PdfSharp.Pdf Namespace Reference

Namespaces
namespace	AcroForms
namespace	Actions
namespace	Advanced
namespace	Annotations
namespace	Content
namespace	Filters
namespace	Internal
namespace	IO
namespace	Printing
namespace	Security

Classes
class	KeyInfoAttribute
	Summary description for KeyInfo.
class	DocumentFontOptions
class	KeysBase
	Base class for all dictionary Keys classes. More...
class	KeyDescriptor
	Hold information about the value of a key in a dictionary. This information is used to create and interpret this value.
class	DictionaryMeta
	Contains meta information about all keys of a PDF dictionary.
class	PdfArray
	Represents a PDF array object. More...
class	PdfBoolean
	Represents a direct boolean value. More...
class	PdfBooleanObject
	Represents an indirect boolean value. This type is not used by PDFsharp. If it is imported from an external PDF file, the value is converted into a direct object. More...
class	PdfCustomValue
	This class is intended for empira internal use only and may change or drop in future releases. More...
class	PdfCustomValues
	This class is intended for empira internal use only and may change or drop in future releases. More...
class	PdfDate
	Represents a direct date value. More...
class	PdfDictionary
	Represents a PDF dictionary object. More...
class	PdfDocument
	Represents a PDF document. More...
class	PdfDocumentInformation
	Represents the PDF document information dictionary. More...
class	PdfDocumentOptions
	Holds information how to handle the document when it is saved as PDF stream. More...
class	PdfDocumentSettings
	Holds PDF specific information of the document. More...
class	PdfInteger
	Represents a direct integer value. More...
class	PdfIntegerObject
	Represents an indirect integer value. This type is not used by PDFsharp. If it is imported from an external PDF file, the value is converted into a direct object. More...
class	PdfItem
	The base class of all PDF objects and simple types. More...
class	PdfLiteral
	Represents text that is written 'as it is' into the PDF stream. This class can lead to invalid PDF files. E.g. strings in a literal are not encrypted when the document is saved with a password. More...
class	PdfName
	Represents a PDF name value. More...
class	PdfNameObject
	Represents an indirect name value. This type is not used by PDFsharp. If it is imported from an external PDF file, the value is converted into a direct object. Acrobat sometime uses indirect names to save space, because an indirect reference to a name may be shorter than a long name. More...
class	PdfNull
	Represents a indirect reference that is not in the cross reference table. More...
class	PdfNullObject
	Represents an indirect null value. This type is not used by PDFsharp, but at least one tool from Adobe creates PDF files with a null object. More...
class	PdfNumber
	Base class for direct number values (not yet used, maybe superfluous). More...
class	PdfNumberObject
	Base class for indirect number values (not yet used, maybe superfluous). More...
class	PdfObject
	Base class of all composite PDF objects. More...
struct	PdfObjectID
	Represents a PDF object identifier, a pair of object and generation number. More...
class	PdfOutline
	Represents an outline item in the outlines tree. An outline is also knows as a bookmark. More...
class	PdfPage
	Represents a page in a PDF document. More...
class	PdfPages
	Represents the pages of the document. More...
class	PdfReal
	Represents a direct real value. More...
class	PdfRealObject
	Represents an indirect real value. This type is not used by PDFsharp. If it is imported from an external PDF file, the value is converted into a direct object. More...
class	PdfRectangle
	Represents a PDF rectangle value, that is internally an array with 4 real values. More...
class	PdfReferenceTable
	Represents the cross reference table of a PDF document. It contains all indirect objects of a document.
class	PdfString
	Represents a direct text string value. More...
class	PdfStringObject
	Represents an indirect text string value. This type is not used by PDFsharp. If it is imported from an external PDF file, the value is converted into a direct object. More...
class	PdfUInteger
	Represents a direct unsigned integer value. More...
class	PdfUIntegerObject
	Represents an indirect integer value. This type is not used by PDFsharp. If it is imported from an external PDF file, the value is converted into a direct object. More...
class	PdfViewerPreferences
	Represents the PDF document viewer preferences dictionary. More...
