IUIX_Dialog::CheckItem Method

From PDF XChange PDF SDK
Jump to: navigation, search
Line 4: Line 4:
 
{{ToReview}}
 
{{ToReview}}
  
Changes item state in a dialog to '''checked''' or '''unchecked''' by item's text ID.
+
Changes state of an item in a dialog to '''checked''' or '''unchecked''' by item's text 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.
 
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.

Revision as of 05:37, 15 May 2015


Changes state of an item in a dialog to checked or unchecked by item's text ID.

This method can be applied only to objects of IUIX_Label interface with radio box or check box flags specified.

Syntax

HRESULT CheckItem([in]                    BSTR          pItemID,
                  [in]                    LONG          nNewCheckState,
                  [in, defaultvalue(-1)]  VARIANT_BOOL  bUpdateRadioGroup);

Parameters

pItemID
[in] Text ID of an item of IUIX_Label interface to check/uncheck.
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.