Property Page Controls

Most controls are typically inherently tied to the data type of the associated parameter. For example, a check box is the default control for a boolean parameter and a numeric control (normally with both an edit control and a slider) is the default control for any numeric parameter.

There are also alternate controls, like the icon list control, which functions like a radio control but displays a bitmap icon instead of the radio button. Another example is the list box and combo (drop-down) box controls which both offer a set of choices to the user but one (list box) is more suited to short lists than the other (combo box).

The command button control is not directly associated with a parameter. In this case, a function in the underlying logic is executed when the user clicks the button. This function may perform tasks using the parameter data from the associated property set.

The various controls available on the Property Page Layout or Property Page Layout are summarized in the following table. The Name column contains links to more specific information about the control, including which attributes it supports:

Name	Category	Data Type	Default	Description	siPPGControlType value
Static Text	Labels	string		Displays value of a string parameter as read-only. This can be used to add instructions to a Property Page.	siControlStatic
Bitmap Widget	Labels	anything		Generally used for displaying bitmap (icon or logo), this control is associated with a real parameter on the underlying CustomProperty but the value is neither read nor changed.	siControlBitmap
Single-line Text	Editable Text Boxes	string	yes	Editable text box; default control for a string parameter.	siControlString
Multi-line Text	Editable Text Boxes	string		Editable text box; the size and style can be customized.	siControlEdit
Text Editor Widget	Editable Text Boxes	string		Editable text box; greater customization is possible.	siControlEdit
List Box	Enum Controls	string or numeric (integers, longs, floats and doubles)		Lists a number of options (read-only values); but only one item can be selected at a time; supports scroll bars.	siControlListBox
Combo/Drop-Down Box	Enum Controls	string or numeric (integers, longs, floats and doubles)		Lists a number of options (read-only values) with only the selected item visible; user clicks on control to display all possible items to choose from; well-suited for large lists.	siControlCombo
Radio Buttons	Enum Controls	string or numeric (integers, longs, floats and doubles)		Lists all options (read-only values) on the page at the same time; user clicks on small circle to select one at a time; well-suited for small lists.	siControlRadio
Icon Buttons	Enum Controls	string or numeric (integers, longs, floats and doubles)		Lists all options (read-only values) on the page at the same time; user clicks on specified (bitmap) icon to select one at a time; well-suited for small lists.	siControlIconList
Bitfield	Enum Controls	numeric (integers, longs, floats and doubles)		Set of small squares indicating whether or not the underlying value is added to the total for the control; user clicks the control to toggle between true and false.	siControlCheck
File Browser Widget	Path Controls	string		Edit box for string path of file and widget for calling the File Browser to pick a file.	siControlFilePath
Folder Widget	Path Controls	string		Edit box for string path of folder and widget for calling the Folder Picker to pick a directory.	siControlFolder
Numeric Edit Box with Slider	Numeric Controls	numeric (integers, longs, floats and doubles)	yes	Numeric edit box for manually typing numbers; optionally includes slider; default for all numeric parameters.	siControlNumber
RGB Color Control	Numeric Controls	(3) doubles		Softimage color control with three channels (no Alpha); associated with 3 underlying parameters (one for each channel).	siControlRGB
RGBA Color Control	Numeric Controls	(4) doubles		Softimage color control with four channels; associated with 4 underlying parameters (one for each channel).	siControlRGBA
FCurve Widget	FCurve Widget	FCurve or FCurve	yes	Softimage fcurve control; changes can be handled by OnChanged events in Logic like other controls.	siControlFCurve
GridData Widget	GridData Widget	GridData or GridData	yes	Multi-column list control, similar to a spreadsheet; supports 2-dimensional array.	siControlGrid
Synoptic Widget	Synoptic Widget	string		A control that shows a synoptic view. You use this control with a string parameter whose value is the full path to the synoptic file.	siControlSynoptic
Check Box	Check Box	boolean	yes	Small square indicating true value if checkmark is visible; user clicks the control to toggle between true and false.	siControlBoolean
Command Button	Command Button	none	n/a	Buttons that are linked to OnClicked events in Logic; no underlying parameters are associated with buttons.	siControlButton

Except where otherwise noted, this work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License

Property Page Controls

Topics in this section