com.aspose.words

Class XamlFixedSaveOptions

java.lang.Object

com.aspose.words.SaveOptions

com.aspose.words.FixedPageSaveOptions

com.aspose.words.XamlFixedSaveOptions

public class XamlFixedSaveOptions
extends FixedPageSaveOptions

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

To learn more, visit the Specify Save Options documentation article.

Method Summary

Modifier and Type	Method and Description
IResourceSavingCallback	getResourceSavingCallback() Allows to control how resources (images and fonts) are saved when a document is exported to fixed page Xaml format.
java.lang.String	getResourcesFolder() Specifies the physical folder where resources (images and fonts) are saved when exporting a document to fixed page Xaml format.
java.lang.String	getResourcesFolderAlias() Specifies the name of the folder used to construct image URIs written into an fixed page Xaml document.
int	getSaveFormat() Specifies the format in which the document will be saved if this save options object is used.
void	setResourceSavingCallback(IResourceSavingCallback value) Allows to control how resources (images and fonts) are saved when a document is exported to fixed page Xaml format.
void	setResourcesFolder(java.lang.String value) Specifies the physical folder where resources (images and fonts) are saved when exporting a document to fixed page Xaml format.
void	setResourcesFolderAlias(java.lang.String value) Specifies the name of the folder used to construct image URIs written into an fixed page Xaml document.
void	setSaveFormat(int value) Specifies the format in which the document will be saved if this save options object is used.

Methods inherited from class com.aspose.words.FixedPageSaveOptions

equals, getColorMode, getJpegQuality, getMetafileRenderingOptions, getNumeralFormat, getOptimizeOutput, getPageSavingCallback, getPageSet, setColorMode, setJpegQuality, setMetafileRenderingOptions, setNumeralFormat, setOptimizeOutput, setPageSavingCallback, setPageSet

Methods inherited from class com.aspose.words.SaveOptions

createSaveOptions, createSaveOptions, getAllowEmbeddingPostScriptFonts, getDefaultTemplate, getDml3DEffectsRenderingMode, getDmlEffectsRenderingMode, getDmlRenderingMode, getExportGeneratorName, getImlRenderingMode, getMemoryOptimization, getPrettyFormat, getProgressCallback, getTempFolder, getUpdateCreatedTimeProperty, getUpdateFields, getUpdateLastPrintedProperty, getUpdateLastSavedTimeProperty, getUpdateSdtContent, getUseAntiAliasing, getUseHighQualityRendering, setAllowEmbeddingPostScriptFonts, setDefaultTemplate, setDml3DEffectsRenderingMode, setDmlEffectsRenderingMode, setDmlRenderingMode, setExportGeneratorName, setImlRenderingMode, setMemoryOptimization, setPrettyFormat, setProgressCallback, setTempFolder, setUpdateCreatedTimeProperty, setUpdateFields, setUpdateLastPrintedProperty, setUpdateLastSavedTimeProperty, setUpdateSdtContent, setUseAntiAliasing, setUseHighQualityRendering

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSaveFormat

public int getSaveFormat()

Specifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.XAML_FIXED.

Specified by:

getSaveFormat in class SaveOptions

Returns:

The corresponding int value. The returned value is one of SaveFormat constants.

setSaveFormat

public void setSaveFormat(int value)

Specifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.XAML_FIXED.

Specified by:

setSaveFormat in class SaveOptions

Parameters:

value - The corresponding int value. The value must be one of SaveFormat constants.

getResourcesFolder

public java.lang.String getResourcesFolder()

Specifies the physical folder where resources (images and fonts) are saved when exporting a document to fixed page Xaml format. Default is null.

When you save a Document in fixed page Xaml format, Aspose.Words needs to save all images embedded in the document as standalone files. getResourcesFolder() / setResourcesFolder(java.lang.String) allows you to specify where the images will be saved and getResourcesFolderAlias() / setResourcesFolderAlias(java.lang.String) 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 getResourcesFolder() / setResourcesFolder(java.lang.String) 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 by using the getResourcesFolder() / setResourcesFolder(java.lang.String) property

Returns:

The corresponding String value.

See Also:

getResourcesFolderAlias(), setResourcesFolderAlias(java.lang.String)

setResourcesFolder

public void setResourcesFolder(java.lang.String value)

Specifies the physical folder where resources (images and fonts) are saved when exporting a document to fixed page Xaml format. Default is null.

When you save a Document in fixed page Xaml format, Aspose.Words needs to save all images embedded in the document as standalone files. getResourcesFolder() / setResourcesFolder(java.lang.String) allows you to specify where the images will be saved and getResourcesFolderAlias() / setResourcesFolderAlias(java.lang.String) 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 getResourcesFolder() / setResourcesFolder(java.lang.String) 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 by using the getResourcesFolder() / setResourcesFolder(java.lang.String) property

Parameters:

value - The corresponding String value.

See Also:

getResourcesFolderAlias(), setResourcesFolderAlias(java.lang.String)

getResourcesFolderAlias

public java.lang.String getResourcesFolderAlias()

Specifies the name of the folder used to construct image URIs written into an fixed page Xaml document. Default is null.

When you save a Document in fixed page Xaml format, Aspose.Words needs to save all images embedded in the document as standalone files. getResourcesFolder() / setResourcesFolder(java.lang.String) allows you to specify where the images will be saved and getResourcesFolderAlias() / setResourcesFolderAlias(java.lang.String) allows to specify how the image URIs will be constructed.

Returns:

The corresponding String value.

See Also:

getResourcesFolder(), setResourcesFolder(java.lang.String)

setResourcesFolderAlias

public void setResourcesFolderAlias(java.lang.String value)

Specifies the name of the folder used to construct image URIs written into an fixed page Xaml document. Default is null.

When you save a Document in fixed page Xaml format, Aspose.Words needs to save all images embedded in the document as standalone files. getResourcesFolder() / setResourcesFolder(java.lang.String) allows you to specify where the images will be saved and getResourcesFolderAlias() / setResourcesFolderAlias(java.lang.String) allows to specify how the image URIs will be constructed.

Parameters:

value - The corresponding String value.

See Also:

getResourcesFolder(), setResourcesFolder(java.lang.String)

getResourceSavingCallback

public IResourceSavingCallback getResourceSavingCallback()

Allows to control how resources (images and fonts) are saved when a document is exported to fixed page Xaml format.

Returns:

The corresponding IResourceSavingCallback value.

setResourceSavingCallback

public void setResourceSavingCallback(IResourceSavingCallback value)

Allows to control how resources (images and fonts) are saved when a document is exported to fixed page Xaml format.

Parameters:

value - The corresponding IResourceSavingCallback value.