com.aspose.words
Class PageSavingArgs

java.lang.Object
    extended by com.aspose.words.PageSavingArgs

public class PageSavingArgs 
extends java.lang.Object

Provides data for the IPageSavingCallback.pageSaving(com.aspose.words.PageSavingArgs) event.

Example:

Shows how separate pages are saved when a document is exported to fixed page format.
public void pageFileName() throws Exception {
    Document doc = new Document(getMyDir() + "Rendering.docx");

    HtmlFixedSaveOptions htmlFixedSaveOptions =
            new HtmlFixedSaveOptions();
    {
        htmlFixedSaveOptions.setPageIndex(0);
        htmlFixedSaveOptions.setPageCount(doc.getPageCount());
    }
    htmlFixedSaveOptions.setPageSavingCallback(new CustomPageFileNamePageSavingCallback());

    doc.save(getArtifactsDir() + "SavingCallback.PageFileName.html", htmlFixedSaveOptions);

    ArrayList<String> filePaths = DocumentHelper.directoryGetFiles(getArtifactsDir(), "SavingCallback.PageFileName.Page_*.html");

    for (int i = 0; i < doc.getPageCount(); i++) {
        String file = getArtifactsDir() + MessageFormat.format("SavingCallback.PageFileName.Page_{0}.html", i);
    }
}

/// <summary>
/// Custom PageFileName is specified.
/// </summary>
private static class CustomPageFileNamePageSavingCallback implements IPageSavingCallback {
    public void pageSaving(PageSavingArgs args) throws Exception {
        String outFileName = getArtifactsDir() + MessageFormat.format("SavingCallback.PageFileName.Page_{0}.html", args.getPageIndex());

        // Specify name of the output file for the current page either in this 
        args.setPageFileName(outFileName);

        // ..or by setting up a custom stream
        args.setPageStream(new FileOutputStream(outFileName));
        Assert.assertFalse(args.getKeepPageStreamOpen());
    }
}

Constructor Summary
PageSavingArgs()
          
 
Property Getters/Setters Summary
booleangetKeepPageStreamOpen()
voidsetKeepPageStreamOpen(boolean value)
           Specifies whether Aspose.Words should keep the stream open or close it after saving a document page.
java.lang.StringgetPageFileName()
voidsetPageFileName(java.lang.String value)
           Gets or sets the file name where the document page will be saved to.
intgetPageIndex()
           Current page index.
java.io.OutputStreamgetPageStream()
voidsetPageStream(java.io.OutputStream value)
           Allows to specify the stream where the document page will be saved to.
 

Constructor Detail

PageSavingArgs

public PageSavingArgs()

Property Getters/Setters Detail

getKeepPageStreamOpen/setKeepPageStreamOpen

public boolean getKeepPageStreamOpen() / public void setKeepPageStreamOpen(boolean value)
Specifies whether Aspose.Words should keep the stream open or close it after saving a document page.

Default is false and Aspose.Words will close the stream you provided in the PageStream property after writing a document page into it. Specify true to keep the stream open.

Example:

Shows how separate pages are saved when a document is exported to fixed page format.
public void pageFileName() throws Exception {
    Document doc = new Document(getMyDir() + "Rendering.docx");

    HtmlFixedSaveOptions htmlFixedSaveOptions =
            new HtmlFixedSaveOptions();
    {
        htmlFixedSaveOptions.setPageIndex(0);
        htmlFixedSaveOptions.setPageCount(doc.getPageCount());
    }
    htmlFixedSaveOptions.setPageSavingCallback(new CustomPageFileNamePageSavingCallback());

    doc.save(getArtifactsDir() + "SavingCallback.PageFileName.html", htmlFixedSaveOptions);

    ArrayList<String> filePaths = DocumentHelper.directoryGetFiles(getArtifactsDir(), "SavingCallback.PageFileName.Page_*.html");

    for (int i = 0; i < doc.getPageCount(); i++) {
        String file = getArtifactsDir() + MessageFormat.format("SavingCallback.PageFileName.Page_{0}.html", i);
    }
}

/// <summary>
/// Custom PageFileName is specified.
/// </summary>
private static class CustomPageFileNamePageSavingCallback implements IPageSavingCallback {
    public void pageSaving(PageSavingArgs args) throws Exception {
        String outFileName = getArtifactsDir() + MessageFormat.format("SavingCallback.PageFileName.Page_{0}.html", args.getPageIndex());

        // Specify name of the output file for the current page either in this 
        args.setPageFileName(outFileName);

        // ..or by setting up a custom stream
        args.setPageStream(new FileOutputStream(outFileName));
        Assert.assertFalse(args.getKeepPageStreamOpen());
    }
}
See Also:
PageStream

getPageFileName/setPageFileName

public java.lang.String getPageFileName() / public void setPageFileName(java.lang.String value)
Gets or sets the file name where the document page will be saved to. If not specified then page file name and path will be generated automatically using original file name.

Example:

