pdfHTML 5.0.3 API
iText.Html2pdf.ConverterProperties Class Reference

Properties that will be used by the HtmlConverter. More...

Public Member Functions

  ConverterProperties ()
  Instantiates a new ConverterProperties instance. More...
 
  ConverterProperties (iText.Html2pdf.ConverterProperties other)
  Instantiates a new ConverterProperties instance based on another ConverterProperties instance (copy constructor). More...
 
virtual MediaDeviceDescription  GetMediaDeviceDescription ()
  Gets the media device description. More...
 
virtual iText.Html2pdf.ConverterProperties  SetMediaDeviceDescription (MediaDeviceDescription mediaDeviceDescription)
  Sets the media device description. More...
 
virtual FontProvider  GetFontProvider ()
  Gets the font provider. More...
 
virtual iText.Html2pdf.ConverterProperties  SetFontProvider (FontProvider fontProvider)
  Sets the font provider. More...
 
virtual int  GetLimitOfLayouts ()
  Gets maximum number of layouts. More...
 
virtual iText.Html2pdf.ConverterProperties  SetLimitOfLayouts (int limitOfLayouts)
  Sets maximum number of layouts. More...
 
virtual ITagWorkerFactory  GetTagWorkerFactory ()
  Gets the TagWorkerFactory instance. More...
 
virtual iText.Html2pdf.ConverterProperties  SetTagWorkerFactory (ITagWorkerFactory tagWorkerFactory)
  Sets the TagWorkerFactory. More...
 
virtual ICssApplierFactory  GetCssApplierFactory ()
  Gets the CSS applier factory. More...
 
virtual iText.Html2pdf.ConverterProperties  SetCssApplierFactory (ICssApplierFactory cssApplierFactory)
  Sets the CSS applier factory. More...
 
virtual String  GetBaseUri ()
  Gets the base URI. More...
 
virtual iText.Html2pdf.ConverterProperties  SetBaseUri (String baseUri)
  Sets the base URI. More...
 
virtual IResourceRetriever  GetResourceRetriever ()
  Gets the resource retriever. More...
 
virtual iText.Html2pdf.ConverterProperties  SetResourceRetriever (IResourceRetriever resourceRetriever)
  Sets the resource retriever. More...
 
virtual bool  IsCreateAcroForm ()
  Check if the createAcroForm flag is set. More...
 
virtual iText.Html2pdf.ConverterProperties  SetCreateAcroForm (bool createAcroForm)
  Sets the createAcroForm value. More...
 
virtual OutlineHandler  GetOutlineHandler ()
  Gets the outline handler. More...
 
virtual iText.Html2pdf.ConverterProperties  SetOutlineHandler (OutlineHandler outlineHandler)
  Sets the outline handler. More...
 
virtual String  GetCharset ()
  Gets the encoding charset. More...
 
virtual iText.Html2pdf.ConverterProperties  SetCharset (String charset)
  Sets the encoding charset. More...
 
virtual iText.Html2pdf.ConverterProperties  SetDocumentOutputIntent (PdfOutputIntent outputIntent)
  Sets pdf document output intent (final destination device) to reproduce the color in the PDF. More...
 
virtual iText.Html2pdf.ConverterProperties  SetPdfAConformanceLevel (PdfAConformanceLevel conformanceLevel)
  Sets the generation and strictness level of the PDF/A that must be followed. More...
 
virtual PdfOutputIntent  GetDocumentOutputIntent ()
  Gets pdf document output intent (final destination device) to reproduce the color in the PDF. More...
 
virtual PdfAConformanceLevel  GetConformanceLevel ()
  Gets the generation and strictness level of the PDF/A that must be followed. More...
 
virtual bool  IsImmediateFlush ()
  Checks if immediateFlush is set. More...
 
virtual iText.Html2pdf.ConverterProperties  SetImmediateFlush (bool immediateFlush)
  Set the immediate flush property of the layout document. More...
 
virtual iText.Html2pdf.ConverterProperties  SetEventMetaInfo (IMetaInfo metaInfo)
  Sets html meta info. More...
 
virtual bool  IsContinuousContainerEnabled ()
  check if continuous container is enabled. More...
 
virtual iText.Html2pdf.ConverterProperties  SetContinuousContainerEnabled (bool value)
  Sets continuous container support. More...
 

Detailed Description

Properties that will be used by the HtmlConverter.

Constructor & Destructor Documentation

◆ ConverterProperties() [1/2]

