pdfHTML 5.0.5 API
|
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... |
|
Properties that will be used by the HtmlConverter.
|
inline |
Instantiates a new ConverterProperties instance.
|
inline |
Instantiates a new ConverterProperties instance based on another ConverterProperties instance (copy constructor).
other | the other ConverterProperties instance |
|
inlinevirtual |
Gets the base URI.
Gets the base URI.
Base URI is used to resolve other URI.
|
inlinevirtual |
Gets the encoding charset.
Gets the encoding charset.
Charset is used to correctly decode an HTML file.
|
inlinevirtual |
Gets the generation and strictness level of the PDF/A that must be followed.
|
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.
|
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) )
|
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.
|
inlinevirtual |
Gets maximum number of layouts.
|
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.
|
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.
|
inlinevirtual |
Gets the resource retriever.
Gets the resource retriever.
The resourceRetriever is used to retrieve data from resources by URL.
|
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.
|
inlinevirtual |
check if continuous container is enabled.
|
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.
|
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).
|
inlinevirtual |
Sets the base URI.
Sets the base URI.
Base URI is used to resolve other URI.
baseUri | the base URI |
|
inlinevirtual |
Sets the encoding charset.
Sets the encoding charset.
Charset is used to correctly decode an HTML file.
charset | the charset |
|
inlinevirtual |
Sets continuous container support.
value | true to set continuous container, false otherwise |
|
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.
createAcroForm | true if an AcroForm needs to be created |
|
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.
cssApplierFactory | the CSS applier factory |
|
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) )
outputIntent | a iText.Kernel.Pdf.PdfOutputIntent instance |
|
inlinevirtual |
Sets html meta info.
Sets html meta info.
This meta info will be used to determine event origin.
metaInfo | meta info to set |
|
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.
fontProvider | the font provider |
|
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).
immediateFlush | the immediate flush value |
|
inlinevirtual |
Sets maximum number of layouts.
limitOfLayouts | layouts limit |
|
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.
mediaDeviceDescription | the media device description |
|
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.
outlineHandler | the outline handler |
|
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.
conformanceLevel | a iText.Kernel.Pdf.PdfAConformanceLevel constant |
|
inlinevirtual |
Sets the resource retriever.
Sets the resource retriever.
The resourceRetriever is used to retrieve data from resources by URL.
resourceRetriever | the resource retriever |
|
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.
tagWorkerFactory | the TagWorkerFactory |