Class AcEdPromptIntegerOptions

Options for prompting the user to enter an integer (whole number), similar to AutoCAD .NET PromptIntegerOptions.

Inherits common numeric‑prompt behavior from AcEdPromptNumericalOptions, and adds integer-specific configuration for minimum and maximum allowed values.

Hierarchy (View Summary)

AcEdPromptNumericalOptions
- AcEdPromptIntegerOptions

Index

Constructors

constructor

new AcEdPromptIntegerOptions(
    message: string,
    lowerLimit?: number,
    upperLimit?: number,
): AcEdPromptIntegerOptions
Constructs a new AcEdPromptIntegerOptions.

AutoCAD .NET provides multiple overloads. This constructor supports the same idea by allowing:
- just a message, or
- a message + lower limit, or
- a message + lower + upper limit.
Parameters
- message: string
  The message displayed to the user when prompting for an integer.
- OptionallowerLimit: number
  (optional) Minimum allowed integer value. Enables useLowerLimit.
- OptionalupperLimit: number
  (optional) Maximum allowed integer value. Enables useUpperLimit.
Returns AcEdPromptIntegerOptions
Overrides AcEdPromptNumericalOptions.constructor
- Defined in editor/input/prompt/AcEdPromptIntegerOptions.ts:27

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 editor/input/prompt/AcEdPromptNumericalOptions.ts:70
set allowArbitraryInput(flag: boolean): void
Parameters
- flag: boolean
Returns void
Inherited from AcEdPromptNumericalOptions.allowArbitraryInput
- Defined in 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 editor/input/prompt/AcEdPromptNumericalOptions.ts:83
set allowNegative(flag: boolean): void
Parameters
- flag: boolean
Returns void
Inherited from AcEdPromptNumericalOptions.allowNegative
- Defined in 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 editor/input/prompt/AcEdPromptNumericalOptions.ts:56
set allowNone(flag: boolean): void
Parameters
- flag: boolean
Returns void
Inherited from AcEdPromptNumericalOptions.allowNone
- Defined in 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 editor/input/prompt/AcEdPromptNumericalOptions.ts:96
set allowZero(flag: boolean): void
Parameters
- flag: boolean
Returns void
Inherited from AcEdPromptNumericalOptions.allowZero
- Defined in 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 editor/input/prompt/AcEdPromptOptions.ts:57
set appendKeywordsToMessage(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AcEdPromptNumericalOptions.appendKeywordsToMessage
- Defined in editor/input/prompt/AcEdPromptOptions.ts:61

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 editor/input/prompt/AcEdPromptNumericalOptions.ts:30
set defaultValue(val: number): void
Parameters
- val: number
Returns void
Inherited from AcEdPromptNumericalOptions.defaultValue
- Defined in 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 editor/input/prompt/AcEdPromptOptions.ts:72

jig

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

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

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 editor/input/prompt/AcEdPromptOptions.ts:80

lowerLimit

get lowerLimit(): undefined | number
Gets or sets the minimum allowed integer value. Corresponds to PromptIntegerOptions.LowerLimit in AutoCAD .NET API.

Returns undefined | number
- Defined in editor/input/prompt/AcEdPromptIntegerOptions.ts:43
set lowerLimit(val: undefined | number): void
Parameters
- val: undefined | number
Returns void
- Defined in editor/input/prompt/AcEdPromptIntegerOptions.ts:47

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 editor/input/prompt/AcEdPromptOptions.ts:43
set message(msg: string): void
Parameters
- msg: string
Returns void
Inherited from AcEdPromptNumericalOptions.message
- Defined in editor/input/prompt/AcEdPromptOptions.ts:47

upperLimit

get upperLimit(): undefined | number
Gets or sets the maximum allowed integer value. Corresponds to PromptIntegerOptions.UpperLimit in AutoCAD .NET API.

Returns undefined | number
- Defined in editor/input/prompt/AcEdPromptIntegerOptions.ts:57
set upperLimit(val: undefined | number): void
Parameters
- val: undefined | number
Returns void
- Defined in editor/input/prompt/AcEdPromptIntegerOptions.ts:61

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 editor/input/prompt/AcEdPromptNumericalOptions.ts:43
set useDefaultValue(flag: boolean): void
Parameters
- flag: boolean
Returns void
Inherited from AcEdPromptNumericalOptions.useDefaultValue
- Defined in editor/input/prompt/AcEdPromptNumericalOptions.ts:46

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 AcEdPromptNumericalOptions.setMessageAndKeywords
- Defined in editor/input/prompt/AcEdPromptOptions.ts:97

Class AcEdPromptIntegerOptions

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns AcEdPromptIntegerOptions

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 undefined | AcEdPreviewJig<T>

Parameters

Returns void

keywords

Returns AcEdKeywordCollection

lowerLimit

Returns undefined | number

Parameters

Returns void

message

Returns string

Parameters

Returns void

upperLimit

Returns undefined | number

Parameters

Returns void

useDefaultValue

Returns boolean

Parameters

Returns void

Methods

setMessageAndKeywords

Parameters

Returns this

Settings

On This Page