iText.Html2pdf.ConverterProperties.ConverterProperties ( )
inline

Instantiates a new ConverterProperties instance.

◆ ConverterProperties() [2/2]

iText.Html2pdf.ConverterProperties.ConverterProperties ( iText.Html2pdf.ConverterProperties  other )
inline

Instantiates a new ConverterProperties instance based on another ConverterProperties instance (copy constructor).

Parameters
other the other ConverterProperties instance

Member Function Documentation

◆ GetBaseUri()

virtual String iText.Html2pdf.ConverterProperties.GetBaseUri ( )
inlinevirtual

Gets the base URI.

Gets the base URI.

Base URI is used to resolve other URI.

Returns
the base URI

◆ GetCharset()

virtual String iText.Html2pdf.ConverterProperties.GetCharset ( )
inlinevirtual

Gets the encoding charset.

Gets the encoding charset.

Charset is used to correctly decode an HTML file.

Returns
the charset

◆ GetConformanceLevel()

virtual PdfAConformanceLevel iText.Html2pdf.ConverterProperties.GetConformanceLevel ( )
inlinevirtual

Gets the generation and strictness level of the PDF/A that must be followed.

Returns
pdf/a conformance level

◆ GetCssApplierFactory()

virtual ICssApplierFactory iText.Html2pdf.ConverterProperties.GetCssApplierFactory ( )
inlinevirtual

Gets the CSS applier factory.

Gets the CSS applier factory.

The cssApplierFactory is used to create iText.Html2pdf.Css.Apply.ICssApplier , which in turn are used to convert the CSS properties to the PDF properties.

Returns
the CSS applier factory

◆ GetDocumentOutputIntent()

virtual PdfOutputIntent iText.Html2pdf.ConverterProperties.GetDocumentOutputIntent ( )
inlinevirtual

Gets pdf document output intent (final destination device) to reproduce the color in the PDF.

Gets pdf document output intent (final destination device) to reproduce the color in the PDF.

Note, output intent isn't applicable for HtmlConverter::convertToElements methods (e.g. HtmlConverter.ConvertToElements(System.IO.Stream, ConverterProperties) )

Returns
pdf output intent

◆ GetFontProvider()

virtual FontProvider iText.Html2pdf.ConverterProperties.GetFontProvider ( )
inlinevirtual

Gets the font provider.

Gets the font provider.

Please note that iText.Layout.Font.FontProvider instances cannot be reused across several documents and thus as soon as you set this property, this ConverterProperties instance becomes only useful for a single HTML conversion.

Returns
the font provider

◆ GetLimitOfLayouts()

virtual int iText.Html2pdf.ConverterProperties.GetLimitOfLayouts ( )
inlinevirtual

Gets maximum number of layouts.

Returns
layouts limit

◆ GetMediaDeviceDescription()

virtual MediaDeviceDescription iText.Html2pdf.ConverterProperties.GetMediaDeviceDescription ( )
inlinevirtual

Gets the media device description.

Gets the media device description.

The properties of the multimedia device are taken into account when creating the SVG and when processing the properties of the СSS.

Returns
the media device description

◆ GetOutlineHandler()

virtual OutlineHandler iText.Html2pdf.ConverterProperties.GetOutlineHandler ( )
inlinevirtual

Gets the outline handler.

Gets the outline handler.

If outlineHandler is specified, then outlines will be created in the PDF for HTML tags specified in outlineHandler.

Please note that iText.Html2pdf.Attach.Impl.OutlineHandler is not thread safe, thus as soon as you have set this property, this ConverterProperties instance cannot be used in converting multiple HTMLs simultaneously.

Returns
the outline handler

◆ GetResourceRetriever()

virtual IResourceRetriever iText.Html2pdf.ConverterProperties.GetResourceRetriever ( )
inlinevirtual

Gets the resource retriever.

Gets the resource retriever.

The resourceRetriever is used to retrieve data from resources by URL.

Returns
the resource retriever

◆ GetTagWorkerFactory()

virtual ITagWorkerFactory iText.Html2pdf.ConverterProperties.GetTagWorkerFactory ( )
inlinevirtual

Gets the TagWorkerFactory instance.

Gets the TagWorkerFactory instance.

The tagWorkerFactory is used to create iText.Html2pdf.Attach.ITagWorker , which in turn are used to convert the HTML tags to the PDF elements.

Returns
the TagWorkerFactory

◆ IsContinuousContainerEnabled()

