Arbortext Command Language > Functions by Alphabetical Listing > option_type
  
option_type
option_type (option)
This function returns the type of the specified option. Possible return values are:
• string — type is a string.
• token — type is a token.
Similar to string, except its value should not be quoted in a set command.
• file — type is a file name.
• pathlist — type is a path list (a list of file paths separated by a semicolon).
• bool — type is a boolean (on or off).
• number — type is an integer.
• float — type is a floating point number.
• color — for options that specify foreground colors, type is a color (named color or a RGB value).
• bgcolor — for options that specify background colors, type is a color (named color or a RGB value).
• dimen — type is a dimension (value and a unit).
Valid units are in, cm, mm, pc, pi, pt, em, and px.
• percent — type is a dimension like dimen, but the unit may also be %.
• enum — type is an enumerated type.
Call the option_values function for a list of its valid values.
• num_enum — type is a combination of an integer and an enumerated type.
Call option_values function for a list of its valid enumerated values.
Call option_value_min and option_value_max functions for the range of valid number values.
• hook — type is a hook function.
If the specified option is invalid, then the function returns invalid.
Examples
eval option_type("tagdisplay")
eval option_type("gentext")
option_type("showentities")