ArcGIS Pro 2.9 API Reference Guide
AnnotationLayer Class Members
Fields  Properties  Methods  Events


ArcGIS.Desktop.Mapping Namespace : AnnotationLayer Class

The following tables list the members exposed by AnnotationLayer.

Protected Fields
 NameDescription
Protected Field (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Top
Public Properties
 NameDescription
Public Property (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Property Gets the blending mode of a layer. (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Property Gets a value indicating the MapMember's connection status. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
Public Property Gets the definition filter for the existing layer. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Property Gets the definition query expression for the existing layer. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Property Gets the depth priority of a layer. (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Property Gets the layer's display cache type. (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Property Gets the per feature blend mode of a basic feature layer. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Property Gets whether the layer has any joins (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Property Gets whether the layer has any relates (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Property Gets whether a layer is editable. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Property Gets whether the layer is expanded or collapsed on the TOC. (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Property Gets whether a basic feature layer is selectable. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Property Gets whether a basic feature layer is set to automatically select related data. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Property Gets the layer's visibility state (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Property Gets a read-only collection of annotation sub layers from the AnnotationLayer.  
Public Property Gets a read only collection of legend groups. Check the LegendStatus property before accessing this collection. (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public PropertyOverridden.  Gets the status of the legend  
Public Property Get the map which the MapMember belongs to. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
Public Property Gets map layer type. (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Property Gets the duration of display cache for the layer. (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Property Gets the maximum distance (in meter) at which the layer is visible in a 3D scene or globe view. (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Property Gets the layer's maximum scale (representative fraction) at which the layer is visible in a 2D map view. (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Property Gets the minimum distance (in meter) at which the layer is visible in a 3D scene or globe view. (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Property Gets the layer's minimum scale (representative fraction) at which the layer is visible in a 2D map view. (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Property Gets the display name of the MapMember. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
Public Property Gets the parent of the layer. It is either the group layer it belongs to, or the map for layers that do not belong in any group layers. (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Property Gets the scene layer type (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Property Gets the number of features selected in the layer. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Property Gets the geometry type of the layer. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Property Gets a value indicating whether the MapMember is configured to show pop-ups when a feature is clicked. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
Public Property Gets whether the MapMember supports metadata (Inherited from ArcGIS.Desktop.Mapping.MapMember)
Public Property Gets the transparency value set to the layer. 100 being fully transparent and 0 means opaque. (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Property Gets the unique path of this MapMember. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
Top
Public Methods
 NameDescription
Public MethodReturns true if the data can be edited. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Method Check if the layer's data source can be replace with this dataset. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Method Check if blending mode can be set on this layer. (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Method Check if the per feature blending mode can be set on this layer. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Method Clears the layer display cache from the local storage. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Method Clears the current selection. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Method Performs a find and replace of workspace path for the layer. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Method Finds an annotation sub layer using a URI.  
Public Method Finds annotation sub layers by name.  
Public Method Gets whether the Layer metadata can be edited or not. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Method Gets a CIMDataConnection value object. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.MapMember)
Public Method Returns the layer's CIM definition. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Method Gets the copy of definition filter choices for the existing layer. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Method Returns computed effective maximum scale considering all its parent group layers. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Method Returns computed effective minimum scale considering all its parent group layers. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Method Returns fields of the layer including joined fields, if any. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Method Returns a read only list of sub layers.  
Public Method Gets the Layer metadata. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Method Gets the URI path of the MapMember. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
Public Method Gets the current selection of the basic feature layer. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Method Gets a readonly snapshot of the layers  
Public Method Returns the layer spatial reference. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Method Returns the underlying feature class as Table type. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Method Gets whether or not the MapMember stores its own metadata or uses metadata retrieved from its source. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.MapMember)
Public Method (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Method Loads the layer's legend. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Method Queries the display expressions of the given set of objects. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Method Returns the outline geometry for the corresponding feature identified by the object id. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Method Returns extent of the layer optionally taking symbol size in account. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Method Remove all definition filters. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Method Remove a definition filter. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Method Replace the layer's data source. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public MethodOverloaded.  (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public MethodOverloaded.  (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Method Sets the layer's blending mode. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Method Updates a MapMember's data source. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.MapMember)
Public Method Updates the layer's CIM definition. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Method Sets the definition filter. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Method Sets the collection of definition filters. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Method Sets the definition query expression for the layer. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Method Sets the duration after which the layer's cache will be refreshed in the local storage. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Method Sets the layer's display cache type. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Method Enables or disables editing on a basic feature layer. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Method Sets whether the layer appears expanded i.e. showing legends on the TOC. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Method Sets the per feature blending mode. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Method Applies updates to the editable properties of fields. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Method Sets the maximum distance (in meter) at which the layer is visible in a 3D scene or globe view. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Method Sets the layer's maximum scale (representative fraction) at which the layer is visible in a 2D map view. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Method Sets the Layer metadata. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Method Sets the minimum distance (in meter) at which the layer is visible in a 3D scene or globe view. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Method Sets the layer's minimum scale (representative fraction) at which the layer is visible in a 2D map view. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Method Sets the display name for the MapMember. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.MapMember)
Public Method Toggles the selectability of a basic feature layer. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Method Sets the current selection of the basic feature layer. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Method Toggles the SelectRelatedData of a MapMember. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
Public Method Toggles enabling pop-ups for the layer. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.MapMember)
Public Method Sets the transparency of the layer. 100 being fully transparent and 0 means opaque. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Method Sets whether or not the Layer will use its own metadata or the metadata from its underlying source (if it has one). This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Method Sets the layer visibility. This method must be called on the MCT. Use QueuedTask.Run (Inherited from ArcGIS.Desktop.Mapping.Layer)
Public Method Returns the display name of the MapMember. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
Top
Protected Methods
Extension Methods
 NameDescription
Public Extension MethodOverloaded. 
Public Extension Method Generate feature templates for a layer or standalone-table. This method must be called on the MCT. Use QueuedTask.Run
Public Extension MethodCreates a new group template object using the specified definition. Adds the base template specified to the group template as the base part. This method must be called on the MCT. Use QueuedTask.Run. Use this method in conjunction with calls to AddComponentTemplate for each component part. Once the group template is fully defined, use CreateTemplate(Layer,CIMEditingTemplate) to add the template to the template manager.
Public Extension Method Creates a new preset template from the specified set of features.
Public Extension MethodOverloaded. 
Public Extension MethodOverloaded. 
Public Extension MethodOverloaded. 
Public Extension MethodLoad a feature into a new inspector instance. This method must be called on the MCT. Use QueuedTask.Run.
Public Extension Method Gets whether the layer is controlled by a parcel fabric of the specified type.
Public Extension MethodOverloaded. 
Public Extension MethodOverloaded. 
Public Extension MethodOverloaded. 
Top
Public Events
 NameDescription
Public Event Occurs when a property value changes. (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
Top
See Also

Reference

AnnotationLayer Class
ArcGIS.Desktop.Mapping Namespace