virtual bool iText.Html2pdf.ConverterProperties.IsContinuousContainerEnabled ( )
inlinevirtual

check if continuous container is enabled.

Returns
true if enabled, false otherwise

◆ IsCreateAcroForm()

virtual bool iText.Html2pdf.ConverterProperties.IsCreateAcroForm ( )
inlinevirtual

Check if the createAcroForm flag is set.

Check if the createAcroForm flag is set.

If createAcroForm is set, then when the form is encountered in HTML, AcroForm will be created, otherwise a visually identical, but not functional element will be created. Please bare in mind that the created Acroform may visually differ a bit from the HTML one.

Returns
the createAcroForm flag

◆ IsImmediateFlush()

virtual bool iText.Html2pdf.ConverterProperties.IsImmediateFlush ( )
inlinevirtual

Checks if immediateFlush is set.

Checks if immediateFlush is set.

This is used for HtmlConverter.ConvertToDocument(System.String, iText.Kernel.Pdf.PdfWriter) methods and will be overwritten to false if a page-counter declaration is present in the CSS of the HTML being converted. Has no effect when used in conjunction with HtmlConverter.ConvertToPdf(System.String, System.IO.Stream) or HtmlConverter.ConvertToElements(System.String).

Returns
true if immediateFlush is set, false if not

◆ SetBaseUri()

virtual iText.Html2pdf.ConverterProperties iText.Html2pdf.ConverterProperties.SetBaseUri ( String  baseUri )
inlinevirtual

Sets the base URI.

Sets the base URI.

Base URI is used to resolve other URI.

Parameters
baseUri the base URI
Returns
the ConverterProperties instance

◆ SetCharset()

virtual iText.Html2pdf.ConverterProperties iText.Html2pdf.ConverterProperties.SetCharset ( String  charset )
inlinevirtual

Sets the encoding charset.

Sets the encoding charset.

Charset is used to correctly decode an HTML file.

Parameters
charset the charset
Returns
the ConverterProperties instance

◆ SetContinuousContainerEnabled()

virtual iText.Html2pdf.ConverterProperties iText.Html2pdf.ConverterProperties.SetContinuousContainerEnabled ( bool  value )
inlinevirtual

Sets continuous container support.

Parameters
value true to set continuous container, false otherwise
Returns
the ConverterProperties instance

◆ SetCreateAcroForm()

virtual iText.Html2pdf.ConverterProperties iText.Html2pdf.ConverterProperties.SetCreateAcroForm ( bool  createAcroForm )
inlinevirtual

Sets the createAcroForm value.

Sets the createAcroForm value.

If createAcroForm is set, then when the form is encountered in HTML, AcroForm will be created, otherwise a visually identical, but not functional element will be created. Please bare in mind that the created Acroform may visually differ a bit from the HTML one.

When enabling this acroform creation, it will disable the immediateFlushing property.

Parameters
createAcroForm true if an AcroForm needs to be created
Returns
the ConverterProperties instance

◆ SetCssApplierFactory()

virtual iText.Html2pdf.ConverterProperties iText.Html2pdf.ConverterProperties.SetCssApplierFactory ( ICssApplierFactory  cssApplierFactory )
inlinevirtual

Sets the CSS applier factory.

Sets the CSS applier factory.

The cssApplierFactory is used to create iText.Html2pdf.Css.Apply.ICssApplier , which in turn are used to convert the CSS properties to the PDF properties.

Parameters
cssApplierFactory the CSS applier factory
Returns
the ConverterProperties instance

◆ SetDocumentOutputIntent()

virtual iText.Html2pdf.ConverterProperties iText.Html2pdf.ConverterProperties.SetDocumentOutputIntent ( PdfOutputIntent  outputIntent )
inlinevirtual

Sets pdf document output intent (final destination device) to reproduce the color in the PDF.

Sets pdf document output intent (final destination device) to reproduce the color in the PDF. Required parameter, when converting to pdf/a one have to specify an explicit output intent.

Note, output intent isn't applicable for HtmlConverter::convertToElements methods (e.g. HtmlConverter.ConvertToElements(System.IO.Stream, ConverterProperties) )

Parameters
outputIntent a iText.Kernel.Pdf.PdfOutputIntent instance
Returns
the ConverterProperties instance

◆ SetEventMetaInfo()

virtual iText.Html2pdf.ConverterProperties iText.Html2pdf.ConverterProperties.SetEventMetaInfo ( IMetaInfo  metaInfo )
inlinevirtual

