IUIX_Dialog::SetItemSelByParam2 Method

Latest revision as of 15:00, 15 June 2015

UI Layer > Interfaces > IUIX_Dialog > IUIX_Dialog::SetItemSelByParam2 Method

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

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

HRESULT SetItemSelByParam2([in]  LONG     nItemID,
                           [in]  PARAM_T  nParam);

nItemID: [in] numerical 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.

Returns S_OK if the operation was successful, or will return an error code if it fails.

@@ Line 1: / Line 1: @@
+__NOTOC__
 [[Category:Editor]]
 {{#customTitle:IUIX_Dialog::SetItemSelByParam2 Method}}
-{{#parentPage:PXV:IUIX_Dialog|method}}
+{{#parentPage:PXV:IUIX_Dialog#Methods|SetItemSelByParam2|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 numerical ID and must implement [[PXV:IUIX_List|IUIX_List]], [[PXV:IUIX_Combo|IUIX_Combo]] or [[PXV:IUIX_Tree|IUIX_Tree]]  interface.
 == Syntax ==
-<pre class="brush:cpp;gutter:false">HRESULT SetItemSelByParam2([in] LONG nItemID, [in] PARAM_T nParam);</pre>
+<pre class="brush:cpp;gutter:false">HRESULT SetItemSelByParam2([in]  LONG     nItemID,
+                           [in]  PARAM_T  nParam);</pre>
 == Parameters ==
-;''nItemID''
+;nItemID
-:[in]  Value of LONG.
+:[in]  numerical 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 ==
-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 [[PXV:IUIX_Dialog|IUIX_Dialog]].
+[[PXV:IUIX_Dialog|IUIX_Dialog]]