PdfOCOrderCollection Class

Represents a collection specifying the recommended order for presentation of optional content groups in a user interface.

Inheritance Hierarchy

SystemObject
Patagames.PdfPdfArrayWrapperIOrderNode
Patagames.Pdf.Net.Wrappers.OptionalContentPdfOCOrderCollection

Namespace: Patagames.Pdf.Net.Wrappers.OptionalContent
Assembly: Patagames.Pdf (in Patagames.Pdf.dll) Version: 4.94.2704

Syntax

C++

JavaScript

Copy

public class PdfOCOrderCollection : PdfArrayWrapper<IOrderNode>, 
	IOrderNode

Public Class PdfOCOrderCollection
	Inherits PdfArrayWrapper(Of IOrderNode)
	Implements IOrderNode

public ref class PdfOCOrderCollection : public PdfArrayWrapper<IOrderNode^>, 
	IOrderNode

type PdfOCOrderCollection = 
    class
        inherit PdfArrayWrapper<IOrderNode>
        interface IOrderNode
    end

public class PdfOCOrderCollection extends PdfArrayWrapper<IOrderNode> implements IOrderNode

Patagames.Pdf.Net.Wrappers.OptionalContent.PdfOCOrderCollection = function();

Type.createClass(
	'Patagames.Pdf.Net.Wrappers.OptionalContent.PdfOCOrderCollection',
	Patagames.Pdf.PdfArrayWrapper`1,
	Patagames.Pdf.Net.Wrappers.OptionalContent.IOrderNode);

The PdfOCOrderCollection type exposes the following members.

Constructors

	Name	Description
	PdfOCOrderCollection(PdfDocument)	Creates a new empty collection.
	PdfOCOrderCollection(PdfDocument, PdfTypeBase)	Initialize new instance of PdfOCOrderCollection class.

Top

Remarks

The collection elements may include the following objects:

PdfOCGroup, which Name property is to be displayed in the user interface.
PdfOCOrderCollection to allow nesting as in a tree or outline structure. Each nested collection may optionally have as its first element the PdfOCLabel, which Label property is to be used as a non-selectable label in the user interface.

Note
PdfOCLabel in nested collections should be used to present collections of related optional content groups, and not to communicate actual nesting of content inside multiple layers of groups. To reflect actual nesting of groups in the content, such as for layers with sublayers, nested arrays of groups without a text label should be used.

An empty collection explicitly specifies that no groups should be presented.

In the default configuration (Default), the default value is an empty collection; in other configurations (Configs), the default is the Order value from the default configuration.

Note
Any groups not listed in this collection should not be presented in any user interface that uses the configuration.

Reference

Patagames.Pdf.Net.Wrappers.OptionalContent Namespace