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

public interface IExcelDataOnlyFormat

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

Method Summary

short	getBaseAreaGroupNum() Returns the group section the column width will be based on.
int	getBaseAreaType() Returns the section the column width will be based on.
double	getConstColWidth() Returns the size of the constant column width.
boolean	isColAlignmentMaintained() Returns whether or not to maintain column alignments.
boolean	isConstColWidthUsed() Returns whether or not to use constant column widths.
boolean	isFormatUsed() Returns whether or not to export object formats and fonts.
boolean	isImageExported() Returns whether or not to export images.
boolean	isPageHeaderExported() Returns whether or not to export the header and footer.
boolean	isPageHeaderSimplified() Returns whether or not to simplify the page header.
boolean	isRelativeObjPositionMaintained() Returns whether to maintain relative object position.
boolean	isShowGroupOutlines() Returns whether to show group outlines.
boolean	isWorksheetFuncUsed() Returns whether or not to use Excel worksheet functions to represent summary fields.
void	setBaseAreaGroupNum(short BaseAreaGroupNum) Sets the group section the column width will be based on.
void	setBaseAreaType(int baseAreaType) Sets the section the column width will be based on.
void	setColAlignmentMaintained(boolean maintainColAlignment) Sets whether or not to maintain column alignments.
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	setFormatUsed(boolean useFormat) Sets whether or not to export object formats and fonts.
void	setImageExported(boolean exportImage) Sets whether or not to export images.
void	setPageHeaderExported(boolean exportPageHeader) Sets whether or not to export the page header and footer.
void	setPageHeaderSimplified(boolean simplifyPageHeader) Sets whether or not to simplify the page header.
void	setRelativeObjPositionMaintained(boolean placeInOneRow) Sets whether to maintain relative object position.
void	setShowGroupOutlines(boolean shown) Sets whether to show group outlines.
void	setWorksheetFuncUsed(boolean useWorksheetFunc) Sets whether or not to use Excel worksheet functions to represent summary fields.

Method Detail

isConstColWidthUsed

public 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, and false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setConstColWidthUsed

public 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, and false otherwise.

getBaseAreaType

public int getBaseAreaType()
                    throws SDKException

Returns the section the column width will be based on.

Returns:

An int specifying which section the column width will be based on.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setBaseAreaType

public void setBaseAreaType(int baseAreaType)

Sets the section the column width will be based on.

Parameters:

baseAreaType - An int specifying which section the column width will be based on.

getBaseAreaGroupNum

public short getBaseAreaGroupNum()
                          throws SDKException

Returns the group section the column width will be based on. This is only valid when BaseAreaType specifies a group header or group footer.

Returns:

A short specifying the group section the column width will be based on.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setBaseAreaGroupNum

public void setBaseAreaGroupNum(short BaseAreaGroupNum)

Sets the group section the column width will be based on. This is only valid when BaseAreaType specifies a group header or group footer.

Parameters:

BaseAreaGroupNum - A short specifying the group section the column width will be based on.

getConstColWidth

public 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

public void setConstColWidth(double constColWidth)

Sets the size of the constant column width.

Parameters:

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

isPageHeaderExported

public boolean isPageHeaderExported()
                             throws SDKException

Returns whether or not to export the header and footer.

Returns:

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

Throws:

SDKException - This is thrown if the process is unsuccessful.

setPageHeaderExported

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

isPageHeaderSimplified

public boolean isPageHeaderSimplified()
                               throws SDKException

Returns whether or not to simplify the page header. This option is only valid when the report format is ExcelDataOnly.

Returns:

true if the page header will be simplified, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setPageHeaderSimplified

public void setPageHeaderSimplified(boolean simplifyPageHeader)

Sets whether or not to simplify the page header. This option is only valid when the report format is ExcelDataOnly.

Parameters:

simplifyPageHeader - true if the page header will be simplified, false otherwise.

isWorksheetFuncUsed

public boolean isWorksheetFuncUsed()
                            throws SDKException

Returns whether or not to use Excel worksheet functions to represent summary fields. This option is only valid when the report format is ExcelDataOnly.

Returns:

true if worksheet functions will be used to represent subtotal fields, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setWorksheetFuncUsed

public void setWorksheetFuncUsed(boolean useWorksheetFunc)

Sets whether or not to use Excel worksheet functions to represent summary fields. This option is only valid when the report format is ExcelDataOnly.

Parameters:

useWorksheetFunc - true if worksheet functions will be used to represent subtotal fields, false otherwise. false otherwise.

isImageExported

public boolean isImageExported()
                        throws SDKException

Returns whether or not to export images. This option is only valid when the report format is ExcelDataOnly.

Returns:

true if images will be exported, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setImageExported

public void setImageExported(boolean exportImage)

Sets whether or not to export images. This option is only valid when the report format is ExcelDataOnly.

Parameters:

exportImage - true if images will be exported, false otherwise.

isFormatUsed

public boolean isFormatUsed()
                     throws SDKException

Returns whether or not to export object formats and fonts. This option is only valid when the report format is ExcelDataOnly.

Returns:

true if formats will be used, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setFormatUsed

public void setFormatUsed(boolean useFormat)

Sets whether or not to export object formats and fonts. This option is only valid when the report format is ExcelDataOnly.

Parameters:

useFormat - true if formats will be used, false otherwise.

isColAlignmentMaintained

public boolean isColAlignmentMaintained()
                                 throws SDKException

Returns whether or not to maintain column alignments. This option is only valid when the report format is ExcelDataOnly.

Returns:

true if column alignments will be maintained, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setColAlignmentMaintained

public void setColAlignmentMaintained(boolean maintainColAlignment)

Sets whether or not to maintain column alignments. This option is only valid when the report format is ExcelDataOnly.

Parameters:

maintainColAlignment - true if column alignments will be maintained, false otherwise.

isRelativeObjPositionMaintained

public boolean isRelativeObjPositionMaintained()
                                        throws SDKException

Returns whether to maintain relative object position. Only valid when report format is ExcelDataOnly.

Returns:

true if all section objects will be placed in one row, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setRelativeObjPositionMaintained

public void setRelativeObjPositionMaintained(boolean placeInOneRow)

Sets whether to maintain relative object position. Only valid when report format is ExcelDataOnly.

Parameters:

placeInOneRow - true if all section objects will be placed in one row. false otherwise.

isShowGroupOutlines

public boolean isShowGroupOutlines()
                            throws SDKException

Returns whether to show group outlines. Only valid when the report format is ExcelDataOnly.

Returns:

A boolean value that indicates whether group outlines will be shown.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setShowGroupOutlines

public void setShowGroupOutlines(boolean shown)

Sets whether to show group outlines. Only valid when the report format is ExcelDataOnly.

Parameters:

shown - a boolean value that indicates whether group outlines will be shown.