Linearize Method

Summary

Converts the file associated with this PDFFile object into a linearized version (one optimized for Web viewing).

Syntax

C++

public void Linearize( 
   string destinationFileName 
)

Public Sub Linearize( _ 
   ByVal destinationFileName As String _ 
)

public: 
void Linearize(  
   String^ destinationFileName 
)

Parameters

destinationFileName
Name of the destination PDF file to be created. If the value of this parameter is null, the file name will be pulled from FileName.

Remarks

A linearized PDF file is a file that has been organized to enable efficient, incremental access in a network environment. The requested page of the PDF file is displayed in a user Web browser while the rest of the file is downloaded from the Web server.

To use this method, associate the PDFFile object with a valid PDF file name and optional password. Do this by either using the PDFFile(string fileName) or PDFFile(string fileName, string password) constructor, or set the file name and optional password directly by setting the FileName and Password properties. It is not necessary to call Load before using this method.

This method will use the following properties of the PDFFile object:

DocumentProperties. If the value of this property is null, the default properties will be used.
CompatibilityLevel. The PDF version to be generated.

The following property is not used by this method:

SecurityOptions. You cannot create encrypted linearized PDF files.

Call IsLinearized to quickly determine if a PDF file is linearized.

Note: Currently, generating linearized PDF files with PDF/A compatibility can result in a PDF file that is not compatible with Adobe Preflight.

Example

This example will linearize a PDF (optimize it for Web viewing).

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Controls; 
using Leadtools.Drawing; 
using Leadtools.ImageProcessing; 
using Leadtools.Pdf; 
using Leadtools.Svg; 
using Leadtools.WinForms; 
 
public void PDFFileLinearizeExample() 
{ 
   string sourceFileName = Path.Combine(LEAD_VARS.ImagesDir, @"Leadtools.pdf"); 
   string destinationFileName = Path.Combine(LEAD_VARS.ImagesDir, @"LEAD_linearized.pdf"); 
 
   // Ensure that the source file is not linearized 
   bool isLinearized = PDFFile.IsLinearized(sourceFileName, null); 
   Console.WriteLine("PDF file {0} isLinearized = {1}", sourceFileName, isLinearized); 
   Assert.IsFalse(isLinearized); 
 
   PDFFile pdf = new PDFFile(sourceFileName); 
   pdf.Linearize(destinationFileName); 
 
   // Ensure that the destination file is linearized 
   isLinearized = PDFFile.IsLinearized(destinationFileName, null); 
   Console.WriteLine("PDF file {0} isLinearized = {1}", destinationFileName, isLinearized); 
   Assert.IsTrue(isLinearized); 
 
   // Check again using PDFDocument class 
   using (PDFDocument document = new PDFDocument(destinationFileName)) 
   { 
      isLinearized = document.IsLinearized; 
      Console.WriteLine("PDF document {0} isLinearized = {1}", destinationFileName, isLinearized); 
      Assert.IsTrue(isLinearized); 
   } 
 
   // Open the destination file in Adobe Acrobat and go to 
   // File/Properties. You should see the "Fast Web View" option as "Yes"; 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Pdf 
Imports Leadtools.WinForms 
Imports Leadtools.Svg 
Imports Leadtools.ImageProcessing 
 
Public Sub PDFFileLinearizeExample() 
   Dim sourceFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Leadtools.pdf") 
   Dim destinationFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "LEAD_linearized.pdf") 
 
   ' Ensure that the source file Is Not linearized 
   Dim isLinearized As Boolean = PDFFile.IsLinearized(sourceFileName, Nothing) 
   Console.WriteLine("PDF file {0} isLinearized = {1}", sourceFileName, isLinearized) 
   Assert.IsFalse(isLinearized) 
 
   Dim pdf As PDFFile = New PDFFile(sourceFileName) 
   pdf.Linearize(destinationFileName) 
 
   ' Ensure that the destination file Is linearized 
   isLinearized = PDFFile.IsLinearized(destinationFileName, Nothing) 
   Console.WriteLine("PDF file {0} isLinearized = {1}", destinationFileName, isLinearized) 
   Assert.IsTrue(isLinearized) 
 
   ' Check again using PDFDocument class 
   Using document As New PDFDocument(destinationFileName) 
      isLinearized = document.IsLinearized 
      Console.WriteLine("PDF document {0} isLinearized = {1}", destinationFileName, isLinearized) 
      Assert.IsTrue(isLinearized) 
   End Using 
 
   ' Open the destination file in Adobe Acrobat and go to 
   ' File/Properties. You should see the "Fast Web View" option as "Yes"; 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class

Requirements

Target Platforms

Reference

PDFFile Class

PDFFile Members

Download our FREE evaluation

Help Version 20.0.2020.4.3

Leadtools.Pdf Assembly

Introduction

Getting Started

Namespaces

Leadtools.Pdf Namespace

Assemblies