class	TrimMargins
	Represents trim margins added to the page. More...

Enumerations
enum class	PdfFlateEncodeMode { Default , BestSpeed , BestCompression }
	Sets the mode for the Deflater (FlateEncoder). More...
enum class	DocumentState { Created = 0x0001 , Imported = 0x0002 , Disposed = 0x8000 }
	Identifies the state of the document More...
enum class	PdfColorMode { Undefined , Rgb , Cmyk }
	Specifies what color model is used in a PDF document. More...
enum class	PdfCustomValueCompressionMode { Default , Uncompressed , Compressed }
	This class is undocumented and may change or drop in future releases. More...
enum class	PdfFontEmbedding { Default , None , Always , Automatic }
	Specifies the embedding options of an XFont when converted into PDF. More...
enum class	PdfFontEncoding { WinAnsi = 0 , CP1252 = 0 , Unicode = 1 }
	Specifies the encoding schema used for an XFont when converted into PDF. More...
enum class	PdfOutlineStyle { Regular = 0 , Italic = 1 , Bold = 2 , BoldItalic = 3 }
	Specifies the font style for the outline (bookmark) text. More...
enum class	PdfPageLayout {   SinglePage , OneColumn , TwoColumnLeft , TwoColumnRight ,   TwoPageLeft , TwoPageRight }
	Specifies the page layout to be used by a viewer when the document is opened. More...
enum class	PdfPageMode {   UseNone , UseOutlines , UseThumbs , FullScreen ,   UseOC , UseAttachments }
	Specifies how the document should be displayed by a viewer when opened. More...
enum class	PdfReadingDirection { LeftToRight , RightToLeft }
	Specifies how the document should be displayed by a viewer when opened. More...
enum class	PdfTextStringEncoding { PDFDocEncoding = 0 , Unicode = 1 }
	Specifies how text strings are encoded. A text string is any text used outside of a page content stream, e.g. document information, outline text, annotation text etc. More...
enum class	VCF { None , Create , CreateIndirect }
	Value creation flags. Specifies whether and how a value that not exists is created. More...
enum class	PdfStringEncoding {   RawEncoding = 0x00 , StandardEncoding = 0x01 , PDFDocEncoding = 0x02 , WinAnsiEncoding = 0x03 ,   MacRomanEncoding = 0x04 , MacExpertEncoding = 0x05 , Unicode = 0x06 }
	Determines the encoding of a PdfString or PdfStringObject. More...
enum class	PdfStringFlags {   RawEncoding = 0x00 , StandardEncoding = 0x01 , PDFDocEncoding = 0x02 , WinAnsiEncoding = 0x03 ,   MacRomanEncoding = 0x04 , MacExpertEncoding = 0x05 , Unicode = 0x06 , EncodingMask = 0x0F ,   HexLiteral = 0x80 }
	Internal wrapper for PdfStringEncoding. More...

Enumeration Type Documentation

DocumentState

enum PdfSharp.Pdf.DocumentState

strong

Identifies the state of the document

Enumerator
Created	The document was created from scratch.
Imported	The document was created by opening an existing PDF file.
Disposed	The document is disposed.

PdfColorMode

enum PdfSharp.Pdf.PdfColorMode

strong

Specifies what color model is used in a PDF document.

Enumerator
Undefined	All color values are written as specified in the XColor objects they come from.
Rgb	All colors are converted to RGB.
Cmyk	All colors are converted to CMYK.

PdfCustomValueCompressionMode

enum PdfSharp.Pdf.PdfCustomValueCompressionMode

strong

This class is undocumented and may change or drop in future releases.

Enumerator
Default	Use document default to determine compression.
Uncompressed	Leave custom values uncompressed.
Compressed	Compress custom values using FlateDecode.

PdfFlateEncodeMode

enum PdfSharp.Pdf.PdfFlateEncodeMode

strong

Sets the mode for the Deflater (FlateEncoder).

Enumerator
Default	The default mode.
BestSpeed	Fast encoding, but larger PDF files.
BestCompression	Best compression, but takes more time.

PdfFontEmbedding

