Aspose::Words::Saving::XamlFixedSaveOptions class

XamlFixedSaveOptions class

Can be used to specify additional options when saving a document into the XamlFixed format. To learn more, visit the Specify Save Options documentation article.

class XamlFixedSaveOptions : public Aspose::Words::Saving::FixedPageSaveOptions

Methods

Method	Description
static CreateSaveOptions(Aspose::Words::SaveFormat)	Creates a save options object of a class suitable for the specified save format.
static CreateSaveOptions(const System::String&)	Creates a save options object of a class suitable for the file extension specified in the given file name.
Equals(System::SharedPtr<System::Object>) override	Determines whether the specified object is equal in value to the current object.
get_AllowEmbeddingPostScriptFonts() const	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.
get_ColorMode() const	Gets or sets a value determining how colors are rendered.
get_CustomTimeZoneInfo() const
get_DefaultTemplate() const	Gets or sets path to default template (including filename). Default value for this property is empty string.
get_Dml3DEffectsRenderingMode() const	Gets a value determining how 3D effects are rendered.
virtual get_DmlEffectsRenderingMode()	Gets or sets a value determining how DrawingML effects are rendered.
get_DmlRenderingMode() const	Gets or sets a value determining how DrawingML shapes are rendered.
get_ExportGeneratorName() const	When true, causes the name and version of Aspose.Words to be embedded into produced files. Default value is true.
get_ImlRenderingMode() const	Gets or sets a value determining how ink (InkML) objects are rendered.
get_JpegQuality() const	Gets or sets a value determining the quality of the JPEG images inside Html document.
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.
get_MetafileRenderingOptions() const	Allows to specify metafile rendering options.
get_NumeralFormat() const	Gets or sets NumeralFormat used for rendering of numerals. European numerals are used by default.
virtual get_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 formatting are concatenated. Note: The accuracy of the content display may be affected if this property is set to true. Default is false.
get_PageSavingCallback() const	Allows to control how separate pages are saved when a document is exported to fixed page format.
get_PageSet() const	Gets or sets the pages to render. Default is all the pages in the document.
get_PrettyFormat() const	When true, pretty formats output where applicable. Default value is false.
get_ProgressCallback() const	Called during saving a document and accepts data about saving progress.
get_ResourceSavingCallback() const	Allows to control how resources (images and fonts) are saved when a document is exported to fixed page Xaml format.
get_ResourcesFolder() const	Specifies the physical folder where resources (images and fonts) are saved when exporting a document to fixed page Xaml format. Default is null.
get_ResourcesFolderAlias() const	Specifies the name of the folder used to construct image URIs written into an fixed page Xaml document. Default is null.
get_SaveFormat() override	Specifies the format in which the document will be saved if this save options object is used. Can only be XamlFixed.
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.
get_UpdateCreatedTimeProperty() const	Gets a value determining whether the CreatedTime property is updated before saving. Default value is false;.
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.
get_UpdateLastPrintedProperty() const	Gets or sets a value determining whether the LastPrinted property is updated before saving.
get_UpdateLastSavedTimeProperty() const	Gets or sets a value determining whether the LastSavedTime property is updated before saving.
get_UseAntiAliasing() const	Gets or sets a value determining whether or not to use anti-aliasing for rendering.
get_UseHighQualityRendering() const	Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
GetType() const override
Is(const System::TypeInfo&) const override
set_AllowEmbeddingPostScriptFonts(bool)	Setter for Aspose::Words::Saving::SaveOptions::get_AllowEmbeddingPostScriptFonts.
set_ColorMode(Aspose::Words::Saving::ColorMode)	Setter for Aspose::Words::Saving::FixedPageSaveOptions::get_ColorMode.
set_CustomTimeZoneInfo(const System::SharedPtr<System::TimeZoneInfo>&)
set_DefaultTemplate(const System::String&)	Setter for Aspose::Words::Saving::SaveOptions::get_DefaultTemplate.
set_Dml3DEffectsRenderingMode(Aspose::Words::Saving::Dml3DEffectsRenderingMode)	Sets a value determining how 3D effects are rendered.
virtual set_DmlEffectsRenderingMode(Aspose::Words::Saving::DmlEffectsRenderingMode)	Setter for Aspose::Words::Saving::SaveOptions::get_DmlEffectsRenderingMode.
set_DmlRenderingMode(Aspose::Words::Saving::DmlRenderingMode)	Setter for Aspose::Words::Saving::SaveOptions::get_DmlRenderingMode.
set_ExportGeneratorName(bool)	Setter for Aspose::Words::Saving::SaveOptions::get_ExportGeneratorName.
set_ImlRenderingMode(Aspose::Words::Saving::ImlRenderingMode)	Setter for Aspose::Words::Saving::SaveOptions::get_ImlRenderingMode.
set_JpegQuality(int32_t)	Setter for Aspose::Words::Saving::FixedPageSaveOptions::get_JpegQuality.
set_MemoryOptimization(bool)	Setter for Aspose::Words::Saving::SaveOptions::get_MemoryOptimization.
set_MetafileRenderingOptions(const System::SharedPtr<Aspose::Words::Saving::MetafileRenderingOptions>&)	Setter for Aspose::Words::Saving::FixedPageSaveOptions::get_MetafileRenderingOptions.
set_NumeralFormat(Aspose::Words::Saving::NumeralFormat)	Setter for Aspose::Words::Saving::FixedPageSaveOptions::get_NumeralFormat.
virtual set_OptimizeOutput(bool)	Setter for Aspose::Words::Saving::FixedPageSaveOptions::get_OptimizeOutput.
set_PageSavingCallback(const System::SharedPtr<Aspose::Words::Saving::IPageSavingCallback>&)	Setter for Aspose::Words::Saving::FixedPageSaveOptions::get_PageSavingCallback.
set_PageSet(const System::SharedPtr<Aspose::Words::Saving::PageSet>&)	Setter for Aspose::Words::Saving::FixedPageSaveOptions::get_PageSet.
set_PrettyFormat(bool)	Setter for Aspose::Words::Saving::SaveOptions::get_PrettyFormat.
set_ProgressCallback(const System::SharedPtr<Aspose::Words::Saving::IDocumentSavingCallback>&)	Setter for Aspose::Words::Saving::SaveOptions::get_ProgressCallback.
set_ResourceSavingCallback(const System::SharedPtr<Aspose::Words::Saving::IResourceSavingCallback>&)	Setter for Aspose::Words::Saving::XamlFixedSaveOptions::get_ResourceSavingCallback.
set_ResourcesFolder(const System::String&)	Setter for Aspose::Words::Saving::XamlFixedSaveOptions::get_ResourcesFolder.
set_ResourcesFolderAlias(const System::String&)	Setter for Aspose::Words::Saving::XamlFixedSaveOptions::get_ResourcesFolderAlias.
set_SaveFormat(Aspose::Words::SaveFormat) override	Setter for Aspose::Words::Saving::XamlFixedSaveOptions::get_SaveFormat.
set_TempFolder(const System::String&)	Setter for Aspose::Words::Saving::SaveOptions::get_TempFolder.
set_UpdateCreatedTimeProperty(bool)	Sets a value determining whether the CreatedTime property is updated before saving. Default value is false;.
set_UpdateFields(bool)	Setter for Aspose::Words::Saving::SaveOptions::get_UpdateFields.
set_UpdateLastPrintedProperty(bool)	Setter for Aspose::Words::Saving::SaveOptions::get_UpdateLastPrintedProperty.
set_UpdateLastSavedTimeProperty(bool)	Setter for Aspose::Words::Saving::SaveOptions::get_UpdateLastSavedTimeProperty.
set_UseAntiAliasing(bool)	Setter for Aspose::Words::Saving::SaveOptions::get_UseAntiAliasing.
set_UseHighQualityRendering(bool)	Setter for Aspose::Words::Saving::SaveOptions::get_UseHighQualityRendering.
static Type()

