OptionalContentMembershipDict Class Documentation

class OptionalContentMembershipDict : SystemIDisposable

Namespace:Datalogics::PDFL

Inherits from:
SystemIDisposable

Detailed Description

Attaches content to one or more optional content groups.

Form, container, and annotation objects can be associated with one or more optional content groups. By associating them with an optional content group, they become part of that 'layer', and the user can control the visibility of the content.

Note that by placing other element objects in a container, they can also be associated with an optional content group.

An OptionalContentMembershipDict connects content to the OptionalContentGroup; it contains a list of OptionalContentGroups, and rules for determining visibility when the OptionalContentGroups have conflicting on/off states in the active OptionalContentContext.

An OptionalContentMembershipDict cannot be changed once created; you must create a new OptionalContentMembershipDict and change the objects to point to it.

Referenced by

AnnotationCircleAnnotationContainerFormFreeTextAnnotationHighlightAnnotationInkAnnotationLineAnnotationLinkAnnotationPolyLineAnnotationPolygonAnnotationRedactionSquareAnnotationTextMarkupAnnotationUnderlineAnnotation

Constructor & Destructor Documentation

OptionalContentMembershipDict

OptionalContentMembershipDict(Document doc, System.Collections.Generic.IList< OptionalContentGroup > ocgs, VisibilityPolicy vp, PDFArray visibilityExpression)

Parameters

doc: Document

The document that the new OptionalContentMembershipDict will belong to.

ocgs: System.Collections.Generic.IList< OptionalContentGroup >

The list of OptionalContentGroups this MembershipDict refers to.

vp: VisibilityPolicy

The VisibilityPolicy of this MembershipDict.

visibilityExpression: PDFArray

The VisibilityExpression of this MembershipDict.

Create a new OptionalContentMembershipDict.

Property Documentation

OptionalContentGroups

System.Collections.Generic.IList< OptionalContentGroup > OptionalContentGroups[get]

Gets the list of OptionalContentGroups for this membership dictionary. This may consist of one OCG or several.

VisibilityExpression

PDFArray VisibilityExpression[get]

GetVisibilityExpression Gets the Visibility Expression for this membership dictionary.

VisibilityPolicy

VisibilityPolicy VisibilityPolicy[get]

Gets the Visbility Policy for this membership dictionary.

Member Function Documentation

Dispose

void Dispose()

Returns:

void

Equals

override bool Equals(object obj)

Parameters

obj: object

Returns:

override bool

ToString

override string ToString()

Returns:

override string

A string describing this OptionalContentMembershipDict.

Returns a string representation of this OptionalContentMembershipDict.

The string includes the names of all associated OptionalContentGroups and the current VisibilityPolicy.