プログラムが何かを実行していることをユーザーに知らせるために、待機/ビジーカーソル(通常は砂時計)をユーザーに表示するにはどうすればよいですか?
10 に答える
を使用できますCursor.Current
。
// Set cursor as hourglass
Cursor.Current = Cursors.WaitCursor;
// Execute your time-intensive hashing code here...
// Set cursor as default arrow
Cursor.Current = Cursors.Default;
ただし、ハッシュ操作が非常に長い場合( MSDNではこれを2〜7秒以上と定義しています)、カーソル以外の視覚的なフィードバックインジケーターを使用して、進行状況をユーザーに通知する必要があります。より詳細な一連のガイドラインについては、この記事を参照してください。
編集:
@Amが指摘したように、砂時計が実際に表示されていることを確認するために、Application.DoEvents();
後で電話する必要がある場合があります。Cursor.Current = Cursors.WaitCursor;
実際、
Cursor.Current = Cursors.WaitCursor;
待機カーソルを一時的に設定しますが、操作が終了するまで待機カーソルが表示されることを保証しません。プログラム内の他のプログラムまたはコントロールは、操作の実行中にマウスを動かすと実際に発生するように、カーソルをデフォルトの矢印に簡単にリセットできます。
待機カーソルを表示するためのより良い方法は、フォームのUseWaitCursorプロパティをtrueに設定することです。
form.UseWaitCursor = true;
これにより、このプロパティをfalseに設定するまで、フォーム上のすべてのコントロールの待機カーソルが表示されます。アプリケーションレベルで待機カーソルを表示する場合は、次を使用する必要があります。
Application.UseWaitCursor = true;
以前の方法に基づいて(これは頻繁に実行されるアクションであるため)、待機カーソルコードをIDisposableヘルパークラスでラップして、using()(1行のコード)で使用できるようにし、オプションのパラメーターを取得して、実行することをお勧めします。内のコードをクリーンアップし(カーソルを復元)、後でクリーンアップします。
public class CursorWait : IDisposable
{
public CursorWait(bool appStarting = false, bool applicationCursor = false)
{
// Wait
Cursor.Current = appStarting ? Cursors.AppStarting : Cursors.WaitCursor;
if (applicationCursor) Application.UseWaitCursor = true;
}
public void Dispose()
{
// Reset
Cursor.Current = Cursors.Default;
Application.UseWaitCursor = false;
}
}
使用法:
using (new CursorWait())
{
// Perform some code that shows cursor
}
フォームまたはウィンドウレベルでUseWaitCursorを使用する方が簡単です。一般的な使用例は次のようになります。
private void button1_Click(object sender, EventArgs e)
{
try
{
this.Enabled = false;//optional, better target a panel or specific controls
this.UseWaitCursor = true;//from the Form/Window instance
Application.DoEvents();//messages pumped to update controls
//execute a lengthy blocking operation here,
//bla bla ....
}
finally
{
this.Enabled = true;//optional
this.UseWaitCursor = false;
}
}
UIエクスペリエンスを向上させるには、別のスレッドのAsynchronyを使用する必要があります。
私のアプローチは、バックグラウンドワーカーですべての計算を行うことです。
次に、次のようにカーソルを変更します。
this.Cursor = Cursors.Wait;
そして、スレッドの終了イベントでカーソルを復元します。
this.Cursor = Cursors.Default;
これは特定のコントロールに対しても実行できるため、カーソルはマウスがそれらの上にある場合にのみ砂時計になります。
OK、静的非同期メソッドを作成しました。これにより、アクションを起動してアプリケーションカーソルを変更するコントロールが無効になりました。アクションをタスクとして実行し、終了するのを待ちます。待機中、制御は呼び出し元に戻ります。そのため、ビジーアイコンが回転している間でも、アプリケーションは応答性を維持します。
async public static void LengthyOperation(Control control, Action action)
{
try
{
control.Enabled = false;
Application.UseWaitCursor = true;
Task doWork = new Task(() => action(), TaskCreationOptions.LongRunning);
Log.Info("Task Start");
doWork.Start();
Log.Info("Before Await");
await doWork;
Log.Info("After await");
}
finally
{
Log.Info("Finally");
Application.UseWaitCursor = false;
control.Enabled = true;
}
これがメインフォームのコードです
private void btnSleep_Click(object sender, EventArgs e)
{
var control = sender as Control;
if (control != null)
{
Log.Info("Launching lengthy operation...");
CursorWait.LengthyOperation(control, () => DummyAction());
Log.Info("...Lengthy operation launched.");
}
}
private void DummyAction()
{
try
{
var _log = NLog.LogManager.GetLogger("TmpLogger");
_log.Info("Action - Sleep");
TimeSpan sleep = new TimeSpan(0, 0, 16);
Thread.Sleep(sleep);
_log.Info("Action - Wakeup");
}
finally
{
}
}
ダミーアクションには別のロガーを使用する必要があり(私はNlogを使用しています)、メインのロガーはUI(リッチテキストボックス)に書き込みます。フォーム上の特定のコンテナー上にある場合にのみ、ビジーカーソルを表示できませんでした(ただし、あまり努力しませんでした)。すべてのコントロールにはUseWaitCursorプロパティがありますが、コントロールには影響がないようです。私は試しました(多分彼らが上になかったので?)
これがメインログで、予想どおりに起こっていることを示しています。
16:51:33.1064 Launching lengthy operation...
16:51:33.1215 Task Start
16:51:33.1215 Before Await
16:51:33.1215 ...Lengthy operation launched.
16:51:49.1276 After await
16:51:49.1537 Finally
オーケー、他の人の見解は非常に明確ですが、次のようにいくつか追加したいと思います:
Cursor tempCursor = Cursor.Current;
Cursor.Current = Cursors.WaitCursor;
//do Time-consuming Operations
Cursor.Current = tempCursor;
これをWPFで使用します。
Cursor = Cursors.Wait;
// Your Heavy work here
Cursor = Cursors.Arrow;
Windowsフォームアプリケーションの場合、UIコントロールをオプションで無効にすると非常に便利です。したがって、私の提案は次のようになります。
public class AppWaitCursor : IDisposable
{
private readonly Control _eventControl;
public AppWaitCursor(object eventSender = null)
{
_eventControl = eventSender as Control;
if (_eventControl != null)
_eventControl.Enabled = false;
Application.UseWaitCursor = true;
Application.DoEvents();
}
public void Dispose()
{
if (_eventControl != null)
_eventControl.Enabled = true;
Cursor.Current = Cursors.Default;
Application.UseWaitCursor = false;
}
}
使用法:
private void UiControl_Click(object sender, EventArgs e)
{
using (new AppWaitCursor(sender))
{
LongRunningCall();
}
}
以下のクラスでは、ドーナツの提案を「例外安全」にすることができます。
using (new CursorHandler())
{
// Execute your time-intensive hashing code here...
}
クラスCursorHandler
public class CursorHandler
: IDisposable
{
public CursorHandler(Cursor cursor = null)
{
_saved = Cursor.Current;
Cursor.Current = cursor ?? Cursors.WaitCursor;
}
public void Dispose()
{
if (_saved != null)
{
Cursor.Current = _saved;
_saved = null;
}
}
private Cursor _saved;
}