DataRowReaderColumn.GetFormattedCursor Method (IDataFormatter)

DataRowReaderColumn GetFormattedCursor Method (IDataFormatter)

TIBCO Spotfire 6.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: 13.19.7018.3940 (13.19.7018.3940)

Syntax

C++

Copy to Clipboard Print

public DataValueCursor<string> GetFormattedCursor(
	IDataFormatter formatter
)

public DataValueCursor<string> GetFormattedCursor(
	IDataFormatter formatter
)

Parameters

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

Return Value

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

Exceptions

Exception	Condition
System ArgumentNullException	Thrown if the formatter is null.