ArcGIS Pro 3.3 API Reference Guide
ArcGIS.Desktop.Layouts Namespace / Layout Class
Properties Methods Events


In This Topic
    Layout Class Members
    In This Topic

    The following tables list the members exposed by Layout.

    Public Properties
     NameDescription
    Public Property Gets the collection of elements in a GroupElement.  
    Public Property Gets the map series associated with a layout.  
    Public Property Gets the name of the layout.  
    Public Property Gets the OperationManager which is responsible for managing the undo/redo stack.  
    Public Property Gets the ID of the project that contains the layout.  
    Public Property Gets the path of the layout in the project.  
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded.   
    Public MethodOverloaded.   
    Public MethodOverloaded.   
    Public MethodOverloaded.   
    Public Method Clear all selected elements in the page layout.  
    Public MethodOverloaded.   
    Public Method Deletes an element on a page layout. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodOverloaded.   
    Public Method Object dispose  
    Public MethodOverloaded.   
    Public Method Finds an element with the given name on the page layout.  
    Public Method Finds the elements recursively with the given names on the page layout.  
    Public Method Gets whether the Layout metadata can be edited or not. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Returns the element's CIM definition. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodGet the collection of elements from the page layout. Nesting within GroupElementis preserved.  
    Public MethodGet the collection of Element from the page layout as a flattened list. Nested groups within GroupElement are not preserved.  
    Public Method Gets the Layout metadata. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodGets the CIMPage for a layout. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Get a collection of the selected layout elements.  
    Public Method Group the collection of elements. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Refreshes the map series when the related map data changes. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Exports a layout to a new layout (.pagx) file. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Select the element within the page layout.  
    Public Method Set the selected elements for the page layout.  
    Public MethodOverloaded.   
    Public MethodOverloaded.   
    Public MethodApplies the changes made to a modified ArcGIS.Core.CIM.CIMLayout back to the element on the page layout. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Sets the map series for a layout. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Sets the Layout metadata. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Sets the name of the layout. It is important that all layouts have a unique name so they can be easily referenced. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodOverloaded.   
    Public Method Opens the Layout Properties dialog.  
    Public Method Ungroup the elements contained in 'group'. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Ungroup the elements contained in 'groups'. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Unselect the element on the page layout.  
    Public Method Unselect the elements on the page layout.  
    Top
    Protected Methods
    Public Events
     NameDescription
    Public Event Occurs when a property value changes. (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Top
    See Also