siPPGItemAttribute String Constant


Variables
const wchar_t *  siUIAlignCenter
const wchar_t *  siUIAlignLeft
const wchar_t *  siUIAlignRight
const wchar_t *  siUIAudioFile
const wchar_t *  siUIButtonDisable
const wchar_t *  siUICaption
const wchar_t *  siUIColumnCnt
const wchar_t *  siUIColumnGap
const wchar_t *  siUIContinue
const wchar_t *  siUICX
const wchar_t *  siUICY
const wchar_t *  siUIDecimals
const wchar_t *  siUIFCurveColorNonBijective
const wchar_t *  siUIFCurveGhosting
const wchar_t *  siUIFCurveGridSpaceX
const wchar_t *  siUIFCurveGridSpaceY
const wchar_t *  siUIFCurveLabelX
const wchar_t *  siUIFCurveLabelY
const wchar_t *  siUIFCurveNoGrid
const wchar_t *  siUIFCurveNoRulerX
const wchar_t *  siUIFCurveNoRulerY
const wchar_t *  siUIFCurveShowTimeCursor
const wchar_t *  siUIFCurveSnapX
const wchar_t *  siUIFCurveSnapY
const wchar_t *  siUIFCurveViewMaxX
const wchar_t *  siUIFCurveViewMaxY
const wchar_t *  siUIFCurveViewMinX
const wchar_t *  siUIFCurveViewMinY
const wchar_t *  siUIFileFilter
const wchar_t *  siUIFileMustExist
const wchar_t *  siUIFilePath
const wchar_t *  siUIGridColumnWidths
const wchar_t *  siUIGridHideColumnHeader
const wchar_t *  siUIGridHideRowHeader
const wchar_t *  siUIGridLockColumnHeader
const wchar_t *  siUIGridLockRowHeader
const wchar_t *  siUIGridReadOnlyColumns
const wchar_t *  siUIGridSelectionMode
const wchar_t *  siUIGridShowColumns
const wchar_t *  siUIImageFile
const wchar_t *  siUIInitialDir
const wchar_t *  siUIItems
const wchar_t *  siUILabel
const wchar_t *  siUILabelMinPixels
const wchar_t *  siUILabelPercentage
const wchar_t *  siUILineCnt
const wchar_t *  siUILineGap
const wchar_t *  siUILogarithmic
const wchar_t *  siUIMultiSelectionListBox
const wchar_t *  siUINoLabel
const wchar_t *  siUINoSlider
const wchar_t *  siUIOpenFile
const wchar_t *  siUISelectionColor
const wchar_t *  siUIShowFrame
const wchar_t *  siUIStyle
const wchar_t *  siUISubFolder
const wchar_t *  siUISyncSlider
const wchar_t *  siUIThumbWheel
const wchar_t *  siUITreadmill
const wchar_t *  siUIType
const wchar_t *  siUIUseSelectionIcon
const wchar_t *  siUIValueOnly
const wchar_t *  siUIWidthPercentage
const wchar_t *  siUILineNumbering
const wchar_t *  siUIFolding
const wchar_t *  siUIBackgroundColor
const wchar_t *  siUIForegroundColor
const wchar_t *  siUIFont
const wchar_t *  siUICommentColor
const wchar_t *  siUIPreprocessorColor
const wchar_t *  siUIMarginWidth
const wchar_t *  siUICommentFont
const wchar_t *  siUIFontSize
const wchar_t *  siUIKeywords
const wchar_t *  siUIHeight
const wchar_t *  siUIHorizontalScroll
const wchar_t *  siUIVerticalScroll
const wchar_t *  siUILineWrap
const wchar_t *  siUIKeywordFile
const wchar_t *  siUIAutoComplete
const wchar_t *  siUIToolbar
const wchar_t *  siUICapability

Detailed Description

Specifies the different attributes supported on PPGItem s. Many of these attributes only apply to a specific type of control, for example siUIColumnGap only applies to siPPGControlType::siControlIconList . Other attributes, such as siPPGItemAttribute::siUINoLabel and siPPGItemAttribute::siUICY , are supported on practically every control.

Some of the most common attributes are available more directly as properties of the PPGItem, for example PPGItem::UIItems is a convenient way to set the siPPGItemAttribute::siUIItems attribute.
See also:
PPGItem::GetAttribute, PPGItem::SetAttribute, PPGItem::GetAttribute, PPGItem::PutAttribute

