com.aspose.xps.features.EventBasedModifications

Class BeforeSavingEventArgs<T extends IModificationAPI>

java.lang.Object

com.aspose.xps.features.EventBasedModifications.BeforeSavingEventArgs<T>

Type Parameters:

T - The modification API type.

public class BeforeSavingEventArgs<T extends IModificationAPI>
extends Object

Defines the base class for arguments of various before-saving events.

Method Summary

Modifier and Type	Method and Description
int	getAbsolutePageNumber() Returns the current absolute page number across all documents within the XPS package.
int	getDocumentNumber() Returns the current document number within the XPS package.
T	getElementAPI() Returns the modification API of the element that is about to be saved.
int	getOutputPageNumber() Returns the current output number.
int	getRelativePageNumber() Returns the current page number relative to the current document within the XPS package.

Methods inherited from class java.lang.Object

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

Method Detail

getElementAPI

public T getElementAPI()

Returns the modification API of the element that is about to be saved.

Returns:

The modification API of the element that is about to be saved.

getDocumentNumber

public int getDocumentNumber()

Returns the current document number within the XPS package.

Returns:

The current document number within the XPS package.

getRelativePageNumber

public int getRelativePageNumber()

Returns the current page number relative to the current document within the XPS package.

Returns:

The current page number relative to the current document within the XPS package.

getAbsolutePageNumber

public int getAbsolutePageNumber()

Returns the current absolute page number across all documents within the XPS package.

Returns:

The current absolute page number across all documents within the XPS package.

getOutputPageNumber

public int getOutputPageNumber()

Returns the current output number. It differs from AbsolutePageNumber if the PageNumbers save option is specified.

Returns:

The current output number.