HtmlFixedSaveOptions

HtmlFixedSaveOptions class

可用于在将文档保存到HtmlFixed格式.

要了解更多信息,请访问指定保存选项文档文章。

public class HtmlFixedSaveOptions : FixedPageSaveOptions

构造函数

姓名描述
HtmlFixedSaveOptions()默认构造函数。

特性

姓名描述
AllowEmbeddingPostScriptFonts { get; set; }获取或设置一个布尔值,指示在保存的文档中嵌入 TrueType 字体时是否允许使用 PostScript 轮廓嵌入字体。 默认值为错误的.
ColorMode { get; set; }获取或设置一个确定颜色呈现方式的值。
CssClassNamesPrefix { get; set; }指定添加到 style.css 文件中所有类名的前缀。 默认值为“噢”.
CustomTimeZoneInfo { get; set; }获取或设置用于日期/时间字段的自定义本地时区。
DefaultTemplate { get; set; }获取或设置默认模板的路径(包括文件名)。 此属性的默认值为空字符串(Empty).
Dml3DEffectsRenderingMode { get; set; }获取或设置一个确定如何渲染 3D 效果的值。
virtual DmlEffectsRenderingMode { get; set; }获取或设置一个值,确定如何呈现 DrawingML 效果。
DmlRenderingMode { get; set; }获取或设置一个值,确定如何呈现 DrawingML 形状。
Encoding { get; set; }指定导出为 HTML 时使用的编码。 默认值为新的UTF8编码(真)(带 BOM 的 UTF-8).
ExportEmbeddedCss { get; set; }指定 CSS(层叠样式表)是否应嵌入到 Html 文档中。
ExportEmbeddedFonts { get; set; }指定字体是否应以 Base64 格式嵌入到 Html 文档中。 请注意,设置此标志会显着增加输出 Html 文件的大小。
ExportEmbeddedImages { get; set; }指定图像是否应以 Base64 格式嵌入到 Html 文档中。 请注意,设置此标志会显着增加输出 Html 文件的大小。
ExportEmbeddedSvg { get; set; }指定 SVG 资源是否应嵌入到 Html 文档中。 默认值为真的.
ExportFormFields { get; set; }获取或设置表单字段是否导出为交互 项目(作为“输入”标记)而不是转换为文本或图形的指示。
ExportGeneratorName { get; set; }真的 ,导致 Aspose.Words 的名称和版本嵌入到生成的文件中。 默认值为真的.
FontFormat { get; set; }获取或设置ExportFontFormat用于字体导出。 默认值为Woff.
ImlRenderingMode { get; set; }获取或设置一个值,确定如何呈现墨迹 (InkML) 对象。
JpegQuality { get; set; }获取或设置决定 Html 文档内 JPEG 图像质量的值。
MemoryOptimization { get; set; }获取或设置确定在保存文档之前是否应执行内存优化的值。 此属性的默认值为错误的.
MetafileRenderingOptions { get; set; }允许指定图元文件渲染选项。
NumeralFormat { get; set; }获取或设置NumeralFormat用于呈现数字。 默认使用欧洲数字。
override OptimizeOutput { get; set; }标志指示是否需要优化输出。 如果设置此标志,则冗余嵌套画布并删除空画布, 还将连接具有相同格式的相邻字形。 注意:如果出现以下情况,内容显示的准确性可能会受到影响该属性设置为真的. 默认为真的.
PageHorizontalAlignment { get; set; }指定 HTML 文档中页面的水平对齐方式。 默认值为Center.
PageMargins { get; set; }指定 HTML 文档中页面周围的边距。 边距值以磅为单位测量,应等于或大于 0。 默认值为 10 磅。
PageSavingCallback { get; set; }允许控制将文档导出为固定页面格式时如何保存单独的页面。
PageSet { get; set; }获取或设置要呈现的页面。 默认为文档中的所有页面。
PrettyFormat { get; set; }真的,在适用的情况下漂亮的格式输出。 默认值为错误的.
ProgressCallback { get; set; }在保存文档期间调用并接受有关保存进度的数据。
ResourceSavingCallback { get; set; }允许控制当文档导出为固定页面 Html 格式时如何保存资源(图像、字体和 CSS)。
ResourcesFolder { get; set; }指定将文档导出为 Html 格式时保存资源(图像、字体、css)的物理文件夹。 默认为无效的.
ResourcesFolderAlias { get; set; }指定用于构建写入 Html 文档的图像 URI 的文件夹的名称。 默认为无效的.
SaveFontFaceCssSeparately { get; set; }标志指示当使用外部样式表保存文档时(即,当ExportEmbeddedCss错误的). 默认值为错误的,所有 CSS 规则都写入单个文件“styles.css”.
override SaveFormat { get; set; }指定使用此保存选项对象时保存文档的格式。 只能是HtmlFixed.
ShowPageBorder { get; set; }指定是否应显示页面周围的边框。 默认为真的.
TempFolder { get; set; }指定保存到 DOC 或 DOCX 文件时使用的临时文件的文件夹。 默认情况下,此属性为无效的并且没有使用临时文件。
UpdateCreatedTimeProperty { get; set; }获取或设置一个值,确定是否CreatedTime属性在保存前更新。 默认值为错误的;
UpdateFields { get; set; }获取或设置一个值,确定在将文档保存为固定页面格式之前是否应更新某些类型的字段。 此属性的默认值为真的.
UpdateLastPrintedProperty { get; set; }获取或设置一个值,确定是否LastPrinted属性在保存前更新。
UpdateLastSavedTimeProperty { get; set; }获取或设置一个值,确定是否LastSavedTime属性在保存前更新。
UseAntiAliasing { get; set; }获取或设置一个值,确定是否使用抗锯齿进行渲染。
UseHighQualityRendering { get; set; }获取或设置一个值,确定是否使用高质量(即慢速)渲染算法。
UseTargetMachineFonts { get; set; }标志指示是否必须使用来自目标计算机的字体来显示文档。 如果此标志设置为真的,FontFormatExportEmbeddedFonts属性没有效果, 也ResourceSavingCallback不会针对字体触发。 默认为错误的.

