com.devexpress.docs.pdf Package

Contains classes, interfaces, enumerations, and exceptions that allow you to create, load, modify, secure, print, and export PDF documents.

Declaration

package com.devexpress.docs.pdf

Classes

Name	Description
AnnotationAppearance	Defines an annotation appearance.
AnnotationAppearances	Defines annotation appearances for interaction states.
AnnotationBorder	Defines annotation border settings.
AnnotationBorderEffect	Defines annotation border effect settings.
AnnotationBorderStyle	Defines annotation border style settings.
AnnotationCallout	Defines annotation callout settings.
AppendDocumentResult	Contains the result of a document append operation, including information about resolved form field name conflicts.
Attachment	A file attachment stored in a PDF document.
AxialShadingFill	Defines an axial shading fill.
BaseAnnotation	Serves as the base class for PDF annotations.
BezierGraphicsPathSegment	A cubic Bézier curve segment in a graphics path.
Bookmark	A PDF bookmark.
ButtonField	A button field in an interactive PDF form.
ButtonIconFit	Specifies how a button icon is scaled and positioned within a button field.
ButtonWidgetAnnotation	Defines a widget annotation associated with the button field 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	Defines a caret annotation in a PDF document.
CheckBoxField	A check box form field in a PDF document.
CheckBoxWidgetAnnotation	A widget annotation associated with a check box form field.
ChoiceField	Base class for choice fields (combo box and list box).
ChoiceFieldItem	An item in a choice form field.
CIEColor	A CIE-based color defined by X, Y, and Z tristimulus values.
CircleAnnotation	Defines a circle annotation in a PDF document.
ClipNode	A clipping node that specifies a clipping region in a PDF document.
ClipRegion	A collection of clipping nodes that specify a clipping region.
ColorSpace	The base class for PDF color spaces.
ColorSpaceGamma	Specifies gamma values for a CalRGB color space.
ColorSpaceMatrix	A color space transformation matrix defined by three XYZ coordinate vectors.
ComboBoxField	A combo box form field in a PDF document.
ComboBoxWidgetAnnotation	A widget annotation associated with a combo box form field.
CoonsPatchMeshShadingFill	Defines a Coons patch mesh shading fill.
CoonsShadingPatch	A Coons patch composed of four Bezier curves for mesh shading.
CustomAnnotation	Defines a custom annotation in a PDF document.
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	The base class that 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 required to clone PDF document objects.
DocumentExportOptions	Contains document-level PDF export options.
DocumentInfo	Contains document properties.
DocumentMetadata	Contains document metadata.
EncryptionOptions	Contains PDF file encryption settings.
ExponentialInterpolationFunction	An exponential interpolation function (PDF Type 2 function).
FileAttachmentAnnotation	Defines a file attachment annotation in a PDF document.
FileSpecification	Contains metadata and binary data for a file associated with a PDF document.
Fill	Contains PDF fill settings for solid, pattern, and shading fills.
FitBBoxDestination	A destination that fits the page bounding box in the document window.
FitBBoxHorizontallyDestination	A destination that fits a page bounding box horizontally.
FitBBoxVerticallyDestination	A destination that fits a page bounding box vertically.
FitDestination	A destination that displays the entire page in the document window.
FitHorizontallyDestination	A destination that fits a page horizontally.
FitRectangleDestination	A destination that displays a page rectangle.
FitVerticallyDestination	A destination that fits a page vertically.
FormField	Serves as the base class for PDF form fields.
FormFieldActions	Stores JavaScript actions for a PDF form field.
FormFieldNameCollision	Contains information about form fields that have the same full name.
FormFieldNameConflict	Contains information about a form field name conflict that the API resolved during a PDF append operation.
FormFieldNegativeNumberStyle	Lists values that specify negative number format.
FormFieldValueFormat	Specifies formatting and validation settings for a PDF form field value.
FormFragment	A visual fragment that draws a reusable form template on a PDF page.
FormTemplate	A reusable form XObject that contains a collection of page fragments.
FormTransparencyGroup	Defines transparency settings for a PDF form XObject.
FreeFormGouraudMeshShadingFill	Defines a free-form Gouraud mesh shading fill.
FreeTextAnnotation	Defines a free text annotation in a PDF document.
FunctionBasedShadingFill	Defines a function-based shading fill.
GoToAction	Defines an action that navigates to a page in the current PDF document.
GouraudMeshShadingFill	Serves as the base class for PDF Gouraud mesh shading fills.
GradientShadingFill	Serves as the base class for PDF gradient shading fills.
GraphicsPath	A sequence of connected lines and curves that can be filled or stroked.
GraphicsPathSegment	The base class for all graphics path segments.
GroupField	A logical group of related PDF form fields.
ICCBasedColorSpace	An ICC-based color space.
ImageCompressionOptions	Contains image compression settings.
ImageExportOptions	Options used to export PDF pages as images.
ImageFragment	An image fragment on a PDF page.
IndexedColorSpace	A color space that maps index values to colors in a lookup table.
InkAnnotation	Defines an ink annotation.
InteractiveAction	Serves as the base class for PDF interactive actions.
JavaScriptAction	An action that executes JavaScript code in a PDF document.
LabColorSpace	A CIE Lab* (Lab) color space in a PDF document.
LatticeFormGouraudMeshShadingFill	Defines a lattice-form Gouraud mesh shading fill.
LayoutAttribute	Defines layout-related attributes for tagged PDF structure elements.
LayoutMetrics	Contains layout metrics for tagged PDF content.
LineAnnotation	Defines a line annotation.
LineGraphicsPathSegment	A line segment in a graphics path.
LineStyle	A dash pattern used to draw lines and outlines.
LinkAnnotation	Defines a link annotation.
ListAttribute	A list attribute for tagged PDF list structure elements.
ListBoxField	A list box form field in a PDF document.
ListBoxWidgetAnnotation	A widget annotation associated with a list box form field.
LoadOptions	Options used to load a PDF document.
MarkedContentGroup	A marked content section in a PDF page.
MarkInfo	Contains the marked content information for a PDF document.
MarkupAnnotation	Servers as a base class for markup annotations.
NamedAction	A named action in a PDF document.
NChannelColorSpace	An NChannel color space in a PDF document.
NumberFormat	Contains number format settings for PDF measurement values.
OptimizationOptions	Contains PDF optimization settings.
OrientedRectangle	An oriented rectangle with location, size, rotation, skew, and pivot data.
Outline	Defines stroke settings for PDF graphics paths.
Page	A single PDF page.
PageFragment	A base class for fragments placed on a PDF page.
ParagraphFragment	A text fragment that contains a paragraph.
PathAnnotation	Serves as a base class for PDF path annotations, such as line, polyline, and polygon.
PathClipNode	A clipping node that uses graphics paths to specify a clipping region.
PathFragment	A visual fragment that contains one or more graphics paths with optional fill and outline settings.
PatternColorSpace	A Pattern color space in a PDF document.
PatternFill	A pattern fill that uses a PatternTemplate to fill PDF content with a repeating tiling pattern.
PatternTemplate	A reusable pattern template.
Pdf17StructureTypeDescriptor	A PDF 1.7 structure type descriptor.
Pdf20StructureTypeDescriptor	A PDF 2.0 structure type descriptor.
PdfColor	A PDF color value.
PdfDocument	A PDF document.
PdfNamespace	A structure tree namespace.
PdfNamespaceRoleMapEntry	A namespace role map entry that maps a structure type to a standard type.
PolygonAnnotation	Defines a PDF polygon annotation.
PolylineAnnotation	Defines a PDF polyline annotation.
PopupAnnotation	Defines a PDF popup annotation.
PostScriptCalculatorFunction	A PostScript calculator function (PDF Type 4 function).
PrinterMarkAnnotation	Defines a PDF printer mark annotation.
PrintFieldAttribute	Attributes of a print field structure element in a PDF document.
PrintPageRange	A range of pages that should be printed.
Quadrilateral	Defines a quadrilateral by four points.
RadialShadingFill	Defines a radial shading fill.
RadioGroupField	A radio button group form field in a PDF document.
RadioGroupItemWidgetAnnotation	A widget annotation for an item in a radio button group.
Range	A continuous interval between two numeric values.
RectilinearMeasure	Defines rectilinear measurement settings for a PDF document.
RedactionAnnotation	Defines a PDF redaction annotation.
RedactionGeometry	Defines redaction annotation geometry.
RemoteGoToAction	Defines an action that navigates to a page in another PDF document.
ResetFormAction	An action that resets PDF form fields to their default values.
ReviewHistoryItem	An annotation’s review item.
RubberStampAnnotation	Defines a PDF rubber stamp annotation.
RubberStampAnnotationIconName	Defines a PDF rubber stamp annotation icon name.
SampledFunction	A sampled function (PDF Type 0 function) that computes output values from a table of sample values.
SaveOptions	Options used to save a PDF document.
SeparationColorSpace	A Separation color space in a PDF document.
ShadingBezierCurve	A cubic Bézier curve segment in a shading fill.
ShadingFill	Serves as the base class for PDF shading fills.
ShadingTriangle	A triangular mesh cell in a Gouraud shading fill.
ShadingVertex	A vertex with a color and position in a shading fill.
ShapeAnnotation	Serves as a base class for PDF shape annotations, such as circle and square.
SignatureField	A signature form field in a PDF document.
SignatureOptions	Specifies options used to sign a PDF document.
SignatureWidgetAnnotation	A widget annotation associated with a signature form field.
SolidFill	Contains a PDF solid fill with a color space and color.
Sound	Contains audio data and playback settings for a PDF sound annotation.
SoundAnnotation	Defines a PDF sound annotation.
SquareAnnotation	Defines a PDF square annotation.
StitchingFunction	A stitching function (PDF Type 3 function) that combines multiple subfunctions.
StructureContentItem	A content item within a structure element.
StructureElement	A structure element in a tagged PDF document.
StructureElementAttribute	The base class for structure element attributes.
StructureElementAttributeCollection	A collection of structure element attributes.
StructureElementType	A PDF structure element type.
StructureItem	The base class for items in a tagged PDF structure tree.
StructureMarkedContentGroup	A marked content group within a structure element.
StructureMarkedContentReference	A marked content reference within a structure element.
StructureTree	Defines the structure tree for a tagged PDF document.
StructureTypeDescriptor	The base class for structure type descriptors.
TableAttribute	Defines table-related attributes for tagged PDF structure elements.
TensorProductPatchMeshShadingFill	Defines a tensor-product patch mesh shading fill.
TensorProductShadingPatch	A tensor-product patch with control points and corner colors for mesh shading.
TextAnnotation	Defines a text annotation in a PDF document.
TextAppearance	Contains appearance settings used to render text in a PDF document.
TextBoxField	A text box form field in a PDF document.
TextBoxWidgetAnnotation	A widget annotation associated with a text box form field.
TextClipNode	A node that defines a clipping path based on text in a PDF document.
TextFont	A font used to draw text in a PDF document.
TextFontStyle	Lists font styles that can be applied to PDF text.
TextFragment	Contains text content that can be added to a PDF page.
TextMarkupAnnotation	Defines a text markup annotation in a PDF document.
TextMatchFragment	A fragment of text that matches a search query in a PDF document.
TextMatchGroup	A group of text matches found in a PDF document.
TextMatchGroupItem	Contains information about a text match within a text match group.
TextMatchInfo	Information about a single text match in a PDF document.
TextSearchInfo	Information about text search results on a PDF page.
TextSearchOptions	Options that define PDF text search behavior.
TrapNetAnnotation	Defines a PDF trap network annotation.
UnclosedPathAnnotation	Defines a PDF unclosed path annotation.
UriAction	An action that opens a web page or another URI associated with a link annotation.
ViewerPreferences	Contains viewer preference settings for a PDF document.
VisualFragment	A base class for visual fragments on a PDF page.
WatermarkAnnotation	Defines a watermark annotation in a PDF document.
WidgetAnnotation	Serves as a base class for widget annotations associated with PDF form fields.
WidgetAnnotationActions	Defines actions associated with widget annotation events.
WinFileSpecification	Contains Windows-specific settings for a launch action.
XmpBasicSchema	The basic XMP schema. Contains general metadata properties, such as the creator application, creation and modification dates, document identifiers, labels, and ratings.
XmpBool	An XMP metadata node with a boolean value.
XmpDate	An XMP metadata date value.
XmpDublinCoreSchema	The Dublin Core metadata schema in an XMP document.
XmpInteger	An XMP metadata integer value.
XmpMetadata	Contains XMP metadata associated with a PDF document.
XmpPdfAExtensionDescriptor	A descriptor for a PDF/A extension schema.
XmpPdfAExtensionField	A field definition in a PDF/A extension schema.
XmpPdfAExtensionProperty	A property definition in a PDF/A extension schema.
XmpPdfAExtensions	Provides access to PDF/A extension schemas in XMP metadata.
XmpPdfAExtensionValueType	A value type definition in a PDF/A extension schema.
XmpPdfASchema	Defines the XMP PDF/A namespace.
XmpPdfSchema	Defines the XMP PDF namespace.
XmpPdfUASchema	The PDF/UA schema in XMP metadata.
XmpProperty	A name-value pair in XMP metadata.
XmpQualifier	An XMP qualifier associated with a metadata property.
XmpRawAccess	Accesses raw XMP metadata properties (XML nodes).
XmpRightsManagementSchema	Stores rights management metadata defined by the XMP Rights Management schema.
XmpString	An XMP metadata string value.
XmpValue	A base class for XMP metadata nodes.
XyzDestination	A destination that displays a page at a position and zoom level.

