Package com.microstrategy.web.objects

Interface WebReportExcelExportSettings

All Superinterfaces:

WebReportExportSettings

public interface WebReportExcelExportSettings
extends WebReportExportSettings

Interface for configuring export to excel settings. Obtained by casting the return object of WebReportInstance.getExportSettings() when WebReportInstance.setExecutionMode(int) was previously set to EnumWebReportExecutionModes.REPORT_MODE_EXCEL.

Since:

MicroStrategy Web 8.0.1

Field Summary

Fields inherited from interface com.microstrategy.web.objects.WebReportExportSettings

PROPERTY_CUSTOM_EXCEL_REPORT_FOOTER, PROPERTY_CUSTOM_EXCEL_REPORT_HEADER, PROPERTY_CUSTOM_REPORT_HEADER

Method Summary

Modifier and Type	Method	Description
int	getGraphType()
java.lang.String	getGraphURL()
java.lang.String	getLayout()
java.lang.String	getOutlineState()
int	getVersion()
boolean	isOfficeRefreshAllowed()	Whether MicroStrategy Office, if installed, is allowed to refresh the report.
boolean	isShowHeaderAndFooter()	Whether to show the Header and Footer on the exported results. The default value is true.
void	setGraphType(int graphType)
void	setGraphURL(java.lang.String url)	Excel cannot render certain varieties of graphs.
void	setLayout(java.lang.String xml)	This governs how the Excel document is laid out.
void	setOfficeRefresh(boolean isAllowed)
void	setOutlineState(java.lang.String xml)	If outline mode is enabled, this configures which nodes are closed/opened.
void	setSeparateSheets(boolean isSeparateSheets)
void	setShowHeaderAndFooter(boolean value)	Whether to show the Header and Footer on the exported results. The default value is true.
void	setVersion(int version)

Methods inherited from interface com.microstrategy.web.objects.WebReportExportSettings

getCustomProperties, getFormatType, getMode, getViewMode, setFormatType, setMode, setViewMode

Method Detail

setLayout

void setLayout(java.lang.String xml)

This governs how the Excel document is laid out.

Parameters:

xml - the layout xml - please use WebReportExcelLayoutBuilder to generate it

getLayout

java.lang.String getLayout()

Returns:

the layout xml

See Also:

setLayout(String)

setOutlineState

void setOutlineState(java.lang.String xml)

If outline mode is enabled, this configures which nodes are closed/opened.

Parameters:

xml - the outline xml.

getOutlineState

java.lang.String getOutlineState()

Returns:

the outline xml

See Also:

setOutlineState(String)

setGraphURL

void setGraphURL(java.lang.String url)

Excel cannot render certain varieties of graphs. In such cases, a graph image can be embedded instead. Note that if it is dynamically generated by the Intelligence Server, the image will only be visible during while the user's session is valid.

Parameters:

url - address of the graph image

getGraphURL

java.lang.String getGraphURL()

Returns:

address of the graph image

See Also:

setGraphURL(String)

setOfficeRefresh

void setOfficeRefresh(boolean isAllowed)

Parameters:

isAllowed - Whether to allow MicroStrategy Office, if installed, to refresh the report

isOfficeRefreshAllowed

boolean isOfficeRefreshAllowed()

Whether MicroStrategy Office, if installed, is allowed to refresh the report. Default is false.

Returns:

whether MicroStrategy Office, if installed, is allowed to refresh the report

setVersion

void setVersion(int version)

Parameters:

version - Excel version as defined in EnumExcelVersion

getVersion

int getVersion()

Returns:

Excel version as defined in EnumExcelVersion

setGraphType

void setGraphType(int graphType)

Parameters:

graphType - the graph type as defined in EnumDSSXMLGraphImgTypes

Since:

MicroStrategy Web 8.0.2

getGraphType

int getGraphType()

Returns:

graph type as defined in EnumDSSXMLGraphImgTypes

Since:

MicroStrategy Web 8.0.2

setSeparateSheets

void setSeparateSheets(boolean isSeparateSheets)

setShowHeaderAndFooter

void setShowHeaderAndFooter(boolean value)

Whether to show the Header and Footer on the exported results.
The default value is true.

Parameters:

value - Whether to show the Header and Footer on the exported results

isShowHeaderAndFooter

boolean isShowHeaderAndFooter()

Whether to show the Header and Footer on the exported results.
The default value is true.

Returns:

Whether to show the Header and Footer on the exported results