IUIX_Dialog::EnableLayer Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IUIX_Dialog::EnableLayer Method}} | {{#customTitle:IUIX_Dialog::EnableLayer Method}} | ||
| − | {{#parentPage:PXV:IUIX_Dialog|EnableLayer | + | {{#parentPage:PXV:IUIX_Dialog#Methods|EnableLayer|method}} |
| − | + | ||
| − | + | ||
| − | + | ||
| + | Enables/disables all items of a required layer. | ||
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT EnableLayer([in] BSTR | + | <pre class="brush:cpp;gutter:false">HRESULT EnableLayer([in] BSTR sLayerName, |
[in, defaultvalue(-1)] VARIANT_BOOL bEnable);</pre> | [in, defaultvalue(-1)] VARIANT_BOOL bEnable);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;sLayerName |
| − | :[in] | + | :[in] a name of a layer to enable/disable. |
;bEnable | ;bEnable | ||
| − | :[in, defaultvalue(-1)] | + | :[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 == | ||
| − | Returns S_OK if operation was successful or error code | + | 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]] | |
Latest revision as of 15:12, 15 June 2015
Enables/disables all items of a required layer.
Syntax
HRESULT EnableLayer([in] BSTR sLayerName,
[in, defaultvalue(-1)] VARIANT_BOOL bEnable);
Parameters
- 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.
Return Value
Returns S_OK if the operation was successful, or will return an error code if it fails.