siPPGControlType, siAutoCompleteMode, siTextEditorCapability, Setting Control Attributes

Variable Documentation

const wchar_t* siUIAlignCenter

["AlignCenter"] NOT SUPPORTED (as of v5.0). A boolean attribute that applies to most controls. (Default: false)

True to align control to the center of the property page.

const wchar_t* siUIAlignLeft

["AlignLeft"] NOT SUPPORTED (as of v5.0). A boolean attribute that applies to most controls. (Default: true)

True to align control to the left side of the property page.

const wchar_t* siUIAlignRight

["AlignRight"] NOT SUPPORTED (as of v5.0). A boolean attribute that applies to most controls. (Default: false)

True to align control to the right side of the property page.

const wchar_t* siUIAudioFile

["AudioFile"] A boolean attribute that applies to the siPPGControlType::siControlFilePath control.

True to use all audio file formats as extensions for the name filters on the File Browser control.

Note: This is a convenience to save you hardcoding a long list of supported audio file extensions into the siPPGItemAttribute::siUIFileFilter attribute.

const wchar_t* siUIButtonDisable

["ButtonDisable"] A boolean attribute that applies to the siPPGControlType::siControlButton control.

True to disable the button (see PPGLayout::AddButton for an example).

Note: A special attribute is required because there is no Parameter associated with a button, and hence no way to call Parameter::Enable .

const wchar_t* siUICaption

["caption"] NOT SUPPORTED. A string attribute that applies to the siPPGControlType::siControlFilePath control.

This attribute is normally for internal use only; however, it can be used to specify additional arguments for the siPPGControlType::siControlFilePath .

const wchar_t* siUIColumnCnt

["nocol"] A LONG attribute that applies to the siPPGControlType::siControlIconList control.

Specifies the maximum number of icons that should appear on a single row for the Icon List type of control. For example, if there are 10 icons in the PPGItem::UIItems and this attribute is 5, then the icons will be displayed as two rows of five icons. By default, all icons appear on a single row.

Note: Usually you would use this attribute or siPPGItemAttribute::siUILineCnt , but not both.

const wchar_t* siUIColumnGap

["colgap"] A LONG attribute that applies to the siPPGControlType::siControlIconList control.

Specifies the width of the gap in pixels between icons in the Icon List control.

const wchar_t* siUIContinue

["Continue"] A boolean attribute that applies to most controls. (Default: false)

True to keep the next control on the same row as this control, rather than starting a new line. This allows you to draw multiple controls in a row and hence make more compact layouts for complex objects. To place two groups of controls side by side this attribute is applied to the first group (see Wrapping Controls (Rows) ).

This is the internal representation and can be used directly, but the methods PPGLayout::AddRow and PPGLayout::EndRow are available for convenience.

const wchar_t* siUICX

["cx"] A LONG attribute that applies to most controls.

Width in pixels for the control. When left blank, the control automatically resizes itself.

To achieve precise placement of multiple controls that are on the same row, use this in conjunction with siPPGItemAttribute::siUILabelMinPixels , siPPGItemAttribute::siUILabelPercentage and siPPGItemAttribute::siUIWidthPercentage .

Note: Often it is better to leave this undefined so that Softimage can use its own heuristic to resize the layout.

const wchar_t* siUICY

["cy"] A LONG attribute that applies to most controls.

Height in pixels for the control. This is useful when creating a multiline edit box for a string (see PPGLayout::AddString ).

Note: Often it is better to leave this undefined so that Softimage can use its own heuristic to resize the layout.

const wchar_t* siUIDecimals

["decimals"] A LONG attribute that applies to the siPPGControlType::siControlNumber . (Default: 3)

Number of decimals of precision to show in the edit box. For example 0.123456 will show up as 0.1 if this attribute is set to 1.

const wchar_t* siUIFCurveColorNonBijective

["ColorNonBijective"] A boolean attribute that applies to the siPPGControlType::siControlFCurve control.

True to color the FCurve orange if any Y value is shared by more than one point on the X axis on an FCurve control.

const wchar_t* siUIFCurveGhosting

