IAdmCustomCommandInfo
The IAdmCustomCommandInfo interface provides information about a custom command.
Methods
-
Method
-
Description
-
GetObjectTypes()
-
Returns an array containing a list of object types on which the custom command can be executed.
Properties
-
Property
-
Description
-
Name
-
Gets the name of the custom command.
-
Description
-
Gets the description of the custom command.
-
Icon
-
Gets the icon associated with the custom command.
-
Disabled
-
Gets a value that indicates whether the custom command is disabled.
-
ID
-
Gets the globally unique identifier (GUID) of the custom command.
-
Confirmation
-
Gets the confirmation text that is displayed before the custom command is executed.
-
Parameters
-
Gets or sets custom command parameters.
Details
GetObjectTypes()
Returns an array containing a list of object types on which the custom command can be executed. Each string in the array contains the name of an object class as defined in your directory schema.
string[] GetObjectTypes()
Name
Gets the name of the custom command.
- Type:
- string
- Access:
- Read-only
Description
Gets the description of the custom command.
- Type:
- string
- Access:
- Read-only
Icon
Gets the icon associated with the custom command. If no icon is associated with the custom command, the property is 0 (zero).
- Type:
- Object
- Access:
- Read-only
Disabled
Gets a value that indicates whether the custom command is disabled.
- Type:
- bool
- Access:
- Read-only
ID
Gets the globally unique identifier (GUID) of the custom command.
- Type:
- string
- Access:
- Read-only
Confirmation
Gets the confirmation text that is displayed before the custom command is executed. If the custom command is executed without any confirmation, the property is an empty string.
- Type:
- string
- Access:
- Read-only
Parameters
Gets or sets custom command parameters.
- Type:
- IAdmParameter[]
- Access:
- Read/Write
Requirements
Minimum required version: 2023