Syntax
| Visual Basic (Declaration) | |
|---|---|
Public Event LoadImage As EventHandler(Of CodecsLoadImageEventArgs) | |
| Visual Basic (Usage) |  Copy Code |
|---|---|
Dim instance As Jpeg2000Engine Dim handler As EventHandler(Of CodecsLoadImageEventArgs) AddHandler instance.LoadImage, handler | |
| C# | |
|---|---|
public event EventHandler<CodecsLoadImageEventArgs> LoadImage | |
| C++/CLI | |
|---|---|
public: event EventHandler<CodecsLoadImageEventArgs^>^ LoadImage | |
Event Data
The event handler receives an argument of type CodecsLoadImageEventArgs containing data related to this event. The following CodecsLoadImageEventArgs properties provide information specific to this event.
| Property | Description |
|---|---|
| Buffer | Gets the memory buffer containing one or more lines of output image data. |
| Cancel | Gets or sets a value which allows the user to abort the load process. |
| FileName | Gets the name of the file currently being loaded. |
| FirstPage | Gets the index of the first page being loaded. |
| Flags | Gets a value which describes whether this is the first or last call of the event, and whether the buffer contains first or last row of image data. |
| Image | Gets the Leadtools.RasterImage object into which the image data is being loaded. |
| ImagePage | Gets the index of the RasterImage.Page into which the image data is being loaded. |
| Info | Gets a Leadtools.Codecs.CodecsImageInfo object that contains information about the image file being loaded. |
| LastPage | Gets the index of the last page being loaded. |
| Lines | Gets the number of lines in Leadtools.Codecs.CodecsLoadImageEventArgs.Buffer. |
| Offset | Gets the offset in bytes from the beginning of the file at which the image data begins. |
| OffsetCount | Gets the number of bytes that make up the actual image data being loaded. |
| OffsetValid | Determines whether the Leadtools.Codecs.CodecsLoadImageEventArgs.Offset property is valid. |
| Page | Gets the index of the page currently being loaded. |
| PagePercent | Gets the load completion percentage of the current page. |
| Row | Gets the current image row number of the first line in Leadtools.Codecs.CodecsLoadImageEventArgs.Buffer. |
| Stream | Gets the Leadtools.Codecs.CodecsLoadImageEventArgs.Stream associated with the file load process. |
| Tile | Gets the rectangular area of the image being loaded. |
| TileValid | Determines whether the Leadtools.Codecs.CodecsLoadImageEventArgs.Tile property is valid. |
| TotalPercent | Gets the overall completion percentage for the load operation. |
Remarks
This event will fire during loading images with the Load and LoadComposite methods. You can use this event to get information about the image being loaded, manually handle the image scanline data or provide a progress status as well as to abort the load operation.
Requirements
Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7