[Expand]General Information
[Collapse]WinForms Controls
  .NET Core Support
  Prerequisites
 [Expand]What's Installed
 [Expand]Build an Application
 [Expand]Controls and Libraries
 [Expand]Common Features
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.DataAccess.UI
  [Expand]DevExpress.DataAccess.UI.Design
  [Expand]DevExpress.DataAccess.UI.EntityFramework
  [Expand]DevExpress.DataAccess.UI.Excel
  [Expand]DevExpress.DataAccess.UI.ObjectBinding
  [Expand]DevExpress.DataAccess.UI.Sql
  [Expand]DevExpress.DataAccess.UI.Wizard
  [Expand]DevExpress.DataAccess.UI.Wizard.Services
  [Expand]DevExpress.DataAccess.UI.Wizard.Views
  [Expand]DevExpress.DocumentView
  [Expand]DevExpress.DocumentView.Controls
  [Expand]DevExpress.LookAndFeel
  [Expand]DevExpress.LookAndFeel.Helpers
  [Expand]DevExpress.Skins
  [Expand]DevExpress.Snap
  [Expand]DevExpress.Snap.API.Native
  [Expand]DevExpress.Snap.Core
  [Expand]DevExpress.Snap.Core.API
  [Expand]DevExpress.Snap.Core.Fields
  [Expand]DevExpress.Snap.Core.Forms
  [Expand]DevExpress.Snap.Core.Options
  [Expand]DevExpress.Snap.Core.Services
  [Expand]DevExpress.Snap.Extensions
  [Expand]DevExpress.Snap.Extensions.Localization
  [Expand]DevExpress.Snap.Extensions.UI
  [Expand]DevExpress.Snap.Localization
  [Expand]DevExpress.Snap.Options
  [Expand]DevExpress.Snap.Services
  [Expand]DevExpress.Utils
  [Expand]DevExpress.Utils.Animation
  [Expand]DevExpress.Utils.Behaviors
  [Expand]DevExpress.Utils.Controls
  [Expand]DevExpress.Utils.DragDrop
  [Expand]DevExpress.Utils.Drawing
  [Expand]DevExpress.Utils.Filtering
  [Expand]DevExpress.Utils.Layout
  [Expand]DevExpress.Utils.Menu
  [Expand]DevExpress.Utils.MVVM
  [Expand]DevExpress.Utils.Taskbar
  [Expand]DevExpress.Utils.Taskbar.Core
  [Expand]DevExpress.Utils.UI.Localization
  [Expand]DevExpress.Utils.VisualEffects
  [Expand]DevExpress.Utils.Win
  [Expand]DevExpress.XtraBars
  [Expand]DevExpress.XtraBars.Alerter
  [Expand]DevExpress.XtraBars.Docking
  [Expand]DevExpress.XtraBars.Docking2010
  [Expand]DevExpress.XtraBars.Docking2010.Base
  [Expand]DevExpress.XtraBars.Docking2010.Customization
  [Expand]DevExpress.XtraBars.Docking2010.Views
  [Expand]DevExpress.XtraBars.Docking2010.Views.NativeMdi
  [Expand]DevExpress.XtraBars.Docking2010.Views.Tabbed
  [Expand]DevExpress.XtraBars.Docking2010.Views.Widget
  [Expand]DevExpress.XtraBars.Docking2010.Views.WindowsUI
  [Expand]DevExpress.XtraBars.FluentDesignSystem
  [Expand]DevExpress.XtraBars.Localization
  [Expand]DevExpress.XtraBars.Navigation
  [Expand]DevExpress.XtraBars.Ribbon
  [Expand]DevExpress.XtraBars.Ribbon.Gallery
  [Expand]DevExpress.XtraBars.Ribbon.ViewInfo
  [Expand]DevExpress.XtraBars.ToastNotifications
  [Expand]DevExpress.XtraBars.ToolbarForm
  [Expand]DevExpress.XtraBars.Utils
  [Expand]DevExpress.XtraBars.WinRTLiveTiles
  [Expand]DevExpress.XtraCharts
  [Expand]DevExpress.XtraCharts.Designer
  [Expand]DevExpress.XtraCharts.Wizard
  [Expand]DevExpress.XtraDataLayout
  [Expand]DevExpress.XtraDiagram
  [Expand]DevExpress.XtraDiagram.Docking
  [Expand]DevExpress.XtraDiagram.Options
  [Expand]DevExpress.XtraEditors
  [Expand]DevExpress.XtraEditors.ButtonPanel
  [Expand]DevExpress.XtraEditors.Calendar
  [Expand]DevExpress.XtraEditors.Camera
  [Expand]DevExpress.XtraEditors.Container
  [Expand]DevExpress.XtraEditors.Controls
  [Expand]DevExpress.XtraEditors.CustomEditor
  [Expand]DevExpress.XtraEditors.DXErrorProvider
  [Expand]DevExpress.XtraEditors.Filtering
  [Expand]DevExpress.XtraEditors.Mask
  [Expand]DevExpress.XtraEditors.Persistent
  [Collapse]DevExpress.XtraEditors.Repository
   [Expand]BaseRepositoryItemCheckEdit Class
    CalendarSelectionMode Enumeration
    CalendarView Enumeration
   [Expand]EditorsRepositoryBase Class
    ExportMode Enumeration
    GridLookUpViewType Enumeration
   [Expand]PersistentRepository Class
   [Collapse]RepositoryItem Class
     RepositoryItem Members
     RepositoryItem Constructor
    [Collapse]RepositoryItem Properties
      AccessibleDefaultActionDescription Property
      AccessibleDescription Property
      AccessibleName Property
      AccessibleRole Property
      AllowFocused Property
      AllowFocusedAppearance Property
      AllowHtmlDraw Property
      AllowInplaceAutoFilter Property
      AllowInplaceBorderPainter Property
      AllowMouseWheel Property
      Appearance Property
      AppearanceDisabled Property
      AppearanceFocused Property
      AppearanceReadOnly Property
      AutoHeight Property
      BestFitWidth Property
      BorderStyle Property
      ContextMenu Property
      ContextMenuStrip Property
      DefaultAlignment Property
      DefaultBorderStyleInBars Property
      DefaultBorderStyleInGrid Property
      DisplayFormat Property
      Editable Property
      EditFormat Property
      EditorTypeName Property
      EditValueChangedDelay Property
      EditValueChangedFiringDelay Property
      EditValueChangedFiringMode Property
      Enabled Property
      ExportMode Property
      HtmlImages Property
      IsDesignMode Property
      IsDisposed Property
      IsFilterLookUp Property
      IsLoading Property
      IsLockUpdate Property
      IsNonSortableEditor Property
      LinkCount Property
      LookAndFeel Property
      Name Property
      NormalizeDisplayText Property
      NullText Property
      OwnerEdit Property
      OwnerItem Property
      PopupOffset Property
      Properties Property
      ReadOnly Property
      RequireDisplayTextSorting Property
      Site Property
      Tag Property
      UseParentBackground Property
      UseTextEditorForAutoFilter Property
    [Expand]RepositoryItem Events
    [Expand]RepositoryItem Methods
   [Expand]RepositoryItemBaseProgressBar Class
   [Expand]RepositoryItemBaseSpinEdit Class
   [Expand]RepositoryItemBlobBaseEdit Class
   [Expand]RepositoryItemBreadCrumbEdit Class
   [Expand]RepositoryItemButtonEdit Class
   [Expand]RepositoryItemCalcEdit Class
   [Expand]RepositoryItemCheckedComboBoxEdit Class
   [Expand]RepositoryItemCheckEdit Class
   [Expand]RepositoryItemCollection Class
   [Expand]RepositoryItemColorEdit Class
   [Expand]RepositoryItemColorPickEdit Class
   [Expand]RepositoryItemComboBox Class
   [Expand]RepositoryItemDateEdit Class
   [Expand]RepositoryItemFontEdit Class
   [Expand]RepositoryItemGridLookUpEdit Class
   [Expand]RepositoryItemGridLookUpEditBase Class
   [Expand]RepositoryItemHyperLinkEdit Class
   [Expand]RepositoryItemHypertextLabel Class
   [Expand]RepositoryItemImageComboBox Class
   [Expand]RepositoryItemImageEdit Class
   [Expand]RepositoryItemLookUpEdit Class
   [Expand]RepositoryItemLookUpEditBase Class
   [Expand]RepositoryItemMarqueeProgressBar Class
   [Expand]RepositoryItemMemoEdit Class
   [Expand]RepositoryItemMemoExEdit Class
   [Expand]RepositoryItemMRUEdit Class
   [Expand]RepositoryItemPageNumberEdit Class
   [Expand]RepositoryItemPickImage Class
   [Expand]RepositoryItemPictureEdit Class
   [Expand]RepositoryItemPopupBase Class
   [Expand]RepositoryItemPopupBaseAutoSearchEdit Class
   [Expand]RepositoryItemPopupContainerEdit Class
   [Expand]RepositoryItemPopupGalleryEdit Class
   [Expand]RepositoryItemProgressBar Class
   [Expand]RepositoryItemRadioGroup Class
   [Expand]RepositoryItemRangeTrackBar Class
   [Expand]RepositoryItemRatingControl Class
   [Expand]RepositoryItemRichTextEdit Class
   [Expand]RepositoryItemSearchControl Class
   [Expand]RepositoryItemSearchLookUpEdit Class
   [Expand]RepositoryItemSparklineEdit Class
   [Expand]RepositoryItemSpinEdit Class
   [Expand]RepositoryItemTextEdit Class
   [Expand]RepositoryItemTimeEdit Class
   [Expand]RepositoryItemTimeSpanEdit Class
   [Expand]RepositoryItemToggleSwitch Class
   [Expand]RepositoryItemTokenEdit Class
   [Expand]RepositoryItemTrackBar Class
   [Expand]RepositoryItemTreeListLookUpEdit Class
   [Expand]RepositoryItemZoomTrackBar Class
   [Expand]RichTextEditBehaviorOptions Class
   [Expand]RichTextEditHorizontalScrollbarOptions Class
    TimeEditStyle Enumeration
   [Expand]TrackBarRange Structure
  [Expand]DevExpress.XtraEditors.ViewInfo
  [Expand]DevExpress.XtraFilterEditor
  [Expand]DevExpress.XtraGauges.Presets.Styles
  [Expand]DevExpress.XtraGauges.Win
  [Expand]DevExpress.XtraGauges.Win.Base
  [Expand]DevExpress.XtraGauges.Win.Gauges.Circular
  [Expand]DevExpress.XtraGauges.Win.Gauges.Digital
  [Expand]DevExpress.XtraGauges.Win.Gauges.Linear
  [Expand]DevExpress.XtraGauges.Win.Gauges.State
  [Expand]DevExpress.XtraGrid
  [Expand]DevExpress.XtraGrid.Columns
  [Expand]DevExpress.XtraGrid.EditForm
  [Expand]DevExpress.XtraGrid.FilterEditor
  [Expand]DevExpress.XtraGrid.Localization
  [Expand]DevExpress.XtraGrid.Views.BandedGrid
  [Expand]DevExpress.XtraGrid.Views.BandedGrid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Base
  [Expand]DevExpress.XtraGrid.Views.Base.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Card
  [Expand]DevExpress.XtraGrid.Views.Card.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Grid
  [Expand]DevExpress.XtraGrid.Views.Grid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Layout
  [Expand]DevExpress.XtraGrid.Views.Layout.Events
  [Expand]DevExpress.XtraGrid.Views.Layout.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Printing
  [Expand]DevExpress.XtraGrid.Views.Tile
  [Expand]DevExpress.XtraGrid.Views.WinExplorer
  [Expand]DevExpress.XtraGrid.WinExplorer
  [Expand]DevExpress.XtraLayout
  [Expand]DevExpress.XtraLayout.Converter
  [Expand]DevExpress.XtraLayout.Customization
  [Expand]DevExpress.XtraLayout.HitInfo
  [Expand]DevExpress.XtraLayout.Localization
  [Expand]DevExpress.XtraLayout.Utils
  [Expand]DevExpress.XtraMap
  [Expand]DevExpress.XtraMap.Printing
  [Expand]DevExpress.XtraNavBar
  [Expand]DevExpress.XtraNavBar.ViewInfo
  [Expand]DevExpress.XtraPdfViewer
  [Expand]DevExpress.XtraPdfViewer.Commands
  [Expand]DevExpress.XtraPdfViewer.Extensions
  [Expand]DevExpress.XtraPdfViewer.Localization
  [Expand]DevExpress.XtraPivotGrid
  [Expand]DevExpress.XtraPivotGrid.Data
  [Expand]DevExpress.XtraPrinting
  [Expand]DevExpress.XtraPrinting.Control
  [Expand]DevExpress.XtraPrinting.Preview
  [Expand]DevExpress.XtraPrintingLinks
  [Expand]DevExpress.XtraReports.UI
  [Expand]DevExpress.XtraRichEdit
  [Expand]DevExpress.XtraRichEdit.Commands
  [Expand]DevExpress.XtraRichEdit.Export
  [Expand]DevExpress.XtraRichEdit.Import
  [Expand]DevExpress.XtraRichEdit.Menu
  [Expand]DevExpress.XtraScheduler
  [Expand]DevExpress.XtraScheduler.Drawing
  [Expand]DevExpress.XtraScheduler.GoogleCalendar
  [Expand]DevExpress.XtraScheduler.Printing
  [Expand]DevExpress.XtraScheduler.Reporting
  [Expand]DevExpress.XtraScheduler.Reporting.UI
  [Expand]DevExpress.XtraScheduler.Services
  [Expand]DevExpress.XtraScheduler.Services.Implementation
  [Expand]DevExpress.XtraScheduler.UI
  [Expand]DevExpress.XtraSpellChecker
  [Expand]DevExpress.XtraSpellChecker.Localization
  [Expand]DevExpress.XtraSplashForm
  [Expand]DevExpress.XtraSplashScreen
  [Expand]DevExpress.XtraSpreadsheet
  [Expand]DevExpress.XtraSpreadsheet.Services
  [Expand]DevExpress.XtraTab
  [Expand]DevExpress.XtraTab.Buttons
  [Expand]DevExpress.XtraTab.ViewInfo
  [Expand]DevExpress.XtraTabbedMdi
  [Expand]DevExpress.XtraToolbox
  [Expand]DevExpress.XtraTreeList
  [Expand]DevExpress.XtraTreeList.Columns
  [Expand]DevExpress.XtraTreeList.Data
  [Expand]DevExpress.XtraTreeList.Localization
  [Expand]DevExpress.XtraTreeList.Menu
  [Expand]DevExpress.XtraTreeList.Nodes
  [Expand]DevExpress.XtraTreeList.Nodes.Operations
  [Expand]DevExpress.XtraTreeList.StyleFormatConditions
  [Expand]DevExpress.XtraTreeMap
  [Expand]DevExpress.XtraTreeMap.Printing
  [Expand]DevExpress.XtraVerticalGrid
  [Expand]DevExpress.XtraVerticalGrid.Events
  [Expand]DevExpress.XtraVerticalGrid.Localization
  [Expand]DevExpress.XtraVerticalGrid.Rows
  [Expand]DevExpress.XtraWaitForm
  [Expand]DevExpress.XtraWizard
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]eXpress Persistent Objects
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

