Syntax
| Visual Basic (Declaration) | |
|---|---|
Public Event SaveImage As EventHandler(Of CodecsSaveImageEventArgs) | |
| Visual Basic (Usage) |  Copy Code |
|---|---|
Dim instance As Jpeg2000Engine Dim handler As EventHandler(Of CodecsSaveImageEventArgs) AddHandler instance.SaveImage, handler | |
| C# | |
|---|---|
public event EventHandler<CodecsSaveImageEventArgs> SaveImage | |
| C++/CLI | |
|---|---|
public: event EventHandler<CodecsSaveImageEventArgs^>^ SaveImage | |
Event Data
The event handler receives an argument of type CodecsSaveImageEventArgs containing data related to this event. The following CodecsSaveImageEventArgs properties provide information specific to this event.
| Property | Description |
|---|---|
| Buffer | Gets the memory buffer containing one or more lines of output image data that the you must provide. |
| Cancel | Gets or sets a value which allows the user to abort the save process. |
| FileName | Gets the name of the file currently being saved. |
| FirstPage | Gets the index of the first page being saved. |
| Image | Gets the Leadtools.RasterImage object being saved. |
| ImagePage | Gets the index of the RasterImage.Page currently being saved. |
| LastPage | Gets the index of the last page being saved. |
| Lines | Gets the number of lines to copy from Leadtools.Codecs.CodecsSaveImageEventArgs.Buffer. |
| Offset | Gets the offset to the start of the image data. |
| OffsetValid | Gets a value that determines whether the Leadtools.Codecs.CodecsSaveImageEventArgs.Offset property is valid. |
| Page | Gets the page number currently being saved. |
| PagePercent | Gets the save completion percentage of the current page. |
| Row | Gets the current image row number of the first line in Leadtools.Codecs.CodecsSaveImageEventArgs.Buffer. |
| Stream | Gets the stream object currently being saved. |
| TotalPercent | Gets the overall completion percentage for the save soperation. |
Remarks
This event will fire during saving images with the Save and SaveComposite methods. You can use this event to get information about the image being saved, manually provide the image scanline data being saved data or provide progress status as well as to abort the save 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