com.aspose.words

Class ResourceSavingArgs

java.lang.Object

com.aspose.words.ResourceSavingArgs

public class ResourceSavingArgs
extends java.lang.Object

Provides data for the IResourceSavingCallback.resourceSaving(com.aspose.words.ResourceSavingArgs) event.

To learn more, visit the Save a Document documentation article.

Remarks:

By default, when Aspose.Words saves a document to fixed page HTML, SVG or Markdown, it saves each resource into a separate file. Aspose.Words uses the document file name and a unique number to generate unique file name for each resource found in the document.

ResourceSavingArgs allows to redefine how resource file names are generated or to completely circumvent saving of resources into files by providing your own stream objects.

To apply your own logic for generating resource file names use the getResourceFileName() / setResourceFileName(java.lang.String) property.

To save resources into streams instead of files, use the P:Aspose.Words.Saving.ResourceSavingArgs.ResourceStream property.

Examples:

Shows how to use a callback to track external resources created while converting a document to HTML.

 
 public void resourceSavingCallback() throws Exception {
     Document doc = new Document(getMyDir() + "Bullet points with alternative font.docx");

     FontSavingCallback callback = new FontSavingCallback();

     HtmlFixedSaveOptions saveOptions = new HtmlFixedSaveOptions();
     {
         saveOptions.setResourceSavingCallback(callback);
     }

     doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.UsingMachineFonts.html", saveOptions);

     System.out.println(callback.getText());
 }

 private static class FontSavingCallback implements IResourceSavingCallback {
     /// <summary>
     /// Called when Aspose.Words saves an external resource to fixed page HTML or SVG.
     /// </summary>
     public void resourceSaving(ResourceSavingArgs args) {
         mText.append(MessageFormat.format("Original document URI:\t{0}", args.getDocument().getOriginalFileName()));
         mText.append(MessageFormat.format("Resource being saved:\t{0}", args.getResourceFileName()));
         mText.append(MessageFormat.format("Full uri after saving:\t{0}\n", args.getResourceFileUri()));
     }

     public String getText() {
         return mText.toString();
     }

     private final StringBuilder mText = new StringBuilder();
 }
 
 

Method Summary

Modifier and Type	Method and Description
Document	getDocument() Gets the document object that is currently being saved.
boolean	getKeepResourceStreamOpen() Specifies whether Aspose.Words should keep the stream open or close it after saving a resource.
java.lang.String	getResourceFileName() Gets the file name (without path) where the resource will be saved to.
java.lang.String	getResourceFileUri() Gets the uniform resource identifier (URI) used to reference the resource file from the document.
java.io.OutputStream	getResourceStream()
void	setKeepResourceStreamOpen(boolean value) Specifies whether Aspose.Words should keep the stream open or close it after saving a resource.
void	setResourceFileName(java.lang.String value) Sets the file name (without path) where the resource will be saved to.
void	setResourceFileUri(java.lang.String value) Sets the uniform resource identifier (URI) used to reference the resource file from the document.
void	setResourceStream(java.io.OutputStream value)

Methods inherited from class java.lang.Object

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

Method Detail

getDocument

public Document getDocument()

Gets the document object that is currently being saved.

Examples:

Shows how to use a callback to track external resources created while converting a document to HTML.

 
 public void resourceSavingCallback() throws Exception {
     Document doc = new Document(getMyDir() + "Bullet points with alternative font.docx");

     FontSavingCallback callback = new FontSavingCallback();

     HtmlFixedSaveOptions saveOptions = new HtmlFixedSaveOptions();
     {
         saveOptions.setResourceSavingCallback(callback);
     }

     doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.UsingMachineFonts.html", saveOptions);

     System.out.println(callback.getText());
 }

 private static class FontSavingCallback implements IResourceSavingCallback {
     /// <summary>
     /// Called when Aspose.Words saves an external resource to fixed page HTML or SVG.
     /// </summary>
     public void resourceSaving(ResourceSavingArgs args) {
         mText.append(MessageFormat.format("Original document URI:\t{0}", args.getDocument().getOriginalFileName()));
         mText.append(MessageFormat.format("Resource being saved:\t{0}", args.getResourceFileName()));
         mText.append(MessageFormat.format("Full uri after saving:\t{0}\n", args.getResourceFileUri()));
     }

     public String getText() {
         return mText.toString();
     }

     private final StringBuilder mText = new StringBuilder();
 }
 
 

