Inheritance diagram for iTextSharp.text.pdf.PdfLayer:

Public Member Functions
	PdfLayer (String name, PdfWriter writer)

void	AddChild (PdfLayer child)

void	SetCreatorInfo (String creator, String subtype)

void	SetLanguage (String lang, bool preferred)

void	SetZoom (float min, float max)

void	SetPrint (String subtype, bool printstate)

Public Member Functions inherited from iTextSharp.text.pdf.PdfDictionary
	PdfDictionary ()

	PdfDictionary (PdfName type)

override void	ToPdf (PdfWriter writer, Stream os)

void	Put (PdfName key, PdfObject value)

void	PutEx (PdfName key, PdfObject value)

void	Remove (PdfName key)

PdfObject	Get (PdfName key)

bool	IsFont ()

bool	IsPage ()

bool	IsPages ()

bool	IsCatalog ()

bool	IsOutlineTree ()

void	Merge (PdfDictionary other)

void	MergeDifferent (PdfDictionary other)

bool	Contains (PdfName key)

virtual IDictionaryEnumerator	GetEnumerator ()

override String	ToString ()

PdfObject	GetDirectObject (PdfName key)

PdfDictionary	GetAsDict (PdfName key)

PdfArray	GetAsArray (PdfName key)

PdfStream	GetAsStream (PdfName key)

PdfString	GetAsString (PdfName key)

PdfNumber	GetAsNumber (PdfName key)

PdfName	GetAsName (PdfName key)

PdfBoolean	GetAsBoolean (PdfName key)

PdfIndirectReference	GetAsIndirectObject (PdfName key)

Public Member Functions inherited from iTextSharp.text.pdf.PdfObject
virtual byte[]	GetBytes ()

bool	CanBeInObjStm ()

override string	ToString ()

bool	IsNull ()

bool	IsBoolean ()

bool	IsNumber ()

bool	IsString ()

bool	IsName ()

bool	IsArray ()

bool	IsDictionary ()

bool	IsStream ()

bool	IsIndirect ()

Static Public Member Functions
static PdfLayer	CreateTitle (String title, PdfWriter writer)

Protected Attributes
PdfIndirectReference	refi

ArrayList	children

PdfLayer	parent

String	title

Protected Attributes inherited from iTextSharp.text.pdf.PdfObject
byte[]	bytes

int	type

PRIndirectReference	indRef

Properties
PdfLayer	Parent `[get]`

ArrayList	Children `[get]`

PdfIndirectReference	Ref `[get, set]`

string	Name `[set]`

PdfObject	PdfObject `[get]`

bool	On `[get, set]`

bool?	Export `[set]`

bool?	View `[set]`

bool	OnPanel `[get, set]`

Properties inherited from iTextSharp.text.pdf.PdfDictionary
ICollection	Keys `[get]`

int	Size `[get]`

Properties inherited from iTextSharp.text.pdf.PdfObject
int	Length `[get]`

string	Content `[set]`

int	Type `[get]`

PRIndirectReference	IndRef `[get, set]`

Properties inherited from iTextSharp.text.pdf.IPdfOCG
PdfIndirectReference	Ref `[get]`

PdfObject	PdfObject `[get]`

Additional Inherited Members
Static Public Attributes inherited from iTextSharp.text.pdf.PdfDictionary
static PdfName	FONT = PdfName.FONT

static PdfName	OUTLINES = PdfName.OUTLINES

static PdfName	PAGE = PdfName.PAGE

static PdfName	PAGES = PdfName.PAGES

static PdfName	CATALOG = PdfName.CATALOG

Static Public Attributes inherited from iTextSharp.text.pdf.PdfObject
const int	BOOLEAN = 1

const int	NUMBER = 2

const int	STRING = 3

const int	NAME = 4

const int	ARRAY = 5

const int	DICTIONARY = 6

const int	STREAM = 7

const int	NULL = 8

const int	INDIRECT = 10

const string	NOTHING = ""

const string	TEXT_PDFDOCENCODING = "PDF"

const string	TEXT_UNICODE = "UnicodeBig"

Protected Member Functions inherited from iTextSharp.text.pdf.PdfObject
	PdfObject (int type)

	PdfObject (int type, string content)

	PdfObject (int type, byte[] bytes)

Detailed Description

An optional content group is a dictionary representing a collection of graphics that can be made visible or invisible dynamically by users of viewer applications. In iText they are referenced as layers.

Author: Paulo Soares (psoar.nosp@m.es@c.nosp@m.onsis.nosp@m.te.p.nosp@m.t)

Constructor & Destructor Documentation

◆ PdfLayer()

iTextSharp.text.pdf.PdfLayer.PdfLayer	(	String	name,
		PdfWriter	writer
	)

Creates a new layer.

Parameters

name	the name of the layer
writer	the writer

Member Function Documentation

◆ AddChild()

void iTextSharp.text.pdf.PdfLayer.AddChild ( PdfLayer child )

Adds a child layer. Nested layers can only have one parent.

