Click or drag to resize

CustomDomainCommand Class

Defines a custom command for an IConfigurationDomainNode. AdminConfigurationManagerBase implementations will convert these to ConfigurationDomainCommands and ensure applicable MFAdmin requests will be delegated back to the Execute callback.
Inheritance Hierarchy
SystemObject
  MFiles.VAF.Configuration.AdminConfigurationsCustomDomainCommand

Namespace:  MFiles.VAF.Configuration.AdminConfigurations
Assembly:  MFiles.VAF.Configuration (in MFiles.VAF.Configuration.dll) Version: 2.1.0.1 (2.1.0.1)
Syntax
C#
public class CustomDomainCommand

The CustomDomainCommand type exposes the following members.

Constructors
  NameDescription
Public methodCustomDomainCommand
Initializes a new instance of the CustomDomainCommand class
Top
Properties
  NameDescription
Public propertyBlocking
Indicates whether the interface should be blocked while the command is being executed. Useful for longer running commands where further user interaction with the interface could negatively effect user experience or execution, or simply a way to indicate to the user that something is happening, and when it is over.
Public propertyConfirmMessage
If specified, the message will be displayed to the user in a confirmation dialog after they've triggered the command, but before its execution. They will have the option to proceed or cancel the command.
Public propertyDisplayName
The display name to use for the command. Optional.
Public propertyExecute
The function to call when the command is triggered.
Public propertyHelpText
Help text to expose for the command. Optional.
Public propertyID
A unique identifier for the command. Can be used to reference the command in status dashboards.
Public propertyLocations
A list of locations specifying where and how the command will be shown.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also