MLightCAD
    Preparing search index...

    Interface AcEdKeywordPromptFormat

    Structured keyword-prompt render payload used by command-line UI.

    This interface captures the canonical AutoCAD-style keyword section that appears after the prompt message, including:

    • visible keyword labels inside [...]
    • optional default keyword inside <...>
    • the fully composed tail text ending with :

    Typical rendered form: Specify option [Yes/No] <Yes>:

    interface AcEdKeywordPromptFormat {
        defaultKeyword?: string;
        formattedTail: string;
        visibleKeywords: string[];
    }
    Index

    Properties

    defaultKeyword? formattedTail visibleKeywords

    Properties

    defaultKeyword?: string

    Display name of the default keyword, when one is configured and visible.

    The value corresponds to what should be shown inside angle brackets in the prompt tail, e.g. <Yes>. When no default keyword is active (or when the default is hidden), this field is undefined.

    formattedTail: string

    Canonical AutoCAD-style keyword suffix for prompt rendering.

    Standard form:

    • [K1/K2]: when no default keyword exists
    • [K1/K2] <K1>: when a default keyword exists

    This string is intended to be appended after the prompt message, e.g.: Specify option [Yes/No] <Yes>:

    visibleKeywords: string[]

    Ordered list of visible keyword display names.

    Notes:

    • The order matches prompt-rendering order in the command line.
    • Hidden keywords are excluded.
    • Values are display strings (localized UI labels), not global tokens.

    Settings

    Member Visibility

    On This Page

    Properties