IUIX_Dialog::CheckItem Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
Line 3: Line 3:
 
{{#customTitle:IUIX_Dialog::CheckItem Method}}
 
{{#customTitle:IUIX_Dialog::CheckItem Method}}
 
{{#parentPage:PXV:IUIX_Dialog#Methods|CheckItem|method}}
 
{{#parentPage:PXV:IUIX_Dialog#Methods|CheckItem|method}}
{{ToReview}}
+
 
  
 
Changes state of an item 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.

Latest revision as of 15:07, 15 June 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          sItemID,
                  [in]                    LONG          nNewCheckState,
                  [in, defaultvalue(-1)]  VARIANT_BOOL  bUpdateRadioGroup);

Parameters

sItemID
[in] Text 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

IUIX_Dialog