Aspose::Words::Saving::HtmlFixedSaveOptions Class Reference

Detailed Description

Can be used to specify additional options when saving a document into the HtmlFixed format.

#include <Aspose.Words.Cpp/Model/Saving/HtmlFixedSaveOptions.h>

+ Inheritance diagram for Aspose::Words::Saving::HtmlFixedSaveOptions:

Public Member Functions

 HtmlFixedSaveOptions ()
 
String get_CssClassNamesPrefix () const
 Specifies prefix which is added to all class names in style.css file. Default value is "aw". More...
 
SharedPtr< Encodingget_Encoding () const
 Specifies the encoding to use when exporting to HTML. Default value is new UTF8Encoding(true) (UTF-8 with BOM). More...
 
bool get_ExportEmbeddedCss () const
 Specifies whether the CSS (Cascading Style Sheet) should be embedded into Html document. More...
 
bool get_ExportEmbeddedFonts () const
 Specifies whether fonts should be embedded into Html document in Base64 format. Note setting this flag can significantly increase size of output Html file. More...
 
bool get_ExportEmbeddedImages () const
 Specifies whether images should be embedded into Html document in Base64 format. Note setting this flag can significantly increase size of output Html file. More...
 
bool get_ExportEmbeddedSvg () const
 Specifies whether SVG resources should be embedded into Html document. Default value is true. More...
 
bool get_ExportFormFields () const
 Gets or sets indication of whether form fields are exported as interactive items (as 'input' tag) rather than converted to text or graphics. More...
 
ExportFontFormat get_FontFormat () const
 Gets ExportFontFormat used for font exporting. Default value is Woff. More...
 
bool get_OptimizeOutput () override
 Flag indicates whether it is required to optimize output. If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formating are concatenated. Note: The accuracy of the content display may be affected if this property is set to true. Default is true. More...
 
HtmlFixedPageHorizontalAlignment get_PageHorizontalAlignment () const
 Specifies the horizontal alignment of pages in an HTML document. Default value is HtmlFixedHorizontalPageAlignment.Center. More...
 
double get_PageMargins () const
 Specifies the margins around pages in an HTML document. The margins value is measured in points and should be equal to or greater than 0. Default value is 10 points. More...
 
SharedPtr< IResourceSavingCallbackget_ResourceSavingCallback () const
 Allows to control how resources (images, fonts and css) are saved when a document is exported to fixed page Html format. More...
 
String get_ResourcesFolder () const
 Specifies the physical folder where resources (images, fonts, css) are saved when exporting a document to Html format. Default is null. More...
 
String get_ResourcesFolderAlias () const
 Specifies the name of the folder used to construct image URIs written into an Html document. Default is null. More...
 
bool get_SaveFontFaceCssSeparately () const
 Flag indicates whether "@font-face" CSS rules should be placed into a separate file "fontFaces.css" when a document is being saved with external stylesheet (that is, when ExportEmbeddedCss is false). Default value is false, all CSS rules are written into single file "styles.css". More...
 
SaveFormat get_SaveFormat () override
 Specifies the format in which the document will be saved if this save options object is used. Can only be HtmlFixed. More...
 
bool get_ShowPageBorder () const
 Specifies whether border around pages should be shown. Default is true. More...
 
bool get_UseTargetMachineFonts () const
 Flag indicates whether fonts from target machine must be used to display the document. If this flag is set to true, FontFormat and ExportEmbeddedFonts properties do not have effect, also ResourceSavingCallback is not fired for fonts. Default is false. More...
 
virtual const TypeInfoGetType () const override
 
virtual bool Is (const TypeInfo &target) const override
 
void set_CssClassNamesPrefix (String value)
 Setter for get_CssClassNamesPrefix. More...
 
void set_Encoding (SharedPtr< Encoding > value)
 Setter for get_Encoding. More...
 
void set_ExportEmbeddedCss (bool value)
 Setter for get_ExportEmbeddedCss. More...
 
void set_ExportEmbeddedFonts (bool value)
 Setter for get_ExportEmbeddedFonts. More...
 
void set_ExportEmbeddedImages (bool value)
 Setter for get_ExportEmbeddedImages. More...
 
void set_ExportEmbeddedSvg (bool value)
 Setter for get_ExportEmbeddedSvg. More...
 
void set_ExportFormFields (bool value)
 Setter for get_ExportFormFields. More...
 
void set_FontFormat (ExportFontFormat value)
 Sets ExportFontFormat used for font exporting. Default value is Woff. More...
 
void set_OptimizeOutput (bool value) override
 Setter for get_OptimizeOutput. More...
 
void set_PageHorizontalAlignment (HtmlFixedPageHorizontalAlignment value)
 Setter for get_PageHorizontalAlignment. More...
 