Returns:

The document object that is currently being saved.

getResourceFileName

public java.lang.String getResourceFileName()

Gets the file name (without path) where the resource will be saved to.

Remarks:

This property allows you to redefine how the resource file names are generated during export to fixed page HTML, SVG or Markdown.

When the event is fired, this property contains the file name that was generated by Aspose.Words. You can change the value of this property to save the resource into a different file. Note that file names must be unique.

Aspose.Words automatically generates a unique file name for every resource when exporting to fixed page HTML, SVG or Markdown format. How the resource file name is generated depends on whether you save the document to a file or to a stream.

When saving a document to a file, the generated resource file name looks like ...

When saving a document to a stream, the generated resource file name looks like Aspose.Words....

getResourceFileName() / setResourceFileName(java.lang.String) must contain only the file name without the path. Aspose.Words determines the path for saving and the value of the src attribute for writing to fixed page HTML, SVG or Markdown using the document file name, the HtmlFixedSaveOptions.getResourcesFolder() / HtmlFixedSaveOptions.setResourcesFolder(java.lang.String) or SvgSaveOptions.getResourcesFolder() / SvgSaveOptions.setResourcesFolder(java.lang.String) and HtmlFixedSaveOptions.getResourcesFolderAlias() / HtmlFixedSaveOptions.setResourcesFolderAlias(java.lang.String) or SvgSaveOptions.getResourcesFolderAlias() / SvgSaveOptions.setResourcesFolderAlias(java.lang.String) or MarkdownSaveOptions.getImagesFolder() / MarkdownSaveOptions.setImagesFolder(java.lang.String) or MarkdownSaveOptions.getImagesFolderAlias() / MarkdownSaveOptions.setImagesFolderAlias(java.lang.String) properties.

HtmlFixedSaveOptions.getResourcesFolder() / HtmlFixedSaveOptions.setResourcesFolder(java.lang.String) SvgSaveOptions.getResourcesFolder() / SvgSaveOptions.setResourcesFolder(java.lang.String) HtmlFixedSaveOptions.getResourcesFolderAlias() / HtmlFixedSaveOptions.setResourcesFolderAlias(java.lang.String) SvgSaveOptions.getResourcesFolderAlias() / SvgSaveOptions.setResourcesFolderAlias(java.lang.String)

Examples:

Shows how to use a callback to track external resources created while converting a document to HTML.

 
 public void resourceSavingCallback() throws Exception {
     Document doc = new Document(getMyDir() + "Bullet points with alternative font.docx");

     FontSavingCallback callback = new FontSavingCallback();

     HtmlFixedSaveOptions saveOptions = new HtmlFixedSaveOptions();
     {
         saveOptions.setResourceSavingCallback(callback);
     }

     doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.UsingMachineFonts.html", saveOptions);

     System.out.println(callback.getText());
 }

 private static class FontSavingCallback implements IResourceSavingCallback {
     /// <summary>
     /// Called when Aspose.Words saves an external resource to fixed page HTML or SVG.
     /// </summary>
     public void resourceSaving(ResourceSavingArgs args) {
         mText.append(MessageFormat.format("Original document URI:\t{0}", args.getDocument().getOriginalFileName()));
         mText.append(MessageFormat.format("Resource being saved:\t{0}", args.getResourceFileName()));
         mText.append(MessageFormat.format("Full uri after saving:\t{0}\n", args.getResourceFileUri()));
     }

     public String getText() {
         return mText.toString();
     }

     private final StringBuilder mText = new StringBuilder();
 }
 
 

P:Aspose.Words.Saving.ResourceSavingArgs.ResourceStream

Returns:

