ArcGIS Pro 3.2 API Reference Guide
ArcGIS.Desktop.Framework.Contracts Namespace / DockPane Class
Properties Methods Events


In This Topic
    DockPane Class Members
    In This Topic

    The following tables list the members exposed by DockPane.

    Public Properties
     NameDescription
    Public Property Gets or sets the DockPane's caption.  
    Public PropertyGets or sets the supplementary text that appears with the Tooltip only when the command is disabled. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn)
    Public Property Gets the DockPane's position.  
    Public Property Gets or sets a boolean to specify whether the control is enabled. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn)
    Public Property Gets the DAML identifier. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn)
    Public Property Gets a boolean indicating whether the pane has been fully initialized or not. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Public Property Gets a boolean to let clients know the DockPane is currently processing a Task.  
    Public Property Gets the DockPane's floating state.  
    Public Property Gets or sets the DockPane's visibility.  
    Public Property Gets or sets the large representation of the command, this may be an image or a xaml element. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn)
    Public Property Gets the OperationManager associated with the DockPane.  
    Public Property Gets or sets the small representation of the command, this may be an image or a xaml element. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn)
    Public Property Gets or sets the dockpane's lower tab text. This appears only when the dock pane is grouped with other tabs.  
    Public Property Gets or sets a brief description of the command that appears in a small pop-up window when a user pauses the mouse pointer over an element, such as over a Button. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn)
    Public Property Gets or sets a one or two word label that appears above the tooltip. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn)
    Top
    Protected Properties
     NameDescription
    Protected Internal Property Gets or sets the content portion of the DockPane.  
    Protected Internal Property Gets or sets the help topic ID to show.  
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded.   
    Public Method Hides the DockPane.  
    Public Method Invoked when an object is dragged over the window. Implement this method to add class handling for this event. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Public Method Invoked when an object is dropped onto the pane. Implement this method to add class handling for this event. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Public Method Pins the DockPane  
    Public Method Restores the DockPane from its pinned state.  
    Top
    Protected Methods
     NameDescription
    Protected Internal Method The active pane is constantly polled giving it the opportunity to enable the application's Copy button. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Protected Internal Method The active pane is constantly polled giving it the opportunity to enable the application's CopyPath button. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Protected Internal Method The active pane is constantly polled giving it the opportunity to enable the application's Cut button. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Protected Internal Method The active pane is constantly polled giving it the opportunity to enable the application's Delete button. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Protected Internal Method The active pane is constantly polled giving it the opportunity to enable the application's Duplicate button. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Protected Internal Method The active pane is constantly polled giving it the opportunity to enable the application's Paste button. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Protected Internal Method The active pane is constantly polled giving it the opportunity to enable the application's PasteSpecial button. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Protected Internal Method Called when the Copy command is clicked. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Protected Internal Method Called when the CopyPath command is clicked. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Protected Internal Method Called when the Cut command is executed. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Protected Internal Method Called when the Delete command is executed. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Protected Internal Method Called when the Duplicate command is executed. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Protected Internal Method Called when the pane is first created to give it the opportunity to initialize itself asynchronously. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Protected MethodOverloaded.  (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Protected Internal Method Called whenever the DockPane is activated or deactivated.  
    Protected Internal Method Optional override to create the visible content of the control.  
    Protected Internal Method Help requested for the DockPane.  
    Protected Internal Method Called when the DockPane is completely hidden.  
    Protected Internal Method Called during OnKeyDown if when a register shortcut matches. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Protected Internal MethodCalled when the Content is specified.  
    Protected Internal Method Called when the visibility of the DockPane changes.  
    Protected Internal Method Called periodically by the framework once the tool has been created. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn)
    Protected Internal Method Called when the Paste command is executed. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Protected Internal Method Called when the PasteSpecial command is executed. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Protected Method Process key down  
    Protected MethodOverloaded.  (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Protected Internal Method Called when the pane is closed to give it the opportunity to uninitialize itself asynchronously. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Top
    Public Events
     NameDescription
    Public Event Occurs when a property value changes. (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Top
    See Also