Click or drag to resize

PdfOCGroup Class

Represents an optional content group dictionary.
Inheritance Hierarchy
SystemObject
  Patagames.Pdf.Net.WrappersPdfWrapper
    Patagames.Pdf.Net.Wrappers.OptionalContentPdfOCGroup

Namespace:  Patagames.Pdf.Net.Wrappers.OptionalContent
Assembly:  Patagames.Pdf (in Patagames.Pdf.dll) Version: 4.89.2704
Syntax
public class PdfOCGroup : PdfWrapper, IOrderNode

The PdfOCGroup type exposes the following members.

Constructors
  NameDescription
Public methodPdfOCGroup(PdfTypeBase)
Creates a new instance of PdfOCGroup and initialize it with specified dictionary
Public methodPdfOCGroup(String)
Creates new instance of PdfOCGroup.
Top
Properties
  NameDescription
Public propertyIntent
Gets or sets a combination of intent flags.
Public propertyName
Gets or sets the name of the optional content group, suitable for presentation in a viewer application’s user interface.
Public propertyUsage
Gets or sets a usage object describing the nature of the content controlled by the group. It may be used by features that automatically control the state of the group based on outside factors.
Top
Remarks
An optional content group is a class representing a collection of PdfPageObject that can be made visible or invisible dynamically by users of viewer applications. The page objects belonging to such a group can reside anywhere in the document: they need not be consecutive in drawing order, nor even belong to the same content stream. The PdfOCGroup class describes such an optional content group.

In its simplest form, each group contains a Name for presentation in a user interface. It may also have an Intent property that describes its intended use and a Usage property that describes the nature of its content.

Individual page objects in a document specify the optional content group or groups that affect their visibility. Any page object whose visibility can be affected by a given optional content group is said to belong to that group.

A group is assigned a state, which is either On or Off. States are not themselves part of the PDF document but can be set programmatically or through the viewer user interface to change the visibility of page object. When a document is first opened, the groups’ states are initialized based on the document’s Default configuration.

In the typical case, page object belonging to a group is visible when the group is On and invisible when it is Off. In more complex cases, page object can belong to multiple groups, which may have conflicting states. These cases are described by the use of PdfOCMembership class.

See Also