DevExpress.Pdf Namespace

Contains classes and enumerations that are used to implement the main functionality of WinForms and WPF PDF Viewers, and the PDF Document API.

Assemblies: DevExpress.Docs.v20.2.dll, DevExpress.Pdf.v20.2.Core.dll, DevExpress.Pdf.v20.2.Drawing.dll

NuGet Packages: DevExpress.Document.Processor, DevExpress.Pdf.Core, DevExpress.Pdf.Drawing

NuGet Packages: DevExpress.Document.Processor, DevExpress.WindowsDesktop.Document.Processor, DevExpress.Pdf.Core, DevExpress.WindowsDesktop.Pdf.Core, DevExpress.Pdf.Drawing, DevExpress.WindowsDesktop.Pdf.Drawing

Classes

Name	Description
ExternalSignerInfo	Contains information about the signature contents.
PdfAcroFormBorderAppearance	Provides appearance settings used to paint the border of an interactive form field.
PdfAcroFormCheckBoxField	Represents a check box field.
PdfAcroFormChoiceField	Represents the base class for combo box and list box fields.
PdfAcroFormComboBoxField	Represents a combo box field.
PdfAcroFormCommonVisualField	Represents the base class for common field types such as text box, check box, list box, combo box, and signature.
PdfAcroFormField	Represents the base class for all interactive form fields.
PdfAcroFormFieldAppearance	Provides appearance settings used to paint an interactive form field.
PdfAcroFormGroupField	Represents a group field.
PdfAcroFormListBoxField	Represents a list box field.
PdfAcroFormRadioGroupField	Represents a radio group field.
PdfAcroFormSignatureField	Represents a signature field.
PdfAcroFormTextBoxField	Represents a text box field.
PdfAcroFormValueFormat	Allows you to specify format for form field values.
PdfAcroFormVisualField	Represents the base class for visual form fields.
PdfAction	An action that is performed with interactive elements (e.g., bookmarks, annotations) in the PDF document.
PdfAnnotation	Represents an annotation that is used for adding text notes and other ancillary information to the document.
PdfAnnotationActions	Represents actions that can be performed with the annotation in the document.
PdfAnnotationAppearance	Determines a form with the annotation appearance.
PdfAnnotationAppearances	Represents annotation appearances on the PDF form.
PdfAnnotationBorder	Represents the annotation’s border settings.
PdfAnnotationBorderStyle	Contains style settings of the annotation’s border.
PdfAnnotationData	Base class for document annotations.
PdfBookmark	Contains settings that are used to specify bookmarks in a document.
PdfButtonFormField	Represents a button field (a push button, radio button, check box) on a PDF interactive form that the end user can manipulate with the mouse.
PdfCharacter	An individual character in a document.
PdfCharacterMapping	Stores a CMap table that maps character codes to Unicode values.
PdfChoiceFormField	Represents a choice field (a combo box, list box) on a PDF form.
PdfColor	Represents a color used in the PDF document.
PdfColorSpace	Represents a PDF color space.
PdfCommand	Represents a command.
PdfCommandList	Represents a list of PdfCommand objects.
PdfCommentFilter	Contains filters that can be applied to annotations.
PdfCreationOptions	Represents document creation options.
PdfDeferredSignatureBuilder	Allows you to build a signature for a document hash.
PdfDeferredSigner	Allows you to sign the document hash.
PdfDestination	Represents a destination (a particular view of a document) to which a document target (e.g. a bookmark) is referred to.
PdfDocument	A document contained in a PDF file.
PdfDocumentActions	Represents an action that is performed with a document.
PdfDocumentArea	A document area.
PdfDocumentContent	Provides information about the PDF content type at a specific client point.
PdfDocumentPosition	Represents a point in the page coordinates of the PDF document.
PdfDocumentProcessor	A non-visual component that allows you to generate PDF files from scratch and manipulate existing documents.
PdfDocumentProcessorHelper	This class supports the internal infrastructure, and is not intended to be used directly from your code.
PdfDocumentSigner	A helper class used to apply signatures to PDF documents.
PdfEncryptionOptions	Contains settings to protect a PDF document with a password and user permissions.
PdfFileAttachment	Represents an attachment where a file can be embedded to a PDF document.
PdfFileSpecification	Represents the file specification that gives the name of the target file in a standard format, and can also contain information related to one or more specific file systems.
PdfFilter	Represents an image filter.
PdfFitBBoxDestination	Represents a destination that displays the page with its contents magnified just enough to fit its bounding box entirely within the window both horizontally and vertically.
PdfFitBBoxHorizontallyDestination	Represents a destination that displays the page with its vertical PdfFitBBoxHorizontallyDestination.Top coordinate positioned at the top edge of the window and the contents magnified just enough to fit the entire width of its bounding box within the window.
PdfFitBBoxVerticallyDestination	Represents a destination that displays the page with the horizontal PdfFitBBoxVerticallyDestination.Left coordinate positioned at the left edge of the window with its contents magnified just enough to fit the entire height of its bounding box within the window.
PdfFitDestination	Represents a destination that displays the page with its contents magnified just enough to fit the entire page within the window both horizontally and vertically.
PdfFitHorizontallyDestination	Represents a destination that displays the page with the PdfFitHorizontallyDestination.Top vertical coordinate positioned at the top edge of the window and the contents magnified just enough to fit the entire width of the page within the window.
PdfFitRectangleDestination	Represents a destination that displays the page with its contents magnified just enough to fit the PdfFitRectangleDestination.Rectangle specified by the PdfRectangle.Left, PdfRectangle.Bottom, PdfRectangle.Right, PdfRectangle.Top coordinates entirely within the window both horizontally and vertically.
PdfFitVerticallyDestination	Represents a destination that displays the page with the horizontal PdfFitVerticallyDestination.Left coordinate positioned at the left edge of the window and the contents magnified just enough to fit the entire height of the page within the window.
PdfFont	A font assigned to a document text.
PdfFontDescriptor	Provides the PDF font options.
PdfForm	Represents a PDF document form.
PdfFormData	Contains data values stored in the PDF Form.
PdfGoToAction	An action that changes the view to a specified destination (page, location, and magnification factor).
PdfGraphics	Implements drawing on a PDF page.
PdfGraphicsAcroFormBorderAppearance	Provides appearance settings used to paint the border of an interactive form field.
PdfGraphicsAcroFormCheckBoxField	Represents a check box field.
PdfGraphicsAcroFormChoiceField	Represents the base class for combo box and list box fields.
PdfGraphicsAcroFormComboBoxField	Represents a combo box field.
PdfGraphicsAcroFormCommonField	Represents the base class for common field types such as text box, check box, list box, combo box and signature.
PdfGraphicsAcroFormField	Represents the base class for all interactive form fields.
PdfGraphicsAcroFormFieldAppearance	Provides appearance settings used to paint an interactive form field.
PdfGraphicsAcroFormListBoxField	Represents a list box field.
PdfGraphicsAcroFormRadioGroupField	Represents a radio group field.
PdfGraphicsAcroFormSignatureField	Represents the signature field.
PdfGraphicsAcroFormTextBoxField	Represents a text box field.
PdfIconFit	Contains properties that define how to display the button’s icon within the annotation rectangle of its widget annotation.
PdfImage	Represents an image in the PDF document.
PdfInteractiveForm	An interactive form (AcroForm) that represents a collection of fields for gathering information interactively from the user.
PdfInteractiveFormField	Represents interactive form field data (e.g., text boxes, radio buttons, combo boxes) in a document.
PdfInteractiveFormFieldActions	Represents an action that is performed with the interactive form fields.
PdfJavaScriptAction	Represents a JavaScript action that executes a script that is written in the JavaScript programming language.
PdfJumpAction	Serves as the base for classes that allow jumping to a destination in the current document (PdfGoToAction) or a destination in another PDF file (PdfRemoteGoToAction).
PdfLineStyle	Provides the style settings used to paint the lines in a document.
PdfLinkAnnotation	Represents the link annotation (a hypertext link to a destination) in a document.
PdfMarkupAnnotation	Represents a markup annotation that is used to mark up PDF documents.
PdfMarkupAnnotationComment	Represents a comment added to an annotation.
PdfMarkupAnnotationData	Represents markup annotations.
PdfMarkupAnnotationDataExtensions static	Contains extension methods for the PdfMarkupAnnotationData class.
PdfMarkupAnnotationReview	Represents the review added to an annotation or comment.
PdfMetadata	Represents global information about the document such as the document’s title, author, and creation and modification dates.
PdfNamedAction	Represents a named action.
PdfNames	Stores names of various PDF entities.
PdfOptionalContent	Represents content in a PDF document that can be selectively viewed or hidden.
PdfOptionalContentConfiguration	Represents different presentations of a document’s optional content groups.
PdfOptionalContentGroup	Represents the optional content group that is used to control the visibility of graphic objects.
PdfOptionalContentOrder	Represents the order for presentation of optional content groups.
PdfOptionalContentProperties	Contains a list of all the optional content groups in the document, as well as information about the default and alternate configurations for optional content.
PdfOptionalContentRadioButtonGroup	Represents a collection of optional content groups whose states are intended to follow a radio button paradigm.
PdfOptionalContentUsage	Represents an optional content group’s usage that contains information describing the nature of the content controlled by the group.
PdfOptionalContentUsageApplication	Represents the optional content usage application.
PdfOptionsFormFieldOption	Represents the list of options in the choice field, each of which shall be represented by a text string that shall be displayed on the screen.
PdfOrientedRectangle	A rectangle that delimits a page area around a specific document element.
PdfOutline	Represents a document outline that allows the user to navigate interactively from one part of the document to another.
PdfOutlineItem	Represents an outline item in the tree-structured hierarchy of outlines.
PdfOutlines	Represents the root of a document’s outline hierarchy.
PdfPage	An individual page in a document.
PdfPageTreeObject	Provides settings that define page boundaries for specific content types.
PdfPageWord	An individual word related to a specific PDF page.
PdfPaperSize static	Contains the standard paper sizes.
PdfPasswordRequestedEventArgs	Provides the security password to open a protected PDF file in the PDF Viewer and PDF Document Processor.
PdfPattern	Represents a color pattern.
PdfPopupAnnotation	Represents a pop-up annotation that displays text in a pop-up window for editing the annotation text.
PdfPrinterSettings	Provides the additional printer settings to a PDF Viewer.
PdfPrintPageEventArgs	Provides data for the PdfViewer.PrintPage and PdfDocumentProcessor.PrintPage events.
PdfPrintPageRange	A range of pages to print.
PdfQuadrilateral	Represents a quadrilateral that comprises the annotation.
PdfQueryPageSettingsEventArgs	Provides data for the PdfViewer.QueryPageSettings and PdfDocumentProcessor.QueryPageSettings events.
PdfRange	Represents a range of colors.
PdfRectangle	A rectangle used to describe locations on a page and bounding boxes for various PDF objects.
PdfRemoteGoToAction	An action that jumps to a destination in another PDF file instead of the current file.
PdfRenderingSettings static	Provides PDF rendering settings to optimize JPEG image decoding.
PdfResetFormAction	An action that resets selected interactive form fields to their default values.
PdfRGBColor	Represents the red, green, and blue color components in the range of 0 to 1.
PdfSignature	An electronic signature used to sign a PDF file.
PdfSignatureBuilder	Allows you to build a signature.
PdfSignatureFieldInfo	Contains information about the signature field.
PdfSignatureInfo	Contains signature information.
PdfStringFormat	Contains settings to format strings in a document.
PdfTextAnnotation	Represents a text annotation (a “sticky note” attached to a point in a document).
PdfTextAnnotationData	Represents a text annotation.
PdfTextAnnotationIconName static	Contains names of built-in annotation icons.
PdfTextExtractionOptions	Contains text extraction options.
PdfTextFormField	Represents a text field on a PDF form.
PdfTextMarkupAnnotation	Represents a text markup annotation.
PdfTextMarkupAnnotationData	Represents a text markup annotation.
PdfTextSearchParameters	Specifies the options applied to a text search.
PdfTextSearchResults	Provides the information related to a PDF text search result.
PdfTimeStamp	Allows you to generate document-level timestamps.
PdfUriAction	Represents a URI (uniform resource identifier) action associated with the annotation.
PdfViewerAnnotationBuilderExtensions static	Defines extension methods for the IPdfViewerAnnotationBuilder interface.
PdfViewerAnnotationExtensions static	Defines extension methods for the IPdfViewerAnnotation interface.
PdfViewerExtensions static	Defines extension methods that are used to extend the functionality of the WinForms PDF Viewer and WPF PDF Viewer.
PdfViewerPreferences	Contains options that specify how to display a document on the screen.
PdfWidgetAnnotation	Represents the widget annotation for the interactive forms in a document.
PdfWidgetAppearanceCharacteristics	Contains appearance characteristics for constructing the annotation’s appearance.
PdfWord	An individual word in a document.
PdfWordSegment	Represents a word segment in a document.
PdfXFAForm	Represents an interactive form based on the Adobe XML Forms Architecture (XFA).
PdfXObject	Represents a form XObject in a PDF document content.
PdfXYZDestination	Represents a destination that displays the PDF page with the PdfXYZDestination.Left, PdfXYZDestination.Top coordinates positioned at the upper-left corner of the window and the contents of the page magnified by the factor zoom (the PdfXYZDestination.Zoom property).
Pkcs7Signer	Allows you to create PKCS#7 signatures.
Pkcs7SignerBase	A base class used to create PKCS#7 signatures.