void set_PageMargins (double value)
 Setter for get_PageMargins. More...
 
void set_ResourceSavingCallback (SharedPtr< IResourceSavingCallback > value)
 Allows to control how resources (images, fonts and css) are saved when a document is exported to fixed page Html format. More...
 
void set_ResourcesFolder (String value)
 Setter for get_ResourcesFolder. More...
 
void set_ResourcesFolderAlias (String value)
 Setter for get_ResourcesFolderAlias. More...
 
void set_SaveFontFaceCssSeparately (bool value)
 Setter for get_SaveFontFaceCssSeparately. More...
 
void set_SaveFormat (SaveFormat value) override
 Specifies the format in which the document will be saved if this save options object is used. Can only be HtmlFixed. More...
 
void set_ShowPageBorder (bool value)
 Specifies whether border around pages should be shown. Default is true. More...
 
void set_UseTargetMachineFonts (bool value)
 Setter for get_UseTargetMachineFonts. More...
 
- Public Member Functions inherited from FixedPageSaveOptions
bool Equals (SharedPtr< Object > obj) override
 Determines whether the specified object is equal in value to the current object. More...
 
ColorMode get_ColorMode () const
 Gets or sets a value determining how colors are rendered. More...
 
int32_t get_JpegQuality () const
 Gets or sets a value determining the quality of the JPEG images inside Html document. More...
 
SharedPtr< MetafileRenderingOptionsget_MetafileRenderingOptions () const
 Allows to specify metafile rendering options. More...
 
NumeralFormat get_NumeralFormat () const
 Gets or sets NumeralFormat used for rendering of numerals. European numerals are used by default. More...
 
int32_t get_PageCount () const
 Gets or sets the number of pages to save. Default is MaxValue which means all pages of the document will be rendered. More...
 
int32_t get_PageIndex () const
 Gets or sets the 0-based index of the first page to save. Default is 0. More...
 
SharedPtr< IPageSavingCallbackget_PageSavingCallback () const
 Allows to control how separate pages are saved when a document is exported to fixed page format. More...
 
SharedPtr< PageSetget_PageSet () const
 Gets the pages to render. Default is all the pages in the document. More...
 
void set_ColorMode (ColorMode value)
 Setter for get_ColorMode. More...
 
void set_JpegQuality (int32_t value)
 Setter for get_JpegQuality. More...
 
void set_MetafileRenderingOptions (SharedPtr< MetafileRenderingOptions > value)
 Allows to specify metafile rendering options. More...
 
void set_NumeralFormat (NumeralFormat value)
 Setter for get_NumeralFormat. More...
 
void set_PageCount (int32_t value)
 Setter for get_PageCount. More...
 
void set_PageIndex (int32_t value)
 Setter for get_PageIndex. More...
 
void set_PageSavingCallback (SharedPtr< IPageSavingCallback > value)
 Allows to control how separate pages are saved when a document is exported to fixed page format. More...
 
void set_PageSet (SharedPtr< PageSet > value)
 Sets the pages to render. Default is all the pages in the document. More...
 
- Public Member Functions inherited from SaveOptions
String get_DefaultTemplate () const
 Gets or sets path to default template (including filename). Default value for this property is empty string (Empty). More...
 
Dml3DEffectsRenderingMode get_Dml3DEffectsRenderingMode () const
 Gets a value determining how 3D effects are rendered. More...
 
virtual DmlEffectsRenderingMode get_DmlEffectsRenderingMode ()
 Gets or sets a value determining how DrawingML effects are rendered. More...
 
DmlRenderingMode get_DmlRenderingMode () const
 Gets or sets a value determining how DrawingML shapes are rendered. More...
 
bool get_MemoryOptimization () const
 Gets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false. More...
 
bool get_PrettyFormat () const
 When true, pretty formats output where applicable. Default value is false. More...
 
String get_TempFolder () const
 Specifies the folder for temporary files used when saving to a DOC or DOCX file. By default this property is null and no temporary files are used. More...
 
bool get_UpdateFields () const
 Gets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. Default value for this property is true. More...
 
bool get_UpdateLastPrintedProperty () const
 Gets or sets a value determining whether the LastPrinted property is updated before saving. More...
 
bool get_UpdateLastSavedTimeProperty () const
 Gets or sets a value determining whether the LastSavedTime property is updated before saving. More...
 
bool get_UpdateSdtContent () const
 Gets or sets value determining whether content of StructuredDocumentTag is updated before saving. More...
 
bool get_UseAntiAliasing () const
 Gets or sets a value determining whether or not to use anti-aliasing for rendering. More...
 
bool get_UseHighQualityRendering () const
 Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. More...
 
void set_DefaultTemplate (String value)
 Setter for get_DefaultTemplate. More...
 