Interfaces

Name	Description
IAnnotationCollection	A collection of PDF annotations.
IAttachmentCollection	A collection of PDF document attachments.
IBookmarkCollection	A collection of PDF document bookmarks.
IFormFieldCollection	Defines a collection of PDF form fields.
IFragmentCollection	A collection of page fragments.
IObjectCollectionBase<T>	A base collection of objects that supports command notifications.
IPageCollection	A collection of PDF document pages.
IStructureElementAttributeCollection	A collection of attributes of a structure element.
IStructureElementCollection	A collection of elements in a structure tree.
IXmpArray<T>	Defines an XMP array.
IXmpCustomSchema	Defines access to custom XMP schema properties.
IXmpDateArray	Defines an XMP date array.
IXmpLangAlt	An XMP language alternative collection.
IXmpQualifierCollection	An XMP qualifier collection.
IXmpStringArray	An XMP string array.

Enums

Name	Description
ActionName	Lists names of named actions.
AnnotationBorderEffectStyle	Lists annotation border effect styles.
AnnotationHighlightingMode	Lists annotation highlighting modes.
AnnotationLineEndingStyle	Lists line ending styles for free text annotations.
AnnotationPdf3DActivationCircumstances	Lists annotation 3D activation circumstances.
AssociatedFileRelationship	Specifies the relationship between an associated file and the PDF document.
BitonalImageCompressionType	Lists compression algorithms for bitonal PDF images.
BorderStyle	Lists values that indicate the border style of a PDF document element.
ButtonCaptionLayout	Lists values that specify the layout of a caption and icon within a button field.
ButtonIconScalingCircumstances	Lists conditions 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 specify permissions for data extraction operations.
DocumentInteractivityPermissions	Lists values that specify permissions for document interaction operations.
DocumentModificationPermissions	Lists values that specify permission levels for document modification operations.
DocumentPrintPermissions	Lists values that specify permission levels for document print operations.
EncryptionAlgorithm	Lists values that specify the encryption algorithm.
ExportDataFormat	Lists values that specify the format of exported AcroForm data.
FileAttachmentAnnotationIconName	Lists icon names for file attachment annotations.
FileVersion	Lists values that specify the PDF file version.
FormFieldButtonStyle	Lists values that specify the appearance of the form field’s marker.
FormFieldCurrencyStyle	Lists values that specify currency style.
FormFieldNumberSeparatorStyle	Lists values that specify the separator format.
FormFieldSpecialFormatType	Lists values that 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 free text annotation intent values.
GrayscaleImageCompressionType	Lists compression algorithms for grayscale PDF images.
HashAlgorithm	Lists hash algorithms used to generate cryptographic hashes.
ImageCompressionType	Lists values that specify the image compression algorithm in a PDF document.
ImageExportType	Specifies output formats for image export.
ImageQuality	Lists values that specify the image quality level used for image processing operations.
LaunchOperation	Lists operations that specify how a launch target is handled.
LayoutBorderStyle	Lists values that specify the border style for a layout element in a tagged PDF document.
LayoutPlacement	Lists values that specify the placement behavior of a layout element in a tagged PDF document.
LineAnnotationCaptionPosition	Lists line annotation caption position values.
LineAnnotationIntent	Lists values that specify the purpose of a line annotation.
LineCap	Lists values that specify the shape of the ends of a line or outline.
LineJoin	Lists values that specify how two connected line segments are joined.
ListNumbering	Lists marker styles for tagged PDF list items.
MarkupAnnotationReplyType	Lists markup annotation reply type values.
MetadataExportMode
MetadataSyncMode	Lists values that specify how to synchronize metadata between document information and XMP metadata.
NonFullScreenPageMode	Lists values that specify how the document page is displayed when a PDF viewer exits full-screen mode.
NumberDisplayFormat	Lists values that correspond to number formats.
NumberFormatLabelPosition	Lists label positions for PDF measurement number formats.
PageContentHorizontalAlignment	Specifies horizontal alignment for page content.
PageContentVerticalAlignment	Specifies vertical alignment for page content.
PageRotationAngle	Specifies page rotation angles.
PathShapeAction	Lists values that specify how a path shape is rendered.
Pdf17StructureType	Lists PDF 1.7 structure types for tagged PDF elements.
Pdf20StructureType	Lists PDF 2.0 structure types for tagged PDF elements.
PdfACompatibility	Lists values that specify the PDF/A version of a document.
PdfUACompatibility	Lists values that specify the PDF/UA version of a document.
PdfVersion	Lists values that indicate the PDF version of a document.
PolygonAnnotationIntent	Lists available PDF polygon annotation intents.
PolylineAnnotationIntent	Lists available PDF polyline annotation intents.
PrintDuplexMode	Lists duplex printing modes for a PDF document.
PrintFieldChecked	Lists checked states of print fields in a PDF document.
PrintFieldRole	Lists roles of print fields in a PDF document.
PrintScalingMode	Lists values that indicate print scaling modes for a PDF document.
ReadingDirection	Lists values that indicate the text reading direction in a PDF document.
RedactionGeometryType	Lists redaction geometry types.
ReviewStatus	Lists values that specify the review status of a PDF annotation.
RichMediaContentType	Lists values that indicate the type of rich media content.
ShadingType	Lists PDF shading types for fills.
SoundAnnotationIconName	Lists PDF sound annotation icon names.
SoundEncoding	Lists sound encoding types.
TableScope	Lists table scopes in a PDF document.
TextAnnotationIconName	Lists text annotation icon names.
TextJustification	Lists values that specify the horizontal alignment of text in a PDF text annotation or text element.
TextMarkupAnnotationType	Lists text markup annotation types.
TextRenderingMode	Lists values that specify the rendering mode used to display text in a PDF document.
ViewAreaBox	Lists page area boxes in a PDF document.
WritingMode	Lists writing directions for tagged PDF text content.
XmpArrayType	Lists values that specify the type of an XMP array.
XmpDatePrecision	Lists values that specify the precision of an XMP date value.
XmpQualifierType	Lists values that indicate the type of an XMP qualifier.
ZugferdConformanceLevel	Lists values that specify a ZUGFeRD conformance level.
ZugferdVersion	Lists values that specify the version of the ZUGFeRD standard used in a PDF document.