IUIX_Dialog::EnableItem Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_Dialog::EnableItem Method}}
 
{{#customTitle:IUIX_Dialog::EnableItem Method}}
{{#parentPage:PXV:IUIX_Dialog|method}}
+
{{#parentPage:PXV:IUIX_Dialog#Methods|EnableItem|method}}
{{ToWrite}}
+
{{ToReview}}
+
  
The method of interface of PDF-XChange Editor SDK.
+
 
 +
Enables/disables an item in a dialog by item's ''text ID''.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT EnableItem([in] BSTR pItemID, [in] VARIANT_BOOL bEnable);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT EnableItem([in] BSTR         sItemID,
 +
                  [in] VARIANT_BOOL bEnable);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pItemID''
+
;sItemID
:[in]  Value of BSTR.
+
:[in]  text ID of an item to be enabled/disabled.
;''bEnable''
+
;bEnable
:[in]  Value of VARIANT_BOOL.
+
:[in]  enables required item if this parameter is set to VARIANT_TRUE, or disables it if set to VARIANT_FALSE.
  
 
== 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 14:10, 15 June 2015


Enables/disables an item in a dialog by item's text ID.

Syntax

HRESULT EnableItem([in]  BSTR          sItemID,
                   [in]  VARIANT_BOOL  bEnable);

Parameters

sItemID
[in] text ID of an item to be enabled/disabled.
bEnable
[in] enables required item if this parameter is set to VARIANT_TRUE, or disables it if set to VARIANT_FALSE.

Return Value

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

See Also

IUIX_Dialog