INgLegend Interface

Provides access to members that control the graphic legend.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Schematics Extension.

Description

The Legend window is a child of the schematic window. By default, each legend entry is featured with its matching element occurrence count. The legend content depends on the element types and properties defined for the related element type.

Custom behavior can be added to the items in a legend. For example, a toggle option to show or hide the legend item in the view can be added to the right-click function on the legend.

The Legend subwindow cannot be printed with the print function of ArcGIS Schematics.

Members

		Description
	Hide	Hides the legend.
	IsVisible	Indicates if the legend window displays in the view.
	Refresh	Refreshes the legend window and diplays it in the 'displayMode' mode.
	Show	Displays the legend in the 'displayMode' mode (see esriNgLegendDisplayMode).
	View	View the legend is related to.

CoClasses that implement INgLegend

CoClasses and Classes	Description
NgLegend	Graphic legend object.

Example

INgLegend properties and methods - Example

Send feedback on this page