|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IExcelExportFormatOptions
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 |
---|
int getBaseAreaGroupNumber()
Returns the base area group number if the area type is group area when exporting to Microsoft Excel (97-2003) format.
int
.AreaSectionKind getBaseAreaType()
Returns the AreaSectionKind
, if
constant column width is not used when exporting to Microsoft Excel (97-2003) format.
AreaSectionKind
, if
constant column width is not used.int getConstantColWidth()
Returns the column width when exporting to Excel format.
int
.boolean getExcelTabHasColumnHeadings()
Returns whether the column headings option is used when exporting to Microsoft Excel (97-2003) format.
true
if the column headings option is used when exporting to Microsoft Excel (97-2003)
format, and false
otherwise.boolean getUseConstantColWidth()
Returns whether the constant column width option is used when exporting to Microsoft Excel (97-2003) format.
true
if the constant column width option is used when exporting to
Excel format, and false
otherwise.ExportPageAreaPairKind getExportPageAreaPairType()
Returns the ExportPageAreaPairKind
object, which indicates how the page header
and footer pair are to be exported.
ExportPageAreaPairKind
object.boolean getShowGridlines()
Returns whether the gridlines will show in the exported report.
true
if the gridlines will show in the exported report, and
false
otherwise.boolean getMaintainRelativeObjectPosition()
Returns whether the relative object position is maintained in the exported report.
true
if the relative object position is maintained in the exported
report, and false
otherwise.boolean getExportPageBreaks()
Returns whether page breaks are exported.
true
if page breaks are exported, and false
otherwise.boolean getConvertDatesToStrings()
Returns whether the dates are converted to strings in the exported report.
true
if the dates are converted to strings in the exported report, and
false
otherwise.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.
groupNumber
- The base area group number as an int
.void setBaseAreaType(AreaSectionKind areaType)
Sets the AreaSectionKind
, if
constant column width is not used when exporting to Excel format.
areaType
- 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.
colWidth
- The column width when exporting to Excel format as an int
.void setExcelTabHasColumnHeadings(boolean hasColumnHeadings)
Sets whether the column headings option is used when exporting to Microsoft Excel (97-2003) format.
hasColumnHeadings
- true
if the column headings option is used when
exporting to Excel format, and false
otherwise.void setUseConstantColWidth(boolean useContantColWidth)
Sets whether the constant column width option is used when exporting to Microsoft Excel (97-2003) format.
useContantColWidth
- true
if the constant column width option is used
when exporting to Excel format, and false
otherwise.void setExportPageAreaPairType(ExportPageAreaPairKind exportPageAreaType)
Sets the ExportPageAreaPairKind
object, which specifies how the page header
and footer pair are to be exported.
exportPageAreaType
- The ExportPageAreaPairKind
object.void setShowGridlines(boolean showGridlines)
Sets whether the gridlines will show in the exported report.
showGridlines
- true
if the gridlines will show in the exported report,
and false
otherwise.void setMaintainRelativeObjectPosition(boolean maintainRelativeObjectPosition)
Sets whether the relative object position is maintained in the exported report.
maintainRelativeObjectPosition
- true
if the relative object position is
maintained in the exported report, and false
otherwise.void setExportPageBreaks(boolean exportPageBreaks)
Sets whether page breaks are exported.
exportPageBreaks
- true
if page breaks are exported, and
false
otherwise.void setConvertDatesToStrings(boolean convertDatesToStrings)
Sets whether the dates are converted to strings in the exported report.
convertDatesToStrings
- true
if the dates are converted to strings in the
exported report, and false
otherwise.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |