C1.Pdf.C1PdfDocumentBase

C1PdfDocumentBase Class

Abstract base class for the C1PdfDocument type. Provides low-level methods to create and save PDF documents.

Inheritance

C1PdfDocumentBase

Implements

IComponent

IDisposable

Namespace: C1.Pdf

Assembly: C1.Pdf.dll

Syntax

public abstract class C1PdfDocumentBase : Component, IComponent, IDisposable

Properties

Name	Description
Compression	Gets or sets the compression level to use when saving the document.
ConformanceLevel	Gets or sets the PDF/A conformance level. The default is none (the document does not conform to PDF/A).
CurrentPage	Gets or sets the index of the current page within the document.
DocumentInfo	Gets the PdfDocumentInfo object that contains information about this document (author, etc).
FontType	Gets or sets a value indicating how fonts should be encoded when saving the document.
ImageQuality	Gets or sets the image quality to use when saving the document.
IsCompressed	Gets a value indicating whether compression is used when saving the document.
PageRectangle	Gets a rectangle that represents the surface of the current page (in points).
PageSize	Gets or sets the default page size for the document (in points).
Pages	Gets the collection of PdfPage objects that make up the document.
PathState	Gets or sets PDF path state.
PdfVersion	Gets or sets the PDF Version of the generated document. By default the version is determined automatically based on which features are used in this document. Setting this property to a non-null string in the format "1.X" (where X is a digit from 0 to 9) overrides the automatic value with the specified one. Setting this property to null reverts to the default behavior.
SaveAllImagesAsJpeg	Gets or sets whether all images should be saved in the Jpeg format.
Security	Gets the PdfSecurity object that manages security for the current document (passwords, etc).
UniqueFontsPerPage	Gets or sets a value indicating whether to embed fonts separately for each page of the document. The default is false, which produces smaller file sizes but in some rare cases may result in incorrect font substitutions. Note that if FontType is not Embedded, this property is not used.
UseFileCaching	Gets or sets a value indicating whether to use temporary disk files to minimize memory usage. The default is false.
UseFontShaping	Gets or sets a value indicating whether to use font shaping for text characters of the document.
ViewerPreferences	Gets the PdfViewerPreferences object that contains information about how the current document should be displayed.

Methods

Name	Description
AddDictEntry(string, long)	Adds dictionary entry.
AddDictEntry(string, string)	Adds dictionary entry.
BeginDict()	Begins PDF dictionary.
BeginObj(string)	Begins PDF object.
Clear()	Restores the document to its initial state.
Dispose(bool)
EncodeAsUnicode(string)	Is encode as Unicode.
EndDict()	Ends PDF dictionary.
EndObj()	Ends PDF object.
GetCurrentID()	For internal use only. Gets the ID of the last object.
GetFontBlocks(string, bool)	Gets array (part of text, font, symbol widths of part of text).
GetNewID()	For internal use only. Increments the ID for the next object.
GetStreamPosition()	For internal use only. Gets the Position on the page stream.
IsBrushColorEmpty()	Determines whether the brush color alpha component is zero or is uninitialized.
IsCJK(string)	Is CJK (Chinese, Japanese, and Korean) of the text string.
IsIdentityMatrix(Matrix3x2)	Gets a value indicating whether matrix is the identity matrix.
IsVerticalCJK(char)	Is vertical CJK (Chinese, Japanese, and Korean) of the character.
IsVerticalCJK(string)	Is vertical CJK (Chinese, Japanese, and Korean) of the text string.
NewPage()	Starts a new page.
OnGeneratingDocument(EventArgs)	Raises the GeneratingDocument event.
OnSavingDocument(ProgressChangedEventArgs)	Raises the SavingDocument event.
ResetDashPatterns()	Resets all dash patterns to default values.
ResetResourceState()	For internal use only. Resets current font, pen, and brush state.
Save(Stream)	Saves the PDF document to a Stream.
Save(string)	Saves the PDF document to a file.
SaveAsync(Stream)	Saves the PDF document to a Stream.
SaveAsync(string)	Saves the PDF document to a file.
SetColor(Color)	For internal use only. Sets the current brush color.
SetDashPattern(DashStyle, float[])	Sets the dash pattern for a specific dash style. Values in `pattern` correspond to dashes and spaces, starting with the first dash. The actual length of each dash and space in the line is the product of the specified value and the width of the pen used to draw the line.
ToPixels(double)	Converts points to pixels.
ToPixels(RectangleF)	Converts points to pixels.
ToPixels(SizeF)	Converts points to pixels.
ToPoints(double)	Converts pixels to points.
ToPoints(RectangleF)	Converts pixels to points.
ToPoints(SizeF)	Converts pixels to points.
ToPoints(float)	Converts pixels to points.
Write(string, params object[])	Writes raw content into the PDF stream for the current page.
WriteMatrix(Matrix3x2, string)	Writes raw content into the PDF stream for the current page.
WriteStream(int, byte[])	Writes PDF object stream.
WriteStreamAsync(int, byte[])	Writes PDF object stream.

Events

Name	Description
GeneratingDocument	Fires periodically while data is written into the PDF document.
SavingDocument	Fires while pages are written to the PDF stream after a call to the Save(Stream) method.