Click or drag to resize

PdfOCMembership Class

Represents an optional content membership dictionary.
Inheritance Hierarchy
SystemObject
  Patagames.Pdf.Net.WrappersPdfWrapper
    Patagames.Pdf.Net.Wrappers.OptionalContentPdfOCMembership

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

The PdfOCMembership type exposes the following members.

Constructors
  NameDescription
Public methodPdfOCMembership(PdfDocument)
Creates new instance of PdfOCMembership.
Public methodPdfOCMembership(PdfDocument, PdfTypeBase)
Creates a new instance of PdfOCMembership and initialize it with specified dictionary
Top
Properties
  NameDescription
Public propertyOCGs
Gets or sets an array of PdfOCGroup specifying the optional content groups whose states determine the visibility of content controlled by this membership.
Public propertyPolicy
Gets or sets an OCGPolicy specifying the visibility policy for content belonging to this membership dictionary.
Top
Remarks
As mentioned in the PdfOCGroup class notes, PdfPageObject typically belongs to a single optional content group and is visible when the group is On and invisible when it is Off. To express more complex visibility policies, page object should declare itself not to belong directly to an optional content group but rather to an optional content membership.

An PdfOCMembership class can express its visibility policy in two ways:

  • The Policy property specifies a simple boolean expression indicating how the optional content groups specified by the OCGs property determine the visibility of page object controlled by the membership.

  • The VE entry of the membership Dictionary, which is a visibility expression that can specify an arbitrary boolean expression for computing the visibility of page object from the states of optional content groups.

See Also