Acad.Editor.getKeywords Function

File

Autodesk.AutoCAD.js

Syntax

JavaScript

function Acad.Editor.getKeywords(options);

Group

ACAD Namespace

Parameters

Returns

A Acad.PromptResults in the success callback function.

This function returns a promise pattern result, it has to be called as a Promise Pattern with .then(onSuccess, onError) function.

Description

Use this function to get a keyword as user input. It wraps the acedGetKword() ObjectARX function.

An AutoCAD user can enter the keyword from the keyboard. The list of keywords that GetKeywords() accepts is set by a prior call to GetInteger(). If the user enters a string not specified in the call to GetInteger(), AutoCAD displays an error message and retries (and redisplays prompt, if one was specified). If the user press Enter, GetKeywords() returns an empty string ("") unless the call to GetInteger() also disallowed null input.

Exception

Throws a TypeError object.

Links

ACAD Namespace