["Ghosting"] A boolean attribute that applies to the siPPGControlType::siControlFCurve control.

True to show the original curve ghosted behind the modified curve on an FCurve control.

const wchar_t* siUIFCurveGridSpaceX

["GridSpaceX"] A double attribute that applies to the siPPGControlType::siControlFCurve control.

Specifies the spaces between the horizontal lines for the grid on the FCurve control.

const wchar_t* siUIFCurveGridSpaceY

["GridSpaceY"] A double attribute that applies to the siPPGControlType::siControlFCurve control.

Specifies the spaces between the vertical lines for the grid on the FCurve control.

const wchar_t* siUIFCurveLabelX

["LabelX"] A string attribute that applies to the siPPGControlType::siControlFCurve control.

Specifies a label for the X-axis on the siPPGControlType::siControlFCurve control.

Note: Use this attribute in conjunction with the siPPGItemAttribute::siUIFCurveLabelY attribute for best results.

const wchar_t* siUIFCurveLabelY

["LabelY"] A string attribute that applies to the siPPGControlType::siControlFCurve control.

Specifies a label for the Y-axis on the siPPGControlType::siControlFCurve control.

Note: This attribute is ignored unless the siPPGItemAttribute::siUIFCurveLabelX attribute is also specified.

const wchar_t* siUIFCurveNoGrid

["NoGrid"] A boolean attribute that applies to the siPPGControlType::siControlFCurve control.

True to hide the grid on the FCurve control.

const wchar_t* siUIFCurveNoRulerX

["NoRulerX"] A boolean attribute that applies to the siPPGControlType::siControlFCurve control.

True to hide the ruler for the X-axis on the FCurve control.

const wchar_t* siUIFCurveNoRulerY

["NoRulerY"] A boolean attribute that applies to the siPPGControlType::siControlFCurve control.

True to hide the ruler for the Y-axis on the FCurve control.

const wchar_t* siUIFCurveShowTimeCursor

["ShowTimeCursor"] A boolean attribute that applies to the siPPGControlType::siControlFCurve control.

True to display the time cursor on an FCurve control.

const wchar_t* siUIFCurveSnapX

["SnapX"] A double attribute that applies to the siPPGControlType::siControlFCurve control.

Specifies the spacing size to use for a snapping grid in the X-axis on an FCurve control. For example, if this attribute is set to 3.5 then users can only set keys at 0, 3.5, 7, 10.5 etc.

const wchar_t* siUIFCurveSnapY

["SnapY"] A double attribute that applies to the siPPGControlType::siControlFCurve control.

Specifies the spacing size to use for a snapping grid in the Y-axis on an FCurve control. For example, if this attribute is set to 1.5 then users can only set keys at 0, 1.5, 3, 4.5 etc.

const wchar_t* siUIFCurveViewMaxX

["ViewMaxX"] A double attribute that applies to the siPPGControlType::siControlFCurve .

Specifies the maximum value for the range on the X-axis on the FCurve control.For example, the range could be from -1 to 1 in the X axis and 0 to 100 in the Y axis.

Note: In order to set the range you need to specify a valid range in both axis. Otherwise the widget automatically sets the ranges such that it show all the keys of the fcurve.

const wchar_t* siUIFCurveViewMaxY

["ViewMaxY"] A double attribute that applies to the siPPGControlType::siControlFCurve .

Specifies the maximum value for the range on the Y-axis on the FCurve control.For example, the range could be from -1 to 1 in the X axis and 0 to 100 in the Y axis.

Note: In order to set the range you need to specify a valid range in both axis. Otherwise the widget automatically sets the ranges such that it show all the keys of the fcurve.

const wchar_t* siUIFCurveViewMinX

["ViewMinX"] A double attribute that applies to the siPPGControlType::siControlFCurve .

Specifies the minimum value for the range on the X-axis on the FCurve control. For example, the range could be from -1 to 1 in the X axis and 0 to 100 in the Y axis.

Note: In order to set the range you need to specify a valid range in both axis. Otherwise the widget automatically sets the ranges such that it show all the keys of the fcurve.

const wchar_t* siUIFCurveViewMinY

["ViewMinY"] A double attribute that applies to the siPPGControlType::siControlFCurve .

Specifies the minimum value for the range on the Y-axis on the FCurve control.For example, the range could be from -1 to 1 in the X axis and 0 to 100 in the Y axis.

