StiDataSource Class

The base class that realizes the Data Source.

Inheritance Hierarchy

SystemObject
Stimulsoft.Report.DictionaryStiDataSource
Stimulsoft.Report.DictionaryStiDataStoreSource

Namespace: Stimulsoft.Report.Dictionary
Assembly: Stimulsoft.Report (in Stimulsoft.Report.dll) Version: 2019.3.1.0

Syntax

ASP.NET

Copy

public abstract class StiDataSource : ICloneable, 
	IStiAppDataSource, IStiAppCell, IStiStateSaveRestore, IStiEnumerator, IEnumerator, 
	IEnumerable, IStiName, IStiInherited, IStiPropertyGridObject, IStiJsonReportObject

Public MustInherit Class StiDataSource
	Implements ICloneable, IStiAppDataSource, IStiAppCell, IStiStateSaveRestore, 
	IStiEnumerator, IEnumerator, IEnumerable, IStiName, IStiInherited, 
	IStiPropertyGridObject, IStiJsonReportObject

The StiDataSource type exposes the following members.

Constructors

	Name	Description
	StiDataSource(String, String)	Creates a new Data Source.
	StiDataSource(String, String, String)	Creates a new Data Source.

Top

Properties

	Name	Description
	Alias	Gets or sets of the Data Source alias.
	ColumnIndexes
	Columns	Gets or sets the column collection.
	ComponentId
	ConnectionOrder	Gets or sets value which indicates in which order that datasource will be connect to the data.
	ConnectOnStart	Gets or sets value which indicates that datasource not connect to the data automatically.
	Count	Gets count of elements.
	DataAdapterType
	DataTable	Gets DataTable.
	DetailRows
	Dictionary	Gets or sets the dictionary in which this Data Source is located.
	Inherited
	IsBof	Gets value indicates that this position specifies to the beginning of data.
	IsCloud	Gets or sets value which indicates that this data source is created dynamically by the Stimulsoft Reports.Server.
	IsConnected	Gets value indicates which Data Source is connected with data.
	IsEmpty	Gets value indicates that no data.
	IsEof	Gets value indicates that this position specifies to the data end.
	Item	Indexer to work with the current row of data. Returns the value by the column name and the current position in the Data Source. Indexer calls the method GetData. ColumnName - name of column.
	Key	Gets or sets the key of the dictionary object.
	Name	Gets or sets of the Data Source name.
	Parameters	Gets or sets the parameter collection.
	Position	Gets the current position.
	PropName
	RealCount
	Rows	Gets or sets rows collection.
	RowToLevel
	States	Gets the component states manager.

Top

Methods

	Name	Description
	CheckColumnsIndexs	Internal use only.
	ClearAllStates	Clear all earlier saved object states.
	Clone	Creates a new object that is a copy of the current instance.
	Connect
	Connect(Boolean)
	Connect(StiDataCollection)
	Connect(StiDataCollection, Boolean)	Connect Data Source to data. It is necessary to call the parent of the method(base.Connect).
	CreateNew
	Disconnect
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	FetchChildRelations	Returns an enumeration of the child data relations for this data source.
	FetchColumns	Returns an enumeration of the data columns from this dictionary.
	FetchColumnValues	Returns an array of values for the specified column in the specified position.
	FetchParentRelations	Returns an enumeration of the parent data relations for this data source.
	FillColumns
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	First	Sets a position at the beginning.
	GetCategoryName	Returns the name to categories of the Data Source.
	GetChildDataSource	Returns the child Data Source by the relation name.
	GetChildRelations	Returns a collection of Child relations.
	GetColumnIndex	Returns the index of a column in the data source.
	GetConnection	Returns a connection to data for this data source.
	GetData(String)	Returns the value by the column name and the current position in the Data Source.
	GetData(String, Int32)	Returns the value by the column name and index of row in the Data Source.
	GetDataAdapter
	GetDataAdapterType
	GetDataTable
	GetDataTable(Boolean)	Returns a DataTable with data from this datasource.
	GetDataTable(DataTable)
	GetDictionary	Returns reference to the dictionary which contains this datasource.
	GetEvents
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetLevel	Returns level of data in hierarchical band.
	GetName
	GetNameInSource
	GetParentData	Returns the parent row with data for the indicated relation.
	GetParentDataSource	Returns the parent Data Source by the relation name.
	GetParentRelations	Returns the colection of Parent relations.
	GetProperties
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InvokeConnecting
	InvokeDisconnecting
	Last	Sets a position on the last element.
	LoadFromJsonObject
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Next	Sets a position on the next element.
	Prior	Sets a position on the previous element.
	ResetData
	ResetDetailsRows
	RestoreState	Restores the earlier saved object state.
	SaveState	Saves the current state of an object.
	SaveToJsonObject
	SetData
	SetDetails	Set the details data for Data Source.
	SetFilter	Apply filter to data.
	SetSort	Sorts data. If data source is not able to sort data then this command is ignored.
	SynchronizeColumns	Synchronize list of columns with columns in datastore.
	ToString	Returns the text view of the Data Source. (Overrides ObjectToString.)
	ToString(Boolean)

Top

Events

	Name	Description
	Connecting
	Disconnecting

Top

Fields

	Name	Description
	isBofValue
	isEofValue
	positionValue

Top

Extension Methods

	Name	Description
	ChildRelationList	(Defined by StiDataSourceExt.)
	GetFixedName	(Defined by StiDataSourceExt.)
	ParentRelationList	(Defined by StiDataSourceExt.)

Top

Reference

Stimulsoft.Report.Dictionary Namespace