A Sandcastle Documented Class Library
ComPDFKit.PDFDocument
CPDFDocument Class
CPDFDocument Methods
AddBates Method
AddBookmark Method
AddHeaderFooter Method
ApplyRedaction Method
BookmarkForPageIndex Method
CheckOwnerPassword Method
CommitAllEditPages Method
CompressFile_Cancel Method
CompressFile_Init Method
CompressFile_Start Method
CreateDocument Method
Decrypt Method
DeleteBates Method
DeleteHeaderFooter Method
DeleteWatermarks Method
EditBookmark Method
Encrypt Method
EndAllEditPages Method
ExchangePage Method
ExportAnnotationToXFDFPath Method
ExtractImage Method
GetBackground Method
GetBates Method
GetBookmarkList Method
GetEncryptAlgorithm Method
GetFontInfo Method
GetFontSubsetFailedResult Method
GetHeaderFooter Method
GetInfo Method
GetLanguage Method
GetMergePageImage Method
GetOptimizeOption Method
GetOutlineList Method
GetOutlineRoot Method
GetPageSize Method
GetPDFStandardType Method
GetPDFType Method
GetPermissions Method
GetPermissionsInfo Method
GetSignatureList Method
GetWatermarkCount Method
ImportAnnotationFromXFDFPath Method
ImportPages Method
ImportPagesAtIndex Method
InitWatermark Method
InitWithBytes Method
InitWithFilePath Method
InitWithStream Method
InitWithUrl Method
InsertPage Method
IsImageDoc Method
IsValid Method
MergePages Method
MovePage Method
PageAtIndex Method
PdfToImage Method
PdfToText Method
Release Method
ReleaseOutlineList Method
ReleasePages Method
ReleaseSignatureList Method
RemoveBookmark Method
RemovePages Method
RemoveSignature Method
RotatePage Method
SetInfo Method
SetLanguage Method
UnlockWithPassword Method
WriteFlattenToFilePath Method
WriteOptimizeToFilePath Method
WritePDFAToFilePath Method
WriteSignatureToFilePath Method
WriteStandardPDFToFilePath Method
WriteToBytes Method
WriteToFilePath Method
WriteToLoadedPath Method
WriteToPreparedCopyPath Method
WriteToStream Method
Click or drag to resize

CPDFDocumentCompressFile_Start Method

Note: This API is now obsolete.

Start compressing the document.

Namespace:  ComPDFKit.PDFDocument
Assembly:  ComPDFKit.NET (in ComPDFKit.NET.dll) Version: 3.0.0+4b8ae91508c7f16ebf511129b42dfd307f45e350
Syntax
C#
Copy
[ObsoleteAttribute("CompressFile_Start is deprecated. Use WriteOptimizeToFilePath() instead.")]
public bool CompressFile_Start(
	IntPtr compressOptPtr,
	string savePath
)

Parameters

compressOptPtr
Type: SystemIntPtr
The handle used for compression.
savePath
Type: SystemString
Save path.

Return Value

Type: Boolean
Returns true on success, false on failure.
See Also