Note: In order to set the range you need to specify a valid range in both axis. Otherwise the widget automatically sets the ranges such that it show all the keys of the fcurve.

const wchar_t* siUIFileFilter

["FileFilter"] A string attribute that applies to the siPPGControlType::siControlFilePath control.

Specifies the extensions to use as name filters on the File Browser control.

For a shortcut to all audio file formats, set the siUIAudioFile attribute to true.

For a shortcut to all image file formats, set the siUIImageFile attribute to true.

Note: The syntax of this string is same as the standard Win32 syntax; see documentation for OPENFILENAME structure, (lpstrFilter member). There is one difference: when there are multiple file extensions for a single item, separate them with the colon character (:) instead of a semi-colon (;). For example:

"Text files (*.txt *.text)|*.txt:*.text|All Files (*.*)|*.*||"

const wchar_t* siUIFileMustExist

["MustExist"] A boolean attribute that applies to siPPGControlType::siControlFilePath control.

True to force the user to pick an existing file to load. Normally this is used for the case of picking an existing file to load.

Note: Used in conjunction with siPPGItemAttribute::siUIOpenFile .

const wchar_t* siUIFilePath

["path"] A string attribute that applies to the siPPGControlType::siControlBitmap

Specifies the filename of the bitmap to use for the Bitmap widget.

Note: The path is absolute (or, where applicable, relative to the SPDL file).

const wchar_t* siUIGridColumnWidths

["ColumnWidths"] An integer (or a colon-delimited array of integers) attribute that applies to the siPPGControlType::siControlGrid control.

Specifies column width in pixels for the GridWidget in one of two ways:

(1) A single integer representing the total width for all columns (of equal widths).

(2) An array of integers separated by a colon (:), each of which represents the width of a specific column in the grid from left to right. The first element specifies the width of the row label column, followed by the normal data columns. For example, "100:50:50" specifies that the row labels have 100 pixels and the first and second column has 50 pixels. (This is true even if the row label column has been hidden with the siPPGItemAttribute::siUIGridHideRowHeader attribute).

Note: If not specified the GridWidget resizes its columns to fit the initial data.

const wchar_t* siUIGridHideColumnHeader

["HideColumnHeader"] A boolean attribute that applies to the siPPGControlType::siControlGrid control.

True to suppress the column labels from appearing on the GridWidget (see GridData::SetColumnLabel ).

const wchar_t* siUIGridHideRowHeader

["HideRowHeader"] A boolean attribute that applies to the siPPGControlType::siControlGrid control.

True to suppress the row labels from appearing on the GridWidget (see GridData::SetRowLabel ).

const wchar_t* siUIGridLockColumnHeader

["LockColumnHeader"] A boolean attribute that applies to the siPPGControlType::siControlGrid control.

True to freeze the column labels of the GridWidget in place even when you scroll off to the right.

const wchar_t* siUIGridLockRowHeader

["LockRowHeader"] A boolean attribute that applies to the siPPGControlType::siControlGrid control.

True to freeze the row labels of the GridWidget in place even when you scroll off to the bottom.

Note: This attribute only takes effect when the siPPGItemAttribute::siUICY attribute has been set to something smaller than the natural height of the GridWidget.

const wchar_t* siUIGridReadOnlyColumns

["ReadOnlyColumns"] An integer (or a colon-delimited array of integers) attribute that applies to the siPPGControlType::siControlGrid control.

Specifies which columns are read-only and which are editable. Cells in a read-only column cannot be edited through the UI; however, they can still be changed via scripting. This attribute can be specified in one of two ways:

(1) The single value "1" to make all columns read-only.

(2) An array of values separated by a colon (:), each of which represents whether that column is read-only ("1") or edtable ("0"). For example "0:1:0:1" means that second and fourth columns are read-only.

Note: Unlike the siPPGItemAttribute::siUIGridColumnWidths attribute, the first element in this string refers to the first data column, not the row label column (which is always read-only).

const wchar_t* siUIGridSelectionMode

["SelectionMode"] An siGridSelectionMode attribute that applies to the siPPGControlType::siControlGrid control.

Set this attribute to a value from the siGridSelectionMode enum to change the cell selection behavior of the GridWidget .

const wchar_t* siUIGridShowColumns

["ShowColumns"] An integer (or a colon-delimited array of integers) attribute that applies to the siPPGControlType::siControlGrid control.

Specifies which columns are shown and which are hidden in one of two ways:

(1) The single value "1" to show all columns.

(2) An array of values separated by a colon (:), each of which represents whether to display that column ("1") or not ("0"). For example "1:1:1:0" means that fourth columns is hidden and the first three are shown.

Note: Unlike the siPPGItemAttribute::siUIGridColumnWidths attribute, the first element in this string refers to the first data column, not the row label column (which is shown or hidden with the siPPGItemAttribute::siUIGridHideRowHeader attribute).

const wchar_t* siUIImageFile

["ImageFile"] A boolean attribute that applies to the siPPGControlType::siControlFilePath control.

True to use all image file formats as extensions for the name filters on the File Browser control.

Note: This is a convenience to save you hardcoding a long list of supported image file extensions into the siPPGItemAttribute::siUIFileFilter attribute.

const wchar_t* siUIInitialDir

["InitialDir"] A string attribute that applies to the siPPGControlType::siControlFilePath and siPPGControlType::siControlFolder

This specifies a default directory to start browsing if the string parameter is empty. This can be an absolute path or the following special values: "workgroup", "factory", "user" or "project".

const wchar_t* siUIItems

["uiitems"] A variant array attribute that applies to drop-down list (enumerator) controls such as siPPGControlType::siControlCombo , siPPGControlType::siControlCheck , siPPGControlType::siControlRadio , siPPGControlType::siControlListBox and siPPGControlType::siControlIconList .

Specifies the label/value pairs for the enumerator controls (see PPGItem::UIItems ).

const wchar_t* siUILabel

["label"] A string attribute that applies to most controls.

Specifies the label for the control. By default this is set to the SIObject::Name or Parameter::ScriptName value (see PPGItem::Label ).

Note: Labels are mandatory for Tab controls but optional for Group and Command Button controls.

const wchar_t* siUILabelMinPixels

["LabelMinPixels"] A LONG attribute that applies to most controls.

Specifies the minimum width, in pixels, to use when drawing a label. A label gets split into multiple lines when there is not enough space on a single line (see PPGItem::LabelMinPixels ).

Note: Use in conjunction with siPPGItemAttribute::siUILabelPercentage .

const wchar_t* siUILabelPercentage

["LabelPercentage"] A LONG attribute that applies to most controls.

Specifies the width of the label of a control, in terms of its percentage of the control's total width. Use in conjunction with siUILabelMinPixels (see PPGItem::LabelPercentage ).

const wchar_t* siUILineCnt

["noline"] A LONG attribute that applies to the siPPGControlType::siControlIconList control.

Specifies the number of rows to use for the Icon List control. This is the alternative to using siPPGItemAttribute::siUIColumnCnt .

const wchar_t* siUILineGap

["linegap"] A LONG attribute that applies to the siPPGControlType::siControlIconList control.

Specifies the height of the gap in pixels between icons appearing on different rows in the Icon List control. Only comes into play if the icons are displayed on multiple lines.

const wchar_t* siUILogarithmic

["log"] A boolean attribute that applies to the siPPGControlType::siControlNumber . (Default: false)

True to use logarithmic scaling for the slider.

const wchar_t* siUIMultiSelectionListBox

["MultiSelectionListBox"] A boolean attribute that applies to siPPGControlType::siControlListBox controls which are bound to string parameters (otherwise this attribute is ignored).

True to support multiple selection for this list box control. For multiple-selection list box controls, the value of the Parameter (the items selected) is returned as a semicolon-separated string. For an example demonstrating how to use this attribute, see PPGItem::UIItems .

const wchar_t* siUINoLabel

["NoLabel"] A boolean attribute that applies to most controls (Default: false)

True to suppress the text label. If this is an animatable parameter then the animation divot will still be drawn to the left of the control.

const wchar_t* siUINoSlider

["noslider"] A boolean attribute that applies to the siPPGControlType::siControlNumber . (Default: false)

True to suppress the slider control (and display only the numeric edit box). This is useful if there is not a lot of space to fit many controls.

const wchar_t* siUIOpenFile

