Editable Text Boxes

There are two kinds of editable text box items available:

Single-line Text—default for string parameters; pressing the Tab or Enter keys moves to the next control.

Multi-line Text—pressing the Enter key adds a carriage return inside the box.

The user can change the text that appears in these controls directly, but they can also be changed dynamically through Logic (see Dynamically Changing Custom Properties).

Single-line Text

 

Single-line text boxes display an editable text box spanning only one line, along with an optional label. They are the default control for underlying String parameters.

You create them using the PPGLayout.AddItem method with the siControlString control type enum.

The following item attributes are available:

Available on all Controls also as a property on the PPGItem object:

Common to many Controls:

siUILabel

siUIItems

siUIType

siUIWidthPercentage

siUILabelPercentage

siUILabelMinPixels

siUINoLabel

siUIValueOnly

siUIContinue

siUICX

siUICY

Multi-line Text

 

Multi-line text boxes display an editable text box spanning several lines, along with an optional label. They are associated to an underlying String parameter.

You create them using the PPGLayout.AddString method.

 

You can also use the PPGLayout.AddItem method with the siControlEdit control type enum, but the PPGLayout.AddString method is a little more convenient (largely because you don’t need a separate call to set attributes like siUICX and siUICY).

The following item attributes are available:

Available on all Controls also as a property on the PPGItem object:

Common to many Controls:

siUILabel

siUIItems

siUIType

siUIWidthPercentage

siUILabelPercentage

siUILabelMinPixels

siUINoLabel

siUIValueOnly

siUIContinue

siUICX

siUICY

siUIStyle



SOFTIMAGE|XSI v6.01     

Return to Softimage XSI Index