DataRowReader Class

Spotfire 14.3 API Reference
Represents a resettable iterator of rows values. It is used to retrieve data from a DataSource or DataTransformation.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.DataDataRowReader
    Spotfire.Dxp.Application.ExtensionCustomDataRowReader

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

C#
public abstract class DataRowReader : IDisposable

The DataRowReader type exposes the following members.

Properties

  NameDescription
Public propertyColumns
Represents a collection of the columns that the reader returns.
Public propertyIsClosed
Gets a value indicating whether the data reader is closed.
Public propertyResultProperties
Gets a read-only copy of the result properties, this is properties for the entire reader result and not for a specific column.
Top
Methods

  NameDescription
Public methodClose
Closes the data reader.
Public methodStatic memberCreateReader(IDataReader)
Creates a DataRowReader from the given IDataReader.
Public methodStatic memberCreateReader(IDataReader, ResultProperties)
Creates a DataRowReader from the given IDataReader.
Public methodStatic memberCreateReader(IDataReader, IListDataColumnProperties)
Creates a DataRowReader from the given IDataReader.
Public methodStatic memberCreateReader(IDataReader, IListDataColumnProperties, ResultProperties)
Creates a DataRowReader from the given IDataReader.
Public methodDispose
Dispose method.
Protected methodCode exampleDispose(Boolean)
Call when the caller is finished using the data reader.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Releases unmanaged resources and performs other cleanup operations before the DataReader2 is reclaimed by garbage collection.
(Overrides ObjectFinalize.)
Protected methodGetColumnsCore
The implementor should provide a list of DataRowReaderColumns that it returns.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetResultPropertiesCore
The implementor should provide the result properties.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMoveNext
Advances the reader to the next row.
Protected methodMoveNextCore
Advance to the next row. The implementor should update all DataValueCursors in the DataRowReaderColumns with values for the next row.
Public methodReset
Resets the reader so that the next time MoveNext is called the first row will be returned.
Protected methodResetCore
The implementor should implement this method to reset the enumerator. If this method is called then the MoveNextCore method should return the first row again when called the next time.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks

Instances of this class can be retrieved from a DataSourceConnection or a DataTransformationConnection.

It is not possible to inherit directly from this class, this should be done through the CustomDataRowReader class.

Version Information

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also

Reference