ArcGIS Pro 3.2 API Reference Guide
ArcGIS.Desktop.Workflow.Client Namespace / WorkflowClientModule Class
Properties Methods Events


In This Topic
    WorkflowClientModule Class Members
    In This Topic

    The following tables list the members exposed by WorkflowClientModule.

    Public Properties
     NameDescription
    Public PropertyCaption Gets the name of the Module. (Inherited from ArcGIS.Desktop.Framework.Contracts.Module)
    Public Propertystatic (Shared in Visual Basic)IsConnected Gets whether the module is connected to a Workflow Manager Server instance.  
    Public Propertystatic (Shared in Visual Basic)ItemId Gets the Id of the Workflow Manager item associated with the Workflow Manager connection.  
    Public Propertystatic (Shared in Visual Basic)JobsManager Get the manager class for all Job-related functionality.  
    Public Propertystatic (Shared in Visual Basic)ServerUrl Gets the server url of the Workflow Manager connection.  
    Top
    Protected Properties
     NameDescription
    Protected Internal PropertyID Gets the DAML identifier. (Inherited from ArcGIS.Desktop.Framework.Contracts.Module)
    Top
    Public Methods
     NameDescription
    Public MethodGetSuggestedCMDIDs Gets the set of Search Suggestion IDs. (Inherited from ArcGIS.Desktop.Framework.Contracts.Module)
    Top
    Protected Methods
     NameDescription
    Protected Internal MethodCanCopyAsync Modules are constantly polled giving them the opportunity to enable the application's Copy button. (Inherited from ArcGIS.Desktop.Framework.Contracts.Module)
    Protected Internal MethodCanCopyPathAsync Modules are constantly polled giving them the opportunity to enable the application's Copy Path button. (Inherited from ArcGIS.Desktop.Framework.Contracts.Module)
    Protected Internal MethodCanCutAsync Modules are constantly polled giving them the opportunity to enable the application's Cut button. (Inherited from ArcGIS.Desktop.Framework.Contracts.Module)
    Protected Internal MethodCanDeleteAsync Modules are constantly polled giving them the opportunity to enable the application's Delete button. (Inherited from ArcGIS.Desktop.Framework.Contracts.Module)
    Protected Internal MethodCanDuplicateAsync Modules are constantly polled giving them the opportunity to enable the application's Duplicate button. (Inherited from ArcGIS.Desktop.Framework.Contracts.Module)
    Protected Internal MethodCanPasteAsync Modules are constantly polled giving them the opportunity to enable the application's Paste button. (Inherited from ArcGIS.Desktop.Framework.Contracts.Module)
    Protected Internal MethodCanPasteSpecialAsync Modules are constantly polled giving them the opportunity to enable the application's PasteSpecial button. (Inherited from ArcGIS.Desktop.Framework.Contracts.Module)
    Protected Internal MethodCanUnload When overridden in a derived class, a Module can return that it can't be unloaded. (Inherited from ArcGIS.Desktop.Framework.Contracts.Module)
    Protected Internal MethodCopyAsync Called when the Copy command is executed. (Inherited from ArcGIS.Desktop.Framework.Contracts.Module)
    Protected Internal MethodCopyPathAsync Called when the CopyPath command is executed. (Inherited from ArcGIS.Desktop.Framework.Contracts.Module)
    Protected Internal MethodCutAsync Called when the Cut command is executed. (Inherited from ArcGIS.Desktop.Framework.Contracts.Module)
    Protected Internal MethodDeleteAsync Called when the Delete command is executed. (Inherited from ArcGIS.Desktop.Framework.Contracts.Module)
    Protected Internal MethodDuplicateAsync Called when the Duplicate command is executed. (Inherited from ArcGIS.Desktop.Framework.Contracts.Module)
    Protected Internal MethodExecuteCommand Override this method to allow users to execute DAML commands specified in this module. (Inherited from ArcGIS.Desktop.Framework.Contracts.Module)
    Protected Internal MethodExecuteCommandArgs Override this method to allow users to execute DAML commands specified in this module. (Inherited from ArcGIS.Desktop.Framework.Contracts.Module)
    Protected MethodNotifyPropertyChangedOverloaded.  (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Protected Internal MethodOnPaneActivated Called by the Framework when a Pane is activated. (Inherited from ArcGIS.Desktop.Framework.Contracts.Module)
    Protected Internal MethodOnPaneClosed Called by the Framework when a Pane is closed. (Inherited from ArcGIS.Desktop.Framework.Contracts.Module)
    Protected Internal MethodOnPaneClosing Called by the Framework when one of the Module's Pane is about to close. (Inherited from ArcGIS.Desktop.Framework.Contracts.Module)
    Protected Internal MethodOnPaneDeactivated Called by the Framework when a Pane is deactivated. (Inherited from ArcGIS.Desktop.Framework.Contracts.Module)
    Protected Internal MethodOnPaneOpened Called by the Framework when a new Pane is opened. This occurs after the pane has been fully initialized. (Inherited from ArcGIS.Desktop.Framework.Contracts.Module)
    Protected Internal MethodOnReadSettingsAsync Override this method to read custom settings written to the current project. (Inherited from ArcGIS.Desktop.Framework.Contracts.Module)
    Protected Internal MethodOnUpdate Called periodically by the framework once the module has been loaded. (Inherited from ArcGIS.Desktop.Framework.Contracts.Module)
    Protected Internal MethodOnWriteSettingsAsync Override this method to write custom settings to the current project when it is saved. (Inherited from ArcGIS.Desktop.Framework.Contracts.Module)
    Protected Internal MethodPasteAsync Called when the Paste command is executed. (Inherited from ArcGIS.Desktop.Framework.Contracts.Module)
    Protected Internal MethodPasteSpecialAsync Called when the PasteSpecial command is executed. (Inherited from ArcGIS.Desktop.Framework.Contracts.Module)
    Protected MethodSetPropertyOverloaded.  (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Top
    Public Events
     NameDescription
    Public EventPropertyChanged Occurs when a property value changes. (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Top
    See Also

    Reference

    WorkflowClientModule Class
    ArcGIS.Desktop.Workflow.Client Namespace

     

     

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

    Send feedback