IUIX_Dialog::IsItemEnabled Method

Latest revision as of 15:34, 15 June 2015

UI Layer > Interfaces > IUIX_Dialog > IUIX_Dialog::IsItemEnabled Method

Checks if a required item with given text ID is enabled.

HRESULT IsItemEnabled([in]           BSTR           sItemID,
                      [out, retval]  VARIANT_BOOL*  bEnabled);

sItemID: [in] text ID of a required item.
bEnabled: [out, retval] returns VARIANT_TRUE if the item is enabled or VARIANT_FALSE if the item is disabled.

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::IsItemEnabled Method}}
-{{#parentPage:PXV:IUIX_Dialog|method}}
+{{#parentPage:PXV:IUIX_Dialog#Methods|IsItemEnabled|method}}
-{{ToWrite}}
-{{ToReview}}
-The method of interface of PDF-XChange Editor SDK.
+Checks if a required item with given text ID is enabled.
 == Syntax ==
-<pre class="brush:cpp;gutter:false">HRESULT IsItemEnabled([in] BSTR pItemID, [out, retval] VARIANT_BOOL* pEnabled);</pre>
+<pre class="brush:cpp;gutter:false">HRESULT IsItemEnabled([in]           BSTR           sItemID,
+                      [out, retval]  VARIANT_BOOL*  bEnabled);</pre>
 == Parameters ==
-;''pItemID''
+;sItemID
-:[in]  Value of BSTR.
+:[in]  text ID of a required item.
-;''pEnabled''
+;bEnabled
-:[out, retval]  Pointer to VARIANT_BOOL.
+:[out, retval]  returns VARIANT_TRUE if the item is enabled or VARIANT_FALSE if the item is disabled.
 == 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]]