Leadtools.CF Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.6.15
Save Method
See Also 
Leadtools.Codecs Namespace > RasterCodecs Class : Save Method



image
The image to save.
fileName
String containing the output file name.
format
An RasterImageFormat specifying the output file format.
bitsPerPixel
Resulting file's pixel depth. Note that not all bits per pixel are available to all file formats.
pageNumber
1-based index of the output page.
pageMode
An CodecsSavePageMode enumeration that describes how to handle the page when saving to multi-page formats.
image
The image to save.
fileName
String containing the output file name.
format
An RasterImageFormat specifying the output file format.
bitsPerPixel
Resulting file's pixel depth. Note that not all bits per pixel are available to all file formats.
pageNumber
1-based index of the output page.
pageMode
An CodecsSavePageMode enumeration that describes how to handle the page when saving to multi-page formats.
Saves the specified image to a file.

Syntax

Visual Basic (Declaration) 
Public Sub Save( _
   ByVal image As RasterImage, _
   ByVal fileName As String, _
   ByVal format As RasterImageFormat, _
   ByVal bitsPerPixel As Integer, _
   ByVal pageNumber As Integer, _
   ByVal pageMode As CodecsSavePageMode _
) 
Visual Basic (Usage)Copy Code
Dim instance As RasterCodecs
Dim image As RasterImage
Dim fileName As String
Dim format As RasterImageFormat
Dim bitsPerPixel As Integer
Dim pageNumber As Integer
Dim pageMode As CodecsSavePageMode
 
instance.Save(image, fileName, format, bitsPerPixel, pageNumber, pageMode)
C# 
public void Save( 
   RasterImage image,
   string fileName,
   RasterImageFormat format,
   int bitsPerPixel,
   int pageNumber,
   CodecsSavePageMode pageMode
)
C++/CLI 
public:
void Save( 
   RasterImage^ image,
   String^ fileName,
   RasterImageFormat format,
   int bitsPerPixel,
   int pageNumber,
   CodecsSavePageMode pageMode
) 

Parameters

image
The image to save.
fileName
String containing the output file name.
format
An RasterImageFormat specifying the output file format.
bitsPerPixel
Resulting file's pixel depth. Note that not all bits per pixel are available to all file formats.
pageNumber
1-based index of the output page.
pageMode
An CodecsSavePageMode enumeration that describes how to handle the page when saving to multi-page formats.

Example

For an example, refer to RasterCodecs.

Remarks

If bitsPerPixel is 0, the file will be stored using the closet BitsPerPixel value supported by that format.

For example, if a file format supports 1, 4, and 24 BitsPerPixel, and the image's BitsPerPixel is 5, the file will be stored as 24 bit. Likewise, if the BitsPerPixel is 2, the file will be stored as 4 bit.

If the image is 8 bits per pixel or greater, use the LEAD CMP format or one of the JPEG (JTIF or JFIF) formats to save disk space.

If the image is 1-bit per pixel, use the LEAD 1-bit format or a CCITT Group 3 or 4 format to save disk space.

For more information, refer to Loading and Saving Images.

For more information, refer to Loading and Saving Large Tiff Files.

For more information, refer to Loading and Saving Large Tiff Files.

Requirements

Target Platforms: Microsoft .NET CF Framework 2.0, Windows Mobile 5 PocketPC, Windows Mobile 5 Smartphone, Windows Mobile 6

See Also