ClearImage .NET API
Edit(Stream,EditPageEventHandler,ImageFileFormat) Method





Inlite.ClearImageNet Namespace > ImageEditor Class > Edit Method : Edit(Stream,EditPageEventHandler,ImageFileFormat) Method
Input stream.
Input pages processing handler.
Output format.
Edit image pages in Stream object through event handler.
Syntax
'Declaration
 
Public Overloads Function Edit( _
   ByVal stream As System.IO.Stream, _
   ByVal handler As ImageEditor.EditPageEventHandler, _
   ByVal format As ImageFileFormat _
) As System.IO.MemoryStream
'Usage
 
Dim instance As ImageEditor
Dim stream As System.IO.Stream
Dim handler As ImageEditor.EditPageEventHandler
Dim format As ImageFileFormat
Dim value As System.IO.MemoryStream
 
value = instance.Edit(stream, handler, format)
public System.IO.MemoryStream Edit( 
   System.IO.Stream stream,
   ImageEditor.EditPageEventHandler handler,
   ImageFileFormat format
)
public function Edit( 
    stream: System.IO.Stream;
    handler: ImageEditor.EditPageEventHandler;
    format: ImageFileFormat
): System.IO.MemoryStream; 
public function Edit( 
   stream : System.IO.Stream,
   handler : ImageEditor.EditPageEventHandler,
   format : ImageFileFormat
) : System.IO.MemoryStream;
public:
System.IO.MemoryStream^ Edit( 
   System.IO.Stream^ stream,
   ImageEditor.EditPageEventHandler^ handler,
   ImageFileFormat format
) 

Parameters

stream
Input stream.
handler
Input pages processing handler.
format
Output format.

Return Value

Memory stream with processed pages.
Remarks

This method processes an image file stored in a Stream object.  stream should contain data in one supported image file formats. 

Image processing is performed by the method pointed by the handler parameter.  If handler is null no image processing is done, and method is used only for format conversion.  To remove specific pages from the output stream handler should set EditPageEventArgs.skipPage to true,

Each input page is written to the output stream using format parameter. 
If format = inputFileFormat output format is the same as the format of the inputFile

The multi-page output stream can be created only using PDF and TIFF formats   Set format=pdf or format=tiff respectively. Image compression controlled by IO.compressionBitonalEx and IO.compressionColorEx properties.

IO.jpegQuality controls compression when format=jpeg or IO.compressionColorEx=jpeg and output format is PDF or TIFF

See Also

Reference

ImageEditor Class
ImageEditor Members
Overload List