IUIX_Dialog::SetItemSelByParam Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 2: Line 2:
 
{{#customTitle:IUIX_Dialog::SetItemSelByParam Method}}
 
{{#customTitle:IUIX_Dialog::SetItemSelByParam Method}}
 
{{#parentPage:PXV:IUIX_Dialog|SetItemSelByParam Method|method}}
 
{{#parentPage:PXV:IUIX_Dialog|SetItemSelByParam Method|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Selects an item with a given parameter in a list of a dialog object.
 +
 
 +
Dialog object is picked via its text ID and must implement [[PXV:IUIX_List|IUIX_List]], [[PXV:IUIX_Combo|IUIX_Combo]] or [[PXV:IUIX_Tree|IUIX_Tree]]  interface.
  
 
== Syntax ==
 
== Syntax ==
Line 13: Line 14:
 
== Parameters ==
 
== Parameters ==
 
;pItemID
 
;pItemID
:[in]  Value of BSTR.
+
:[in]  text ID of a required dialog object.
 
;nParam
 
;nParam
:[in]  Value of PARAM_T.
+
:[in]  parameter value of an item that must be selected. If there is more than one item with a given parameter, the first of these items in a list will be selected.
  
 
== Return Value ==
 
== Return Value ==

Revision as of 07:48, 16 May 2015


Selects an item with a given parameter in a list of a dialog object.

Dialog object is picked via its text ID and must implement IUIX_List, IUIX_Combo or IUIX_Tree interface.

Syntax

HRESULT SetItemSelByParam([in]  BSTR     pItemID,
                          [in]  PARAM_T  nParam);

Parameters

pItemID
[in] text ID of a required dialog object.
nParam
[in] parameter value of an item that must be selected. If there is more than one item with a given parameter, the first of these items in a list will be selected.

Return Value

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

See Also

See also IUIX_Dialog.