IUIX_Dialog::EnableLayer Method

Latest revision as of 15:12, 15 June 2015

UI Layer > Interfaces > IUIX_Dialog > IUIX_Dialog::EnableLayer Method

Enables/disables all items of a required layer.

HRESULT EnableLayer([in]                    BSTR          sLayerName,
                    [in, defaultvalue(-1)]  VARIANT_BOOL  bEnable);

sLayerName: [in] a name of a layer to enable/disable.
bEnable: [in, defaultvalue(-1)] enables all layer items if this parameter is set to VARIANT_TRUE, or disables them if set to VARIANT_FALSE.

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::EnableLayer Method}}
-{{#parentPage:PXV:IUIX_Dialog|method}}
+{{#parentPage:PXV:IUIX_Dialog#Methods|EnableLayer|method}}
-{{ToWrite}}
-{{ToReview}}
-The method of interface of PDF-XChange Editor SDK.
+Enables/disables all items of a required layer.
 == Syntax ==
-<pre class="brush:cpp;gutter:false">HRESULT EnableLayer([in] BSTR pLayerName, [in, defaultvalue(-1)] VARIANT_BOOL bEnable);</pre>
+<pre class="brush:cpp;gutter:false">HRESULT EnableLayer([in]                    BSTR          sLayerName,
+                    [in, defaultvalue(-1)]  VARIANT_BOOL  bEnable);</pre>
 == Parameters ==
-;''pLayerName''
+;sLayerName
-:[in]  Value of BSTR.
+:[in]  a name of a layer to enable/disable.
-;''bEnable''
+;bEnable
-:[in, defaultvalue(-1)]  Value of VARIANT_BOOL.
+:[in, defaultvalue(-1)]  enables all layer items if this parameter is set to VARIANT_TRUE, or disables them if set to VARIANT_FALSE.
 == 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]]