Config Class

The OCG::Config object represents an optional-content (OC) configuration structure (see section 4.10.3 in PDF Reference), used to persist a set of visibility states and other optional-content information in a PDF file A document has a default configuration, saved in the D entry in the 'OCProperties' dictionary (that can be obtained using pdfdoc.GetOCConfig()), and can have a list of other configurations, saved as an Array in the 'Configs' entry in the OCProperties dictionary.

Configurations are typically used to initialize the OCG ON-OFF states for an optional-content context (OCG::Context). The OCG order in the configuration is the order in which the groups appear in the Layers panel of a PDF viewer. The configuration can also define a set of mutually exclusive OCGs, called a radio button group.

Inheritance Hierarchy

SystemObject
pdftron.PDF.OCGConfig

Namespace: pdftron.PDF.OCG
Assembly: pdftron (in pdftron.dll) Version: 255.255.255.255

Syntax

C++

JavaScript

Copy

public sealed class Config

Public NotInheritable Class Config

public ref class Config sealed

pdftron.PDF.OCG.Config = function();

Type.createClass(
	'pdftron.PDF.OCG.Config');

The Config type exposes the following members.

Constructors

	Name	Description
	Config	Creates a new optional-content configuration from an existing SDF Cos object.

Top

Methods

	Name	Description
	Create	Creates a new optional-content configuration from an existing SDF/Cos object.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetCreator	Gets the creator.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetInitBaseState	Gets the inits the base state.
	GetInitOffStates	Gets the inits the off states.
	GetInitOnStates	Gets the inits the on states.
	GetIntent	Gets the intent.
	GetLockedOCGs	Gets the locked oc gs.
	GetName	Gets the name.
	GetOrder	Gets the order.
	GetSDFObj	Gets the SDFObj.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	SetCreator	Sets the creator property of an optional-content configuration. Stores the specified string as the Creator entry in the configuration's SDF/Cos dictionary.
	SetInitBaseState	Sets the base initialization state. For more info, please see GetInitBaseState().
	SetInitOffStates	Sets the 'OFF' initialization Array in the configuration dictionary. For more info, please see SetInitOffStates() and section 4.10.3 in PDF Reference.
	SetInitOnStates	Sets the 'ON' initialization Array in the configuration dictionary. For more info, please see SetInitOnStates() and section 4.10.3 in PDF Reference.
	SetIntent	Sets the Intent entry in an optional-content configuration's SDF/Cos dictionary. For more information, see GetIntent().
	SetLockedOCGs	Sets the Array of locked OCGs. The on/off state of a locked OCG cannot be toggled by the user through the user interface.
	SetName	Sets the name of an optional-content configuration (suitable for presentation in a user interface). The method stores the specified string as the Name entry in the configuration's SDF/Cos dictionary.
	SetOrder	Sets the user interface display order of optional-content groups (OCGs) in this configuration. This is the order in which the group names are displayed in the Layers panel of a PDF viewer.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

pdftron.PDF.OCG Namespace