|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.crystaldecisions.sdk.occa.report.exportoptions.DataOnlyExcelExportFormatOptions
public class DataOnlyExcelExportFormatOptions
This class is used to specify the format of a document
that is exported with Microsoft Excel (97-2003) Data-Only formatting. When possible, use the
IDataOnlyExcelExportFormatOptions
interface to manipulate this object.
Constructor Summary | |
---|---|
DataOnlyExcelExportFormatOptions()
|
|
DataOnlyExcelExportFormatOptions(IDataOnlyExcelExportFormatOptions src)
|
Method Summary | |
---|---|
void |
checkValidity(java.util.Locale locale)
Verifies that the export options are valid for a given locale. |
java.lang.Object |
clone(boolean deepClone)
|
void |
copyTo(java.lang.Object destObject,
boolean deepCopy)
|
java.lang.Object |
createMember(java.lang.String eleName,
org.xml.sax.Attributes attrs,
XMLSerializationContext ctxt,
java.util.Map objState,
boolean[] bLoaded)
For internal use only. |
void |
endElement(java.lang.String eleName,
java.util.Map objState)
For internal use only. |
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. |
boolean |
hasContent(java.lang.Object obj)
|
void |
readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
For internal use only. |
void |
save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
For internal use only. |
void |
save(XMLWriter writer,
XMLSerializationContext ctxt)
For internal use only. |
void |
saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
For internal use only. |
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 showGroupOutlines)
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. |
void |
startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
For internal use only. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DataOnlyExcelExportFormatOptions()
public DataOnlyExcelExportFormatOptions(IDataOnlyExcelExportFormatOptions src)
Method Detail |
---|
public int getBaseAreaGroupNumber()
IDataOnlyExcelExportFormatOptions
Returns the base area group number if the area type is group area when exporting to Microsoft Excel (97-2003) Data-Only format.
getBaseAreaGroupNumber
in interface IDataOnlyExcelExportFormatOptions
int
.public int getConstantColWidth()
IDataOnlyExcelExportFormatOptions
Returns the column width when exporting to Microsoft Excel (97-2003) Data-Only format.
getConstantColWidth
in interface IDataOnlyExcelExportFormatOptions
int
.public AreaSectionKind getBaseAreaType()
IDataOnlyExcelExportFormatOptions
Returns the AreaSectionKind
,
if constant column width is not used when exporting to Microsoft Excel (97-2003) format.
getBaseAreaType
in interface IDataOnlyExcelExportFormatOptions
AreaSectionKind
,
if constant column width is not used.public boolean getExportObjectFormatting()
IDataOnlyExcelExportFormatOptions
Returns whether the object formatting is exported.
getExportObjectFormatting
in interface IDataOnlyExcelExportFormatOptions
true
if the object formatting is exported when exporting to Microsoft Excel (97-2003) Data-Only format,
and false
otherwise.public boolean getUseConstantColWidth()
IDataOnlyExcelExportFormatOptions
Returns whether the constant column width option is used when exporting to Microsoft Excel (97-2003) Data-Only format.
getUseConstantColWidth
in interface IDataOnlyExcelExportFormatOptions
true
if the constant column width option is used when exporting to Microsoft Excel (97-2003) Data-Only format,
and false
otherwise.public boolean getExportPageHeaderAndFooter()
IDataOnlyExcelExportFormatOptions
Returns whether the page header and footer are exported.
getExportPageHeaderAndFooter
in interface IDataOnlyExcelExportFormatOptions
true
if the page header and footer are exported when exporting to Microsoft Excel (97-2003) Data-Only format,
and false
otherwise.public boolean getExportImages()
IDataOnlyExcelExportFormatOptions
Returns whether the images are exported.
getExportImages
in interface IDataOnlyExcelExportFormatOptions
true
if the images are exported when exporting to Microsoft Excel (97-2003) Data-Only format,
and false
otherwise.public boolean getMaintainRelativeObjectPosition()
IDataOnlyExcelExportFormatOptions
Returns whether the relative object position is maintained in the exported report.
getMaintainRelativeObjectPosition
in interface IDataOnlyExcelExportFormatOptions
true
if the relative object position is maintained in the exported report, and false
otherwise.public boolean getUseWorksheetFunctionsForSummaries()
IDataOnlyExcelExportFormatOptions
Returns whether worksheet functions are to be used for summaries when exporting to Microsoft Excel (97-2003) Data-Only format.
getUseWorksheetFunctionsForSummaries
in interface IDataOnlyExcelExportFormatOptions
true
if the worksheet functions are to be used for summaries in the exported report,
and false
otherwise.public boolean getMaintainColumnAlignment()
IDataOnlyExcelExportFormatOptions
Returns whether column alignment is maintained when exporting to Microsoft Excel (97-2003) Data-Only format.
getMaintainColumnAlignment
in interface IDataOnlyExcelExportFormatOptions
true
if column alignment is maintained when exporting to Microsoft Excel (97-2003) Data-Only format,
and false
otherwise.public boolean getSimplifyPageHeaders()
IDataOnlyExcelExportFormatOptions
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).
getSimplifyPageHeaders
in interface IDataOnlyExcelExportFormatOptions
true
if the page headers are to be simplified in the exported report, and false
otherwise.public void setBaseAreaGroupNumber(int groupNumber)
IDataOnlyExcelExportFormatOptions
Sets the base area group number if the area type is group area when exporting to Microsoft Excel (97-2003) Data-Only format.
setBaseAreaGroupNumber
in interface IDataOnlyExcelExportFormatOptions
groupNumber
- The base area group number as an int
.public void setConstantColWidth(int colWidth)
IDataOnlyExcelExportFormatOptions
Sets the column width when exporting to Microsoft Excel (97-2003) Data-Only format.
setConstantColWidth
in interface IDataOnlyExcelExportFormatOptions
colWidth
- The column width when exporting to Microsoft Excel (97-2003) Data-Only format as an int
.public void setBaseAreaType(AreaSectionKind areaType)
IDataOnlyExcelExportFormatOptions
Sets the AreaSectionKind
,
if constant column width is not used when exporting to Microsoft Excel (97-2003) Data-Only format.
setBaseAreaType
in interface IDataOnlyExcelExportFormatOptions
areaType
- The AreaSectionKind
,
if constant column width is not used when exporting to Microsoft Excel (97-2003) Data-Only format.public void setExportObjectFormatting(boolean bExportObjectFormatting)
IDataOnlyExcelExportFormatOptions
Sets whether the object formatting is exported.
setExportObjectFormatting
in interface IDataOnlyExcelExportFormatOptions
bExportObjectFormatting
- true
if the object formatting is exported,
and false
otherwise.public void setUseConstantColWidth(boolean bUseConstantColWidth)
IDataOnlyExcelExportFormatOptions
Sets whether the constant column width option is used when exporting to Microsoft Excel (97-2003) Data-Only format.
setUseConstantColWidth
in interface IDataOnlyExcelExportFormatOptions
public void setExportPageHeaderAndFooter(boolean bExportPageHeaderAndFooter)
IDataOnlyExcelExportFormatOptions
Sets whether the page header and footer are exported.
setExportPageHeaderAndFooter
in interface IDataOnlyExcelExportFormatOptions
bExportPageHeaderAndFooter
- true
if the page header and footer are exported when exporting to Microsoft Excel (97-2003) Data-Only format,
and false
otherwise.public void setExportImages(boolean bExportImages)
IDataOnlyExcelExportFormatOptions
Sets whether the images are exported when exporting to Microsoft Excel (97-2003) Data-Only format.
setExportImages
in interface IDataOnlyExcelExportFormatOptions
bExportImages
- true
if the images are exported when exporting to Microsoft Excel (97-2003) Data-Only format,
and false
otherwise.public void setMaintainRelativeObjectPosition(boolean bMaintainRelativeObjectPosition)
IDataOnlyExcelExportFormatOptions
Sets whether the relative object position is maintained in the exported report.
setMaintainRelativeObjectPosition
in interface IDataOnlyExcelExportFormatOptions
bMaintainRelativeObjectPosition
- true
if the relative object position is maintained in the exported report,
and false
otherwise.public void setUseWorksheetFunctionsForSummaries(boolean bUseWorksheetFunctionsForSummaries)
IDataOnlyExcelExportFormatOptions
Sets whether worksheet functions are to be used for summaries when exporting to Microsoft Excel (97-2003) Data-Only format.
setUseWorksheetFunctionsForSummaries
in interface IDataOnlyExcelExportFormatOptions
bUseWorksheetFunctionsForSummaries
- true
if worksheet functions are to be used for summaries
when exporting to Microsoft Excel (97-2003) Data-Only format, and false
otherwise.public void setMaintainColumnAlignment(boolean bMaintainColumnAlignment)
IDataOnlyExcelExportFormatOptions
Sets whether column alignment is maintained when exporting to Microsoft Excel (97-2003) Data-Only format.
setMaintainColumnAlignment
in interface IDataOnlyExcelExportFormatOptions
bMaintainColumnAlignment
- true
if column alignment is maintained
when exporting to Microsoft Excel (97-2003) Data-Only format, and false
otherwise.public void setSimplifyPageHeaders(boolean bSimplifyPageHeaders)
IDataOnlyExcelExportFormatOptions
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).
setSimplifyPageHeaders
in interface IDataOnlyExcelExportFormatOptions
bSimplifyPageHeaders
- true
page headers are to be simplified
when exporting to Microsoft Excel (97-2003) Data-Only format, and false
otherwise.public java.lang.Object clone(boolean deepClone)
public void copyTo(java.lang.Object destObject, boolean deepCopy)
public boolean hasContent(java.lang.Object obj)
public void checkValidity(java.util.Locale locale)
IExportFormatOptions
checkValidity
in interface IExportFormatOptions
locale
- the locale the options are being checked forpublic java.lang.Object createMember(java.lang.String eleName, org.xml.sax.Attributes attrs, XMLSerializationContext ctxt, java.util.Map objState, boolean[] bLoaded)
For internal use only.
public void endElement(java.lang.String eleName, java.util.Map objState)
For internal use only.
public void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
For internal use only.
public void save(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
public void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
public void saveContents(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
public void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
For internal use only.
public boolean getShowGroupOutlines()
IDataOnlyExcelExportFormatOptions
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.
getShowGroupOutlines
in interface IDataOnlyExcelExportFormatOptions
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.public void setShowGroupOutlines(boolean showGroupOutlines)
IDataOnlyExcelExportFormatOptions
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.
setShowGroupOutlines
in interface IDataOnlyExcelExportFormatOptions
showGroupOutlines
- 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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |