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

All Superinterfaces:

IPageFormat

public interface IExcelFormat
extends IPageFormat

The IExcelFormat interface allows you to set the options for a report that is to be scheduled as an Excel spreadsheet. You can customize cell and column formats as well as how worksheet functions are used.

Nested Class Summary

static interface	IExcelFormat.CeReportExportHeaderFooterOption Specifies the way page header and footer are exported.
static interface	IExcelFormat.SectionType Specifies the section to base the column width on when exporting to Excel.

Method Summary

short	getBaseAreaGroupNum() Returns which group section to base the column width on.
int	getBaseAreaType() Returns which section to base the column width on.
double	getConstColWidth() Returns the size of the constant column width.
int	getExportPageHeaderFooter() Returns the way page header and footer are exported.
boolean	isColumnHeadingAvailable() Returns whether or not to use column headings.
boolean	isConstColWidthUsed() Returns whether or not to use constant column widths.
boolean	isDateConvertedToString() Returns whether or not to convert the date to a string value.
boolean	isGridlineShown() Returns whether or not to include gridlines during exporting.
boolean	isPageBreakCreated() Returns whether or not to create page breaks.
boolean	isPageHeaderExported() Returns whether or not to export the page header and footer.
boolean	isTabularFormat() Returns whether or not to use a tabular format.
void	setBaseAreaGroupNum(short BaseAreaGroupNum) Sets which group section to base the column width on.
void	setBaseAreaType(int baseAreaType) Sets which section to base the column width on.
void	setColumnHeadingAvailable(boolean columnHeadings) Sets whether or not to use column headings.
void	setConstColWidth(double constColWidth) Sets the size of the constant column width.
void	setConstColWidthUsed(boolean useConstColWidth) Sets whether or not to use constant column widths.
void	setDateConvertedToString(boolean convertDateToString) Sets whether or not to convert the date to a string value.
void	setExportPageHeaderFooter(int type) Sets the way page header and footer are exported.
void	setGridlineShown(boolean includeGridlines) Sets whether or not to include gridlines during exporting.
void	setPageBreakCreated(boolean createPageBreak) Sets whether or not to create page breaks.
void	setPageHeaderExported(boolean exportPageHeader) Sets whether or not to export the page header and footer.
void	setTabularFormat(boolean isTabularFormat) Sets whether or not to use a tabular format.

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

getEndPageNumber, getStartPageNumber, isAllPagesExported, setAllPageExported, setEndPageNumber, setStartPageNumber

Method Detail

isColumnHeadingAvailable

boolean isColumnHeadingAvailable()
                                 throws SDKException

Returns whether or not to use column headings.

Returns:

true if column headings will be used, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setColumnHeadingAvailable

void setColumnHeadingAvailable(boolean columnHeadings)

Sets whether or not to use column headings.

Parameters:

columnHeadings - true if column headings will be used, false otherwise.

isConstColWidthUsed

boolean isConstColWidthUsed()
                            throws SDKException

Returns whether or not to use constant column widths.

Note: The value for this property must be within the range 10-288.

Returns:

true if constant column widths will be used, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setConstColWidthUsed

void setConstColWidthUsed(boolean useConstColWidth)

Sets whether or not to use constant column widths.

Note: The value for this property must be within the range 10-288.

Parameters:

useConstColWidth - true if constant column widths will be used, false otherwise.

getConstColWidth

double getConstColWidth()
                        throws SDKException

Returns the size of the constant column width.

Returns:

A Double specifying the size of the constant column width.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setConstColWidth

void setConstColWidth(double constColWidth)

Sets the size of the constant column width.

Parameters:

constColWidth - A double specifying the size of the constant column width.

isTabularFormat

boolean isTabularFormat()
                        throws SDKException

Returns whether or not to use a tabular format.

Returns:

true if tabular format will be used, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setTabularFormat

void setTabularFormat(boolean isTabularFormat)

Sets whether or not to use a tabular format.

Parameters:

isTabularFormat - true if tabular format will be used, false otherwise.

getBaseAreaType

int getBaseAreaType()
                    throws SDKException

Returns which section to base the column width on.

Returns:

An int specifying which section to base the column width on, of type IExcelFormat.SectionType.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

com.crystaldecisions.com.sdk.plugin.desktop.common.IExcelFormat.SectionType

setBaseAreaType

void setBaseAreaType(int baseAreaType)

Sets which section to base the column width on.

Parameters:

baseAreaType - An int specifying which section to base the column width on, of type IExcelFormat.SectionType.

See Also:

com.crystaldecisions.com.sdk.plugin.desktop.common.IExcelFormat.SectionType

getBaseAreaGroupNum

short getBaseAreaGroupNum()
                          throws SDKException

Returns which group section to base the column width on. This is only valid when BaseAreaType specifies a group header or group footer.

Returns:

A short specifying the group section to base the column width on.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setBaseAreaGroupNum

void setBaseAreaGroupNum(short BaseAreaGroupNum)

Sets which group section to base the column width on. This is only valid when BaseAreaType specifies a group header or group footer.

Parameters:

BaseAreaGroupNum - A short specifying the group section to base the column width on.

isPageBreakCreated

boolean isPageBreakCreated()
                           throws SDKException

Returns whether or not to create page breaks.

Returns:

true if page breaks will be created, and false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setPageBreakCreated

void setPageBreakCreated(boolean createPageBreak)

Sets whether or not to create page breaks.

Parameters:

createPageBreak - true if page breaks will be created, and false otherwise.

isDateConvertedToString

boolean isDateConvertedToString()
                                throws SDKException

Returns whether or not to convert the date to a string value.

Returns:

true if date will be converted to string, and false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setDateConvertedToString

void setDateConvertedToString(boolean convertDateToString)

Sets whether or not to convert the date to a string value.

Parameters:

convertDateToString - true if the date will be converted to a string value. false otherwise.

isPageHeaderExported

boolean isPageHeaderExported()
                             throws SDKException

Returns whether or not to export the page header and footer.

Returns:

true if the page header and footer will be exported, and false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setPageHeaderExported

void setPageHeaderExported(boolean exportPageHeader)

Sets whether or not to export the page header and footer.

Parameters:

exportPageHeader - true if the page header and footer will be exported, false otherwise.

getExportPageHeaderFooter

int getExportPageHeaderFooter()
                              throws SDKException

Returns the way page header and footer are exported.

Returns:

A int of type CeReportExportHeaderFooterOption.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

com.crystaldecisions.com.sdk.plugin.desktop.common.CeReportExportHeaderFooterOption

setExportPageHeaderFooter

void setExportPageHeaderFooter(int type)

Sets the way page header and footer are exported.

Parameters:

type - page header and footer export format, corresponding to types defined in CeReportExportHeaderFooterOption.

See Also:

com.crystaldecisions.com.sdk.plugin.desktop.common.CeReportExportHeaderFooterOption

isGridlineShown

boolean isGridlineShown()
                        throws SDKException

Returns whether or not to include gridlines during exporting.

Returns:

true if export include gridlines, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setGridlineShown

void setGridlineShown(boolean includeGridlines)

Sets whether or not to include gridlines during exporting.

Parameters:

includeGridlines - true if gridlines are included during exporting. false otherwise.