[]
DEMOS DOCS API PRICING
FREE TRIAL
(Showing Draft Content)

GrapeCity.Documents.Pdf.Writer.PdfStreamWriterBase

PdfStreamWriterBase Class

Base class for PDF writers: GrapeCity.Documents.Pdf.Writer.PdfContentStreamWriter, PdfDocStreamWriter.

Inheritance
object
PdfStreamWriterBase
PdfDocStreamWriter
Namespace: GrapeCity.Documents.Pdf.Writer
Assembly: DS.Documents.Pdf.dll
Syntax
public abstract class PdfStreamWriterBase
Public MustInherit Class PdfStreamWriterBase

Fields

Name Description
Doc

The GcPdfDocument object content of which is written.

Properties

Name Description
CurrentObjID

Gets a PdfObjID structure defining ID of PDF object currently written to the stream, used to encrypt strings. By default returns Empty.
Stream

Gets or sets the underlying stream.

Methods

Name Description
AddDictEntries(IPdfDict, params PdfName[])

Adds dictionary entries, skips entries with name in propsToSkip.
AddDictEntries(IPdfDict, Func<PdfName, IPdfObject, bool>)

Adds dictionary entries from specified collection, PDF dictionary should be started.
AddDictEntriesSkipLength(IPdfDict, Func<PdfName, IPdfObject, bool>)

Adds dictionary entries except for "Length" entry.
AddDictEntriesSkipStreamProps(IPdfDict, Func<PdfName, IPdfObject, bool>)

Adds dictionary entries except for "Length", "Filter" and "DecodeParms" entries.
AddDictEntry(PdfName, Offsets)

Adds a dictionary entry with Offsets value.
AddDictEntry(PdfName, PdfDateTime)

Adds a dictionary entry with PdfDateTime value.
AddDictEntry(PdfName, IPdfObject)

Adds a dictionary entry with value representing GrapeCity.Documents.Pdf.Spec.IPdfObject, see Write(IPdfObject).
AddDictEntry(PdfName, bool)

Adds a dictionary entry with PDF bool value.
AddDictEntry(PdfName, bool, bool)

Adds a dictionary entry with bool value.
AddDictEntry(PdfName, IList<PointF>, Func<PointF, PointF>)

Adds a dictionary entry with array of points. convertMethod is called for each item in value.
AddDictEntry(PdfName, IList<int>, IList<int>)

Adds a dictionary entry with integer array value.
AddDictEntry(PdfName, IList<float>, IList<float>)

Adds a dictionary entry with float array value.
AddDictEntry(PdfName, double)

Adds a dictionary entry with double value.
AddDictEntry(PdfName, Color)

Adds a dictionary entry with Color value.
AddDictEntry(PdfName, RectangleF)

Adds a dictionary entry with RectangleF value.
AddDictEntry(PdfName, int)

Adds a dictionary entry with integer value.
AddDictEntry(PdfName, int, int)

Adds a dictionary entry with integer value.
AddDictEntry(PdfName, long)

Adds a dictionary entry with integer value.
AddDictEntry(PdfName, Offsets?)

Adds a dictionary entry with nullable Offsets value.
AddDictEntry(PdfName, PdfDateTime?)

Adds a dictionary entry with nullable PdfDateTime value.
AddDictEntry(PdfName, bool?)

Adds a dictionary entry with nullable bool value.
AddDictEntry(PdfName, RectangleF?)

Adds a dictionary entry with nullable RectangleF value.
AddDictEntry(PdfName, RectangleF?, RectangleF)

Adds a dictionary entry with nullable RectangleF value.
AddDictEntry(PdfName, int?)

Adds a dictionary entry with nullable integer value.
AddDictEntry(PdfName, float?)

Adds a dictionary entry with nullable float value.
AddDictEntry(PdfName, float?, float)

Adds a dictionary entry with nullable float value.
AddDictEntry(PdfName, Matrix3x2)

Adds a dictionary entry with Matrix3x2 value.
AddDictEntry(PdfName, float)