enum PdfSharp.Pdf.PdfFontEmbedding

strong

Specifies the embedding options of an XFont when converted into PDF.

Enumerator
Default	Unicode fonts are embedded, WinAnsi fonts are not embedded.
None	Fonts are not embedded.
Always	All fonts are embedded.
Automatic	Not yet implemented.

PdfFontEncoding

enum PdfSharp.Pdf.PdfFontEncoding

strong

Specifies the encoding schema used for an XFont when converted into PDF.

Enumerator
WinAnsi	Windows ANSI encoding.
CP1252	Alternate name for Windows ANSI encoding.
Unicode	Unicode encoding.

PdfOutlineStyle

enum PdfSharp.Pdf.PdfOutlineStyle

strong

Specifies the font style for the outline (bookmark) text.

Enumerator
Regular	Regular font.
Italic	Italic font.
Bold	Bold font.
BoldItalic	Bold and italic font.

PdfPageLayout

enum PdfSharp.Pdf.PdfPageLayout

strong

Specifies the page layout to be used by a viewer when the document is opened.

Enumerator
SinglePage	Display one page at a time.
OneColumn	Display the pages in one column.
TwoColumnLeft	Display the pages in two columns, with oddnumbered pages on the left.
TwoColumnRight	Display the pages in two columns, with oddnumbered pages on the right.
TwoPageLeft	(PDF 1.5) Display the pages two at a time, with odd-numbered pages on the left.
TwoPageRight	(PDF 1.5) Display the pages two at a time, with odd-numbered pages on the right.

PdfPageMode

enum PdfSharp.Pdf.PdfPageMode

strong

Specifies how the document should be displayed by a viewer when opened.

Enumerator
UseNone	Neither document outline nor thumbnail images visible.
UseOutlines	Document outline visible.
UseThumbs	Thumbnail images visible.
FullScreen	Full-screen mode, with no menu bar, windowcontrols, or any other window visible.
UseOC	(PDF 1.5) Optional content group panel visible.
UseAttachments	(PDF 1.6) Attachments panel visible.

PdfReadingDirection

enum PdfSharp.Pdf.PdfReadingDirection

strong

Specifies how the document should be displayed by a viewer when opened.

Enumerator
LeftToRight	Left to right.
RightToLeft	Right to left (including vertical writing systems, such as Chinese, Japanese, and Korean)

PdfStringEncoding

enum PdfSharp.Pdf.PdfStringEncoding

strong

Determines the encoding of a PdfString or PdfStringObject.

Enumerator
RawEncoding	The characters of the string are actually bytes with an unknown or context specific meaning or encoding. With this encoding the 8 high bits of each character is zero.
StandardEncoding	Not yet used by PDFsharp.
PDFDocEncoding	The characters of the string are actually bytes with PDF document encoding. With this encoding the 8 high bits of each character is zero.
WinAnsiEncoding	The characters of the string are actually bytes with Windows ANSI encoding. With this encoding the 8 high bits of each character is zero.
MacRomanEncoding	Not yet used by PDFsharp.
MacExpertEncoding	Not yet used by PDFsharp.
Unicode	The characters of the string are Unicode characters.

PdfStringFlags

enum PdfSharp.Pdf.PdfStringFlags

strong

Internal wrapper for PdfStringEncoding.

Enumerator
RawEncoding
StandardEncoding
PDFDocEncoding
WinAnsiEncoding
MacRomanEncoding
MacExpertEncoding
Unicode
EncodingMask
HexLiteral

PdfTextStringEncoding

enum PdfSharp.Pdf.PdfTextStringEncoding

strong

Specifies how text strings are encoded. A text string is any text used outside of a page content stream, e.g. document information, outline text, annotation text etc.

Enumerator
PDFDocEncoding	Specifies that hypertext uses PDF DocEncoding.
Unicode	Specifies that hypertext uses unicode encoding.

VCF

enum PdfSharp.Pdf.VCF

strong

Value creation flags. Specifies whether and how a value that not exists is created.

Enumerator
None	Don't create the value.
Create	Create the value as direct object.
CreateIndirect	Create the value as indirect object.