Back to Devexpress

RepositoryItemProgressBar Class

windowsforms-devexpress-dot-xtraeditors-dot-repository-5de1e8a9.md

latest5.7 KB
Original Source

RepositoryItemProgressBar Class

A repository item that stores settings specific to a ProgressBarControl.

Namespace : DevExpress.XtraEditors.Repository

Assembly : DevExpress.XtraEditors.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
[DXLicenseWinFormsEditors]
public class RepositoryItemProgressBar :
    RepositoryItemBaseProgressBar
vb
<DXLicenseWinFormsEditors>
Public Class RepositoryItemProgressBar
    Inherits RepositoryItemBaseProgressBar

The following members return RepositoryItemProgressBar objects:

Remarks

The RepositoryItemProgressBar class contains properties and events related to progress bar controls (ProgressBarControl class objects). In a standalone ProgressBarControl, use the ProgressBarControl.Properties property to access these settings.

The following table lists main settings of the RepositoryItemProgressBar class:

|

Setting

|

Description

| | --- | --- | |

Maximum and Minimum

|

Specify maximum and minimum values that can be displayed.

| |

PercentView and ShowTitle

|

Specify the availability and format of the text label that indicates the current progress.

| |

ProgressKind

|

Specifies the progress bar’s direction.

|

Note

You do not need to create repository items manually unless you create inplace editors for container controls like the Data Grid. Refer to the following help topic for more information: Cell Editors.

Example

The following code snippet creates a RepositoryItemProgressBar and assigns it to a Grid column:

csharp
using DevExpress.XtraEditors;
using DevExpress.XtraEditors.Repository;
using DevExpress.XtraGrid;
using DevExpress.XtraGrid.Views.Grid;

namespace progressBar {
    public partial class Form1 : XtraForm {

        RepositoryItemProgressBar bar;

        public Form1() {
            InitializeComponent();

            bar = new RepositoryItemProgressBar();
            // Add the item to the grid's 'RepositoryItems' collection
            gridControl1.RepositoryItems.Add(bar);
            // Customize the repository item
            bar.Minimum = 0;
            bar.Maximum = 100;
            bar.PercentView = true;
            bar.ShowTitle = true;
            // Assign the repository item to a column
            gridView1.Columns["TaskProgress"].ColumnEdit = bar;
        }
    }
}
vb
Imports DevExpress.XtraEditors
Imports DevExpress.XtraEditors.Repository
Imports DevExpress.XtraGrid
Imports DevExpress.XtraGrid.Views.Grid

Namespace progressBar
    Partial Public Class Form1
        Inherits XtraForm

        Private bar As RepositoryItemProgressBar

        Public Sub New()
            InitializeComponent()

            bar = New RepositoryItemProgressBar()
            ' Add the item to the grid's 'RepositoryItems' collection
            gridControl1.RepositoryItems.Add(bar)
            ' Customize the repository item
            bar.Minimum = 0
            bar.Maximum = 100
            bar.PercentView = True
            bar.ShowTitle = True
            ' Assign the repository item to a column
            gridView1.Columns("TaskProgress").ColumnEdit = bar
        End Sub
    End Class
End Namespace

Inheritance

Object MarshalByRefObject Component DevExpress.XtraEditors.ComponentBase RepositoryItem RepositoryItemBaseProgressBar RepositoryItemProgressBar

See Also

Edit Data. Create Cell Editors. Validate User Input

How to: Display File Operation's Progress via ProgressBarControl

RepositoryItemProgressBar Members

DevExpress.XtraEditors.Repository Namespace