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


In This Topic
    DockPane Class Methods
    In This Topic

    For a list of all members of this type, see DockPane members.

    Public Methods
     NameDescription
    Public MethodActivateOverloaded.   
    Public MethodHide Hides the DockPane.  
    Public MethodOnDragOver 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 MethodOnDrop 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 MethodPin Pins the DockPane  
    Public MethodUnPin Restores the DockPane from its pinned state.  
    Top
    Protected Methods
     NameDescription
    Protected Internal MethodCanCopyAsync 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 MethodCanCopyPathAsync 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 MethodCanCutAsync 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 MethodCanDeleteAsync 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 MethodCanDuplicateAsync 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 MethodCanPasteAsync 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 MethodCanPasteSpecialAsync 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 MethodCopyAsync Called when the Copy command is clicked. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Protected Internal MethodCopyPathAsync Called when the CopyPath command is clicked. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Protected Internal MethodCutAsync Called when the Cut command is executed. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Protected Internal MethodDeleteAsync Called when the Delete command is executed. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Protected Internal MethodDuplicateAsync Called when the Duplicate command is executed. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Protected Internal MethodInitializeAsync Called when the pane is first created to give it the opportunity to initialize itself asynchronously. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Protected MethodNotifyPropertyChangedOverloaded.  (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Protected Internal MethodOnActivate Called whenever the DockPane is activated or deactivated.  
    Protected Internal MethodOnCreateContent Optional override to create the visible content of the control.  
    Protected Internal MethodOnHelpRequested Help requested for the DockPane.  
    Protected Internal MethodOnHidden Called when the DockPane is completely hidden.  
    Protected Internal MethodOnKeyCommand Called during OnKeyDown if when a register shortcut matches. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Protected Internal MethodOnSetContentCalled when the Content is specified.  
    Protected Internal MethodOnShow Called when the visibility of the DockPane changes.  
    Protected Internal MethodOnUpdate Called periodically by the framework once the tool has been created. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn)
    Protected Internal MethodPasteAsync Called when the Paste command is executed. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Protected Internal MethodPasteSpecialAsync Called when the PasteSpecial command is executed. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Protected MethodProcessKeyDown Process key down  
    Protected MethodSetPropertyOverloaded.  (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Protected Internal MethodUninitializeAsync Called when the pane is closed to give it the opportunity to uninitialize itself asynchronously. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Top
    See Also

    Reference

    DockPane Class
    ArcGIS.Desktop.Framework.Contracts Namespace
    Pane Class

     

     

    ©2023 Esri Inc., All Rights Reserved. Generated on Wednesday, October 25, 2023

    Send feedback