Class LayoutTaggingHelper

Namespace

iText.Layout.Tagging

Assembly

itext.layout.dll

The class is a helper which is used to correctly create structure tree for layout element (with keeping right order for tags).

public class LayoutTaggingHelper

Inheritance

object

LayoutTaggingHelper

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

LayoutTaggingHelper(PdfDocument, bool)

public LayoutTaggingHelper(PdfDocument document, bool immediateFlush)

Parameters

document PdfDocument

immediateFlush bool

Methods

AddKidsHint(TaggingHintKey, ICollection<TaggingHintKey>)

public virtual void AddKidsHint(TaggingHintKey parentKey, ICollection<TaggingHintKey> newKidsKeys)

Parameters

parentKey TaggingHintKey

newKidsKeys ICollection<TaggingHintKey>

AddKidsHint(TaggingHintKey, ICollection<TaggingHintKey>, int)

public virtual void AddKidsHint(TaggingHintKey parentKey, ICollection<TaggingHintKey> newKidsKeys, int insertIndex)

Parameters

parentKey TaggingHintKey

newKidsKeys ICollection<TaggingHintKey>

insertIndex int

AddKidsHint<_T0>(TagTreePointer, IEnumerable<_T0>)

public virtual void AddKidsHint<_T0>(TagTreePointer parentPointer, IEnumerable<_T0> newKids) where _T0 : IPropertyContainer

Parameters

parentPointer TagTreePointer

newKids IEnumerable<_T0>

Type Parameters

_T0

AddKidsHint<_T0>(IPropertyContainer, IEnumerable<_T0>)

public virtual void AddKidsHint<_T0>(IPropertyContainer parent, IEnumerable<_T0> newKids) where _T0 : IPropertyContainer

Parameters

parent IPropertyContainer

newKids IEnumerable<_T0>

Type Parameters

_T0

AddKidsHint<_T0>(IPropertyContainer, IEnumerable<_T0>, int)

public virtual void AddKidsHint<_T0>(IPropertyContainer parent, IEnumerable<_T0> newKids, int insertIndex) where _T0 : IPropertyContainer

Parameters

parent IPropertyContainer

newKids IEnumerable<_T0>

insertIndex int

Type Parameters

_T0

AddTreeHints(LayoutTaggingHelper, IRenderer)

public static void AddTreeHints(LayoutTaggingHelper taggingHelper, IRenderer rootRenderer)

Parameters

taggingHelper LayoutTaggingHelper

rootRenderer IRenderer

CreateTag(IRenderer, TagTreePointer)

public virtual bool CreateTag(IRenderer renderer, TagTreePointer tagPointer)

Parameters

renderer IRenderer

tagPointer TagTreePointer

Returns

bool

CreateTag(TaggingHintKey, TagTreePointer)

public virtual bool CreateTag(TaggingHintKey hintKey, TagTreePointer tagPointer)

Parameters

hintKey TaggingHintKey

tagPointer TagTreePointer

Returns

bool

FinishTaggingHint(IPropertyContainer)

public virtual void FinishTaggingHint(IPropertyContainer hintOwner)

Parameters

hintOwner IPropertyContainer

GetAccessibleKidsHint(TaggingHintKey)

public virtual IList<TaggingHintKey> GetAccessibleKidsHint(TaggingHintKey parent)

Parameters

parent TaggingHintKey

Returns

IList<TaggingHintKey>

GetAccessibleParentHint(TaggingHintKey)

public virtual TaggingHintKey GetAccessibleParentHint(TaggingHintKey hintKey)

Parameters

hintKey TaggingHintKey

Returns

TaggingHintKey

GetHintKey(IPropertyContainer)

public static TaggingHintKey GetHintKey(IPropertyContainer container)

Parameters

container IPropertyContainer

Returns

TaggingHintKey

GetKidsHint(TaggingHintKey)

public virtual IList<TaggingHintKey> GetKidsHint(TaggingHintKey parent)

Parameters

parent TaggingHintKey

Returns

IList<TaggingHintKey>

GetOrCreateHintKey(IPropertyContainer)

public static TaggingHintKey GetOrCreateHintKey(IPropertyContainer container)

Parameters

container IPropertyContainer

Returns

TaggingHintKey

GetParentHint(IPropertyContainer)

public virtual TaggingHintKey GetParentHint(IPropertyContainer hintOwner)

Parameters

hintOwner IPropertyContainer

Returns

TaggingHintKey

GetParentHint(TaggingHintKey)

public virtual TaggingHintKey GetParentHint(TaggingHintKey hintKey)

Parameters

hintKey TaggingHintKey

Returns

TaggingHintKey

GetPdfDocument()

public virtual PdfDocument GetPdfDocument()

Returns

PdfDocument

IsArtifact(IPropertyContainer)

public virtual bool IsArtifact(IPropertyContainer hintOwner)

Parameters

hintOwner IPropertyContainer

Returns

bool

MarkArtifactHint(IPropertyContainer)

public virtual void MarkArtifactHint(IPropertyContainer hintOwner)

Parameters

hintOwner IPropertyContainer

MarkArtifactHint(TaggingHintKey)

public virtual void MarkArtifactHint(TaggingHintKey hintKey)

Parameters

hintKey TaggingHintKey

MoveKidHint(TaggingHintKey, TaggingHintKey)

public virtual int MoveKidHint(TaggingHintKey hintKeyOfKidToMove, TaggingHintKey newParent)

Parameters

hintKeyOfKidToMove TaggingHintKey

newParent TaggingHintKey

Returns

int

MoveKidHint(TaggingHintKey, TaggingHintKey, int)

public virtual int MoveKidHint(TaggingHintKey hintKeyOfKidToMove, TaggingHintKey newParent, int insertIndex)

Parameters

hintKeyOfKidToMove TaggingHintKey

newParent TaggingHintKey

insertIndex int

Returns

int

ReleaseAllHints()

public virtual void ReleaseAllHints()

ReleaseFinishedHints()

public virtual void ReleaseFinishedHints()

ReplaceKidHint(TaggingHintKey, ICollection<TaggingHintKey>)

public virtual int ReplaceKidHint(TaggingHintKey kidHintKey, ICollection<TaggingHintKey> newKidsHintKeys)

Parameters

kidHintKey TaggingHintKey

newKidsHintKeys ICollection<TaggingHintKey>

Returns

int

RestoreAutoTaggingPointerPosition(IRenderer)

public virtual void RestoreAutoTaggingPointerPosition(IRenderer renderer)

Parameters

renderer IRenderer

SetRoleHint(IPropertyContainer, string)

public virtual void SetRoleHint(IPropertyContainer hintOwner, string role)

Parameters

hintOwner IPropertyContainer

role string

UseAutoTaggingPointerAndRememberItsPosition(IRenderer)

public virtual TagTreePointer UseAutoTaggingPointerAndRememberItsPosition(IRenderer renderer)

Parameters

renderer IRenderer

Returns

TagTreePointer