void set_Dml3DEffectsRenderingMode (Dml3DEffectsRenderingMode value)
 Sets a value determining how 3D effects are rendered. More...
 
virtual void set_DmlEffectsRenderingMode (DmlEffectsRenderingMode value)
 Setter for get_DmlEffectsRenderingMode. More...
 
void set_DmlRenderingMode (DmlRenderingMode value)
 Setter for get_DmlRenderingMode. More...
 
void set_MemoryOptimization (bool value)
 Setter for get_MemoryOptimization. More...
 
void set_PrettyFormat (bool value)
 Setter for get_PrettyFormat. More...
 
void set_TempFolder (String value)
 Setter for get_TempFolder. More...
 
void set_UpdateFields (bool value)
 Setter for get_UpdateFields. More...
 
void set_UpdateLastPrintedProperty (bool value)
 Setter for get_UpdateLastPrintedProperty. More...
 
void set_UpdateLastSavedTimeProperty (bool value)
 Setter for get_UpdateLastSavedTimeProperty. More...
 
void set_UpdateSdtContent (bool value)
 Setter for get_UpdateSdtContent. More...
 
void set_UseAntiAliasing (bool value)
 Setter for get_UseAntiAliasing. More...
 
void set_UseHighQualityRendering (bool value)
 Setter for get_UseHighQualityRendering. More...
 
- Public Member Functions inherited from Object
ASPOSECPP_SHARED_API Object ()
 
ASPOSECPP_SHARED_API Object (Object const &x)
 
virtual ASPOSECPP_SHARED_API ~Object ()
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 
Detail::SmartPtrCounter * GetCounter ()
 
virtual ASPOSECPP_SHARED_API int GetHashCode () const
 
ASPOSECPP_SHARED_API void Lock ()
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 
Objectoperator= (Object const &x)
 
bool ReferenceEquals (String const &str, std::nullptr_t)
 
bool ReferenceEquals (String const &str1, String const &str2)
 
int RemovedSharedRefs (int count)
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument)
 
int SharedCount () const
 
ObjectSharedRefAdded ()
 
int SharedRefRemovedSafe ()
 
virtual ASPOSECPP_SHARED_API String ToString () const
 
ASPOSECPP_SHARED_API void Unlock ()
 
Detail::SmartPtrCounter * WeakRefAdded ()
 
void WeakRefRemoved ()
 

Static Public Member Functions

static const TypeInfoType ()
 
- Static Public Member Functions inherited from FixedPageSaveOptions
static const TypeInfoType ()
 
- Static Public Member Functions inherited from SaveOptions
static SharedPtr< SaveOptionsCreateSaveOptions (SaveFormat saveFormat)
 Creates a save options object of a class suitable for the specified save format. More...
 
static SharedPtr< SaveOptionsCreateSaveOptions (String fileName)
 Creates a save options object of a class suitable for the file extension specified in the given file name. More...
 
static const TypeInfoType ()
 
- Static Public Member Functions inherited from Object
bool Equals (double const &objA, double const &objB)
 
bool Equals (float const &objA, float const &objB)
 
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 
static const TypeInfoType ()
 

Additional Inherited Members

- Public Types inherited from Object
typedef SmartPtr< Objectptr
 
typedef System::Details::SharedMembersType shared_members_type
 

Constructor & Destructor Documentation

◆ HtmlFixedSaveOptions()

Aspose::Words::Saving::HtmlFixedSaveOptions::HtmlFixedSaveOptions ( )

Member Function Documentation

◆ get_CssClassNamesPrefix()

System::String Aspose::Words::Saving::HtmlFixedSaveOptions::get_CssClassNamesPrefix ( ) const

Specifies prefix which is added to all class names in style.css file. Default value is "aw".

Examples

Shows how to add prefix to all class names in css file.

auto doc = MakeObject<Document>(MyDir + u"Bookmarks.docx");
auto htmlFixedSaveOptions = MakeObject<HtmlFixedSaveOptions>();
htmlFixedSaveOptions->set_CssClassNamesPrefix(u"myprefix");
htmlFixedSaveOptions->set_SaveFontFaceCssSeparately(true);
doc->Save(ArtifactsDir + u"HtmlFixedSaveOptions.AddCssClassNamesPrefix.html", htmlFixedSaveOptions);
String outDocContents = System::IO::File::ReadAllText(ArtifactsDir + u"HtmlFixedSaveOptions.AddCssClassNamesPrefix.html");
ASSERT_TRUE(System::Text::RegularExpressions::Regex::Match(outDocContents, String(u"<div class=\"myprefixdiv myprefixpage\" style=\"width:595[.]3pt; height:841[.]9pt;\">") + u"<div class=\"myprefixdiv\" style=\"left:85[.]05pt; top:36pt; clip:rect[(]0pt,510[.]25pt,74[.]95pt,-85.05pt[)];\">" + u"<span class=\"myprefixspan myprefixtext001\" style=\"font-size:11pt; left:294[.]73pt; top:0[.]36pt;\">")->get_Success());

