DevExpress.Docs.Pdf Namespace

Contains members for working with PDF documents.

Assemblies: DevExpress.Docs.Core.v26.1.dll, DevExpress.Docs.Pdf.v26.1.dll

NuGet Packages: DevExpress.Docs.Core, DevExpress.Docs.Pdf

Classes

Name	Description
AnnotationAppearance	An annotation’s appearance.
AnnotationAppearances	Contains annotation appearance properties for different states in a PDF form.
AnnotationBorder	An annotation’s border settings.
AnnotationBorderEffect	Contains properties that specify the annotation border effect and its intensity.
AnnotationBorderStyle	Contains style settings of the annotation’s border.
AnnotationCallout	A callout annotation object.
AnnotationCollection	A collection of annotations.
Attachment	A file attached to a PDF document.
AttachmentCollection	A collection of attachments in a PDF document.
AxialShadingFill	An axial (linear) shading fill that defines a color gradient along a line between two points.
BaseAnnotation	A base class for annotations.
BezierGraphicsPathSegment	A cubic Bezier curve segment of a graphics path.
ButtonField	A button form field in a PDF form.
ButtonIconFit	Contains settings that specify how to fit an icon in a button.
ButtonWidgetAnnotation	A button widget annotation in a PDF document.
CalGrayColorSpace	A CIE-based calibrated single-component (gray) color space.
CalRGBColorSpace	A CIE-based calibrated three-component (RGB) color space.
CaretAnnotation	A caret annotation.
CheckBoxField	A checkbox form field that allows users to select or clear an option in a PDF document.
CheckBoxWidgetAnnotation	Contains properties that customize the checkbox field’s widget annotation.
ChoiceField	Base class for choice fields - combo box and list box.
ChoiceFieldItem	An item in a choice field.
CIEColor	A CIE-based color defined by X, Y, and Z tristimulus values.
CircleAnnotation	A round annotation in PDF files.
ClipNode	A clipping node that defines a clipping region.
ClipRegion	A clipping region.
ColorSpace	The base class for PDF color spaces.
ColorSpaceGamma	Stores gamma values for a CalRGB color space.
ColorSpaceMatrix	A 3x3 matrix used to transform color values in a CalRGB color space.
ComboBoxField	A combo box form field that allows users to select an option from a drop-down list in a PDF document.
ComboBoxWidgetAnnotation	Contains properties that customize the combo box field’s widget annotation.
CoonsPatchMeshShadingFill	A Coons patch mesh shading fill defined by cubic Bezier curves.
CoonsShadingPatch	Defines a Coons patch composed of four Bezier curves for mesh shading.
CustomAnnotation	A custom annotation in PDF files.
CustomFunction	The base class for PDF functions used in color space transformations.
DashPattern	A dash pattern that defines the appearance of dashed lines in a PDF document.
Destination	References a page with specific view parameters.
DeviceCMYKColorSpace	A device-dependent CMYK color space.
DeviceColorSpace	The base class for device-dependent color spaces.
DeviceGrayColorSpace	A device-dependent grayscale color space.
DeviceNColorSpace	A DeviceN color space that defines multiple custom colorants.
DeviceRGBColorSpace	A device-dependent RGB color space.
DocumentCloneContext	Contains information about the cloning process.
DocumentExportOptions	Contains options used to specify PDF document properties.
DocumentInfo	Contains basic PDF metadata, such as the title, author, subject, and keywords.
DocumentMetadata	Contains PDF metadata information.
EncryptionOptions	Contains members used to specify encryption options of a PDF file.
ExponentialInterpolationFunction	An exponential interpolation function (PDF Type 2 function).
FileAttachmentAnnotation	Contains members that manage file attachment annotations.
FileSpecification	The file specification that includes the target file name in a standard format and information for specific file systems.
Fill	The base class for PDF fill objects.
FitBBoxDestination	A destination that fits a page’s bounding box within the document window.
FitBBoxHorizontallyDestination	A destination that fits a page’s bounding box to the width of the document window.
FitBBoxVerticallyDestination	A destination that positions a specified X-coordinate at the top-left corner of a document window and zooms that page’s bounding box to fit window height.
FitDestination	A destination that fits a page within the document window.
FitHorizontallyDestination	A destination that positions a specific Y coordinate at the top left corner of the document window, and zooms a page so that it fits the window horizontally.
FitRectangleDestination	A destination that displays a specific page rectangle in the document window.
FitVerticallyDestination	A destination that fits the page vertically in the window and displays the leftmost portion of the page at the left edge of the window.
FormField	A base class for all form fields in a PDF document.
FormFieldActions	Actions that are executed when a user interacts with a form field.
FormFieldCollection	A collection of form fields contained in a PDF document.
FormFieldValueFormat	Allows you to specify format for form field values.
FormFragment	A form fragment in a PDF document.
FormTemplate	A form template that defines the layout and content of a PDF form.
FormTransparencyGroup	A transparency group that specifies the transparency settings of a form XObject.
FragmentCollection	A collection of content fragments.
FreeFormGouraudMeshShadingFill	A free-form Gouraud-shaded triangle mesh fill.
FreeTextAnnotation	Contains members that manage free text annotations.
FunctionBasedShadingFill	A function-based shading fill that defines colors as a function of two-dimensional coordinates.
GoToAction	An action that jumps to a destination in the current PDF document.
GouraudMeshShadingFill	The base class for Gouraud-shaded triangle mesh fills.
GradientShadingFill	The base class for gradient shading fills (axial and radial).
GraphicsPath	A sequence of connected lines and curves that can be filled or outlined.
GraphicsPathSegment	A segment of a graphics path.
GroupField	A form field that organizes other form fields into groups in a PDF document.
ICCBasedColorSpace	A color space based on an ICC color profile.
ImageExportOptions	Contains options used to export PDF pages to images.
ImageFragment	An image fragment on a PDF page.
IndexedColorSpace	A color space that maps index values to colors in a lookup table.
InkAnnotation	Contains members that manage ink annotations.
InteractiveAction	A base class for annotation actions.
JavaScriptAction	A JavaScript action that runs a script written in JavaScript.
LabColorSpace	A CIE-based Lab* color space.
LatticeFormGouraudMeshShadingFill	A lattice-form Gouraud-shaded triangle mesh fill.
LayoutAttribute	An attribute that defines the layout of structure elements in a PDF document.
LineAnnotation	Contains members that manage line annotations.
LineGraphicsPathSegment	A line segment in a graphics path.
LineStyle	Lists style settings that paint the lines in a document.
LinkAnnotation	Contains settings for a link annotation.
ListAttribute	An attribute that defines the list element in a PDF document.
ListBoxField	A list box form field in a PDF document.
ListBoxWidgetAnnotation	Contains properties used to customize the list box field’s widget annotation.
LoadOptions	Contains options used to load PDF documents.
MarkedContentGroup	A marked content group on a PDF page.
MarkInfo	Contains information about Tagged PDF conventions.
MarkupAnnotation	A markup annotation.
NamedAction	A named action.
NChannelColorSpace	An NChannel color space (an extension of DeviceN with additional colorant attributes).
NumberFormat	Contains properties that specify the number format for a text element.
ObjectCollectionBase<T>	The base class for collections of PDF objects.
Outline	Defines stroke settings for PDF graphics paths.
Page	A page in a PDF document.
PageCollection	A collection of pages in a PDF document.
PageFragment	A base class for content fragments in a PDF document.
ParagraphFragment	A paragraph fragment - a segment of text with the same formatting.
PathAnnotation	A path annotation.
PathClipNode	A node that defines a clipping path in a PDF document.
PathFragment	A path fragment in a PDF document.
PatternColorSpace	A pattern color space used for tiling and shading patterns.
PatternFill	A fill that paints an area with a repeating tiling pattern.
PatternTemplate	Defines a tiling pattern template for pattern fills.
Pdf17StructureTypeDescriptor	The descriptor for PDF 1.7 structure types.
Pdf20StructureTypeDescriptor	The descriptor for PDF 2.0 structure types.
PdfColor	A color defined as an array of component values in a specific color space.
PdfDocument	The main class of the DevExpress PDF Document API library. Contains the document model and key PDF processing APIs.
PdfNamespace	A structure tree namespace is an identifier that defines the vocabulary and semantic meaning of structure element types.
PdfNamespaceRoleMapEntry	Represents a namespace role map entry that maps a structure type to a standard type.
PolygonAnnotation	A polygon annotation.
PolylineAnnotation	A polyline annotation.
PopupAnnotation	A popup annotation.
PostScriptCalculatorFunction	A PostScript calculator function (PDF Type 4 function).
PrinterMarkAnnotation	A printer’s mark annotation.
PrintFieldAttribute	Attributes of a print field in a PDF document.
PrintPageRange	A range of pages that should be printed.
Quadrilateral	A quadrilateral shape defined by four points in a two-dimensional space.
RadialShadingFill	A radial shading fill that defines a color gradient between two circles.
RadioGroupField	A radio group field is a form field that contains a set of options, only one of which can be selected.
RadioGroupItemWidgetAnnotation	Contains properties that customize the radio button field’s widget annotation.
Range	Defines a numeric range with minimum and maximum values.
RectilinearMeasure	Measurement settings for the path annotation.
RedactionAnnotation	A redaction annotation.
RedactionGeometry	The geometry of redaction areas in a PDF document.
RemoteGoToAction	An action that jumps to a destination in another PDF file instead of the current file.
ResetFormAction	An action that resets selected interactive form fields to their default values.
ReviewHistoryItem	An annotation’s review item.
RubberStampAnnotation	A rubber stump annotation.
SampledFunction	A sampled function (PDF Type 0 function) that uses a table of sample values.
SaveOptions	Contains members used to specify save options of an exported PDF file.
SeparationColorSpace	A separation color space that defines a single custom colorant.
ShadingBezierCurve	Defines a cubic Bezier curve with two vertices and two control points for patch mesh shading.
ShadingFill	The base class for shading-based fills that define smooth color transitions.
ShadingTriangle	Defines a triangle for Gouraud-shaded mesh fills.
ShadingVertex	Defines a vertex with a position and color for mesh shading.
ShapeAnnotation	A base class for shape annotations.
SignatureField	A signature field is a form field that allows users to sign PDF documents electronically.
SignatureOptions	Contains members used to specify signature information for an exported PDF file.
SignatureWidgetAnnotation	Contains properties that customize the signature field’s widget annotation.
SolidFill	A fill that paints an area with a single uniform color.
Sound	A sound object attached to the sound annotation.
SoundAnnotation	An annotation that contains a sound recorded or imported form a file.
SquareAnnotation	A square annotation.
StitchingFunction	A stitching function (PDF Type 3 function) that combines multiple subfunctions.
StructureContentItem	A structure content item.
StructureElement	An element in a structure tree of a PDF document.
StructureElementAttribute	An attribute of a structure element.
StructureElementAttributeCollection	A collection of attributes of a structure element.
StructureElementCollection	A collection of elements in a structure tree.
StructureElementType	The type of a structure element in a PDF document.
StructureItem	The base class for all structure elements in a PDF document.
StructureMarkedContentGroup	A structure marked content group.
StructureMarkedContentReference	A reference to a structure element that is associated with a marked content sequence.
StructureTree	The structure tree of a PDF document.
StructureTypeDescriptor	The base class for structure type descriptors in a PDF document.
TableAttribute	A attribute that defines the table elements in a PDF document.
TensorProductPatchMeshShadingFill	A tensor-product patch mesh shading fill.
TensorProductShadingPatch	Defines a tensor-product patch with control points and corner colors for mesh shading.
TextAnnotation	A text annotation (a “sticky note” attached to a point in a document).
TextAppearance	Contains text appearance settings.
TextBoxField	A text box form field that allows users to enter text in a PDF document.
TextBoxWidgetAnnotation	Contains properties that customize the text box field’s widget annotation.
TextClipNode	A node that defines a clipping path based on text in a PDF document.
TextFont	A font used to draw content in a PDF document.
TextFragment	A text fragment on a PDF page.
TextMarkupAnnotation	A text markup annotation.
TextMatchFragment	A text fragment that matches a search pattern.
TextMatchGroup	A group of text matches found in a PDF document.
TextMatchGroupItem	An item in the text match group.
TextMatchInfo	A text match found in the PDF document.
TextSearchInfo	Contains information about text search results in a PDF document.
TextSearchOptions	Defines options for searching text in a PDF document.
TrapNetAnnotation	A Trap Network annotation.
UnclosedPathAnnotation	A base class for unclosed path annotations.
UriAction	The URI (Uniform Resource Identifier) action associated with the annotation.
ViewerPreferences	Contains options that specify how to display a PDF file on the screen.
VisualFragment	The base class for visual fragments in a PDF document.
WatermarkAnnotation	A watermark annotation.
WidgetAnnotation	A base class that contains widget annotation properties.
WidgetAnnotationActions	Contains settings used to define actions that are associated with a widget annotation.
WinFileSpecification	Contains Windows-specific parameters for a Launch action.
XmpArray<T>	An XMP metadata node with an array value.
XmpBasicSchema	Contains properties used to define the XMP basic namespace.
XmpBool	An XMP metadata node with a boolean value.
XmpCustomSchema	Contains properties used to define the XMP custom namespace.
XmpDate	An XMP metadata node with a date value.
XmpDateArray	An XMP metadata node with a date array value.
XmpDublinCoreSchema	Contains properties used to define the XMP Dublin Core namespace.
XmpInteger	An XMP metadata node with an integer value.
XmpLangAlt	An alternative XMP array of simple text items with xml:lang qualifiers.
XmpMetadata	Contains PDF document XMP metadata.
XmpPdfAExtensionDescriptor	An XMP PDF/A extension descriptor.
XmpPdfAExtensionField	A PDF/A extension schema field - the schema used to define the individual fields inside a structured XmpPdfAExtensionValueType field.
XmpPdfAExtensionProperty	A PDF/A extension property.
XmpPdfAExtensions	Contains PDF/A-specific metadata properties.
XmpPdfAExtensionValueType	Specifies value types defined in the PDF/A extension schema.
XmpPdfASchema	Contains properties used to define the XMP PDF/A namespace.
XmpPdfSchema	Contains properties used to define the XMP PDF namespace.
XmpPdfUASchema	Contains properties used to define the XMP PDF/UA namespace.
XmpQualifier	An XMP qualifier - a property that provides additional information about another property in an XMP metadata structure.
XmpQualifierCollection	A collection of XMP qualifiers.
XmpRawAccess	The XMP metadata’s raw XML nodes.
XmpRightsManagementSchema	Contains properties used to define the XMP rights management namespace.
XmpString	An XMP metadata node with a string value.
XmpStringArray	An XMP metadata node with a string array value.
XmpValue	A base class for XMP metadata nodes.
XyzDestination	A destination that displays a page with the specified coordinates at the upper-left corner of the window.

