Acad.PromptDistanceOptions Function
File
Autodesk.AutoCAD.js
Syntax
JavaScript
function Acad.PromptDistanceOptions(messageAndKeywords);Group
Parameters
| Parameter | Description |
|---|---|
| messageAndKeywords | is the prompt message along with keywords. |
Returns
PromptDistanceOptions
Description
This class represents optional parameters for a distance prompt. This function is derived from Acad.PromptEditorOptions.
Properties
| Name | Type | Description | Condition |
|---|---|---|---|
| basePoint | Acad.Point3d | Gets or sets the base point to be used. | Read-write |
| defaultValue | number | The default value to be used when you press enter without any other input. | Read-write |
| only2d | boolean | Gets or sets whether or not the distance returned must be measured as a 2D projection to the UCS. | Read-write |
| useBasePoint | boolean | Gets or sets whether or not the base point is to be used or not. | Read-write |
| useDashedLine | boolean | Gets or sets whether or not a dashed "rubber band" line is to be drawn between the base point and the cursor's current location while prompting. | Read-write |
Exception
Throws a TypeError object.