ArcGIS Pro 3.0 API Reference Guide
ArcGIS.Core.CIM Namespace / CIMGeneralPlacementProperties Class
Members Example

In This Topic
    CIMGeneralPlacementProperties Class
    In This Topic
    Represents general placement properties. This is base class for general placement properties for each label engine.
    Object Model
    CIMGeneralPlacementProperties ClassCIMColor Class
    Syntax
    Example
    Get the active map's labeling engine - Maplex or Standard labeling engine
    //Note: call within QueuedTask.Run()
    
    //Get the active map's definition - CIMMap.
    var cimMap = MapView.Active.Map.GetDefinition();
    //Get the labeling engine from the map definition
    CIMGeneralPlacementProperties labelEngine = cimMap.GeneralPlacementProperties;
    Change the active map's labeling engine from Standard to Maplex or vice versa
    //Note: call within QueuedTask.Run()
    
    //Get the active map's definition - CIMMap.
    var cimMap = MapView.Active.Map.GetDefinition();
    //Get the labeling engine from the map definition
    var cimGeneralPlacement = cimMap.GeneralPlacementProperties;
    
    if (cimGeneralPlacement is CIMMaplexGeneralPlacementProperties)
    {
      //Current labeling engine is Maplex labeling engine
      //Create a new standard label engine properties
      var cimStandardPlacementProperties = new CIMStandardGeneralPlacementProperties();
      //Set the CIMMap's GeneralPlacementProperties to the new label engine
      cimMap.GeneralPlacementProperties = cimStandardPlacementProperties;
    }
    else
    {
      //Current labeling engine is Standard labeling engine
      //Create a new Maplex label engine properties
      var cimMaplexGeneralPlacementProperties = new CIMMaplexGeneralPlacementProperties();
      //Set the CIMMap's GeneralPlacementProperties to the new label engine
      cimMap.GeneralPlacementProperties = cimMaplexGeneralPlacementProperties;
    }
    //Set the map's definition
    MapView.Active.Map.SetDefinition(cimMap);
    Inheritance Hierarchy

    System.Object
       ArcGIS.Core.CIM.CIMObject
          ArcGIS.Core.CIM.CIMGeneralPlacementProperties
             ArcGIS.Core.CIM.CIMMaplexGeneralPlacementProperties
             ArcGIS.Core.CIM.CIMStandardGeneralPlacementProperties

    Requirements

    Target Platforms: Windows 11, Windows 10, Windows 8.1

    See Also