com.aspose.words

Class PageSavingArgs

java.lang.Object

com.aspose.words.PageSavingArgs

public class PageSavingArgs
extends java.lang.Object

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

To learn more, visit the Programming with Documents documentation article.

Method Summary

Modifier and Type	Method and Description
boolean	getKeepPageStreamOpen() Specifies whether Aspose.Words should keep the stream open or close it after saving a document page.
java.lang.String	getPageFileName() Gets the file name where the document page will be saved to.
int	getPageIndex() Current page index.
java.io.OutputStream	getPageStream()
void	setKeepPageStreamOpen(boolean value) Specifies whether Aspose.Words should keep the stream open or close it after saving a document page.
void	setPageFileName(java.lang.String value) Sets the file name where the document page will be saved to.
void	setPageStream(java.io.OutputStream value)

Methods inherited from class java.lang.Object

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

Method Detail

getPageStream

public java.io.OutputStream getPageStream()

setPageStream

public void setPageStream(java.io.OutputStream value)

getKeepPageStreamOpen

public boolean getKeepPageStreamOpen()

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 P:Aspose.Words.Saving.PageSavingArgs.PageStream property after writing a document page into it. Specify true to keep the stream open.

P:Aspose.Words.Saving.PageSavingArgs.PageStream

Returns:

The corresponding boolean value.

setKeepPageStreamOpen

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 P:Aspose.Words.Saving.PageSavingArgs.PageStream property after writing a document page into it. Specify true to keep the stream open.

P:Aspose.Words.Saving.PageSavingArgs.PageStream

Parameters:

value - The corresponding boolean value.

getPageFileName

public java.lang.String getPageFileName()

Gets 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.

Returns:

The file name where the document page will be saved to.

setPageFileName

public void setPageFileName(java.lang.String value)

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.

Parameters:

value - The file name where the document page will be saved to.

getPageIndex

public int getPageIndex()

Current page index.

Returns:

The corresponding int value.