This enumeration defines rules which tune encoding logic More...

Inherits Aspose::Pdf::UnifiedSaveOptions.

Classes

class  CssSavingInfo
 
class  CssUrlRequestInfo
 
class  HtmlImageSavingInfo
 
class  HtmlPageMarkupSavingInfo
 

Public Types

enum  FontSavingModes {
  FontSavingModes::AlwaysSaveAsWOFF = 0, FontSavingModes::AlwaysSaveAsTTF = 1, FontSavingModes::AlwaysSaveAsEOT = 2, FontSavingModes::SaveInAllFormats = 3,
  FontSavingModes::DontSave = 4
}
 
enum  AntialiasingProcessingType { AntialiasingProcessingType::NoAdditionalProcessing, AntialiasingProcessingType::TryCorrectResultHtml }
 
enum  LettersPositioningMethods { LettersPositioningMethods::UseEmUnitsAndCompensationOfRoundingErrorsInCss, LettersPositioningMethods::UsePixelUnitsInCssLetterSpacingForIE }
 
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
}
 
enum  ImageParentTypes { ImageParentTypes::HtmlPage = 0, ImageParentTypes::SvgImage = 1 }
 
enum  RasterImagesSavingModes { RasterImagesSavingModes::AsPngImagesEmbeddedIntoSvg, RasterImagesSavingModes::AsExternalPngFilesReferencedViaSvg, RasterImagesSavingModes::AsEmbeddedPartsOfPngPageBackground }
 
enum  HtmlMarkupGenerationModes { HtmlMarkupGenerationModes::WriteAllHtml, HtmlMarkupGenerationModes::WriteOnlyBodyContent }
 
enum  PartsEmbeddingModes { PartsEmbeddingModes::EmbedAllIntoHtml, PartsEmbeddingModes::EmbedCssOnly, PartsEmbeddingModes::NoEmbedding }
 
enum  FontEncodingRules : uint8_t { FontEncodingRules::Default, FontEncodingRules::DecreaseToUnicodePriorityLevel }
 
using ResourceSavingStrategy = System::MulticastDelegate< System::String(System::SharedPtr< SaveOptions::ResourceSavingInfo >)>
 
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
}
 
enum  NodeLevelResourceType { NodeLevelResourceType::Image = 0, NodeLevelResourceType::Font = 1 }
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 

Public Member Functions

HtmlDocumentType get_DocumentType ()
 Gets the HtmlDocumentType. More...
 
void set_DocumentType (HtmlDocumentType value)
 Sets the HtmlDocumentType. More...
 
bool get_CompressSvgGraphicsIfAny ()
 Gets the flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving More...
 
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...
 
bool get_SplitCssIntoPages ()
 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...
 
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...
 
bool get_SplitIntoPages ()
 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...
 
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...
 
bool get_FixedLayout ()
 Gets a value indicating whether that HTML is created as fixed layout. More...
 
void set_FixedLayout (bool value)
 Sets a value indicating whether that HTML is created as fixed layout. More...
 
int32_t get_ImageResolution ()
 Gets resolution for image rendering. More...
 
void set_ImageResolution (int32_t value)
 Sets resolution for image rendering. More...
 
System::String get_DefaultFontName ()
 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...
 
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...
 
System::SharedPtr< Text::FontSourceCollectionget_FontSources ()
 Font sources of pre-saved fonts. More...
 
int32_t get_AdditionalMarginWidthInPoints ()
 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...
 
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...
 
bool get_UseZOrder ()
 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...
 
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...
 
bool get_ConvertMarkedContentToLayers ()
 If attribute ConvertMarkedContentToLayers set to true then an all elements inside a PDF marked content (layer) will be put into an HTML

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

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...
 
float get_MinimalLineWidth ()
 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...
 
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...
 
bool get_PreventGlyphsGrouping ()
 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...
 
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...
 
