SetCtrlAttribute

int SetCtrlAttribute (int panelHandle, int controlID, int controlAttribute, ...);

Purpose

Sets the value of a control attribute.

Although you can obtain the value of all control attributes using GetCtrlAttribute, there are some control attributes that you cannot modify. The descriptions you access in the list of control attributes indicate which attributes you cannot modify.

Note   When you set control attributes that affect the font of a control, set the ATTR_TEXT_FONT attribute first.

Supported Controls

You can use SetCtrlAttribute with all LabWindows/CVI user interface 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.
controlAttribute int The control 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 control attribute.

If the attribute shown in this 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 3.0 and later

WAS THIS ARTICLE HELPFUL?

Not Helpful