◆ get_Encoding()

System::SharedPtr<System::Text::Encoding> Aspose::Words::Saving::HtmlFixedSaveOptions::get_Encoding ( ) const

Specifies the encoding to use when exporting to HTML. Default value is new UTF8Encoding(true) (UTF-8 with BOM).

Examples

Shows how to set encoding while exporting to HTML.

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->Writeln(u"Hello World!");
// The default encoding is UTF-8
// If we want to represent our document using a different encoding, we can set one explicitly using a SaveOptions object
auto htmlFixedSaveOptions = MakeObject<HtmlFixedSaveOptions>();
htmlFixedSaveOptions->set_Encoding(System::Text::Encoding::GetEncoding(u"ASCII"));
ASSERT_EQ(u"US-ASCII", htmlFixedSaveOptions->get_Encoding()->get_EncodingName());
doc->Save(ArtifactsDir + u"HtmlFixedSaveOptions.UseEncoding.html", htmlFixedSaveOptions);

◆ get_ExportEmbeddedCss()

bool Aspose::Words::Saving::HtmlFixedSaveOptions::get_ExportEmbeddedCss ( ) const

Specifies whether the CSS (Cascading Style Sheet) should be embedded into Html document.

Examples

Shows how to export embedded stylesheets into an HTML file.

auto doc = MakeObject<Document>(MyDir + u"Rendering.docx");
auto htmlFixedSaveOptions = MakeObject<HtmlFixedSaveOptions>();
htmlFixedSaveOptions->set_ExportEmbeddedCss(doExportEmbeddedCss);
doc->Save(ArtifactsDir + u"HtmlFixedSaveOptions.ExportEmbeddedCSS.html", htmlFixedSaveOptions);
String outDocContents = System::IO::File::ReadAllText(ArtifactsDir + u"HtmlFixedSaveOptions.ExportEmbeddedCSS.html");
if (doExportEmbeddedCss)
{
ASSERT_TRUE(System::Text::RegularExpressions::Regex::Match(outDocContents, u"<style type=\"text/css\">")->get_Success());
ASSERT_FALSE(System::IO::File::Exists(ArtifactsDir + u"HtmlFixedSaveOptions.ExportEmbeddedCSS/styles.css"));
}
else
{
ASSERT_TRUE(System::Text::RegularExpressions::Regex::Match(outDocContents, u"<link rel=\"stylesheet\" type=\"text/css\" href=\"HtmlFixedSaveOptions[.]ExportEmbeddedCSS/styles[.]css\" media=\"all\" />")->get_Success());
ASSERT_TRUE(System::IO::File::Exists(ArtifactsDir + u"HtmlFixedSaveOptions.ExportEmbeddedCSS/styles.css"));
}

◆ get_ExportEmbeddedFonts()

bool Aspose::Words::Saving::HtmlFixedSaveOptions::get_ExportEmbeddedFonts ( ) const

Specifies whether fonts should be embedded into Html document in Base64 format. Note setting this flag can significantly increase size of output Html file.

Examples

Shows how to export embedded fonts into an HTML file.

auto doc = MakeObject<Document>(MyDir + u"Embedded font.docx");
auto htmlFixedSaveOptions = MakeObject<HtmlFixedSaveOptions>();
htmlFixedSaveOptions->set_ExportEmbeddedFonts(doExportEmbeddedFonts);
doc->Save(ArtifactsDir + u"HtmlFixedSaveOptions.ExportEmbeddedFonts.html", htmlFixedSaveOptions);
String outDocContents = System::IO::File::ReadAllText(ArtifactsDir + u"HtmlFixedSaveOptions.ExportEmbeddedFonts/styles.css");
if (doExportEmbeddedFonts)
{
ASSERT_TRUE(System::Text::RegularExpressions::Regex::Match(outDocContents, u"@font-face { font-family:'Arial'; font-style:normal; font-weight:normal; src:local[(]'☺'[)], url[(].+[)] format[(]'woff'[)]; }")->get_Success());
ASSERT_EQ(0, System::IO::Directory::GetFiles(ArtifactsDir + u"HtmlFixedSaveOptions.ExportEmbeddedFonts")->LINQ_Count([](String f) { return f.EndsWith(u".woff"); }));
}
else
{
ASSERT_TRUE(System::Text::RegularExpressions::Regex::Match(outDocContents, u"@font-face { font-family:'Arial'; font-style:normal; font-weight:normal; src:local[(]'☺'[)], url[(]'font001[.]woff'[)] format[(]'woff'[)]; }")->get_Success());
ASSERT_EQ(2, System::IO::Directory::GetFiles(ArtifactsDir + u"HtmlFixedSaveOptions.ExportEmbeddedFonts")->LINQ_Count([](String f) { return f.EndsWith(u".woff"); }));
}

