DataRowReaderColumnGetFormattedCursor Method (IDataFormatter)

Spotfire 15.0 API Reference
Get a formatted cursor for retrieving the formatted values from this column with a specified formatter. The cursor will contain the formatted value in the current row after MoveNext has been called.

Namespace:  Spotfire.Dxp.Data
Assembly:  Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 71.0.22122.5390 (71.0.22122.5390)
Syntax

C#
public DataValueCursor<string> GetFormattedCursor(
	IDataFormatter formatter
)

Parameters

formatter
Type: Spotfire.Dxp.Data.FormattersIDataFormatter
The formatter that should be used to format the values.

Return Value

Type: DataValueCursorString
A cursor which can be used to retrieve the formatted values for the current row.
Exceptions

ExceptionCondition
ArgumentNullExceptionThrown if the formatter is null.
Version Information


See Also

Reference