RWExcelExportSettings (Web API 2021)

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()`
`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`	`setRange(int exportRange)`	Sets the export range.

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