All Superinterfaces:: RWExportSettings

public interface RWExcelExportSettings
extends RWExportSettings

Since:: MicroStrategy Web 9.0.0

Field Summary
- Fields inherited from interface com.microstrategy.web.objects.rw.RWExportSettings
  PROPERTY_DEFAULT_PAGE_BY_EXPORT_MODE, PROPERTY_EXPORT_RANGE

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`getAddOfficeCommentBlock()`
`java.lang.String`	`getExcelVersion()`
`java.lang.String`	`getExportFooter()`	The content of export footer It works for reports only, when reports are rendered as dossiers in Library.
`java.lang.String`	`getExportHeader()`	The content of export header It works for reports only, when reports are rendered as dossiers in Library.
`int`	`getExportHeaderLocation()`	The location of export header It works for reports only, when reports are rendered as dossiers in Library.
`boolean`	`getIncludeFilterDetails()`	Whether to export filter details It works for reports only, when reports are rendered as dossiers in Library.
`boolean`	`getIncludePageByInfo()`	Whether to include pageby information It works for reports only, when reports are rendered as dossiers in Library.
`boolean`	`getIncludeReportTitle()`	Whether to export report title It works for reports only, when reports are rendered as dossiers in Library.
`java.lang.Boolean`	`getPagePerSheet()`	Whether to export each page-by on a separate sheet.
`int`	`getRange()`
`void`	`setAddOfficeCommentBlock(boolean value)`	Whether to generate the comment block for MicroStrategy Office
`void`	`setAutoSize(boolean value)`	Whether to generate the auto size for the Excel output.
`void`	`setEmbedGraphs(boolean value)`	Whether to embed the graphs on the Excel output.
`void`	`setEmbedImages(boolean value)`	Whether to embed the images on the Excel output.
`void`	`setExcelVersion(java.lang.String version)`	Excel version This must be a value from `EnumExcelVersion`
`void`	`setExportFooter(java.lang.String exportFooter)`
`void`	`setExportHeader(java.lang.String exportHeader)`
`void`	`setExportHeaderLocation(int exportHeaderLocation)`
`void`	`setIncludeFilterDetails(boolean includeFilterDetails)`
`void`	`setIncludePageByInfo(boolean includePageByInfo)`
`void`	`setIncludeReportTitle(boolean includeReportTitle)`
`void`	`setPagePerSheet(java.lang.Boolean enabled)`
`void`	`setRange(int exportRange)`	Sets the export range. 0=All layouts; 1=Current layout

Methods inherited from interface com.microstrategy.web.objects.rw.RWExportSettings
getExportOrientation, getExportOverview, getExportPaperHeight, getExportPaperWidth, getExportPDFFooter, getExportPDFHeader, getExportViz, getFilterSummary, getGridHorizontalPagination, getGridKey, getGridPagingMode, getGridRepeatHeader, getHtml5Vi, getHtmlDelayTime, getIsNewExportSetting, getMode, getNodeKeys, getOnetierVersion, getPassword, getSio, getSliceId, getStateID, getTableOfContents, getViewportHeight, getViewportWidth, isFromShowData, setExportOrientation, setExportOverview, setExportPaperHeight, setExportPaperWidth, setExportPDFFooter, setExportPDFHeader, setExportViz, setFilterSummary, setFromShowData, setGridHorizontalPagination, setGridKey, setGridPagingMode, setGridRepeatHeader, setHtml5Vi, setHtmlDelayTime, setIsNewExportSetting, setMode, setNodeKeys, setOnetierVersion, setPassword, setSio, setSliceId, setStateID, setTableOfContents, setViewportHeight, setViewportWidth

- Method Detail
  - setExcelVersion
```
void setExcelVersion(java.lang.String version)
```
    Excel version
    This must be a value from EnumExcelVersion
  - getExcelVersion
```
java.lang.String getExcelVersion()
```
  - setRange
```
void setRange(int exportRange)
```
    Sets the export range. 0=All layouts; 1=Current layout
    
    Parameters:
    
    exportRange -
  - getRange
```
int getRange()
```
  - setAddOfficeCommentBlock
```
void setAddOfficeCommentBlock(boolean value)
```
    Whether to generate the comment block for MicroStrategy Office
    
    Parameters:
    
    value - Whether to generate the comment block for MicroStrategy Office
  - getAddOfficeCommentBlock
```
boolean getAddOfficeCommentBlock()
```
  - setEmbedGraphs
```
void setEmbedGraphs(boolean value)
```
    Whether to embed the graphs on the Excel output.
    Overwrites the document property
    
    Parameters:
    
    value - Whether to embed the graphs on the Excel output
  - setEmbedImages
```
void setEmbedImages(boolean value)
```
    Whether to embed the images on the Excel output.
    Overwrites the document property
  - setAutoSize
```
void setAutoSize(boolean value)
```
    Whether to generate the auto size for the Excel output.
    Overwrites the document property
    
    Parameters:
    
    value - Whether to generate the comment block for MicroStrategy Office
  - getPagePerSheet
```
java.lang.Boolean getPagePerSheet()
```
    Whether to export each page-by on a separate sheet. It works for reports only, when reports are rendered as dossiers in Library.
  - setPagePerSheet
```
void setPagePerSheet(java.lang.Boolean enabled)
```
  - getIncludeReportTitle
```
boolean getIncludeReportTitle()
```
    Whether to export report title It works for reports only, when reports are rendered as dossiers in Library.
  - setIncludeReportTitle
```
void setIncludeReportTitle(boolean includeReportTitle)
```
  - getIncludeFilterDetails
```
boolean getIncludeFilterDetails()
```
    Whether to export filter details It works for reports only, when reports are rendered as dossiers in Library.
  - setIncludeFilterDetails
```
void setIncludeFilterDetails(boolean includeFilterDetails)
```
  - getExportHeader
```
java.lang.String getExportHeader()
```
    The content of export header It works for reports only, when reports are rendered as dossiers in Library.
  - setExportHeader
```
void setExportHeader(java.lang.String exportHeader)
```
  - getExportFooter
```
java.lang.String getExportFooter()
```
    The content of export footer It works for reports only, when reports are rendered as dossiers in Library.
  - setExportFooter
```
void setExportFooter(java.lang.String exportFooter)
```
  - getExportHeaderLocation
```
int getExportHeaderLocation()
```
    The location of export header It works for reports only, when reports are rendered as dossiers in Library.
  - setExportHeaderLocation
```
void setExportHeaderLocation(int exportHeaderLocation)
```
  - getIncludePageByInfo
```
boolean getIncludePageByInfo()
```
    Whether to include pageby information It works for reports only, when reports are rendered as dossiers in Library.
  - setIncludePageByInfo
```
void setIncludePageByInfo(boolean includePageByInfo)
```

Interface RWExcelExportSettings

Field Summary

Fields inherited from interface com.microstrategy.web.objects.rw.RWExportSettings

Method Summary

Methods inherited from interface com.microstrategy.web.objects.rw.RWExportSettings

Method Detail

setExcelVersion

getExcelVersion

setRange

getRange

setAddOfficeCommentBlock

getAddOfficeCommentBlock

setEmbedGraphs

setEmbedImages

setAutoSize

getPagePerSheet

setPagePerSheet

getIncludeReportTitle

setIncludeReportTitle

getIncludeFilterDetails

setIncludeFilterDetails

getExportHeader

setExportHeader

getExportFooter

setExportFooter

getExportHeaderLocation

setExportHeaderLocation

getIncludePageByInfo

setIncludePageByInfo