SetTreeCellAttribute
int SetTreeCellAttribute (int panelHandle, int controlID, int itemIndex, int columnIndex, int cellAttribute, ...);
Purpose
Sets an attribute of a tree cell.
Supported Controls
You can use SetTreeCellAttribute with tree controls.
Parameters
| Input | ||
| Name | Type | Description |
| panelHandle | int | Specifier for a particular panel that is currently in memory. You can obtain this handle from functions such as LoadPanel and NewPanel. |
| controlID | int | The defined constant, located in the .uir header file, that you assigned to the control in the User Interface Editor, or the ID returned by functions such as NewCtrl and DuplicateCtrl. |
| itemIndex | int |
Zero-based index of the tree item containing the cell for which you want to set the attribute. Pass VAL_ALL_OBJECTS if you want to set the cell attribute for all cells in the specified column. Pass VAL_DFLT_FOR_NEW_OBJECTS if you want to set the default cell attribute for future new cells in the specified column. |
| columnIndex | int |
Zero-based index of the tree column containing the cell for which you want to set the attribute. Pass VAL_ALL_OBJECTS to set the cell attribute for all cells in the specified tree item row. |
| cellAttribute | int | The cell attribute value to set. In the function panel, when you click the control or press <Enter>, <Spacebar>, or <Ctrl-down arrow>, a dialog box appears containing a hierarchical list of the available attributes. Attributes whose values cannot be obtained are dimmed. Help text is shown for each attribute. To select an attribute, double-click it or select it and then press <Enter>. If the attribute shown in this ring control has named constants as valid values, you can open a list of them by moving to the Attribute Value control and pressing <Enter>. The Attribute Values dialog box displays the values and value help for the constants. |
| attributeValue | ... | The value to which to set the cell attribute. If the attribute shown in this ring control has named constants as valid values, you can open a list of them by pressing <Enter>. The Attribute Values dialog box displays the values and value help for the constants. |
Return Value
| Name | Type | Description |
| status | int | Return value indicating whether the function was successful. A negative number indicates that an error occurred. |
Additional Information
Library: User Interface Library
Include file: userint.h
LabWindows/CVI compatibility: LabWindows/CVI 7.0 and later
Example
Refer to userint\events.cws for an example of using the SetTreeCellAttribute function.