Constant

Value

Description

siControlBitmap

BitmapWidget

A static bitmap control. The control needs to be associated with a real parameter on the inspected object, but the value is neither read nor changed. This control is often used for displaying a logo. The path is specified using siUIFilePath. For more information, see the Bitmap Widget topic.

siControlBoolean

Boolean

A simple check box. This is the default control for Boolean parameters. For more information, see the Check Box topic.

siControlButton

commandbutton

A button is a special kind of control which is not associated with any parameter of the inspected object. See PPGLayout.AddButton.

Supported attributes are siUICX and siUICY. For more information, see the Command Button topic.

siControlCheck

Check

Bitfield control, showing separate check boxes for each item in the PPGItem.UIItems list. The value of the parameter will be equal to the sum of all the checked items. This control is useful for packing many flags into a single integer while still having a convenient user interface to set or view which flags have been set. For more information, see the Bitfield topic.

siControlCombo

Combo

A read-only edit control, with a drop down menu showing items out of the PPGItem.UIItems list.

Supported attributes are siUICX and siUICY. For more information, see the Combo/Drop-Down Box topic.

siControlEdit

Edit

An edit box control. It is similar to siControlString, however it supports the siUICX, siUICY and siUIStyle attributes and is used as a multi-line string edit box. For more information, see the Multi-line Text topic.

siControlFCurve

FCurveWidget

A control for displaying an FCurve (see PPGLayout.AddFCurve).

Supported optional attributes are siUICX, siUICY, siUIFCurveLabelX, siUIFCurveLabelY, siUIFCurveViewMinX, siUIFCurveViewMaxX, siUIFCurveViewMinY, siUIFCurveViewMaxY, siUIFCurveGridSpaceX, siUIFCurveGridSpaceY, siUIFCurveNoGrid, siUIFCurveNoRulerX, and siUIFCurveNoRulerY. For more information, see the FCurve Widget topic.

siControlFilePath

FilePath

A control for driving a string Parameter containing a file name. The control provides an edit box and a button that launches a file browser (similar to XSIUIToolkit.FileBrowser).

Supported attributes are siUIFileFilter, siUIInitialDir, siUISubFolder, siUIAudioFile, siUIImageFile, siUIOpenFile, siUIFileMustExist, siUIStyle. For more information, see the File Browser Widget topic.

siControlFolder

Folder

A control for driving a string Parameter with an edit box and a button that launches a directory picker.

Supported attributes are siUIInitialDir and siUISubFolder. For more information, see the Folder Widget topic.

siControlGrid

GridWidget

A control of type GridWidget which displays the data from a GridData object. It shows a multi-column list control, similar to a spreadsheet. See CustomProperty.AddGridParameter.

Supported optional attributes are siUICX, siUICY, siUIGridColumnWidths, siUIGridLockColumnHeader, siUIGridLockRowHeader, siUIGridHideColumnHeader, siUIGridReadOnlyColumns, siUIGridHideRowHeader and siUIGridSelectionMode. For more information, see the GridData Widget topic.

Note: This control has no relationship to the geometric shape called a "Grid".

siControlIconList

IconList

Similar to a siControlRadio, except each item is represented by a bitmap on the screen rather than by a text label. Only .bmp files are supported, and the filenames of these files are specified in the PPGItem.UIItems list.

Supported attributes are siUIColumnCnt, siUILineCnt, siUIColumnGap, siUILineGap, siUISelectionColor, and siUIUseSelectionIcon. For more information, see the Icon Buttons topic.

siControlListBox

ListBox

This control is functionally similar to siControlRadio and siControlCombo in that it shows a list of possible items. However, unlike those other controls, you have the option to use the ListBox in a multi-selection mode by using the attribute siUIMultiSelectionListBox.

The siUICX and siUICY attributes can be set to change the size. If no siUIStyle attribute is assigned and the list is too large to fit, the ListBox will display a vertical scroll bar. For more information, see the List Box topic.

siControlNumber

Number

A numeric control, normally with both an edit control and a slider. This is the default control for all numeric parameters.

Supported attributes are siUICX, siUICY, siUISyncSlider, siUILogarithmic, siUIDecimals, siUINoSlider, siUITreadmill and siUIThumbWheel. For more information, see the Numeric Edit Box with Slider topic.

siControlRadio

Radio

Radio control, allowing you to select a single item out of the PPGItem.UIItems list. This is the same behavior as the siControlCombo control, except that all the options are displayed on the screen. Hence a Combo box is best suited for large lists of items. For more information, see the Radio Buttons topic.

siControlRGB

RBG

A Color control with no "Alpha" channel. This control is associated with three parameters in the underlying object. See PPGLayout.AddColor. For more information, see the RGB Color Control topic.

siControlRGBA

RBGA

A Color control that includes the "Alpha" channel. This control is associated with four parameters in the underlying object. See PPGLayout.AddColor. For more information, see the RGBA Color Control topic.

siControlStatic

Static

Static text on the property page, see PPGLayout.AddStaticText. If the PPGItem.Name of the associated item is "Static" the PPGItem.Label will be displayed as the static text. Otherwise the name is assumed to refer to an actual string Parameter and its value is shown.

Tip: To break the text onto multiple lines, include line return characters in the text (vbCrLf in vbscript and "\n" in JScript).

Supported attributes are siUICX and siUICY. For more information, see the Static Text topic.

siControlString

String

A single line edit box for displaying text. This is the default control for String parameters.

Supported attributes are siUICX and siUICY. For multi-line strings use the siControlEdit instead. For more information, see the Single-line Text topic.

siControlSynoptic

SynopticWidget

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. The size of the synoptic view determines the size of the control. For an example of the synoptic control, see the PPGDemos example. For more information, see the Synoptic Widget topic.

siControlTextEditor

TextEditorWidget

A control that shows a full-featured text editor. You use this control with a string parameter whose value will be set to the text in the editor. For more information, see the Text Editor Widget topic.