ArcGIS Pro 3.4 API Reference Guide
ArcGIS.Desktop.Mapping Namespace / CompositeFeatureLayer Class


In This Topic
    CompositeFeatureLayer Class Methods
    In This Topic

    For a list of all members of this type, see CompositeFeatureLayer members.

    Public Methods
     NameDescription
    Public Method Adds a label class to the layer's label class collection. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.FeatureLayer)
    Public Method Add Symbol Layer Drawing, SLD, to the feature layer. After adding SLD it will be enabled.This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.FeatureLayer)
    Public Method Determine whether the feature layer can have Symbol Layer Drawing added to its definition. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.FeatureLayer)
    Public Method Gets if the mapMember supports time filtering and can clear the time filter. Clearing the time filter ensures that data is always shown. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Public MethodDetermines whether a renderer can be created and is valid for the feature layer using the specified RendererDefinition. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.FeatureLayer)
    Public MethodReturns true if the data can be edited. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
    Public Method Gets if the mapMember supports time filtering. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Public Method calling code must run on MCT (Inherited from ArcGIS.Desktop.Mapping.Layer)
    Public Method calling code can be run on any thread (Inherited from ArcGIS.Desktop.Mapping.Layer)
    Public Method Determines whether the layer's renderer type supports symbol lookup. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.FeatureLayer)
    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 Gets whether the elevation type definition can be set on the layer. This method must be called on the MCT. Use QueuedTask.Run. (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 Determines whether a renderer is valid for the feature layer and can be updated. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.FeatureLayer)
    Public Method Gets if the mapMember supports time filtering and if the specified time parameters are valid. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Public Method Refreshes the layer drawing and clears the feature cache (for layer types supporting it). 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 Clears the time filter for the mapMember. Clearing the time filter ensures that data is always shown. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Public Method Creates a renderer to a feature layer using a RendererDefinition. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.FeatureLayer)
    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 a layer using a URI.  
    Public Method Finds 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 Gets the time extent of the data for the specified fieldName - that is the minimum and maximum dates present in the data. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Public Method Gets the set of time intervals for the specified field name present in the data. 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 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 Get 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 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 Gets the elevation type definition for the layer. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.Layer)
    Public MethodReturns the underlying FeatureClass that the feature layer is pointing to. A FeatureClass is a collection of spatial entities, modeled as objects with properties and behavior. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.FeatureLayer)
    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 flat list of layers where nested groups are not preserved.  
    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 path of the dataset underneath the MapMember as a Uri. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Public MethodOverloaded.  (Inherited from ArcGIS.Desktop.Mapping.FeatureLayer)
    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 the current time parameters for the mapMember. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    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 Gets whether the layer or a parent group layer is currently using Symbol Layer Drawing or not. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.FeatureLayer)
    Public MethodOverloaded.  (Inherited from ArcGIS.Desktop.Mapping.Layer)
    Public MethodOverloaded.  (Inherited from ArcGIS.Desktop.Mapping.Layer)
    Public Method Determine whether the feature layer or a parent group layer has Symbol Layer Drawing added. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.FeatureLayer)
    Public MethodInsert a list of DefinitionQuery. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
    Public MethodInserts a DefinitionQuery. If makeActive is true, makes it the active definition query. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
    Public Method Gets if time is supported for this mapMember. 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 Looks up the symbol for the corresponding feature identified by the object id. This method will return null when the input OID is not part of the feature layer definition or if the renderer returns a null symbol. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.FeatureLayer)
    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 MethodOverloaded.  (Inherited from ArcGIS.Desktop.Mapping.FeatureLayer)
    Public Method Removes the active definition query. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
    Public Method Remove all definition queries. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
    Public Method Removes the definition queries specified by the list of names. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
    Public Method Removes the definition query at the specified index. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
    Public Method (Inherited from ArcGIS.Desktop.Mapping.FeatureLayer)
    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 MethodExecutes a spatial or attribute query to the underlying data source and returns features matching the search criteria. For stream layer, you should call ArcGIS.Core.Data.Realtime.RealtimeFeatureClass.StopStreaming for predictable result. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
    Public MethodSelects features based upon the specified attribute and/or spatial criteria and combination method. For stream layer, you should call ArcGIS.Core.Data.Realtime.RealtimeFeatureClass.StopStreaming for predictable result. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
    Public MethodSets the definition query matching the specified queryName to be the active definition query. This method must be called on the MCT. Use QueuedTask.Run. (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 Sets the layer's caching options. If the layer's feature class supports feature caching, then both the display cache and feature cache are set otherwise just the display cache is set. 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 where clause of the active definition query. 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 display 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 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 the elevation type definition for the layer. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.Layer)
    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 Toggles the feature layer's label's visibility. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.FeatureLayer)
    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 Specifies the maximum number of previous observations to be displayed for each track. (Inherited from ArcGIS.Desktop.Mapping.FeatureLayer)
    Public Method Specifies whether to display previous observations or not. (Inherited from ArcGIS.Desktop.Mapping.FeatureLayer)
    Public MethodOverloaded.  (Inherited from ArcGIS.Desktop.Mapping.FeatureLayer)
    Public Method Toggles whether all symbol and text sizes varies as the map scale changes based on the RefereceScale set on the map the layer belongs to. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.FeatureLayer)
    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 MethodToggles the IsSelectRelatedData of a BasicFeatureLayer. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.BasicFeatureLayer)
    Public Method Sets whether the layer is visible at all scales. (Inherited from ArcGIS.Desktop.Mapping.Layer)
    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 Enables or disables snapping on the feature layer. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.FeatureLayer)
    Public Method Sets the specified time parameters for the mapMember. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.MapMember)
    Public Method Specifies whether to display Track Lines or not. (Inherited from ArcGIS.Desktop.Mapping.FeatureLayer)
    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 Specifies to use real world symbol size in 3D based on the mapScale. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.FeatureLayer)
    Public Method Sets whether Symbol Layer Drawing will be used on the feature layer or not. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Mapping.FeatureLayer)
    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
     NameDescription
    Protected MethodOverloaded.  (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Protected Internal MethodOverloaded.  (Inherited from ArcGIS.Desktop.Mapping.Layer)
    Top
    Extension Methods
     NameDescription
    Public Extension Method Gets whether templates have been loaded for the specified map member.
    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(MapMember,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 Method Gets a template by name for a map member. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension Method Gets all templates for a map member. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension Method Gets all templates for a map member, including templates for any children. This method must be called on the MCT. Use QueuedTask.Run.
    Public Extension MethodLoads a row 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
    See Also