Class AcEdPromptEntityOptions

Represents prompt options for selecting a single entity. Mirrors Autodesk.AutoCAD.EditorInput.PromptEntityOptions.

Hierarchy (View Summary)

AcEdPromptOptions<string>
- AcEdPromptEntityOptions

Index

Constructors

constructor

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

Accessors

allowNone

get allowNone(): boolean
Gets or sets whether the user may press ENTER without selecting an entity. Corresponds to PromptEntityOptions.AllowNone.

Returns boolean
- Defined in editor/input/prompt/AcEdPromptEntityOptions.ts:31
set allowNone(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in editor/input/prompt/AcEdPromptEntityOptions.ts:35

allowObjectOnLockedLayer

get allowObjectOnLockedLayer(): boolean
Gets or sets whether entities on locked layers can be selected. Corresponds to PromptEntityOptions.AllowObjectOnLockedLayer.

Returns boolean
- Defined in editor/input/prompt/AcEdPromptEntityOptions.ts:45
set allowObjectOnLockedLayer(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in editor/input/prompt/AcEdPromptEntityOptions.ts:49

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

rejectMessage

get rejectMessage(): string
Gets the rejection message shown when the selected entity is invalid. Corresponds to PromptEntityOptions.RejectMessage.

Returns string
- Defined in editor/input/prompt/AcEdPromptEntityOptions.ts:59

Methods

addAllowedClass

addAllowedClass(className: string): this
Adds an allowed entity class name. Corresponds to PromptEntityOptions.AddAllowedClass().
Parameters
- className: string
  Entity class name (e.g. "Line", "Circle")
Returns this
- Defined in editor/input/prompt/AcEdPromptEntityOptions.ts:80

clearAllowedClasses

clearAllowedClasses(): this
Clears all allowed class restrictions (allow all entities).

Returns this
- Defined in editor/input/prompt/AcEdPromptEntityOptions.ts:101

isClassAllowed

isClassAllowed(className: string): boolean
Checks whether a given entity class is allowed. Used internally by selection logic.
Parameters
- className: string
Returns boolean
- Defined in editor/input/prompt/AcEdPromptEntityOptions.ts:112

removeAllowedClass

removeAllowedClass(className: string): this
Removes an allowed entity class name. Corresponds to PromptEntityOptions.RemoveAllowedClass().
Parameters
- className: string
Returns this
- Defined in editor/input/prompt/AcEdPromptEntityOptions.ts:91

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

setRejectMessage

setRejectMessage(message: string): this
Sets the rejection message. Corresponds to PromptEntityOptions.SetRejectMessage().
Parameters
- message: string
Returns this
- Defined in editor/input/prompt/AcEdPromptEntityOptions.ts:67

Class AcEdPromptEntityOptions

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns AcEdPromptEntityOptions

Accessors

allowNone

Returns boolean

Parameters

Returns void

allowObjectOnLockedLayer

Returns boolean

Parameters

Returns void

appendKeywordsToMessage

Returns boolean

Parameters

Returns void

isReadOnly

Returns boolean

jig

Returns undefined | AcEdPreviewJig<T>

Parameters

Returns void

keywords

Returns AcEdKeywordCollection

message

Returns string

Parameters

Returns void

rejectMessage

Returns string

Methods

addAllowedClass

Parameters

Returns this

clearAllowedClasses

Returns this

isClassAllowed

Parameters

Returns boolean

removeAllowedClass

Parameters

Returns this

setMessageAndKeywords

Parameters

Returns this

setRejectMessage

Parameters

Returns this

Settings

On This Page