Save options for export to Html format More...
#include "HtmlSaveOptions.h"
Inherits Aspose::Pdf::UnifiedSaveOptions, Aspose::Pdf::IPageSetOptions, and Aspose::Pdf::IPipelineOptions.
Classes | |
| class | CssSavingInfo |
| This class represents set of data that related to custom saving of CSS during conversion of PDF to HTML format More... | |
| class | CssUrlRequestInfo |
| Represents set of data that related to request from converter to custom code aimed to get desirable URL (or URL template)of subject CSS More... | |
| class | HtmlImageSavingInfo |
| This class represents set of data that related to external resource image file's saving during PDF to HTML conversion. More... | |
| class | HtmlPageMarkupSavingInfo |
| If SplitToPages property of HtmlSaveOptions, then several HTML-files (one HTML file per converted page) are created during conversion of PDF to HTML. This class represents set of data that related to custom saving of one HTML-page's markup during conversion of PDF to HTML More... | |
Public Types | |
| enum | FontSavingModes { FontSavingModes::AlwaysSaveAsWOFF = 0, FontSavingModes::AlwaysSaveAsTTF = 1, FontSavingModes::AlwaysSaveAsEOT = 2, FontSavingModes::SaveInAllFormats = 3, FontSavingModes::DontSave = 4 } |
| Enumerates modes that can be used for saving of fonts referenced in saved PDF. More... | |
| enum | AntialiasingProcessingType { AntialiasingProcessingType::NoAdditionalProcessing, AntialiasingProcessingType::TryCorrectResultHtml } |
| This enum describes possible antialiasing measures during conversion More... | |
| enum | LettersPositioningMethods { LettersPositioningMethods::UseEmUnitsAndCompensationOfRoundingErrorsInCss, LettersPositioningMethods::UsePixelUnitsInCssLetterSpacingForIE } |
| It enumerates possible modes of positioning of letters in words in result HTML More... | |
| enum | HtmlImageType { HtmlImageType::Jpeg = 0, HtmlImageType::Png = 1, HtmlImageType::Bmp = 2, HtmlImageType::Gif = 3, HtmlImageType::Tiff = 4, HtmlImageType::Svg = 5, HtmlImageType::ZippedSvg = 6, HtmlImageType::Unknown = 7 } |
| enumerates possible types of image files that can be saved as external resources during Pdf to Html conversion More... | |
| enum | ImageParentTypes { ImageParentTypes::HtmlPage = 0, ImageParentTypes::SvgImage = 1 } |
| Enumerates possible types of image's parents Image can pertain to HTML page or to SVG parent image More... | |
| enum | RasterImagesSavingModes { RasterImagesSavingModes::AsPngImagesEmbeddedIntoSvg, RasterImagesSavingModes::AsExternalPngFilesReferencedViaSvg, RasterImagesSavingModes::AsEmbeddedPartsOfPngPageBackground } |
| Converted PDF can contain raster images(.png, *.jpeg etc.) This enum defines methods of how raster images can be handled during conversion of PDF to HTML More... | |
| enum | HtmlMarkupGenerationModes { HtmlMarkupGenerationModes::WriteAllHtml, HtmlMarkupGenerationModes::WriteOnlyBodyContent } |
| Sometimes specific reqirments to created HTML are present. This enum defines HTML preparing modes that can be used during conversion of PDF to HTML to match such specific requirments. More... | |
| enum | PartsEmbeddingModes { PartsEmbeddingModes::EmbedAllIntoHtml, PartsEmbeddingModes::EmbedCssOnly, PartsEmbeddingModes::NoEmbedding } |
| This enum enumerates possible modes of embedding of files referenced in HTML It allows to control whether referenced files (HTML, Fonts,Images, CSSes) will be embedded into main HTML file or will be generated as apart binary entities More... | |
| enum | FontEncodingRules : uint8_t { FontEncodingRules::Default, FontEncodingRules::DecreaseToUnicodePriorityLevel } |
| This enumeration defines rules which tune encoding logic More... | |
| using | ResourceSavingStrategy = System::MulticastDelegate< System::String(System::SharedPtr< SaveOptions::ResourceSavingInfo >)> |
| To this property You can assign delegate created from custom method that implements processing of external resource(Font or Image) that was extracted from PDF and must be saved as external resource during conversion of PDF to HTML. In such case processing (like saving in stream or disk) can be done in that custom code and that custom code must return path(or any another string without quotemarks) that will be afterwards incorporated into generated HTML instead of original supposed path to that image resource. In such case All the necessary actions for saving of image must be undertaken in code of supplied method, because saving of result in code of converter will be not in use . If processing for this or that file for some reason must be done by converter's code itself, not in custom code, please set in custom code flag 'CustomProcessingCancelled' of 'resourceSavingInfo' parameter's variable It signals to converter that all the necessary steps for processing of that resource must be done in converter itself as if there was no any external custom code . More... | |
| using | HtmlPageMarkupSavingStrategy = System::MulticastDelegate< void(System::SharedPtr< HtmlSaveOptions::HtmlPageMarkupSavingInfo >)> |
| using | CssSavingStrategy = System::MulticastDelegate< void(System::SharedPtr< HtmlSaveOptions::CssSavingInfo >)> |
| using | CssUrlMakingStrategy = System::MulticastDelegate< System::String(System::SharedPtr< HtmlSaveOptions::CssUrlRequestInfo >)> |
 Public Types inherited from Aspose::Pdf::UnifiedSaveOptions | |