int32_t get_ProcessingBatchSize ()
 For a PDF document with many pages the conversion may take a long time or hang. This attribute specifies the number of pages for the batch conversion mode. Example: 'ProcessingBatchSize = 20 pages, Pdf.Size = 100 pages'. Aspose.PDF converts 5 times by 20 pages to one HTLM file. More...
 
void set_ProcessingBatchSize (int32_t value)
 For a PDF document with many pages the conversion may take a long time or hang. This attribute specifies the number of pages for the batch conversion mode. Example: 'ProcessingBatchSize = 20 pages, Pdf.Size = 100 pages'. Aspose.PDF converts 5 times by 20 pages to one HTLM file. More...
 
bool get_SimpleTextboxModeGrouping ()
 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...
 
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...
 
bool get_FlowLayoutParagraphFullWidth ()
 This attribute specifies full width paragraph text for Flow mode, FixedLayout = false More...
 
void set_FlowLayoutParagraphFullWidth (bool value)
 This attribute specifies full width paragraph text for Flow mode, FixedLayout = false More...
 
 HtmlSaveOptions ()
 Initializes a new instance of the HtmlSaveOptions class. More...
 
 HtmlSaveOptions (HtmlDocumentType documentType)
 Initializes a new instance of the HtmlSaveOptions class. More...
 
 HtmlSaveOptions (bool fixedLayout)
 Initializes a new instance of the HtmlSaveOptions class. More...
 
 HtmlSaveOptions (HtmlDocumentType documentType, bool fixedLayout)
 Initializes a new instance of the HtmlSaveOptions class. More...
 
- Public Member Functions inherited from Aspose::Pdf::UnifiedSaveOptions
bool get_ExtractOcrSublayerOnly ()
 This atrribute turned on functionality for extracting image or text for PDF documents with OCR sublayer. More...
 
void set_ExtractOcrSublayerOnly (bool value)
 This atrribute turned on functionality for extracting image or text for PDF documents with OCR sublayer. More...
 
 UnifiedSaveOptions ()
 
- Public Member Functions inherited from Aspose::Pdf::SaveOptions
System::SharedPtr< IWarningCallbackget_WarningHandler ()
 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...
 
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::SaveFormat get_SaveFormat ()
 Format of data save. More...
 
bool get_CloseResponse ()
 Gets boolean value which indicates will Response object be closed after document saved into response. More...
 