["OpenFile"] A boolean attribute that applies to the siPPGControlType::siControlFilePath control.

True to turn off the warning that a file exists for the File Browser control. Normally this is used for the case of picking an existing file to load.

Note: Used in conjunction with siPPGItemAttribute::siUIFileMustExist .

const wchar_t* siUISelectionColor

["selcolor"] A LONG attribute that applies to the siPPGControlType::siControlIconList control.

Specifies an RGBA color value for the highlighting around the selected icon in an Icon List control. The color is represented by considering the least significant byte as the R value, the next byte as the G, etc. For example, 0xFFFF is Yellow.

Note: If the siPPGItemAttribute::siUIUseSelectionIcon has been enable this attribute is ignored.

const wchar_t* siUIShowFrame

["ShowFrame"] A boolean attribute that applies to Groups. (Default: false)

This attribute only applies when there is no label for the group, and is used to determine whether there should be a box drawn around the controls of the group. See PPGLayout::AddGroup and Grouping Controls.

const wchar_t* siUIStyle

["style"] A LONG attribute that applies to many controls, including the multi-line edit and siPPGControlType::siControlListBox controls.

Specifies advanced window style options such as scroll bars and support for multiple lines. For advanced use only.

The values are based on the flags defined in the Windows Header file winuser.h (long). For example, using the value for ES_PASSWORD (0x0020, or 32), displays the text the user types as asterisks; while using the value for ES_UPPERCASE (0x0008, or 8) converts the text to uppercase.

Note: You can also combine these flags for multiple effects. For example, you can 9 as the value for the siUIStyle attribute to create a text box with centered and uppercase text (because ES_CENTER=1 and ES_UPPERCASE=8).

const wchar_t* siUISubFolder

["SubFolder"] A string attribute that applies to the siPPGControlType::siControlFilePath and siPPGControlType::siControlFolder controls.

A subfolder relative to the value specified for siPPGItemAttribute::siUIInitialDir . For example, if the initial directory is "project" and the subfolder is "scenes/myscenes" then the browser opens in the scenes/myscenes directory inside the current project. This attribute is ignored if siUIInitialDir is not specified.

const wchar_t* siUISyncSlider

["SyncSlider"] A boolean attribute that applies to siPPGControlType::siControlNumber . (Default: true)

True to force an update of the parameter value in Softimage when the slider is moved.

const wchar_t* siUIThumbWheel

["ThumbWheel"] A boolean attribute that applies to the siPPGControlType::siControlNumber . (Default: false)

True to reduce the slider to a small portion of the screen (like a thumbwheel). This is useful when many parameters need to be displayed in a small amount of space.

const wchar_t* siUITreadmill

["Treadmill"] A boolean attribute that applies to the siPPGControlType::siControlNumber . (Default: false)

True to display a control similar in size to the Thumb Wheel which can be dragged left/right to decrement/increment the value. This control is useful when many parameters need to be displayed in a small amount of space.

const wchar_t* siUIType

["uitype"] An siPPGControlType attribute that applies to all controls.

Specifies the type of control for this property page item (see PPGItem::Type ).

const wchar_t* siUIUseSelectionIcon

["useselicon"] A boolean attribute that applies to siPPGControlType::siControlIconList . (Default: false)

True to use an alternate bitmap for selected icons in the Icon List control. For example, rather than drawing a box around a button the selected icon might show the button in a compressed position.

Note: Filenames of the alternate bitmaps must use the same name but appended with "_sel" before the extension.

const wchar_t* siUIValueOnly

["ValueOnly"] A boolean attribute that applies to most controls (Default: false)

True to suppress the text label and animation divot.

const wchar_t* siUIWidthPercentage

["WidthPercentage"] A LONG attribute that applies to most controls.

Specifies the percentage of the row that this control should use relative to the other members of the row (see PPGItem::WidthPercentage ).

const wchar_t* siUILineNumbering

["LineNumbering"] A boolean attribute that applies to the siPPGControlType::siControlTextEditor .

True to display line numbers on the left edge of the text editor.

const wchar_t* siUIFolding

["Folding"] A boolean attribute that applies to the siPPGControlType::siControlTextEditor .

