ProgressBar Class (System.Windows.Controls)

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

ProgressBar Class

Updated: February 2009

Indicates the progress of an operation.

Namespace: System.Windows.Controls
Assembly: PresentationFramework (in PresentationFramework.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/xaml/presentation

Syntax

Visual Basic (Declaration)

<TemplatePartAttribute(Name := "PART_Track", Type := GetType(FrameworkElement))> _
<TemplatePartAttribute(Name := "PART_Indicator", Type := GetType(FrameworkElement))> _
Public Class ProgressBar _
    Inherits RangeBase

Visual Basic (Usage)

Dim instance As ProgressBar

[TemplatePartAttribute(Name = "PART_Track", Type = typeof(FrameworkElement))]
[TemplatePartAttribute(Name = "PART_Indicator", Type = typeof(FrameworkElement))]
public class ProgressBar : RangeBase

Visual C++

[TemplatePartAttribute(Name = L"PART_Track", Type = typeof(FrameworkElement))]
[TemplatePartAttribute(Name = L"PART_Indicator", Type = typeof(FrameworkElement))]
public ref class ProgressBar : public RangeBase

JScript

public class ProgressBar extends RangeBase

XAML Object Element Usage

<ProgressBar .../>

Remarks

A ProgressBar control consists of a window that is filled, by default from left to right, as an operation progresses. The control has a range and a current position.

ProgressBar overrides the metadata of the Maximum property and sets its default to 100. ProgressBar overrides the metadata of the Focusable property and sets its default to false. For more information, see Dependency Properties Overview.

Dependency properties for this control might be set by the control’s default style. If a property is set by a default style, the property might change from its default value when the control appears in the application. The default style is determined by which desktop theme is used when the application is running. For more information, see Themes.

Examples

This example creates a ProgressBar and uses an animation to simulate the progress of an operation.

<StatusBar Name="sbar" 
           VerticalAlignment="Bottom" Background="Beige" >

  <StatusBarItem>
    <TextBlock>Downloading File</TextBlock>
  </StatusBarItem>
  <StatusBarItem>
    <ProgressBar Width="100" Height="20"
                 Name="progressBar1">
      <ProgressBar.Triggers>
        <EventTrigger RoutedEvent="ProgressBar.Loaded">
          <BeginStoryboard>
            <Storyboard>
              <DoubleAnimation
                Storyboard.TargetName="progressBar1" 
                Storyboard.TargetProperty="Value"
                From="0" To="100" Duration="0:0:5"  />
            </Storyboard>
          </BeginStoryboard>
        </EventTrigger>
      </ProgressBar.Triggers>
    </ProgressBar>
  </StatusBarItem>
  <StatusBarItem>
    <Separator/>
  </StatusBarItem>
  <StatusBarItem>
    <TextBlock>Online</TextBlock>
  </StatusBarItem>
  <StatusBarItem HorizontalAlignment="Right">
    <Image Source="images\help.bmp" Width="16" Height="16"/>
  </StatusBarItem>
</StatusBar>

ProgressBar progbar = new ProgressBar();
progbar.IsIndeterminate = false;
progbar.Orientation = Orientation.Horizontal;
progbar.Width = 150;
progbar.Height = 15;
Duration duration = new Duration(TimeSpan.FromSeconds(10));
DoubleAnimation doubleanimation = new DoubleAnimation(100.0, duration);
progbar.BeginAnimation(ProgressBar.ValueProperty, doubleanimation);

Inheritance Hierarchy

System..::.Object
  System.Windows.Threading..::.DispatcherObject
    System.Windows..::.DependencyObject
      System.Windows.Media..::.Visual
        System.Windows..::.UIElement
          System.Windows..::.FrameworkElement
            System.Windows.Controls..::.Control
              System.Windows.Controls.Primitives..::.RangeBase
                System.Windows.Controls..::.ProgressBar

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0

Reference

ProgressBar Members

System.Windows.Controls Namespace

RangeBase

Other Resources

ProgressBar Sample

Change History

Date	History	Reason
February 2009	Described how default styles change dependency properties.	Customer feedback.

Date

History

Reason

February 2009

Described how default styles change dependency properties.

Customer feedback.