Adds a dictionary entry with float value.
AddDictEntry(PdfName, float[], float)

Adds a dictionary entry with line style value.
AddDictEntryArray(PdfName, params IPdfObject[])

Adds a dictionary entry with PDF array value, does nothing if value is null, writes empty PDF array if value has no items.
AddDictEntryHexString(PdfName, IList<byte>)

Adds a dictionary entry with PDF string value written as HEX string: <F1A0>
AddDictEntryName(PdfName, string)

Adds a dictionary entry with PDF name value, the entry is added only if value is not null and not empty.
AddDictEntryNameArray(PdfName, params string[])

Adds a dictionary entry with PDF name array.
AddDictEntryNames(PdfName, string[], string[])

Adds a dictionary entry with PDF name array.
AddDictEntryObjRef(PdfName, PdfObjID)

Adds a dictionary entry with PDF reference.
AddDictEntryObjRef(PdfName, int)

Adds a dictionary entry with PDF reference.
AddDictEntryPlaceHolder(PdfName, int, out long)

Adds a dictionary entry with "placeholder" (spaces) the actual value should be written later, used when generating linearized PDF stream.
AddDictEntryRichString(PdfName, string)

Adds a dictionary entry with PDF rich string value, see PDF specification for details about Rich text in PDF.
AddDictEntryString(PdfName, IList<byte>)

Adds string dict entry, string is written as PDF string i.e. like (BlaBla). If string contains chars with code greater than 126 it encoded as unicode. String is encoded if encoding specified for document.
AddDictEntryString(PdfName, IList<byte>, bool)

Adds a dictionary entry with PDF string value. If string contains chars with code greater than 126 it encoded as unicode. The string is encrypted if an encryption specified for document.
AddDictEntryString(PdfName, string)

Adds a dictionary entry with PDF string value. If string contains chars with code greater than 126 it encoded as unicode. The string is encrypted if an encryption specified for document.
AddDictEntryStringNotEmpty(PdfName, string)

Adds a dictionary entry with PDF string value. If string contains chars with code greater than 126 it encoded as unicode. The string is encrypted if an encryption specified for document.
AddDictEntry<TEnum>(PdfName, PdfEnum<TEnum>)

Adds a dictionary entry with PdfEnum<TEnum> value.
AddDictEntry<TEnum>(PdfName, PdfEnum<TEnum>?)

Adds a dictionary entry with nullable PdfEnum<TEnum> value.
AddDictEntry<T>(PdfName, T?, T)

Adds a dictionary entry with PDF name value, the PDF name obtained as value.ToString().
BeginArray()

Starts a PDF array, should be enclosed with EndArray().
BeginArrayEntry(PdfName)

Starts a PDF dictionary entry with array value, should be enclosed with EndArrayEntry().
BeginDict()

Starts a PDF dictionary, should be enclosed with EndDict().
BeginDictEntry(PdfName)

Starts a PDF dictionary entry with nested dictionary value, should be enclosed with EndDictEntry().
BeginEntry(PdfName)

Starts a PDF dictionary entry, should be enclosed with EndEntry().
EndArray()

Ends a PDF array started with BeginArray().
EndArrayEntry()

Ends a PDF dictionary entry started with BeginArrayEntry(PdfName).
EndDict()

Ends a PDF dictionary started with BeginDict().
EndDictEntry()

Ends a PDF dictionary entry started with BeginDictEntry(PdfName).
EndEntry()

Ends a PDF dictionary entry started with BeginEntry(PdfName).
Flush()

Flushes all data to the underlying stream.
FmtDouble(double)

Converts specified float to string which can be written to PDF stream.
FmtDouble(float)

Converts specified float to string which can be written to PDF stream.
FmtInteger(int)

Converts specified integer to string which can be written to PDF stream.
FmtLong(long)

Converts specified long to string which can be written to PDF stream.
FmtUint(uint)

Converts specified uint to string which can be written to PDF stream.
GetPosition()

