IUIX_Dialog::CheckItem Method

From PDF XChange PDF SDK
Jump to: navigation, search
Line 4: Line 4:
 
{{ToReview}}
 
{{ToReview}}
  
Changes state of object of [[PXV:IUIX_Label|IUIX_Label]] interface with [[PXV:UIX_LabelStyleFlags|''radio button'']] or [[PXV:UIX_LabelStyleFlags|''checkbox'']] flags specified.  
+
Changes state of object of [[PXV:IUIX_Label|IUIX_Label]] interface with [[PXV:UIX_LabelStyleFlags|''radio box'']] or [[PXV:UIX_LabelStyleFlags|''check box'']] flags specified.  
  
 
Object's state can be altered to '''checked''' or '''unchecked'''.
 
Object's state can be altered to '''checked''' or '''unchecked'''.
Line 15: Line 15:
 
== Parameters ==
 
== Parameters ==
 
;pItemID
 
;pItemID
:[in]  Value of BSTR.
+
:[in]  Text ID of an item of [[PXV:IUIX_Label|IUIX_Label]] interface to check/uncheck.
 
;nNewCheckState
 
;nNewCheckState
:[in]  Value of LONG.
+
:[in]  BOOL value. Checks an item of set to TRUE, unchecks otherwise.
 
;bUpdateRadioGroup
 
;bUpdateRadioGroup
 
:[in, defaultvalue(-1)]  Value of VARIANT_BOOL.
 
:[in, defaultvalue(-1)]  Value of VARIANT_BOOL.

Revision as of 06:06, 15 May 2015


Changes state of object of IUIX_Label interface with radio box or check box flags specified.

Object's state can be altered to checked or unchecked.

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] BOOL value. Checks an item of set to TRUE, unchecks otherwise.
bUpdateRadioGroup
[in, defaultvalue(-1)] Value of VARIANT_BOOL.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

See also IUIX_Dialog.