Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Collapse]WPF Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Common Concepts
 [Expand]Controls and Libraries
 [Expand]Localization
  Redistribution and Deployment
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.Charts.Designer
  [Expand]DevExpress.Mvvm.UI
  [Expand]DevExpress.Mvvm.UI.Interactivity
  [Expand]DevExpress.Mvvm.UI.ModuleInjection
  [Expand]DevExpress.Xpf.Accordion
  [Expand]DevExpress.Xpf.Bars
  [Expand]DevExpress.Xpf.Carousel
  [Expand]DevExpress.Xpf.Charts
  [Expand]DevExpress.Xpf.Charts.Localization
  [Expand]DevExpress.Xpf.Charts.RangeControlClient
  [Expand]DevExpress.Xpf.ChunkList
  [Expand]DevExpress.Xpf.Controls
  [Expand]DevExpress.Xpf.Core
  [Expand]DevExpress.Xpf.Core.ConditionalFormatting
  [Expand]DevExpress.Xpf.Core.DataSources
  [Expand]DevExpress.Xpf.Core.ServerMode
  [Expand]DevExpress.Xpf.Data
  [Expand]DevExpress.Xpf.DataAccess
  [Expand]DevExpress.Xpf.DataAccess.DataSourceWizard
  [Expand]DevExpress.Xpf.Diagram
  [Expand]DevExpress.Xpf.Docking
  [Expand]DevExpress.Xpf.Docking.Base
  [Expand]DevExpress.Xpf.DocumentViewer
  [Expand]DevExpress.Xpf.Editors
  [Expand]DevExpress.Xpf.Editors.DateNavigator
  [Expand]DevExpress.Xpf.Editors.ExpressionEditor
  [Expand]DevExpress.Xpf.Editors.Filtering
  [Expand]DevExpress.Xpf.Editors.Flyout
  [Expand]DevExpress.Xpf.Editors.Flyout.Native
  [Expand]DevExpress.Xpf.Editors.Helpers
  [Expand]DevExpress.Xpf.Editors.Popups
  [Expand]DevExpress.Xpf.Editors.RangeControl
  [Collapse]DevExpress.Xpf.Editors.Settings
   [Expand]BarCodeEditSettings Class
   [Collapse]BaseEditSettings Class
     BaseEditSettings Members
    [Collapse]BaseEditSettings Properties
      AllowNullInput Property
      DisableExcessiveUpdatesInInplaceInactiveMode Property
      DisplayFormat Property
      DisplayTextConverter Property
      FlowDirection Property
      HorizontalContentAlignment Property
      MaxWidth Property
      NullText Property
      NullValue Property
      ShouldDisableExcessiveUpdatesInInplaceInactiveMode Property
      ShowNullText Property
      ShowNullTextForEmptyValue Property
      StyleSettings Property
      ValidationErrorTemplate Property
      VerticalContentAlignment Property
    [Expand]BaseEditSettings Events
    [Expand]BaseEditSettings Methods
   [Expand]ButtonEditSettings Class
   [Expand]CalcEditSettings Class
   [Expand]CheckEditSettings Class
   [Expand]ColorEditSettings Class
   [Expand]ComboBoxEditSettings Class
   [Expand]DateEditSettings Class
    EditSettingsHorizontalAlignment Enumeration
   [Expand]FontEditSettings Class
   [Expand]HyperlinkEditSettings Class
   [Expand]ImageEditSettings Class
   [Expand]ListBoxEditSettings Class
   [Expand]LookUpEditSettingsBase Class
   [Expand]MemoEditSettings Class
   [Expand]PasswordBoxEditSettings Class
   [Expand]PopupBaseEditSettings Class
    PopupColorEditDisplayMode Enumeration
   [Expand]PopupColorEditSettings Class
   [Expand]PopupImageEditSettings Class
   [Expand]ProgressBarEditSettings Class
   [Expand]RatingEditSettings Class
   [Expand]SparklineEditSettings Class
   [Expand]SpinEditSettings Class
   [Expand]TextEditSettings Class
   [Expand]ToggleSwitchEditSettings Class
   [Expand]TrackBarEditSettings Class
  [Expand]DevExpress.Xpf.Editors.Validation
  [Expand]DevExpress.Xpf.Gauges
  [Expand]DevExpress.Xpf.Gauges.Localization
  [Expand]DevExpress.Xpf.Grid
  [Expand]DevExpress.Xpf.Grid.ConditionalFormatting
  [Expand]DevExpress.Xpf.Grid.LookUp
  [Expand]DevExpress.Xpf.Grid.TreeList
  [Expand]DevExpress.Xpf.Layout.Core
  [Expand]DevExpress.Xpf.LayoutControl
  [Expand]DevExpress.Xpf.Map
  [Expand]DevExpress.Xpf.NavBar
  [Expand]DevExpress.Xpf.Navigation
  [Expand]DevExpress.Xpf.PdfViewer
  [Expand]DevExpress.Xpf.PivotGrid
  [Expand]DevExpress.Xpf.PivotGrid.Printing
  [Expand]DevExpress.Xpf.Printing
  [Expand]DevExpress.Xpf.Printing.Parameters
  [Expand]DevExpress.Xpf.Printing.Parameters.Models
  [Expand]DevExpress.Xpf.Printing.PreviewControl.Bars
  [Expand]DevExpress.Xpf.Prism
  [Expand]DevExpress.Xpf.PropertyGrid
  [Expand]DevExpress.Xpf.Reports.UserDesigner
  [Expand]DevExpress.Xpf.Reports.UserDesigner.Extensions
  [Expand]DevExpress.Xpf.Reports.UserDesigner.Localization
  [Expand]DevExpress.Xpf.Reports.UserDesigner.ReportWizard
  [Expand]DevExpress.Xpf.Reports.UserDesigner.ReportWizard.Pages
  [Expand]DevExpress.Xpf.Ribbon
  [Expand]DevExpress.Xpf.RichEdit
  [Expand]DevExpress.Xpf.Scheduler
  [Expand]DevExpress.Xpf.Scheduler.Drawing
  [Expand]DevExpress.Xpf.Scheduler.Menu
  [Expand]DevExpress.Xpf.Scheduler.Reporting
  [Expand]DevExpress.Xpf.Scheduler.UI
  [Expand]DevExpress.Xpf.SpellChecker
  [Expand]DevExpress.Xpf.Spreadsheet
  [Expand]DevExpress.Xpf.Spreadsheet.Menu
  [Expand]DevExpress.Xpf.TreeMap
  [Expand]DevExpress.Xpf.Utils.Themes
  [Expand]DevExpress.Xpf.WindowsUI
  [Expand]DevExpress.Xpf.WindowsUI.Navigation
  [Expand]DevExpress.XtraRichEdit
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Document Server
[Expand]Reporting
[Expand]Report Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

BaseEditSettings.DisplayFormat Property

Gets or sets the pattern used to format the editor's value for display purposes. This is a dependency property.

Namespace:DevExpress.Xpf.Editors.Settings
Assembly:DevExpress.Xpf.Core.v17.1.dll

Expanded Syntax

Property value

Type: String
A System.String value that is the format pattern.

Expanded Remarks

Use the DisplayFormat property to format the editor's value and add any text to its textual representation. The formatted text is displayed if the editor's value is not currently edited (e.g. the editor is not focused or it is read-only).

For example, to display currency values, set the DisplayFormat property to 'c2'. If the editor's value is 99.9, its formatted equivalent will be $99.90.

Note

An editor's value is formatted using string.Format("{0:DisplayFormat}, BaseEdit.EditValue). The specified display format should match the value's type (Example 1). Otherwise, it is ignored and is not applied (Example 2).

Example 1:

Example 2:

Expanded See Also

How would you rate this topic?​​​​​​​