Sets html meta info.

Sets html meta info.

This meta info will be used to determine event origin.

Parameters
metaInfo meta info to set
Returns
the ConverterProperties instance

◆ SetFontProvider()

virtual iText.Html2pdf.ConverterProperties iText.Html2pdf.ConverterProperties.SetFontProvider ( FontProvider  fontProvider )
inlinevirtual

Sets the font provider.

Sets the font provider.

Please note that iText.Layout.Font.FontProvider instances cannot be reused across several documents and thus as soon as you set this property, this ConverterProperties instance becomes only useful for a single HTML conversion.

Parameters
fontProvider the font provider
Returns
the ConverterProperties instance

◆ SetImmediateFlush()

virtual iText.Html2pdf.ConverterProperties iText.Html2pdf.ConverterProperties.SetImmediateFlush ( bool  immediateFlush )
inlinevirtual

Set the immediate flush property of the layout document.

Set the immediate flush property of the layout document.

This is used for HtmlConverter.ConvertToDocument(System.String, iText.Kernel.Pdf.PdfWriter) methods and will be overwritten to false if a page-counter declaration is present in the CSS of the HTML being converted. Has no effect when used in conjunction with HtmlConverter.ConvertToPdf(System.String, System.IO.Stream) or HtmlConverter.ConvertToElements(System.String).

Parameters
immediateFlush the immediate flush value
Returns
the ConverterProperties instance

◆ SetLimitOfLayouts()

virtual iText.Html2pdf.ConverterProperties iText.Html2pdf.ConverterProperties.SetLimitOfLayouts ( int  limitOfLayouts )
inlinevirtual

Sets maximum number of layouts.

Parameters
limitOfLayouts layouts limit
Returns
the ConverterProperties instance

◆ SetMediaDeviceDescription()

virtual iText.Html2pdf.ConverterProperties iText.Html2pdf.ConverterProperties.SetMediaDeviceDescription ( MediaDeviceDescription  mediaDeviceDescription )
inlinevirtual

Sets the media device description.

Sets the media device description.

The properties of the multimedia device are taken into account when creating the SVG and when processing the properties of the СSS.

Parameters
mediaDeviceDescription the media device description
Returns
the ConverterProperties instance

◆ SetOutlineHandler()

virtual iText.Html2pdf.ConverterProperties iText.Html2pdf.ConverterProperties.SetOutlineHandler ( OutlineHandler  outlineHandler )
inlinevirtual

Sets the outline handler.

Sets the outline handler.

If outlineHandler is specified, then outlines will be created in the PDF for HTML tags specified in outlineHandler.

Please note that iText.Html2pdf.Attach.Impl.OutlineHandler is not thread safe, thus as soon as you have set this property, this ConverterProperties instance cannot be used in converting multiple HTMLs simultaneously.

Parameters
outlineHandler the outline handler
Returns
the ConverterProperties instance

◆ SetPdfAConformanceLevel()

virtual iText.Html2pdf.ConverterProperties iText.Html2pdf.ConverterProperties.SetPdfAConformanceLevel ( PdfAConformanceLevel  conformanceLevel )
inlinevirtual

Sets the generation and strictness level of the PDF/A that must be followed.

Sets the generation and strictness level of the PDF/A that must be followed. Required parameter, when converting to pdf/a one have to specify an explicit pdf/a conformance level.

Parameters
conformanceLevel a iText.Kernel.Pdf.PdfAConformanceLevel constant
Returns
the ConverterProperties instance

◆ SetResourceRetriever()

virtual iText.Html2pdf.ConverterProperties iText.Html2pdf.ConverterProperties.SetResourceRetriever ( IResourceRetriever  resourceRetriever )
inlinevirtual

Sets the resource retriever.

Sets the resource retriever.

The resourceRetriever is used to retrieve data from resources by URL.

Parameters
resourceRetriever the resource retriever
Returns
the ConverterProperties instance

◆ SetTagWorkerFactory()

virtual iText.Html2pdf.ConverterProperties iText.Html2pdf.ConverterProperties.SetTagWorkerFactory ( ITagWorkerFactory  tagWorkerFactory )
inlinevirtual

Sets the TagWorkerFactory.

Sets the TagWorkerFactory.

The tagWorkerFactory is used to create iText.Html2pdf.Attach.ITagWorker , which in turn are used to convert the HTML tags to the PDF elements.

Parameters
tagWorkerFactory the TagWorkerFactory
Returns
the ConverterProperties instance