ArcGIS Pro 3.0 API Reference Guide
ArcGIS.Desktop.Layouts Namespace / MapFrame Class


In This Topic
    MapFrame Class Methods
    In This Topic

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

    Public Methods
     NameDescription
    Public MethodCompareTo Compare Elements by name. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public MethodConvertToGraphics Convert the element to graphics. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public MethodEqualsOverloaded.  (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public MethodExport Export a layout to a variety of formats. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodGetAnchor 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 MethodGetAnchorPoint Get the element anchor point location. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public MethodGetAutoCamera Gets the auto camera associated with the map frame  
    Public MethodGetBounds 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 MethodGetCustomProperty Gets a Custom Property value for the element. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public MethodGetDefinition Returns the element's CIM definition. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public MethodGetGeometry (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public MethodGetHashCode Serves as the default hash function. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public MethodGetHeight Gets the height of the element. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public MethodGetLockedAspectRatio 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 MethodGetMapView Gets the map Frame's viewer on the specified layout pane.  
    Public MethodGetParent Gets the parent of this element. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public MethodGetRotation 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 MethodGetViewCenter 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 MethodGetViewExtent Gets the current extent of the map frame view. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodGetWidth Gets the width of the element. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public MethodGetX 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 MethodGetY 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 MethodIsMapSeriesMapFrame Gets whether this map frame is associated with a layout map series. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodMapToPageOverloaded.   
    Public MethodPageToMapOverloaded.   
    Public MethodSetAnchor 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 MethodSetAnchorPoint 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 MethodSetAutoCamera Sets the auto camera for the map frame display constraints. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSetCameraOverloaded.   
    Public MethodSetCustomProperties 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 MethodSetCustomPropertyOverloaded.  (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public MethodSetDefinitionApplies 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 MethodSetGeometry (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public MethodSetHeight Sets the height of the element. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public MethodSetLocked 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 MethodSetLockedAspectRatio 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 MethodSetMapSets the Map associated with the MapFrame. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSetName Sets the name of the element. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public MethodSetRotation 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 MethodSetTOCPositionAbsolute 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 MethodSetTOCPositionRelativeOverloaded.  (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public MethodSetVisible 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 MethodSetWidth Sets the width of the element. This method must be called on the MCT. Use QueuedTask.Run. (Inherited from ArcGIS.Desktop.Layouts.Element)
    Public MethodSetX 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 MethodSetY 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 MethodValidateAutoCameraValidates 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
     NameDescription
    Protected MethodNotifyPropertyChangedOverloaded.  (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Protected MethodSetPropertyOverloaded.  (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Top
    See Also

    Reference

    MapFrame Class
    ArcGIS.Desktop.Layouts Namespace

     

     

    ©2022 Esri Inc., All Rights Reserved. Generated on Monday, June 13, 2022

    Send feedback