Class XamlFlowSaveOptions
Namespace: Aspose.Words.Saving
Assembly: Aspose.Words.dll (25.3.0)
Can be used to specify additional options when saving a document into the Aspose.Words.SaveFormat.XamlFlow or Aspose.Words.SaveFormat.XamlFlowPack format.
To learn more, visit the Specify Save Options documentation article.
public class XamlFlowSaveOptions : SaveOptionsInheritance
object ← SaveOptions ← XamlFlowSaveOptions
Inherited Members
SaveOptions.CreateSaveOptions(SaveFormat), SaveOptions.CreateSaveOptions(string), SaveOptions.SaveFormat, SaveOptions.ExportGeneratorName, SaveOptions.TempFolder, SaveOptions.PrettyFormat, SaveOptions.UseAntiAliasing, SaveOptions.UseHighQualityRendering, SaveOptions.DmlRenderingMode, SaveOptions.DmlEffectsRenderingMode, SaveOptions.ImlRenderingMode, SaveOptions.DefaultTemplate, SaveOptions.UpdateFields, SaveOptions.UpdateLastSavedTimeProperty, SaveOptions.UpdateLastPrintedProperty, SaveOptions.UpdateCreatedTimeProperty, SaveOptions.MemoryOptimization, SaveOptions.UpdateAmbiguousTextFont, SaveOptions.Dml3DEffectsRenderingMode, SaveOptions.ProgressCallback, SaveOptions.AllowEmbeddingPostScriptFonts, SaveOptions.CustomTimeZoneInfo, object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Constructors
XamlFlowSaveOptions()
Initializes a new instance of this class that can be used to save a document in the Aspose.Words.SaveFormat.XamlFlow format.
public XamlFlowSaveOptions()XamlFlowSaveOptions(SaveFormat)
Initializes a new instance of this class that can be used to save a document in the Aspose.Words.SaveFormat.XamlFlow or Aspose.Words.SaveFormat.XamlFlowPack format.
public XamlFlowSaveOptions(SaveFormat saveFormat)Parameters
saveFormat SaveFormat
Can be Aspose.Words.SaveFormat.XamlFlow or Aspose.Words.SaveFormat.XamlFlowPack.
Properties
ImageSavingCallback
Allows to control how images are saved when a document is saved to XAML.
public IImageSavingCallback ImageSavingCallback { get; set; }Property Value
ImagesFolder
Specifies the physical folder where images are saved when exporting a document to XAML format. Default is an empty string.
public string ImagesFolder { get; set; }Property Value
Remarks
When you save a Aspose.Words.Document in XAML format, Aspose.Words needs to save all images embedded in the document as standalone files. Aspose.Words.Saving.XamlFlowSaveOptions.ImagesFolder allows you to specify where the images will be saved and Aspose.Words.Saving.XamlFlowSaveOptions.ImagesFolderAlias 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 Aspose.Words.Saving.XamlFlowSaveOptions.ImagesFolder 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 in the Aspose.Words.Saving.XamlFlowSaveOptions.ImagesFolder property or provide custom streams via the Aspose.Words.Saving.XamlFlowSaveOptions.ImageSavingCallback event handler.
Aspose.Words.Saving.XamlFlowSaveOptions.ImagesFolderAlias Aspose.Words.Saving.XamlFlowSaveOptions.ImageSavingCallbackImagesFolderAlias
Specifies the name of the folder used to construct image URIs written into an XAML document. Default is an empty string.
public string ImagesFolderAlias { get; set; }Property Value
Remarks
When you save a Aspose.Words.Document in XAML format, Aspose.Words needs to save all images embedded in the document as standalone files. Aspose.Words.Saving.XamlFlowSaveOptions.ImagesFolder allows you to specify where the images will be saved and Aspose.Words.Saving.XamlFlowSaveOptions.ImagesFolderAlias allows to specify how the image URIs will be constructed.
If Aspose.Words.Saving.XamlFlowSaveOptions.ImagesFolderAlias is not an empty string, then the image URI written to XAML will be ImagesFolderAlias + <image file name>.
If Aspose.Words.Saving.XamlFlowSaveOptions.ImagesFolderAlias is an empty string, then the image URI written to XAML will be ImagesFolder + <image file name>.
If Aspose.Words.Saving.XamlFlowSaveOptions.ImagesFolderAlias is set to '.' (dot), then the image file name will be written to XAML without path regardless of other options.
Aspose.Words.Saving.XamlFlowSaveOptions.ImagesFolder Aspose.Words.Saving.XamlFlowSaveOptions.ImageSavingCallbackReplaceBackslashWithYenSign
Specifies whether backslash characters should be replaced with yen signs.
Default value is false.
public bool ReplaceBackslashWithYenSign { get; set; }Property Value
Remarks
By default, Aspose.Words mimics MS Word’s behavior and doesn’t replace backslash characters with yen signs in generated XAML documents. However, previous versions of Aspose.Words performed such replacements in certain scenarios. This flag enables backward compatibility with previous versions of Aspose.Words.
SaveFormat
Specifies the format in which the document will be saved if this save options object is used. Can only be Aspose.Words.SaveFormat.XamlFlow.
public override SaveFormat SaveFormat { get; set; }