Interfaces

Name	Description
IExternalSigner	Exposes the basic functionality to generate signatures.
IPdfViewer	For internal use. Provides the functionality of PdfViewer and PdfViewerControl classes.
IPdfViewerAnnotation	Implements options used to obtain information common for annotation types.
IPdfViewerAnnotationBuilder	Implements options used to build all annotation types.
IPdfViewerMarkupAnnotation	Implements properties used to return information about markup annotations.
IPdfViewerMarkupAnnotationBuilder	Implements properties used to build markup annotations.
IPdfViewerTextAnnotation	Contains properties used to return information about text annotations.
IPdfViewerTextAnnotationBuilder	Contains options used to build text annotations.
IPdfViewerTextMarkupAnnotation	Contains properties used to return information about text markup annotations.
IPdfViewerTextMarkupAnnotationBuilder	Implements options used to build text markup annotations.

Structs

Name	Description
PdfAcroFormFieldNameCollision	Represents a structure which stores information about a collision found in interactive form field names.
PdfPoint	Specifies the coordinates of a PDF point.
PdfSaveOptions	A class that provides document encryption options and document signature to save the document.

Delegates

Name	Description
PdfPasswordRequestedEventHandler	This event handler is used to programmatically provide a document opening password in a PDF Viewer and PDF Document Processor to open a document without end-user interaction.
PdfPrintPageEventHandler	A method that will handle the PdfViewer.PrintPage and PdfDocumentProcessor.PrintPage events.
PdfQueryPageSettingsEventHandler	A method that will handle the PdfDocumentProcessor.QueryPageSettings and PdfViewer.QueryPageSettings events.

