Class AcEdPromptSelectionOptions

Represents prompt options for one selection set Mirrors Autodesk.AutoCAD.EditorInput.PromptSelectionOptions.

Hierarchy (View Summary)

AcEdPromptOptions<string>
- AcEdPromptSelectionOptions

Index

Constructors

Accessors

appendKeywordsToMessage isReadOnly jig keywords message singleOnly

Methods

setMessageAndKeywords

Constructors

constructor

new AcEdPromptSelectionOptions(message: string): AcEdPromptSelectionOptions
Parameters
- message: string
Returns AcEdPromptSelectionOptions
Overrides AcEdPromptOptions.constructor
- Defined in editor/input/prompt/AcEdPromptSelectionOptions.ts:11

Accessors

appendKeywordsToMessage

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
Inherited from AcEdPromptOptions.appendKeywordsToMessage
- Defined in editor/input/prompt/AcEdPromptOptions.ts:59
set appendKeywordsToMessage(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AcEdPromptOptions.appendKeywordsToMessage
- Defined in editor/input/prompt/AcEdPromptOptions.ts:63

isReadOnly

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
Inherited from AcEdPromptOptions.isReadOnly
- Defined in editor/input/prompt/AcEdPromptOptions.ts:74

jig

get jig(): undefined | AcEdPreviewJig<T>
Gets or sets the preview jig in the prompt.

Returns undefined | AcEdPreviewJig<T>
Inherited from AcEdPromptOptions.jig
- Defined in editor/input/prompt/AcEdPromptOptions.ts:31
set jig(jig: undefined | AcEdPreviewJig<T>): void
Parameters
- jig: undefined | AcEdPreviewJig<T>
Returns void
Inherited from AcEdPromptOptions.jig
- Defined in editor/input/prompt/AcEdPromptOptions.ts:35

keywords

get keywords(): AcEdKeywordCollection
Gets the collection of keywords for this prompt. Mirrors PromptOptions.Keywords in AutoCAD .NET API.

Returns AcEdKeywordCollection
Inherited from AcEdPromptOptions.keywords
- Defined in editor/input/prompt/AcEdPromptOptions.ts:82

message

get message(): string
Gets or sets the message displayed in the prompt. Corresponds to PromptOptions.Message in AutoCAD .NET API.

Returns string
Inherited from AcEdPromptOptions.message
- Defined in editor/input/prompt/AcEdPromptOptions.ts:45
set message(msg: string): void
Parameters
- msg: string
Returns void
Inherited from AcEdPromptOptions.message
- Defined in editor/input/prompt/AcEdPromptOptions.ts:49

singleOnly

get singleOnly(): boolean
Gets or sets whether to force single object selection only

Returns boolean
- Defined in editor/input/prompt/AcEdPromptSelectionOptions.ts:18
set singleOnly(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in editor/input/prompt/AcEdPromptSelectionOptions.ts:22

Methods

setMessageAndKeywords

setMessageAndKeywords(messageAndKeywords: string, globalKeywords: string): this
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
Inherited from AcEdPromptOptions.setMessageAndKeywords
- Defined in editor/input/prompt/AcEdPromptOptions.ts:99