Page.DropLegend Method (Visio)
Inserts a data graphics legend on a Microsoft Visio drawing page. Returns the list shape instance specified in the OuterList parameter.
Note
This Visio object or member is available only to licensed users of Microsoft Visio Professional 2010 or Visio Premium 2010.
Version Information
Version Added: Visio 2010
Syntax
expression .DropLegend(OuterList, InnerList, populateFlags)
expression An expression that returns a Page object.
Parameters
Name |
Required/Optional |
Data Type |
Description |
|---|---|---|---|
OuterList |
Required |
[UNKNOWN] |
A Master or MasterShortcut object that represents the legend object. Corresponds to the outermost list shape. |
InnerContainer |
Required |
[UNKNOWN] |
A Master or MasterShortcut object that represents the legend object. Corresponds to the inner field container shape used within the legend for each data-graphic field. |
populateFlags |
Required |
A flag that specifies whether Visio should populate the legend. |
Return Value
Remarks
The value of the populateFlags parameter must be one of the following VisLegendFlags constants.
Constant |
Value |
Description |
|---|---|---|
visLegendPopulate |
0 |
Insert the legend and populate it. |
visLegendNoContents |
1 |
Insert the legend but do not populate it. |
If you pass visLegendPopulate for the populateFlags parameter, Visio inserts the legend and populates it with eligible data-graphic items in use on the specified drawing page. If no such items exist, Visio returns the error EU_API_NOOP, "Operation succeeded but no action taken."
If you pass visLegendNoContents for the populateFlags parameter, Visio inserts a legend that consists of the outer list shape as well as a single inner container shape, which contains an inner list shape but has no heading text.