IAdmParameterPredefinedValue

The IAdmParameterPredefinedValue interface represents a value predefined for a parameter.

Inheritance: IUnknown

Properties

  • Property

  • Description

  • ID

  • Gets or sets a unique identifier of the predefined parameter value.

  • DisplayName

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

  • RawDisplayName

  • Gets the display name of the predefined parameter value.

  • Value

  • Gets or sets a value of the predefined parameter value.

  • IsDefault

  • Gets or sets a value indicating whether the predefined parameter value is used by default.

Details

ID

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

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

DisplayName

Gets or sets an optional display name for the predefined parameter value. You can use value value references in the display name (e.g. %username%).

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

Remarks

If the display name is not set, this property gets the value specified in the Value property.

RawDisplayName

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

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

Value

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

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

IsDefault

Gets or sets a value indicating whether the predefined parameter value is used by default. If multiple predefined values are marked as default, the first one is used.

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

Requirements

Minimum required version: 2018.1

See also

© Softerra 2022. All rights reserved.
Send feedback