ArcGIS Pro 3.4 API Reference Guide
ArcGIS.Desktop.Layouts Namespace / MapFrame Class
Properties Methods Events


In This Topic
    MapFrame Class Members
    In This Topic

    The following tables list the members exposed by MapFrame.

    Public Properties
     NameDescription
    Public Property Gets the camera settings associated with the map frame.  
    Public Property Gets whether the given element can be converted to graphics (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Property Gets the Custom Properties for the element. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public PropertyGets whether the map frame is activated or not. Refer to LayoutView.ActivateMapFrame.  
    Public Property Gets or sets if a group element is expanded in the contents pane. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Property Gets the locked state of an element. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Property Gets the visibility of an element. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public PropertyGets the Map associated with the MapFrame.  
    Public Property Gets the name of the element. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Property Gets the Z order of the element relative to its parent (Inherited from ArcGIS.Desktop.Layouts.Element)
    Top
    Public Methods
     NameDescription
    Public Method Add a grid or a graticule to a map frame. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method Gets whether the StyleItem can be applied (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method Compare Elements by name. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method Convert the element to graphics. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public MethodOverloaded.  (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method Export a layout to a variety of formats. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Gets the anchor position of the element. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method Get the element anchor point location. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method Gets the auto camera associated with the map frame  
    Public Method Gets the bounding box for the element. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method Gets a Custom Property value for the element. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method Returns the element's CIM definition. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method Get the grids or graticules associated with the map frame.  
    Public Method Serves as the default hash function. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method Gets the height of the element. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method Gets the locked aspect ratio value of the element. If This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method Gets the map Frame's viewer on the specified layout pane. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Gets the parent of this element. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method Gets the rotation value for the element. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method Get the center point of the current extent of the map frame view. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Gets the current extent of the map frame view. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Gets the width of the element. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method Gets the X position of the element. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method Gets the Y position of the element. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method Gets whether this map frame is associated with a layout map series. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodOverloaded.   
    Public MethodOverloaded.   
    Public Method Sets the anchor position of the element. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method Sets the element anchor point to the X and Y location specified. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method Sets the auto camera for the map frame display constraints. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodOverloaded.   
    Public Method Sets multiple CustomProperty values for the element. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public MethodOverloaded.  (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public MethodApplies the changes made to a modified CIMElement back to the element on the page layout. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method Update the grids or graticules of a map frame. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Sets the height of the element. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method Sets the locked state of an element on a page layout. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method Sets the locked aspect ratio value of the element. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public MethodSets the Map associated with the MapFrame. This method must be called on the MCT. Use QueuedTask.Run.  
    Public Method Sets the name of the element. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method Sets the rotation value for the element. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method Sets the position of an element either at the top or bottom of the layout TOC or a group element. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public MethodOverloaded.  (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method Sets the visibility of an element on a page layout. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method Sets the width of the element. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method Sets the X position of the element. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public Method Sets the Y position of the element. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public MethodValidates the input CIMAutoCamera for the given ArcGIS.Core.CIM.CIMAutoCamera.Source and ArcGIS.Core.CIM.CIMAutoCamera.AutoCameraType values. This method must be called on the MCT. Use QueuedTask.Run.  
    Top
    Protected Methods
    Public Events
     NameDescription
    Public Event Occurs when a property value changes. (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Top
    See Also