IAdmCustomCommand

The IAdmCustomCommand interface represents a custom command.

Inheritance: IAdmBusinessRule

Methods

Properties

Details

CreateParameter()

Creates a custom command parameter of the given type.

IAdmParameter CreateParameter(ADM_PARAMETERTYPE_ENUM type)

---

CreateArguments()

Creates an instance of the IAdmCustomCommandArguments interface that represents custom command arguments.

IAdmCustomCommandArguments CreateArguments()

---

ResolveValueReferences()

Returns the given text and replaces value references within with the values of the corresponding properties of the specified object.

string ResolveValueReferences(IAdmTop targetObject,
                              IAdmCustomCommandArguments arguments,
                              string text,
                              out string[] warnings)

Parameters

• targetObject – the object whose properties will replace value references.
• arguments – the arguments for custom command execution.
• text – the text with value references which should be replaced with property values.
• warnings – an output (OUT) parameter that returns an array of warnings issued while resolving value references.

---

Remarks

Before passing an IAdmCustomCommandArguments instance to the arguments parameter, first resolve value references in the arguments using the IAdmCustomCommandArguments::ResolveValueReferences method.

CommandName

Gets the name of the custom command.

---

CommandID

Gets the globally unique identifier (GUID) of the custom command.

---

Confirmation

Gets or sets the confirmation text that is displayed before the custom command is executed. When set to an empty string, the custom command is executed without any confirmation.

---

CommandIcon

Gets or sets the index of the icon associated with the custom command. Set this property to 0 if you don't want any icon to be associated with the custom command.

---

Parameters

Gets or sets custom command parameters.

---

Requirements

Minimum required version: 2023

See also

• Managing custom commands
• IAdmBusinessRule