com.crystaldecisions.sdk.occa.report.exportoptions
Interface IDataOnlyExcelExportFormatOptions

All Superinterfaces:
IClone, IExportFormatOptions
All Known Implementing Classes:
DataOnlyExcelExportFormatOptions

public interface IDataOnlyExcelExportFormatOptions
extends IExportFormatOptions

This interface is used to specify the format of a document that is exported with Microsoft Excel (97-2003) Data-Only formatting.


Method Summary
 int getBaseAreaGroupNumber()
           Returns the base area group number if the area type is group area when exporting to Microsoft Excel (97-2003) Data-Only format.
 AreaSectionKind getBaseAreaType()
           Returns the AreaSectionKind, if constant column width is not used when exporting to Microsoft Excel (97-2003) format.
 int getConstantColWidth()
           Returns the column width when exporting to Microsoft Excel (97-2003) Data-Only format.
 boolean getExportImages()
           Returns whether the images are exported.
 boolean getExportObjectFormatting()
           Returns whether the object formatting is exported.
 boolean getExportPageHeaderAndFooter()
           Returns whether the page header and footer are exported.
 boolean getMaintainColumnAlignment()
           Returns whether column alignment is maintained when exporting to Microsoft Excel (97-2003) Data-Only format.
 boolean getMaintainRelativeObjectPosition()
           Returns whether the relative object position is maintained in the exported report.
 boolean getShowGroupOutlines()
           Returns whether the group information appears as Microsoft Excel (97-2003) outline symbols when exporting to Microsoft Excel (97-2003) Data-Only format.
 boolean getSimplifyPageHeaders()
           Returns whether page headers are to be simplified when exporting to Microsoft Excel (97-2003) Data-Only format.
 boolean getUseConstantColWidth()
           Returns whether the constant column width option is used when exporting to Microsoft Excel (97-2003) Data-Only format.
 boolean getUseWorksheetFunctionsForSummaries()
           Returns whether worksheet functions are to be used for summaries when exporting to Microsoft Excel (97-2003) Data-Only format.
 void setBaseAreaGroupNumber(int groupNumber)
           Sets the base area group number if the area type is group area when exporting to Microsoft Excel (97-2003) Data-Only format.
 void setBaseAreaType(AreaSectionKind areaType)
           Sets the AreaSectionKind, if constant column width is not used when exporting to Microsoft Excel (97-2003) Data-Only format.
 void setConstantColWidth(int colWidth)
           Sets the column width when exporting to Microsoft Excel (97-2003) Data-Only format.
 void setExportImages(boolean bExportImages)
           Sets whether the images are exported when exporting to Microsoft Excel (97-2003) Data-Only format.
 void setExportObjectFormatting(boolean bExportObjectFormatting)
           Sets whether the object formatting is exported.
 void setExportPageHeaderAndFooter(boolean bExportPageHeaderAndFooter)
           Sets whether the page header and footer are exported.
 void setMaintainColumnAlignment(boolean bMaintainColumnAlignment)
           Sets whether column alignment is maintained when exporting to Microsoft Excel (97-2003) Data-Only format.
 void setMaintainRelativeObjectPosition(boolean bMaintainRelativeObjectPosition)
           Sets whether the relative object position is maintained in the exported report.
 void setShowGroupOutlines(boolean bShowGroupOutlines)
           Sets whether the group information appears as Microsoft Excel (97-2003) outline symbols when exporting to Microsoft Excel (97-2003) Data-Only format.
 void setSimplifyPageHeaders(boolean bSimplifyPageHeaders)
           Sets whether page headers are to be simplified when exporting to Microsoft Excel (97-2003) Data-Only format.
 void setUseConstantColWidth(boolean bUseConstantColWidth)
           Sets whether the constant column width option is used when exporting to Microsoft Excel (97-2003) Data-Only format.
 void setUseWorksheetFunctionsForSummaries(boolean bUseWorksheetFunctionsForSummaries)
           Sets whether worksheet functions are to be used for summaries when exporting to Microsoft Excel (97-2003) Data-Only format.
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.exportoptions.IExportFormatOptions
checkValidity
 

