com.crystaldecisions.sdk.plugin.desktop.common
Interface IPageFormat

All Known Subinterfaces:

IExcelFormat, IPaginatedTextFormat, IPDFFormat, IRichTextFormat, IRichTextFormatEditable, IWordFormat

public interface IPageFormat

This abstract interface is used by other exporting sub-classes to set how the pages of a report will be exported.

Method Summary

int	getEndPageNumber() Returns the end page number to be exported.
int	getStartPageNumber() Returns the start page number to be exported.
boolean	isAllPagesExported() Returns whether or not to export all pages.
void	setAllPageExported(boolean allPages) Sets whether or not to export all pages.
void	setEndPageNumber(int endPageNum) Sets the end page number to be exported.
void	setStartPageNumber(int startPageNum) Sets the start page number to be exported.

Method Detail

isAllPagesExported

boolean isAllPagesExported()
                           throws SDKException

Returns whether or not to export all pages.

Returns:

true if all pages will be exported, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setAllPageExported

void setAllPageExported(boolean allPages)

Sets whether or not to export all pages.

Parameters:

allPages - true if all pages will be exported, false otherwise.

getStartPageNumber

int getStartPageNumber()
                       throws SDKException

Returns the start page number to be exported.

Returns:

An int specifying the start page number.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setStartPageNumber

void setStartPageNumber(int startPageNum)

Sets the start page number to be exported.

Parameters:

startPageNum - An int specifying the start page number.

getEndPageNumber

int getEndPageNumber()
                     throws SDKException

Returns the end page number to be exported.

Returns:

An int specifying the end page number.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setEndPageNumber

void setEndPageNumber(int endPageNum)

Sets the end page number to be exported.

Parameters:

endPageNum - An int specifying the end page number.