HtmlFixedSaveOptions Class |
Namespace: Aspose.Words.Saving
The HtmlFixedSaveOptions type exposes the following members.
Name | Description | |
---|---|---|
![]() | HtmlFixedSaveOptions | Initializes a new instance of the HtmlFixedSaveOptions class |
Name | Description | |
---|---|---|
![]() ![]() | ColorMode |
Gets or sets a value determining how colors are rendered.
(Inherited from FixedPageSaveOptions.) |
![]() ![]() | CssClassNamesPrefix |
Specifies prefix which is added to all class names in style.css file.
Default value is "aw".
|
![]() ![]() | DefaultTemplate |
Gets or sets path to default template (including filename).
Default value for this property is empty string (Empty).
(Inherited from SaveOptions.) |
![]() ![]() | DmlEffectsRenderingMode |
Gets or sets a value determining how DrawingML effects are rendered.
(Inherited from SaveOptions.) |
![]() ![]() | DmlRenderingMode |
Gets or sets a value determining how DrawingML shapes are rendered.
(Inherited from SaveOptions.) |
![]() ![]() | Encoding |
Specifies the encoding to use when exporting to HTML.
Default value is new UTF8Encoding(true) (UTF-8 with BOM).
|
![]() ![]() | ExportEmbeddedCss |
Specifies whether the CSS (Cascading Style Sheet) should be embedded into Html document.
|
![]() ![]() | ExportEmbeddedFonts |
Specifies whether fonts should be embedded into Html document in Base64 format.
Note setting this flag can significantly increase size of output Html file.
|
![]() ![]() | ExportEmbeddedImages |
Specifies whether images should be embedded into Html document in Base64 format.
Note setting this flag can significantly increase size of output Html file.
|
![]() ![]() | ExportEmbeddedSvg |
Specifies whether SVG resources should be embedded into Html document.
Default value is true.
|
![]() ![]() | ExportFormFields |
Gets or sets indication of whether form fields are exported as interactive
items (as 'input' tag) rather than converted to text or graphics.
|
![]() ![]() | FontFormat |
Gets or sets ExportFontFormat used for font exporting.
Default value is Woff.
|
![]() ![]() | JpegQuality |
Gets or sets a value determining the quality of the JPEG images inside Html document.
(Inherited from FixedPageSaveOptions.) |
![]() ![]() | MemoryOptimization |
Gets or sets value determining if memory optimization should be performed before saving the document.
Default value for this property is false.
(Inherited from SaveOptions.) |
![]() ![]() | MetafileRenderingOptions |
Allows to specify metafile rendering options.
(Inherited from FixedPageSaveOptions.) |
![]() ![]() | NumeralFormat |
Gets or sets NumeralFormat used for rendering of numerals.
European numerals are used by default.
(Inherited from FixedPageSaveOptions.) |
![]() ![]() | OptimizeOutput |
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.
(Overrides FixedPageSaveOptionsOptimizeOutput.) |
![]() ![]() | PageCount |
Gets or sets the number of pages to save.
Default is MaxValue which means all pages of the document will be rendered.
(Inherited from FixedPageSaveOptions.) |
![]() ![]() | PageHorizontalAlignment |
Specifies the horizontal alignment of pages in an HTML document.
Default value is HtmlFixedHorizontalPageAlignment.Center.
|
![]() ![]() | PageIndex |
Gets or sets the 0-based index of the first page to save.
Default is 0.
(Inherited from FixedPageSaveOptions.) |
![]() ![]() | PageMargins |
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.
|
![]() ![]() | PageSavingCallback |
Allows to control how separate pages are saved when a document is exported to fixed page format.
(Inherited from FixedPageSaveOptions.) |
![]() ![]() | PrettyFormat |
When true, pretty formats output where applicable.
Default value is false.
(Inherited from SaveOptions.) |
![]() ![]() | ResourceSavingCallback |
Allows to control how resources (images, fonts and css) are saved when a document is exported to fixed page Html format.
|
![]() ![]() | ResourcesFolder |
Specifies the physical folder where resources (images, fonts, css) are saved when exporting a document to Html format.
Default is null.
|
![]() ![]() | ResourcesFolderAlias |
Specifies the name of the folder used to construct image URIs written into an Html document.
Default is null.
|
![]() ![]() | SaveFontFaceCssSeparately |
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".
|
![]() ![]() | SaveFormat |
Specifies the format in which the document will be saved if this save options object is used.
Can only be HtmlFixed.
(Overrides SaveOptionsSaveFormat.) |
![]() ![]() | ShowPageBorder |
Specifies whether border around pages should be shown.
Default is true.
|
![]() ![]() | TempFolder |
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.
(Inherited from SaveOptions.) |
![]() ![]() | UpdateFields |
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.
(Inherited from SaveOptions.) |
![]() | UpdateLastPrintedProperty |
Gets or sets a value determining whether the LastPrinted property is updated before saving.
(Inherited from SaveOptions.) |
![]() ![]() | UpdateLastSavedTimeProperty |
Gets or sets a value determining whether the LastSavedTime property is updated before saving.
(Inherited from SaveOptions.) |
![]() ![]() | UpdateSdtContent |
Gets or sets value determining whether content of StructuredDocumentTag is updated before saving.
(Inherited from SaveOptions.) |
![]() ![]() | UseAntiAliasing |
Gets or sets a value determining whether or not to use anti-aliasing for rendering.
(Inherited from SaveOptions.) |
![]() ![]() | UseHighQualityRendering |
Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
(Inherited from SaveOptions.) |
![]() ![]() | UseTargetMachineFonts |
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.
|
Name | Description | |
---|---|---|
![]() | Equals | (Inherited from FixedPageSaveOptions.) |
![]() | GetHashCode | (Inherited from Object.) |
![]() | GetType | (Inherited from Object.) |
![]() | ToString | (Inherited from Object.) |
public void HtmlFixedResourceFolder() { // Open a document which contains images Document doc = new Document(MyDir + "Rendering.docx"); HtmlFixedSaveOptions options = new HtmlFixedSaveOptions { SaveFormat = SaveFormat.HtmlFixed, ExportEmbeddedImages = false, ResourcesFolder = ArtifactsDir + "HtmlFixedResourceFolder", ResourcesFolderAlias = ArtifactsDir + "HtmlFixedResourceFolderAlias", ShowPageBorder = false, ResourceSavingCallback = new ResourceUriPrinter() }; // A folder specified by ResourcesFolderAlias will contain the resources instead of ResourcesFolder // We must ensure the folder exists before the streams can put their resources into it Directory.CreateDirectory(options.ResourcesFolderAlias); doc.Save(ArtifactsDir + "HtmlFixedSaveOptions.HtmlFixedResourceFolder.html", options); } /// <summary> /// Counts and prints URIs of resources contained by as they are converted to fixed .Html /// </summary> private class ResourceUriPrinter : IResourceSavingCallback { void IResourceSavingCallback.ResourceSaving(ResourceSavingArgs args) { // If we set a folder alias in the SaveOptions object, it will be printed here Console.WriteLine($"Resource #{++mSavedResourceCount} \"{args.ResourceFileName}\""); string extension = Path.GetExtension(args.ResourceFileName); switch (extension) { case ".ttf": case ".woff": { // By default 'ResourceFileUri' used system folder for fonts // To avoid problems across platforms you must explicitly specify the path for the fonts args.ResourceFileUri = ArtifactsDir + Path.DirectorySeparatorChar + args.ResourceFileName; break; } } Console.WriteLine("\t" + args.ResourceFileUri); // If we specified a ResourcesFolderAlias we will also need to redirect each stream to put its resource in that folder args.ResourceStream = new FileStream(args.ResourceFileUri, FileMode.Create); args.KeepResourceStreamOpen = false; } private int mSavedResourceCount; }