Document Solutions for PDF
DS.Documents.Pdf Assembly / GrapeCity.Documents.Pdf.Layers Namespace / ViewState Class
Fields Properties Methods

In This Topic
    ViewState Class Members
    In This Topic

    The following tables list the members exposed by ViewState.

    Public Constructors
     NameDescription
    Public ConstructorViewState ConstructorInitializes a new instance of the ViewState class.  
    Top
    Public Fields
     NameDescription
    Public FieldDocThe GrapeCity.Documents.Pdf.GcPdfDocument for which this ViewState was created.  
    Top
    Public Properties
     NameDescription
    Public PropertyCurrentConfigurationGets the OptionalContentConfiguration specified in the last ApplyConfiguration method call.  
    Public PropertyIgnoreLayersStateGets or sets a value indicating whether all layers' state should be ignored and all layers should be considered visible.  
    Public PropertyModeGets or sets the document view mode.  
    Public PropertyZoomGets or sets the document zoom value (1 is actual size, no zoom).  
    Top
    Public Methods
     NameDescription
    Public MethodApplyConfigurationApplies the specified configuration to this view state.  
    Public MethodGetLayerUIStateOverloaded. Gets the visibility state of an optional content group (layer) in the context of an end-user UI The return value is interpreted as follows:
    • true: the user explicitly made layer visible.
    • false: the user explicitly made layer hidden.
    • a null reference (Nothing in Visual Basic): the user did not change the visibility of layer.
     
    Public MethodIsLayerActiveOverloaded. Checks whether a layer is active in the view mode specified by the Mode property. The target layer can be specified as an OptionalContentGroup, an OptionalContentMembership or a string representing the name of the layer.  
    Public MethodIsLayerExportableChecks whether a layer is visible when the document is exported. The target layer can be specified as an OptionalContentGroup, an OptionalContentMembership or a string representing the name of the layer.  
    Public MethodIsLayerPrintableChecks whether a layer is visible when the document is printed. The target layer can be specified as an OptionalContentGroup, an OptionalContentMembership or a string representing the name of the layer.  
    Public MethodIsLayerVisibleChecks whether a layer is visible when the document is viewed. The target layer can be specified as an OptionalContentGroup, an OptionalContentMembership or a string representing the name of the layer.  
    Public MethodResetResets this ViewState to its initial state.  
    Public MethodSetLayersUIStateSets the visibility of one or more layers in the context of an end-user UI. The layers array can contain layer names (strings) or OptionalContentGroup references. The state is interpreted as follows:
    • true: the user explicitly made the layers visible.
    • false: the user explicitly made the layers hidden.
    • a null reference (Nothing in Visual Basic): the user did not change the visibility of the layers.
     
    Public MethodSetLayersUIStateExceptSets the visibility of all layers except those listed in the layers array, in the context of an end-user UI. The layers array can contain layer names (strings) or OptionalContentGroup references. The state is interpreted as follows:
    • true: the user explicitly made all layers (except the specified ones) visible.
    • false: the user explicitly made all layers (except the specified ones) hidden.
    • a null reference (Nothing in Visual Basic): the user did not change the visibility of the layers.
     
    Public MethodSetLayerUIStateOverloaded. Sets the visibility of an optional content group (layer) in the context of an end-user UI. The state is interpreted as follows:
    • true: the user explicitly made layer visible.
    • false: the user explicitly made layer hidden.
    • a null reference (Nothing in Visual Basic): the user did not change the visibility of layer.
     
    Top
    See Also

    Reference

    ViewState Class
    GrapeCity.Documents.Pdf.Layers Namespace