CanActivateMapFrame Method

In This Topic

Check whether or not the given map frame can be activated on the layout view

Syntax

Visual Basic (Declaration)
C#

Public Function CanActivateMapFrame( _
   ByVal mapFrame As MapFrame _
) As Boolean

public bool CanActivateMapFrame( 
   MapFrame mapFrame
)

Parameters

mapFrame: The mapframe to check

Return Value

True if the map frame can be activated on this view

Remarks

To be activated, a map frame must have a valid map, be visible on the current layout (being shown on the view), and not already be activated. If another map frame is currently activated on the view then CanActivateMapFrame will also return false.

Example

Activate Map Frame

{



  //We can activate a map frame on the layout of the active view
  var map_frame = layout.GetElementsAsFlattenedList()
                      .OfType<MapFrame>().FirstOrDefault(mf => mf.Name == "Map 1");
  if (map_frame == null)
    return;
  //can we activate the map frame?
  if (layoutView.CanActivateMapFrame(map_frame))
    //activate it - Note: we are on the UI thread!
    layoutView.ActivateMapFrame(map_frame);
}

Requirements

Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

ArcGIS Pro version: 3.1 or higher.

Reference

LayoutView Class
LayoutView Members

Send feedback