The file name (without path) where the resource will be saved to.

setResourceFileName

public void setResourceFileName(java.lang.String value)
                         throws java.lang.Exception

Sets the file name (without path) where the resource will be saved to.

Remarks:

This property allows you to redefine how the resource file names are generated during export to fixed page HTML, SVG or Markdown.

When the event is fired, this property contains the file name that was generated by Aspose.Words. You can change the value of this property to save the resource into a different file. Note that file names must be unique.

Aspose.Words automatically generates a unique file name for every resource when exporting to fixed page HTML, SVG or Markdown format. How the resource file name is generated depends on whether you save the document to a file or to a stream.

When saving a document to a file, the generated resource file name looks like ...

When saving a document to a stream, the generated resource file name looks like Aspose.Words....

getResourceFileName() / setResourceFileName(java.lang.String) must contain only the file name without the path. Aspose.Words determines the path for saving and the value of the src attribute for writing to fixed page HTML, SVG or Markdown using the document file name, the HtmlFixedSaveOptions.getResourcesFolder() / HtmlFixedSaveOptions.setResourcesFolder(java.lang.String) or SvgSaveOptions.getResourcesFolder() / SvgSaveOptions.setResourcesFolder(java.lang.String) and HtmlFixedSaveOptions.getResourcesFolderAlias() / HtmlFixedSaveOptions.setResourcesFolderAlias(java.lang.String) or SvgSaveOptions.getResourcesFolderAlias() / SvgSaveOptions.setResourcesFolderAlias(java.lang.String) or MarkdownSaveOptions.getImagesFolder() / MarkdownSaveOptions.setImagesFolder(java.lang.String) or MarkdownSaveOptions.getImagesFolderAlias() / MarkdownSaveOptions.setImagesFolderAlias(java.lang.String) properties.

HtmlFixedSaveOptions.getResourcesFolder() / HtmlFixedSaveOptions.setResourcesFolder(java.lang.String) SvgSaveOptions.getResourcesFolder() / SvgSaveOptions.setResourcesFolder(java.lang.String) HtmlFixedSaveOptions.getResourcesFolderAlias() / HtmlFixedSaveOptions.setResourcesFolderAlias(java.lang.String) SvgSaveOptions.getResourcesFolderAlias() / SvgSaveOptions.setResourcesFolderAlias(java.lang.String)

Examples:

Shows how to use a callback to track external resources created while converting a document to HTML.

 
 public void resourceSavingCallback() throws Exception {
     Document doc = new Document(getMyDir() + "Bullet points with alternative font.docx");

     FontSavingCallback callback = new FontSavingCallback();

     HtmlFixedSaveOptions saveOptions = new HtmlFixedSaveOptions();
     {
         saveOptions.setResourceSavingCallback(callback);
     }

     doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.UsingMachineFonts.html", saveOptions);

     System.out.println(callback.getText());
 }

 private static class FontSavingCallback implements IResourceSavingCallback {
     /// <summary>
     /// Called when Aspose.Words saves an external resource to fixed page HTML or SVG.
     /// </summary>
     public void resourceSaving(ResourceSavingArgs args) {
         mText.append(MessageFormat.format("Original document URI:\t{0}", args.getDocument().getOriginalFileName()));
         mText.append(MessageFormat.format("Resource being saved:\t{0}", args.getResourceFileName()));
         mText.append(MessageFormat.format("Full uri after saving:\t{0}\n", args.getResourceFileUri()));
     }

     public String getText() {
         return mText.toString();
     }

     private final StringBuilder mText = new StringBuilder();
 }
 
 

P:Aspose.Words.Saving.ResourceSavingArgs.ResourceStream

Parameters:

value - The file name (without path) where the resource will be saved to.

Throws:

java.lang.Exception

getResourceFileUri

public java.lang.String getResourceFileUri()

Gets the uniform resource identifier (URI) used to reference the resource file from the document.

Remarks:

This property allows you to change URIs of resource files exported to fixed page HTML, SVG or Markdown documents.

