This document is archived and information here might be outdated.  Recommended version.


IClassBreaksRenderer.Description Property (ArcObjects .NET 10.5 SDK)
ArcObjects Help for .NET developers > ArcObjects namespaces > Carto > ESRI.ArcGIS.Carto > Interfaces > IC > IClassBreaksRenderer Interface > IClassBreaksRenderer.Description Property (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (Carto)  

IClassBreaksRenderer.Description Property

Description at the specified index.

[Visual Basic .NET]
Public Function get_Description ( _
    ByVal Index As Integer _
) As String

[Visual Basic .NET]
Public Sub set_Description ( _
    ByVal Index As Integer, _
    ByVal Text As String _
)

[C#]
public string get_Description (
    int Index
);

[C#]
public void set_Description (
    int Index,
    string Text
);

[C++]
HRESULT get_Description(
  long Index,
  BSTR* Text
);

[C++]
HRESULT put_Description(
  long Index,
  BSTR Text
);

[C++]

Parameters
Index [in]
  Index is a parameter of type long
Text [out, retval]
  Text is a parameter of type BSTR
Index [in]
  Index is a parameter of type long
Text [in]
  Text is a parameter of type BSTR

Product Availability

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

Description

Description(i) is the description for the ith class. The description appears in the layer properties dialog's symbology tab and can also appear in the legend.

Remarks

Breaks, symbols, labels, and descriptions are all indexed the same and match the classes defined for the renderer. The lowest index is 0 and the highest index=BreakCount - 1.

See Also

IClassBreaksRenderer Interface