IAdmParameter

The IAdmParameter interface is the base interface for all interfaces that represent parameters.

Inheritance: IUnknown

Methods

  • Method

  • Description

  • ValueToString()

  • Returns a string representation of the given parameter value.

Properties

  • Property

  • Description

  • ID

  • Gets or sets a unique identifier of the parameter.

  • Type

  • Gets the type of the parameter.

  • Name

  • Gets or sets the parameter name.

  • DisplayName

  • Gets or sets an optional display name for the parameter.

  • RawDisplayName

  • Gets the parameter display name.

  • Visible

  • Gets or sets a value indicating whether the parameter is visible.

  • DefaultValue

  • Gets or sets a default value for the parameter.

  • Hint

  • Gets or sets an optional parameter hint.

  • HelpText

  • Gets or sets an optional parameter description.

Details

ValueToString()

Returns a string representation of the given parameter value.

string ValueToString(object value, ADM_VALUETARGET_ENUM valueTarget)

Parameters

  • value - Specifies the parameter value.
  • valueTarget - Specifies how the parameter value is used.

Remarks

This method does not resolve value references in the parameter value.

ID

Gets or sets a unique identifier of the parameter. A unique identifier is automatically assigned to a parameter after creation.

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

Type

Gets the type of the parameter.

Name

Gets or sets the parameter name.

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

Remarks

  • This property always gets a parameter name with the param- prefix (e.g. param-MyParameter).
  • You can set a parameter name with or without the param- prefix.
  • Allowed parameter name characters include letters (A-z), digits (0-9), semicolons (;), and dashes (-). A parameter name must begin with a letter (A-z).

DisplayName

Gets or sets an optional display name for the parameter. If the parameter display name is not set, this property gets the value specified in the Name property without the param- prefix.

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

RawDisplayName

Gets the parameter display name. Unlike the DisplayName property, this property is empty if the parameter display name is not set.

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

Visible

Gets or sets a value indicating whether the parameter is visible.

  • Type:
  • bool
  • Access:
  • Read/Write

DefaultValue

Gets or sets a default value for the parameter. You can use value references in the value (e.g. %username%).

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

Hint

Gets or sets an optional parameter hint.

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

HelpText

Gets or sets an optional parameter description. You can use HTML tags in the description.

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

Requirements

Minimum required version: 2018.1

See also

© Softerra 2022. All rights reserved.
Send feedback