ProgressRing クラス

定義

名前空間:

Microsoft.UI.Xaml.Controls

操作の進行状況を示すコントロールを表します。 一般的なビジュアルの外観は、リング状の "スピナー" です。

このドキュメントは、UWP 用の WinUI 2 に適用されます (Windows アプリ SDKの WinUI の場合は、Windows アプリ SDK名前空間を参照してください)。

/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.XamlContract, 65536)]
class ProgressRing : Control

[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.XamlContract), 65536)]
public class ProgressRing : Control

Public Class ProgressRing
Inherits Control

継承

Control

ProgressRing

属性

MarshalingBehaviorAttribute ThreadingAttribute ContractVersionAttribute

例

ヒント

詳細、設計ガイダンス、およびコード例については、「 進行状況コントロール」を参照してください。

WinUI 3 ギャラリー アプリと WinUI 2 ギャラリー アプリには、ほとんどの WinUI 3 および WinUI 2 コントロールと機能の対話型の例が含まれています。

既にインストールされている場合は、WinUI 3 ギャラリーまたは WinUI 2 ギャラリーのリンクをクリックして開きます。

インストールされていない場合は、Microsoft Store から WinUI 3 ギャラリーと WinUI 2 ギャラリーをダウンロードできます。

GitHub から両方のソース コードを取得することもできます (WinUI 3 の場合は main ブランチ、WinUI 2 の場合は winui2 ブランチを使用します)。

ヒント

詳細、設計ガイダンス、およびコード例については、「 進行状況コントロール」を参照してください。

WinUI 2 ギャラリー アプリを開き、ProgressRing の動作を確認します。

WinUI 2 ギャラリー アプリには、ほとんどの WinUI 2 コントロールと機能の対話型の例が含まれています。 Microsoft Store からアプリを入手するか、GitHub でソース コードを取得します。

この例では、コードで ProgressRing の IsActive プロパティを設定する方法を示します。 ToggleSwitch は、ProgressRing コントロールのオンとオフを切 り替 えるために使用されます。

<StackPanel>
   <muxc:ProgressRing IsActive="{x:Bind ProgressToggle.IsOn, Mode=OneWay}" />
   <ToggleSwitch x:Name="ProgressToggle" Header="Toggle work" OffContent="Do work" OnContent="Working" IsOn="True" />
</StackPanel>

この例では、コードで IsIndeterminate プロパティを設定して、value プロパティに基づいて進行状況リングの塗りつぶしを表示する方法を示します。

<StackPanel>
   <muxc:ProgressRing IsIndeterminate="false">
   <muxc:NumberBox x:Name="ProgressValue" Minimum="0" Maximum="100" SpinButtonPlacementMode="Inline" ValueChanged="ProgressValue_ValueChanged"/>
</StackPanel>

 private void ProgressValue_ValueChanged(Microsoft.UI.Xaml.Controls.NumberBox sender, Microsoft.UI.Xaml.Controls.NumberBoxValueChangedEventArgs args)
{
   if (!sender.Value.IsNaN())
   {
         ProgressRing2.Value = sender.Value;
   }
   else
   {
         sender.Value = 0;
   }
}

注釈

ProgressRing は、アニメーションを繰り返すリング、または値に基づいて塗りつぶされるリングの 2 つのスタイルのいずれかを使用して、操作の進行状況を視覚的に示すコントロールです。

ProgressRing を使用して、操作が進行中であることを視覚的に示します。 ProgressRing をオンまたはオフにするには、 IsActive プロパティを設定します。 IsActive が false の場合、ProgressRing は表示されませんが、UI レイアウトではスペースが予約されています。 ProgressRing の領域を予約しないようにするには、 その Visibility プロパティを Collapsed に設定します。

IsIndeterminate プロパティは、ProgressRing の外観を決定します。

• 繰り返しアニメーションを表示するには、 IsIndeterminate を true に設定します。 (これが既定値です)
• 値に基づいてバーを塗りつぶすには、 IsIndeterminate を false に設定します。 IsIndeterminate が false の場合は、Minimum プロパティと Maximum プロパティを使用して範囲を指定します。 既定では 、最小値 は 0、 最大値 は 100 です。 進行状況の値を指定するには、 Value プロパティを設定します。

コントロール のスタイルとテンプレート

