DoEvents プロパティ (C1MultiDocument)

生成時に現在の C1MultiDocumentが Windows メッセージを処理するかどうかを示す値を取得または設定します。

デフォルト値は false です。

シンタックス

Visual Basic
C#

'宣言
 
Public Property DoEvents As System.Boolean

'使用法
 
Dim instance As C1MultiDocument
Dim value As System.Boolean
 
instance.DoEvents = value
 
value = instance.DoEvents

public System.bool DoEvents {get; set;}

解説

このプロパティを true に設定すると、ドキュメントの生成時にユーザーはフォームのサイズ変更、ボタンのクリックなどを実行できます。これはアプリケーションの反応を速くし、ドキュメント生成の停止に〈キャンセル〉ボタンを提供する場合に必要となります（そうでない場合、生成が完了するまでユーザーはボタンをクリックできません）。

このプロパティを false に設定するとドキュメントは少し速く生成します。

使用例

下のコードは C1PrintDocumentにアタッチされた〈生成〉および〈キャンセル〉ボタンを実装します。

〈生成〉ボタンは生成を開始する前にドキュメントがビジーかどうかを確認します。これが必要なのは、ドキュメントの生成が完了する前に、ユーザーが〈生成〉ボタンを連続してクリックすることがあるためです（コンポーネントがビジーのときに Generateメソッドを呼び出すと例外がスローされます）。

〈キャンセル〉ボタンはドキュメントが現在生成中かどうかを確認し、生成中の場合に Cancelプロパティを true に設定します。

_doc.DoEvents = true;
          
private void Generate_Click(object sender, EventArgs e)
{
  if (_doc.BusyState != BusyStateEnum.Ready)
    Console.WriteLine("現在生成できません。ドキュメントがビジー状態です。");
  else
    _doc.Generate();
}
          
private void Cancel_Click(object sender, EventArgs e)
{
  if (_doc.BusyState != BusyStateEnum.Ready)
    _doc.Cancel = true;
  else
    Console.WriteLine("ドキュメントは生成されていません。キャンセルするものがありません。");
}

参照

C1MultiDocument クラス
 C1MultiDocument メンバ