Options for prompting the user to enter a string, similar to AutoCAD .NET PromptStringOptions.

Allows configuration of whether spaces are permitted, default values, and whether the default should be used when the user presses ENTER.

Hierarchy (View Summary)

Constructors

Accessors

  • get appendKeywordsToMessage(): boolean

    Gets or sets whether keywords should be appended automatically to the message when rendering. In AutoCAD .NET, this is PromptOptions.AppendKeywordsToMessage.

    Returns boolean

  • set appendKeywordsToMessage(value: boolean): void

    Parameters

    • value: boolean

    Returns void

  • get isReadOnly(): boolean

    Gets whether this AcEdPromptOptions is read-only. When read-only, properties such as message and appendKeywordsToMessage cannot be changed. Corresponds to PromptOptions.IsReadOnly.

    Returns boolean

Methods

  • Sets both the prompt message and the display keywords from a single combined string. This corresponds to PromptOptions.SetMessageAndKeywords(string messageAndKeywords, string globalKeywords) in the .NET API.

    The messageAndKeywords string is typically of the form "Message text [Keyword1/Keyword2/...]". The globalKeywords parameter is a space-separated list of global keyword names.

    After calling this, the message is updated to the part before the [ ... ], and the keywords collection is updated to contain the specified global keywords.

    Parameters

    • messageAndKeywords: string

      The combined message and keywords for the prompt.

    • globalKeywords: string

      A space-separated string listing the global names of the keywords.

    Returns this