Meziantou.Framework.Pdf namespace

Classes

NameDescription
InvalidPdfContentExceptionThrown when a document is malformed, inconsistent or truncated beyond what the reader can recover.
PdfAnnotationAn annotation of a page (ISO 32000-2, 12.5): a link, a note, a form field widget, ...
PdfAnnotationCollectionThe annotations of a page: the /Annots array (ISO 32000-2, 12.5).
PdfCheckBoxFieldA check box (ISO 32000-2, 12.7.5.2.3): a button that is on or off.
PdfCheckBoxOptionsThe attributes of a check box created by PdfInteractiveForm.AddCheckBox.
PdfChoiceFieldA choice field (ISO 32000-2, 12.7.5.4): a list box or a combo box.
PdfChoiceFieldOptionsThe attributes of a choice field created by PdfInteractiveForm.AddComboBox or PdfInteractiveForm.AddListBox.
PdfChoiceOptionAn option of a choice field (ISO 32000-2, 12.7.5.4, /Opt).
PdfContentBuilderWrites the operators of a content stream (ISO 32000-2, 8 and 9): graphics state, paths, colors, text, images and marked content. The resources the content uses (fonts, images) are added to the resource dictionary of the page.
PdfDestinationA destination: a page and how it is shown (ISO 32000-2, 12.3.2), the target of an outline item or a link. A destination can also target a structure element (PdfDestination.WithStructureElement), as PDF/UA-2 requires.
PdfDocumentA PDF document: its pages, metadata and outline over the object model (ISO 32000-2).
PdfDocumentInformationThe document information dictionary (ISO 32000-2, 14.3.3), the /Info entry of the trailer. Setting a value creates the dictionary; setting null removes the entry.
PdfEmbeddedFileA file embedded in a document (ISO 32000-2, 7.11.4): a file specification dictionary whose embedded file stream holds the bytes of the file. The files of the document are in PdfDocument.EmbeddedFiles, the files of a page in its file attachment annotations (PdfFileAttachmentAnnotation).
PdfEmbeddedFileCollectionThe files embedded in a document: the /EmbeddedFiles name tree of the name dictionary of the catalog (ISO 32000-2, 7.7.4, 7.11.4). The files added are also associated with the document (/AF of the catalog, 14.13), as PDF/A-3 and PDF/A-4f require.
PdfEmbeddedFileOptionsThe attributes of a file embedded in a document (PdfEmbeddedFileCollection.Add, PdfAnnotationCollection.AddFileAttachment).
PdfEncryptedPayloadThe encrypted payload of an unencrypted wrapper document (ISO 32000-2, 7.6.7): an encrypted PDF document embedded in a document that is not encrypted, so that a reader without the cryptographic filter of the payload can show the pages of the wrapper (usually a page that explains how to open the payload).
PdfEncryptionThe encryption of a document: by the standard security handler (ISO 32000-2, 7.6.4), with passwords, or by the public-key security handler (7.6.5), for the certificates of recipients. Set PdfDocument.Encryption to encrypt a document when it is saved.
PdfEncryptionRecipientA recipient of a document encrypted by the public-key security handler (ISO 32000-2, 7.6.5): the certificate whose private key opens the document, and the operations it allows.
PdfExceptionThe base class of the exceptions the library throws for the content of a document.
PdfExtGStateA graphics state parameter dictionary (ISO 32000-2, 8.4.5), set with PdfContentBuilder.SetGraphicsState: the parameters that have no operator of their own, such as the transparency. The parameters that are null are not changed. A graphics state does not belong to a document; the instances are immutable.
PdfFileAttachmentAnnotationA file attachment annotation (ISO 32000-2, 12.5.6.15): an icon of a page that holds an embedded file.
PdfFontA font that PdfContentBuilder shows text with. A font does not belong to a document: each document that uses it gets its own font objects.
PdfFormA form XObject of a document (ISO 32000-2, 8.10): a content stream that can be painted several times, with PdfContentBuilder.DrawForm, or used as a transparency group or the group of a soft mask.
PdfFormFieldA field of the interactive form of a document (ISO 32000-2, 12.7.4): a node of the field hierarchy. A terminal field has a value and widgets, the annotations that show it on the pages; a non-terminal field holds other fields, whose names are qualified by its name.
PdfFormFieldOptionsThe attributes of a field created by PdfInteractiveForm and of its widgets: PdfInteractiveForm.AddSignatureField uses them as they are; the other fields derive from it.
PdfFunctionA function (ISO 32000-2, 7.10): it maps m inputs to n outputs, such as the position in a gradient to the components of its color. A function does not belong to a document: each document that uses it gets its own object. The instances are immutable.
PdfImageAn image that PdfContentBuilder.DrawImage draws: an image XObject (ISO 32000-2, 8.9.5). A JPEG file is kept as it is (DCTDecode); another image is stored as samples compressed with FlateDecode, or as JPEG data with PdfImage.FromImageAsJpeg, its alpha channel as a soft mask (11.6.5.3). An ICC profile of the image becomes an ICCBased color space. A bilevel image (PdfImage.FromBilevel) is compressed with CCITTFaxDecode, JBIG2Decode or FlateDecode.
PdfImageOccurrenceAn image painted by the content of a page (PdfPage.GetImages): an image XObject painted by Do, directly or by a form, or an inline image (ISO 32000-2, 8.9). An image XObject painted several times is an occurrence each time, with the same PdfImageOccurrence.Reference.
PdfInteractiveFormThe interactive form of a document (ISO 32000-2, 12.7): the /AcroForm dictionary of the catalog and its field hierarchy. The fields are read from the objects each time: changes made through the object model are seen.
PdfLinkAnnotationA link annotation (ISO 32000-2, 12.5.6.5): a region of a page that opens a URI or goes to a destination.
PdfMarkupAnnotationA markup annotation (ISO 32000-2, 12.5.6.2): a note, a text markup, a free text, a stamp, a shape, an ink drawing... the annotations a reviewer adds to a document. Create them with the Add* methods of PdfAnnotationCollection.
PdfOutlineCollectionThe items of a level of the document outline (ISO 32000-2, 12.3.3).
PdfOutlineItemAn item of the document outline, a bookmark (ISO 32000-2, 12.3.3).
PdfPageA page of a document (ISO 32000-2, 7.7.3.3). The members read and write the page dictionary; the inheritable entries are looked up in the page tree.
PdfPageCollectionThe pages of a document, in the order of the page tree (ISO 32000-2, 7.7.3).
PdfPageLabelThe labelling of a range of pages (ISO 32000-2, 12.4.2): a numbering style, a prefix and the number of its first page.
PdfPageLabelCollectionThe page labels of a document (ISO 32000-2, 12.4.2): the /PageLabels number tree of the catalog, whose keys are the indexes of the first pages of the ranges. The changes are written to the catalog at once.
PdfPasswordExceptionThrown when an encrypted document is opened without its user or owner password (PdfReadOptions.Password), or, for a document encrypted for certificates, without the certificate of a recipient and its private key (PdfReadOptions.Certificate).
PdfPatchA patch of a Coons or tensor-product patch mesh (ISO 32000-2, 8.7.4.5.7 and 8.7.4.5.8): four cubic Bézier curves around the patch and a color at each corner.
PdfPatternA pattern (ISO 32000-2, 8.7): a color that paints the areas it fills or strokes with a tile repeated over them (PdfTilingPattern) or a shading (PdfShadingPattern). It is set with PdfContentBuilder.SetFillPattern or PdfContentBuilder.SetStrokePattern.
PdfPatternHyphenatorHyphenates the words with the hyphenation patterns of a language, loaded by Hyphenator.
PdfPushButtonFieldA push button (ISO 32000-2, 12.7.5.2.2): a button that runs an action, without a value.
PdfRadioButtonA button of a group of radio buttons (PdfInteractiveForm.AddRadioButtons): a widget, and the option it chooses.
PdfRadioButtonFieldA group of radio buttons (ISO 32000-2, 12.7.5.2.4): one widget per option, of which one at most is on.
PdfRadioButtonOptionsThe attributes of a group of radio buttons created by PdfInteractiveForm.AddRadioButtons.
PdfReadOptionsThe options of PdfDocument.Open. The limits bound the memory and the work of hostile files.
PdfResourceLimitExceptionThrown when reading or writing a document exceeds a configured limit (PdfReadOptions).
PdfSaveOptionsThe options of PdfDocument.Save.
PdfShadingA smooth shading (ISO 32000-2, 8.7.4.5): a gradient painted with PdfContentBuilder.PaintShading or used by a PdfShadingPattern. A shading does not belong to a document: each document that uses it gets its own object. The instances are immutable.
PdfShadingPatternA shading pattern (ISO 32000-2, 8.7.4): a color that paints with a shading. It does not belong to a document; the instances are immutable.
PdfSignatureFieldA signature field (ISO 32000-2, 12.7.5.5). Its signature is read and verified with PdfSignatureVerifier.
PdfSoftMaskA soft mask (ISO 32000-2, 11.6.5.2): the alpha of the objects painted while it is set comes from a transparency group, its luminosity or its alpha. It is set with PdfExtGState.SoftMask.
PdfStructureElementAn element of the structure tree of a tagged document (ISO 32000-2, 14.7.2): a paragraph, a heading, a figure, a table... Its content is the marked content the content builder tags with it (PdfContentBuilder.BeginStructureElement), its annotations and its child elements.
PdfStructureTreeThe structure tree of a tagged document (ISO 32000-2, 14.7 and 14.8): the logical structure of its content, which assistive technologies read, and the parent tree that maps the marked content of the pages back to its elements.
PdfTableA table, drawn by PdfContentBuilder.DrawTable: columns with fixed, relative or automatic widths, rows of cells whose texts are broken into lines, borders, and header rows drawn again at the top of each page.
PdfTableCellA cell of a PdfTableRow: a text, broken into lines that fit the width of its column. The properties that are null take the value of the row, then of the table.
PdfTableColumnA column of a PdfTable: its width and the alignment of its cells.
PdfTableDrawResultThe result of PdfContentBuilder.DrawTable: pass it to the next call to continue the table.
PdfTableRowA row of a PdfTable. The properties that are null take the value of the table.
PdfTextBlockA block of the text of a page: lines that blank spaces of the page do not separate, such as a paragraph or a part of a column (see PdfTextLayout.Blocks).
PdfTextBoxOptionsThe layout of a text box (PdfContentBuilder.DrawTextBox).
PdfTextExtractionOptionsThe options of PdfPage.ExtractText and PdfPage.ExtractTextLayout.
PdfTextFieldA text field (ISO 32000-2, 12.7.5.3): a box the user types a text in.
PdfTextFieldOptionsThe attributes of a text field created by PdfInteractiveForm.AddTextField.
PdfTextGlyphA glyph of the text of a page: its text and where it is painted (see PdfPage.ExtractTextLayout).
PdfTextLayoutThe text of a page with the position of its lines, words and glyphs (see PdfPage.ExtractTextLayout).
PdfTextLineA line of the text of a page: the glyphs that follow each other on a baseline (see PdfPage.ExtractTextLayout).
PdfTextWordA word of the text of a page: glyphs of a line that no space separates (see PdfPage.ExtractTextLayout).
PdfTilingPatternA tiling pattern of a document (ISO 32000-2, 8.7.3): a cell, drawn with the builder of PdfTilingPattern.CreateContentBuilder, repeated at fixed intervals over the areas it paints.
PdfTransparencyGroupThe attributes of a transparency group (ISO 32000-2, 11.6.6): a form whose content is composited as one object.
UnsupportedPdfFeatureExceptionThrown when a document uses a valid feature the library does not support.