Shows how separate pages are saved when a document is exported to fixed page format.
public void pageFileName() throws Exception {
    Document doc = new Document(getMyDir() + "Rendering.docx");

    HtmlFixedSaveOptions htmlFixedSaveOptions =
            new HtmlFixedSaveOptions();
    {
        htmlFixedSaveOptions.setPageIndex(0);
        htmlFixedSaveOptions.setPageCount(doc.getPageCount());
    }
    htmlFixedSaveOptions.setPageSavingCallback(new CustomPageFileNamePageSavingCallback());

    doc.save(getArtifactsDir() + "SavingCallback.PageFileName.html", htmlFixedSaveOptions);

    ArrayList<String> filePaths = DocumentHelper.directoryGetFiles(getArtifactsDir(), "SavingCallback.PageFileName.Page_*.html");

    for (int i = 0; i < doc.getPageCount(); i++) {
        String file = getArtifactsDir() + MessageFormat.format("SavingCallback.PageFileName.Page_{0}.html", i);
    }
}

/// <summary>
/// Custom PageFileName is specified.
/// </summary>
private static class CustomPageFileNamePageSavingCallback implements IPageSavingCallback {
    public void pageSaving(PageSavingArgs args) throws Exception {
        String outFileName = getArtifactsDir() + MessageFormat.format("SavingCallback.PageFileName.Page_{0}.html", args.getPageIndex());

        // Specify name of the output file for the current page either in this 
        args.setPageFileName(outFileName);

        // ..or by setting up a custom stream
        args.setPageStream(new FileOutputStream(outFileName));
        Assert.assertFalse(args.getKeepPageStreamOpen());
    }
}

getPageIndex

public int getPageIndex()
Current page index.

Example:

Shows how separate pages are saved when a document is exported to fixed page format.
public void pageFileName() throws Exception {
    Document doc = new Document(getMyDir() + "Rendering.docx");

    HtmlFixedSaveOptions htmlFixedSaveOptions =
            new HtmlFixedSaveOptions();
    {
        htmlFixedSaveOptions.setPageIndex(0);
        htmlFixedSaveOptions.setPageCount(doc.getPageCount());
    }
    htmlFixedSaveOptions.setPageSavingCallback(new CustomPageFileNamePageSavingCallback());

    doc.save(getArtifactsDir() + "SavingCallback.PageFileName.html", htmlFixedSaveOptions);

    ArrayList<String> filePaths = DocumentHelper.directoryGetFiles(getArtifactsDir(), "SavingCallback.PageFileName.Page_*.html");

    for (int i = 0; i < doc.getPageCount(); i++) {
        String file = getArtifactsDir() + MessageFormat.format("SavingCallback.PageFileName.Page_{0}.html", i);
    }
}

/// <summary>
/// Custom PageFileName is specified.
/// </summary>
private static class CustomPageFileNamePageSavingCallback implements IPageSavingCallback {
    public void pageSaving(PageSavingArgs args) throws Exception {
        String outFileName = getArtifactsDir() + MessageFormat.format("SavingCallback.PageFileName.Page_{0}.html", args.getPageIndex());

        // Specify name of the output file for the current page either in this 
        args.setPageFileName(outFileName);

        // ..or by setting up a custom stream
        args.setPageStream(new FileOutputStream(outFileName));
        Assert.assertFalse(args.getKeepPageStreamOpen());
    }
}

getPageStream/setPageStream

public java.io.OutputStream getPageStream() / public void setPageStream(java.io.OutputStream value)
Allows to specify the stream where the document page will be saved to.

This property allows you to save document pages to streams instead of files.

The default value is null. When this property is null, the document page will be saved to a file specified in the PageFileName property.

If both PageStream and PageFileName are set, then PageStream will be used.

Example:

Shows how separate pages are saved when a document is exported to fixed page format.
public void pageFileName() throws Exception {
    Document doc = new Document(getMyDir() + "Rendering.docx");

    HtmlFixedSaveOptions htmlFixedSaveOptions =
            new HtmlFixedSaveOptions();
    {
        htmlFixedSaveOptions.setPageIndex(0);
        htmlFixedSaveOptions.setPageCount(doc.getPageCount());
    }
    htmlFixedSaveOptions.setPageSavingCallback(new CustomPageFileNamePageSavingCallback());

    doc.save(getArtifactsDir() + "SavingCallback.PageFileName.html", htmlFixedSaveOptions);

    ArrayList<String> filePaths = DocumentHelper.directoryGetFiles(getArtifactsDir(), "SavingCallback.PageFileName.Page_*.html");

    for (int i = 0; i < doc.getPageCount(); i++) {
        String file = getArtifactsDir() + MessageFormat.format("SavingCallback.PageFileName.Page_{0}.html", i);
    }
}

/// <summary>
/// Custom PageFileName is specified.
/// </summary>
private static class CustomPageFileNamePageSavingCallback implements IPageSavingCallback {
    public void pageSaving(PageSavingArgs args) throws Exception {
        String outFileName = getArtifactsDir() + MessageFormat.format("SavingCallback.PageFileName.Page_{0}.html", args.getPageIndex());

        // Specify name of the output file for the current page either in this 
        args.setPageFileName(outFileName);

        // ..or by setting up a custom stream
        args.setPageStream(new FileOutputStream(outFileName));
        Assert.assertFalse(args.getKeepPageStreamOpen());
    }
}
See Also:
PageFileName, KeepPageStreamOpen

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.