True to enable folding of comments, functions and namespaces in the text editor control. Folding makes code more readable and navigable because it allows users to expand or collapse blocks of related text (multi-line comments, entire functions, etc.) by clicking a plus or minus control. Most IDE tools such as Visual Studio .NET 2005 offer folding as a usability feature.

const wchar_t* siUIBackgroundColor

["Background"] A hexadecimal attribute that applies to the siPPGControlType::siControlTextEditor .

Sets the background color of the text editor control.

const wchar_t* siUIForegroundColor

["Foreground"] A hexadecimal attribute that applies to the siPPGControlType::siControlTextEditor .

Sets the text color of the text editor control.

const wchar_t* siUIFont

["Font"] A string attribute that applies to the siPPGControlType::siControlTextEditor .

Sets the font used by the text editor control.

const wchar_t* siUICommentColor

["CommentColor"] A hexadecimal attribute that applies to the siPPGControlType::siControlTextEditor .

Sets the color of commented text in the text editor control.

const wchar_t* siUIPreprocessorColor

["PreprocessorColor"] A hexadecimal attribute that applies to the siPPGControlType::siControlTextEditor .

Sets the color of preprocessor commands in the text editor control.

const wchar_t* siUIMarginWidth

["MarginWidth"] A numeric attribute that applies to the siPPGControlType::siControlTextEditor .

Sets the width (in characters) of the margin in the text editor control.

const wchar_t* siUICommentFont

["CommentFont"] A string attribute that applies to the siPPGControlType::siControlTextEditor .

Sets the font used by comments in the text editor control.

const wchar_t* siUIFontSize

["FontSize"] A numeric attribute that applies to the siPPGControlType::siControlTextEditor .

Sets the size of the font used by the text editor control.

const wchar_t* siUIKeywords

["Keywords"] A string attribute that applies to the siPPGControlType::siControlTextEditor . This is similar to the siPPGItemAttribute::siUIKeywordFile attribute, but more suited to small lists.

Specifies a space-delimited list of keywords that are to be highlighted in the text editor control. These values are also available for auto-completion (see the siPPGItemAttribute::siUIAutoComplete attribute).

const wchar_t* siUIHeight

["Height"] A numeric attribute that applies to the siPPGControlType::siControlTextEditor .

Specifies the height in pixels of the text editor control.

const wchar_t* siUIHorizontalScroll

["HorizontalScroll"] A boolean attribute that applies to the siPPGControlType::siControlTextEditor .

True to display a horizontal scrollbar in the text editor.

const wchar_t* siUIVerticalScroll

["VerticalScroll"] A boolean attribute that applies to the siPPGControlType::siControlTextEditor .

True to display a vertical scrollbar in the text editor.

const wchar_t* siUILineWrap

["LineWrap"] A boolean attribute that applies to the siPPGControlType::siControlTextEditor .

True to enable line wrapping in the text editor.

const wchar_t* siUIKeywordFile

["KeywordFile"] A string attribute that applies to the siPPGControlType::siControlTextEditor . This is similar to the siPPGItemAttribute::siUIKeywords attribute, but more suited to large lists.

Specifies the location of a file that contains a space-delimited list of keywords to be highlighted in the text editor control. These values are also available for auto-completion (see the siPPGItemAttribute::siUIAutoComplete attribute).

const wchar_t* siUIAutoComplete

["AutoComplete"] An siAutoCompleteMode attribute that applies to the siPPGControlType::siControlTextEditor .

Specifies the behavior of the auto complete feature in the text editor control. By default, only keywords are highlighted. See siAutoCompleteMode for a list of values you can specify. Use either the siPPGItemAttribute::siUIKeywords attribute or the siPPGItemAttribute::siUIKeywordFile attribute to specify which keywords can be autocompleted.

const wchar_t* siUIToolbar

["Toolbar"] A boolean attribute that applies to the siPPGControlType::siControlTextEditor .

True to display the File and Edit menus in a toolbar at the top of the text editor. You can limit which File menu options are enabled with the siPPGItemAttribute::siUICapability attribute.

const wchar_t* siUICapability

["Capability"] An siTextEditorCapability attribute that applies to the siPPGControlType::siControlTextEditor .

Specifies the capabilities of some of the File menu functionality for the text editor control.

Note: The File and Edit menus do not appear by default, but you can use the siPPGItemAttribute::siUIToolbar attribute to display them.