DataSourceInfo Class

Contains information about a document’s data source.

Namespace: DevExpress.Snap.Core.API

Assembly: DevExpress.Snap.v18.1.Core.dll

Declaration

C#

public class DataSourceInfo :
    IDataSourceOwner

VB.NET

Public Class DataSourceInfo
    Implements IDataSourceOwner

Related API Members

The following members accept/return DataSourceInfo objects:

• DataSourceChangedEventArgs.ChangedDataSourceInfo
• DataSourceInfoCollection.Add(String, Object)
• DataSourceInfoCollection.DefaultDataSourceInfo
• DataSourceInfoCollection.GetInfo(Object)
• DataSourceInfoCollection.Item[String]
• DataSourceRemovedEventArgs.DataSourceInfo
• DocumentDataSources.DefaultDataSourceInfo

Remarks

You can assign a DataSourceInfo to a SnapDocument in the following ways.

• Add a single default data source (via the IDataSourceOwner.DataSource property).

  To access the default data source and its calculated fields, use the DataSourceInfoCollection.DefaultDataSourceInfo method.

• Add a collection of non-default data sources (via the SnapDocument.DataSources property).

  To access a non-default data source, use the DataSourceInfoCollection.GetInfo method.

To check whether or not a data source is the default, use the DataSourceInfoCollection.IsDefaultDataSource method.

To update the DataSourceInfo collection, use the SnapDocument.BeginUpdateDataSource and SnapDocument.EndUpdateDataSource methods.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the DataSourceInfo class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-use-snapdocument-events-to-customize-the-default-templates-of-snap-lists-and-columns-e4782/CS/Snap_Events/Form1.cs#L63

var employeesBinding = new BindingSource() { DataSource = dataSource, DataMember = employeeDataSourceName };
document.DataSources.Add(new DataSourceInfo(employeeDataSourceName, employeesBinding));

VB.NET

how-to-use-snapdocument-events-to-customize-the-default-templates-of-snap-lists-and-columns-e4782/VB/Snap_Events/Form1.vb#L65

Dim employeesBinding = New BindingSource() With {.DataSource = dataSource, .DataMember = employeeDataSourceName}
document.DataSources.Add(New DataSourceInfo(employeeDataSourceName, employeesBinding))

Implements

IDataSourceOwner

Inheritance

Object

DataSourceInfo