wpf-devexpress-dot-xpf-dot-editors-7f70efd4.md
A progress bar.
Namespace : DevExpress.Xpf.Editors
Assembly : DevExpress.Xpf.Core.v25.2.dll
NuGet Package : DevExpress.Wpf.Core
[DXLicenseWpfEditors]
public class ProgressBarEdit :
RangeBaseEdit,
IProgressBarExportSettings,
ITextExportSettings,
IExportSettings
<DXLicenseWpfEditors>
Public Class ProgressBarEdit
Inherits RangeBaseEdit
Implements IProgressBarExportSettings,
ITextExportSettings,
IExportSettings
The ProgressBarEdit is a visual control that indicates the progress of lengthy operations.
You can specify the progress bar editor’s value via the RangeBaseEdit.Value or BaseEdit.EditValue property.
<Window ...
xmlns:dxe="http://schemas.devexpress.com/winfx/2008/xaml/editors">
<!-- Create a progress bar with possible values from 0 to 100.
Use the RangeBaseEdit.Value property to specify the value.
Display the progress value in a custom content format. -->
<dxe:ProgressBarEdit
Value="75"
ContentDisplayMode="Value"
DisplayFormatString="{}{0}%"/>
To change the operation mode of a progress bar, assign the BaseEdit.StyleSettings property of the bar to one of the objects listed in the table below.
|
Operation Mode
|
Settings object
|
Description
| | --- | --- | --- | |
Default
|
|
A progress bar that indicates the progress of a lengthy operation. This style is the default mode.
| |
Marquee
|
ProgressBarMarqueeStyleSettings
|
The editor represents the marquee progress bar, which does not display progress.
It displays a block that continuously scrolls from left to right - to indicate a continuous operation.
|
The code snippet below demonstrates how to create a marquee progress bar:
<dxe:ProgressBarEdit>
<dxe:ProgressBarEdit.StyleSettings>
<dxe:ProgressBarMarqueeStyleSettings/>
</dxe:ProgressBarEdit.StyleSettings>
</dxe:ProgressBarEdit>
Use the ProgressBarEdit.ContentDisplayMode property to switch between the following display modes.
None - only a progress indicator is displayed.
Value - progress bar displays a numeric value.
Content - progress bar displays the contents of its ProgressBarEdit.Content property.
You can limit the range of accepted values using the ProgressBarEdit ‘s RangeBaseEdit.Minimum and RangeBaseEdit.Maximum properties.
To display the ProgressBarEdit ‘s value as a decimal number, set the ProgressBarEdit.IsPercent property to true.
Use the ProgressBarEdit ‘s RangeBaseEdit.Orientation property to switch between horizontal and vertical orientations.
Use the ProgressBrush to specify the progress color.
The following code snippets (auto-collected from DevExpress Examples) contain references to the ProgressBarEdit 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.
dxrichedit-for-wpf-how-to-implement-progress-indicator/CS/MainWindow.xaml#L25
</dx:DXTabControl>
<dxe:ProgressBarEdit Name="progressBarControl1" Grid.Row="2" Visibility="Collapsed" />
</Grid>
wpf-richedit-use-docvariable-fields/CS/MainWindow.xaml#L29
</dx:DXTabControl>
<dxe:ProgressBarEdit Name="progressBarControl1" Grid.Row="2" Visibility="Collapsed" />
</Grid>
wpf-grid-read-only-and-enabled-binding/CS/MainWindow.xaml#L32
<DataTemplate>
<dxe:ProgressBarEdit Name="PART_Editor" ContentDisplayMode="Value" IsPercent="True" DisplayFormatString="p0"/>
</DataTemplate>
Object DispatcherObject DependencyObject Visual UIElement FrameworkElement Control BaseEdit RangeBaseEdit ProgressBarEdit
See Also