DeactivateMapFrame Method

In This Topic

Deactivate the ActivatedMapFrame on the layout view. This method must be called on the UI thread.

Syntax

C#
Visual Basic (Declaration)

public void DeactivateMapFrame()

Public Sub DeactivateMapFrame()

Exceptions

Exception	Description
System.InvalidOperationException	Needs to run on the GUI thread
System.InvalidOperationException	Layout view must be the active view

Remarks

This method must be called on the UI thread (and not the MCT as is most commonly the case with most other synchronous API methods) or an System.InvalidOperationException will be thrown. The layout view you are deactivating the ActivatedMapFrame "on" must be the current active view or an System.InvalidOperationException will be thrown. The deactivated map frame will remain selected.

Example

Deactivate Map Frame

//The active view must be a layout view.
var lv = LayoutView.Active;
if (lv == null)
  return;
var layout = lv.Layout;
if (layout == null)
  return;

//Deactivate any activated map frame
//Note: we are on the UI thread!
lv.DeactivateMapFrame();//no-op if nothing activated

//or - check if a  map frame is activated first...
if (lv.ActivatedMapFrame != null)
  //Note: we are on the UI thread!
  lv.DeactivateMapFrame();

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.1 or higher.

Reference

LayoutView Class
LayoutView Members

Send feedback