SaveImage Event

Occurs during the JPEG 2000 file saving process to provide functionality for manually handling the output image data or monitoring the progress status.

Syntax

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++/CLI

public event EventHandler<CodecsSaveImageEventArgs> SaveImage

'Declaration
 
Public Event SaveImage As EventHandler(Of CodecsSaveImageEventArgs)

'Usage
 
Dim instance As Jpeg2000Engine
Dim handler As EventHandler(Of CodecsSaveImageEventArgs)
 
AddHandler instance.SaveImage, handler

public event EventHandler<CodecsSaveImageEventArgs> SaveImage

add_SaveImage(function(sender, e))
remove_SaveImage(function(sender, e))

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 operation.

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: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

Jpeg2000Engine Class
Jpeg2000Engine Members
SaveComposite