| using | ConversionProgressEventHandler = System::MulticastDelegate< void(System::SharedPtr< UnifiedSaveOptions::ProgressEventHandlerInfo >)> |
| Public Types inherited from Aspose::Pdf::SaveOptions | |
| enum | HtmlBorderLineType { HtmlBorderLineType::None = 0, HtmlBorderLineType::Dotted = 1, HtmlBorderLineType::Dashed = 2, HtmlBorderLineType::Solid = 3, HtmlBorderLineType::Double = 4, HtmlBorderLineType::Groove = 5, HtmlBorderLineType::Ridge = 6, HtmlBorderLineType::Inset = 7, HtmlBorderLineType::Outset = 8 } |
| Represents line types that can be used in result document for drawing borders or another lines More... | |
| enum | NodeLevelResourceType { NodeLevelResourceType::Image = 0, NodeLevelResourceType::Font = 1 } |
| enumerates possible types of saved external resources More... | |
| Public Types inherited from System::Object | |
| typedef SmartPtr< Object > | ptr |
| Alias for smart pointer type. More... | |
Public Member Functions | |
| ASPOSE_PDF_SHARED_API HtmlDocumentType | get_DocumentType () const |
| Gets the HtmlDocumentType. More... | |
| ASPOSE_PDF_SHARED_API void | set_DocumentType (HtmlDocumentType value) |
| Sets the HtmlDocumentType. More... | |
| ASPOSE_PDF_SHARED_API bool | get_CompressSvgGraphicsIfAny () const |
| Gets the flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving More... | |
| ASPOSE_PDF_SHARED_API void | set_CompressSvgGraphicsIfAny (bool value) |
| Sets the flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving More... | |
| ASPOSE_PDF_SHARED_API bool | get_SplitCssIntoPages () const |
| When multipage-mode selected(i.e 'SplitIntoPages' is 'true'), then this attribute defines whether should be created separate CSS-file for each result HTML page. By default this attribute is false, so, will be created one big common CSS for all created pages. Summary size of all CSSes generated in this mode(one CSS per page) usually much more than size of one big CSS file, because in former case CSS classes are duplicates in such case in several CSS files for each page. So, this setting is worse to be used only when You are interested in future processing of each HTML page independently, and therefore size of CSS of each one page taken apart is the most critical issue. More... | |
| ASPOSE_PDF_SHARED_API void | set_SplitCssIntoPages (bool value) |
| When multipage-mode selected(i.e 'SplitIntoPages' is 'true'), then this attribute defines whether should be created separate CSS-file for each result HTML page. By default this attribute is false, so, will be created one big common CSS for all created pages. Summary size of all CSSes generated in this mode(one CSS per page) usually much more than size of one big CSS file, because in former case CSS classes are duplicates in such case in several CSS files for each page. So, this setting is worse to be used only when You are interested in future processing of each HTML page independently, and therefore size of CSS of each one page taken apart is the most critical issue. More... | |
| ASPOSE_PDF_SHARED_API bool | get_SplitIntoPages () const |
| Gets the flag that indicates whether each page of source document will be converted into it's own target HTML document, i.e whether result HTML will be splitted into several HTML-pages. More... | |
| ASPOSE_PDF_SHARED_API void | set_SplitIntoPages (bool value) |
| Sets the flag that indicates whether each page of source document will be converted into it's own target HTML document, i.e whether result HTML will be splitted into several HTML-pages. More... | |
| ASPOSE_PDF_SHARED_API System::ArrayPtr< int32_t > | get_ExplicitListOfSavedPages () override |
| With this property You can explicitely define what pages of document should be converted. Pages in this list must have 1-based numbers. I.e. valid numbers of pages must be taken from range (1...[NumberOfPagesInConvertedDocument]) Order of appearing of pages in this list does not affect their order in result HTML page(s) - in result pages allways will go in order in which they are present in source PDF. If this list is null (as it is by default), all pages will be converted. If any page number of this list will go out of range of present pages(1-[amountOfPagesInDocument]) exception will be thrown. More... | |
| ASPOSE_PDF_SHARED_API void | set_ExplicitListOfSavedPages (System::ArrayPtr< int32_t > value) override |
| With this property You can explicitely define what pages of document should be converted. Pages in this list must have 1-based numbers. I.e. valid numbers of pages must be taken from range (1...[NumberOfPagesInConvertedDocument]) Order of appearing of pages in this list does not affect their order in result HTML page(s) - in result pages allways will go in order in which they are present in source PDF. If this list is null (as it is by default), all pages will be converted. If any page number of this list will go out of range of present pages(1-[amountOfPagesInDocument]) exception will be thrown. More... | |
| ASPOSE_PDF_SHARED_API bool | get_FixedLayout () const |
| Gets a value indicating whether that HTML is created as fixed layout. More... | |
| ASPOSE_PDF_SHARED_API void | set_FixedLayout (bool value) |
| Sets a value indicating whether that HTML is created as fixed layout. More... | |
| ASPOSE_PDF_SHARED_API int32_t | get_ImageResolution () const |
| Gets resolution for image rendering. More... | |
| ASPOSE_PDF_SHARED_API void | set_ImageResolution (int32_t value) |
| Sets resolution for image rendering. More... | |
| ASPOSE_PDF_SHARED_API System::String | get_DefaultFontName () const |
| Specifies the name of an installed font which is used to substitute any document font that is not embedded and not installed in the system. If null then default substitution font is used. More... | |
| ASPOSE_PDF_SHARED_API void | set_DefaultFontName (System::String value) |
| Specifies the name of an installed font which is used to substitute any document font that is not embedded and not installed in the system. If null then default substitution font is used. More... | |
| ASPOSE_PDF_SHARED_API int32_t | get_BatchSize () override |
| Defines batch size if batched conversion is applicable to source and destination formats pair. More... | |
| ASPOSE_PDF_SHARED_API void | set_BatchSize (int32_t value) override |
| Defines batch size if batched conversion is applicable to source and destination formats pair. More... | |
| ASPOSE_PDF_SHARED_API System::SharedPtr< Text::FontSourceCollection > | get_FontSources () const |
| Font sources of pre-saved fonts. More... | |
| ASPOSE_PDF_SHARED_API int32_t | get_AdditionalMarginWidthInPoints () const |
| If attribute 'SplitOnPages=false', than whole HTML representing all input PDF pages wont be not split into different HTML pages, but will be put into one big result HTML file. But each source PDF page will be represented with it's own rectangle area in HTML (if necessary that areas can be bordered to show page paper edges with special attribute 'PageBorderIfAny'. This parameter defines width of margin that will be forcibly left around that output HTML-areas that represent pages of source PDF document.In essence it defines guaranteed interval between HTML-representations of PDF "paper" pages such mode of conversion. More... | |
| ASPOSE_PDF_SHARED_API void | set_AdditionalMarginWidthInPoints (int32_t value) |
| If attribute 'SplitOnPages=false', than whole HTML representing all input PDF pages wont be not split into different HTML pages, but will be put into one big result HTML file. But each source PDF page will be represented with it's own rectangle area in HTML (if necessary that areas can be bordered to show page paper edges with special attribute 'PageBorderIfAny'. This parameter defines width of margin that will be forcibly left around that output HTML-areas that represent pages of source PDF document.In essence it defines guaranteed interval between HTML-representations of PDF "paper" pages such mode of conversion. More... | |
| ASPOSE_PDF_SHARED_API bool | get_UseZOrder () const |
| If attribute UseZORder set to true, graphics and text are added to resultant HTML document accordingly Z-order in original PDF document. If this attribute is false all graphics is put as single layer which may cause some unnecessary effects for overlapped objects. More... | |
| ASPOSE_PDF_SHARED_API void | set_UseZOrder (bool value) |
| If attribute UseZORder set to true, graphics and text are added to resultant HTML document accordingly Z-order in original PDF document. If this attribute is false all graphics is put as single layer which may cause some unnecessary effects for overlapped objects. More... | |
| ASPOSE_PDF_SHARED_API bool | get_ConvertMarkedContentToLayers () const |
| If attribute ConvertMarkedContentToLayers set to true then an all elements inside a PDF marked content (layer) will be put into an HTML div with "data-pdflayer" attribute specifying a layer name. This layer name will be extracted from optional properties of PDF marked content. If this attribute is false (by default) then no any layers will be created from PDF marked content. More... | |
| ASPOSE_PDF_SHARED_API void | set_ConvertMarkedContentToLayers (bool value) |
| If attribute ConvertMarkedContentToLayers set to true then an all elements inside a PDF marked content (layer) will be put into an HTML div with "data-pdflayer" attribute specifying a layer name. This layer name will be extracted from optional properties of PDF marked content. If this attribute is false (by default) then no any layers will be created from PDF marked content. More... | |
| ASPOSE_PDF_SHARED_API float | get_MinimalLineWidth () const |
| This attribute sets minimal width of graphic path line. If thickness of line is less than 1px Adobe Acrobat rounds it to this value. So this attribute can be used to emulate this behavior for HTML browsers. More... | |
| ASPOSE_PDF_SHARED_API void | set_MinimalLineWidth (float value) |
| This attribute sets minimal width of graphic path line. If thickness of line is less than 1px Adobe Acrobat rounds it to this value. So this attribute can be used to emulate this behavior for HTML browsers. More... | |
| ASPOSE_PDF_SHARED_API bool | get_PreventGlyphsGrouping () const |
| This attribute switch on the mode when text glyphs will not be grouped into words and strings This mode allows to keep maximum precision during positioning of glyphs on the page and it can be used for conversion documents with music notes or glyphs that should be placed separately each other. This parameter will be applied to document only when the value of FixedLayout attribute is true. More... | |
| ASPOSE_PDF_SHARED_API void | set_PreventGlyphsGrouping (bool value) |
| This attribute switch on the mode when text glyphs will not be grouped into words and strings This mode allows to keep maximum precision during positioning of glyphs on the page and it can be used for conversion documents with music notes or glyphs that should be placed separately each other. This parameter will be applied to document only when the value of FixedLayout attribute is true. More... | |
| ASPOSE_PDF_SHARED_API bool | get_SimpleTextboxModeGrouping () const |
| This attribute specifies a sequential grouping of glyphs and words into strings For example tags and words has different order in converted HTML and you want them to match. This parameter will be applied to document only when the value of FixedLayout attribute is true. More... | |
| ASPOSE_PDF_SHARED_API void | set_SimpleTextboxModeGrouping (bool value) |
| This attribute specifies a sequential grouping of glyphs and words into strings For example tags and words has different order in converted HTML and you want them to match. This parameter will be applied to document only when the value of FixedLayout attribute is true. More... | |
| ASPOSE_PDF_SHARED_API bool | get_FlowLayoutParagraphFullWidth () const |
| This attribute specifies full width paragraph text for Flow mode, FixedLayout = false More... | |
| ASPOSE_PDF_SHARED_API void | set_FlowLayoutParagraphFullWidth (bool value) |
| This attribute specifies full width paragraph text for Flow mode, FixedLayout = false More... | |
| ASPOSE_PDF_SHARED_API bool | get_RenderTextAsImage () const |
| If attribute RenderTextAsImage set to true, the text from the source becomes an image in HTML. May be useful to make text unselectable or HTML text is not rendered properly. More... | |
| ASPOSE_PDF_SHARED_API void | set_RenderTextAsImage (bool value) |
| If attribute RenderTextAsImage set to true, the text from the source becomes an image in HTML. May be useful to make text unselectable or HTML text is not rendered properly. More... | |
| ASPOSE_PDF_SHARED_API System::String | get_Title () const |
| Gets HTML page title. More... | |
| ASPOSE_PDF_SHARED_API void | set_Title (System::String value) |
| Sets HTML page title. More... | |
| ASPOSE_PDF_SHARED_API | HtmlSaveOptions () |
| Initializes a new instance of the HtmlSaveOptions class. More... | |
| ASPOSE_PDF_SHARED_API | HtmlSaveOptions (HtmlDocumentType documentType) |
| Initializes a new instance of the HtmlSaveOptions class. More... | |
| ASPOSE_PDF_SHARED_API | HtmlSaveOptions (bool fixedLayout) |
| Initializes a new instance of the HtmlSaveOptions class. More... | |
| ASPOSE_PDF_SHARED_API | HtmlSaveOptions (HtmlDocumentType documentType, bool fixedLayout) |
| Initializes a new instance of the HtmlSaveOptions class. More... | |
| Public Member Functions inherited from Aspose::Pdf::UnifiedSaveOptions | |
| ASPOSE_PDF_SHARED_API bool | get_ExtractOcrSublayerOnly () const |
| This atrribute turned on functionality for extracting image or text for PDF documents with OCR sublayer. More... | |
| ASPOSE_PDF_SHARED_API void | set_ExtractOcrSublayerOnly (bool value) |
| This atrribute turned on functionality for extracting image or text for PDF documents with OCR sublayer. More... | |
| ASPOSE_PDF_SHARED_API | UnifiedSaveOptions () |
| Public Member Functions inherited from Aspose::Pdf::SaveOptions | |
| ASPOSE_PDF_SHARED_API System::SharedPtr< IWarningCallback > | get_WarningHandler () const |
| Callback to handle any warnings generated. The WarningHandler returns ReturnAction enum item specifying either Continue or Abort. Continue is the default action and the Save operation continues, however the user may also return Abort in which case the Save operation should cease. More... | |
| ASPOSE_PDF_SHARED_API void | set_WarningHandler (System::SharedPtr< IWarningCallback > value) |
| Callback to handle any warnings generated. The WarningHandler returns ReturnAction enum item specifying either Continue or Abort. Continue is the default action and the Save operation continues, however the user may also return Abort in which case the Save operation should cease. More... | |
| ASPOSE_PDF_SHARED_API Aspose::Pdf::SaveFormat | get_SaveFormat () const |
| Format of data save. More... | |
| ASPOSE_PDF_SHARED_API bool | get_CloseResponse () const |
| Gets boolean value which indicates will Response object be closed after document saved into response. More... | |
| ASPOSE_PDF_SHARED_API void | set_CloseResponse (bool value) |
| Sets boolean value which indicates will Response object be closed after document saved into response. More... | |
| ASPOSE_PDF_SHARED_API | SaveOptions () |
| Public Member Functions inherited from System::Object | |
| ASPOSECPP_SHARED_API | Object () |
| Creates object. Initializes all internal data structures. More... | |
| virtual ASPOSECPP_SHARED_API | ~Object () |
| Destroys object. Frees all internal data structures. More... | |
| ASPOSECPP_SHARED_API | Object (Object const &x) |
| Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More... | |
| Object & | operator= (Object const &x) |
| Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More... | |
| Object * | SharedRefAdded () |
| Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More... | |
| int | SharedRefRemovedSafe () |
| Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More... | |
| int | RemovedSharedRefs (int count) |
| Decreases shared reference count by specified value. More... | |
| Detail::SmartPtrCounter * | WeakRefAdded () |
| Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More... | |
| void | WeakRefRemoved () |
| Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More... | |
| Detail::SmartPtrCounter * | GetCounter () |
| Gets reference counter data structure associated with the object. More... | |
| int | SharedCount () const |
| Gets current value of shared reference counter. More... | |
| ASPOSECPP_SHARED_API void | Lock () |
| Implements C# lock() statement locking. Call directly or use LockContext sentry object. More... | |
| ASPOSECPP_SHARED_API void | Unlock () |
| Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More... | |
| virtual ASPOSECPP_SHARED_API bool | Equals (ptr obj) |
| Compares objects using C# Object.Equals semantics. More... | |
| virtual ASPOSECPP_SHARED_API int32_t | GetHashCode () const |
| Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More... | |
| virtual ASPOSECPP_SHARED_API String | ToString () const |
| Analog of C# Object.ToString() method. Enables converting custom objects to string. More... | |
| virtual ASPOSECPP_SHARED_API ptr | MemberwiseClone () const |
| Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More... | |
| virtual ASPOSECPP_SHARED_API const TypeInfo & | GetType () const |
| Gets actual type of object. Analog of C# System.Object.GetType() call. More... | |
| virtual ASPOSECPP_SHARED_API bool | Is (const TypeInfo &targetType) const |
| Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More... | |
| virtual ASPOSECPP_SHARED_API void | SetTemplateWeakPtr (uint32_t argument) |
| Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More... | |
| virtual ASPOSECPP_SHARED_API bool | FastCast (const Details::FastRttiBase &helper, void **out_ptr) const |
| For internal purposes only. More... | |
| template<> | |
| bool | Equals (float const &objA, float const &objB) |
| Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More... | |
| template<> | |
| bool | Equals (double const &objA, double const &objB) |
| Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More... | |
| template<> | |
| bool | ReferenceEquals (String const &str, std::nullptr_t) |
| Specialization of Object::ReferenceEquals for case of string and nullptr. More... | |
| template<> | |
| bool | ReferenceEquals (String const &str1, String const &str2) |
| Specialization of Object::ReferenceEquals for case of strings. More... | |
Public Attributes | |
| UnifiedSaveOptions::ConversionProgressEventHandler | CustomProgressHandler |
| This handler can be used to handle conversion progress events f.e. it can be used to show progress bar or messages about current amount of processed pages, example of handler's code that shows progress on console is : More... | |
| bool | SaveFullFont |
| Indicates that full font will be saved, supports only True Type Fonts. By default SaveFullFont = false and the converter saves the subset of the initial font needed to display the text of the document. More... | |
| HtmlSaveOptions::AntialiasingProcessingType | AntialiasingProcessing |
| This parameter defines required antialiasing measures during conversion of compound background images from PDF to HTML More... | |
| bool | SaveTransparentTexts |
| Pdf can contain transparent texts that can be selected to clipboard (usually it happen when document contains images and OCRed texts extracted from it). This settings tells to converter whether we need save such texts as transparent selectable texts in result HTML More... | |
| bool | SaveShadowedTextsAsTransparentTexts |
| Pdf can contain texts that are shadowed by another elements (f.e. by images) but can be selected to clipboard in Acrobat Reader (usually it happen when document contains images and OCRed texts extracted from it). This settings tells to converter whether we need save such texts as transparent selectable texts in result HTML to mimic behaviour of Acrobat Reader (othervise such texts are usually saved as hidden, not available for copying to clipboard) More... | |
| HtmlSaveOptions::FontSavingModes | FontSavingMode |
| Defines font saving mode that will be used during saving of PDF to desirable format More... | |
| System::SharedPtr< SaveOptions::BorderInfo > | PageBorderIfAny |
| This attribute represents set of settings used for drawing border (if any) in result HTML document around area that represent source PDF page. In essence it concerns of showing of page's paper edges, not page border referenced in PDF page itself. More... | |
| System::SharedPtr< SaveOptions::MarginInfo > | PageMarginIfAny |
| This attribute represents set of extra page margin (if any) in result HTML document around area that represent source PDF page. More... | |
| HtmlSaveOptions::LettersPositioningMethods | LettersPositioningMethod |
| Sets mode of positioning of letters in words in result HTML More... | |
| System::ArrayPtr< System::String > | ExcludeFontNameList |
| List of PDF embedded font names that not be embedded in HTML. More... | |
| HtmlSaveOptions::ResourceSavingStrategy | CustomResourceSavingStrategy |
| This field can contain saving strategy that must be used (if present) during conversion for customized handling of created referenced resource files (like images and fonts) related to nodes of saved HTML. That strategy must process resources and return string that represents desirable URL of saved resource in generated HTML. More... | |
| HtmlSaveOptions::CssSavingStrategy | CustomCssSavingStrategy |
| This field can contain saving strategy that must be used (if present) during conversion of Pdf to Html for handling of saving of CSSes related to created HTML document as whole or to it's pages(if several HTMLpages are generated) If You want handle CSS file in some specific way, that just please create relevant method and assign delegate created from it to this property. More... | |
| HtmlSaveOptions::HtmlPageMarkupSavingStrategy | CustomHtmlSavingStrategy |
| Result of conversion can contain one or several HTML-pages You can assign to this property delegate created from custom method that implements processing of one HTML-page(to be accurately - markup-HTML, without exteranl linked files if any) that was created during conversion. In such case processing (like saving of paage's HTML in stream or disk) can be done in that custom code . In such case all the necessary actions for saving of HTML page must be undertaken in code of supplied method, because saving of result in code of converter will be not in use . If processing for this or that case for some reason must be done by converter's code itself, not in custom code, please set in custom code flag 'CustomProcessingCancelled' of 'htmlSavingInfo' parameter's variable : it will signal to converter that all the necessary steps for processing of that resource must be done in converter itself in same way as if there was no any external custom code for procesing . More... | |
| HtmlSaveOptions::CssUrlMakingStrategy | CustomStrategyOfCssUrlCreation |
| This field can contain custom method that returns URL (Or URL template if multipage generation is on - see details below) of subject CSS as it should be put in generated result HTML. F.e. if You want converter put some specific URL instead of standard CSS file name into generated CSS, then You should just create and put into this property method that generates desirable URL. If flag 'SplitCssIntoPages' set, then this custom strategy (if any) must return not exact URL of CSS but rather template string that (after substitution of placeholder with page number with string.Format() function inside converter) can be resolved into URL for this or that page's CSS' URL. Examples of expected return string in such case are: 'SomeTargetLocation-page_{0}.css','../PartHandlers/GetCss.aspx?DocumentId=45654&CssPage={0}') More... | |
| System::String | SpecialFolderForSvgImages |
| Gets or sets path to directory to which must be saved only SVG-images if they are encountered during saving of document as HTML. If parameter is empty or null then SVG files(if any) wil be saved together with other image-files (near to output file) or in special folder for images (if it specified in SpecialImagesFolderIfAny option). It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file. More... | |
| System::String | SpecialFolderForAllImages |
| Gets or sets path to directory to which must be saved any images if they are encountered during saving of document as HTML. If parameter is empty or null then image files(if any) wil be saved together with other files linked to HTML It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file. More... | |
| System::String | CssClassNamesPrefix |
| When PDFtoHTML converter generates result CSSs, CSS class names (something like ".stl_01 {}" ... ".stl_NN {}) are generated and used in result CSS. This property allows forcibly set class name prefix For example, if You want that all class names start with 'my_prefix_' (i.e. were something like 'my_prefix_1' ... 'my_prefix_NNN' ) , then just assign 'my_prefix_' to this property before conversion. If this property will stay untouched(i.e. null will be leaved as value ), then converter will generate class names itself (it wil be something like ".stl_01 {}" ... ".stl_NN {}") More... | |
| HtmlSaveOptions::PartsEmbeddingModes | PartsEmbeddingMode |
| It defines whether referenced files (HTML, Fonts,Images, CSSes) will be embedded into main HTML file or will be generated as apart binary entities More... | |
| HtmlSaveOptions::HtmlMarkupGenerationModes | HtmlMarkupGenerationMode |
| Sometimes specific reqirments to generation of HTML markup are present. This parameter defines HTML preparing modes that can be used during conversion of PDF to HTML to match such specific requirments. More... | |
| HtmlSaveOptions::RasterImagesSavingModes | RasterImagesSavingMode |
| Converted PDF can contain raster images This parameter defines how they should be handled during conversion of PDF to HTML More... | |
| bool | RemoveEmptyAreasOnTopAndBottom |
| Defines whether in created HTML will be removed top and bottom empty area without any content (if any). More... | |
| HtmlSaveOptions::FontEncodingRules | FontEncodingStrategy |
| Defines encoding special rule to tune PDF decoding for current document More... | |
| bool | PagesFlowTypeDependsOnViewersScreenSize |
| If attribute 'SplitOnPages=false', than whole HTML representing all input PDF pages will be put into one big result HTML file. This flag defines whether result HTML will be generated in such way that flow of areas that represent PDF pages in result HTML will depend on screen resolution of viewer. Suppose width of screen on viewer side is big enough to put 2 or more pages one near other in horizontal direction. If this flag set to true, then this opportunity will be used (as many pages will be shown in horizontal direction one near another as it possible, then next horizontal group of pages will be shown under first one ). Otherwise pages will flow in such way: next page goes always under previous one. More... | |
| bool | TrySaveTextUnderliningAndStrikeoutingInCss |
| PDF itself does not contain underlining markers for texts. It emulated with line situated under text. This option allows converter try guess that this or that line is a text's underlining and put this info into CSS instead of drawing of underlining graphically More... | |
| Public Attributes inherited from Aspose::Pdf::UnifiedSaveOptions | |
| bool | TryMergeAdjacentSameBackgroundImages |
| Sometimes PDFs contain background images (of pages or table cells) constructed from several same tiling background images put one near other. In such case renderers of target formats (f.e MsWord for DOCS format) sometimes generates visible boundaries beetween parts of background images, cause their techniques of image edge smoothing (anti-aliasing) is different from Acrobat Reader. If it looks like exported document contains such visible boundaries between parts of same background images, please try use this setting to get rid of that unwanted effect. ATTENTION! This optimization of quality usually essentially slows down conversion, so, please, use this option only when it's really necessary. More... | |
Protected Member Functions | |
| Aspose::Pdf::Direction | get_Direction () const |
| This attribute determines text direction in converted document. More... | |
| void | set_Direction (Aspose::Pdf::Direction value) |
| This attribute determines text direction in converted document. More... | |
| void | CheckParametersConsistensyAndThrowExceptionOtherwise (bool targetIsStream) |
| void | ResetInternals () |
| Protected Member Functions inherited from Aspose::Pdf::UnifiedSaveOptions | |
| int32_t | GetNumberOfConvertiblePages (System::SharedPtr< Document > document) |
Additional Inherited Members | |
| Static Public Member Functions inherited from System::Object | |
| static bool | ReferenceEquals (ptr const &objA, ptr const &objB) |
| Compares objects by reference. More... | |
| template<typename T > | |
| static std::enable_if<!IsSmartPtr< T >::value, bool >::type | ReferenceEquals (T const &objA, T const &objB) |
| Compares objects by reference. More... | |
| template<typename T > | |
| static std::enable_if<!IsSmartPtr< T >::value, bool >::type | ReferenceEquals (T const &objA, std::nullptr_t) |
| Reference-compares value type object with nullptr. More... | |
| template<typename T1 , typename T2 > | |
| static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type | Equals (T1 const &objA, T2 const &objB) |
| Compares reference type objects in C# style. More... | |
| template<typename T1 , typename T2 > | |
| static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type | Equals (T1 const &objA, T2 const &objB) |
| Compares value type objects in C# style. More... | |
| static const TypeInfo & | Type () |
| Implements C# typeof(System.Object) construct. More... | |
| Protected Types inherited from Aspose::Pdf::UnifiedSaveOptions | |
| using | OnePageProcessedEventHandler = System::MulticastDelegate< void(int32_t)> |
| Protected Attributes inherited from Aspose::Pdf::UnifiedSaveOptions | |
| System::SharedPtr< ConversionProgressEventsTranslator > | ProgressEventsRetranslator |
| Represents internal progress events processor that works during conversion and translates conversion events of internal conversion stages into external total progress events Also class broadcasts events that allow to free resources that not needed anymore This internal class handles events of PDF to APS and APS to [Other format] progress to calculate total progress and inform customer's code about that total progress events this class uses two types of events : ApsToExternal model conversion and events of conversion Pdf to APS to generate total progress events Export has three stage : 1) Pdf to Aps 2) Aps recognition 3_ Aps export to target format Constructor allows tune how much pages are converted and what is approximmate part of this or that stage in total progress More... | |
| Protected Attributes inherited from Aspose::Pdf::SaveOptions | |
| Aspose::Pdf::SaveFormat | _saveFormat |
| System::String | ApsIntermediateFileIfAny |
| System::String | XpsIntermediateFileIfAny |
| System::String | PngIntermediateFileIfAny |
| ApsToXpsSavingMode | ApsAsXpsSavingMode |
| System::SharedPtr< Aspose::DocumentInfo > | DocumentInfoForSaveAsXps |
| System::String | PlainApsIntermediateTempFileIfAny |
| Sometimes we need use temp file to save APS during conversion to avoid OOM exceptions in PalZipWriter For such hard tests can be used this parameter - it will force usage of ile instead of MemoryStream More... | |
| Static Protected Attributes inherited from Aspose::Pdf::UnifiedSaveOptions | |
| static const int32_t | DefaultBatchSize |
Detailed Description
Save options for export to Html format
Member Typedef Documentation
◆ CssSavingStrategy
| using Aspose::Pdf::HtmlSaveOptions::CssSavingStrategy = System::MulticastDelegate<void(System::SharedPtr<HtmlSaveOptions::CssSavingInfo>)> |
◆ CssUrlMakingStrategy
| using Aspose::Pdf::HtmlSaveOptions::CssUrlMakingStrategy = System::MulticastDelegate<System::String(System::SharedPtr<HtmlSaveOptions::CssUrlRequestInfo>)> |
◆ HtmlPageMarkupSavingStrategy
| using Aspose::Pdf::HtmlSaveOptions::HtmlPageMarkupSavingStrategy = System::MulticastDelegate<void(System::SharedPtr<HtmlSaveOptions::HtmlPageMarkupSavingInfo>)> |
◆ ResourceSavingStrategy
| using Aspose::Pdf::HtmlSaveOptions::ResourceSavingStrategy = System::MulticastDelegate<System::String(System::SharedPtr<SaveOptions::ResourceSavingInfo>)> |
To this property You can assign delegate created from custom method that implements processing of external resource(Font or Image) that was extracted from PDF and must be saved as external resource during conversion of PDF to HTML. In such case processing (like saving in stream or disk) can be done in that custom code and that custom code must return path(or any another string without quotemarks) that will be afterwards incorporated into generated HTML instead of original supposed path to that image resource. In such case All the necessary actions for saving of image must be undertaken in code of supplied method, because saving of result in code of converter will be not in use . If processing for this or that file for some reason must be done by converter's code itself, not in custom code, please set in custom code flag 'CustomProcessingCancelled' of 'resourceSavingInfo' parameter's variable It signals to converter that all the necessary steps for processing of that resource must be done in converter itself as if there was no any external custom code .
- Parameters
-
resourceSavingInfo represents set of data for saving of resource
- Returns
- must return URL to saved resource that will be used during generation of HTML
Member Enumeration Documentation
◆ AntialiasingProcessingType
This enum describes possible antialiasing measures during conversion
◆ FontEncodingRules
|
strong |
This enumeration defines rules which tune encoding logic
◆ FontSavingModes
|
strong |
Enumerates modes that can be used for saving of fonts referenced in saved PDF.
◆ HtmlImageType
|
strong |
enumerates possible types of image files that can be saved as external resources during Pdf to Html conversion
◆ HtmlMarkupGenerationModes
Sometimes specific reqirments to created HTML are present. This enum defines HTML preparing modes that can be used during conversion of PDF to HTML to match such specific requirments.
◆ ImageParentTypes
|
strong |
◆ LettersPositioningMethods
It enumerates possible modes of positioning of letters in words in result HTML
◆ PartsEmbeddingModes
This enum enumerates possible modes of embedding of files referenced in HTML It allows to control whether referenced files (HTML, Fonts,Images, CSSes) will be embedded into main HTML file or will be generated as apart binary entities
◆ RasterImagesSavingModes
Converted PDF can contain raster images(.png, *.jpeg etc.) This enum defines methods of how raster images can be handled during conversion of PDF to HTML
Constructor & Destructor Documentation
◆ HtmlSaveOptions() [1/4]
| ASPOSE_PDF_SHARED_API Aspose::Pdf::HtmlSaveOptions::HtmlSaveOptions | ( | ) |
Initializes a new instance of the HtmlSaveOptions class.
◆ HtmlSaveOptions() [2/4]
| ASPOSE_PDF_SHARED_API Aspose::Pdf::HtmlSaveOptions::HtmlSaveOptions | ( | HtmlDocumentType | documentType | ) |
Initializes a new instance of the HtmlSaveOptions class.
- Parameters
-
documentType The HtmlDocumentType.
◆ HtmlSaveOptions() [3/4]
| ASPOSE_PDF_SHARED_API Aspose::Pdf::HtmlSaveOptions::HtmlSaveOptions | ( | bool | fixedLayout | ) |
Initializes a new instance of the HtmlSaveOptions class.
- Parameters
-
fixedLayout if set to trueHTML is created as fixed layout.
◆ HtmlSaveOptions() [4/4]
| ASPOSE_PDF_SHARED_API Aspose::Pdf::HtmlSaveOptions::HtmlSaveOptions | ( | HtmlDocumentType | documentType, |
| bool | fixedLayout | ||
| ) |
Initializes a new instance of the HtmlSaveOptions class.
- Parameters
-
documentType The HtmlDocumentType. fixedLayout if set to trueHTML is created as fixed layout.
Member Function Documentation
◆ CheckParametersConsistensyAndThrowExceptionOtherwise()
|
protected |
◆ get_AdditionalMarginWidthInPoints()
| ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::HtmlSaveOptions::get_AdditionalMarginWidthInPoints | ( | ) | const |
If attribute 'SplitOnPages=false', than whole HTML representing all input PDF pages wont be not split into different HTML pages, but will be put into one big result HTML file. But each source PDF page will be represented with it's own rectangle area in HTML (if necessary that areas can be bordered to show page paper edges with special attribute 'PageBorderIfAny'. This parameter defines width of margin that will be forcibly left around that output HTML-areas that represent pages of source PDF document.In essence it defines guaranteed interval between HTML-representations of PDF "paper" pages such mode of conversion.
- Deprecated:
- AdditionalMarginWidthInPoints is deprecated, please use PageMarginIfAny instead.
◆ get_BatchSize()
|
overridevirtual |
Defines batch size if batched conversion is applicable to source and destination formats pair.
Implements Aspose::Pdf::IPipelineOptions.
◆ get_CompressSvgGraphicsIfAny()
| ASPOSE_PDF_SHARED_API bool Aspose::Pdf::HtmlSaveOptions::get_CompressSvgGraphicsIfAny | ( | ) | const |
Gets the flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving
The HtmlDocumentType.
◆ get_ConvertMarkedContentToLayers()
| ASPOSE_PDF_SHARED_API bool Aspose::Pdf::HtmlSaveOptions::get_ConvertMarkedContentToLayers | ( | ) | const |
If attribute ConvertMarkedContentToLayers set to true then an all elements inside a PDF marked content (layer) will be put into an HTML div with "data-pdflayer" attribute specifying a layer name. This layer name will be extracted from optional properties of PDF marked content. If this attribute is false (by default) then no any layers will be created from PDF marked content.
◆ get_DefaultFontName()
| ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::HtmlSaveOptions::get_DefaultFontName | ( | ) | const |
Specifies the name of an installed font which is used to substitute any document font that is not embedded and not installed in the system. If null then default substitution font is used.
Font name
◆ get_Direction()
|
protected |
This attribute determines text direction in converted document.
◆ get_DocumentType()
| ASPOSE_PDF_SHARED_API HtmlDocumentType Aspose::Pdf::HtmlSaveOptions::get_DocumentType | ( | ) | const |
Gets the HtmlDocumentType.
The HtmlDocumentType.
◆ get_ExplicitListOfSavedPages()
|
overridevirtual |
With this property You can explicitely define what pages of document should be converted. Pages in this list must have 1-based numbers. I.e. valid numbers of pages must be taken from range (1...[NumberOfPagesInConvertedDocument]) Order of appearing of pages in this list does not affect their order in result HTML page(s) - in result pages allways will go in order in which they are present in source PDF. If this list is null (as it is by default), all pages will be converted. If any page number of this list will go out of range of present pages(1-[amountOfPagesInDocument]) exception will be thrown.
Implements Aspose::Pdf::IPageSetOptions.
◆ get_FixedLayout()
| ASPOSE_PDF_SHARED_API bool Aspose::Pdf::HtmlSaveOptions::get_FixedLayout | ( | ) | const |
Gets a value indicating whether that HTML is created as fixed layout.
true if [fixed layout]; otherwise, false.
◆ get_FlowLayoutParagraphFullWidth()
| ASPOSE_PDF_SHARED_API bool Aspose::Pdf::HtmlSaveOptions::get_FlowLayoutParagraphFullWidth | ( | ) | const |
This attribute specifies full width paragraph text for Flow mode, FixedLayout = false
◆ get_FontSources()
| ASPOSE_PDF_SHARED_API System::SharedPtr<Text::FontSourceCollection> Aspose::Pdf::HtmlSaveOptions::get_FontSources | ( | ) | const |
Font sources of pre-saved fonts.
Fonts may be saved preliminarily for cache purpose and then passed into Html conversion process. For example it may be useful in document splitting scenario and processing document pages in multiple threads with single set of fonts.
◆ get_ImageResolution()
| ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::HtmlSaveOptions::get_ImageResolution | ( | ) | const |
Gets resolution for image rendering.
Resolution
◆ get_MinimalLineWidth()
| ASPOSE_PDF_SHARED_API float Aspose::Pdf::HtmlSaveOptions::get_MinimalLineWidth | ( | ) | const |
This attribute sets minimal width of graphic path line. If thickness of line is less than 1px Adobe Acrobat rounds it to this value. So this attribute can be used to emulate this behavior for HTML browsers.
◆ get_PreventGlyphsGrouping()
| ASPOSE_PDF_SHARED_API bool Aspose::Pdf::HtmlSaveOptions::get_PreventGlyphsGrouping | ( | ) | const |
This attribute switch on the mode when text glyphs will not be grouped into words and strings This mode allows to keep maximum precision during positioning of glyphs on the page and it can be used for conversion documents with music notes or glyphs that should be placed separately each other. This parameter will be applied to document only when the value of FixedLayout attribute is true.
◆ get_RenderTextAsImage()
| ASPOSE_PDF_SHARED_API bool Aspose::Pdf::HtmlSaveOptions::get_RenderTextAsImage | ( | ) | const |
If attribute RenderTextAsImage set to true, the text from the source becomes an image in HTML. May be useful to make text unselectable or HTML text is not rendered properly.
◆ get_SimpleTextboxModeGrouping()
| ASPOSE_PDF_SHARED_API bool Aspose::Pdf::HtmlSaveOptions::get_SimpleTextboxModeGrouping | ( | ) | const |
This attribute specifies a sequential grouping of glyphs and words into strings For example tags and words has different order in converted HTML and you want them to match. This parameter will be applied to document only when the value of FixedLayout attribute is true.
◆ get_SplitCssIntoPages()
| ASPOSE_PDF_SHARED_API bool Aspose::Pdf::HtmlSaveOptions::get_SplitCssIntoPages | ( | ) | const |
When multipage-mode selected(i.e 'SplitIntoPages' is 'true'), then this attribute defines whether should be created separate CSS-file for each result HTML page. By default this attribute is false, so, will be created one big common CSS for all created pages. Summary size of all CSSes generated in this mode(one CSS per page) usually much more than size of one big CSS file, because in former case CSS classes are duplicates in such case in several CSS files for each page. So, this setting is worse to be used only when You are interested in future processing of each HTML page independently, and therefore size of CSS of each one page taken apart is the most critical issue.
◆ get_SplitIntoPages()
| ASPOSE_PDF_SHARED_API bool Aspose::Pdf::HtmlSaveOptions::get_SplitIntoPages | ( | ) | const |
Gets the flag that indicates whether each page of source document will be converted into it's own target HTML document, i.e whether result HTML will be splitted into several HTML-pages.
◆ get_Title()
| ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::HtmlSaveOptions::get_Title | ( | ) | const |
Gets HTML page title.
◆ get_UseZOrder()
| ASPOSE_PDF_SHARED_API bool Aspose::Pdf::HtmlSaveOptions::get_UseZOrder | ( | ) | const |
If attribute UseZORder set to true, graphics and text are added to resultant HTML document accordingly Z-order in original PDF document. If this attribute is false all graphics is put as single layer which may cause some unnecessary effects for overlapped objects.
◆ ResetInternals()
|
protected |
◆ set_AdditionalMarginWidthInPoints()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::HtmlSaveOptions::set_AdditionalMarginWidthInPoints | ( | int32_t | value | ) |
If attribute 'SplitOnPages=false', than whole HTML representing all input PDF pages wont be not split into different HTML pages, but will be put into one big result HTML file. But each source PDF page will be represented with it's own rectangle area in HTML (if necessary that areas can be bordered to show page paper edges with special attribute 'PageBorderIfAny'. This parameter defines width of margin that will be forcibly left around that output HTML-areas that represent pages of source PDF document.In essence it defines guaranteed interval between HTML-representations of PDF "paper" pages such mode of conversion.
- Deprecated:
- AdditionalMarginWidthInPoints is deprecated, please use PageMarginIfAny instead.
◆ set_BatchSize()
|
overridevirtual |
Defines batch size if batched conversion is applicable to source and destination formats pair.
Implements Aspose::Pdf::IPipelineOptions.
◆ set_CompressSvgGraphicsIfAny()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::HtmlSaveOptions::set_CompressSvgGraphicsIfAny | ( | bool | value | ) |
Sets the flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving
The HtmlDocumentType.
◆ set_ConvertMarkedContentToLayers()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::HtmlSaveOptions::set_ConvertMarkedContentToLayers | ( | bool | value | ) |
If attribute ConvertMarkedContentToLayers set to true then an all elements inside a PDF marked content (layer) will be put into an HTML div with "data-pdflayer" attribute specifying a layer name. This layer name will be extracted from optional properties of PDF marked content. If this attribute is false (by default) then no any layers will be created from PDF marked content.
◆ set_DefaultFontName()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::HtmlSaveOptions::set_DefaultFontName | ( | System::String | value | ) |
Specifies the name of an installed font which is used to substitute any document font that is not embedded and not installed in the system. If null then default substitution font is used.
Font name
◆ set_Direction()
|
protected |
This attribute determines text direction in converted document.
◆ set_DocumentType()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::HtmlSaveOptions::set_DocumentType | ( | HtmlDocumentType | value | ) |
Sets the HtmlDocumentType.
The HtmlDocumentType.
◆ set_ExplicitListOfSavedPages()
|
overridevirtual |
With this property You can explicitely define what pages of document should be converted. Pages in this list must have 1-based numbers. I.e. valid numbers of pages must be taken from range (1...[NumberOfPagesInConvertedDocument]) Order of appearing of pages in this list does not affect their order in result HTML page(s) - in result pages allways will go in order in which they are present in source PDF. If this list is null (as it is by default), all pages will be converted. If any page number of this list will go out of range of present pages(1-[amountOfPagesInDocument]) exception will be thrown.
Implements Aspose::Pdf::IPageSetOptions.
◆ set_FixedLayout()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::HtmlSaveOptions::set_FixedLayout | ( | bool | value | ) |
Sets a value indicating whether that HTML is created as fixed layout.
true if [fixed layout]; otherwise, false.
◆ set_FlowLayoutParagraphFullWidth()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::HtmlSaveOptions::set_FlowLayoutParagraphFullWidth | ( | bool | value | ) |
This attribute specifies full width paragraph text for Flow mode, FixedLayout = false
◆ set_ImageResolution()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::HtmlSaveOptions::set_ImageResolution | ( | int32_t | value | ) |
Sets resolution for image rendering.
Resolution
◆ set_MinimalLineWidth()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::HtmlSaveOptions::set_MinimalLineWidth | ( | float | value | ) |
This attribute sets minimal width of graphic path line. If thickness of line is less than 1px Adobe Acrobat rounds it to this value. So this attribute can be used to emulate this behavior for HTML browsers.
◆ set_PreventGlyphsGrouping()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::HtmlSaveOptions::set_PreventGlyphsGrouping | ( | bool | value | ) |
This attribute switch on the mode when text glyphs will not be grouped into words and strings This mode allows to keep maximum precision during positioning of glyphs on the page and it can be used for conversion documents with music notes or glyphs that should be placed separately each other. This parameter will be applied to document only when the value of FixedLayout attribute is true.
◆ set_RenderTextAsImage()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::HtmlSaveOptions::set_RenderTextAsImage | ( | bool | value | ) |
If attribute RenderTextAsImage set to true, the text from the source becomes an image in HTML. May be useful to make text unselectable or HTML text is not rendered properly.
◆ set_SimpleTextboxModeGrouping()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::HtmlSaveOptions::set_SimpleTextboxModeGrouping | ( | bool | value | ) |
This attribute specifies a sequential grouping of glyphs and words into strings For example tags and words has different order in converted HTML and you want them to match. This parameter will be applied to document only when the value of FixedLayout attribute is true.
◆ set_SplitCssIntoPages()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::HtmlSaveOptions::set_SplitCssIntoPages | ( | bool | value | ) |
When multipage-mode selected(i.e 'SplitIntoPages' is 'true'), then this attribute defines whether should be created separate CSS-file for each result HTML page. By default this attribute is false, so, will be created one big common CSS for all created pages. Summary size of all CSSes generated in this mode(one CSS per page) usually much more than size of one big CSS file, because in former case CSS classes are duplicates in such case in several CSS files for each page. So, this setting is worse to be used only when You are interested in future processing of each HTML page independently, and therefore size of CSS of each one page taken apart is the most critical issue.
◆ set_SplitIntoPages()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::HtmlSaveOptions::set_SplitIntoPages | ( | bool | value | ) |
Sets the flag that indicates whether each page of source document will be converted into it's own target HTML document, i.e whether result HTML will be splitted into several HTML-pages.
◆ set_Title()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::HtmlSaveOptions::set_Title | ( | System::String | value | ) |
Sets HTML page title.
◆ set_UseZOrder()
| ASPOSE_PDF_SHARED_API void Aspose::Pdf::HtmlSaveOptions::set_UseZOrder | ( | bool | value | ) |
If attribute UseZORder set to true, graphics and text are added to resultant HTML document accordingly Z-order in original PDF document. If this attribute is false all graphics is put as single layer which may cause some unnecessary effects for overlapped objects.
Member Data Documentation
◆ AntialiasingProcessing
| HtmlSaveOptions::AntialiasingProcessingType Aspose::Pdf::HtmlSaveOptions::AntialiasingProcessing |
This parameter defines required antialiasing measures during conversion of compound background images from PDF to HTML
◆ CssClassNamesPrefix
| System::String Aspose::Pdf::HtmlSaveOptions::CssClassNamesPrefix |
When PDFtoHTML converter generates result CSSs, CSS class names (something like ".stl_01 {}" ... ".stl_NN {}) are generated and used in result CSS. This property allows forcibly set class name prefix For example, if You want that all class names start with 'my_prefix_' (i.e. were something like 'my_prefix_1' ... 'my_prefix_NNN' ) , then just assign 'my_prefix_' to this property before conversion. If this property will stay untouched(i.e. null will be leaved as value ), then converter will generate class names itself (it wil be something like ".stl_01 {}" ... ".stl_NN {}")
◆ CustomCssSavingStrategy
| HtmlSaveOptions::CssSavingStrategy Aspose::Pdf::HtmlSaveOptions::CustomCssSavingStrategy |
This field can contain saving strategy that must be used (if present) during conversion of Pdf to Html for handling of saving of CSSes related to created HTML document as whole or to it's pages(if several HTMLpages are generated) If You want handle CSS file in some specific way, that just please create relevant method and assign delegate created from it to this property.
◆ CustomHtmlSavingStrategy
| HtmlSaveOptions::HtmlPageMarkupSavingStrategy Aspose::Pdf::HtmlSaveOptions::CustomHtmlSavingStrategy |
Result of conversion can contain one or several HTML-pages You can assign to this property delegate created from custom method that implements processing of one HTML-page(to be accurately - markup-HTML, without exteranl linked files if any) that was created during conversion. In such case processing (like saving of paage's HTML in stream or disk) can be done in that custom code . In such case all the necessary actions for saving of HTML page must be undertaken in code of supplied method, because saving of result in code of converter will be not in use . If processing for this or that case for some reason must be done by converter's code itself, not in custom code, please set in custom code flag 'CustomProcessingCancelled' of 'htmlSavingInfo' parameter's variable : it will signal to converter that all the necessary steps for processing of that resource must be done in converter itself in same way as if there was no any external custom code for procesing .
◆ CustomProgressHandler
| UnifiedSaveOptions::ConversionProgressEventHandler Aspose::Pdf::HtmlSaveOptions::CustomProgressHandler |
This handler can be used to handle conversion progress events f.e. it can be used to show progress bar or messages about current amount of processed pages, example of handler's code that shows progress on console is :
◆ CustomResourceSavingStrategy
| HtmlSaveOptions::ResourceSavingStrategy Aspose::Pdf::HtmlSaveOptions::CustomResourceSavingStrategy |
This field can contain saving strategy that must be used (if present) during conversion for customized handling of created referenced resource files (like images and fonts) related to nodes of saved HTML. That strategy must process resources and return string that represents desirable URL of saved resource in generated HTML.
◆ CustomStrategyOfCssUrlCreation
| HtmlSaveOptions::CssUrlMakingStrategy Aspose::Pdf::HtmlSaveOptions::CustomStrategyOfCssUrlCreation |
This field can contain custom method that returns URL (Or URL template if multipage generation is on - see details below) of subject CSS as it should be put in generated result HTML. F.e. if You want converter put some specific URL instead of standard CSS file name into generated CSS, then You should just create and put into this property method that generates desirable URL. If flag 'SplitCssIntoPages' set, then this custom strategy (if any) must return not exact URL of CSS but rather template string that (after substitution of placeholder with page number with string.Format() function inside converter) can be resolved into URL for this or that page's CSS' URL. Examples of expected return string in such case are: 'SomeTargetLocation-page_{0}.css','../PartHandlers/GetCss.aspx?DocumentId=45654&CssPage={0}')
◆ ExcludeFontNameList
| System::ArrayPtr<System::String> Aspose::Pdf::HtmlSaveOptions::ExcludeFontNameList |
List of PDF embedded font names that not be embedded in HTML.
◆ FontEncodingStrategy
| HtmlSaveOptions::FontEncodingRules Aspose::Pdf::HtmlSaveOptions::FontEncodingStrategy |
Defines encoding special rule to tune PDF decoding for current document
◆ FontSavingMode
| HtmlSaveOptions::FontSavingModes Aspose::Pdf::HtmlSaveOptions::FontSavingMode |
Defines font saving mode that will be used during saving of PDF to desirable format
◆ HtmlMarkupGenerationMode
| HtmlSaveOptions::HtmlMarkupGenerationModes Aspose::Pdf::HtmlSaveOptions::HtmlMarkupGenerationMode |
Sometimes specific reqirments to generation of HTML markup are present. This parameter defines HTML preparing modes that can be used during conversion of PDF to HTML to match such specific requirments.
◆ LettersPositioningMethod
| HtmlSaveOptions::LettersPositioningMethods Aspose::Pdf::HtmlSaveOptions::LettersPositioningMethod |
Sets mode of positioning of letters in words in result HTML
◆ PageBorderIfAny
| System::SharedPtr<SaveOptions::BorderInfo> Aspose::Pdf::HtmlSaveOptions::PageBorderIfAny |
This attribute represents set of settings used for drawing border (if any) in result HTML document around area that represent source PDF page. In essence it concerns of showing of page's paper edges, not page border referenced in PDF page itself.
◆ PageMarginIfAny
| System::SharedPtr<SaveOptions::MarginInfo> Aspose::Pdf::HtmlSaveOptions::PageMarginIfAny |
This attribute represents set of extra page margin (if any) in result HTML document around area that represent source PDF page.
◆ PagesFlowTypeDependsOnViewersScreenSize
| bool Aspose::Pdf::HtmlSaveOptions::PagesFlowTypeDependsOnViewersScreenSize |
If attribute 'SplitOnPages=false', than whole HTML representing all input PDF pages will be put into one big result HTML file. This flag defines whether result HTML will be generated in such way that flow of areas that represent PDF pages in result HTML will depend on screen resolution of viewer. Suppose width of screen on viewer side is big enough to put 2 or more pages one near other in horizontal direction. If this flag set to true, then this opportunity will be used (as many pages will be shown in horizontal direction one near another as it possible, then next horizontal group of pages will be shown under first one ). Otherwise pages will flow in such way: next page goes always under previous one.
◆ PartsEmbeddingMode
| HtmlSaveOptions::PartsEmbeddingModes Aspose::Pdf::HtmlSaveOptions::PartsEmbeddingMode |
It defines whether referenced files (HTML, Fonts,Images, CSSes) will be embedded into main HTML file or will be generated as apart binary entities
◆ RasterImagesSavingMode
| HtmlSaveOptions::RasterImagesSavingModes Aspose::Pdf::HtmlSaveOptions::RasterImagesSavingMode |
Converted PDF can contain raster images This parameter defines how they should be handled during conversion of PDF to HTML
◆ RemoveEmptyAreasOnTopAndBottom
| bool Aspose::Pdf::HtmlSaveOptions::RemoveEmptyAreasOnTopAndBottom |
Defines whether in created HTML will be removed top and bottom empty area without any content (if any).
◆ SaveFullFont
| bool Aspose::Pdf::HtmlSaveOptions::SaveFullFont |
Indicates that full font will be saved, supports only True Type Fonts. By default SaveFullFont = false and the converter saves the subset of the initial font needed to display the text of the document.
◆ SaveShadowedTextsAsTransparentTexts
| bool Aspose::Pdf::HtmlSaveOptions::SaveShadowedTextsAsTransparentTexts |
Pdf can contain texts that are shadowed by another elements (f.e. by images) but can be selected to clipboard in Acrobat Reader (usually it happen when document contains images and OCRed texts extracted from it). This settings tells to converter whether we need save such texts as transparent selectable texts in result HTML to mimic behaviour of Acrobat Reader (othervise such texts are usually saved as hidden, not available for copying to clipboard)
◆ SaveTransparentTexts
| bool Aspose::Pdf::HtmlSaveOptions::SaveTransparentTexts |
Pdf can contain transparent texts that can be selected to clipboard (usually it happen when document contains images and OCRed texts extracted from it). This settings tells to converter whether we need save such texts as transparent selectable texts in result HTML
◆ SpecialFolderForAllImages
| System::String Aspose::Pdf::HtmlSaveOptions::SpecialFolderForAllImages |
Gets or sets path to directory to which must be saved any images if they are encountered during saving of document as HTML. If parameter is empty or null then image files(if any) wil be saved together with other files linked to HTML It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file.
◆ SpecialFolderForSvgImages
| System::String Aspose::Pdf::HtmlSaveOptions::SpecialFolderForSvgImages |
Gets or sets path to directory to which must be saved only SVG-images if they are encountered during saving of document as HTML. If parameter is empty or null then SVG files(if any) wil be saved together with other image-files (near to output file) or in special folder for images (if it specified in SpecialImagesFolderIfAny option). It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file.
◆ TrySaveTextUnderliningAndStrikeoutingInCss
| bool Aspose::Pdf::HtmlSaveOptions::TrySaveTextUnderliningAndStrikeoutingInCss |
PDF itself does not contain underlining markers for texts. It emulated with line situated under text. This option allows converter try guess that this or that line is a text's underlining and put this info into CSS instead of drawing of underlining graphically