iText.Kernel.Pdf.Tagutils.TagReference Class Reference

The class is used to provide connection between structure element of Tagged PDF document and marked content sequence in PDF stream. More...

Public Member Functions
virtual PdfName	GetRole ()
	Gets role of structure element. More...
virtual int	CreateNextMcid ()
	Creates next marked content identifier, which will be used to mark content in PDF stream. More...
virtual iText.Kernel.Pdf.Tagutils.TagReference	AddProperty (PdfName name, PdfObject value)
	Adds property, which will be associated with marked-content sequence. More...
virtual iText.Kernel.Pdf.Tagutils.TagReference	RemoveProperty (PdfName name)
	Removes property. More...
virtual PdfObject	GetProperty (PdfName name)
	Gets property which related to specified name. More...
virtual PdfDictionary	GetProperties ()
	Gets properties, which will be associated with marked-content sequence as iText.Kernel.Pdf.PdfDictionary. More...

Package Functions
	TagReference (PdfStructElem referencedTag, TagTreePointer tagPointer, int insertIndex)
	Creates a TagReference instance which represents a reference to iText.Kernel.Pdf.Tagging.PdfStructElem. More...

Package Attributes
TagTreePointer	tagPointer
int	insertIndex
PdfStructElem	referencedTag
PdfName	role
PdfDictionary	properties

Detailed Description

The class is used to provide connection between structure element of Tagged PDF document and marked content sequence in PDF stream.

The class is used to provide connection between structure element of Tagged PDF document and marked content sequence in PDF stream.

See TagTreePointer.GetTagReference(int) and iText.Kernel.Pdf.Canvas.PdfCanvas.OpenTag(TagReference).

Constructor & Destructor Documentation

TagReference()

iText.Kernel.Pdf.Tagutils.TagReference.TagReference ( PdfStructElem  referencedTag, TagTreePointer  tagPointer, int  insertIndex  )

inlinepackage

Creates a TagReference instance which represents a reference to iText.Kernel.Pdf.Tagging.PdfStructElem.

Parameters

referencedTag	a structure element to which marked content will link (if insertIndex is -1, otherwise to MC will link to kid with insertIndex of passed structure element)
tagPointer	the tag pointer to structure element
insertIndex	if insertIndex is -1, the referencedTag will be used as a source of reference, otherwise the kid will be used

Member Function Documentation

AddProperty()

virtual iText.Kernel.Pdf.Tagutils.TagReference iText.Kernel.Pdf.Tagutils.TagReference.AddProperty ( PdfName  name, PdfObject  value  )

inlinevirtual

Adds property, which will be associated with marked-content sequence.

Parameters

name	the name of the property
value	the value of the property

Returns

the TagReference instance

CreateNextMcid()

virtual int iText.Kernel.Pdf.Tagutils.TagReference.CreateNextMcid ( )

inlinevirtual

Creates next marked content identifier, which will be used to mark content in PDF stream.

Returns

the marked content identifier

GetProperties()

virtual PdfDictionary iText.Kernel.Pdf.Tagutils.TagReference.GetProperties ( )

inlinevirtual

Gets properties, which will be associated with marked-content sequence as iText.Kernel.Pdf.PdfDictionary.

Returns

the properties

GetProperty()

virtual PdfObject iText.Kernel.Pdf.Tagutils.TagReference.GetProperty ( PdfName  name )

inlinevirtual

Gets property which related to specified name.

Parameters

name	the name of the property

Returns

the value of the property

GetRole()

virtual PdfName iText.Kernel.Pdf.Tagutils.TagReference.GetRole ( )

inlinevirtual

Gets role of structure element.

Returns

the role of structure element

RemoveProperty()

virtual iText.Kernel.Pdf.Tagutils.TagReference iText.Kernel.Pdf.Tagutils.TagReference.RemoveProperty ( PdfName  name )

inlinevirtual

Removes property.

Removes property. The property will not be associated with marked-content sequence.

Parameters

name	the name of property to be deleted

Returns

the TagReference instance