Table of contents
TOC
Collapse the table of content
Expand the table of content

Page.DropLegend Method (Visio)

office 365 dev account|Last Updated: 6/12/2017
|
1 Contributor

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 Visio Professional 2013.

Syntax

expression . DropLegend( OuterList , InnerList , populateFlags )

expression An expression that returns a Page object.

Parameters

NameRequired/OptionalData TypeDescription
OuterListRequired[UNKNOWN]A Master or MasterShortcut object that represents the legend object. Corresponds to the outermost list shape.
InnerContainerRequired[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.
populateFlagsRequiredVisLegendFlagsA flag that specifies whether Visio should populate the legend.

Return Value

Shape

Remarks

The value of the populateFlags parameter must be one of the following VisLegendFlags constants.

ConstantValueDescription
visLegendPopulate0Insert the legend and populate it.
visLegendNoContents1Insert 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.

© 2017 Microsoft