GrapeCity.Documents.Pdf.Layers.OptionalContentProperties

OptionalContentProperties Class

Represents the Optional Content Properties PDF dictionary that can be specified in the document catalog.

Inheritance

OptionalContentProperties

Implements

IPdfDict

Namespace: GrapeCity.Documents.Pdf.Layers

Assembly: DS.Documents.Pdf.dll

Syntax

public class OptionalContentProperties : PdfDictWrapper, IPdfDict

Public Class OptionalContentProperties
    Inherits PdfDictWrapper
    Implements IPdfDict

Properties

Name	Description
Configs	Gets the collection of alternate optional content configurations.
DefaultConfig	Gets the default optional content configuration.
Doc	Gets the GcPdfDocument object that owns this object.
Groups	Gets the collection of optional content groups.
HasConfigs	Gets a value indicating whether the Configs collection is not empty.
HasDefaultConfig	Gets a value indicating whether this OptionalContentProperties has DefaultConfig property.
HasGroups	Gets a value indicating whether the Groups collection is not empty.

Methods

Name	Description
AddLayer(string)	Adds a layer with a specified name.
Clear()	Clears the content of the current object.
GetLayer(string)	Returns the OptionalContentGroup by its name.
GetLayerDefaultState(OptionalContentGroup)	Returns a value indicating whether a layer is ON by default.
GetLayerDefaultState(string)	Returns a value indicating whether a layer is ON by default. Throws an exception if the layer with the specified name does not exist.
GetLayerExportState(OptionalContentGroup)	Returns the export state of a layer.
GetLayerExportState(string)	Returns the export state of a layer. Throws an exception if the layer with the specified name does not exist.
GetLayerInitialViewState(OptionalContentGroup)	Returns the layer initial view state of a layer.
GetLayerInitialViewState(string)	Returns the layer initial view state of a layer. Throws an exception if the layer with the specified name does not exist.
GetLayerLocked(OptionalContentGroup)	Returns a value indicating whether a layer is locked.
GetLayerLocked(string)	Returns a value indicating whether a layer is locked. Throws an exception if the layer with the specified name does not exist.
GetLayerPrintState(OptionalContentGroup)	Returns the print state of a layer.
GetLayerPrintState(string)	Returns the print state of a layer. Throws an exception if the layer with the specified name does not exist.
RemoveLayer(OptionalContentGroup)	Removes a specified layer. Note that this method does not remove the content associated with the layer. For content removal, see RemoveLayers(bool, params OptionalContentGroup[]).
RemoveLayer(string)	Removes a layer with a specified name. Throws an exception if the layer with the specified name does not exist. Note that this method does not remove the content associated with the layer. For content removal, see RemoveLayers(bool, params OptionalContentGroup[]).
RemoveLayers(bool, params OptionalContentGroup[])	Removes specified layers, optionally removing content associated with those layers.
SetLayerDefaultState(OptionalContentGroup, bool)	Sets the default state of a layer.
SetLayerDefaultState(string, bool)	Sets the default state of a layer. Throws an exception if the layer with the specified name does not exist.
SetLayerExportState(OptionalContentGroup, LayerExportState)	Sets the export state of a layer.
SetLayerExportState(string, LayerExportState)	Sets the export state of a layer. Throws an exception if the layer with the specified name does not exist.
SetLayerInitialViewState(OptionalContentGroup, LayerInitialViewState)	Sets the initial view state of a layer.
SetLayerInitialViewState(string, LayerInitialViewState)	Sets the initial view state of a layer. Throws an exception if the layer with the specified name does not exist.
SetLayerLocked(OptionalContentGroup, bool)	Sets the locked state of a layer.
SetLayerLocked(string, bool)	Sets the locked state of a layer. Throws an exception if the layer with the specified name does not exist.
SetLayerPrintState(OptionalContentGroup, LayerPrintState)	Sets the print state of a layer.
SetLayerPrintState(string, LayerPrintState)	Sets the print state of a layer. Throws an exception if the layer with the specified name does not exist.