◆ get_ExportEmbeddedImages()

bool Aspose::Words::Saving::HtmlFixedSaveOptions::get_ExportEmbeddedImages ( ) const

Specifies whether images should be embedded into Html document in Base64 format. Note setting this flag can significantly increase size of output Html file.

Examples

Shows how to export embedded images into an HTML file.

auto doc = MakeObject<Document>(MyDir + u"Images.docx");
auto htmlFixedSaveOptions = MakeObject<HtmlFixedSaveOptions>();
htmlFixedSaveOptions->set_ExportEmbeddedImages(doExportImages);
doc->Save(ArtifactsDir + u"HtmlFixedSaveOptions.ExportEmbeddedImages.html", htmlFixedSaveOptions);
String outDocContents = System::IO::File::ReadAllText(ArtifactsDir + u"HtmlFixedSaveOptions.ExportEmbeddedImages.html");
if (doExportImages)
{
ASSERT_FALSE(System::IO::File::Exists(ArtifactsDir + u"HtmlFixedSaveOptions.ExportEmbeddedImages/image001.jpeg"));
ASSERT_TRUE(System::Text::RegularExpressions::Regex::Match(outDocContents, u"<img class=\"awimg\" style=\"left:0pt; top:0pt; width:493.1pt; height:300.55pt;\" src=\".+\" />")->get_Success());
}
else
{
ASSERT_TRUE(System::IO::File::Exists(ArtifactsDir + u"HtmlFixedSaveOptions.ExportEmbeddedImages/image001.jpeg"));
ASSERT_TRUE(System::Text::RegularExpressions::Regex::Match(outDocContents, String(u"<img class=\"awimg\" style=\"left:0pt; top:0pt; width:493.1pt; height:300.55pt;\" ") + u"src=\"HtmlFixedSaveOptions[.]ExportEmbeddedImages/image001[.]jpeg\" />")->get_Success());
}

◆ get_ExportEmbeddedSvg()

bool Aspose::Words::Saving::HtmlFixedSaveOptions::get_ExportEmbeddedSvg ( ) const

Specifies whether SVG resources should be embedded into Html document. Default value is true.

Examples

Shows how to export embedded SVG objects into an HTML file.

auto doc = MakeObject<Document>(MyDir + u"Images.docx");
auto htmlFixedSaveOptions = MakeObject<HtmlFixedSaveOptions>();
htmlFixedSaveOptions->set_ExportEmbeddedSvg(doExportSvgs);
doc->Save(ArtifactsDir + u"HtmlFixedSaveOptions.ExportEmbeddedSvgs.html", htmlFixedSaveOptions);
String outDocContents = System::IO::File::ReadAllText(ArtifactsDir + u"HtmlFixedSaveOptions.ExportEmbeddedSvgs.html");
if (doExportSvgs)
{
ASSERT_FALSE(System::IO::File::Exists(ArtifactsDir + u"HtmlFixedSaveOptions.ExportEmbeddedSvgs/svg001.svg"));
ASSERT_TRUE(System::Text::RegularExpressions::Regex::Match(outDocContents, u"<image id=\"image004\" xlink:href=.+/>")->get_Success());
}
else
{
ASSERT_TRUE(System::IO::File::Exists(ArtifactsDir + u"HtmlFixedSaveOptions.ExportEmbeddedSvgs/svg001.svg"));
ASSERT_TRUE(System::Text::RegularExpressions::Regex::Match(outDocContents, u"<object type=\"image/svg[+]xml\" data=\"HtmlFixedSaveOptions.ExportEmbeddedSvgs/svg001[.]svg\"></object>")->get_Success());
}

◆ get_ExportFormFields()

bool Aspose::Words::Saving::HtmlFixedSaveOptions::get_ExportFormFields ( ) const

Gets or sets indication of whether form fields are exported as interactive items (as 'input' tag) rather than converted to text or graphics.

Examples

Show how to exporting form fields from a document into HTML file.

auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->InsertCheckBox(u"CheckBox", false, 15);
auto htmlFixedSaveOptions = MakeObject<HtmlFixedSaveOptions>();
htmlFixedSaveOptions->set_ExportFormFields(doExportFormFields);
doc->Save(ArtifactsDir + u"HtmlFixedSaveOptions.ExportFormFields.html", htmlFixedSaveOptions);
String outDocContents = System::IO::File::ReadAllText(ArtifactsDir + u"HtmlFixedSaveOptions.ExportFormFields.html");
if (doExportFormFields)
{
ASSERT_TRUE(System::Text::RegularExpressions::Regex::Match(outDocContents, String(u"<a name=\"CheckBox\" style=\"left:0pt; top:0pt;\"></a>") + u"<input style=\"position:absolute; left:0pt; top:0pt;\" type=\"checkbox\" name=\"CheckBox\" />")->get_Success());
}
else
{
ASSERT_TRUE(System::Text::RegularExpressions::Regex::Match(outDocContents, String(u"<a name=\"CheckBox\" style=\"left:0pt; top:0pt;\"></a>") + u"<div class=\"awdiv\" style=\"left:0.8pt; top:0.8pt; width:14.25pt; height:14.25pt; border:solid 0.75pt #000000;\"")->get_Success());
}

◆ get_FontFormat()

Aspose::Words::Saving::ExportFontFormat Aspose::Words::Saving::HtmlFixedSaveOptions::get_FontFormat ( ) const

Gets ExportFontFormat used for font exporting. Default value is Woff.

◆ get_OptimizeOutput()

bool Aspose::Words::Saving::HtmlFixedSaveOptions::get_OptimizeOutput ( )
overridevirtual

Flag indicates whether it is required to optimize output. If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formating are concatenated. Note: The accuracy of the content display may be affected if this property is set to true. Default is true.

Examples

Shows how to optimize document objects while saving to html.

auto doc = MakeObject<Document>(MyDir + u"Rendering.docx");
auto saveOptions = MakeObject<HtmlFixedSaveOptions>();
saveOptions->set_OptimizeOutput(false);
doc->Save(ArtifactsDir + u"HtmlFixedSaveOptions.OptimizeGraphicsOutput.Unoptimized.html", saveOptions);
saveOptions->set_OptimizeOutput(true);
doc->Save(ArtifactsDir + u"HtmlFixedSaveOptions.OptimizeGraphicsOutput.Optimized.html", saveOptions);
ASSERT_TRUE(MakeObject<System::IO::FileInfo>(ArtifactsDir + u"HtmlFixedSaveOptions.OptimizeGraphicsOutput.Unoptimized.html")->get_Length() > MakeObject<System::IO::FileInfo>(ArtifactsDir + u"HtmlFixedSaveOptions.OptimizeGraphicsOutput.Optimized.html")->get_Length());

Reimplemented from Aspose::Words::Saving::FixedPageSaveOptions.

◆ get_PageHorizontalAlignment()

Aspose::Words::Saving::HtmlFixedPageHorizontalAlignment Aspose::Words::Saving::HtmlFixedSaveOptions::get_PageHorizontalAlignment ( ) const

Specifies the horizontal alignment of pages in an HTML document. Default value is HtmlFixedHorizontalPageAlignment.Center.

Examples

Shows how to set the horizontal alignment of pages in HTML file.

auto doc = MakeObject<Document>(MyDir + u"Rendering.docx");
auto htmlFixedSaveOptions = MakeObject<HtmlFixedSaveOptions>();
htmlFixedSaveOptions->set_PageHorizontalAlignment(pageHorizontalAlignment);
doc->Save(ArtifactsDir + u"HtmlFixedSaveOptions.HorizontalAlignment.html", htmlFixedSaveOptions);
String outDocContents = System::IO::File::ReadAllText(ArtifactsDir + u"HtmlFixedSaveOptions.HorizontalAlignment/styles.css");
switch (pageHorizontalAlignment)
{
ASSERT_TRUE(System::Text::RegularExpressions::Regex::Match(outDocContents, u"[.]awpage { position:relative; border:solid 1pt black; margin:10pt auto 10pt auto; overflow:hidden; }")->get_Success());
break;
ASSERT_TRUE(System::Text::RegularExpressions::Regex::Match(outDocContents, u"[.]awpage { position:relative; border:solid 1pt black; margin:10pt auto 10pt 10pt; overflow:hidden; }")->get_Success());
break;
ASSERT_TRUE(System::Text::RegularExpressions::Regex::Match(outDocContents, u"[.]awpage { position:relative; border:solid 1pt black; margin:10pt 10pt 10pt auto; overflow:hidden; }")->get_Success());
break;
}

◆ get_PageMargins()

double Aspose::Words::Saving::HtmlFixedSaveOptions::get_PageMargins ( ) const

Specifies the margins around pages in an HTML document. The margins value is measured in points and should be equal to or greater than 0. Default value is 10 points.

Depends on the value of PageHorizontalAlignment property:

  • Defines top, bottom and left page margins if the value is Left.
  • Defines top, bottom and right page margins if the value is Right.
  • Defines top and bottom page margins if the value is Center.
Examples

Shows how to set the margins around pages in HTML file.

