OptionalContentConfiguration Class

Apitron PDF Kit help

Apitron.PDF.Kit library for .NET

This class represents an optional content configuration, which represent different presentations of a document’s optional content groups for use by conforming readers.

Inheritance Hierarchy

SystemObject
Apitron.PDF.Kit.FixedLayout.ResourcesResource
Apitron.PDF.Kit.FixedLayout.OptionalContentOptionalContentConfiguration

Namespace: Apitron.PDF.Kit.FixedLayout.OptionalContent
Assembly: Apitron.PDF.Kit (in Apitron.PDF.Kit.dll) Version: 2.0.37.0 (2.0.37.0)

Syntax

Copy

public class OptionalContentConfiguration : Resource

Public Class OptionalContentConfiguration
	Inherits Resource

The OptionalContentConfiguration type exposes the following members.

Constructors

	Name	Description
	OptionalContentConfiguration	Initializes a new instance of the OptionalContentConfiguration class.

Top

Properties

	Name	Description
	BaseState	Used to initialize the states of all the optional content groups in a document when this configuration is applied. The value of this entry shall be one of the following names: On The states of all groups shall be turned ON. Off The states of all groups shall be turned OFF. Unchanged The states of all groups shall be left unchanged. After this initialization, the contents of the ON and OFF arrays shall beprocessed, overriding the state of the groups included in the arrays. Default value: On. If BaseState is present in the document’s default configuration, its value shall be On.
	CanBeExported	Gets a value indicating whether this instance can be exported. (Inherited from Resource.)
	IntentNames	A single intent name or an array containing any combination of names. it shall be used to determine which optional content groups’ states to consider and which to ignore in calculating the visibility of content. PDF defines two intent names, View and Design. In addition, the name All shall indicate the set of all intents, including those not yet defined. Default value: View. The value shall be View for the document’s default configuration.
	ListMode	A mode specifying which optional content groups in the Order array shall be displayed to the user.
	LockedGroups	An array of optional content groups that shall belocked when this configuration is applied. The state of a locked group cannot be changed through the user interface of a conforming reader. Conforming writers can use this entry to prevent the visibility of content that depends on these groups from being changed by users. Default value: an empty array.
	Name	A name for the configuration, suitable for presentation in a user interface.
	OffGroups	An array of optional content groups whose state shall beset to OFF when this configuration is applied. If the BaseState entry is Off, this entry is redundant.
	OnGroups	An array of optional content groups whose state shall beset to ON when this configuration is applied. If the BaseState entry is On, this entry is redundant.
	Order	Gets the tree specifying the order for presentation of optional content groups in a conforming reader’s user interface.
	RadioButtonGroups	Gets the array consisting of one or more arrays, each of which represents a collection of optional content groups whose states shall be intended to follow a radio button paradigm. That is, the state of at most one optional content group in each array shall be ON at a time. If one group is turned ON, all others shall be turned OFF. However, turning a group from ON to OFF does not force any other group to be turned ON.
	ResourceType	Gets the resource type. (Inherited from Resource.)

Top

Reference

Apitron.PDF.Kit.FixedLayout.OptionalContent Namespace