Scripting API

<<GetRasterSelectionRect Main Index GetVectorSelectionRect>>
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

GetString

Script Name: GetString
Name: GetString
Library: CmdExternal
Description: Brings up a dialog and prompts the user for text. The text is checked against a maximum length but it otherwise unverified. The text and the dialog button pressed are returned in the result dictionary.
Status bar text: Prompt the user for text and return the string entered
Tool tip text: Get String
 
Parameter Repository:
NameScript NameType Description Supports None Default Minimum Maximum
DefaultTextDefaultTextStringText that will be placed in the edit field as a default valueNo
DialogTitleDialogTitleStringText to be used in the title bar of the dialog.No
Maximum LengthMaxLengthIntegerMaximum length of the stringNo8011000
PromptPromptStringText displayed above the entry box as a prompt stringNo
General SettingsGeneralSettingsParameter RepositoryContains parameters that control the execution of the command.No
 
Return Type:
NameScript NameType Description Supports None Default Minimum Maximum
ResultResultParameter RepositoryResult dictionary. Contains keys for the returned text and the button pressed on the dialogNo
 
Command Attributes:
IsExternal: true
NoRepeat: true
NoDocumentNeeded: true
 
Resource Attributes: