IUIX_Dialog::SetItemSelByParam Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_Dialog::SetItemSelByParam Method}}
 
{{#customTitle:IUIX_Dialog::SetItemSelByParam Method}}
{{#parentPage:PXV:IUIX_Dialog|SetItemSelByParam Method|method}}
+
{{#parentPage:PXV:IUIX_Dialog#Methods|SetItemSelByParam|method}}
{{ToWrite}}
+
{{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 ==
<pre class="brush:cpp;gutter:false">HRESULT SetItemSelByParam([in]  BSTR    pItemID,
+
<pre class="brush:cpp;gutter:false">HRESULT SetItemSelByParam([in]  BSTR    sItemID,
 
                           [in]  PARAM_T  nParam);</pre>
 
                           [in]  PARAM_T  nParam);</pre>
  
 
== Parameters ==
 
== Parameters ==
;pItemID
+
;sItemID
:[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 ==
Returns S_OK if operation was successful or error code in other cases.
+
Returns S_OK if the operation was successful, or will return an error code if it fails.  
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IUIX_Dialog|IUIX_Dialog]].
+
[[PXV:IUIX_Dialog|IUIX_Dialog]]

Latest revision as of 15:45, 15 June 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     sItemID,
                          [in]  PARAM_T  nParam);

Parameters

sItemID
[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 the operation was successful, or will return an error code if it fails.

See Also

IUIX_Dialog