OptionalContentGroup Class Documentation

class OptionalContentGroup : SystemIDisposable

Namespace:Datalogics::PDFL

Inherits from:
SystemIDisposable

Detailed Description

A dictionary used to manage graphics images in a PDF.

An Optional Content Group is a dictionary that represents a set of graphics images that users can turn on or off in a PDF document, making them visible or invisible.

In a PDF Viewer, Optional Content Groups are referred to as "Layers."

Referenced by

DocumentOptionalContentConfigOptionalContentContextOptionalContentGroupOptionalContentMembershipDictOptionalContentOrderLeaf

Constructor & Destructor Documentation

OptionalContentGroup

OptionalContentGroup(Document doc, string name)

Parameters

doc: Document

The document that the new OptionalContentGroup will belong to.

name: string

The name given to the new OptionalContentGroup.

Create a new OptionalContentGroup.

Property Documentation

Intent

System.Collections.Generic.IList< System.String > Intent[get, set]

Name

string Name[get, set]

PDFDict

PDFDict PDFDict[get]

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 OptionalContentGroup.

Returns a string representation of this OptionalContentGroup.

The string includes the group's name and its intent list.