IUIX_Dialog::EnableLayer Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 2: Line 2:
 
{{#customTitle:IUIX_Dialog::EnableLayer Method}}
 
{{#customTitle:IUIX_Dialog::EnableLayer Method}}
 
{{#parentPage:PXV:IUIX_Dialog|EnableLayer Method|method}}
 
{{#parentPage:PXV:IUIX_Dialog|EnableLayer Method|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Enables/disables all items of a required layer.
  
 
== Syntax ==
 
== Syntax ==
Line 13: Line 12:
 
== Parameters ==
 
== Parameters ==
 
;pLayerName
 
;pLayerName
:[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 ==
 
== Return Value ==

Revision as of 06:55, 15 May 2015


Enables/disables all items of a required layer.

Syntax

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

Parameters

pLayerName
[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.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

See also IUIX_Dialog.