←Select platform

CompactFile(string,string,int,int,bool,int,int,bool,int,CodecsSavePageMode,bool,bool) Method

Summary

Compacts TIFF files with specific options.

Syntax

C#
VB
C++
public void CompactFile( 
   string srcFileName, 
   string destFileName, 
   int pages, 
   int srcStartPage, 
   bool useSrcIfd, 
   int srcIfd, 
   int destStartPage, 
   bool useDestIfd, 
   int destIfd, 
   CodecsSavePageMode pageMode, 
   bool noSubFileType, 
   bool motorolaOrder 
) 

Public Overloads Sub CompactFile( _ 
   ByVal srcFileName As String, _ 
   ByVal destFileName As String, _ 
   ByVal pages As Integer, _ 
   ByVal srcStartPage As Integer, _ 
   ByVal useSrcIfd As Boolean, _ 
   ByVal srcIfd As Integer, _ 
   ByVal destStartPage As Integer, _ 
   ByVal useDestIfd As Boolean, _ 
   ByVal destIfd As Integer, _ 
   ByVal pageMode As CodecsSavePageMode, _ 
   ByVal noSubFileType As Boolean, _ 
   ByVal motorolaOrder As Boolean _ 
)  

public: 
void CompactFile(  
   String^ srcFileName, 
   String^ destFileName, 
   int pages, 
   int srcStartPage, 
   bool useSrcIfd, 
   int srcIfd, 
   int destStartPage, 
   bool useDestIfd, 
   int destIfd, 
   CodecsSavePageMode pageMode, 
   bool noSubFileType, 
   bool motorolaOrder 
)  

Parameters

srcFileName
A String containing the name of the file being compacted. All the pages will be read from this file.

destFileName
A String containing the name of the file in which all the pages will be written.

pages
Value that represents the number of pages to copy. Use 0 to copy all the pages. If pages is > 0, only pages will be copied to destFileName.

srcStartPage
Specifies the start page in the source file. Page 1 is the first page, page 2 is the second page, etc. The pages will be read starting with this page.

useSrcIfd
true to use srcIfd as the file offset of the first page. false to use srcStartPage.

srcIfd
Offset into the source file for the start page. Used only if useSrcIfd is true.

All pages will be relative to that page. (Note that this might not be the first physical page in the file). This is a common technique for manipulating files with thousands of pages.

destStartPage
0 to overwrite destFileName. <>0 to append the pages to the end of the file.

useDestIfd
true to use destIfd as the file offset of the first page. false to use destStartPage.

destIfd
Offset into the destination file for the start page. Used only if useDestIfd is true.

All pages will be relative to that page. (Note that this might not be the first physical page in the file). This is a common technique for manipulating files with thousands of pages.

pageMode
Flag which indicates the save page mode.

Value Meaning
CodecsSavePageMode.Insert All pages are inserted before destStartPage.
CodecsSavePageMode.Replace Pages in destFileName are replaced beginning with destStartPage.

noSubFileType
true to have the TGSUBFILETYPE tag stripped from all pages in the destination file.

motorolaOrder
true to save pages in Motorola byte order. false to save pages in Intel byte order. This only applies when creating a new file. When updating existing files, the byte order of the original file is used.

Remarks

This method can also be used to copy or extract one or more pages from a TIFF file and copy them without recompression to another TIFF file. Whenever you save an image containing a region as a TIFF file format, the region is also saved. Note, however, that the ability to save a region inside a TIFF file must be unlocked. This requires a Document Imaging or Medical Imaging toolkit.

Example

For an example, refer to CompactFile.

Requirements

Target Platforms

Help Version 20.0.2018.6.21
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Codecs Assembly