pdfHTML 2.1.6 API
iText.Html2pdf.ConverterProperties Class Reference

Properties that will be used by the converter. 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 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 bool IsCreateAcroForm ()
 Checks if is an AcroForm needs to be created. 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 bool IsImmediateFlush ()
 Checks if immediateFlush is set More...
 
virtual iText.Html2pdf.ConverterProperties SetImmediateFlush (bool immediateFlush)
 set the immediate flush property of the layout document This is used for convertToDocument methods and will be overwritten to false if a page-counter declaration is present in the CSS of the HTML being converted. More...
 
virtual IMetaInfo GetEventCountingMetaInfo ()
 Gets html meta info. More...
 
virtual iText.Html2pdf.ConverterProperties SetEventCountingMetaInfo (IMetaInfo metaInfo)
 Sets html meta info. More...
 

Detailed Description

Properties that will be used by the converter.

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
otherthe other ConverterProperties instance

Member Function Documentation

◆ GetBaseUri()

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

Gets the base URI.

Returns
the base URI

◆ GetCharset()

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

Gets the encoding charset.

Returns
the charset

◆ GetCssApplierFactory()

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

Gets the CSS applier factory.

Returns
the CSS applier factory

◆ GetEventCountingMetaInfo()

virtual IMetaInfo iText.Html2pdf.ConverterProperties.GetEventCountingMetaInfo ( )
inlinevirtual

Gets html meta info.

Gets html meta info. This meta info will be passed with to iText.Kernel.Counter.EventCounter with iText.Html2pdf.Events.PdfHtmlEvent and can be used to determine event origin.

Returns
converter's iText.Kernel.Counter.Event.IMetaInfo

◆ GetFontProvider()

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

Gets the font provider.

Returns
the font provider

◆ GetMediaDeviceDescription()

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

Gets the media device description.

Returns
the media device description

◆ GetOutlineHandler()

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

Gets the outline handler.

Returns
the outline handler

◆ GetTagWorkerFactory()

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

Gets the TagWorkerFactory instance.

Returns
the TagWorkerFactory

◆ IsCreateAcroForm()

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

Checks if is an AcroForm needs to be created.

Returns
true, an AcroForm should be created

◆ IsImmediateFlush()

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

Checks if immediateFlush is set

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.

Parameters
baseUrithe base URI
Returns
the ConverterProperties instance

◆ SetCharset()

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

Sets the encoding charset.

Parameters
charsetthe charset
Returns
the ConverterProperties instance

◆ SetCreateAcroForm()

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

Sets the createAcroForm value.

Parameters
createAcroFormtrue 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.

Parameters
cssApplierFactorythe CSS applier factory
Returns
the ConverterProperties instance

◆ SetEventCountingMetaInfo()

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

Sets html meta info.

Sets html meta info. This meta info will be passed with to iText.Kernel.Counter.EventCounter with iText.Html2pdf.Events.PdfHtmlEvent and can be used to determine event origin.

Parameters
metaInfometa info to set
Returns
this 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
fontProviderthe 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 This is used for convertToDocument methods and will be overwritten to false if a page-counter declaration is present in the CSS of the HTML being converted.

set the immediate flush property of the layout document This is used for convertToDocument 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 convertToPdf or convertToElements

Parameters
immediateFlushthe immediate flush value
Returns
the ConverterProperties

◆ SetMediaDeviceDescription()

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

Sets the media device description.

Parameters
mediaDeviceDescriptionthe 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. 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
outlineHandlerthe outline handler
Returns
the ConverterProperties instance

◆ SetTagWorkerFactory()

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

Sets the TagWorkerFactory.

Parameters
tagWorkerFactorythe TagWorkerFactory
Returns
the ConverterProperties instance