Method Detail

getBaseAreaGroupNumber

int getBaseAreaGroupNumber()

Returns the base area group number if the area type is group area when exporting to Microsoft Excel (97-2003) Data-Only format.

Returns:
The base area group number as an int.

getConstantColWidth

int getConstantColWidth()

Returns the column width when exporting to Microsoft Excel (97-2003) Data-Only format.

Returns:
The column width as an int.

getBaseAreaType

AreaSectionKind getBaseAreaType()

Returns the AreaSectionKind, if constant column width is not used when exporting to Microsoft Excel (97-2003) format.

Returns:
The AreaSectionKind, if constant column width is not used.

getExportObjectFormatting

boolean getExportObjectFormatting()

Returns whether the object formatting is exported.

Returns:
true if the object formatting is exported when exporting to Microsoft Excel (97-2003) Data-Only format, and false otherwise.

getUseConstantColWidth

boolean getUseConstantColWidth()

Returns whether the constant column width option is used when exporting to Microsoft Excel (97-2003) Data-Only format.

Returns:
true if the constant column width option is used when exporting to Microsoft Excel (97-2003) Data-Only format, and false otherwise.

getExportPageHeaderAndFooter

boolean getExportPageHeaderAndFooter()

Returns whether the page header and footer are exported.

Returns:
true if the page header and footer are exported when exporting to Microsoft Excel (97-2003) Data-Only format, and false otherwise.

getExportImages

boolean getExportImages()

Returns whether the images are exported.

Returns:
true if the images are exported when exporting to Microsoft Excel (97-2003) Data-Only format, and false otherwise.

getMaintainRelativeObjectPosition

boolean getMaintainRelativeObjectPosition()

Returns whether the relative object position is maintained in the exported report.

Returns:
true if the relative object position is maintained in the exported report, and false otherwise.

getUseWorksheetFunctionsForSummaries

boolean getUseWorksheetFunctionsForSummaries()

Returns whether worksheet functions are to be used for summaries when exporting to Microsoft Excel (97-2003) Data-Only format.

Returns:
true if the worksheet functions are to be used for summaries in the exported report, and false otherwise.

getMaintainColumnAlignment

boolean getMaintainColumnAlignment()

Returns whether column alignment is maintained when exporting to Microsoft Excel (97-2003) Data-Only format.

Returns:
true if column alignment is maintained when exporting to Microsoft Excel (97-2003) Data-Only format, and false otherwise.

getSimplifyPageHeaders

boolean getSimplifyPageHeaders()

Returns whether page headers are to be simplified when exporting to Microsoft Excel (97-2003) Data-Only format.

If this method returns true, the simplest version of your Crystal report's page headers are exported. For example, if your page header includes two or more rows of objects, the program exports only the bottom row. If this method returns false, the program exports all objects in the page header (to a single row in the spreadsheet).

Returns:
true if the page headers are to be simplified in the exported report, and false otherwise.

setBaseAreaGroupNumber

void setBaseAreaGroupNumber(int groupNumber)

Sets the base area group number if the area type is group area when exporting to Microsoft Excel (97-2003) Data-Only format.

Parameters:
groupNumber - The base area group number as an int.

setConstantColWidth

void setConstantColWidth(int colWidth)

Sets the column width when exporting to Microsoft Excel (97-2003) Data-Only format.

Parameters:
colWidth - The column width when exporting to Microsoft Excel (97-2003) Data-Only format as an int.

setBaseAreaType

void setBaseAreaType(AreaSectionKind areaType)

Sets the AreaSectionKind, if constant column width is not used when exporting to Microsoft Excel (97-2003) Data-Only format.

Parameters:
areaType - The AreaSectionKind, if constant column width is not used when exporting to Microsoft Excel (97-2003) Data-Only format.

setExportObjectFormatting

void setExportObjectFormatting(boolean bExportObjectFormatting)

Sets whether the object formatting is exported.

