SnapControl.DataSource Property

Specifies the SnapControl data source.

Namespace: DevExpress.Snap

Assembly: DevExpress.Snap.v18.2.dll

Declaration

C#

[DefaultValue(null)]
[DXCategory("Data")]
public object DataSource { get; set; }

VB.NET

<DefaultValue(Nothing)>
<DXCategory("Data")>
Public Property DataSource As Object

Property Value

Type	Default	Description
Object	*null*	A Object value, specifying the document data source.

Remarks

The data binding in Snap can be accomplished by creating a data source of one of the following types.

• Application Data Source

  A data source that is assigned to the DataSource property cannot be edited or removed from within of the Snap application and is always available for any document opened in it.

  To access the collection of a SnapControl‘s data sources, use the SnapControl.DataSources property.

  A calculated field that is added to an application data source has no access to fields from document data sources.

• Document Data Source

  A data source that is specified via the user interface of a Snap application is assigned to the IDataSourceOwner.DataSource property of a currently opened SnapDocument.

  To access the collection of a SnapDocument‘s data sources, use the SnapDocument.DataSources property.

  A calculated field that is added to a document data source can evaluate the field values that belong to the application data sources.

An application data source is given priority when it has a name identical to a document data source.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DataSource property.

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-edit-an-existing-snx-template-in-code-t224149/CS/Snap_API/Form1.cs#L32

InitializeComponent();
snapControl1.DataSource = GetDataSource();
snapControl1.LoadDocumentTemplate("SnapTemplate.snx", SnapDocumentFormat.Snap);

how-to-generate-a-live-report-based-on-gridcontrol-content-t272175/CS/WindowsFormsApplication1/GridReportExtensions/SnapReportForGridGenerator.cs#L48

static void AssignDataSourceToSnapControl(SnapControl snap) {
    snap.DataSource = snap.Tag;
}

how-to-bind-a-snap-document-to-multiple-data-sources-in-code-e4784/CS/MultipleDataSources/Form1.cs#L45

// Set the Application data source which cannot be edited or removed by the end-user.
this.snapControl1.DataSource = dsContacts.Tables[0];
// Add Document data sources which persist for the currently loaded document only.

an-example-of-using-a-cell-range-as-a-data-source-t483776/CS/RangeDataSourceForSnap/Form1.cs#L71

private void BindControlsToDataSource() {
    snapControl1.DataSource = rangeDS;
    gridControl1.DataSource = rangeDS;

snap-how-to-customize-the-data-explorer-panel-t535534/CS/CustomDataExplorer/Form1.cs#L49

    snapControl1.Document.DataSources.Add("My Xml Data", FishesSource.Data);
    snapControl1.DataSource = textDataSource;
}

VB.NET

how-to-edit-an-existing-snx-template-in-code-t224149/VB/Snap_API/Form1.vb#L34

InitializeComponent()
snapControl1.DataSource = GetDataSource()
snapControl1.LoadDocumentTemplate("SnapTemplate.snx", SnapDocumentFormat.Snap)

how-to-generate-a-live-report-based-on-gridcontrol-content-t272175/VB/WindowsFormsApplication1/GridReportExtensions/SnapReportForGridGenerator.vb#L50

Private Sub AssignDataSourceToSnapControl(ByVal snap As SnapControl)
    snap.DataSource = snap.Tag
End Sub

an-example-of-using-a-cell-range-as-a-data-source-t483776/VB/RangeDataSourceForSnap/Form1.vb#L73

Private Sub BindControlsToDataSource()
    snapControl1.DataSource = rangeDS
    gridControl1.DataSource = rangeDS

snap-how-to-customize-the-data-explorer-panel-t535534/VB/CustomDataExplorer/Form1.vb#L50

    snapControl1.Document.DataSources.Add("My Xml Data", FishesSource.Data)
    snapControl1.DataSource = textDataSource
End Sub