GrapeCity.Spreadsheet.IRange.TextToColumns

TextToColumns Method

TextToColumns(int, int, TextParsingType, TextQualifier, bool, bool, bool, bool, bool, bool, char, Tuple<int, ColumnDataType>[], char, char, bool)

Parses a column of cells that contain text into several columns.

Declaration

ActionResult<object> TextToColumns(int row = -1, int column = -1, TextParsingType dataType = TextParsingType.Delimited, TextQualifier textQualifier = TextQualifier.None, bool consecutiveDelimiter = false, bool tab = false, bool semicolon = false, bool comma = false, bool space = false, bool other = false, char otherChar = '\0', Tuple<int, ColumnDataType>[] fieldInfo = null, char decimalSeparator = '\0', char thousandsSeparator = '\0', bool trailingMinusNumbers = false)

Function TextToColumns(Optional row As Integer = -1, Optional column As Integer = -1, Optional dataType As TextParsingType = TextParsingType.Delimited, Optional textQualifier As TextQualifier = TextQualifier.None, Optional consecutiveDelimiter As Boolean = False, Optional tab As Boolean = False, Optional semicolon As Boolean = False, Optional comma As Boolean = False, Optional space As Boolean = False, Optional other As Boolean = False, Optional otherChar As Char = vbNullChar, Optional fieldInfo As Tuple(Of Integer, ColumnDataType)() = Nothing, Optional decimalSeparator As Char = vbNullChar, Optional thousandsSeparator As Char = vbNullChar, Optional trailingMinusNumbers As Boolean = False) As ActionResult(Of Object)

Parameters

Type	Name	Description
int	row	An integer value that specifies the row where Spread will place the results.
int	column	An integer value that specifies the column where Spread will place the results.
TextParsingType	dataType	The format of the text to be split into columns.
TextQualifier	textQualifier	Specifies whether to use single, double, or no quotes as the text qualifier.
bool	consecutiveDelimiter	True to have Spread consider consecutive delimiters as one delimiter. The default value is False.
bool	tab	`true` to have `dataType` be Delimited and to have the tab character be a delimiter. The default value is `true`.
bool	semicolon	`true` to have `dataType` be Delimited and to have the semicolon character be a delimiter. The default value is `true`.
bool	comma	`true` to have `dataType` be Delimited and to have the comma character be a delimiter. The default value is `true`.
bool	space	`true` to have `dataType` be Delimited and to have the space character be a delimiter. The default value is `true`.
bool	other	`true` to have `dataType` be Delimited and to have the `otherChar` character be a delimiter. The default value is `true`.
char	otherChar	Required if `other` is `true`; the delimiter character when `other` is `true`. If more than one character is specified, only the first character of the string is used; the remaining characters are ignored.
Tuple<int, ColumnDataType>[]	fieldInfo	An array containing parse information for the individual columns of data. The interpretation depends on the value of `dataType`. When the data is delimited, this argument is an array of two-element arrays, with each two-element array specifying the conversion options for a particular column. The first element is the column number, and the second element is one of the ColumnDataType constants specifying how the column is parsed.
char	decimalSeparator	The decimal separator that Spread uses when recognizing numbers. The default setting is the system setting.
char	thousandsSeparator	The thousands separator that Spread uses when recognizing numbers. The default setting is the system setting.
bool	trailingMinusNumbers	Numbers that begin with a minus character.

Returns

Type	Description
ActionResult<object>	`true` if the columns are inserted successful, `false` otherwise.

TextToColumns(IRange, TextParsingType, TextQualifier, bool, bool, bool, bool, bool, bool, char, Tuple<int, ColumnDataType>[], char, char, bool)

Parses a column of cells that contain text into several columns.

Declaration

ActionResult<object> TextToColumns(IRange destination, TextParsingType dataType = TextParsingType.Delimited, TextQualifier textQualifier = TextQualifier.None, bool consecutiveDelimiter = false, bool tab = false, bool semicolon = false, bool comma = false, bool space = false, bool other = false, char otherChar = '\0', Tuple<int, ColumnDataType>[] fieldInfo = null, char decimalSeparator = '\0', char thousandsSeparator = '\0', bool trailingMinusNumbers = false)

Function TextToColumns(destination As IRange, Optional dataType As TextParsingType = TextParsingType.Delimited, Optional textQualifier As TextQualifier = TextQualifier.None, Optional consecutiveDelimiter As Boolean = False, Optional tab As Boolean = False, Optional semicolon As Boolean = False, Optional comma As Boolean = False, Optional space As Boolean = False, Optional other As Boolean = False, Optional otherChar As Char = vbNullChar, Optional fieldInfo As Tuple(Of Integer, ColumnDataType)() = Nothing, Optional decimalSeparator As Char = vbNullChar, Optional thousandsSeparator As Char = vbNullChar, Optional trailingMinusNumbers As Boolean = False) As ActionResult(Of Object)

Parameters

