Class AcEdPromptDoubleOptions

Options for prompting the user to enter a double-precision (floating point) number, similar to AutoCAD .NET PromptDoubleOptions.

Inherits common numeric-prompt behavior from AcEdPromptNumericalOptions.

Hierarchy (View Summary)

AcEdPromptNumericalOptions
- AcEdPromptDoubleOptions

Index

Constructors

constructor

new AcEdPromptDoubleOptions(
message: string,
globalKeywords?: string,
): AcEdPromptDoubleOptions
Constructs a new AcEdPromptNumericalOptions with a given prompt message.
Parameters
- message: string
  The message shown to the user when prompting for a number.
- OptionalglobalKeywords: string
Returns AcEdPromptDoubleOptions
Inherited from AcEdPromptNumericalOptions.constructor
- Defined in packages/cad-simple-viewer/src/editor/input/prompt/AcEdPromptNumericalOptions.ts:21

Accessors

allowArbitraryInput

get allowArbitraryInput(): boolean
Gets or sets whether arbitrary (non-numeric) input is accepted. If true, the prompt may allow strings or other input, depending on implementation. Corresponds to PromptNumericalOptions.AllowArbitraryInput in AutoCAD .NET API.

Returns boolean
Inherited from AcEdPromptNumericalOptions.allowArbitraryInput
- Defined in packages/cad-simple-viewer/src/editor/input/prompt/AcEdPromptNumericalOptions.ts:70
set allowArbitraryInput(flag: boolean): void
Parameters
- flag: boolean
Returns void
Inherited from AcEdPromptNumericalOptions.allowArbitraryInput
- Defined in packages/cad-simple-viewer/src/editor/input/prompt/AcEdPromptNumericalOptions.ts:73

allowNegative

get allowNegative(): boolean
Gets or sets whether negative numeric values are allowed. Corresponds to PromptNumericalOptions.AllowNegative in AutoCAD .NET API.

Returns boolean
Inherited from AcEdPromptNumericalOptions.allowNegative
- Defined in packages/cad-simple-viewer/src/editor/input/prompt/AcEdPromptNumericalOptions.ts:83
set allowNegative(flag: boolean): void
Parameters
- flag: boolean
Returns void
Inherited from AcEdPromptNumericalOptions.allowNegative
- Defined in packages/cad-simple-viewer/src/editor/input/prompt/AcEdPromptNumericalOptions.ts:86

allowNone

get allowNone(): boolean
Gets or sets whether pressing ENTER alone (no input) is accepted. Corresponds to PromptNumericalOptions.AllowNone in AutoCAD .NET API.

Returns boolean
Inherited from AcEdPromptNumericalOptions.allowNone
- Defined in packages/cad-simple-viewer/src/editor/input/prompt/AcEdPromptNumericalOptions.ts:56
set allowNone(flag: boolean): void
Parameters
- flag: boolean
Returns void
Inherited from AcEdPromptNumericalOptions.allowNone
- Defined in packages/cad-simple-viewer/src/editor/input/prompt/AcEdPromptNumericalOptions.ts:59

allowZero

get allowZero(): boolean
Gets or sets whether zero is an acceptable numeric value. Corresponds to PromptNumericalOptions.AllowZero in AutoCAD .NET API.

