VtGet(VTCL)

VtGet -- return value of specified option for given widget

VtGetValues- synonym of VtGet

Synopsis

VtGet widgetName [option]
VtGetValues widgetName [option]

Description

Returns the value of the specified option for the given widget. Only options which have a "G" next to the option name in the command reference can be retrieved with VtGet. VtGet can retrieve multiple options from a single widget in a single command. The options are retrieved in the order in which they appear on the command line.

Options

Any valid options for the particular widget. For example, to return the label string for the widget $myLabel:

set label [VtGet $myLabel -label]

You can specify one of the dialog options -apply, -cancel, -help,-ok, or -reset to retrieve the widget name of the corresponding built-in button on a form. For example, to get the widget name of the Help button on the form $myForm:

set helpbutton [VtGet $myForm -help]

Return values

If VtGet fails, it returns one of the following error messages:

NOT_GETTABLE: the option is not gettable
OPTION_COUNT: too many or too few options specified
Standard errors: See ``Tcl widget creation errors'' in Developing Visual Tcl applications.

References

VtSet(VTCL)