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

All Superinterfaces:
IClone, IExportFormatOptions, IPageBasedExportFormatOptions
All Known Implementing Classes:
ExcelExportFormatOptions

public interface IExcelExportFormatOptions
extends IPageBasedExportFormatOptions

This interface is used to specify the format of a document that is exported with Microsoft Excel (97-2003) 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) 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 Excel format.
 boolean getConvertDatesToStrings()
           Returns whether the dates are converted to strings in the exported report.
 boolean getExcelTabHasColumnHeadings()
           Returns whether the column headings option is used when exporting to Microsoft Excel (97-2003) format.
 ExportPageAreaPairKind getExportPageAreaPairType()
           Returns the ExportPageAreaPairKind object, which indicates how the page header and footer pair are to be exported.
 boolean getExportPageBreaks()
           Returns whether page breaks are exported.
 boolean getMaintainRelativeObjectPosition()
           Returns whether the relative object position is maintained in the exported report.
 boolean getShowGridlines()
           Returns whether the gridlines will show in the exported report.
 boolean getUseConstantColWidth()
           Returns whether the constant column width option is used when exporting to Microsoft Excel (97-2003) 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) format.
 void setBaseAreaType(AreaSectionKind areaType)
           Sets the AreaSectionKind, if constant column width is not used when exporting to Excel format.
 void setConstantColWidth(int colWidth)
           Sets the column width when exporting to Excel format.
 void setConvertDatesToStrings(boolean convertDatesToStrings)
           Sets whether the dates are converted to strings in the exported report.
 void setExcelTabHasColumnHeadings(boolean hasColumnHeadings)
           Sets whether the column headings option is used when exporting to Microsoft Excel (97-2003) format.
 void setExportPageAreaPairType(ExportPageAreaPairKind exportPageAreaType)
           Sets the ExportPageAreaPairKind object, which specifies how the page header and footer pair are to be exported.
 void setExportPageBreaks(boolean exportPageBreaks)
           Sets whether page breaks are exported.
 void setMaintainRelativeObjectPosition(boolean maintainRelativeObjectPosition)
           Sets whether the relative object position is maintained in the exported report.
 void setShowGridlines(boolean showGridlines)
           Sets whether the gridlines will show in the exported report.
 void setUseConstantColWidth(boolean useContantColWidth)
           Sets whether the constant column width option is used when exporting to Microsoft Excel (97-2003) format.
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.exportoptions.IPageBasedExportFormatOptions
getEndPageNumber, getStartPageNumber, setEndPageNumber, setStartPageNumber
 
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) format.

Returns:
The base area group number 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.

getConstantColWidth

int getConstantColWidth()

Returns the column width when exporting to Excel format.

Returns:
The column width as an int.

getExcelTabHasColumnHeadings

boolean getExcelTabHasColumnHeadings()

Returns whether the column headings option is used when exporting to Microsoft Excel (97-2003) format.

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

getUseConstantColWidth

boolean getUseConstantColWidth()

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

Returns:
true if the constant column width option is used when exporting to Excel format, and false otherwise.

getExportPageAreaPairType

ExportPageAreaPairKind getExportPageAreaPairType()

Returns the ExportPageAreaPairKind object, which indicates how the page header and footer pair are to be exported.

Returns:
a reference to the ExportPageAreaPairKind object.

getShowGridlines

boolean getShowGridlines()

Returns whether the gridlines will show in the exported report.

Returns:
true if the gridlines will show in the exported report, 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.

getExportPageBreaks

boolean getExportPageBreaks()

Returns whether page breaks are exported.

Returns:
true if page breaks are exported, and false otherwise.

getConvertDatesToStrings

boolean getConvertDatesToStrings()

Returns whether the dates are converted to strings in the exported report.

Returns:
true if the dates are converted to strings 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) format.

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

setBaseAreaType

void setBaseAreaType(AreaSectionKind areaType)

Sets the AreaSectionKind, if constant column width is not used when exporting to Excel format.

Parameters:
areaType - The AreaSectionKind, if constant column width is not used when exporting to Excel format.

setConstantColWidth

void setConstantColWidth(int colWidth)

Sets the column width when exporting to Excel format.

Parameters:
colWidth - The column width when exporting to Excel format as an int.

setExcelTabHasColumnHeadings

void setExcelTabHasColumnHeadings(boolean hasColumnHeadings)

Sets whether the column headings option is used when exporting to Microsoft Excel (97-2003) format.

Parameters:
hasColumnHeadings - true if the column headings option is used when exporting to Excel format, and false otherwise.

setUseConstantColWidth

void setUseConstantColWidth(boolean useContantColWidth)

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

Parameters:
useContantColWidth - true if the constant column width option is used when exporting to Excel format, and false otherwise.

setExportPageAreaPairType

void setExportPageAreaPairType(ExportPageAreaPairKind exportPageAreaType)

Sets the ExportPageAreaPairKind object, which specifies how the page header and footer pair are to be exported.

Parameters:
exportPageAreaType - The ExportPageAreaPairKind object.

setShowGridlines

void setShowGridlines(boolean showGridlines)

Sets whether the gridlines will show in the exported report.

Parameters:
showGridlines - true if the gridlines will show in the exported report, and false otherwise.

setMaintainRelativeObjectPosition

void setMaintainRelativeObjectPosition(boolean maintainRelativeObjectPosition)

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

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

setExportPageBreaks

void setExportPageBreaks(boolean exportPageBreaks)

Sets whether page breaks are exported.

Parameters:
exportPageBreaks - true if page breaks are exported, and false otherwise.

setConvertDatesToStrings

void setConvertDatesToStrings(boolean convertDatesToStrings)

Sets whether the dates are converted to strings in the exported report.

Parameters:
convertDatesToStrings - true if the dates are converted to strings in the exported report, and false otherwise.