IsLinearized(Stream,string) Method

Summary

Determines if the PDF in a stream is linearized (optimized for the web).

Syntax

C++/CLI

Java

Python

public static bool IsLinearized( 
   Stream stream, 
   string password 
)

public static boolean isLinearized( 
   leadtools.ILeadStream iLeadStream,  
   java.lang.String string 
);

public:  
   static bool IsLinearized( 
      Stream^ stream, 
      String^ password 
   )

def IsLinearized(self,stream,password):

Parameters

stream

Stream containing the PDF file data.

password

The password to use when loading this PDF file (if the file is encrypted); otherwise, use null.

Return Value

true if this PDF file is linearized (optimized for the web); otherwise, false.

Remarks

A linearized PDF file is a file that has been organized in such a way as to enable efficient, incremental access in a network environment. Linearized PDF files allow the first page of the PDF file to be displayed in a user Web browser before the entire file is downloaded from the Web server.

Use Linearize to create a linearized version of an existing PDF file.

Example

using Leadtools.WinForms; 
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Controls; 
using Leadtools.Drawing; 
using Leadtools.ImageProcessing; 
using Leadtools.Pdf; 
using Leadtools.Svg; 
 
 
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:\LEADTOOLS22\Resources\Images"; 
}

Requirements

Target Platforms

Reference

PDFFile Class

PDFFile Members

Leadtools.Pdf Namespace

Download our FREE evaluation

Help Version 22.0.2023.7.10

Leadtools.Pdf Assembly

Introduction

Getting Started

Namespaces

Leadtools.Pdf Namespace

Assemblies