StiDictionary Class

Class describes the dictionary data.

Inheritance Hierarchy

SystemObject
Stimulsoft.Report.DictionaryStiDictionary

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

Syntax

ASP.NET

Copy

[SerializableAttribute]
public class StiDictionary : ICloneable, 
	IStiStateSaveRestore, IStiJsonReportObject, IStiAppDictionary

<SerializableAttribute>
Public Class StiDictionary
	Implements ICloneable, IStiStateSaveRestore, IStiJsonReportObject, IStiAppDictionary

The StiDictionary type exposes the following members.

Constructors

	Name	Description
	StiDictionary	Creates a new object of the type StiDictionary.
	StiDictionary(StiReport)	Creates a new object of the type StiDictionary.

Top

Properties

	Name	Description
	AutoSynchronize	Gets or sets Synchronization mode of the Dictionary.
	BusinessObjects	Gets or sets collection of the business objects.
	CacheDataSet	Gets or sets a DataSet for caching.
	CacheUserNamesAndPasswords
	Databases	Gets or sets collection of the databases.
	DataSources	Gets or sets collection of the data sources.
	DataStore	Gets or sets DataStore.
	IsRequestFromUserVariablesPresent
	ReconnectListForRequestFromUserVariables
	Relations	Gets or sets collection of relations.
	Report	Gets or sets report in which given dictionary is placed.
	Resources	Gets or sets collection of resources.
	Restrictions	Gets or sets collections of dictionary restrictions.
	UseInternalData	If the property is true then all data sources (including SQL sources) connect only with DataSet data, which were passed using RegData method. DataNames of data sources are to be the same.
	Variables	Gets or sets collection of variables.

Top

Methods

	Name	Description
	Clear	Clears data dictionary.
	ClearAllStates	Clears all earlier saved object states.
	Clone	Creates a new object that is a copy of the current instance.
	Connect	Connects all Data Sources to data.
	ConnectAsync	Connects all Data Sources to data.
	ConnectCrossTabDataSources
	ConnectCrossTabDataSources(StiCrossTabDataSource)	Intenal use only.
	ConnectDataTransformations	Intenal use only.
	ConnectToDatabases
	ConnectVirtualDataSources	Intenal use only.
	Disconnect	Disconnects the Data Source from data.
	DoAutoSynchronize	Synchronizes DataStore and Dictionary. Report for Synchronization of the data.
	DoAutoSynchronizeAsync	Synchronizes DataStore and Dictionary. Report for Synchronization of the data.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	ExportXMLSchema	Exports Data Sources to DataSet.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetConnection	Returns IDbConnection for database with specified name.
	GetDataSet	Returns a new DataSet from the dictionary.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetSystemVariableValue	Returns value of a specified system variable.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUnusedRelationsFromDataStore	Returns Collection of unused relations.
	GetUnusedRelationsFromDataStore(Hashtable)	Returns Collection of unused relations.
	GetUnusedRelationsFromDataStore(String)	Returns Collection of unused relations.
	GetUnusedRelationsFromDataStore(String, Hashtable)	Returns Collection of unused relations.
	ImportXMLSchema	Imports Data Sources from DataSet.
	IsSystemVariable	Returns true if a specified name is a name of a system variable.
	Load(Stream)	Loads the dictionary from the stream in XML format.
	Load(String)	Loads dictionary from the file in XML format.
	Load(StiDictionarySLService, Stream)	Loads dictionary from the stream through descendants of StiDictionarySLService service.
	Load(StiDictionarySLService, String)	Loads the dictionary from file through descendants of StiDictionarySLService service.
	LoadFromJsonObject
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Merge(Stream)	Merges the dictionary with the stream in XML format.
	Merge(String)	Merges the dictionary with the file in XML format.
	Merge(StiDictionary)	Merges two dictionaries.
	Merge(StiDictionarySLService, Stream)	Merges the dictionary with the stream through provider.
	Merge(StiDictionarySLService, String)	Merges the dictionary with the file through provider.
	MergeXMLSchema	Imports Data Sources from DataSet and merges them with this dictionary.
	RegRelation	Register new relation of the dictionary DataSet.
	RegRelations	Register new relations of the dictionary DataSet.
	RemoveUnusedData	Removes from dictionary unused data sources, relations, and rows and etc.
	RemoveUnusedDataSourcesV2	Removes from dictionary unused data sources V2
	RenameDatabase
	RestoreState	Restores the earlier saved object state.
	RetrievalData	Returns Hashtables with the used relations, data sources and columns.
	Save(Stream)	Saves dictionary to the stream in XML format.
	Save(String)	Saves the dictionary in file in XML format.
	Save(StiDictionarySLService, Stream)	Saves dictionary to the stream through provider.
	Save(StiDictionarySLService, String)	Saves the dictionary in file through service.
	SaveState	Saves the current state of an object.
	SaveToJsonObject
	SortItems	Sorts the DataSources collection and columns in each DataSource.
	SortItems(StiSortOrder)	Sorts the DataSources collection and columns in each DataSource.
	Synchronize	Synchronizes the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
	SynchronizeAsync	Synchronizes the content of the DataStore and Dictionary. If DataSources or Columns or Relations from the DataStore does not exists in Dictionary, then new elements will be added to the Dictionary.
	SynchronizeBusinessObjects
	SynchronizeBusinessObjects(Int32)	Synchronizes the business objects with report dictionary.
	SynchronizeColumns(Object, StiBusinessObject)
	SynchronizeColumns(StiBusinessObjectData, StiBusinessObject)
	SynchronizeColumns(StiData, StiDataSource)
	SynchronizeRelations
	SynchronizeRelations(String)
	SynchronizeRelationsAsync
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

Stimulsoft.Report.Dictionary Namespace