Structs

Name	Description
LayoutMetrics	The layout metrics of a measured text fragment.
OrientedRectangle	A rectangle that delimits a page area around a specific document element.
RubberStampAnnotationIconName	Contains names of built-in rubber stamp annotation icons.
XmpProperty	A property of an XMP metadata object.

Enums

Name	Description
AnnotationBorderEffectStyle	Lists values that specify the effect applied to the annotation border.
AnnotationHighlightingMode	Lists values that specify the visual effect applied when the mouse button is pressed or held down inside the annotation’s active area.
AnnotationLineEndingStyle	Lists values used to specify the style of the annotation’s end points.
AnnotationPdf3DActivationCircumstances	Lists values that define activation circumstances for 3D annotations.
AssociatedFileRelationship	Lists values that indicate the relationship type between document and attachment files.
BorderStyle	Lists values that indicate the border style of a PDF document element.
ButtonCaptionLayout	Lists values that indicate the layout of a button caption.
ButtonIconScalingCircumstances	Lists values that specify circumstances under which button icons are scaled.
ButtonIconScalingType	Lists values that specify how to scale a button icon.
ColorSpaceType	Lists values that indicate color space types available in a PDF document.
DocumentAccessMode	Lists values that specify the access level for a PDF document.
DocumentDataExtractionPermissions	Lists values that indicate permission levels of data extraction operations.
DocumentInteractivityPermissions	Lists values that indicate permission levels of data interaction operations.
DocumentModificationPermissions	Lists values that indicate permission levels of document modification operations.
DocumentPrintPermissions	Lists values that indicate the permission levels of print operations.
EncryptionAlgorithm	Lists values that indicate the encryption algorithm.
ExportDataFormat	Lists values that indicate the format of exported AcroForm data.
FileAttachmentAnnotationIconName	Contains names of built-in file attachment annotation icons.
FileVersion	Lists values that indicate PDF file version.
FormFieldButtonStyle	Lists values used to specify the appearance of the form field’s marker.
FormFieldCurrencyStyle	Lists values used to specify currency style.
FormFieldNegativeNumberStyle	Lists values used to specify negative number format.
FormFieldNumberSeparatorStyle	Lists values used to specify the separator format.
FormFieldSpecialFormatType	Lists values used to specify special value format types.
FormFieldTextAlignment	Lists text alignment options in an interactive form field.
FormFieldTextFieldType	Lists the types of text form field values.
FreeTextAnnotationIntent	Lists intents of free text annotations.
HashAlgorithm	Lists values used to specify the signature’s secure hash algorithm (SHA) type.
ImageExportType	Lists values that indicate the image format used to export PDF pages.
ImageQuality	Lists values that indicate the image quality in an exported PDF file.
LaunchOperation	Lists operations that specify how a Windows launch target is handled.
LayoutBorderStyle	Lists values that indicate the style of a border in a layout.
LayoutPlacement	Lists values that indicate the placement of a layout in a PDF document.
LineAnnotationCaptionPosition	Lists values that specify a line annotation caption position.
LineAnnotationIntent	Lists values that specify the intent of a line annotation.
LineCap	Lists values that indicate the style of the line cap.
LineJoin	Lists values that indicate the line join style in a PDF document.
ListNumbering	Lists values that specify the list numbering type for a structure element.
MarkupAnnotationReplyType	Lists values that specify how a markup annotation relates to another annotation.
MetadataSyncMode	Lists values that indicate how to synchronize metadata between basic information and the corresponding XMP metadata.
NamedActionName	Lists names of named actions.
NonFullScreenPageMode	Lists values that specify how a PDF viewer displays a document when it is opened in non-full-screen mode.
NumberFormatDisplayFormat	Lists values that indicate the number display format.
NumberFormatLabelPosition	Lists values that indicate the position of a number format label.
PageContentHorizontalAlignment	Lists values that indicate horizontal alignment settings for page content.
PageContentVerticalAlignment	Lists values that indicate vertical alignment settings for page content.
PageRotationAngle	Lists values that indicate the page rotation angle.
PathShapeAction	Lists values that indicate the action to perform on a path shape.
Pdf17StructureType	Lists values that indicate the structure type defined in the PDF 1.7 specification.
Pdf20StructureType	Lists values that indicate the structure type defined in the PDF 2.0 specification.
PdfVersion	Lists values that indicate the PDF version of a document.
PolygonAnnotationIntent	Lists values that specify the intent of a polygon annotation.
PolylineAnnotationIntent	Lists values that specify the intent of a polygon annotation.
PrintDuplexMode	Lists values that indicate the duplex printing mode for a PDF document.
PrintFieldChecked	Lists values that indicate the checked state of a print field in a PDF document.
PrintFieldRole	Lists values that indicate the role of a print field in a PDF document.
PrintScalingMode	Lists values that indicate the print scaling mode in a PDF document.
ReadingDirection	Lists values that indicate the text reading direction in a PDF document.
RedactionGeometryType	Lists values that indicate the type of redaction geometry in a PDF document.
ReviewStatus	Lists the annotation’s review statuses.
RichMediaContentType	Lists values that indicate the type of rich media content.
ShadingType	Lists shading types for PDF gradient fills.
SoundAnnotationIconName	Lists values that indicate the icon for a sound annotation.
SoundEncoding	Lists the encoding formats of sample data associated with the sound annotation.
TableScope	Lists values that indicate the scope of a table in a PDF document.
TextAnnotationIconName	Lists values that indicate the icon displayed in a text annotation.
TextFontStyle	Lists values that indicate the style of a text font.
TextJustification	Lists the justification types applied to the overlay text.
TextMarkupAnnotationType	Lists types of a text markup annotation.
TextRenderingMode	Lists values that indicate the text rendering mode.
ViewAreaBox	Lists values that indicate the page area of the PDF document.
WritingMode	Lists values that indicate the text writing mode in a PDF document.
XmpArrayType	Lists values that indicate the type of an XMP array.
XmpDatePrecision	Lists values that indicate the precision of an XMP date value.
XmpQualifierType	Lists values that indicate the XMP qualifier type.
ZugferdConformanceLevel	Lists values used to specify a ZUGFeRD conformance level.
ZugferdVersion	Lists values that indicate the version of the ZUGFeRD standard used in a PDF document.