public class CellsOptions extends Object
Provides options for rendering Cells documents.
Modifier and Type | Field and Description |
---|---|
static int |
TEXT_OVERFLOW_MODE_DEFAULT
Constant
TEXT_OVERFLOW_MODE_DEFAULT=TextOverflowMode.OverlayIfNextIsEmpty |
Constructor and Description |
---|
CellsOptions()
Initializes a new instance of the
CellsOptions class. |
Modifier and Type | Method and Description |
---|---|
int |
getCountRowsPerPage()
The number of rows rendered into one page when one page per sheet rendering mode is not enabled.
|
Charset |
getEncoding()
The text (*.csv) document encoding.
|
com.aspose.ms.System.Text.Encoding |
getEncodingInternal()
The text (*.csv) document encoding.
|
int |
getFlags()
Gets flags.
|
String |
getInternalHyperlinkPrefix()
Prefix for hyperlink that references worksheet inside the same document.
|
boolean |
getOnePagePerSheet()
Specifies worksheet rendering mode.
|
boolean |
getShowGridLines()
Indicates whether to show grid lines in converted document.
|
boolean |
getShowHiddenSheets()
Indicates whether hidden sheets should be rendered.
|
int |
getTextOverflowMode()
Text overflow mode applied when the text is too big to fit into the cell.
|
boolean |
hasNonDefaultFlags()
Has non default flags boolean.
|
void |
setCountRowsPerPage(int value)
The number of rows rendered into one page when one page per sheet rendering mode is not enabled.
|
void |
setEncoding(Charset value)
The text (*.csv) document encoding.
|
void |
setInternalHyperlinkPrefix(String value)
Prefix for hyperlink that references worksheet inside the same document.
|
void |
setOnePagePerSheet(boolean value)
Specifies worksheet rendering mode.
|
void |
setShowGridLines(boolean value)
Indicates whether to show grid lines in converted document.
|
void |
setShowHiddenSheets(boolean value)
Indicates whether hidden sheets should be rendered.
|
void |
setTextOverflowMode(int value)
Text overflow mode applied when the text is too big to fit into the cell.
|
public static final int TEXT_OVERFLOW_MODE_DEFAULT
TEXT_OVERFLOW_MODE_DEFAULT=TextOverflowMode.OverlayIfNextIsEmpty
public CellsOptions()
Initializes a new instance of the CellsOptions
class.
public boolean getShowGridLines()
Indicates whether to show grid lines in converted document. The default value is false.
The following example demonstrates how to set ShowGridLines property.public void setShowGridLines(boolean value)
Indicates whether to show grid lines in converted document. The default value is false.
The following example demonstrates how to set ShowGridLines property.value
- a boolean.public boolean getOnePagePerSheet()
Specifies worksheet rendering mode. Default value is true.
The following example demonstrates how to enable one page per sheet rendering mode. When one page per sheet rendering is enabled, all worksheet content is rendered into a single page. Otherwise worksheet content is divided into pages, where each page includes count of rows defined in count rows per page option.public void setOnePagePerSheet(boolean value)
Specifies worksheet rendering mode. Default value is true.
The following example demonstrates how to enable one page per sheet rendering mode. When one page per sheet rendering is enabled, all worksheet content is rendered into a single page. Otherwise worksheet content is divided into pages, where each page includes count of rows defined in count rows per page option.value
- a boolean.public boolean getShowHiddenSheets()
Indicates whether hidden sheets should be rendered. The default value is false.
The following example demonstrates how to enable rendering of the hidden sheets.public void setShowHiddenSheets(boolean value)
Indicates whether hidden sheets should be rendered. The default value is false.
The following example demonstrates how to enable rendering of the hidden sheets.value
- a boolean.public Charset getEncoding()
The text (*.csv) document encoding.
The following example demonstrates how to set Encoding for rendering csv documents.Charset
object.public com.aspose.ms.System.Text.Encoding getEncodingInternal()
The text (*.csv) document encoding.
public void setEncoding(Charset value)
The text (*.csv) document encoding.
The following example demonstrates how to set Encoding for rendering csv documents.value
- a Charset
object.public String getInternalHyperlinkPrefix()
Prefix for hyperlink that references worksheet inside the same document.
The following example demonstrates how to set prefix for internal hyperlinks. Excel workbook may contain hyperlink to specific location in the same workbook. Internal hyperlink prefix is useful for applications where workbook sheets are rendered separately one by one. In this case internal hyperlink may contain some REST API method address with referenced sheet name. Value may contain page number placeholder which will be substituted with referenced sheet number.String
object.public void setInternalHyperlinkPrefix(String value)
Prefix for hyperlink that references worksheet inside the same document.
The following example demonstrates how to set prefix for internal hyperlinks. Excel workbook may contain hyperlink to specific location in the same workbook. Internal hyperlink prefix is useful for applications where workbook sheets are rendered separately one by one. In this case internal hyperlink may contain some REST API method address with referenced sheet name. Value may contain page number placeholder which will be substituted with referenced sheet number.value
- a String
object.public int getCountRowsPerPage()
The number of rows rendered into one page when one page per sheet rendering mode is not enabled. Default value is 50.
The following example demonstrates how to set rendering of 100 rows into each page.public void setCountRowsPerPage(int value)
The number of rows rendered into one page when one page per sheet rendering mode is not enabled. Default value is 50.
The following example demonstrates how to set rendering of 100 rows into each page.value
- a int.public int getTextOverflowMode()
Text overflow mode applied when the text is too big to fit into the cell. Default value is TextOverflowMode.OverlayIfNextIsEmpty.
The following example demonstrates how to set TextOverflowMode property. Text overflow mode is only applicable for rendering into HTML.public void setTextOverflowMode(int value)
Text overflow mode applied when the text is too big to fit into the cell. Default value is TextOverflowMode.OverlayIfNextIsEmpty.
The following example demonstrates how to set TextOverflowMode property. Text overflow mode is only applicable for rendering into HTML.value
- a int.public boolean hasNonDefaultFlags()
public int getFlags()
Copyright © 2018. All rights reserved.