For internal use only. Gets the Position on the underlying stream.
Seek(long, SeekOrigin)

Sets the position within the underlying stream.
Write(IPdfObject)

Writes the GrapeCity.Documents.Pdf.Spec.IPdfObject object if value is indirect object then reference to this object will be written otherwise Write(PdfStreamWriterBase) will be called to write value representing an object. If value is null or GrapeCity.Documents.Pdf.Spec.IPdfObject.Empty is true then PDF NULL value will be written.
Write(byte[])

Writes a byte array.
Write(PointF)

Writes a PointF structure as 2 float values.
Write(Stream)

Writes content of specified stream.
Write(Matrix3x2)

Writes a Matrix3x2 structure.
Write(string)

Writes a string using ASCII encoding, each char converted to byte as (byte)s[i].
Write(string, int)

Writes a string using ASCII encoding, each char converted to byte as (byte)s[i]. If string length is less than length the spaces will be added at right, if string length is greater than length the string will be truncated.
WriteBool(bool)

Writes a bool value.
WriteByte(byte)

Writes a single byte.
WriteBytes(byte, int)

Writes specified count of bytes to the stream.
WriteCRLF()

Writes the CRLF, resets GrapeCity.Documents.Pdf.Writer.PdfStreamWriterBase.NeedDelimiter.
WriteColor(Color)

Writes a Color value as sequence of 3 numbers R, G, B. NOTE! alpha channel is NOT written.
WriteDelim()

Writes the (space) if GrapeCity.Documents.Pdf.Writer.PdfStreamWriterBase.NeedDelimiter is true, resets GrapeCity.Documents.Pdf.Writer.PdfStreamWriterBase.NeedDelimiter.
WriteDouble(double, int)

Writes a double value.
WriteFloat(float?, int)

Writes a nullable float value.
WriteFloat(float, int)

Writes a float value.
WriteFloatArray(float[], int)

Writes a float array, writes a null if value is null.
WriteHexString(IList<byte>, bool)

Writes a string as PDF HEX string, like <FF01>. Note! String is encrypted if encrypt is true and encryption is specified for the document. Note! If value is null or empty then empty '()' PDF string is written.
WriteInt(int)

Writes an integer value.
WriteIntValue(int)

Writes an integer value.
WriteLine(string)

Writes a string and adds CRLF after, each char of the string converted to a byte.
WriteLong(long)

Writes a long value.
WriteLongValue(long)

Writes a long value.
WriteName(PdfName)

Writes a PDF name value, like "/name".
WriteName(IList<byte>)

Writes a byte array as PDF name value, i.e. like "/name".
WriteName(string)

Writes a string as PDF name value, like "/name".
WriteNull()

Writes a NULL value.
WriteOffsets(Offsets)

Writes an Offsets structure as 4 float values.
WritePdfDateTime(PdfDateTime)

Writes a PdfDateTime value, the value is encoded as it defined in chapter 3.8.3 Dates of PdfSpec 1.7.
WritePlaceHolder(int, out long)

Writes a placeholder to the PDF stream and returns its offset.
WriteRect(RectangleF)

Writes a RectangleF structure as 4 float values Left, Top, Width, Height.
WriteRectLTRB(RectangleF)

Writes a RectangleF structure as 4 float values Left, Top, Right, Bottom.
WriteRef(PdfObjID)

Writes a PDF reference like "10 0 R".
WriteRef(int)

Writes a PDF reference like "10 0 R".
WriteString(IList<byte>, bool)

Writes a byte array as PDF string, like "(BlaBla)". Note! String is encrypted if encrypt is true and encryption is specified for the document. Note! If value is null or empty then empty "()" PDF string is written.
WriteString(string, bool)

Writes a string as PDF string, like "(BlaBla)". Note! String is encrypted if encrypt is true and encryption is specified for the document. Note! If value is null or empty then empty "()" PDF string is written.
WriteUint(uint)

Writes an uint value.