Examples

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

void ResourceFolder()
{
    auto doc = MakeObject<Document>(MyDir + u"Rendering.docx");
    auto callback = MakeObject<ExXamlFixedSaveOptions::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.
    auto options = MakeObject<XamlFixedSaveOptions>();

    ASSERT_EQ(SaveFormat::XamlFixed, options->get_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->set_ResourcesFolder(ArtifactsDir + u"XamlFixedResourceFolder");

    // Use the "ResourcesFolderAlias" property to use this folder
    // when constructing image URIs instead of the resources folder's name.
    options->set_ResourcesFolderAlias(ArtifactsDir + u"XamlFixedFolderAlias");

    options->set_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.
    System::IO::Directory::CreateDirectory_(options->get_ResourcesFolderAlias());

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

    for (const auto& resource : callback->get_Resources())
    {
        std::cout << resource << std::endl;
    }
}

class ResourceUriPrinter : public IResourceSavingCallback
{
public:
    SharedPtr<System::Collections::Generic::List<String>> get_Resources()
    {
        return pr_Resources;
    }

    ResourceUriPrinter()
    {
        pr_Resources = MakeObject<System::Collections::Generic::List<String>>();
    }

private:
    SharedPtr<System::Collections::Generic::List<String>> pr_Resources;

    void ResourceSaving(SharedPtr<ResourceSavingArgs> args) override
    {
        get_Resources()->Add(String::Format(u"Resource \"{0}\"\n\t{1}", args->get_ResourceFileName(), args->get_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->set_ResourceStream(MakeObject<System::IO::FileStream>(args->get_ResourceFileUri(), System::IO::FileMode::Create));
        args->set_KeepResourceStreamOpen(false);
    }
};

Aspose::Words::Saving::XamlFixedSaveOptions class

XamlFixedSaveOptions class

Methods

Examples

See Also