IUIX_Dialog::CheckItem2 Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 3: | Line 3: | ||
{{#customTitle:IUIX_Dialog::CheckItem2 Method}} | {{#customTitle:IUIX_Dialog::CheckItem2 Method}} | ||
{{#parentPage:PXV:IUIX_Dialog#Methods|CheckItem2|method}} | {{#parentPage:PXV:IUIX_Dialog#Methods|CheckItem2|method}} | ||
| − | + | ||
Changes state of an item in a dialog to '''checked''' or '''unchecked''' by item's numerical ID. | Changes state of an item in a dialog to '''checked''' or '''unchecked''' by item's numerical ID. | ||
| Line 23: | Line 23: | ||
== Return Value == | == Return Value == | ||
| − | Returns S_OK if operation was successful or error code | + | Returns S_OK if the operation was successful, or will return an error code if it fails. |
== See Also == | == See Also == | ||
[[PXV:IUIX_Dialog|IUIX_Dialog]] | [[PXV:IUIX_Dialog|IUIX_Dialog]] | ||
Latest revision as of 15:08, 15 June 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.
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 the operation was successful, or will return an error code if it fails.
