Class PdfStream
- Namespace
- iTextSharp.text.pdf
- Assembly
- iTextSharp.LGPLv2.Core.dll
PdfStream is the Pdf stream object. A stream, like a string, is a sequence of characters. However, an application can read a small portion of a stream at a time, while a string must be read in its entirety. For this reason, objects with potentially large amounts of data, such as images and page descriptions, are represented as streams. A stream consists of a dictionary that describes a sequence of characters, followed by the keyword stream, followed by zero or more lines of characters, followed by the keyword endstream. All streams must be PdfIndirectObject s. The stream dictionary must be a direct object. The keyword stream that follows the stream dictionary should be followed by a carriage return and linefeed or just a linefeed. Remark: In this version only the FLATEDECODE-filter is supported. This object is described in the 'Portable Document Format Reference Manual version 1.3' section 4.8 (page 41-53). @see PdfObject @see PdfDictionary
public class PdfStream : PdfDictionary- Inheritance
-
PdfStream
- Derived
- Inherited Members
Constructors
PdfStream()
Constructs a PdfStream -object.
protected PdfStream()PdfStream(byte[])
Constructs a PdfStream -object.
public PdfStream(byte[] bytes)Parameters
bytesbyte[]content of the new PdfObject as an array of byte .
PdfStream(Stream, PdfWriter)
Creates an efficient stream. No temporary array is ever created. The InputStream is totally consumed but is not closed. The general usage is: InputStream in = ...; PdfStream stream = new PdfStream(in, writer); stream.FlateCompress(); writer.AddToBody(stream); stream.WriteLength(); in.Close();
public PdfStream(Stream inputStream, PdfWriter writer)Parameters
Fields
BEST_COMPRESSION
membervariables
public const int BEST_COMPRESSION = 9Field Value
BEST_SPEED
A possible compression level. @since 2.1.3
public const int BEST_SPEED = 1Field Value
Compressed
is the stream compressed?
protected bool CompressedField Value
CompressionLevel
The level of compression. @since 2.1.3
protected int CompressionLevelField Value
DEFAULT_COMPRESSION
A possible compression level. @since 2.1.3
public const int DEFAULT_COMPRESSION = -1Field Value
InputStream
protected Stream InputStreamField Value
InputStreamLength
protected int InputStreamLengthField Value
Iref
protected PdfIndirectReference IrefField Value
NO_COMPRESSION
A possible compression level. @since 2.1.3
public const int NO_COMPRESSION = 0Field Value
StreamBytes
protected MemoryStream StreamBytesField Value
Writer
protected PdfWriter WriterField Value
rawLength
protected int rawLengthField Value
Properties
RawLength
methods overriding some methods of PdfObject
public int RawLength { get; }Property Value
Methods
FlateCompress()
Compresses the stream.
public void FlateCompress()FlateCompress(int)
methods
public void FlateCompress(int compressionLevel)Parameters
compressionLevelintthe compression level (0 = best speed, 9 = best compression, -1 is default)
SuperToPdf(PdfWriter, Stream)
protected virtual void SuperToPdf(PdfWriter writer, Stream os)Parameters
ToPdf(PdfWriter, Stream)
public override void ToPdf(PdfWriter writer, Stream os)Parameters
ToString()
@see com.lowagie.text.pdf.PdfObject#toString()
public override string ToString()Returns
WriteContent(Stream)
Writes the data content to an Stream . @throws IOException on error
public void WriteContent(Stream os)Parameters
osStreamthe destination to write to
WriteLength()
Writes the stream length to the PdfWriter . This method must be called and can only be called if the contructor {@link #PdfStream(InputStream,PdfWriter)} is used to create the stream. @throws IOException on error @see #PdfStream(InputStream,PdfWriter)
public void WriteLength()