FieldInfo Class

Contains settings of the ExcelDataSource field.

Namespace: DevExpress.DataAccess.Excel

Assembly: DevExpress.DataAccess.v18.1.dll

Declaration

C#

public sealed class FieldInfo

VB.NET

Public NotInheritable Class FieldInfo

Remarks

The ExcelDataSource allows you to specify its schema using the ExcelDataSource.Schema property that provides access to a collection of FieldInfo objects. The FieldInfo class exposes the FieldInfo.Name and FieldInfo.Type properties allowing you to specify the field name and type, respectively. The FieldInfo.Selected property specifies whether or not the field will be displayed within the field list.

Example

This example shows how to customize the schema of the ExcelDataSource using the ExcelDataSource.Schema property. To do this, perform the following steps.

• Create an ExcelDataSource with the required settings.
• Retrieve the available fields (FieldInfo objects) using the IExcelSchemaProvider.GetSchema method.
• Iterate through the collection of fields, specify their properties and add all fields to the ExcelDataSource.Schema collection.

C#

            // Creates an Excel data source and selects the specific cell range from the SalesPerson worksheet.
            ExcelDataSource excelDataSource = new ExcelDataSource("Excel Data Source");
            excelDataSource.FileName = HostingEnvironment.MapPath(@"~/App_Data/ExcelDataSource.xlsx");
            ExcelWorksheetSettings worksheetSettings = new ExcelWorksheetSettings("SalesPerson", "A1:L2000");
            excelDataSource.SourceOptions = new ExcelSourceOptions(worksheetSettings);

            // Specifies the fields that will be available for the created data source.
            IExcelSchemaProvider schemaProvider = excelDataSource.GetService(typeof(IExcelSchemaProvider)) 
                as IExcelSchemaProvider;
            FieldInfo[] availableFields = schemaProvider.GetSchema(excelDataSource.FileName, null, 
                ExcelDocumentFormat.Xlsx, excelDataSource.SourceOptions, System.Threading.CancellationToken.None);
            List<string> fieldsToSelect = new List<string>() { "CategoryName", "ProductName", "Country", "Quantity", 
                "Extended Price"};
            foreach (FieldInfo field in availableFields) {
                if (fieldsToSelect.Contains(field.Name)) {
                    excelDataSource.Schema.Add(field);
                }
                else {
                    field.Selected = false;
                    excelDataSource.Schema.Add(field);
                }
            }
            excelDataSource.Fill();

VB.NET

            ' Creates an Excel data source and selects the specific cell range from the SalesPerson worksheet.
            Dim excelDataSource As New ExcelDataSource("Excel Data Source")
            excelDataSource.FileName = HostingEnvironment.MapPath("~/App_Data/ExcelDataSource.xlsx")
            Dim worksheetSettings As New ExcelWorksheetSettings("SalesPerson", "A1:L2000")
            excelDataSource.SourceOptions = New ExcelSourceOptions(worksheetSettings)

            ' Specifies the fields that will be available for the created data source.
            Dim schemaProvider As IExcelSchemaProvider = TryCast(excelDataSource.GetService(GetType(IExcelSchemaProvider)), IExcelSchemaProvider)
            Dim availableFields() As FieldInfo = schemaProvider.GetSchema(excelDataSource.FileName, Nothing, ExcelDocumentFormat.Xlsx, excelDataSource.SourceOptions, System.Threading.CancellationToken.None)
            Dim fieldsToSelect As New List(Of String) (New String() {"CategoryName", "ProductName", "Country", "Quantity", "Extended Price"})
            For Each field As FieldInfo In availableFields
                If fieldsToSelect.Contains(field.Name) Then
                    excelDataSource.Schema.Add(field)
                Else
                    field.Selected = False
                    excelDataSource.Schema.Add(field)
                End If
            Next field
            excelDataSource.Fill()

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the FieldInfo 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#

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

// Define the data source schema.
FieldInfo fieldID = new FieldInfo { Name = "ID", Type = typeof(int) };
FieldInfo fieldDate = new FieldInfo { Name = "Date", Type = typeof(DateTime) };

Reporting_how-to-bind-a-report-to-a-csv-file-at-runtime-t311958/CS/BindingReportToCsvFile/Form1.cs#L39

// Define the data source schema.
FieldInfo fieldCategoryID = new FieldInfo { Name = "CategoryID", Type = typeof(double), Selected = false };
FieldInfo fieldCategoryName = new FieldInfo { Name = "CategoryName", Type = typeof(string) };

Reporting_how-to-bind-a-report-to-an-excel-workbook-at-runtime-t311954/CS/BindingReportToExcelWorkbook/Form1.cs#L38

// Create new fields and specify their settings.
FieldInfo fieldCategoryID = new FieldInfo { Name = "CategoryID", Type = typeof(double), Selected = false };
FieldInfo fieldCategoryName = new FieldInfo { Name = "CategoryName", Type = typeof(string) };

Reporting_how-to-provide-aspxreportdesigner-with-the-sqldatasource-objectdatasource-t271722/CS/WebApplication1/Default.aspx.cs#L49

DevExpress.DataAccess.Excel.FieldInfo fieldInfo1 = new DevExpress.DataAccess.Excel.FieldInfo() { Name = "CategoryID", Type = typeof(double) };
DevExpress.DataAccess.Excel.FieldInfo fieldInfo2 = new DevExpress.DataAccess.Excel.FieldInfo() { Name = "CategoryName", Type = typeof(string)};

VB.NET

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

' Define the data source schema.
Dim fieldID As FieldInfo = New FieldInfo With { _
    .Name = "ID", _

Reporting_how-to-bind-a-report-to-a-csv-file-at-runtime-t311958/VB/BindingReportToCsvFile/Form1.vb#L37

' Define the data source schema.
Dim fieldCategoryID As FieldInfo = New FieldInfo With { _
    .Name = "CategoryID", _

Reporting_how-to-bind-a-report-to-an-excel-workbook-at-runtime-t311954/VB/BindingReportToExcelWorkbook/Form1.vb#L36

' Create new fields and specify their settings.
Dim fieldCategoryID As FieldInfo = New FieldInfo With { _
    .Name = "CategoryID", _

Reporting_how-to-provide-aspxreportdesigner-with-the-sqldatasource-objectdatasource-t271722/VB/WebApplication1/Default.aspx.vb#L47

Dim fieldInfo1 As New DevExpress.DataAccess.Excel.FieldInfo() With {.Name = "CategoryID", .Type = GetType(Double)}
Dim fieldInfo2 As New DevExpress.DataAccess.Excel.FieldInfo() With {.Name = "CategoryName", .Type = GetType(String)}

Inheritance

Object

FieldInfo