Structs

NameDescription
PdfColorA color in a device color space (ISO 32000-2, 8.6.4): gray, RGB or CMYK, with components from 0 to 1.
PdfGlyphA glyph shown at a position by PdfContentBuilder.ShowGlyphs.
PdfMatrixA transformation matrix [a b c d e f] (ISO 32000-2, 8.3.4): a point (x, y) becomes (a\*x + c\*y + e, b\*x + d\*y + f).
PdfMeshVertexA vertex of a triangle mesh shading (ISO 32000-2, 8.7.4.5.5): a point of the shading space and its color.
PdfPointA point of a coordinate space, such as the user space or the space of a shading.
PdfRectangleA rectangle in user space units (ISO 32000-2, 7.9.5): its lower-left and upper-right corners.
PdfSizeA size in user space units: 1/72 inch unless a page sets /UserUnit.
PdfTableColumnWidthThe width of a column of a PdfTable: fixed, relative or automatic. The default value is PdfTableColumnWidth.Auto.
PdfTextSegmentAn element of a text shown with individual glyph positioning (the TJ operator, ISO 32000-2, 9.4.3): a text, or an adjustment of the position.
PdfVersionA version of the PDF format, such as 1.7 or 2.0.

Interfaces

NameDescription
IPdfHyphenatorFinds the positions where a word can be hyphenated, for the text boxes and the tables of the content builder.