void set_CloseResponse (bool value)
 Sets boolean value which indicates will Response object be closed after document saved into response. More...
 
 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...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 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 refernce 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 int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () ASPOSE_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 TypeInfoGetType () 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 (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Public Attributes

UnifiedSaveOptions::ConversionProgressEventHandler CustomProgressHandler
 
HtmlSaveOptions::AntialiasingProcessingType AntialiasingProcessing
 
bool SaveTransparentTexts
 
bool SaveShadowedTextsAsTransparentTexts
 
HtmlSaveOptions::FontSavingModes FontSavingMode
 
System::SharedPtr< SaveOptions::BorderInfoPageBorderIfAny
 
HtmlSaveOptions::LettersPositioningMethods LettersPositioningMethod
 
System::ArrayPtr< int32_t > ExplicitListOfSavedPages
 
System::ArrayPtr< System::StringExcludeFontNameList
 
HtmlSaveOptions::ResourceSavingStrategy CustomResourceSavingStrategy
 
HtmlSaveOptions::CssSavingStrategy CustomCssSavingStrategy
 
HtmlSaveOptions::HtmlPageMarkupSavingStrategy CustomHtmlSavingStrategy
 
HtmlSaveOptions::CssUrlMakingStrategy CustomStrategyOfCssUrlCreation
 
System::String SpecialFolderForSvgImages
 
System::String SpecialFolderForAllImages
 
System::String CssClassNamesPrefix
 
HtmlSaveOptions::PartsEmbeddingModes PartsEmbeddingMode
 
HtmlSaveOptions::HtmlMarkupGenerationModes HtmlMarkupGenerationMode
 
HtmlSaveOptions::RasterImagesSavingModes RasterImagesSavingMode
 
bool RemoveEmptyAreasOnTopAndBottom
 
HtmlSaveOptions::FontEncodingRules FontEncodingStrategy
 
bool PagesFlowTypeDependsOnViewersScreenSize
 
bool TrySaveTextUnderliningAndStrikeoutingInCss
 
- Public Attributes inherited from Aspose::Pdf::UnifiedSaveOptions
bool TryMergeAdjacentSameBackgroundImages
 

Protected Member Functions

Aspose::Pdf::Direction get_Direction ()
 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 ()
 

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 TypeInfoType ()
 Impleemnts 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
 
- Protected Attributes inherited from Aspose::Pdf::SaveOptions
Aspose::Pdf::SaveFormat _saveFormat
 
System::String ApsIntermediateFileIfAny
 
System::String XpsIntermediateFileIfAny
 
System::String PngIntermediateFileIfAny
 
ApsToXpsSavingType ApsAsXpsSavingType
 
System::SharedPtr< Aspose::DocumentInfo > DocumentInfoForSaveAsXps
 
System::String PlainApsIntermediateTempFileIfAny
 

Detailed Description

This enumeration defines rules which tune encoding logic

Member Typedef Documentation

◆ CssSavingStrategy

◆ CssUrlMakingStrategy

◆ HtmlPageMarkupSavingStrategy

◆ ResourceSavingStrategy

Member Enumeration Documentation

◆ AntialiasingProcessingType

Enumerator
NoAdditionalProcessing 

no special antialiasing processing in use. This is an optimal option for overhelming majority of documents and it does not require additional time during conversion

TryCorrectResultHtml 

In such case converter tries to detect places with ajacent background graphical elements and correct result HTML in relevant way. This option allows enhance result of export for documents that contain backgrounds built from several ajacent graphical elements (for such kind of documents PDF renderers , f.e. Acrobat Reader,

With this option converter imitates that behaviour of PDF-renderers. This option allows enhance layout of result of export for some specific documents (that use such compound backgrounds), but it requires additional time for processng (usually about 10-15% of additional time). So usage of this mode in general case is not recommended.

◆ FontEncodingRules

Enumerator
Default 

Leave encoding logic "as is" - in accordance with PDF specification

DecreaseToUnicodePriorityLevel 

ToUnicode is a special mechanism which helps to decode input codes to unicode symbols. According to specification it must be used first of all mechanisms to get unicode symbols for specific input code. But some documents has non-standard fonts and to convert these documents correctly it may be necessary to decrease ToUnicode priority and use another mechanisms to decode input codes.

◆ FontSavingModes

Enumerator
AlwaysSaveAsWOFF 

All referenced fonts will be saved and referenced as WOFF-fonts

AlwaysSaveAsTTF 

All referenced fonts will be saved and referenced as TTF-fonts

AlwaysSaveAsEOT 

All referenced fonts will be saved and referenced as EOT-fonts

SaveInAllFormats 

All referenced fonts will be saved (and referenced in CSS) as 3 independent files : EOT, TTH,WOFF. It increases size of output data but makes output sutable for overhelming majority of web brawsers

DontSave 

All referenced fonts will not be saved.

◆ HtmlImageType

Enumerator
Jpeg 

Jpeg format

Png 

Png format

Bmp 

Bmp format

Gif 

Gif format

Tiff 

Tiff format

Svg 

Svg format

ZippedSvg 

Zipped Svg format

Unknown 

Unknown - means that converter cannot detect type of content itself

◆ HtmlMarkupGenerationModes

Enumerator
WriteAllHtml 

Default mode any specific requirments are absent. Will be generated output that will contain all parts of HTML without any special additional processing.

WriteOnlyBodyContent 

will be stripped away all HTML content that is outside HTML's body, i.e. will be left only content that is inside <body></body> tags

◆ ImageParentTypes

Enumerator
HtmlPage 

Image pertains to HTML page itself

SvgImage 

Image was embedded in SVG image

◆ LettersPositioningMethods

Enumerator
UseEmUnitsAndCompensationOfRoundingErrorsInCss 

It's default method. It uses EM-units and special alhorithm of compensation of rounding errors It's preferable for usage in IE10.0 and more fresh versions and gives better scaling of captions when scaling is necessary

UsePixelUnitsInCssLetterSpacingForIE 

It allows to get sometimes more precise results in old IE browser versions

◆ PartsEmbeddingModes

Enumerator
EmbedAllIntoHtml 

Enforces embed all referenced files(Css,Images,Fonts) into generated HTML markup (i.e. into HTML itself) This approach generates one HTML file, but total size of output becames bigger(because Base64 encoding of binaries is in use) and not all browsers (especially legacy) successfully process binaries embedded into HTML. But it allows get HTML that contains whole result, without any additional files.

EmbedCssOnly 

Enforces put apart all referenced files except CSS (Images and Fonts) I.e. CSS will be embedded into result HTML , and all other referenced files(Images and Fonts) will be processed as external parts It generates HTML that is sutable for wide set of browsers

NoEmbedding 

Enforces put apart referenced files(Css,Images,Fonts) This approach generates set of files, but total size of output becames smaller(because no Base64 encoding of binaries is in use) Also such approach generates HTML that is sutable for wide set of browsers

◆ RasterImagesSavingModes

Enumerator
AsPngImagesEmbeddedIntoSvg 

for each distinct raster file will be generated wrapper SVG image, and raster image will be embedded as Base64 encoded strings into that SVG image

AsExternalPngFilesReferencedViaSvg 

distinct raster images will be put apart as PNG files but will be referenced through wrapping SVG images, i.e. will be generated one PNG file and one SVG for each raster image, and each of such SVGs will contain links to relevant PNG file

AsEmbeddedPartsOfPngPageBackground 

Will be generated one big PNG background file for each result page. Raster images will be embedded into that file and rendered as regions of that image. No external PNG files for each image will be generated, only one PNG file per page will be present in conversion result set of files.

Constructor & Destructor Documentation

◆ HtmlSaveOptions() [1/4]

Aspose::Pdf::HtmlSaveOptions::HtmlSaveOptions ( )

Initializes a new instance of the HtmlSaveOptions class.

◆ HtmlSaveOptions() [2/4]

Aspose::Pdf::HtmlSaveOptions::HtmlSaveOptions ( HtmlDocumentType  documentType)

Initializes a new instance of the HtmlSaveOptions class.

Parameters
documentTypeThe HtmlDocumentType.

◆ HtmlSaveOptions() [3/4]

Aspose::Pdf::HtmlSaveOptions::HtmlSaveOptions ( bool  fixedLayout)

Initializes a new instance of the HtmlSaveOptions class.

Parameters
fixedLayoutif set to true HTML is created as fixed layout.

◆ HtmlSaveOptions() [4/4]

Aspose::Pdf::HtmlSaveOptions::HtmlSaveOptions ( HtmlDocumentType  documentType,
bool  fixedLayout 
)

Initializes a new instance of the HtmlSaveOptions class.

Parameters
documentTypeThe HtmlDocumentType.
fixedLayoutif set to true HTML is created as fixed layout.

Member Function Documentation

◆ CheckParametersConsistensyAndThrowExceptionOtherwise()

void Aspose::Pdf::HtmlSaveOptions::CheckParametersConsistensyAndThrowExceptionOtherwise ( bool  targetIsStream)
protected

◆ get_AdditionalMarginWidthInPoints()

int32_t Aspose::Pdf::HtmlSaveOptions::get_AdditionalMarginWidthInPoints ( )

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.

◆ get_CompressSvgGraphicsIfAny()

bool Aspose::Pdf::HtmlSaveOptions::get_CompressSvgGraphicsIfAny ( )

Gets the flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving

The HtmlDocumentType.

◆ get_ConvertMarkedContentToLayers()

bool Aspose::Pdf::HtmlSaveOptions::get_ConvertMarkedContentToLayers ( )

If attribute ConvertMarkedContentToLayers set to true then an all elements inside a PDF marked content (layer) will be put into an HTML

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()

System::String Aspose::Pdf::HtmlSaveOptions::get_DefaultFontName ( )

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()

Aspose::Pdf::Direction Aspose::Pdf::HtmlSaveOptions::get_Direction ( )
protected

This attribute determines text direction in converted document.

◆ get_DocumentType()

HtmlDocumentType Aspose::Pdf::HtmlSaveOptions::get_DocumentType ( )

◆ get_FixedLayout()

bool Aspose::Pdf::HtmlSaveOptions::get_FixedLayout ( )

Gets a value indicating whether that HTML is created as fixed layout.

true if [fixed layout]; otherwise, false.

◆ get_FlowLayoutParagraphFullWidth()

bool Aspose::Pdf::HtmlSaveOptions::get_FlowLayoutParagraphFullWidth ( )

This attribute specifies full width paragraph text for Flow mode, FixedLayout = false

◆ get_FontSources()

System::SharedPtr<Text::FontSourceCollection> Aspose::Pdf::HtmlSaveOptions::get_FontSources ( )

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()

int32_t Aspose::Pdf::HtmlSaveOptions::get_ImageResolution ( )

Gets resolution for image rendering.

Resolution

◆ get_MinimalLineWidth()

float Aspose::Pdf::HtmlSaveOptions::get_MinimalLineWidth ( )

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()

bool Aspose::Pdf::HtmlSaveOptions::get_PreventGlyphsGrouping ( )

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_ProcessingBatchSize()

int32_t Aspose::Pdf::HtmlSaveOptions::get_ProcessingBatchSize ( )

For a PDF document with many pages the conversion may take a long time or hang. This attribute specifies the number of pages for the batch conversion mode. Example: 'ProcessingBatchSize = 20 pages, Pdf.Size = 100 pages'. Aspose.PDF converts 5 times by 20 pages to one HTLM file.

◆ get_SimpleTextboxModeGrouping()

bool Aspose::Pdf::HtmlSaveOptions::get_SimpleTextboxModeGrouping ( )

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()

bool Aspose::Pdf::HtmlSaveOptions::get_SplitCssIntoPages ( )

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()

bool Aspose::Pdf::HtmlSaveOptions::get_SplitIntoPages ( )

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_UseZOrder()

bool Aspose::Pdf::HtmlSaveOptions::get_UseZOrder ( )

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()

void Aspose::Pdf::HtmlSaveOptions::ResetInternals ( )
protected

◆ set_AdditionalMarginWidthInPoints()

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.

◆ set_CompressSvgGraphicsIfAny()

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()

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

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()

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()

void Aspose::Pdf::HtmlSaveOptions::set_Direction ( Aspose::Pdf::Direction  value)
protected

This attribute determines text direction in converted document.

◆ set_DocumentType()

void Aspose::Pdf::HtmlSaveOptions::set_DocumentType ( HtmlDocumentType  value)

◆ set_FixedLayout()

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()

void Aspose::Pdf::HtmlSaveOptions::set_FlowLayoutParagraphFullWidth ( bool  value)

This attribute specifies full width paragraph text for Flow mode, FixedLayout = false

◆ set_ImageResolution()

void Aspose::Pdf::HtmlSaveOptions::set_ImageResolution ( int32_t  value)

Sets resolution for image rendering.

Resolution

◆ set_MinimalLineWidth()

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()

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_ProcessingBatchSize()

void Aspose::Pdf::HtmlSaveOptions::set_ProcessingBatchSize ( int32_t  value)

For a PDF document with many pages the conversion may take a long time or hang. This attribute specifies the number of pages for the batch conversion mode. Example: 'ProcessingBatchSize = 20 pages, Pdf.Size = 100 pages'. Aspose.PDF converts 5 times by 20 pages to one HTLM file.

◆ set_SimpleTextboxModeGrouping()

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()

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()

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_UseZOrder()

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

◆ CssClassNamesPrefix

System::String Aspose::Pdf::HtmlSaveOptions::CssClassNamesPrefix

◆ CustomCssSavingStrategy

HtmlSaveOptions::CssSavingStrategy Aspose::Pdf::HtmlSaveOptions::CustomCssSavingStrategy

◆ CustomHtmlSavingStrategy

HtmlSaveOptions::HtmlPageMarkupSavingStrategy Aspose::Pdf::HtmlSaveOptions::CustomHtmlSavingStrategy

◆ CustomProgressHandler

UnifiedSaveOptions::ConversionProgressEventHandler Aspose::Pdf::HtmlSaveOptions::CustomProgressHandler

◆ CustomResourceSavingStrategy

HtmlSaveOptions::ResourceSavingStrategy Aspose::Pdf::HtmlSaveOptions::CustomResourceSavingStrategy

◆ CustomStrategyOfCssUrlCreation

HtmlSaveOptions::CssUrlMakingStrategy Aspose::Pdf::HtmlSaveOptions::CustomStrategyOfCssUrlCreation

◆ ExcludeFontNameList

System::ArrayPtr<System::String> Aspose::Pdf::HtmlSaveOptions::ExcludeFontNameList

◆ ExplicitListOfSavedPages

System::ArrayPtr<int32_t> Aspose::Pdf::HtmlSaveOptions::ExplicitListOfSavedPages

◆ FontEncodingStrategy

HtmlSaveOptions::FontEncodingRules Aspose::Pdf::HtmlSaveOptions::FontEncodingStrategy

◆ FontSavingMode

HtmlSaveOptions::FontSavingModes Aspose::Pdf::HtmlSaveOptions::FontSavingMode

◆ HtmlMarkupGenerationMode

HtmlSaveOptions::HtmlMarkupGenerationModes Aspose::Pdf::HtmlSaveOptions::HtmlMarkupGenerationMode

◆ LettersPositioningMethod

HtmlSaveOptions::LettersPositioningMethods Aspose::Pdf::HtmlSaveOptions::LettersPositioningMethod

◆ PageBorderIfAny

System::SharedPtr<SaveOptions::BorderInfo> Aspose::Pdf::HtmlSaveOptions::PageBorderIfAny

◆ PagesFlowTypeDependsOnViewersScreenSize

bool Aspose::Pdf::HtmlSaveOptions::PagesFlowTypeDependsOnViewersScreenSize

◆ PartsEmbeddingMode

HtmlSaveOptions::PartsEmbeddingModes Aspose::Pdf::HtmlSaveOptions::PartsEmbeddingMode

◆ RasterImagesSavingMode

HtmlSaveOptions::RasterImagesSavingModes Aspose::Pdf::HtmlSaveOptions::RasterImagesSavingMode

◆ RemoveEmptyAreasOnTopAndBottom

bool Aspose::Pdf::HtmlSaveOptions::RemoveEmptyAreasOnTopAndBottom

◆ SaveShadowedTextsAsTransparentTexts

bool Aspose::Pdf::HtmlSaveOptions::SaveShadowedTextsAsTransparentTexts

◆ SaveTransparentTexts

bool Aspose::Pdf::HtmlSaveOptions::SaveTransparentTexts

◆ SpecialFolderForAllImages

System::String Aspose::Pdf::HtmlSaveOptions::SpecialFolderForAllImages

◆ SpecialFolderForSvgImages

System::String Aspose::Pdf::HtmlSaveOptions::SpecialFolderForSvgImages

◆ TrySaveTextUnderliningAndStrikeoutingInCss

bool Aspose::Pdf::HtmlSaveOptions::TrySaveTextUnderliningAndStrikeoutingInCss