ArcGIS Pro 3.2 API Reference Guide
ArcGIS.Core.CIM Namespace / CIMLegend Class
Properties Methods Events


In This Topic
    CIMLegend Class Members
    In This Topic

    The following tables list the members exposed by CIMLegend.

    Public Constructors
     NameDescription
    Public Constructor  
    Top
    Public Properties
     NameDescription
    Public Property Gets or sets the anchor position of the element. (Inherited from ArcGIS.Core.CIM.CIMElement)
    Public Property Gets or sets a value indicating whether items should automatically be added to the legend.  
    Public Property Gets or sets a value indicating whether legend fonts should automatically be sized.  
    Public Property Gets or sets a value indicating whether the items should automatically be ordered when added.  
    Public Property Gets or sets a value indicating whether the items should display when not in the visible extent.  
    Public Property Gets or sets a value indicating whether to balance the columns or simply "pour" the text into each column.  
    Public Property Gets or sets the gap between classes. Units in points.  
    Public Property Gets or sets the number of legend columns when either of the following fitting strategies is in ///effect: SpecifyColumnsAndAdjustFrame or SpecifyColumnsAndAdjustSize.  
    Public Property Gets or sets the custom properties of the element. (Inherited from ArcGIS.Core.CIM.CIMElement)
    Public Property Gets or sets the default legend item used as the basis for new legend item creation.  
    Public Property Gets or sets an items default patch height. Units in points.  
    Public Property Gets or sets an items default patch width. Units in points.  
    Public Property Gets or sets the description width threshold. Units in points.  
    Public Property Gets or sets a collection of layer URIs from the associated map that are explicitly excluded from the legend.  
    Public Property Gets or sets a value indicating whether this element is expanded in the contents pane. (Inherited from ArcGIS.Core.CIM.CIMElement)
    Public Property Gets or sets the feature count prefix. Deprecated in 1.4. Use count prefix in legend item instead.  
    Public Property Gets or sets the feature count suffix. Deprecated in 1.4. Use count suffix in legend item instead.  
    Public Property Gets or sets the legends fitting strategy.  
    Public Property Gets or sets the geometry of a frame for an element. (Inherited from ArcGIS.Core.CIM.CIMFrameElement)
    Public Property Gets or sets the graphic symbology of an element's frame. (Inherited from ArcGIS.Core.CIM.CIMFrameElement)
    Public Property Gets or sets the gap between groups. Units in points.  
    Public Property Gets or sets the gap following the group layer name.  
    Public Property Gets or sets the heading gap. Units in points.  
    Public Property Gets or sets the gap between horizontal items. Units in points.  
    Public Property Gets or sets the gap between items. Units in points,.  
    Public Property Gets or sets a collection of items in a layout.  
    Public Property Gets or sets the label width. Units in points.  
    Public Property Gets or sets the layer name gap. Units in points.  
    Public Property Gets or sets a value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool. (Inherited from ArcGIS.Core.CIM.CIMElement)
    Public Property Gets or sets a value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally. (Inherited from ArcGIS.Core.CIM.CIMElement)
    Public Property Gets or sets a value indicating whether to ensure all the columns are the same width.  
    Public Property Gets or sets the map frame associated with the map surround. (Inherited from ArcGIS.Core.CIM.CIMMapSurround)
    Public Property Gets or sets the maximum scale. (Inherited from ArcGIS.Core.CIM.CIMMapSurround)
    Public Property Gets or sets the minimum font size. Units in points.  
    Public Property Gets or sets the minimum scale. (Inherited from ArcGIS.Core.CIM.CIMMapSurround)
    Public Property Gets or sets the name of the element. (Inherited from ArcGIS.Core.CIM.CIMElement)
    Public Property Gets or sets the gap between patches. Units in points.  
    Public Property Gets or sets a value indicating whether right to left orientation should be applied.  
    Public Property Gets or sets the rotation of the element. (Inherited from ArcGIS.Core.CIM.CIMElement)
    Public Property Gets or sets the location of the anchor in page units.This is also the location the feature is rotated around. (Inherited from ArcGIS.Core.CIM.CIMElement)
    Public Property Gets or sets a value indicating whether symbols should be scaled.  
    Public Property Gets or sets a value indicating whether the legend title should be displayed.  
    Public Property Gets or sets the gap between text. Units in points.  
    Public Property Gets or sets the title for the legend.  
    Public Property Gets or sets the title gap. Units in points.  
    Public Property Gets or sets the symbol for the title.  
    Public Property Gets or sets a value indicating whether the element is visible. (Inherited from ArcGIS.Core.CIM.CIMElement)
    Top
    Public Methods
     NameDescription
    Public Method Creates a deep copy of CIMLegend.  
    Public Methodstatic (Shared in Visual Basic) Reconstructs the CIMLegend with a specified state from a JSON encoding.  
    Public Method Not implemented, reserved for future use. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Public Method Reads the element inside the reader. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Public MethodOverridden.  Creates a JSON encoding of the CIMLegend and its current state.  
    Public Method Writes the element inside the writer. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Top
    Protected Methods
     NameDescription
    Protected Method Called from a property setter to notify the framework that an Object member has changed. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Protected MethodOverridden.  Reads the child element inside the reader.  
    Protected MethodOverridden.  Writes a child element to the writer.  
    Top
    Public Events
     NameDescription
    Public Event Occurs when a property value changes. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Top
    See Also