Parameters

child the child layer

◆ CreateTitle()

static PdfLayer iTextSharp.text.pdf.PdfLayer.CreateTitle	(	String	title,
		PdfWriter	writer
	)

static

Creates a title layer. A title layer is not really a layer but a collection of layers under the same title heading.

Parameters

title	the title text
writer	the `PdfWriter`

Returns: the title layer

◆ SetCreatorInfo()

void iTextSharp.text.pdf.PdfLayer.SetCreatorInfo	(	String	creator,
		String	subtype
	)

Used by the creating application to store application-specific data associated with this optional content group.

Parameters

creator	a text string specifying the application that created the group
subtype	a string defining the type of content controlled by the group. Suggested values include but are not limited to Artwork, for graphic-design or publishing applications, and Technical, for technical designs such as building plans or schematics

◆ SetLanguage()

void iTextSharp.text.pdf.PdfLayer.SetLanguage	(	String	lang,
		bool	preferred
	)

Specifies the language of the content controlled by this optional content group

Parameters

lang	a language string which specifies a language and possibly a locale (for example, es-MX represents Mexican Spanish)
preferred	used by viewer applications when there is a partial match but no exact match between the system language and the language strings in all usage dictionaries

◆ SetPrint()

void iTextSharp.text.pdf.PdfLayer.SetPrint	(	String	subtype,
		bool	printstate
	)

Specifies that the content in this group is intended for use in printing

Parameters

subtype	a name specifying the kind of content controlled by the group; for example, Trapping, PrintersMarks and Watermark
printstate	indicates that the group should be set to that state when the document is printed from a viewer application

◆ SetZoom()

void iTextSharp.text.pdf.PdfLayer.SetZoom	(	float	min,
		float	max
	)

Specifies a range of magnifications at which the content in this optional content group is best viewed.

Parameters

min	the minimum recommended magnification factors at which the group should be ON. A negative value will set the default to 0
max	the maximum recommended magnification factor at which the group should be ON. A negative value will set the largest possible magnification supported by the viewer application

Member Data Documentation

◆ children

ArrayList iTextSharp.text.pdf.PdfLayer.children

protected

◆ parent

PdfLayer iTextSharp.text.pdf.PdfLayer.parent

protected

◆ refi

PdfIndirectReference iTextSharp.text.pdf.PdfLayer.refi

protected

◆ title

String iTextSharp.text.pdf.PdfLayer.title

protected

Property Documentation

◆ Children

ArrayList iTextSharp.text.pdf.PdfLayer.Children

get

Gets the children layers.

Returns: the children layers or null if the layer has no children

◆ Export

bool? iTextSharp.text.pdf.PdfLayer.Export

set

Specifies the recommended state for content in this group when the document (or part of it) is saved by a viewer application to a format that does not support optional content (for example, an earlier version of PDF or a raster image format).

Parameters

export the export state

◆ Name

string iTextSharp.text.pdf.PdfLayer.Name

set

Sets the name of this layer.

Parameters

name	the name of this layer

◆ On

bool iTextSharp.text.pdf.PdfLayer.On

getset

Gets the initial visibility of the layer.

Returns: the initial visibility of the layer

◆ OnPanel

bool iTextSharp.text.pdf.PdfLayer.OnPanel

getset

Gets the layer visibility in Acrobat's layer panel

Returns: the layer visibility in Acrobat's layer panel Sets the visibility of the layer in Acrobat's layer panel. If false the layer cannot be directly manipulated by the user. Note that any children layers will also be absent from the panel.

Parameters

onPanel the visibility of the layer in Acrobat's layer panel

◆ Parent

PdfLayer iTextSharp.text.pdf.PdfLayer.Parent

get

Gets the parent layer.

Returns: the parent layer or null if the layer has no parent

◆ PdfObject

PdfObject iTextSharp.text.pdf.PdfLayer.PdfObject

get

Gets the dictionary representing the layer. It just returns this.

Returns: the dictionary representing the layer

◆ Ref

PdfIndirectReference iTextSharp.text.pdf.PdfLayer.Ref

getset

Gets the PdfIndirectReference that represents this layer.

Returns: the PdfIndirectReference that represents this layer

◆ View

bool? iTextSharp.text.pdf.PdfLayer.View

set

Indicates that the group should be set to that state when the document is opened in a viewer application.

Parameters

view	the view state

The documentation for this class was generated from the following file:

src/core/iTextSharp/text/pdf/PdfLayer.cs

Public Member Functions

Static Public Member Functions

Protected Attributes

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PdfLayer()

Member Function Documentation

◆ AddChild()

◆ CreateTitle()

◆ SetCreatorInfo()

◆ SetLanguage()

◆ SetPrint()

◆ SetZoom()

Member Data Documentation

◆ children

◆ parent

◆ refi

◆ title

Property Documentation

◆ Children

◆ Export

◆ Name

◆ On

◆ OnPanel

◆ Parent

◆ PdfObject

◆ Ref

◆ View