RepositoryItem.DisplayFormat Property

Provides access to the format settings applied to the editor's display text. These settings are in effect when the editor does not have input focus.

Namespace:DevExpress.XtraEditors.Repository
Assembly:DevExpress.XtraEditors.v19.1.dll

Expanded Syntax

Property value

Type: FormatInfo
A DevExpress.Utils.FormatInfo object containing the formatting settings applied to the control's display text.

Expanded Remarks

Expanded Entering date-time and numeric values

See the following topics to learn about the editors you can use to enter date-time and numeric values:

Expanded Format values in display mode

The DisplayFormat object of the DevExpress.Utils.FormatType class contains properties to format the editor's values in display mode (when the editor doesn't have input focus). Specify the format type (Numeric, DateTime or Custom) with the DevExpress.Utils.FormatInfo.FormatType property, set the format pattern (DevExpress.Utils.FormatInfo.FormatString) or assign a custom formatter object (DevExpress.Utils.FormatInfo.Format).

The following code formats a CalcEdit control's values as currency in display mode.

See the Formatting Display and Edit Values topic to learn about supported formatting approaches and format specifiers.

If you use the Numeric format (DisplayFormat.FormatType.Numeric), the editor's values must of a numeric data type. If you use the DateTime format (DisplayFormat.FormatType.DateTime), the editor's values must be of the DateTime data type.

In bound mode, the bound field determines the edit value data type. In unbound mode, specify the edit value data type explicitly - by assigning a value of the required data type to the editor's BaseEdit.EditValue property, or by setting the MaskProperties.MaskType property (editor.Properties.Mask.MaskType) to Numeric, DateTime/DateTimeAdvancingCaret.

The DisplayFormat property does not affect how strings being entered in the editor are converted to the editor's underlying data type.

Note

LookUp editors do not take into account the DisplayFormat and EditFormat properties.

Expanded Format values in edit and display modes

You can apply a mask to a text editor to restrict input of values and format values in edit and display modes. Mask settings are accessible from the RepositoryItemTextEdit.Mask property. Enable the MaskProperties.UseMaskAsDisplayFormat (editor.Properties.Mask.UseMaskAsDisplayFormat) option to use the specified mask to format the editor's values in display mode.

The following code applies a mask that formats values in a CalcEdit control as currency. The mask formats the editor's values regardless of whether the editor has input focus.

Expanded See Also

Is this topic helpful?​​​​​​​