Type	Name	Description
IRange	destination	An IRange object that specifies where Spread will place the results. If the range is larger than a single cell, the top left cell is used.
TextParsingType	dataType	The format of the text to be split into columns.
TextQualifier	textQualifier	Specifies whether to use single, double, or no quotes as the text qualifier.
bool	consecutiveDelimiter	True to have Spread consider consecutive delimiters as one delimiter. The default value is False.
bool	tab	`true` to have `dataType` be Delimited and to have the tab character be a delimiter. The default value is `true`.
bool	semicolon	`true` to have `dataType` be Delimited and to have the semicolon character be a delimiter. The default value is `true`.
bool	comma	`true` to have `dataType` be Delimited and to have the comma character be a delimiter. The default value is `true`.
bool	space	`true` to have `dataType` be Delimited and to have the space character be a delimiter. The default value is `true`.
bool	other	`true` to have `dataType` be Delimited and to have the `otherChar` character be a delimiter. The default value is `true`.
char	otherChar	Required if `other` is `true`; the delimiter character when `other` is `true`. If more than one character is specified, only the first character of the string is used; the remaining characters are ignored.
Tuple<int, ColumnDataType>[]	fieldInfo	An array containing parse information for the individual columns of data. The interpretation depends on the value of `dataType`. When the data is delimited, this argument is an array of two-element arrays, with each two-element array specifying the conversion options for a particular column. The first element is the column number, and the second element is one of the ColumnDataType constants specifying how the column is parsed.
char	decimalSeparator	The decimal separator that Spread uses when recognizing numbers. The default setting is the system setting.
char	thousandsSeparator	The thousands separator that Spread uses when recognizing numbers. The default setting is the system setting.
bool	trailingMinusNumbers	Numbers that begin with a minus character.

Returns

Type	Description
ActionResult<object>	`true` if the columns are inserted successful, `false` otherwise.

TextToColumns(string, TextParsingType, TextQualifier, bool, bool, bool, bool, bool, bool, char, Tuple<int, ColumnDataType>[], char, char, bool)

Parses a column of cells that contain text into several columns.

Declaration

ActionResult<object> TextToColumns(string destination, TextParsingType dataType = TextParsingType.Delimited, TextQualifier textQualifier = TextQualifier.None, bool consecutiveDelimiter = false, bool tab = false, bool semicolon = false, bool comma = false, bool space = false, bool other = false, char otherChar = '\0', Tuple<int, ColumnDataType>[] fieldInfo = null, char decimalSeparator = '\0', char thousandsSeparator = '\0', bool trailingMinusNumbers = false)

Function TextToColumns(destination As String, Optional dataType As TextParsingType = TextParsingType.Delimited, Optional textQualifier As TextQualifier = TextQualifier.None, Optional consecutiveDelimiter As Boolean = False, Optional tab As Boolean = False, Optional semicolon As Boolean = False, Optional comma As Boolean = False, Optional space As Boolean = False, Optional other As Boolean = False, Optional otherChar As Char = vbNullChar, Optional fieldInfo As Tuple(Of Integer, ColumnDataType)() = Nothing, Optional decimalSeparator As Char = vbNullChar, Optional thousandsSeparator As Char = vbNullChar, Optional trailingMinusNumbers As Boolean = False) As ActionResult(Of Object)

Parameters

Type	Name	Description
string	destination	A string value that specifies where Spread will place the results. If the range is larger than a single cell, the top left cell is used.
TextParsingType	dataType	The format of the text to be split into columns.
TextQualifier	textQualifier	Specifies whether to use single, double, or no quotes as the text qualifier.
bool	consecutiveDelimiter	`true` to have Spread consider consecutive delimiters as one delimiter.
bool	tab	`true` to have `dataType` be Delimited and to have the tab character be a delimiter.
bool	semicolon	`true` to have `dataType` be Delimited and to have the semicolon character be a delimiter.
bool	comma	`true` to have `dataType` be Delimited and to have the comma character be a delimiter.
bool	space	`true` to have `dataType` be Delimited and to have the space character be a delimiter.
bool	other	`true` to have `dataType` be Delimited and to have the `otherChar` character be a delimiter.
char	otherChar	Required if `other` is `true`; the delimiter character when `other` is `true`. If more than one character is specified, only the first character of the string is used; the remaining characters are ignored.
Tuple<int, ColumnDataType>[]	fieldInfo	An array containing parse information for the individual columns of data. The interpretation depends on the value of `dataType`. When the data is delimited, this argument is an array of two-element arrays, with each two-element array specifying the conversion options for a particular column. The first element is the column number, and the second element is one of the ColumnDataType constants specifying how the column is parsed.
char	decimalSeparator	The decimal separator that Spread uses when recognizing numbers. The default setting is the system setting.
char	thousandsSeparator	The thousands separator that Spread uses when recognizing numbers. The default setting is the system setting.
bool	trailingMinusNumbers	Numbers that begin with a minus character.

Returns

Type	Description
ActionResult<object>	`true` if the columns are inserted successful, `false` otherwise.