Enums

Name	Description
PdfAcroFormBorderStyle	Specifies the border style for an interactive form field.
PdfAcroFormButtonStyle	Lists values specifying the appearance of the form field’s button.
PdfAcroFormCurrencyStyle	Lists values used to specify currency style.
PdfAcroFormFieldRotation	Specifies the rotation to apply to a form field.
PdfAcroFormNegativeNumberStyle	Lists values used to specify negative number format.
PdfAcroFormNumberSeparatorStyle	Lists values used to specify the separator format.
PdfAcroFormSpecialFormatType	Lists values used to specify special value format types.
PdfAcroFormStringAlignment	Specifies the alignment of a text string within an interactive form field.
PdfAcroFormTextFieldType	Specifies the type of text field.
PdfAnnotationFlags	Lists the values specifying various characteristics of the annotation.
PdfAnnotationHighlightingMode	Lists values that specify the visual effect that will be used when the mouse button is pressed or held down inside its active area.
PdfAnnotationReviewStatus	Lists values used to specify the annotation’s review status.
PdfAnnotationType	Lists values used to indicate the annotation type.
PdfAssociatedFileRelationship	Lists the values used to specify the type of relationship between the document and the attached file.
PdfCertificationLevel	Lists values used to specify permissions granted by a signature.
PdfCommentSortMode	Lists values used to specify the annotation’s sort mode in the Comments pane.
PdfCompatibility	Lists the values specifying the compatibility mode of a document.
PdfContentHorizontalAlignment	Lists values used to specify the horizontal alignment of the PDF page content.
PdfContentVerticalAlignment	Lists values used to specify the vertical alignment of the PDF page content.
PdfDirection	Lists values that specify the content direction in the PDF document.
PdfDocumentContentType	Lists the values indicating the type of the PDF content corresponding to a specific document point.
PdfDocumentDataExtractionPermissions	Lists the values specifying permissions that are used to restrict or allow access to data extraction operations.
PdfDocumentInteractivityPermissions	Lists the values specifying permissions that are used to restrict or allow access to document interaction operations.
PdfDocumentModificationPermissions	Lists the values specifying permissions that are used to restrict or allow access to document modification operations.
PdfDocumentPrintingPermissions	Lists the values specifying permissions that are used to restrict or allow access to document printing operations.
PdfEncryptionAlgorithm	Lists the available algorithms to encrypt a document.
PdfFilterAnnotationType	Lists values that indicate the annotation type used in the filter.
PdfFontFlags	Lists the values that correspond to flags defining various characteristics of the font.
PdfFontStretch	Lists the font stretch values.
PdfFontStyle	Lists the form field’s font styles.
PdfFormDataFormat	Lists formats allowed for PDF Form data values.
PdfGraphicsJpegImageQuality	Specifies how images are exported to PDF format.
PdfGraphicsTextOrigin	Contains values that specify how to interpret a point passed to one of the PdfGraphics.DrawString overload methods that take a PointF object as an argument.
PdfHotkeyPrefix	Specifies the type of display for hot-key prefixes that relate to text.
PdfIconScalingCircumstances	Lists the circumstances under which the icon will be scaled inside the annotation rectangle.
PdfIconScalingType	Lists the type of icon scaling within the annotation rectangle.
PdfInteractiveFormFieldFlags	Represents flags specifying various document-level characteristics related to interactive form fields.
PdfMarkupAnnotationReplyType	List values that specify the relationship (the “reply type”) between one annotation and another.
PdfNonFullScreenPageMode	Lists values that specify how the document page is displayed in windowed mode.
PdfOptionalContentIntent	Lists names that are used to determine which optional content group states to consider and which to ignore in calculating the visibility of content.
PdfOptionalContentOrderListMode	Lists values that specify which optional content groups in the PdfOptionalContentConfiguration.Order property will be displayed to the user.
PdfOptionalContentState	Lists the states of all the optional content groups in a document when the optional content configuration is applied.
PdfPageLayout	Lists the values that define how the page is positioned in the PDF Viewer.
PdfPageMode	Lists values that specify how to display the opened document.
PdfPrintMode	Lists values that specify the document print mode.
PdfPrintPageOrientation	Lists the available document orientation modes.
PdfPrintScaleMode	Lists the available document scale modes.
PdfPrintScaling	Lists values that specify the scaling mode for printed documents.
PdfRenderingEngine	Lists values used to specify the rendering engine.
PdfRenderingIntent	Lists rendering intents that determine how a color management system handles color conversion from one color space to another.
PdfSignatureFlags	Lists values that specify various document-level characteristics related to signature fields.
PdfSignatureProfile	Lists values used to specify the signature profile type.
PdfSignatureType	Lists values used to specify the signature type.
PdfStringAlignment	Specifies the alignment of a text string relative to its layout rectangle.
PdfStringFormatFlags	Specifies the display and layout information for text strings.
PdfStringTrimming	Specifies how to trim characters from a string that does not completely fit into a layout shape.
PdfTextJustification	Lists the form of justification that is used in laying out the overlay text.
PdfTextMarkupAnnotationType	Specifies the type of a text markup annotation.
PdfTextSearchDirection	Lists the available text search direction modes.
PdfTextSearchStatus	Lists the values specifying the status of a PDF text search operation.
PdfViewArea	Lists values that specify the document area.
PdfWidgetAnnotationTextPosition	Lists values that specify the text position of the widget annotation’s caption relative to its icon.