XamlFixedSaveOptions

XamlFixedSaveOptions class

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

public class XamlFixedSaveOptions : FixedPageSaveOptions

Constructors

Name Description
XamlFixedSaveOptions() The default constructor.

Properties

Name Description
AllowEmbeddingPostScriptFonts { get; set; } Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is false.
ColorMode { get; set; } Gets or sets a value determining how colors are rendered.
CustomTimeZoneInfo { get; set; } Gets or sets custom local time zone used for date/time fields.
DefaultTemplate { get; set; } Gets or sets path to default template (including filename). Default value for this property is empty string (Empty).
Dml3DEffectsRenderingMode { get; set; } Gets or sets a value determining how 3D effects are rendered.
virtual DmlEffectsRenderingMode { get; set; } Gets or sets a value determining how DrawingML effects are rendered.
DmlRenderingMode { get; set; } Gets or sets a value determining how DrawingML shapes are rendered.
ExportGeneratorName { get; set; } When true, causes the name and version of Aspose.Words to be embedded into produced files. Default value is true.
ImlRenderingMode { get; set; } Gets or sets a value determining how ink (InkML) objects are rendered.
JpegQuality { get; set; } Gets or sets a value determining the quality of the JPEG images inside Html document.
MemoryOptimization { get; set; } Gets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false.
MetafileRenderingOptions { get; set; } Allows to specify metafile rendering options.
NumeralFormat { get; set; } Gets or sets NumeralFormat used for rendering of numerals. European numerals are used by default.
virtual OptimizeOutput { get; set; } 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 formatting are concatenated. Note: The accuracy of the content display may be affected if this property is set to true. Default is false.
PageSavingCallback { get; set; } Allows to control how separate pages are saved when a document is exported to fixed page format.
PageSet { get; set; } Gets or sets the pages to render. Default is all the pages in the document.
PrettyFormat { get; set; } When true, pretty formats output where applicable. Default value is false.
ProgressCallback { get; set; } Called during saving a document and accepts data about saving progress.
ResourceSavingCallback { get; set; } Allows to control how resources (images and fonts) are saved when a document is exported to fixed page Xaml format.
ResourcesFolder { get; set; } Specifies the physical folder where resources (images and fonts) are saved when exporting a document to fixed page Xaml format. Default is null.
ResourcesFolderAlias { get; set; } Specifies the name of the folder used to construct image URIs written into an fixed page Xaml document. Default is null.
override SaveFormat { get; set; } Specifies the format in which the document will be saved if this save options object is used. Can only be XamlFixed.
TempFolder { get; set; } 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.
UpdateCreatedTimeProperty { get; set; } Gets or sets a value determining whether the CreatedTime property is updated before saving. Default value is false;
UpdateFields { get; set; } 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.
UpdateLastPrintedProperty { get; set; } Gets or sets a value determining whether the LastPrinted property is updated before saving.
UpdateLastSavedTimeProperty { get; set; } Gets or sets a value determining whether the LastSavedTime property is updated before saving.
UpdateSdtContent { get; set; } Gets or sets value determining whether content of StructuredDocumentTag is updated before saving.
UseAntiAliasing { get; set; } Gets or sets a value determining whether or not to use anti-aliasing for rendering.
UseHighQualityRendering { get; set; } Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.

Methods

Name Description
override Equals(object) Determines whether the specified object is equal in value to the current object.

Examples

Shows how to print the URIs of linked resources created while converting a document to fixed-form .xaml.

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

    // Create a "XamlFixedSaveOptions" object, which we can pass to the document's "Save" method
    // to modify how we save the document to the XAML save format.
    XamlFixedSaveOptions options = new XamlFixedSaveOptions();

    Assert.AreEqual(SaveFormat.XamlFixed, options.SaveFormat);

    // Use the "ResourcesFolder" property to assign a folder in the local file system into which
    // Aspose.Words will save all the document's linked resources, such as images and fonts.
    options.ResourcesFolder = ArtifactsDir + "XamlFixedResourceFolder";

    // Use the "ResourcesFolderAlias" property to use this folder
    // when constructing image URIs instead of the resources folder's name.
    options.ResourcesFolderAlias = ArtifactsDir + "XamlFixedFolderAlias";

    options.ResourceSavingCallback = callback;

    // A folder specified by "ResourcesFolderAlias" will need to contain the resources instead of "ResourcesFolder".
    // We must ensure the folder exists before the callback's streams can put their resources into it.
    Directory.CreateDirectory(options.ResourcesFolderAlias);

    doc.Save(ArtifactsDir + "XamlFixedSaveOptions.ResourceFolder.xaml", options);

    foreach (string resource in callback.Resources)
        Console.WriteLine(resource);
}

/// <summary>
/// Counts and prints URIs of resources created during conversion to fixed .xaml.
/// </summary>
private class ResourceUriPrinter : IResourceSavingCallback
{
    public ResourceUriPrinter()
    {
        Resources = new List<string>();
    }

    void IResourceSavingCallback.ResourceSaving(ResourceSavingArgs args)
    {
        Resources.Add($"Resource \"{args.ResourceFileName}\"\n\t{args.ResourceFileUri}");

        // If we specified a resource folder alias, we would also need
        // to redirect each stream to put its resource in the alias folder.
        args.ResourceStream = new FileStream(args.ResourceFileUri, FileMode.Create);
        args.KeepResourceStreamOpen = false;
    }

    public List<string> Resources { get; }
}

See Also