LEADTOOLS画像ファイルサポート(Leadtools.Codecsアセンブリ)

フレームを表示

LoadAsyncCompletedイベント








非同期のロード操作が完了したことを示します。
構文
public event EventHandler<CodecsLoadAsyncCompletedEventArgs> LoadAsyncCompleted
'Declaration
 
Public Event LoadAsyncCompleted As EventHandler(Of CodecsLoadAsyncCompletedEventArgs)
'Usage
 
Dim instance As RasterCodecs
Dim handler As EventHandler(Of CodecsLoadAsyncCompletedEventArgs)
 
AddHandler instance.LoadAsyncCompleted, handler
public event EventHandler<CodecsLoadAsyncCompletedEventArgs> LoadAsyncCompleted
synchronized public void addLoadAsyncCompletedListener(CodecsLoadAsyncCompletedListener listener)
synchronized public void removeLoadAsyncCompletedListener(CodecsLoadAsyncCompletedListener listener)
            
add_LoadAsyncCompleted(function(sender, e))
remove_LoadAsyncCompleted(function(sender, e))

public:
event EventHandler<CodecsLoadAsyncCompletedEventArgs^>^ LoadAsyncCompleted
イベントデータ

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

プロパティ説明
Cancelled (Inherited from System.ComponentModel.AsyncCompletedEventArgs)非同期動作がキャンセルされたかどうか示している値を取得します。
Error (Inherited from System.ComponentModel.AsyncCompletedEventArgs)どのエラーが非同期動作の間、発生したかについて示している値を取得します。
FileName (Inherited from Leadtools.Codecs.CodecsAsyncCompletedEventArgs)この非同期動作が使用しているファイル名を取得します。
Image ロードされているRasterImageクラスインスタンスを取得します。
Stream (Inherited from Leadtools.Codecs.CodecsAsyncCompletedEventArgs)この非同期動作が使っているストリームを取得します。
Uri (Inherited from Leadtools.Codecs.CodecsAsyncCompletedEventArgs)この非同期動作が使っているURIを取得します。
UserState (Inherited from System.ComponentModel.AsyncCompletedEventArgs)非同期タスクの固有識別子を取得します。
解説

RasterCodecsクラスは、LoadAsyncメソッドを用いて非同期でロード画像ファイルをサポートします。これらのいずれかのメソッドを呼び出すと、コーラースレッドはブロックされ、ロード状態にあるインスタンスRasterImageのでただちに返されます(RasterImage.IsLoadingをtrueに設定)。オブジェクトがロード状態にある間は、このオブジェクトのその他のプロパティは使用してはなりません。

RasterCodecsオブジェクトがimageをロードするを完了するとき、RasterImageのいろいろなプロパティは画像情報で値を入力されます、そして、データとRasterImage.IsLoadingプロパティはfalseに設定されます。

imageがロードされて終わるかどうか決定するためにRasterImage.IsLoadingプロパティをポーリングしないよう勧めます、代わりに、LoadAsync操作がいつ完了されるか、そして、任意のエラーが発生したかどうかについて通知を取得するために、LoadAsyncCompletedイベントにサブスクライブします。

LoadAsyncCompletedイベントデータにはLoadAsyncから返されたものと同じオブジェクトも含まれます。このためアプリケーション内にオリジナルのオブジェクトを保持しておく必要はありません。

LoadAsyncCompletedイベントは、型CodecsLoadAsyncCompletedEventArgsのデータ引数オブジェクトを使います。このクラスは、以下のプロパティを格納します:

プロパティ 説明
CodecsLoadAsyncCompletedEventArgs.UriCodecsLoadAsyncCompletedEventArgs.StreamCodecsLoadAsyncCompletedEventArgs.FileName

この非同期動作を初期化したメソッドに渡されるURI、ストリームまたはファイル名を格納します。

常に、これらのプロパティのいずれか1つのみが有効な値(null参照ではない値)になります。どのプロパティに有効な参照が含まれるかは、どのバージョンのLoadAsyncメソッドが呼び出されたかによって決まります。

たとえばLoadAsync(ウーリuri、オブジェクトuserState)が呼び出されている場合、Uriにはメソッドに渡されるものと同じURIが含まれ、StreamFileNameはどちらもNULLになります。LoadAsync(String fileName、オブジェクトuserState)が呼び出されている場合、FileNameにはメソッドに渡されるものと同じファイル名の文字列値が含まれ、ウーリStreamはどちらもNULLになる、等です。

CodecsLoadAsyncCompletedEventArgs.Image

