Stream Property

Summary

Gets the original document stream.

Syntax

C++/CLI

Java

Python

public Stream Stream {get;}

public:  
   property System::IO::Stream^ Stream 
   { 
      System::IO::Stream^ get() 
   }

public InputStream getStream()

Stream # get  (LEADDocument)

Property Value

Original document stream.

Remarks

Stream contains the original value passed to DocumentFactory.LoadFromStream; otherwise, the value will be null.

The LEADDocument class will use the stream members to read the various parts of the stream, such as the images and metadata, on demand as needed. It is the user's responsibility to keep the stream alive while the document is not disposed. When the document is disposed, the stream is no longer used and can be closed or disposed by the user.

If the document is saved into the cache using SaveToCache, then the entire content of the stream is saved into the cache and the stream is no longer used and can be safely disposed by the user. When the document is later re-loaded from the cache using DocumentFactory.LoadFromCache, then it is treated as if it was downloaded from an external resource and the stream functionality is not used (the value of Stream will be null).

Example

Java

using Leadtools; 
using Leadtools.Caching; 
using Leadtools.Document; 
 
 
public void DocumentFactoryLoadFromStreamExample() 
{ 
   // Get a stream to anything, in this case a file 
   // Note that the stream must be seekable 
   var fileName = Path.Combine(LEAD_VARS.ImagesDir, "Leadtools.pdf"); 
   using (var stream = File.OpenRead(fileName)) 
   { 
      // We must keep the stream alive as long as the document is alive 
      var options = new LoadDocumentOptions(); 
      using (var document = DocumentFactory.LoadFromStream(stream, options)) 
      { 
         Console.WriteLine(document.Stream); 
         PrintOutDocumentInfo(document); 
      } 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}

 
import java.io.File; 
import java.io.FileInputStream; 
import java.io.FileNotFoundException; 
import java.io.IOException; 
import java.io.InputStream; 
import java.net.URI; 
import java.net.URISyntaxException; 
import java.util.Calendar; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
import static org.junit.Assert.*; 
 
import leadtools.*; 
import leadtools.caching.*; 
import leadtools.document.*; 
 
 
public void documentFactoryLoadFromStreamExample() throws FileNotFoundException { 
   String LEAD_VARS_ImagesDir = "C:\\LEADTOOLS23\\Resources\\Images"; 
   // Get a stream to anything, in this case a file 
   // Note that the stream must be seekable 
   String fileName = combine(LEAD_VARS_ImagesDir, "Leadtools.pdf"); 
   ILeadStream documentStream = LeadStreamFactory.create(fileName); 
   // We must keep the stream alive as long as the document is alive 
   LoadDocumentOptions options = new LoadDocumentOptions(); 
   documentStream.seek(LeadSeekOrigin.BEGIN, 0); 
   LEADDocument document = DocumentFactory.loadFromStream(documentStream, options); 
   System.out.println(document.toString()); 
   printOutDocumentInfo(document); 
   assertTrue(document != null && documentStream != null); 
   System.out.println("Document and DocumentStream created successfully"); 
   document.dispose(); 
   documentStream.dispose(); 
}

Requirements

Target Platforms

Reference

LEADDocument Class

LEADDocument Members

Leadtools.Document Namespace

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Document Assembly

Introduction

Getting Started

Namespaces

Leadtools.Document Namespace

Assemblies