com.esri.arcgis.schematic
Interface INgLegendDescription

All Superinterfaces:

Serializable

All Known Implementing Classes:

INgLegendDescriptionProxy, NgLegendDescription

public interface INgLegendDescription
extends Serializable

Provides access to members that control the description of the graphic legend entries.

Product Availability

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

See Also:

INgLegend

Method Summary

int	getEntriesCount() Number of legend entries.
void	getEntryInfo(int index, String[] pDesc, String[] pLabel, String[] pSymbolEMF) Returns the information related to the 'Index' legend entry.
INgView	getView() View the legend description is related to.

Method Detail

getView

INgView getView()
                throws IOException,
                       AutomationException

View the legend description 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.

getEntriesCount

int getEntriesCount()
                    throws IOException,
                           AutomationException

Number of legend entries.

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.

getEntryInfo

void getEntryInfo(int index,
                  String[] pDesc,
                  String[] pLabel,
                  String[] pSymbolEMF)
                  throws IOException,
                         AutomationException

Returns the information related to the 'Index' legend entry.

Product Availability

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

Parameters:

index - The index (in)

pDesc - The pDesc (out: use single element array)

pLabel - The pLabel (out: use single element array)

pSymbolEMF - The pSymbolEMF (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.