ロードされている画像データを格納するRasterImageクラスインスタンスを格納します。このインスタンスは、LoadAsyncメソッドから返される同じオブジェクトです。非同期操作の実行中は、RasterImage.IsLoadingの値がtrueになります。これは、現在このオブジェクトに画像情報を格納している最中であり、このオブジェクトを使用すべきでないことを示します。操作が完了する非同期、イベントが発生するLoadAsyncCompletedとimageがいつ最終的であるものとすぐに使えるものを格納するかオブジェクト。エラーが発生するならば、このプロパティはnullに設定されます、そして、オブジェクトはツールキットで内部的に破棄されます。

CodecsLoadAsyncCompletedEventArgs.Error

非同期動作の間、発生したかもしれない任意のエラーを格納します。LoadAsyncCompletedイベントが発生するこの値を確認しなければならなくて、それが有効な例外を格納しないことを確認しなければなりませんオブジェクト。

CodecsLoadAsyncCompletedEventArgs.Cancelled

非同期動作がキャンセルされたかどうか示している値を格納します。たとえば、URLでRasterCodecs.LoadAsyncを使うとき、CancelAsyncを呼び出すことによって。

サンプル
Copy Code  
Imports Leadtools
Imports Leadtools.Codecs
Imports Leadtools.ImageProcessing
Imports Leadtools.ImageProcessing.Color
Imports Leadtools.Drawing
Imports Leadtools.Svg

      
Public Sub LoadAsyncCompletedExample()
   Dim srcFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp")
   Dim uri As New Uri(srcFileName)
   Dim codecs As New RasterCodecs()

   ' Now load the image asynchronously
   AddHandler codecs.LoadAsyncCompleted, AddressOf LoadAsyncCompletedExample_LoadAsyncCompleted
   Dim rasterImageObject As Object = codecs.LoadAsync(uri, Nothing)

   ' Notice that the returned rasterImageObject is a RasterImage with IsLoading set to true at this point
   ' The IsLoading will be false (and hence, the object will be usable) when the LoadAsyncCompleteted
   ' fires.
End Sub

Private Sub LoadAsyncCompletedExample_LoadAsyncCompleted(ByVal sender As Object, ByVal e As CodecsLoadAsyncCompletedEventArgs)
   If e.Cancelled Then
      Console.WriteLine("User canceled")
   ElseIf Not IsNothing(e.Error) Then
      Console.WriteLine("Error: " + e.Error.Message)
   Else
      ' Everything is OK, get the image
      Dim image As RasterImage = e.Image
      Console.WriteLine("Image at {0} loaded OK, size: {1} by {2}", e.Uri, image.Width, image.Height)
      image.Dispose()
   End If

   ' Unsubscribe to the event and dispose the RasterCodecs object
   Dim codecs As RasterCodecs = DirectCast(sender, RasterCodecs)
   RemoveHandler codecs.LoadAsyncCompleted, AddressOf LoadAsyncCompletedExample_LoadAsyncCompleted
   codecs.Dispose()
End Sub

Public NotInheritable Class LEAD_VARS
Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class
using Leadtools;
using Leadtools.Codecs;
using Leadtools.ImageProcessing;
using Leadtools.ImageProcessing.Color;
using Leadtools.Svg;

      
public void LoadAsyncCompletedExample()
{
   string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp");
   Uri uri = new Uri(srcFileName);
   RasterCodecs codecs = new RasterCodecs();

   // Now load the image asynchronously
   codecs.LoadAsyncCompleted += new EventHandler<CodecsLoadAsyncCompletedEventArgs>(LoadAsyncCompletedExample_LoadAsyncCompleted);
   object rasterImageObject = codecs.LoadAsync(uri, null);

   // Notice that the returned rasterImageObject is a RasterImage with IsLoading set to true at this point
   // The IsLoading will be false (and hence, the object will be usable) when the LoadAsyncCompleteted
   // fires.
}

private void LoadAsyncCompletedExample_LoadAsyncCompleted(object sender, CodecsLoadAsyncCompletedEventArgs e)
{
   if (e.Cancelled)
   {
      Console.WriteLine("User canceled");
   }
   else if (e.Error != null)
   {
      Console.WriteLine("Error: " + e.Error.Message);
   }
   else
   {
      // Everything is OK, get the image
      RasterImage image = e.Image;
      Console.WriteLine("Image at {0} loaded OK, size: {1} by {2}", e.Uri, image.Width, image.Height);
      image.Dispose();
   }

   // Unsubscribe to the event and dispose the RasterCodecs object
   RasterCodecs codecs = sender as RasterCodecs;
   codecs.LoadAsyncCompleted -= new EventHandler<CodecsLoadAsyncCompletedEventArgs>(LoadAsyncCompletedExample_LoadAsyncCompleted);
   codecs.Dispose();
}

static class LEAD_VARS
{
public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}
必要条件

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

参照

参照

RasterCodecsクラス
RasterCodecsメンバ