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

All Superinterfaces:

IPageFormat

public interface IPaginatedTextFormat
extends IPageFormat

For internal use only

Nested Class Summary

static interface	IPaginatedTextFormat.ExportCharsetType
static interface	IPaginatedTextFormat.PageAreaExportType

Method Summary

int	getCharactersPerInch() Gets the number of characters per inch.
int	getExportCharsetType() Gets the export charset type.
int	getMinimumLinesPerPage() Gets the number of minimum lines per page.
int	getPageAreaExportType() Gets the page area export type.
boolean	isInsertFormFeedCharacter() Gets the isInsertFormFeedCharacter.
void	setCharactersPerInch(int charsPerInch) Sets the number of characters per inch.
void	setExportCharsetType(int exportCharsetType) Sets the export charset type.
void	setInsertFormFeedCharacter(boolean bInsertFormFeedCharacter) Sets the isInsertFormFeedCharacter.
void	setMinimumLinesPerPage(int minLinesPerPage) Sets the number of minimum lines per page.
void	setPageAreaExportType(int pageAreaExportType) Sets the page area export type.

Methods inherited from interface com.crystaldecisions.sdk.plugin.desktop.common.IPageFormat

getEndPageNumber, getStartPageNumber, isAllPagesExported, setAllPageExported, setEndPageNumber, setStartPageNumber

Method Detail

getPageAreaExportType

int getPageAreaExportType()
                          throws SDKException

Gets the page area export type.

Returns:

An int representing the page area export type which is a value defined in PageAreaExportType

Throws:

SDKException - This is thrown if the process is unsuccessful.

setPageAreaExportType

void setPageAreaExportType(int pageAreaExportType)

Sets the page area export type.

Parameters:

pageAreaExportType - An int representing the page area export type which is a value defined in PageAreaExportType.

getMinimumLinesPerPage

int getMinimumLinesPerPage()
                           throws SDKException

Gets the number of minimum lines per page.

Returns:

An int that specifies the number of minimum lines per page.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setMinimumLinesPerPage

void setMinimumLinesPerPage(int minLinesPerPage)

Sets the number of minimum lines per page.

Parameters:

minLinesPerPage - An int that specifies the number of minimum lines per page.

getCharactersPerInch

int getCharactersPerInch()
                         throws SDKException

Gets the number of characters per inch.

Returns:

An int that specifies number of characters per inch.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setCharactersPerInch

void setCharactersPerInch(int charsPerInch)

Sets the number of characters per inch.

Parameters:

charsPerInch - An int that specifies the number of characters per inch.

getExportCharsetType

int getExportCharsetType()
                         throws SDKException

Gets the export charset type.

Returns:

An int representing the export charset type which is a value defined in ExportCharsetType

Throws:

SDKException - This is thrown if the process is unsuccessful.

setExportCharsetType

void setExportCharsetType(int exportCharsetType)

Sets the export charset type.

Parameters:

pageAreaExportType - An int representing the export charset type which is a value defined in ExportCharsetType.

isInsertFormFeedCharacter

boolean isInsertFormFeedCharacter()
                                  throws SDKException

Gets the isInsertFormFeedCharacter.

Returns:

An boolean that specifies the isInsertFormFeedCharacter.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setInsertFormFeedCharacter

void setInsertFormFeedCharacter(boolean bInsertFormFeedCharacter)

Sets the isInsertFormFeedCharacter.

Parameters:

bInsertFormFeedCharacter - An boolean that specifies the isInsertFormFeedCharacter.