Returns boolean
Inherited from AcEdPromptNumericalOptions.allowZero
- Defined in packages/cad-simple-viewer/src/editor/input/prompt/AcEdPromptNumericalOptions.ts:96
set allowZero(flag: boolean): void
Parameters
- flag: boolean
Returns void
Inherited from AcEdPromptNumericalOptions.allowZero
- Defined in packages/cad-simple-viewer/src/editor/input/prompt/AcEdPromptNumericalOptions.ts:99

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 AcEdPromptNumericalOptions.appendKeywordsToMessage
- Defined in packages/cad-simple-viewer/src/editor/input/prompt/AcEdPromptOptions.ts:68
set appendKeywordsToMessage(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AcEdPromptNumericalOptions.appendKeywordsToMessage
- Defined in packages/cad-simple-viewer/src/editor/input/prompt/AcEdPromptOptions.ts:72

defaultValue

get defaultValue(): number
Gets or sets the default numerical value for the prompt. This is used when the user presses ENTER without providing any other input. In the .NET API, derived classes define the type-specific default value (e.g., integer, double).

Returns number
Inherited from AcEdPromptNumericalOptions.defaultValue
- Defined in packages/cad-simple-viewer/src/editor/input/prompt/AcEdPromptNumericalOptions.ts:30
set defaultValue(val: number): void
Parameters
- val: number
Returns void
Inherited from AcEdPromptNumericalOptions.defaultValue
- Defined in packages/cad-simple-viewer/src/editor/input/prompt/AcEdPromptNumericalOptions.ts:33

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 AcEdPromptNumericalOptions.isReadOnly
- Defined in packages/cad-simple-viewer/src/editor/input/prompt/AcEdPromptOptions.ts:83

jig

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

Returns AcEdPreviewJig<T> | undefined
Inherited from AcEdPromptNumericalOptions.jig
- Defined in packages/cad-simple-viewer/src/editor/input/prompt/AcEdPromptOptions.ts:40
set jig(jig: AcEdPreviewJig<T> | undefined): void
Parameters
- jig: AcEdPreviewJig<T> | undefined
Returns void
Inherited from AcEdPromptNumericalOptions.jig
- Defined in packages/cad-simple-viewer/src/editor/input/prompt/AcEdPromptOptions.ts:44

keywords

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

Returns AcEdKeywordCollection
Inherited from AcEdPromptNumericalOptions.keywords
- Defined in packages/cad-simple-viewer/src/editor/input/prompt/AcEdPromptOptions.ts:91

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 AcEdPromptNumericalOptions.message
- Defined in packages/cad-simple-viewer/src/editor/input/prompt/AcEdPromptOptions.ts:54
set message(msg: string): void
Parameters
- msg: string
Returns void
Inherited from AcEdPromptNumericalOptions.message
- Defined in packages/cad-simple-viewer/src/editor/input/prompt/AcEdPromptOptions.ts:58

useDefaultValue

get useDefaultValue(): boolean
Gets or sets whether the default value should be used when the user presses ENTER. Corresponds to PromptNumericalOptions.UseDefaultValue in AutoCAD .NET API.

Returns boolean
Inherited from AcEdPromptNumericalOptions.useDefaultValue
- Defined in packages/cad-simple-viewer/src/editor/input/prompt/AcEdPromptNumericalOptions.ts:43
set useDefaultValue(flag: boolean): void
Parameters
- flag: boolean
Returns void
Inherited from AcEdPromptNumericalOptions.useDefaultValue
- Defined in packages/cad-simple-viewer/src/editor/input/prompt/AcEdPromptNumericalOptions.ts:46

Methods

getKeywordPromptFormat

getKeywordPromptFormat(): AcEdKeywordPromptFormat
Returns AutoCAD-style keyword prompt format data: [Keywords] :

Returns AcEdKeywordPromptFormat
Inherited from AcEdPromptNumericalOptions.getKeywordPromptFormat
- Defined in packages/cad-simple-viewer/src/editor/input/prompt/AcEdPromptOptions.ts:99

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 AcEdPromptNumericalOptions.setMessageAndKeywords
- Defined in packages/cad-simple-viewer/src/editor/input/prompt/AcEdPromptOptions.ts:116

Class AcEdPromptDoubleOptions

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns AcEdPromptDoubleOptions

Accessors

allowArbitraryInput

Returns boolean

Parameters

Returns void

allowNegative

Returns boolean

Parameters

Returns void

allowNone

Returns boolean

Parameters

Returns void

allowZero

Returns boolean

Parameters

Returns void

appendKeywordsToMessage

Returns boolean

Parameters

Returns void

defaultValue

Returns number

Parameters

Returns void

isReadOnly

Returns boolean

jig

Returns AcEdPreviewJig<T> | undefined

Parameters

Returns void

keywords

Returns AcEdKeywordCollection

message

Returns string

Parameters

Returns void

useDefaultValue

Returns boolean

Parameters

Returns void

Methods

getKeywordPromptFormat

Returns AcEdKeywordPromptFormat

setMessageAndKeywords

Parameters

Returns this

Settings

On This Page