Interface ICamApiMacroStepParam

One editable parameter of a macro step (e.g. the value in SetOperationParam). Label and type are fixed at record time; the user may override the value before playback.

Namespace: CAMAPI.Macros

Assembly: CAMAPI.Macros.dll

Syntax

[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[Guid("F8A2E1B3-9C4D-4F56-A789-012345678901")]
public interface ICamApiMacroStepParam

Properties

Caption

Locale-aware sub-row caption for composite rows (resolved from the command descriptor). Empty falls back to the param Key / LabelText.

Declaration

string Caption { get; }

Property Value

Type	Description
string

DefaultValue

Default value recorded at macro creation time

Declaration

string DefaultValue { get; }

Property Value

Type	Description
string

LabelText

Human-readable label for the parameter (e.g. "Значение")

Declaration

string LabelText { get; }

Property Value

Type	Description
string

ParamType

Type of the parameter value

Declaration

TMacroCommandParamType ParamType { get; }

Property Value

Type	Description
TMacroCommandParamType

Required

True if default_value in commands.json was JSON null (or absent). The playback UI must show the parameter as required (empty + red border) and refuse to run the macro until the user supplies a value.

Declaration

bool Required { get; }

Property Value

Type	Description
bool

ValuesString

Semicolon-separated list of allowed values (e.g. "val1;val2;val3"). Empty string means the parameter is free-form (no fixed set).

Declaration

string ValuesString { get; }

Property Value

Type	Description
string

key

Declaration

string key { get; }

Property Value

Type	Description
string