Progressイベント

現在の進捗を示すためにファクトリーが文書をロードしている間に1回以上発生するイベント。

構文

C#
Visual Basic
Objective-C
Java
C++

public event EventHandler<LoadAsyncProgressEventArgs> Progress

'Declaration

Public Event Progress As EventHandler(Of LoadAsyncProgressEventArgs)

'Usage

Dim instance As LoadDocumentAsyncOptions
Dim handler As EventHandler(Of LoadAsyncProgressEventArgs)
 
AddHandler instance.Progress, handler

public:
event EventHandler<LoadAsyncProgressEventArgs^>^ Progress

イベントデータ

イベントハンドラは、このイベントに関連するデータを格納するタイプLoadAsyncProgressEventArgsの引数を受け取ります。以下のLoadAsyncProgressEventArgsプロパティは、このイベントに特有の情報を提供します。

プロパティ	説明
BytesReceived	この大量操作の間に受け取るバイト数。
IsCancelPending	ロード操作を中止します。
ProgressPercentage (Inherited from System.ComponentModel.ProgressChangedEventArgs)	非同期タスク進捗パーセンテージを取得します。
TotalBytesToReceive	ロード操作全体のためにこれまでに受け取ったバイトの総数。
Uri	ロードされたドキュメント存在の位置。
UserState (Inherited from System.ComponentModel.ProgressChangedEventArgs)	一意な利用者状態を取得します。

解説

ドキュメントがロードされる間、進捗は1回以上を発生します、そして、ユーザー（そして、必要に応じて、ロードを中止することのサポート）のためにプログレスバーインジケータを示すのに用いられることができます。進捗は、各々の「チャンク」のために以下で値を入力されるLoadAsyncProgressEventArgsイベントデータクラスを使用します：

メンバ	値
ProgressPercentage	現在の進捗パーセンテージ。この値は、0から100まで。。
UserState	LoadDocumentAsyncOptions.UserState。内でユーザーがもともと設定した値と同じ値。
ウーリ	ロードされたドキュメント存在の位置。これは、LoadFromUriAsyncに渡されるuri値です
BytesReceived	この大量操作の間に受け取るバイト数。
TotalBytesToReceive	ロード操作全体のためにこれまでに受け取ったバイトの総数。
IsCancelPending	ロード操作を中止するのに用いられることができます。

サンプル

サンプルのために、参照しますDocumentFactory.LoadFromUriAsync。

必要条件

ターゲットプラットホーム

参照

LoadDocumentAsyncOptionsクラス
 LoadDocumentAsyncOptionsメンバ