RepositoryItem.ExportMode Property

Specifies whether the editor’s value or display text is exported when data is exported to XLS and CSV formats.

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v19.1.dll

Declaration

C#

[DefaultValue(ExportMode.Default)]
[DXCategory("Behavior")]
public virtual ExportMode ExportMode { get; set; }

VB.NET

<DefaultValue(ExportMode.Default)>
<DXCategory("Behavior")>
Public Overridable Property ExportMode As ExportMode

Property Value

Type	Default	Description
ExportMode	**Default**	A ExportMode enumeration value.

Available values:

Name	Description
Default	Either an editor’s value or display text is exported, depending on the editor’s type. For the ImageComboBoxEdit and LookUpEdit controls, their display text is exported. For other editors, their edit values (BaseEdit.EditValue), which sometimes match the display text, are exported.
DisplayText	An editor’s display text is exported.
Value	An editor’s edit value is exported.

Remarks

The following considerations are applied when exporting data to XLS and CSV formats. In default export mode (when the ExportMode property is set to ExportMode.Default), editor values are exported differently, depending on the editor’s type. For the ImageComboBoxEdit and LookUpEdit controls, their display text is exported by default. For other editors, their edit values (BaseEdit.EditValue), which sometimes match the display text, are exported. To change this default logic for a specific editor, set the ExportMode property to the required value.

For a RepositoryItemCheckEdit object, the ExportMode property is ignored. For these editors, values of the RepositoryItemCheckEdit.DisplayValueChecked, RepositoryItemCheckEdit.DisplayValueUnchecked and RepositoryItemCheckEdit.DisplayValueGrayed properties are exported, according to the editor’s current value.

In Data-Aware export mode, display values are exported by default for columns that use lookup and image-combobox editors. You can set the columns’ ExportMode property to Value to export edit values instead of display values.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ExportMode 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-timespan-data-in-standalone-and-in-place-mode-e1976/CS/TimeSpanEditor/Form1.cs#L43

{
    timeSpanEdit.Properties.ExportMode = (ExportMode)cbeExportMode.EditValue;
}

how-to-create-an-ip-address-editor-to-cycle-through-every-part-of-an-ip-address-e2443/CS/IPAddressEditor/IPAddressEdit.cs#L59

{
    if ( Properties.ExportMode == ExportMode.DisplayText )
        return Properties.GetDisplayText(null, base.EditValue);

VB.NET

how-to-edit-timespan-data-in-standalone-and-in-place-mode-e1976/VB/TimeSpanEditor/Form1.vb#L40

Private Sub cbeExportMode_SelectedIndexChanged(ByVal sender As Object, ByVal e As EventArgs) Handles cbeExportMode.SelectedIndexChanged
    timeSpanEdit.Properties.ExportMode = CType(cbeExportMode.EditValue, ExportMode)
End Sub

how-to-create-an-ip-address-editor-to-cycle-through-every-part-of-an-ip-address-e2443/VB/IPAddressEditor/IPAddressEdit.vb#L53

Get
    If Properties.ExportMode = ExportMode.DisplayText Then
        Return Properties.GetDisplayText(Nothing, MyBase.EditValue)