com.esri.arcgis.schematic
Interface INgLegend

All Superinterfaces:

Serializable

All Known Implementing Classes:

INgLegendProxy, NgLegend

public interface INgLegend
extends Serializable

Provides access to members that control the graphic legend.

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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

INgLegendDescription

Method Summary

INgView	getView() View the legend is related to.
void	hide() Hides the legend.
boolean	isVisible() Indicates if the legend window displays in the view.
void	refresh(int displayMode) Refreshes the legend window and diplays it in the 'displayMode' mode.
void	show(int displayMode) Displays the legend in the 'displayMode' mode (see esriNgLegendDisplayMode).

Method Detail

getView

INgView getView()
                throws IOException,
                       AutomationException

View the legend is related to.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.schematic.INgView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if the legend window displays in the view.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgLegend.hide(), INgLegend.show(int)

hide

void hide()
          throws IOException,
                 AutomationException

Hides the legend.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgLegend.isVisible(), INgLegend.show(int)

show

void show(int displayMode)
          throws IOException,
                 AutomationException

Displays the legend in the 'displayMode' mode (see esriNgLegendDisplayMode).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

displayMode - A com.esri.arcgis.schematic.esriNgLegendDisplayMode constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgLegend.hide(), INgLegend.isVisible()

refresh

void refresh(int displayMode)
             throws IOException,
                    AutomationException

Refreshes the legend window and diplays it in the 'displayMode' mode.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

displayMode - A com.esri.arcgis.schematic.esriNgLegendDisplayMode constant (in, optional, pass 1 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.