DockPaneState Enumeration

In This Topic

DockPane positions.

Syntax

C#
Visual Basic (Declaration)

public enum DockPaneState : System.Enum, System.IComparable, System.IConvertible, System.IFormattable

Public Enum DockPaneState 
   Inherits System.Enum
   Implements System.IComparable, System.IConvertible, System.IFormattable

Members

Member	Description
AutoHide	Content is hosted by a fly-out window and is visible only when the user moves the mouse over an anchor thumb located in the application border.
DockableWindow	Content is hosted by a floating window and the user can re-dock it within the application.
Docked	Content is docked within the application.
FloatingWindow	Content is hosted by a floating window that can't be docked within the application.
Hidden	Content is hidden.
None	Content is not associated with any ArcGIS.Desktop.Framework.DockPaneManager (Default State).

Example

Dockpane properties and methods

// in order to find a dockpane you need to know it's DAML id
var pane = FrameworkApplication.DockPaneManager.Find("esri_core_ProjectDockPane");

// determine visibility
bool visible = pane.IsVisible;

// activate it
pane.Activate();

// determine dockpane state
DockPaneState state = pane.DockState;

// pin it
pane.Pin();

// hide it
pane.Hide();

Inheritance Hierarchy

System.Object
   System.ValueType
      System.Enum
         ArcGIS.Desktop.Framework.Contracts.DockPaneState

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

ArcGIS.Desktop.Framework.Contracts Namespace

Send feedback