IAdmCustomCommand

The IAdmCustomCommand interface represents a custom command.

Inheritance: IAdmBusinessRule

Methods

Properties

  • Property

  • Description

  • 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.

  • CommandIcon

  • Gets or sets the index of the icon associated with the custom command.

  • Parameters

  • Gets or sets custom command parameters.

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 with value references replaced with values of corresponding properties of the given object.

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

Parameters

  • targetObject - Specifies the object whose properties will be used to replace value references.
  • arguments - Specifies arguments for custom command execution. Before calling this method, replace value references in the arguments with values of corresponding properties of the object specified in the targetObject parameter. To replace the value references, call the IAdmCustomCommandArguments::ResolveValueReferences method.
  • text - Specifies the text in which to replace value references with property values.
  • warnings - An output (OUT) parameter that returns an array of warnings issued while resolving value references.

CommandName

Gets the name of the custom command.

  • Type:
  • string
  • Access:
  • Read-only

CommandID

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

  • Type:
  • string
  • Access:
  • Read-only

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.

  • Type:
  • string
  • Access:
  • Read/Write

CommandIcon

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

  • Type:
  • Object
  • Access:
  • Read/Write

Parameters

Gets or sets custom command parameters.

Requirements

Minimum required version: 2023

See also

© Softerra 2022. All rights reserved.
Send feedback