DataSourceWizardOptions.DataSourceTypes Property

Gets or sets the data source types available for data binding from the Data Source Wizard.

Namespace: DevExpress.Snap.Options

Assembly: DevExpress.Snap.v19.1.dll

Declaration

C#

[Browsable(false)]
[DefaultValue(DataSourceTypes.All)]
public DataSourceTypes DataSourceTypes { get; set; }

VB.NET

<Browsable(False)>
<DefaultValue(DataSourceTypes.All)>
Public Property DataSourceTypes As DataSourceTypes

Property Value

Type	Default	Description
DataSourceTypes	**All**	One of the DataSourceTypes enumeration members.

Available values:

Name	Description
Sql	Specifies that an SQL database is available for data binding from the Data Source Wizard.
Excel	Specifies that a data source used to extract data from Microsoft® Excel® documents is available for data binding from the Data Source Wizard.
EntityFramework	Specifies that an Entity Framework data source is available for data binding from the Data Source Wizard.
Object	Specifies that an object data source is available for data binding from the Data Source Wizard.
Json	Indicates a JSON data source.
Federation	Indicates a Federated data source.
All	Specifies that all data source types are available for data binding from the Data Source Wizard.

Property Paths

You can access this nested property as listed below:

Object Type	Path to DataSourceTypes
SnapControlOptions	.DataSourceWizardOptions.DataSourceTypes

Remarks

Use the DataSourceTypes property to specify the data source types that should be displayed on the "Select the data source type" page of the Data Source Wizard.

Note

Take into account the following limitations:

• The Data Federation data source is available in the Data Source Wizard only if a snap report contains at least one data source.
• The DevExpress Snap uses the open-source Newtonsoft.Json library to provide JSON data at runtime. We recommend you to install the required NuGet package to use this data source type.

The following example demonstrates how to display only the Entity Framework and Excel File items in the Data Source Wizard.

C#

snapControl1.Options.DataSourceWizardOptions.DataSourceTypes = DataSourceTypes.EntityFramework | DataSourceTypes.Excel;

VB.NET

snapControl1.Options.DataSourceWizardOptions.DataSourceTypes = DataSourceTypes.EntityFramework Or DataSourceTypes.Excel

The image below shows the result of the code.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the DataSourceTypes 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-add-a-new-data-source-type-to-the-data-source-wizard-t310160/CS/CustomWizardExample/Form1.cs#L15

snapControl.Text = "Click the \"Add New Data Source\" button to invoke the customized Data Source Wizard that allows you to establish a connection to an XML data file.";
snapControl.Options.DataSourceWizardOptions.DataSourceTypes = DataSourceTypes.Sql | DataSourceTypes.Excel;
snapControl.AddService(typeof(IDataSourceWizardCustomizationService), new DataSourceWizardCustomizationService());

VB.NET

how-to-add-a-new-data-source-type-to-the-data-source-wizard-t310160/VB/CustomWizardExample/Form1.vb#L15

snapControl.Text = "Click the ""Add New Data Source"" button to invoke the customized Data Source Wizard that allows you to establish a connection to an XML data file."
snapControl.Options.DataSourceWizardOptions.DataSourceTypes = DataSourceTypes.Sql Or DataSourceTypes.Excel
snapControl.AddService(GetType(IDataSourceWizardCustomizationService), New DataSourceWizardCustomizationService())