私はユーザーがログインしているC#アプリケーションを持っています、そしてハッシュアルゴリズムは高価なので、それには少し時間がかかります。プログラムが何かをしていることをユーザーに知らせるために、待機/使用中カーソル(通常は砂時計)をユーザーに表示する方法を教えてください。
プロジェクトはC#です。
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が指摘したように、砂時計が実際に表示されるようにするには、Cursor.Current = Cursors.WaitCursor;
の後にApplication.DoEvents();
を呼び出す必要があるかもしれません。
実は
Cursor.Current = Cursors.WaitCursor;
一時的には待機カーソルを設定しますが、待機カーソルが操作の最後まで表示されることを保証しません。動作中にマウスを動かすと実際に起こるように、プログラム内の他のプログラムやコントロールは、カーソルをデフォルトの矢印に簡単に戻すことができます。
待機カーソルを表示するより良い方法は、フォームのUseWaitCursorプロパティをtrueに設定することです。
form.UseWaitCursor = true;
このプロパティをfalseに設定するまで、フォーム上のすべてのコントロールの待機カーソルが表示されます。待機カーソルをアプリケーションレベルで表示したい場合は、次のようにします。
Application.UseWaitCursor = true;
これを頻繁に実行するアクションなので、これをもとにした私の推奨するアプローチは、waitカーソルコードを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エクスペリエンスのためには、別のスレッドから非同期を使用するべきです。
私のアプローチは、バックグラウンドワーカーですべての計算をすることです。
それからカーソルを次のように変更します。
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(リッチテキストボックス)に書き込んでいます。フォーム上の特定のコンテナの上にあるときだけビジーカーソルを表示することができませんでした(しかし、私はあまり努力しませんでした)。私は試してみました(おそらく彼らは上にいなかったのでしょうか?)
これがメインログで、予想通りの順序で起こっていることがわかります。
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
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();
}
}
オーキー、他の人々の見解は非常に明確ですが、私は以下のように、いくつか追加したいと思います。
Cursor tempCursor = Cursor.Current;
Cursor.Current = Cursors.WaitCursor;
//do Time-consuming Operations
Cursor.Current = tempCursor;
以下のクラスを使えば、Donutの提案を「例外なしに安全」にすることができます。
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;
}
これをWPFで使用します。
Cursor = Cursors.Wait;
// Your Heavy work here
Cursor = Cursors.Arrow;