Parameters:
bExportObjectFormatting - true if the object formatting is exported, and false otherwise.

setUseConstantColWidth

void setUseConstantColWidth(boolean bUseConstantColWidth)

Sets whether the constant column width option is used when exporting to Microsoft Excel (97-2003) Data-Only format.

Parameters:
bUseContantColWidth - true if the constant column width option is used when exporting to Microsoft Excel (97-2003) Data-Only format, and false otherwise.

setExportPageHeaderAndFooter

void setExportPageHeaderAndFooter(boolean bExportPageHeaderAndFooter)

Sets whether the page header and footer are exported.

Parameters:
bExportPageHeaderAndFooter - true if the page header and footer are exported when exporting to Microsoft Excel (97-2003) Data-Only format, and false otherwise.

setExportImages

void setExportImages(boolean bExportImages)

Sets whether the images are exported when exporting to Microsoft Excel (97-2003) Data-Only format.

Parameters:
bExportImages - true if the images are exported when exporting to Microsoft Excel (97-2003) Data-Only format, and false otherwise.

setMaintainRelativeObjectPosition

void setMaintainRelativeObjectPosition(boolean bMaintainRelativeObjectPosition)

Sets whether the relative object position is maintained in the exported report.

Parameters:
bMaintainRelativeObjectPosition - true if the relative object position is maintained in the exported report, and false otherwise.

setUseWorksheetFunctionsForSummaries

void setUseWorksheetFunctionsForSummaries(boolean bUseWorksheetFunctionsForSummaries)

Sets whether worksheet functions are to be used for summaries when exporting to Microsoft Excel (97-2003) Data-Only format.

Parameters:
bUseWorksheetFunctionsForSummaries - true if worksheet functions are to be used for summaries when exporting to Microsoft Excel (97-2003) Data-Only format, and false otherwise.

setMaintainColumnAlignment

void setMaintainColumnAlignment(boolean bMaintainColumnAlignment)

Sets whether column alignment is maintained when exporting to Microsoft Excel (97-2003) Data-Only format.

Parameters:
bMaintainColumnAlignment - true if column alignment is maintained when exporting to Microsoft Excel (97-2003) Data-Only format, and false otherwise.

setSimplifyPageHeaders

void setSimplifyPageHeaders(boolean bSimplifyPageHeaders)

Sets whether page headers are to be simplified when exporting to Microsoft Excel (97-2003) Data-Only format.

Set this option to true to export the simplest version of your Crystal report's page headers. For example, if your page header includes two or more rows of objects, the program exports only the bottom row. If this option is not selected, the program exports all objects in the page header (to a single row in the spreadsheet).

Parameters:
bSimplifyPageHeaders - true page headers are to be simplified when exporting to Microsoft Excel (97-2003) Data-Only format, and false otherwise.

getShowGroupOutlines

boolean getShowGroupOutlines()

Returns whether the group information appears as Microsoft Excel (97-2003) outline symbols when exporting to Microsoft Excel (97-2003) Data-Only format.

Microsoft Excel (97-2003) supports eight levels of outline symbols. If the report has more than eight levels of group information, the entire report will be exported, but only eight levels of outline symbols will appear in the Microsoft Excel (97-2003) worksheet.

Returns:
true if the group information appears as Microsoft Excel (97-2003) outline symbols when exporting to Microsoft Excel (97-2003) Data-Only format, and false otherwise.

setShowGroupOutlines

void setShowGroupOutlines(boolean bShowGroupOutlines)

Sets whether the group information appears as Microsoft Excel (97-2003) outline symbols when exporting to Microsoft Excel (97-2003) Data-Only format.

Microsoft Excel (97-2003) supports eight levels of outline symbols. If the report has more than eight levels of group information, the entire report will be exported, but only eight levels of outline symbols will appear in the Microsoft Excel (97-2003) worksheet.

Parameters:
bShowGroupOutlines - true if the group information appears as Microsoft Excel (97-2003) outline symbols when exporting to Microsoft Excel (97-2003) Data-Only format, and false otherwise.