IUIX_Dialog::CheckItem2 Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 2: | Line 2: | ||
{{#customTitle:IUIX_Dialog::CheckItem2 Method}} | {{#customTitle:IUIX_Dialog::CheckItem2 Method}} | ||
{{#parentPage:PXV:IUIX_Dialog|CheckItem2 Method|method}} | {{#parentPage:PXV:IUIX_Dialog|CheckItem2 Method|method}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| − | + | Changes state of an item in a dialog to '''checked''' or '''unchecked''' by item's numerical ID. | |
| + | |||
| + | This method can be applied only to objects of [[PXV:IUIX_Label|IUIX_Label]] interface with [[PXV:UIX_LabelStyleFlags|''radio box'']] or [[PXV:UIX_LabelStyleFlags|''check box'']] flags specified. | ||
== Syntax == | == Syntax == | ||
| Line 14: | Line 15: | ||
== Parameters == | == Parameters == | ||
;nItemID | ;nItemID | ||
| − | :[in] | + | :[in] numerical ID of an item that is to be checked/unchecked. |
;nNewCheckState | ;nNewCheckState | ||
| − | :[in] | + | :[in] Checks an item if set to TRUE, unchecks if set to FALSE. |
;bUpdateRadioGroup | ;bUpdateRadioGroup | ||
| − | :[in, defaultvalue(-1)] | + | :[in, defaultvalue(-1)] if set to VARIANT_TRUE, updates state of all ''radio boxes'' of the same group unchecking items that were in a '''checked''' state. |
== Return Value == | == Return Value == | ||
Revision as of 06:40, 15 May 2015
Changes state of an item in a dialog to checked or unchecked by item's numerical ID.
This method can be applied only to objects of IUIX_Label interface with radio box or check box flags specified.
Contents
Syntax
HRESULT CheckItem2([in] LONG nItemID,
[in] LONG nNewCheckState,
[in, defaultvalue(-1)] VARIANT_BOOL bUpdateRadioGroup);
Parameters
- nItemID
- [in] numerical ID of an item that is to be checked/unchecked.
- nNewCheckState
- [in] Checks an item if set to TRUE, unchecks if set to FALSE.
- bUpdateRadioGroup
- [in, defaultvalue(-1)] if set to VARIANT_TRUE, updates state of all radio boxes of the same group unchecking items that were in a checked state.
Return Value
Returns S_OK if operation was successful or error code in other cases.
See Also
See also IUIX_Dialog.
