LEADTOOLS OCR (Leadtools.Forms.Ocr assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
ExportPages(Int32,Int32,Stream,RasterImageFormat,Int32,Int32,CodecsSavePageMode) Method
See Also 
Leadtools.Forms.Ocr Namespace > IOcrPageCollection Interface > ExportPages Method : ExportPages(Int32,Int32,Stream,RasterImageFormat,Int32,Int32,CodecsSavePageMode) Method



firstPageIndex
The zero-based index of the first page to export.
lastPageIndex
The zero-based index of the last page to export. A value of -1 means export up to and including the last page in the OCR document.
stream
The .NET stream to save the pages to.
format
The image file format to use.
bitsPerPixel
The bits/pixel value of the result image file.
firstSavePageNumber
1-based index of the first output page. If the output file already exists, then this parameter lets you control which pages to overwrite and/or where to append the new pages.
pageMode

Determines how to handle the page when saving to multipage formats. This can be one of the following:

Value Meaning
CodecsSavePageMode.Append Append the new page(s) to the end of the file. If the file does not exist, this option will create the file and add the pages to it. firstSavePageNumber is not used.
CodecsSavePageMode.Insert Insert the new page(s) at the index specified by firstSavePageNumber.
CodecsSavePageMode.Replace Replace the page(s) starting at the index specified by firstSavePageNumber.
CodecsSavePageMode.Overwrite Overwrite the page(s) starting at the index specified by firstSavePageNumber.
CodecsSavePageMode.Append Append the new page(s) to the end of the file. If the file does not exist, this option will create the file and add the pages to it.

The ExportPages(Int32,Int32,Stream,RasterImageFormat,Int32,Int32,CodecsSavePageMode) Method is available as an add-on to the LEADTOOLS Document and Medical Imaging toolkits.

firstPageIndex
The zero-based index of the first page to export.
lastPageIndex
The zero-based index of the last page to export. A value of -1 means export up to and including the last page in the OCR document.
stream
The .NET stream to save the pages to.
format
The image file format to use.
bitsPerPixel
The bits/pixel value of the result image file.
firstSavePageNumber
1-based index of the first output page. If the output file already exists, then this parameter lets you control which pages to overwrite and/or where to append the new pages.
pageMode

Determines how to handle the page when saving to multipage formats. This can be one of the following:

Value Meaning
CodecsSavePageMode.Append Append the new page(s) to the end of the file. If the file does not exist, this option will create the file and add the pages to it. firstSavePageNumber is not used.
CodecsSavePageMode.Insert Insert the new page(s) at the index specified by firstSavePageNumber.
CodecsSavePageMode.Replace Replace the page(s) starting at the index specified by firstSavePageNumber.
CodecsSavePageMode.Overwrite Overwrite the page(s) starting at the index specified by firstSavePageNumber.
CodecsSavePageMode.Append Append the new page(s) to the end of the file. If the file does not exist, this option will create the file and add the pages to it.

Exports one of more page at the specified index to a .NET stream.

Syntax

Visual Basic (Declaration) 
Overloads Sub ExportPages( _
   ByVal firstPageIndex As Integer, _
   ByVal lastPageIndex As Integer, _
   ByVal stream As Stream, _
   ByVal format As RasterImageFormat, _
   ByVal bitsPerPixel As Integer, _
   ByVal firstSavePageNumber As Integer, _
   ByVal pageMode As CodecsSavePageMode _
) 
Visual Basic (Usage)Copy Code
Dim instance As IOcrPageCollection
Dim firstPageIndex As Integer
Dim lastPageIndex As Integer
Dim stream As Stream
Dim format As RasterImageFormat
Dim bitsPerPixel As Integer
Dim firstSavePageNumber As Integer
Dim pageMode As CodecsSavePageMode
 
instance.ExportPages(firstPageIndex, lastPageIndex, stream, format, bitsPerPixel, firstSavePageNumber, pageMode)
C++/CLI 
void ExportPages( 
   int firstPageIndex,
   int lastPageIndex,
   Stream^ stream,
   RasterImageFormat format,
   int bitsPerPixel,
   int firstSavePageNumber,
   CodecsSavePageMode pageMode
) 

Parameters

firstPageIndex
The zero-based index of the first page to export.
lastPageIndex
The zero-based index of the last page to export. A value of -1 means export up to and including the last page in the OCR document.
stream
The .NET stream to save the pages to.
format
The image file format to use.
bitsPerPixel
The bits/pixel value of the result image file.
firstSavePageNumber
1-based index of the first output page. If the output file already exists, then this parameter lets you control which pages to overwrite and/or where to append the new pages.
pageMode

Determines how to handle the page when saving to multipage formats. This can be one of the following:

Value Meaning
CodecsSavePageMode.Append Append the new page(s) to the end of the file. If the file does not exist, this option will create the file and add the pages to it. firstSavePageNumber is not used.
CodecsSavePageMode.Insert Insert the new page(s) at the index specified by firstSavePageNumber.
CodecsSavePageMode.Replace Replace the page(s) starting at the index specified by firstSavePageNumber.
CodecsSavePageMode.Overwrite Overwrite the page(s) starting at the index specified by firstSavePageNumber.
CodecsSavePageMode.Append Append the new page(s) to the end of the file. If the file does not exist, this option will create the file and add the pages to it.

Example

This example will add pages to an OCR document before exporting a range of it back to a .NET stream.

Remarks

To export one page to a .NET stream, use ExportPages(int pageIndex, Stream stream, RasterImageFormat format, int bitsPerPixel)

.

You can export the page to any of the file formats supported by LEADTOOLS. For more information, refer to Summary of All Supported Image File Formats.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also

ExportPages(Int32,Int32,Stream,RasterImageFormat,Int32,Int32,CodecsSavePageMode) requires an OCR module license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features