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


In This Topic
    Pane Class Members
    In This Topic

    The following tables list the members exposed by Pane.

    Public Properties
     NameDescription
    Public Property Gets or sets the Pane's caption.  
    Public Property Allows derived classes to provide a unique identifier for the Pane. The DAML ID is returned by default.  
    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 or sets a boolean to specify whether the control is enabled. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn)
    Public Property Gets the Pane's Caption including its GroupID count.  
    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 the Framework assigned ID.  
    Public Property Gets a boolean to let clients know the Pane is currently processing a Task.  
    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 or sets the message presented while the Pane is initializing.  
    Public Property Gets the OperationManager associated with the Pane.  
    Public Property This is for Esri internal use only.  
    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 the Pane's state table.  
    Public Property Gets or sets the Pane's tab tooltip.  
    Public Property Gets or sets the Pane's HwndHost if applicable.  
    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 Pane.  
    Protected Internal Property Setting the GroupID property enables Pane numbering.  
    Protected Internal Property For internal esri use only  
    Top
    Public Methods
     NameDescription
    Public Method Makes the Pane the active Pane and active window.  
    Public Method Close the Pane.  
    Public Method Flashes the Pane's tab.  
    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)
    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 Combines the Pane's state with the specified Pane.  
    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 Method Allows a Pane to override the state it sets when activated.  
    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 Pane is activated or deactivated.  
    Protected Internal Method Notification letting the Pane know it has been closed.  
    Protected Internal Method Called when a request has been made to close the Pane.  
    Protected Internal Method Provides the Pane with the option to customize its ContextMenu before it is displayed.  
    Protected Internal Method Optional override to create the visible content of the control.  
    Protected Internal Method Notification letting the Pane know it has been docked.  
    Protected Internal Method Occurs when a mouse button is clicked two or more times.  
    Protected Internal Method Notification letting the Pane know it has been floated.  
    Protected Internal Method Notification letting the Pane know it has been hidden.  
    Protected Internal Method Called during OnKeyDown if when a register shortcut matches. (Inherited from ArcGIS.Desktop.Framework.Contracts.PaneBase)
    Protected Internal Method Occurs when a key is pressed while focus is on this element.  
    Protected Internal Method Occurs when a key is released while focus is on this element.  
    Protected Internal Method Occurs when any mouse button is pressed while the pointer is over this element.  
    Protected Internal Method Occurs when the mouse pointer moves while over this element.  
    Protected Internal Method Occurs when any mouse button is released over this element.  
    Protected Internal Method Occurs when a pointer is pressed while over this element.  
    Protected Internal Method Occurs when a pointer is released over this element.  
    Protected Internal Method Occurs when a touch event occurs over this element.  
    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 Method Stops the Pane from impersonating a different state.  
    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