方法

姓名描述
override Equals(object)确定指定对象的值是否等于当前对象。

例子

演示如何使用回调来打印在将文档转换为 HTML 时创建的外部资源的 URI。

public void HtmlFixedResourceFolder()
{
    Document doc = new Document(MyDir + "Rendering.docx");

    ResourceUriPrinter callback = new ResourceUriPrinter();

    HtmlFixedSaveOptions options = new HtmlFixedSaveOptions
    {
        SaveFormat = SaveFormat.HtmlFixed,
        ExportEmbeddedImages = false,
        ResourcesFolder = ArtifactsDir + "HtmlFixedResourceFolder",
        ResourcesFolderAlias = ArtifactsDir + "HtmlFixedResourceFolderAlias",
        ShowPageBorder = false,
        ResourceSavingCallback = callback
    };

    // 由 ResourcesFolderAlias 指定的文件夹将包含资源而不是 ResourcesFolder。
    // 我们必须确保该文件夹存在,然后流才能将其资源放入其中。
    Directory.CreateDirectory(options.ResourcesFolderAlias);

    doc.Save(ArtifactsDir + "HtmlFixedSaveOptions.HtmlFixedResourceFolder.html", options);

    Console.WriteLine(callback.GetText());

    string[] resourceFiles = Directory.GetFiles(ArtifactsDir + "HtmlFixedResourceFolderAlias");

    Assert.False(Directory.Exists(ArtifactsDir + "HtmlFixedResourceFolder"));
    Assert.AreEqual(6, resourceFiles.Count(f => f.EndsWith(".jpeg") || f.EndsWith(".png") || f.EndsWith(".css")));
}

/// <summary>
/// 计算并打印 包含的资源的 URI,因为它们被转换为固定的 HTML。
/// </summary>
private class ResourceUriPrinter : IResourceSavingCallback
{
    void IResourceSavingCallback.ResourceSaving(ResourceSavingArgs args)
    {
        // 如果我们在 SaveOptions 对象中设置文件夹别名,我们将能够从这里打印它。
        mText.AppendLine($"Resource #{++mSavedResourceCount} \"{args.ResourceFileName}\"");

        string extension = Path.GetExtension(args.ResourceFileName);
        switch (extension)
        {
            case ".ttf":
            case ".woff":
            {
                // 默认情况下,“ResourceFileUri”使用系统文件夹来存储字体。
                // 为了避免在其他平台上出现问题,您必须显式指定字体的路径。
                args.ResourceFileUri = ArtifactsDir + Path.DirectorySeparatorChar + args.ResourceFileName;
                break;
            }
        }

        mText.AppendLine("\t" + args.ResourceFileUri);

        // 如果我们在“ResourcesFolderAlias”属性中指定了一个文件夹,
        // 我们还需要重定向每个流以将其资源放入该文件夹中。
        args.ResourceStream = new FileStream(args.ResourceFileUri, FileMode.Create);
        args.KeepResourceStreamOpen = false;
    }

    public string GetText()
    {
        return mText.ToString();
    }

    private int mSavedResourceCount;
    private readonly StringBuilder mText = new StringBuilder();
}

也可以看看