Aspose.Words automatically generates an URI for every resource file during export to fixed page HTML, SVG or Markdown format. The generated URIs reference resource files saved by Aspose.Words. However, the URIs can be incorrect if resource files are to be moved to other location or if resource files are saved to streams. This property allows to correct URIs in these cases.

When the event is fired, this property contains the URI that was generated by Aspose.Words. You can change the value of this property to provide a custom URI for the resource file.

HtmlFixedSaveOptions.getResourcesFolder() / HtmlFixedSaveOptions.setResourcesFolder(java.lang.String) SvgSaveOptions.getResourcesFolder() / SvgSaveOptions.setResourcesFolder(java.lang.String) MarkdownSaveOptions.getImagesFolder() / MarkdownSaveOptions.setImagesFolder(java.lang.String) HtmlFixedSaveOptions.getResourcesFolderAlias() / HtmlFixedSaveOptions.setResourcesFolderAlias(java.lang.String) SvgSaveOptions.getResourcesFolderAlias() / SvgSaveOptions.setResourcesFolderAlias(java.lang.String) MarkdownSaveOptions.getImagesFolderAlias() / MarkdownSaveOptions.setImagesFolderAlias(java.lang.String)

Examples:

Shows how to use a callback to track external resources created while converting a document to HTML.

 
 public void resourceSavingCallback() throws Exception {
     Document doc = new Document(getMyDir() + "Bullet points with alternative font.docx");

     FontSavingCallback callback = new FontSavingCallback();

     HtmlFixedSaveOptions saveOptions = new HtmlFixedSaveOptions();
     {
         saveOptions.setResourceSavingCallback(callback);
     }

     doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.UsingMachineFonts.html", saveOptions);

     System.out.println(callback.getText());
 }

 private static class FontSavingCallback implements IResourceSavingCallback {
     /// <summary>
     /// Called when Aspose.Words saves an external resource to fixed page HTML or SVG.
     /// </summary>
     public void resourceSaving(ResourceSavingArgs args) {
         mText.append(MessageFormat.format("Original document URI:\t{0}", args.getDocument().getOriginalFileName()));
         mText.append(MessageFormat.format("Resource being saved:\t{0}", args.getResourceFileName()));
         mText.append(MessageFormat.format("Full uri after saving:\t{0}\n", args.getResourceFileUri()));
     }

     public String getText() {
         return mText.toString();
     }

     private final StringBuilder mText = new StringBuilder();
 }
 
 

Returns:

The uniform resource identifier (URI) used to reference the resource file from the document.

setResourceFileUri

public void setResourceFileUri(java.lang.String value)

Sets the uniform resource identifier (URI) used to reference the resource file from the document.

Remarks:

This property allows you to change URIs of resource files exported to fixed page HTML, SVG or Markdown documents.

Aspose.Words automatically generates an URI for every resource file during export to fixed page HTML, SVG or Markdown format. The generated URIs reference resource files saved by Aspose.Words. However, the URIs can be incorrect if resource files are to be moved to other location or if resource files are saved to streams. This property allows to correct URIs in these cases.

When the event is fired, this property contains the URI that was generated by Aspose.Words. You can change the value of this property to provide a custom URI for the resource file.

HtmlFixedSaveOptions.getResourcesFolder() / HtmlFixedSaveOptions.setResourcesFolder(java.lang.String) SvgSaveOptions.getResourcesFolder() / SvgSaveOptions.setResourcesFolder(java.lang.String) MarkdownSaveOptions.getImagesFolder() / MarkdownSaveOptions.setImagesFolder(java.lang.String) HtmlFixedSaveOptions.getResourcesFolderAlias() / HtmlFixedSaveOptions.setResourcesFolderAlias(java.lang.String) SvgSaveOptions.getResourcesFolderAlias() / SvgSaveOptions.setResourcesFolderAlias(java.lang.String) MarkdownSaveOptions.getImagesFolderAlias() / MarkdownSaveOptions.setImagesFolderAlias(java.lang.String)

Examples:

Shows how to use a callback to track external resources created while converting a document to HTML.

 
 public void resourceSavingCallback() throws Exception {
     Document doc = new Document(getMyDir() + "Bullet points with alternative font.docx");

     FontSavingCallback callback = new FontSavingCallback();

     HtmlFixedSaveOptions saveOptions = new HtmlFixedSaveOptions();
     {
         saveOptions.setResourceSavingCallback(callback);
     }

     doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.UsingMachineFonts.html", saveOptions);

     System.out.println(callback.getText());
 }

 private static class FontSavingCallback implements IResourceSavingCallback {
     /// <summary>
     /// Called when Aspose.Words saves an external resource to fixed page HTML or SVG.
     /// </summary>
     public void resourceSaving(ResourceSavingArgs args) {
         mText.append(MessageFormat.format("Original document URI:\t{0}", args.getDocument().getOriginalFileName()));
         mText.append(MessageFormat.format("Resource being saved:\t{0}", args.getResourceFileName()));
         mText.append(MessageFormat.format("Full uri after saving:\t{0}\n", args.getResourceFileUri()));
     }

     public String getText() {
         return mText.toString();
     }

     private final StringBuilder mText = new StringBuilder();
 }
 
 

Parameters:

value - The uniform resource identifier (URI) used to reference the resource file from the document.

getKeepResourceStreamOpen

public boolean getKeepResourceStreamOpen()

Specifies whether Aspose.Words should keep the stream open or close it after saving a resource.

Remarks:

Default is false and Aspose.Words will close the stream you provided in the P:Aspose.Words.Saving.ResourceSavingArgs.ResourceStream property after writing a resource into it. Specify true to keep the stream open.

Examples:

