pdfHTML 5.0.3 API
Public Member Functions | Static Public Member Functions | List of all members
iText.Html2pdf.Attach.Impl.OutlineHandler Class Reference

A OutlineHandler handles creating outlines for tags. More...

Public Member Functions
virtual OutlineHandler  PutTagPriorityMapping (String tagName, int? priority)
  Put tag priority mapping. More...
 
virtual OutlineHandler  PutAllTagPriorityMappings (IDictionary< String, int?> mappings)
  Put all tag priority mappings. More...
 
virtual ? int  GetTagPriorityMapping (String tagName)
  Gets the tag priority mapping. More...
 
virtual bool  HasTagPriorityMapping (String tagName)
  Checks for tag priority mapping. More...
 
virtual void  Reset ()
  Resets the current state so that this OutlineHandler is ready to process new document More...
 
virtual void  SetDestinationNamePrefix (String destinationNamePrefix)
  Sets the destination name prefix. More...
 
virtual String  GetDestinationNamePrefix ()
  Gets the destination name prefix. More...
 

Static Public Member Functions
static OutlineHandler  CreateStandardHandler ()
  Creates an OutlineHandler with standard predefined mappings. More...
 

Detailed Description

A OutlineHandler handles creating outlines for tags.

A OutlineHandler handles creating outlines for tags.

This class is not reusable and a new instance shall be created for every new conversion process.

Member Function Documentation

◆ CreateStandardHandler()

static OutlineHandler iText.Html2pdf.Attach.Impl.OutlineHandler.CreateStandardHandler ( )
inlinestatic

Creates an OutlineHandler with standard predefined mappings.

Returns
the outline handler

◆ GetDestinationNamePrefix()

virtual String iText.Html2pdf.Attach.Impl.OutlineHandler.GetDestinationNamePrefix ( )
inlinevirtual

Gets the destination name prefix.

Gets the destination name prefix. The destination name prefix serves as the prefix for the destination names created in the GenerateUniqueDestinationName(iText.StyledXmlParser.Node.IElementNode) method.

Returns
the destination name prefix

◆ GetTagPriorityMapping()

virtual ? int iText.Html2pdf.Attach.Impl.OutlineHandler.GetTagPriorityMapping ( String  tagName )
inlinevirtual

Gets the tag priority mapping.

Parameters
tagName the tag name
Returns
the tag priority mapping

◆ HasTagPriorityMapping()

virtual bool iText.Html2pdf.Attach.Impl.OutlineHandler.HasTagPriorityMapping ( String  tagName )
inlinevirtual

Checks for tag priority mapping.

Parameters
tagName the tag name
Returns
true, if the tag name is listed in the tag priorities mapping

◆ PutAllTagPriorityMappings()

virtual OutlineHandler iText.Html2pdf.Attach.Impl.OutlineHandler.PutAllTagPriorityMappings ( IDictionary< String, int?>  mappings )
inlinevirtual

Put all tag priority mappings.

Parameters
mappings the mappings
Returns
the outline handler

◆ PutTagPriorityMapping()

virtual OutlineHandler iText.Html2pdf.Attach.Impl.OutlineHandler.PutTagPriorityMapping ( String  tagName,
int?  priority 
)
inlinevirtual

Put tag priority mapping.

Parameters
tagName the tag name
priority the priority
Returns
the outline handler

◆ Reset()

virtual void iText.Html2pdf.Attach.Impl.OutlineHandler.Reset ( )
inlinevirtual

Resets the current state so that this OutlineHandler is ready to process new document

◆ SetDestinationNamePrefix()

virtual void iText.Html2pdf.Attach.Impl.OutlineHandler.SetDestinationNamePrefix ( String  destinationNamePrefix )
inlinevirtual

Sets the destination name prefix.

Sets the destination name prefix. The destination name prefix serves as the prefix for the destination names created in the GenerateUniqueDestinationName(iText.StyledXmlParser.Node.IElementNode) method.

Parameters
destinationNamePrefix the destination name prefix