auto doc = MakeObject<Document>(MyDir + u"Document.docx");
auto saveOptions = MakeObject<HtmlFixedSaveOptions>();
saveOptions->set_PageMargins(15);
doc->Save(ArtifactsDir + u"HtmlFixedSaveOptions.PageMargins.html", saveOptions);
String outDocContents = System::IO::File::ReadAllText(ArtifactsDir + u"HtmlFixedSaveOptions.PageMargins/styles.css");
ASSERT_TRUE(System::Text::RegularExpressions::Regex::Match(outDocContents, u"[.]awpage { position:relative; border:solid 1pt black; margin:15pt auto 15pt auto; overflow:hidden; }")->get_Success());

◆ get_ResourceSavingCallback()

System::SharedPtr<Aspose::Words::Saving::IResourceSavingCallback> Aspose::Words::Saving::HtmlFixedSaveOptions::get_ResourceSavingCallback ( ) const

Allows to control how resources (images, fonts and css) are saved when a document is exported to fixed page Html format.

◆ get_ResourcesFolder()

System::String Aspose::Words::Saving::HtmlFixedSaveOptions::get_ResourcesFolder ( ) const

Specifies the physical folder where resources (images, fonts, css) are saved when exporting a document to Html format. Default is null.

Has effect only if ExportEmbeddedImages property is false.

When you save a Document in Html format, Aspose.Words needs to save all images embedded in the document as standalone files. ResourcesFolder allows you to specify where the images will be saved and ResourcesFolderAlias allows to specify how the image URIs will be constructed.

If you save a document into a file and provide a file name, Aspose.Words, by default, saves the images in the same folder where the document file is saved. Use ResourcesFolder to override this behavior.

If you save a document into a stream, Aspose.Words does not have a folder where to save the images, but still needs to save the images somewhere. In this case, you need to specify an accessible folder by using the ResourcesFolder property

See also
Aspose::Words::Saving::HtmlFixedSaveOptions::get_ResourcesFolderAlias

◆ get_ResourcesFolderAlias()

System::String Aspose::Words::Saving::HtmlFixedSaveOptions::get_ResourcesFolderAlias ( ) const

Specifies the name of the folder used to construct image URIs written into an Html document. Default is null.

When you save a Document in Html format, Aspose.Words needs to save all images embedded in the document as standalone files. ResourcesFolder allows you to specify where the images will be saved and ResourcesFolderAlias allows to specify how the image URIs will be constructed.

See also
Aspose::Words::Saving::HtmlFixedSaveOptions::get_ResourcesFolder

◆ get_SaveFontFaceCssSeparately()

bool Aspose::Words::Saving::HtmlFixedSaveOptions::get_SaveFontFaceCssSeparately ( ) const

Flag indicates whether "@font-face" CSS rules should be placed into a separate file "fontFaces.css" when a document is being saved with external stylesheet (that is, when ExportEmbeddedCss is false). Default value is false, all CSS rules are written into single file "styles.css".

Examples

Shows how to add prefix to all class names in css file.

auto doc = MakeObject<Document>(MyDir + u"Bookmarks.docx");
auto htmlFixedSaveOptions = MakeObject<HtmlFixedSaveOptions>();
htmlFixedSaveOptions->set_CssClassNamesPrefix(u"myprefix");
htmlFixedSaveOptions->set_SaveFontFaceCssSeparately(true);
doc->Save(ArtifactsDir + u"HtmlFixedSaveOptions.AddCssClassNamesPrefix.html", htmlFixedSaveOptions);
String outDocContents = System::IO::File::ReadAllText(ArtifactsDir + u"HtmlFixedSaveOptions.AddCssClassNamesPrefix.html");
ASSERT_TRUE(System::Text::RegularExpressions::Regex::Match(outDocContents, String(u"<div class=\"myprefixdiv myprefixpage\" style=\"width:595[.]3pt; height:841[.]9pt;\">") + u"<div class=\"myprefixdiv\" style=\"left:85[.]05pt; top:36pt; clip:rect[(]0pt,510[.]25pt,74[.]95pt,-85.05pt[)];\">" + u"<span class=\"myprefixspan myprefixtext001\" style=\"font-size:11pt; left:294[.]73pt; top:0[.]36pt;\">")->get_Success());

◆ get_SaveFormat()

Aspose::Words::SaveFormat Aspose::Words::Saving::HtmlFixedSaveOptions::get_SaveFormat ( )
overridevirtual

Specifies the format in which the document will be saved if this save options object is used. Can only be HtmlFixed.

Implements Aspose::Words::Saving::SaveOptions.

◆ get_ShowPageBorder()

bool Aspose::Words::Saving::HtmlFixedSaveOptions::get_ShowPageBorder ( ) const

Specifies whether border around pages should be shown. Default is true.

◆ get_UseTargetMachineFonts()

bool Aspose::Words::Saving::HtmlFixedSaveOptions::get_UseTargetMachineFonts ( ) const

