CellValueToStringConverter.SetPreferredNumberFormatLocal(IWorkbook, String) Method

Specifies a local number format used for string representation of numeric values.

Namespace: DevExpress.Spreadsheet.Export

Assembly: DevExpress.Spreadsheet.v24.1.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

public void SetPreferredNumberFormatLocal(
    IWorkbook workbook,
    string excelNumberFormat
)

VB.NET

Public Sub SetPreferredNumberFormatLocal(
    workbook As IWorkbook,
    excelNumberFormat As String
)

Parameters

Name	Type	Description
workbook	IWorkbook	The current workbook.
excelNumberFormat	String	A Microsoft Excel compatible number format.

Remarks

Use the SetPreferredNumberFormatLocal method to specify a number format based on the local culture defined by the DocumentOptions.Culture property.

The following code snippet exports a DateTime value in a format specific to the French culture. The result is “mai-22”.

C#

using DevExpress.Spreadsheet;
using DevExpress.Spreadsheet.Export;
using System;
using System.Data;
using System.Globalization;
// ...

spreadsheetControl1.Options.Culture = new CultureInfo("fr-FR");
var workbook = spreadsheetControl1.Document;

var worksheet = workbook.Worksheets.ActiveWorksheet;
var dataTable = new DataTable();
dataTable.Columns.Add(new DataColumn("Column1", typeof(string)));
worksheet["A1"].Value = new DateTime(2022, 05, 30);
var exporter = worksheet.CreateDataTableExporter(worksheet["A1"], dataTable, false);
exporter.Options.DefaultCellValueToStringConverter.PreferredCulture = new CultureInfo("fr-FR");
exporter.Options.DefaultCellValueToStringConverter.SetPreferredNumberFormatLocal(spreadsheetControl1.Document, "mmm-aa");
exporter.Export();
string result = dataTable.Rows[0].Field<string>("Column1");

VB.NET

Imports DevExpress.Spreadsheet
Imports DevExpress.Spreadsheet.Export
Imports System
Imports System.Data
Imports System.Globalization
' ...

spreadsheetControl1.Options.Culture = New CultureInfo("fr-FR")
Dim workbook As IWorkbook = spreadsheetControl1.Document

Dim worksheet As Worksheet = workbook.Worksheets.ActiveWorksheet
Dim dataTable As New DataTable()
dataTable.Columns.Add(New DataColumn("Column1", GetType(String)))
worksheet("A1").Value = New DateTime(2022, 05, 30)
Dim exporter As DataTableExporter = worksheet.CreateDataTableExporter(worksheet("A1"), dataTable, False)
exporter.Options.DefaultCellValueToStringConverter.PreferredCulture = New CultureInfo("fr-FR")
exporter.Options.DefaultCellValueToStringConverter.SetPreferredNumberFormatLocal(spreadsheetControl1.Document, "mmm-aa")
exporter.Export()
Dim result As String = dataTable.Rows(0).Field(Of String)("Column1")

The CellValueToStringConverter.SetPreferredNumberFormat method allows you to obtain or specify a number format in the invariant culture.