Share via


IXRProgressBar (Compact 2013)

3/28/2014

This class represents a control that indicates the progress of an operation.

Syntax

class IXRProgressBar : public IXRRangeBase

Inheritance Hierarchy

IXRDependencyObject

    IXRUIElement

        IXRFrameworkElement

            IXRControl

                IXRRangeBase

                    IXRProgressBar

Methods

Method

Description

IXRProgressBar::GetIsIndeterminate

Retrieves a value that indicates whether this progress bar displays a repeating pattern or fills incrementally based on the current value in IXRRangeBase::GetValue.

IXRProgressBar::SetIsIndeterminate

Sets a value that indicates whether this progress bar displays a repeating pattern or fills incrementally based on the current value in IXRRangeBase::GetValue.

Thread Safety

Members of this class are thread-safe if you previously called IXRApplication::CreateHostFromXaml and supplied it with an XRWindowCreateParams structure that has AllowsMultipleThreadAccess set to true.

Remarks

An IXRProgressBar control inherits from IXRRangeBase and indicates progress of a lengthy operation by displaying one of the following styles:

  • A bar that displays a repeating pattern.
  • A bar that fills itself incrementally, based on a value.

The value that you provide in IXRProgressBar::SetIsIndeterminate determines the appearance of the progress bar.

Call IXRProgressBar::SetIsIndeterminate with a value of true to display a repeating pattern.

Call IXRProgressBar::SetIsIndeterminate with a value of false to fill the bar incrementally, based on a value. When you specify false, you must indicate the range by using the inherited methods IXRRangeBase::SetMinimum and IXRRangeBase::SetMaximum. You must call the inherited method IXRRangeBase::SetValue every time the progress value changes to determine the percentage of the bar that is filled at a given time.

When you create a class instance, use an IXRProgressBarPtr smart pointer instead of a raw interface pointer. For more information, see XRPtr<Interface>.

You can also define a progress bar in Microsoft Silverlight 3 XAML. For information about the differences between XAML in XAML for Windows Embedded and Silverlight 3, see Differences Between Microsoft Silverlight 3 and XAML for Windows Embedded. For more information about how to define this element in the source XAML for your application, see the ProgressBar Class on MSDN.

.NET Framework Equivalent

System.Windows.Controls.ProgressBar

Requirements

Header

XamlRuntime.h

sysgen

SYSGEN_XAML_RUNTIME

See Also

Reference

Classes for UI Element Management