既定の Style と ControlTemplate を変更して、コントロールに一意の外観を与えることができます。 コントロールのスタイルとテンプレートの変更については、「 XAML スタイル」を参照してください。 コントロールの外観を定義する既定のスタイル、テンプレート、およびリソースがファイルに generic.xaml 含まれます。 設計上の目的で、 generic.xaml は WinUI (Microsoft.UI.Xaml) NuGet パッケージと共にインストールされます。 既定では、この場所は \Users\<username>\.nuget\packages\microsoft.ui.xaml\<version>\lib\uap10.0\Microsoft.UI.Xaml\Themes\generic.xaml です。 WinUI の異なるバージョンのスタイルとリソースの値が異なる場合があります。

XAML には、コントロール テンプレートを変更せずに、さまざまなビジュアル状態でコントロールの色を変更するために使用できるリソースも含まれています。 これらのリソースの変更は、 Background や Foreground などのプロパティを設定する場合に推奨 されます。 詳細については、XAML スタイルに関する記事の「軽量のスタイル設定」セクションを参照してください。

コンストラクター

ProgressRing()

ProgressRing クラスの新しいインスタンスを初期化します。 このドキュメントは、UWP 用の WinUI 2 に適用されます (Windows アプリ SDKの WinUI の場合は、Windows アプリ SDK名前空間を参照してください)。

プロパティ

IsActive	ProgressRing に進行状況が表示されているかどうかを示す値を取得または設定します。 このドキュメントは、UWP 用の WinUI 2 に適用されます (Windows アプリ SDKの WinUI の場合は、Windows アプリ SDK名前空間を参照してください)。
IsActiveProperty	IsActive 依存関係プロパティを識別します。 このドキュメントは、UWP 用の WinUI 2 に適用されます (Windows アプリ SDKの WinUI の場合は、Windows アプリ SDK名前空間を参照してください)。
IsIndeterminate	進行状況リングが繰り返しパターンで一般的な進行状況を報告するか、 Value プロパティに基づいて進行状況を報告するかを示す値を取得または設定します。 このドキュメントは、UWP 用の WinUI 2 に適用されます (Windows アプリ SDKの WinUI の場合は、Windows アプリ SDK名前空間を参照してください)。
IsIndeterminateProperty	IsIndeterminate 依存関係プロパティを識別します。 このドキュメントは、UWP 用の WinUI 2 に適用されます (Windows アプリ SDKの WinUI の場合は、Windows アプリ SDK名前空間を参照してください)。
Maximum	範囲要素の最大値を取得または設定します。 このドキュメントは、UWP 用の WinUI 2 に適用されます (Windows アプリ SDKの WinUI の場合は、Windows アプリ SDK名前空間を参照してください)。
MaximumProperty	最大依存関係プロパティを識別します。 このドキュメントは、UWP 用の WinUI 2 に適用されます (Windows アプリ SDKの WinUI の場合は、Windows アプリ SDK名前空間を参照してください)。
Minimum	範囲要素の最小許容 値 を取得または設定します。 このドキュメントは、UWP 用の WinUI 2 に適用されます (Windows アプリ SDKの WinUI の場合は、Windows アプリ SDK名前空間を参照してください)。
MinimumProperty	最小依存関係プロパティを識別します。 このドキュメントは、UWP 用の WinUI 2 に適用されます (Windows アプリ SDKの WinUI の場合は、Windows アプリ SDK名前空間を参照してください)。
TemplateSettings	ProgressRing コントロールのテンプレートを定義するときに TemplateBinding ソースとして参照できる計算値を提供するオブジェクトを取得します。 このドキュメントは、UWP 用の WinUI 2 に適用されます (Windows アプリ SDKの WinUI の場合は、Windows アプリ SDK名前空間を参照してください)。
Value	進行状況リングの現在の大きさを取得または設定します。 このドキュメントは、UWP 用の WinUI 2 に適用されます (Windows アプリ SDKの WinUI の場合は、Windows アプリ SDK名前空間を参照してください)。
ValueProperty	Value 依存関係プロパティを識別します。 このドキュメントは、UWP 用の WinUI 2 に適用されます (Windows アプリ SDKの WinUI の場合は、Windows アプリ SDK名前空間を参照してください)。

こちらもご覧ください

• ProgressBar
• 進行状況コントロールの概要
• コントロールの一覧