Shows how to use a callback to print the URIs of external resources created while converting a document to HTML.

 
 public void htmlFixedResourceFolder() throws Exception {
     Document doc = new Document(getMyDir() + "Rendering.docx");

     ResourceUriPrinter callback = new ResourceUriPrinter();

     HtmlFixedSaveOptions options = new HtmlFixedSaveOptions();
     {
         options.setSaveFormat(SaveFormat.HTML_FIXED);
         options.setExportEmbeddedImages(false);
         options.setResourcesFolder(getArtifactsDir() + "HtmlFixedResourceFolder");
         options.setResourcesFolderAlias(getArtifactsDir() + "HtmlFixedResourceFolderAlias");
         options.setShowPageBorder(false);
         options.setResourceSavingCallback(callback);
     }

     // A folder specified by ResourcesFolderAlias will contain the resources instead of ResourcesFolder.
     // We must ensure the folder exists before the streams can put their resources into it.
     new File(options.getResourcesFolderAlias()).mkdir();

     doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.HtmlFixedResourceFolder.html", options);

     System.out.println(callback.getText());

     String[] resourceFiles = new File(getArtifactsDir() + "HtmlFixedResourceFolderAlias").list();

     Assert.assertFalse(new File(getArtifactsDir() + "HtmlFixedResourceFolder").exists());
     Assert.assertEquals(6, IterableUtils.countMatches(Arrays.asList(resourceFiles),
             f -> f.endsWith(".jpeg") || f.endsWith(".png") || f.endsWith(".css")));
 }

 /// <summary>
 /// Counts and prints URIs of resources contained by as they are converted to fixed HTML.
 /// </summary>
 private static class ResourceUriPrinter implements IResourceSavingCallback {
     public void resourceSaving(ResourceSavingArgs args) throws Exception {
         // If we set a folder alias in the SaveOptions object, we will be able to print it from here.
         mText.append(MessageFormat.format("Resource #{0} \"{1}\"", ++mSavedResourceCount, args.getResourceFileName()));

         String extension = FilenameUtils.getExtension(args.getResourceFileName());
         switch (extension) {
             case "ttf":
             case "woff": {
                 // By default, 'ResourceFileUri' uses system folder for fonts.
                 // To avoid problems in other platforms you must explicitly specify the path for the fonts.
                 args.setResourceFileUri(getArtifactsDir() + File.separatorChar + args.getResourceFileName());
                 break;
             }
         }

         mText.append("\t" + args.getResourceFileUri());

         // If we have specified a folder in the "ResourcesFolderAlias" property,
         // we will also need to redirect each stream to put its resource in that folder.
         args.setResourceStream(new FileOutputStream(args.getResourceFileUri()));
         args.setKeepResourceStreamOpen(false);
     }

     public String getText() {
         return mText.toString();
     }

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

P:Aspose.Words.Saving.ResourceSavingArgs.ResourceStream

Returns:

The corresponding boolean value.

setKeepResourceStreamOpen

public void setKeepResourceStreamOpen(boolean value)

Specifies whether Aspose.Words should keep the stream open or close it after saving a resource.

Remarks:

Default is false and Aspose.Words will close the stream you provided in the P:Aspose.Words.Saving.ResourceSavingArgs.ResourceStream property after writing a resource into it. Specify true to keep the stream open.

Examples:

Shows how to use a callback to print the URIs of external resources created while converting a document to HTML.

 
 public void htmlFixedResourceFolder() throws Exception {
     Document doc = new Document(getMyDir() + "Rendering.docx");

     ResourceUriPrinter callback = new ResourceUriPrinter();

     HtmlFixedSaveOptions options = new HtmlFixedSaveOptions();
     {
         options.setSaveFormat(SaveFormat.HTML_FIXED);
         options.setExportEmbeddedImages(false);
         options.setResourcesFolder(getArtifactsDir() + "HtmlFixedResourceFolder");
         options.setResourcesFolderAlias(getArtifactsDir() + "HtmlFixedResourceFolderAlias");
         options.setShowPageBorder(false);
         options.setResourceSavingCallback(callback);
     }

     // A folder specified by ResourcesFolderAlias will contain the resources instead of ResourcesFolder.
     // We must ensure the folder exists before the streams can put their resources into it.
     new File(options.getResourcesFolderAlias()).mkdir();

     doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.HtmlFixedResourceFolder.html", options);

     System.out.println(callback.getText());

     String[] resourceFiles = new File(getArtifactsDir() + "HtmlFixedResourceFolderAlias").list();

     Assert.assertFalse(new File(getArtifactsDir() + "HtmlFixedResourceFolder").exists());
     Assert.assertEquals(6, IterableUtils.countMatches(Arrays.asList(resourceFiles),
             f -> f.endsWith(".jpeg") || f.endsWith(".png") || f.endsWith(".css")));
 }

 /// <summary>
 /// Counts and prints URIs of resources contained by as they are converted to fixed HTML.
 /// </summary>
 private static class ResourceUriPrinter implements IResourceSavingCallback {
     public void resourceSaving(ResourceSavingArgs args) throws Exception {
         // If we set a folder alias in the SaveOptions object, we will be able to print it from here.
         mText.append(MessageFormat.format("Resource #{0} \"{1}\"", ++mSavedResourceCount, args.getResourceFileName()));

         String extension = FilenameUtils.getExtension(args.getResourceFileName());
         switch (extension) {
             case "ttf":
             case "woff": {
                 // By default, 'ResourceFileUri' uses system folder for fonts.
                 // To avoid problems in other platforms you must explicitly specify the path for the fonts.
                 args.setResourceFileUri(getArtifactsDir() + File.separatorChar + args.getResourceFileName());
                 break;
             }
         }

         mText.append("\t" + args.getResourceFileUri());

         // If we have specified a folder in the "ResourcesFolderAlias" property,
         // we will also need to redirect each stream to put its resource in that folder.
         args.setResourceStream(new FileOutputStream(args.getResourceFileUri()));
         args.setKeepResourceStreamOpen(false);
     }

     public String getText() {
         return mText.toString();
     }

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

P:Aspose.Words.Saving.ResourceSavingArgs.ResourceStream

Parameters:

value - The corresponding boolean value.

getResourceStream

public java.io.OutputStream getResourceStream()

setResourceStream

public void setResourceStream(java.io.OutputStream value)