Class AcEdKeywordCollection

A collection of AcEdKeyword objects, mirroring Autodesk.AutoCAD.EditorInput.KeywordCollection. Represents the set of valid keywords for a prompt.

Index

Constructors

Accessors

Methods

[iterator] add clear findByDisplayName findByGlobalName getDisplayString toArray

Constructors

constructor

new AcEdKeywordCollection(): AcEdKeywordCollection
Constructs a new, empty AcEdKeywordCollection.

Returns AcEdKeywordCollection
- Defined in editor/input/prompt/AcEdKeywordCollection.ts:12

Accessors

count

get count(): number
Gets the number of keywords in this collection.

Returns number
- Defined in editor/input/prompt/AcEdKeywordCollection.ts:144

default

get default(): undefined | AcEdKeyword
Gets or sets the default keyword for this collection.

Returns undefined | AcEdKeyword
- Defined in editor/input/prompt/AcEdKeywordCollection.ts:91
set default(kw: undefined | AcEdKeyword): void
Parameters
- kw: undefined | AcEdKeyword
Returns void
- Defined in editor/input/prompt/AcEdKeywordCollection.ts:94

Methods

[iterator]

"[iterator]"(): Iterator<AcEdKeyword>
Returns an iterator over the AcEdKeyword objects in this collection.

Returns Iterator<AcEdKeyword>
- Defined in editor/input/prompt/AcEdKeywordCollection.ts:118

add

add(displayName: string): AcEdKeyword
Adds a new keyword (displayName only).
Parameters
- displayName: string
  The text shown to the user for this keyword.
Returns AcEdKeyword
The newly created AcEdKeyword.
- Defined in editor/input/prompt/AcEdKeywordCollection.ts:19
add(globalName: string, localName: string): AcEdKeyword
Adds a new keyword with globalName and localName.
Parameters
- globalName: string
  The internal, non-display name.
- localName: string
  The name that the user types to select the keyword.
Returns AcEdKeyword
The newly created AcEdKeyword.
- Defined in editor/input/prompt/AcEdKeywordCollection.ts:26
add(
    displayName: string,
    globalName: string,
    localName: string,
    enabled?: boolean,
    visible?: boolean,
): AcEdKeyword
Adds a new keyword with displayName, globalName, localName, enabled, visible.
Parameters
- displayName: string
  The text shown to the user.
- globalName: string
  Internal identifier for the keyword.
- localName: string
  The name used by the user to type the keyword.
- Optionalenabled: boolean
  If false, the keyword cannot be selected.
- Optionalvisible: boolean
  If false, the keyword is hidden from display.
Returns AcEdKeyword
The newly created AcEdKeyword.
- Defined in editor/input/prompt/AcEdKeywordCollection.ts:36

clear

clear(): void
Removes all keywords from the collection.

Returns void
- Defined in editor/input/prompt/AcEdKeywordCollection.ts:80

findByDisplayName

findByDisplayName(displayName: string): undefined | AcEdKeyword
Finds a keyword by its display name (case-insensitive).
Parameters
- displayName: string
Returns undefined | AcEdKeyword
- Defined in editor/input/prompt/AcEdKeywordCollection.ts:130

findByGlobalName

findByGlobalName(globalName: string): undefined | AcEdKeyword
Finds a keyword by its global name (case-insensitive).
Parameters
- globalName: string
Returns undefined | AcEdKeyword
- Defined in editor/input/prompt/AcEdKeywordCollection.ts:137

getDisplayString

getDisplayString(showNoDefault?: boolean): string
Returns a string representing the visible, enabled keywords for display.
Parameters
- showNoDefault: boolean = false
Returns string
- Defined in editor/input/prompt/AcEdKeywordCollection.ts:104

toArray

toArray(): AcEdKeyword[]
Copies the keywords of this collection into a plain array.

Returns AcEdKeyword[]
- Defined in editor/input/prompt/AcEdKeywordCollection.ts:86