Enums

NameDescription
PdfAConformanceA conformance level of PDF/A (ISO 19005), the PDF of long-term archiving, that a document is saved with.
PdfAnnotationFlagsThe flags of an annotation (ISO 32000-2, 12.5.3, table 167). The bits the enumeration does not name are kept as they are.
PdfArtifactTypeThe kind of an artifact (ISO 32000-2, 14.8.2.2.2): content that is not part of the logical structure of the document.
PdfAssociatedFileRelationshipHow an embedded file relates to the content of the document (/AFRelationship, ISO 32000-2, 7.11.3, Table 43).
PdfBilevelCompressionThe compression of a bilevel image (PdfImage.FromBilevel). Every compression is lossless.
PdfBlendModeThe blend modes of the transparent imaging model (ISO 32000-2, 11.3.5).
PdfCheckBoxStyleThe symbol of a check box or a radio button that is on: a glyph of ZapfDingbats (the normal caption /CA of the appearance characteristics, ISO 32000-2, 12.5.6.19).
PdfDestinationKindHow a destination shows its page (ISO 32000-2, 12.3.2.2, table 149).
PdfDeviceColorSpaceThe device color spaces (ISO 32000-2, 8.6.4).
PdfEncryptionAlgorithmThe algorithm of the standard security handler that encrypts the strings and the streams of a document (ISO 32000-2, 7.6).
PdfFileAttachmentIconThe icon of a file attachment annotation (/Name, ISO 32000-2, 12.5.6.15, Table 191).
PdfFillRuleThe rule that decides which points are inside a path that is filled or clipped (ISO 32000-2, 8.5.3.3).
PdfLineCapThe shape of the ends of open subpaths that are stroked (ISO 32000-2, 8.4.3.3).
PdfLineJoinThe shape of the corners of paths that are stroked (ISO 32000-2, 8.4.3.4).
PdfPageLabelStyleThe numbering style of a page label range (ISO 32000-2, 12.4.2, table 161).
PdfPermissionsThe operations the user password of an encrypted document allows (ISO 32000-2, 7.6.4.2, table 22). The owner password allows all of them. The library does not enforce them: the applications that open a document with the user password must.
PdfStandardFontThe standard 14 fonts (ISO 32000-2, 9.6.2.2): every reader has them, so a document that uses them does not embed them.
PdfTableColumnWidthTypeHow the width of a column of a PdfTable is computed.
PdfTextAlignmentThe horizontal alignment of the lines of a text box (PdfContentBuilder.DrawTextBox).
PdfTextMarkupKindThe kind of a text markup annotation (ISO 32000-2, 12.5.6.10).
PdfTextReadingOrderThe order of the lines of the text extracted from a page (see PdfTextExtractionOptions.ReadingOrder).
PdfTextRenderingModeHow the glyphs of the text are painted (ISO 32000-2, 9.3.6).
PdfTrappedWhether a document includes trapping information (ISO 32000-2, 14.3.3 and 14.11.6): the /Trapped entry of the document information.
PdfUAConformanceA conformance level of PDF/UA (ISO 14289), the PDF of universal accessibility, that a document is saved with.