IAdmParameterCheck

The IAdmParameterCheck interface represents a parameter that can have one of the following states: selected, cleared, or undetermined. Each state corresponds to a specific parameter value.

Inheritance: IAdmParameter

Methods

Properties

Details

GetStateByValue()

Returns the parameter state by the given value.

int GetStateByValue(object value)

ValueWhenChecked

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

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

ValueWhenUnchecked

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

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

ValueWhenUndetermined

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

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

Remarks

This property is ignored if the ThreeStateCheck property is set to false.

ThreeStateCheck

Gets or sets a value indicating whether the parameter has the undetermined state (neither selected nor cleared).

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

DefaultState

Gets the default state of the parameter.

  • Type:
  • int
  • Access:
  • Read-only

Remarks

To set the default state, use the IAdmParameter::DefaultValue property.

Possible parameter states

0 - cleared

1 - selected

2 - undetermined

Requirements

Minimum required version: 2018.1

See also

© Softerra 2022. All rights reserved.
Send feedback