DelimitedTextSaveOptions

Inheritance: java.lang.Object

All Implemented Interfaces: com.groupdocs.editor.options.ISaveOptions

public final class DelimitedTextSaveOptions implements ISaveOptions

Contains options for generating and saving text-based Spreadsheet documents (CSV, Tab-based etc.), that use a separator (delimiter)


https://en.wikipedia.org/wiki/Delimiter-separated_values

Constructors

Constructor Description
DelimitedTextSaveOptions() This parameterless constructor creates a new instance of DelimitedTextSaveOptions with a semicolon (;) default separator (can be modified then through Separator (#getSeparator.getSeparator/#setSeparator(String).setSeparator(String)) property)
DelimitedTextSaveOptions(String separator) Creates an instance of options class for delimited text with mandatory separator (delimiter)

Methods

Method Description
getSeparator() Allows to specify a string separator (delimiter) for text-based Spreadsheet documents
setSeparator(String value) Allows to specify a string separator (delimiter) for text-based Spreadsheet documents
getEncoding() Allows to set an encoding for the text-based Spreadsheet document.
setEncoding(Charset value) Allows to set an encoding for the text-based Spreadsheet document.
getTrimLeadingBlankRowAndColumn() Indicates whether leading blank rows and columns should be trimmed like what MS Excel does
setTrimLeadingBlankRowAndColumn(boolean value) Indicates whether leading blank rows and columns should be trimmed like what MS Excel does
getKeepSeparatorsForBlankRow() Indicates whether separators should be output for blank row.
setKeepSeparatorsForBlankRow(boolean value) Indicates whether separators should be output for blank row.

DelimitedTextSaveOptions()

public DelimitedTextSaveOptions()

This parameterless constructor creates a new instance of DelimitedTextSaveOptions with a semicolon (;) default separator (can be modified then through Separator (#getSeparator.getSeparator/#setSeparator(String).setSeparator(String)) property)

DelimitedTextSaveOptions(String separator)

public DelimitedTextSaveOptions(String separator)

Creates an instance of options class for delimited text with mandatory separator (delimiter)

Parameters:

Parameter Type Description
separator java.lang.String String separator (delimiter) for text-based Spreadsheet documents

getSeparator()

public final String getSeparator()

Allows to specify a string separator (delimiter) for text-based Spreadsheet documents

Returns: java.lang.String -

setSeparator(String value)

public final void setSeparator(String value)

Allows to specify a string separator (delimiter) for text-based Spreadsheet documents

Parameters:

Parameter Type Description
value java.lang.String

getEncoding()

public final Charset getEncoding()

Allows to set an encoding for the text-based Spreadsheet document. By default (and if not specified) is UTF8.

Returns: java.nio.charset.Charset -

setEncoding(Charset value)

public final void setEncoding(Charset value)

Allows to set an encoding for the text-based Spreadsheet document. By default (and if not specified) is UTF8.

Parameters:

Parameter Type Description
value java.nio.charset.Charset

getTrimLeadingBlankRowAndColumn()

public final boolean getTrimLeadingBlankRowAndColumn()

Indicates whether leading blank rows and columns should be trimmed like what MS Excel does

Returns: boolean -

setTrimLeadingBlankRowAndColumn(boolean value)

public final void setTrimLeadingBlankRowAndColumn(boolean value)

Indicates whether leading blank rows and columns should be trimmed like what MS Excel does

Parameters:

Parameter Type Description
value boolean

getKeepSeparatorsForBlankRow()

public final boolean getKeepSeparatorsForBlankRow()

Indicates whether separators should be output for blank row. Default value is false which means the content for blank row will be empty.

Returns: boolean -

setKeepSeparatorsForBlankRow(boolean value)

public final void setKeepSeparatorsForBlankRow(boolean value)

Indicates whether separators should be output for blank row. Default value is false which means the content for blank row will be empty.

Parameters:

Parameter Type Description
value boolean