Provides access to members that control how a layer appears in a legend. Can be stored in a style. Note: the ILegendItem2 interface has been superseded byILegendItem3. Please consider using the more recent version.
Product Availability
Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.
Members
Description | ||
---|---|---|
CanDisplay | Indicates if the style is compatible with the specified layer. | |
ChangeFlowDirection | Indicates if a legend's flow direction changes. Update alignment settings. | |
Columns | Number of columns in the legend item. | |
CreateGraphics | Rebuilds the list of graphics. Call whenever the associated layer changes. | |
Graphics | List of graphics that represent the legend item. Must call CreateGraphics first. | |
GroupIndex | Zero-based index of the legend group shown by this item. Use -1 to show all legend groups using this item. | |
HeadingSymbol | Text symbol used to draw the heading. | |
Height | Height of the item in points. Must call CreateGraphics first. | |
KeepTogether | Indicates if classes must appear in a single column or whether they can be split across multiple columns. | |
Layer | Associated layer. | |
LayerNameSymbol | Text symbol used to draw the layer name. | |
LegendClassFormat | Default formatting information for the legend classes. Renderer may override. | |
Name | Name of the style. | |
NewColumn | Indicates if the item starts a new column in the legend. | |
ShowDescriptions | Indicates if descriptions are visible. | |
ShowHeading | Indicates if heading is visibile. | |
ShowLabels | Indicates if labels are visible. | |
ShowLayerName | Indicates if layer name is visibile. | |
Width | Width of the item in points. Must call CreateGraphics first. |
CoClasses that implement ILegendItem2
CoClasses and Classes | Description |
---|---|
HorizontalBarLegendItem | Horizontal bar legend item. |
HorizontalLegendItem | Horizontal legend item. |
NestedLegendItem | Nested legend item. |
VerticalLegendItem | Vertical legend item. |