PdfOptionalContentGroup Class

An optional content group (ISO 32000-2, 8.11.2): a layer, which viewers let the user show or hide. The content of a group is drawn between PdfContentBuilder.BeginOptionalContent and PdfContentBuilder.EndMarkedContent; an annotation belongs to one with PdfAnnotation.OptionalContent.

public sealed class PdfOptionalContentGroup

Properties

NameDescription
DictionaryGets the group dictionary.
IntentsGets the intents of the group (/Intent): View, the default, Design, or names of applications.
IsVisibleGets or sets a value indicating whether the group is visible when the document is opened: its state in the default configuration (PdfOptionalContentProperties.DefaultConfiguration).
NameGets or sets the name of the group (/Name), which viewers show in their list of layers.
ReferenceGets the reference to the group.

Gets the group dictionary.

public PdfDictionary Dictionary { get; }

Property value

PdfDictionary

Gets the intents of the group (/Intent): View, the default, Design, or names of applications.

public IReadOnlyList<string> Intents { get; }

Property value

IReadOnlyList<string>

Gets or sets a value indicating whether the group is visible when the document is opened: its state in the default configuration (PdfOptionalContentProperties.DefaultConfiguration).

public bool IsVisible { get; set; }

Property value

bool

Gets or sets the name of the group (/Name), which viewers show in their list of layers.

public string Name { get; set; }

Property value

string

Gets the reference to the group.

public PdfReference Reference { get; }

Property value

PdfReference

Methods

NameDescription
Equals(object?)Determines whether the specified object is equal to the current object.
GetHashCode()Serves as the default hash function.

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)

Parameters

obj object?
The object to compare with the current object.

Returns

bool true if the specified object is equal to the current object; otherwise, false.

Serves as the default hash function.

public override int GetHashCode()

Returns

int A hash code for the current object.