Flag indicates whether fonts from target machine must be used to display the document. If this flag is set to true, FontFormat and ExportEmbeddedFonts properties do not have effect, also ResourceSavingCallback is not fired for fonts. Default is false.

◆ GetType()

virtual const System::TypeInfo& Aspose::Words::Saving::HtmlFixedSaveOptions::GetType ( ) const
overridevirtual

◆ Is()

virtual bool Aspose::Words::Saving::HtmlFixedSaveOptions::Is ( const System::TypeInfo target) const
overridevirtual

◆ set_CssClassNamesPrefix()

void Aspose::Words::Saving::HtmlFixedSaveOptions::set_CssClassNamesPrefix ( System::String  value)

◆ set_Encoding()

void Aspose::Words::Saving::HtmlFixedSaveOptions::set_Encoding ( System::SharedPtr< System::Text::Encoding value)

◆ set_ExportEmbeddedCss()

void Aspose::Words::Saving::HtmlFixedSaveOptions::set_ExportEmbeddedCss ( bool  value)

◆ set_ExportEmbeddedFonts()

void Aspose::Words::Saving::HtmlFixedSaveOptions::set_ExportEmbeddedFonts ( bool  value)

◆ set_ExportEmbeddedImages()

void Aspose::Words::Saving::HtmlFixedSaveOptions::set_ExportEmbeddedImages ( bool  value)

◆ set_ExportEmbeddedSvg()

void Aspose::Words::Saving::HtmlFixedSaveOptions::set_ExportEmbeddedSvg ( bool  value)

◆ set_ExportFormFields()

void Aspose::Words::Saving::HtmlFixedSaveOptions::set_ExportFormFields ( bool  value)

◆ set_FontFormat()

void Aspose::Words::Saving::HtmlFixedSaveOptions::set_FontFormat ( Aspose::Words::Saving::ExportFontFormat  value)

Sets ExportFontFormat used for font exporting. Default value is Woff.

◆ set_OptimizeOutput()

void Aspose::Words::Saving::HtmlFixedSaveOptions::set_OptimizeOutput ( bool  value)
overridevirtual

◆ set_PageHorizontalAlignment()

void Aspose::Words::Saving::HtmlFixedSaveOptions::set_PageHorizontalAlignment ( Aspose::Words::Saving::HtmlFixedPageHorizontalAlignment  value)

◆ set_PageMargins()

void Aspose::Words::Saving::HtmlFixedSaveOptions::set_PageMargins ( double  value)

◆ set_ResourceSavingCallback()

void Aspose::Words::Saving::HtmlFixedSaveOptions::set_ResourceSavingCallback ( System::SharedPtr< Aspose::Words::Saving::IResourceSavingCallback value)

Allows to control how resources (images, fonts and css) are saved when a document is exported to fixed page Html format.

◆ set_ResourcesFolder()

void Aspose::Words::Saving::HtmlFixedSaveOptions::set_ResourcesFolder ( System::String  value)

◆ set_ResourcesFolderAlias()

void Aspose::Words::Saving::HtmlFixedSaveOptions::set_ResourcesFolderAlias ( System::String  value)

◆ set_SaveFontFaceCssSeparately()

void Aspose::Words::Saving::HtmlFixedSaveOptions::set_SaveFontFaceCssSeparately ( bool  value)

◆ set_SaveFormat()

void Aspose::Words::Saving::HtmlFixedSaveOptions::set_SaveFormat ( Aspose::Words::SaveFormat  value)
overridevirtual

Specifies the format in which the document will be saved if this save options object is used. Can only be HtmlFixed.

Implements Aspose::Words::Saving::SaveOptions.

◆ set_ShowPageBorder()

void Aspose::Words::Saving::HtmlFixedSaveOptions::set_ShowPageBorder ( bool  value)

Specifies whether border around pages should be shown. Default is true.

◆ set_UseTargetMachineFonts()

void Aspose::Words::Saving::HtmlFixedSaveOptions::set_UseTargetMachineFonts ( bool  value)

◆ Type()

static const System::TypeInfo& Aspose::Words::Saving::HtmlFixedSaveOptions::Type ( )
static
String
@ Right
Align pages to the right.
@ Center
Center pages. This is the default value.
static ASPOSECPP_SHARED_API String ReadAllText(const String &path, const EncodingPtr &encoding=Text::Encoding::get_UTF8())
static ASPOSECPP_SHARED_API ArrayPtr< String > GetFiles(const String &path, const String &searchPattern=u"*", SearchOption searchOption=SearchOption::TopDirectoryOnly)
static ASPOSECPP_SHARED_API EncodingPtr GetEncoding(const String &name)
static ASPOSECPP_SHARED_API bool Exists(const String &path)
@ Left
Align pages to the left.
friend friend class Match