Share

Editor.GetKeywords(PromptKeywordOptions) Method

Description

Gets user input for a keyword.

Wraps the acedGetKword() ObjectARX function.

The 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 tries again (and redisplays prompt, if one was specified). If the user types only [Return], GetKeywords() returns an empty string ("") unless the call to GetInteger() also disallowed null input.

Note: The underscore character ("_") has a special meaning and can't be used as a keyword or as part of a keyword.

Visual Basic

Public Function GetKeywords(
    options As PromptKeywordOptions
) As PromptResult

C#

public PromptResult GetKeywords(
    PromptKeywordOptions options
);

Parameters

Parameters Description
PromptKeywordOptions options Input optional parameters of the prompt.

Links

Editor Class, Autodesk.AutoCAD.EditorInput Namespace

Was this information helpful?