ArcGIS Pro 3.1 API Reference Guide
ArcGIS.Desktop.Layouts Namespace / LayoutView Class
Properties Methods


In This Topic
    LayoutView Class Members
    In This Topic

    The following tables list the members exposed by LayoutView.

    Public Properties
     NameDescription
    Public PropertyActivatedMapFrame Gets the activated map frame or null if a map frame is not activated  
    Public PropertyActivatedMapViewGets the activated map view or null if there is no ActivatedMapFrame  
    Public Propertystatic (Shared in Visual Basic)Active Gets the active layout view.  
    Public PropertyActiveElementContainer Gets the active element container  
    Public PropertyActiveMapFrame Gets the active map frame on a layout.  
    Public PropertyDrawingPaused Gets or sets the paused state on the map view.  
    Public PropertyExtent Gets the current extent of the layout view.  
    Public PropertyIsReadyGets a value that indicates whether the LayoutView can be accessed. This property is false while the layout view processes major operations.  
    Public PropertyLayout Gets the layout associated with the layout view.  
    Public PropertyZoomPercentage Gets the current zoom percentage of the layout view.  
    Top
    Public Methods
     NameDescription
    Public MethodActivateMapFrameActivate the map frame on the layout view. This method must be called on the UI thread.  
    Public MethodCanActivateMapFrame Check whether or not the given map frame can be activated on the layout view  
    Public MethodCaptureThumbnailOverloaded.   
    Public MethodClearElementSelection Clear all layout elements in the layout view. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodClientToPage Converts a point in client coordinates to a point in page coordinates. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodClientToScreen Converts a point in screen coordinates to a point in client coordinates. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodDeactivateMapFrameDeactivate the ActivatedMapFrame on the layout view. This method must be called on the UI thread.  
    Public MethodGetSelectedElements Returns a collection of selected layout elements.  
    Public MethodGetViewSize Returns the current size of the view in pixels.  
    Public MethodPageToClient Converts a point in page coordinates to a point in client coordinates. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodPageToScreenConverts a point in page coordinates to screen coordinates. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodRefresh Force the layout view to redraw. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodScreenToClient Converts a point in screen coordinates to a point in client coordinates. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodScreenToPage Converts a point in screen coordinates to a point in page coordinates. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSelectAllElements Select all layout elements in a layout view. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSelectElement Set the element selected for the layout view. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSelectElementsOverloaded.   
    Public MethodUnSelectElement Unselect the element within the layout view. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodUnSelectElements Unselect the elements within the layout view. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodZoomTo Zoom the layout view to the extent defined by a geometry. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodZoomTo100Percent Zoom to the layout view to 100 percent. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodZoomToElement Zoom to the extent of the element. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodZoomToElements Zoom to the extent of the elements. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodZoomToNext Zoom the layout view to the next extent. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodZoomToPageWidth Zoom the layout view to the width of the page. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodZoomToPrevious Zoom the layout view to the previous extent. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodZoomToSelectedElements Zoom the layout view to the extent of the selected elements. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodZoomToWholePage Zoom the layout view to the whole page. This method must be called on the MCT. Use QueuedTask.Run.  
    Top
    Extension Methods
     NameDescription
    Public Extension MethodClearSketchAsync Clears the current sketch in the view.
    Public Extension MethodGetCurrentSketchAsync Gets the current geometry of the sketch without finishing it.
    Top
    See Also

    Reference

    LayoutView Class
    ArcGIS.Desktop.Layouts Namespace

     

     

    ©2023 Esri Inc., All Rights Reserved. Generated on Friday, February 17, 2023

    Send feedback