CAM API
  • CAM API
v20.0.1
Search Results for

    Show / Hide Table of Contents

    Interface ICamApiMacroStepInfo

    Information about a single recorded step in a macro. Provides human-readable display text for UI presentation and step highlighting.

    Namespace: CAMAPI.Macros
    Assembly: CAMAPI.Macros.dll
    Syntax
    [Guid("E1F2A3B4-C5D6-4E78-9012-ABCDEF345678")]
    [InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
    public interface ICamApiMacroStepInfo

    Properties

    DisplayText

    Human-readable description of this step, may contain {N} placeholders for editable params

    Declaration
    string DisplayText { get; }
    Property Value
    Type Description
    string

    GroupCaption

    Optional UI grouping caption. Consecutive steps carrying the same non-empty caption are folded into a single collapsible row by MacrosFrm (header + N sub-rows). Empty for ungrouped steps.

    Declaration
    string GroupCaption { get; }
    Property Value
    Type Description
    string

    IsComposite

    True if this step renders as a collapsible composite row (header caption + chevron over a vertical sub-panel of editable_params). Resolved from the command descriptor.

    Declaration
    bool IsComposite { get; }
    Property Value
    Type Description
    bool

    IsModelItem

    True if this is a selectModelItem step — the single editable param renders as a read-only label with a clear (x) + geom-pickup affordance, not a free-form edit.

    Declaration
    bool IsModelItem { get; }
    Property Value
    Type Description
    bool

    IsUseCurrent

    Current value of the use_current flag (initial visual state of the star toggle).

    Declaration
    bool IsUseCurrent { get; }
    Property Value
    Type Description
    bool

    OpType

    Operation type for setOperationParam rows (drives locale prop-caption + enum resolution host-side). Empty for other steps.

    Declaration
    string OpType { get; }
    Property Value
    Type Description
    string

    Param[int]

    Declaration
    ICamApiMacroStepParam Param[int Index] { get; }
    Parameters
    Type Name Description
    int Index
    Property Value
    Type Description
    ICamApiMacroStepParam

    ParamCount

    Number of editable parameters for this step

    Declaration
    int ParamCount { get; }
    Property Value
    Type Description
    int

    PropPath

    Property path for setOperationParam rows. Empty for other steps.

    Declaration
    string PropPath { get; }
    Property Value
    Type Description
    string

    SupportsUseCurrent

    True if the row exposes the "use current item" toggle (the star button).

    Declaration
    bool SupportsUseCurrent { get; }
    Property Value
    Type Description
    bool
    In this article