Aspose.PDF FOSS for .NET

API reference for Aspose.Pdf FOSS for .NET v26.7.0. 854 public types organized by module.

Core API

ClassDescription
BaseOperatorCollectionStandalone operator-list class — surface mirrors OperatorCollection but is detached from any page.
BuildVersionInfoBuild and version information for the library.
CollectionItemPer-file metadata entries declared by a portfolio /Collection’s schema, exposed as a typed dictionary on CollectionItem.
ContentsAppenderBuffers operators to prepend to / append to a page’s content stream.
DocumentRepresents a PDF document.
DocumentCollectionClass with 2 methods and 1 property.
DocumentInfoRepresents the document information dictionary.
EmbeddedFileCollectionCollection of embedded files in a document.
EncryptedPayloadWraps the /EP entry on an embedded-file file-spec — the encrypted-payload that signals a PDF 2.0 unencrypted-wrapper document.
EngineDocFacadeWrapper providing the small slice of engine-level state callers may set via doc._engineDoc.X.
ExtGStateValueOne /ExtGState entry — name plus stroke/fill alpha factors.
FileParamsWraps the /Params dict on an embedded-file stream (PDF §7.11.3 Table 46).
FileSpecificationRepresents an embedded file specification (PDF §7.11.3).
GroupGroup / blending colour space dictionary (PDF 32000 §11.6.5).
ImageImage compositing can be customized using the BlendMode enumeration, which includes common blend operations such as Multiply and Screen.
ImagePlacementRepresents an image placement found on a PDF page — the position, size, and resolution of an image XObject as it appears on the page (after CTM transformation).
ImagePlacementAbsorberAbsorbs image placement information from PDF pages.
ImagePlacementCollectionA collection of ImagePlacement items.
ImageStampAdds an image to a PDF page.
InterruptMonitorClass with 1 method.
JavaScriptCollectionDocument-level JavaScript scripts (PDF spec §12.6.4.16).
LaunchActionOperationConverterLaunchActionOperationConverter converts a LaunchActionOperation value to its string representation via ToString, exposing the strings strOpen and strPrint.
LayerA PDF layer (Optional Content Group) as exposed through Layers.
MergeOptionsMerge tuning knobs honored by Merge(MergeOptions, Document[]) and friends.
OcspSettingsOCSP (Online Certificate Status Protocol) settings for the signer’s revocation-check / OCSP-stapling path.
Operator-PdfTop-level base for all PDF content-stream operators.
OperatorCollectionCollection of content stream operators for a page.
OpiOpen Prepress Interface (OPI) metadata wrapper for an XForm.
OptimizationOptions-PdfDocument-scoped alias for OptimizationOptions.
PageRepresents a page in a PDF document.
PageActionCollectionPer-page additional actions (PDF 32000 §12.6.3 /AA entries).
PageExtensionsExtension methods over Page that manipulate the page content stream.
PageInfoContainer for page dimension and margin properties.
PageResourcesProvides access to a page’s resource collections (fonts, images).
PageTransitionRepresents a page transition effect (PDF32000 §12.4.4).
RawOperatorAn unparsed operator token from a content stream — used as a fallback for operators not covered by the typed Operators hierarchy.
RepairOptionsOptions describing what repair is needed.
ResolutionRepresents the resolution (DPI) for device rendering and image placement.
ResourcesType alias for PageResources, matching the Resources class name.
Stamp-PdfTop-level Aspose.Pdf-shape abstract base for stamps applied to a Page via AddStamp(Stamp).
TextStamp-PdfCompat re-export so external tests that reference Aspose.Pdf.TextStamp (from before the type moved to Aspose.Pdf.Stamps) keep compiling.
TimestampSettingsRFC 3161 Time-Stamp Authority (TSA) settings consumed by the signer when embedding a timestamp token into the PKCS#7 envelope.
ValueOne typed value pulled out of a CollectionItem dict by TryGet*Value.
WarningInfoClass with 2 methods and 3 properties.
WatermarkWatermark applied to a page.
XFormRepresents a Form XObject (reusable content stream with its own resources).
XFormCollectionCollection of XForm (Form XObject) resources on a page.
XFormResourcesResources (fonts, xobjects) on an XForm’s stream dict.

Interfaces

InterfaceDescription
IDocumentFontUtilitiesPer-document font helper contract — implemented by FontUtilities.
IOperatorSelectorVisitor interface for Accept(IOperatorSelector).
IWarningCallbackInterface with 1 method.

Enumerations

EnumerationDescription
AFRelationshipRelationship between an embedded file and the document content that references it (/AFRelationship, PDF 2.0 §7.11.3).
FileEncodingCompression / encoding used for the embedded file stream’s data (consumed by Encoding).
FixupPre-defined PDF fixup operations accepted by Stream, bool, object[]).
ImageDeleteActionAction taken by Delete(int, ImageDeleteAction) when the image being removed is still referenced from the page content.
ImageFileTypeRecognised image-source file types reported by Image.FileType.
ImageFilterTypeImageFilterType enum defines the compression filters Jpeg2000, Flate, Jpeg, and CCITTFax that can be applied when re‑encoding images.
LaunchActionOperationLaunchActionOperation enum defines the possible launch operations: None, Open, and Print.
NoCharacterAction-PdfAction taken when the configured font does not have a glyph for a character in the stamp text.
PasswordTypeIdentifies which password (if any) is in effect on an encrypted PDF.
PdfAStandardVersionPdfAStandardVersion enum lists supported PDF/A conformance levels, including PDF_A_1A, PDF_A_2B, PDF_A_3U, and PDF_A_4.
PermissionsPermissions.PrintDocument, ModifyContent, ExtractContent, etc., are enum values that can be combined to set document security settings.
PrintScalingEnum with 2 members.
ReturnActionThe ReturnAction enum is used by RichMediaAnnotation.Accept(visitor) to indicate whether the visitor should Continue processing or Abort.
RotationEnum with 5 members.
TabOrderTab order applied to widget annotations on a page (PDF 32000 /Tabs entry).
WarningTypeCategories of warnings emitted during save/load.

Actions

ClassDescription
ActionCollectionCollection of actions associated with an annotation.
GoToActionClass with 13 methods and 5 properties.
GoToRemoteActionGo-to-remote action — jumps to a destination in a different PDF file .
GoToURIActionAlias for UriAction, matching the public API name.
ImportDataActionAn import-data action (/S /ImportData): imports field data from the FDF/XFDF file identified by the action’s /F file specification.
JavascriptActionClass with 8 methods and 3 properties.
LaunchActionClass with 9 methods and 4 properties.
NamedActionNamedAction.CreateUri(uri) builds a URI action that can be linked to from annotations or form fields.
PdfActionBase class for PDF actions.
SubmitFormActionSubmit-form action — sends form field data to a URL or remote file (PDF 32000-1:2008 §12.7.5.2).
UriActionClass with 7 methods and 3 properties.

Enumerations

EnumerationDescription
ActionTypeThe type of a PDF action.

Annotations

ClassDescription
AnnotationRepresents a PDF annotation.
AnnotationActionCollectionPer-event PDF action slots for a widget annotation (matches the Aspose.Pdf /AA-tree entry shape: 14 named events plus the direct /A activation action).
AnnotationCollectionCollection of annotations on a page.
AnnotationSelectorVisitor that filters annotations across one or more pages.
AppearanceDictionaryAppearance-stream dictionary on an annotation (/AP entry): maps appearance-state name -> XForm.
BleedMarkAnnotationBleedMarkAnnotation can be instantiated with a page and position, and provides methods to update its appearance, flatten it, and write XFDF data.
BorderRepresents the border of an annotation or field widget.
CaretAnnotationClass with 16 methods and 52 properties.
CharacteristicsAnnotation characteristics (border, rotation, etc.).
CircleAnnotationClass with 16 methods and 51 properties.
ColorBarAnnotationThe ColorBarAnnotation constructor creates a color‑bar annotation on a page by specifying the page, rectangle and a CMYK color selector.
CommonFigureAnnotationCommon base for square and circle annotations — a figure drawn inside a rectangle, optionally inset by /RD (PDF 32000 §12.5.6.8).
DashRepresents a dash pattern for borders.
DefaultAppearanceRepresents the default appearance of a free text annotation.
DocumentActionCollectionDocument-level /AA additional-action dictionary (PDF 32000-1 §12.6.3 Table 195).
ExplicitDestinationRepresents an explicit destination in a PDF document (e.g.
FieldDateTimeFormatterFormats a date/time value string according to an Acrobat-style date format.
FieldNumberCurrencyFormatterFormats a numeric string as a currency value.
FieldNumberPercentFormatterFormats a numeric string as a percentage (multiplies by 100 first).
FileAttachmentAnnotationRepresents a file attachment annotation.
FitBExplicitDestinationFit-bounding-box destination (/FitB).
FitBHExplicitDestinationFitBH destination (/FitBH) — fit bounding box horizontally at Top.
FitBVExplicitDestinationFitBV destination (/FitBV) — fit bounding box vertically at Left.
FitExplicitDestinationFit-the-page destination (/Fit).
FitHExplicitDestinationFit horizontally at /Top (/FitH).
FitRExplicitDestinationFitR rectangle destination (/FitR).
FitVExplicitDestinationFit vertically at /Left (/FitV).
FixedPrintClass with 3 properties.
FreeTextAnnotationFreeTextAnnotation constructors allow creating a free‑text annotation on a specific page rectangle with a defined appearance.
GenericAnnotationFallback annotation class for annotation subtypes that have no dedicated model (e.g.
HighlightAnnotationHighlight text markup annotation.
InkAnnotationClass with 17 methods and 52 properties.
LineAnnotationClass with 17 methods and 62 properties.
LinkAnnotationClass with 9 methods and 51 properties.
MarkupAnnotationClass with 15 methods and 50 properties.
MeasureMeasure-units metadata attached to a LineAnnotation (PDF 32000 §12.5.6.13 measure dictionaries).
MediaClipA media clip object (PDF §13.2.4) — the actual media data or section thereof.
MediaClipDataA media clip data object (PDF §13.2.4.2) — full media data via a file specification.
MediaClipSectionA media clip section object (PDF §13.2.4.3) — a temporal section of another clip.
MediaRenditionA media rendition (PDF §13.2.3.2) — pairs a media clip with playback parameters.
MovieAnnotationClass with 9 methods and 51 properties.
NumberFormatOne number-format entry — describes how a measurement value is rendered (precision, separators, before/after text).
NumberFormatListNested number-format list (Aspose.Pdf shape: Measure+NumberFormatList).
PDF3DAnnotationClass with 14 methods and 53 properties.
PDF3DArtworkA 3D artwork dictionary referenced by a PDF 3D annotation (Aspose.Pdf shape).
PDF3DContentEmbedded-stream content for a 3D artwork (U3D or PRC).
PDF3DCrossSectionSingle cross-section through a PDF 3D model (Aspose.Pdf shape).
PDF3DCrossSectionArrayOrdered collection of PDF3DCrossSection entries applied to a PDF 3D view (Aspose.Pdf shape).
PDF3DCuttingPlaneOrientationOrientation angles for the cutting plane of a 3D cross-section (Aspose.Pdf shape).
PDF3DLightingSchemeLighting scheme applied to a PDF 3D artwork (Aspose.Pdf shape).
PDF3DRenderModeRender mode applied to a 3D artwork view (Aspose.Pdf shape).
PDF3DStreamPDF /3DD stream wrapper — pairs a PDF3DArtwork with its document-owned content stream.
PDF3DViewCamera + render-state snapshot of a 3D artwork (Aspose.Pdf shape).
PDF3DViewArrayIndexed collection of PDF3DView snapshots (Aspose.Pdf shape).
PageInformationAnnotationClass with 8 methods and 47 properties.
PdfActionCollectionCollection of PdfAction entries attached to an annotation (or any other action-bearing PDF object).
PolyAnnotationCommon base for polygon and polyline annotations — a chain of connected vertices (PDF 32000 §12.5.6.9).
PolygonAnnotationClass with 16 methods and 52 properties.
PolylineAnnotationClass with 15 methods and 52 properties.
PopupAnnotationClass with 9 methods and 49 properties.
PrinterMarkAnnotationAggregate printer’s-mark generator.
RedactAnnotationBackward-compatible alias for RedactionAnnotation.
RedactionAnnotationRepresents a redaction annotation.
RegistrationMarkAnnotationClass with 8 methods and 48 properties.
RenditionA rendition object (PDF §13.2.3) — describes a media object to be played by a rendition action.
RenditionActionA rendition action (PDF §12.6.4.14) — controls the playing of multimedia content.
RichMediaAnnotationClass with 12 methods and 52 properties.
RichTextToFlatStructureTransformerTransforms rich text annotation content (XHTML with arbitrarily nested spans) into a flat structure where every leaf text node becomes a single <span style="."> with the fully-merged CSS from all ancestor elements.
ScreenAnnotationThe ScreenAnnotation class lets you add a screen annotation to a page by providing the page, rectangle, and media file, and exposes AnnotationType, Action, and Title properties.
SelectorRenditionA selector rendition (PDF §13.2.3.3) — chooses among alternative renditions.
SoundAnnotationClass with 16 methods and 52 properties.
SoundDataClass with 5 properties.
SoundSampleDataSoundSampleData constructors allow specifying samplingRate alone or together with numberOfSoundChannels, bitsPerChannel, and SoundSampleDataEncodingFormat.
SquareAnnotationThe SquareAnnotation.Accept(visitor) method implements the visitor pattern, allowing custom processing of annotation objects.
SquigglyAnnotationSquiggly text markup annotation.
StampAnnotationClass with 16 methods and 53 properties.
StrikeOutAnnotationStrikeOut text markup annotation.
TextAnnotationClass with 16 methods and 54 properties.
TextMarkupAnnotationBase class for the text-markup annotations (Highlight, Underline, StrikeOut, Squiggly) — those whose geometry is a set of QuadPoints over page text.
TextStyleBundled font / colour / alignment style applied to a free-text annotation’s rich text.
TrimMarkAnnotationClass with 8 methods and 48 properties.
UnderlineAnnotationUnderline text markup annotation.
WatermarkAnnotationRepresents a watermark annotation that can be added to a PDF page.
WidgetAnnotationClass with 13 methods and 59 properties.
XYZExplicitDestinationXYZ explicit destination: display the page at position (left, top) with zoom factor.

Interfaces

InterfaceDescription
IAppointmentMarker interface for any object that can be stored in an outline item’s Destination, a link annotation’s Destination, Document.OpenAction, or a named-destination collection.

Enumerations

EnumerationDescription
ActivationEventEnum with 3 members.
AnnotationFlagsAnnotation flags as defined in PDF spec Table 165.
AnnotationStateReview or marked-state of a markup annotation, as defined by PDF 32000 §12.5.6.3 (text annotations, /StateModel + /State entries).
AnnotationStateModelWhich state model a AnnotationState belongs to.
AnnotationTypeAnnotation subtype as defined in PDF spec Table 169.
BorderEffectBorder effect applied to annotations.
BorderStyleBorder style for annotations and fields.
CapStyleCap style used by ink strokes (free-hand drawings).
CaptionPositionCaption-position within a LineAnnotation.
CaretSymbolCaret-symbol style for CaretAnnotation.
ColorsOfCMYKCMYK channel selector used by ColorBarAnnotation.
ContentTypeEnum with 3 members.
ExplicitDestinationTypeExplicit destination type, mirroring PDF 32000 §12.3.2.2 names.
FileIconNamed-icon style for FileAttachmentAnnotation (/Name entry).
FractionStyleHow fractional values are rendered (decimal / fraction / round / truncate).
FreeTextIntentIntent (sub-purpose) of a free-text annotation.
HighlightingModeHighlighting mode for link annotations.
JustificationJustification of a free-text annotation’s content.
LightingSchemeTypeLighting-scheme nominal type (PDF 32000-1 §13.6.4).
LineEndingLine annotation ending styles (/LE entry elements).
LineIntentLine annotation intents (/IT entry).
PDF3DActivationHow the embedded 3D model becomes active (PDF 32000-1 §13.6.2, AAS entry of the 3D activation dictionary).
PolyIntentIntent of a polygon or polyline annotation (/IT entry).
PredefinedActionNamed viewer commands targeted by a NamedAction (PDF 32000 §12.6.4.11).
PrinterMarkCornerPositionCorner a printer-mark annotation sits in (used by bleed-/trim-marks).
PrinterMarkSidePositionSide a printer-mark annotation sits on.
PrinterMarksKindThe set of printer’s-mark families AddPrinterMarks generates on a page (PDF 32000 pre-press marks).
RenderModeTypeRender-mode nominal type (PDF 32000-1 §13.6.5).
ReplyTypeReply-relationship between a markup annotation and its InReplyTo target.
RichTextFontStylesRich-text run styles applied via Color).
SoundEncodingEnum with 4 members.
SoundIconEnum with 2 members.
SoundSampleDataEncodingFormatSoundSampleDataEncodingFormat enum defines the supported audio encodings: Raw, Signed, muLaw, and ALaw.
StampIconNamed stamp-icon style for StampAnnotation (/Name entry, PDF 32000 §12.5.6.14).
TextAlignmentHorizontal text alignment for annotation text boxes.
TextIconNamed-icon style for TextAnnotation (PDF 32000 §12.5.6.4 /Name entries).

Artifacts

ClassDescription
ArtifactRepresents a PDF artifact — a marked content sequence tagged as /Artifact (PDF 32000 §14.8.2.2).
ArtifactCollectionCollection of artifacts on a page.
BackgroundArtifactRepresents a background artifact (a coloured block or image painted behind page content).
HeaderArtifactRepresents a header artifact — a page-level running head tagged Artifact /Subtype /Header (PDF 32000 §14.8.2.2).
WatermarkArtifactRepresents a watermark artifact that can be added to a PDF page.

Enumerations

EnumerationDescription
ArtifactSubtypeEnumerates artifact subtypes.
ArtifactTypeEnumerates artifact types as defined by PDF 32000 §14.8.2.2.

Collections

ClassDescription
CollectionPDF Portfolio collection.
CollectionFieldOne column in a PDF Portfolio’s collection schema (PDF spec §7.11.5 Table 75).
CollectionSchemaSchema of a PDF Portfolio collection (PDF spec §7.11.5 Table 74).
ImageCollectionCollection of image XObjects on a page.
ImageXObjectRepresents an image XObject found in a PDF page’s resources.
PageCollectionCollection of pages in a PDF document.
XImageImage XObject wrapper that mirrors the Aspose.Pdf XImage public surface.
XImageCollectionCollection of image XObjects on a page, with XImage-typed accessors and editing helpers.

Enumerations

EnumerationDescription
CollectionFieldSubtypePredefined collection field subtypes (PDF spec §7.11.5 Table 75).

Color

ClassDescription
Color-PdfRepresents a color value used in PDF documents.

Enumerations

EnumerationDescription
ColorSpaceTop-level device colour-space selector (Aspose.Pdf public surface).
ColorTypeRepresents the color type of a page.

Comparison

ClassDescription
DiffOperationA single edit produced when diffing two texts: an Operation (Equal / Delete / Insert) together with the run of text it applies to.
DiffUtilsText helpers used by the diff engine: common prefix/suffix extraction and re-assembly of the source / destination text from a list of DiffOperations.
MergingOptimizerSemantic clean-up pass: eliminates equalities that are no larger than the edits surrounding them (folding those short common runs back into the adjacent delete/insert), then re-merges the result into canonical form.
OperationsMergerMerges a diff into its canonical minimal form: coalesces adjacent runs of the same operation, and for a mixed delete/insert run factors any common prefix into the preceding equality and any common suffix into the following equality.
OperationsSlideMergerShifts a single edit that is surrounded on both sides by equalities sideways to eliminate one of those equalities, canonicalising the diff.

Interfaces

InterfaceDescription
IDiffOptimizationOperationA post-processing pass that normalises a diff — a mutable list of DiffOperations — in place, preserving the source and destination texts while producing a cleaner or more canonical sequence of edits.

Enumerations

EnumerationDescription
EditOperationsOrderWhen a delete and an insert are emitted for the same position, which one an optimizer places first in the resulting operation sequence.
OperationThe kind of edit a DiffOperation represents when diffing two texts: a run that is unchanged, deleted from the source, or inserted in the destination.

Content

ClassDescription
BDCBDC — Begin marked content with properties.
BIBI — Begin inline-image object.
BMCBMC — Begin marked-content sequence (no properties).
BTBT — Begin text object.
BXBX — Begin compatibility section.
BasicSetColorAndPatternOperatorCommon base for SCN/scn (basic color or pattern).
BasicSetColorOperatorCommon base for the rg/RG/g/G/k/K family.
BlockTextOperatorCommon base for the BT / ET delimiters.
ClipW — Set clipping path (nonzero winding rule).
ClosePathh — Close subpath.
ClosePathEOFillStrokeb* — Close, fill, and stroke path (even-odd rule).
ClosePathFillStrokeb — Close, fill, and stroke path (nonzero winding rule).
ClosePathStrokes — Close and stroke path.
ConcatenateMatrixcm — Concatenate matrix to CTM.
ContentStreamBuilderBuilds PDF content stream bytes using the operator syntax from PDF32000 §8-9.
CurveToc — Append cubic Bézier curve with three control points.
CurveTo1v — Append cubic Bézier curve; first control point is current point.
CurveTo2y — Append cubic Bézier curve; second control point coincides with final point.
DPDP — Designate marked-content point with property list.
DoDo — Invoke named XObject.
EIEI — End inline-image object.
EMCEMC — End marked content.
EOClipW* — Set clipping path (even-odd rule).
EOFillf* — Fill path (even-odd rule).
EOFillStrokeB* — Fill and stroke path (even-odd rule).
ETET — End text object.
EXEX — End compatibility section.
EndPathn — End path without filling or stroking.
ExtGStateRepresents an Extended Graphics State dictionary (PDF32000 §8.4.5).
ExtractedPathRepresents a complete path with its painting mode and color.
Fillf — Fill path (nonzero winding rule).
FillStrokeB — Fill and stroke path (nonzero winding rule).
GRestoreQ — Restore graphics state.
GSgs — Set parameters from named ExtGState resource.
GSaveq — Save graphics state.
GlyphPositionOne element of a TJ-style glyph-position array: a string with an optional preceding/following position adjustment (in 1/1000 text units).
GraphicsStateTracks the PDF graphics state during content stream parsing (PDF32000 §8.4).
ID-OperatorsID — Begin image data (after the inline-image dictionary).
LineTol — Append straight line segment to (X, Y).
MPMP — Designate marked-content point (no properties).
MoveTextPositionTd — Move text position: translate text origin by (X, Y).
MoveTextPositionSetLeadingTD — Move text position and set leading: translate by (X, Y) and set leading to -Y.
MoveTom — Begin new subpath at (X, Y).
MoveToNextLineT* — Move to next line using current leading.
MoveToNextLineShowText’ — Move to next line and show text.
ObsoleteFillF — Fill path (deprecated; equivalent to f).
Operator-OperatorsBack-compat alias for Operator kept so existing using Aspose.Pdf.Operators; code and the concrete operator subclasses (GSave, BT, ET, …) in this namespace continue to bind.
OperatorSelectorVisitor that filters content-stream operators by concrete type.
PathExtractorExtracts vector paths from PDF page content streams.
PathSegmentRepresents a segment of a path.
Rere — Append rectangle (X, Y, Width, Height) as a complete subpath.
SelectFontTf — Select font and size.
SetAdvancedColorscn — Set color (with optional pattern name) in current color space (non-stroking).
SetAdvancedColorStrokeSCN — Set color (with optional pattern name) in current color space (stroking).
SetCMYKColork — Set CMYK fill color.
SetCMYKColorStrokeK — Set CMYK stroke color.
SetCharWidthd0 — Set glyph width in a Type 3 font.
SetCharWidthBoundingBoxd1 — Set glyph width and bounding box in a Type 3 font.
SetCharacterSpacingTc — Set character spacing.
SetColorsc — Set color in current color space (non-stroking).
SetColorOperatorCommon base for the SC/SCN/sc/scn family.
SetColorRenderingIntentri — Set color rendering intent.
SetColorSpacecs — Set color space for non-stroking operations.
SetColorSpaceStrokeCS — Set color space for stroking operations.
SetColorStrokeSC — Set color in current color space (stroking).
SetDashd — Set dash pattern.
SetFlati — Set flatness tolerance.
SetGlyphsPositionShowTextTJ — Show text with individual glyph positioning (array of strings and numeric adjustments).
SetGrayg — Set gray fill color.
SetGrayStrokeG — Set gray stroke color.
SetHorizontalTextScalingTz — Set horizontal text scaling.
SetLineCapJ — Set line cap style.
SetLineJoinj — Set line join style.
SetLineWidthw — Set line width.
SetMiterLimitM — Set miter limit.
SetRGBColorrg — Set RGB fill color.
SetRGBColorStrokeRG — Set RGB stroke color.
SetSpacingMoveToNextLineShowText" — Set word/char spacing, move to next line, and show text.
SetTextLeadingTL — Set text leading.
SetTextMatrixTm — Set text matrix.
SetTextRenderingModeTr — Set text rendering mode.
SetTextRiseTs — Set text rise.
SetWordSpacingTw — Set word spacing.
ShFillsh — Paint shading specified by named resource.
ShowTextTj — Show text string.
StrokeS — Stroke path.
TextOperatorCommon base for all text-related operators (BT/ET, Tx state, text-show, text-place).
TextPlaceOperatorCommon base for text-positioning operators (Td, TD, T*, Tm).
TextShowOperatorCommon base for text-showing operators (Tj, TJ, ‘, “).
TextStateOperatorCommon base for text-state operators (Tc, Tw, Tz, TL, Tf, Tr, Ts).

Structs

StructDescription
PathCommandA single path construction command with coordinates.

Enumerations

EnumerationDescription
LineCapLine cap style.
LineJoinLine join style.
PathOpPath construction operator type.
PathOperationTypeRepresents a type of path operation.
PathPaintModeRepresents a single path painting operation.

Converters

ClassDescription
MarkdownConverterOptionsOptions for PDF-to-Markdown conversion.
MdLoadOptionsOptions for loading Markdown files as PDF documents.
PageSizeInfoPage size configuration for document loading.
PdfToHtmlConverterConverts PDF pages to HTML markup.
PdfToMarkdownConverterConverts PDF pages to Markdown text.
PdfToSvgConverterConverts PDF pages to SVG format.
PdfToTextConverterConverts PDF pages to plain text.
SvgLoadOptionsOptions for loading SVG files as PDF documents.
TxtLoadOptionsOptions for loading a plain-text (.txt) file as a PDF document.

Enumerations

EnumerationDescription
ConversionEnginesAvailable conversion engines.

Devices

ClassDescription
BmpDeviceRenders PDF document pages into BMP image format.
DocumentDeviceAbstract base for whole-document rendering devices.
GdiPlusPageRendererPDF page renderer that rasterizes through GDI+ (Graphics).
GifDeviceRenders PDF document pages into GIF image format.
ImageDeviceAbstract base class for image rendering devices (PNG, JPEG, BMP, TIFF).
ImagePageDeviceDefault PageDevice that delegates to any ImageDevice — PngDevice / JpegDevice / BmpDevice / TiffDevice.
IndexBitmapConverterAbstract base class for converting rendered images to indexed (1/4/8bpp) bitmaps.
JpegDeviceRenders PDF document pages into JPEG image format.
MarginsPage margins in points for TIFF rendering.
PageDeviceAbstract base for single-page rendering devices.
PageSize-DevicesRepresents a physical page size in points.
PdfDocumentDeviceDefault DocumentDevice implementation that saves the document as a PDF (Document.Save round-trip).
PngDeviceRenders PDF document pages into PNG image format.
RgbaBufferRaw RGBA pixel buffer returned by a IPageRenderer.
SoftwarePageRendererBuilt-in software PDF page renderer.
SvgDeviceConverts a PDF page to SVG markup.
TextDeviceExtracts text from PDF pages.
TiffDeviceRenders PDF document pages into TIFF image format.
TiffSettingsSettings for TIFF image generation (color depth, compression).

Interfaces

InterfaceDescription
IPageRendererRenders a PDF page to an RGBA pixel buffer.

Enumerations

EnumerationDescription
ColorDepthColor depth options for TIFF encoding.
CompressionTypeTIFF compression algorithm options.
FormPresentationModeHow form fields are rendered (canonical Production / Editor split).
PageCoordinateTypeWhich page-box the rendered image extents come from.
ShapeTypeShape type for TIFF rendering.

Drawing

ClassDescription
ArcAn arc shape (portion of an ellipse).
CircleA circle shape.
Color-DrawingColor for drawing shapes.
CurveA Bézier curve shape.
DrawingPathA path shape composed of move, line, and curve segments.
DrawingRectangleA rectangle shape.
EllipseAn ellipse shape.
GradientAxialShadingDefines a linear (axial) gradient between two colors for use as a fill pattern.
GraphA graph container that holds drawable shapes and renders them to a content stream.
LineA line shape.
PatternColorSpacePattern colour-space marker (Aspose.Pdf public surface).
Point-DrawingA 2D point (x, y).
PolygonA polygon shape (closed path with arbitrary vertices).
Rectangle-DrawingA rectangle shape in the Drawing namespace (distinct from Aspose.Pdf.Rectangle which is a page rectangle).
ShapeBase class for drawable shapes.

Enumerations

EnumerationDescription
ImageFormatSpecifies the encoding format of an image.

Enums

ClassDescription
IdPair of byte strings that make up the /ID array in the PDF trailer.

Enumerations

EnumerationDescription
DirectionPredominant text-flow direction recorded in the viewer-preferences dictionary.
ExtendedBooleanA tri-state Boolean — True/False plus an Undefined sentinel used at deserialization time when a value isn’t carried on the PDF dictionary entry.
FieldValueTypeLogical value type carried by a CollectionField.
HorizontalAlignmentDescribes horizontal alignment.
PageLayoutPage-layout entry written to the catalog (PDF32000 Table 28).
PageModePage-mode entry written to the catalog (PDF32000 Table 28).
PdfVersionPDF specification version targeted by the document header.
PrintDuplexPrint-duplex value recorded in viewer preferences (PDF32000 Table 150).
VerticalAlignmentDescribes vertical alignment.

Exceptions

ClassDescription
CrashReportOptionsConfigures crash-report emission for GenerateCrashReport.
FontNotFoundExceptionThrown when a requested font cannot be located (no system font with that name, no matching custom-font source, etc.).
IncorrectFontUsageExceptionThrown during text extraction when the content stream issues a text-showing operator (Tj/TJ/’/”) while no font is set in the current graphics state — i.e.
InvalidFormTypeOperationExceptionThrown when an operation is attempted on the wrong form type (e.g.
InvalidPasswordExceptionThrown when a password-protected operation is attempted without supplying a valid password (e.g.
InvalidPdfFileFormatExceptionThrown when a stream cannot be opened as a PDF (bad header, truncated file, or otherwise unrecognisable as PDF).
PdfExceptionRepresents errors that occur during PDF application execution.
PdfExceptionMessagesCentralised message strings surfaced by the library’s exceptions and security diagnostics.
PdfTextDecodingExceptionThrown when text content cannot be decoded — e.g.
UnsupportedFontTypeExceptionThrown when a file cannot be opened as a font because its format is not a supported font program (e.g.
ValidationIssueRepresents a validation issue found in a PDF document.

Facades

ClassDescription
AlignmentTypeHorizontal-alignment selector for legacy facade APIs (e.g.
AutoFillerRepeatedly stamps a template PDF with rows from a DataTable: for each row, fills the form fields whose names match column names, flattens (except those listed in UnFlattenFields), and appends the resulting pages to the output.
BDCPropertiesProperties for a BDC / DP marked-content operator (/MCID and /Lang).
BookmarkA single bookmark extracted from a document’s outline tree by ExtractBookmarks().
BookmarksAn ordered, indexable collection of Bookmark entries returned by ExtractBookmarks().
ContentsResizeParametersParameters for ResizeContents describing margins, content size, and whether the page media box should change to match.
ContentsResizeValueRepresents a content-resize value.
CorruptedItemOne file the Concatenate path could not parse — recorded only when CorruptedFileAction is set to skip-and-continue.
DocumentPrivilegeRepresents document access permissions (P value in encryption dictionary).
FontColorRepresents a font color using RGB components.
Form-FacadesFacade for form field manipulation including XML import/export.
FormDataConverterBridges PDF form-data formats (FDF / XFDF / XML) with DataTable and direct stream-to-stream transforms.
FormEditorFacade for form operations: fill fields, flatten forms, import/export data.
FormFieldFacadeRepresents the visual appearance attributes of a form field.
FormImportResultPer-field result of a form-data import operation.
FormattedTextRepresents formatted text used in stamp and mend operations.
FormattedTextFontRepresents a font reference returned by FormattedText.getFont().
LineInfoLine drawing parameters for PdfContentEditor.DrawCurve.
PageBreakDescribes a single horizontal cut on a source page: PageNumber (1-based) identifies the page in the source document, Position the PDF y-coordinate where the page is split.
PdfAnnotationEditorFacade for annotation manipulation: import/export XFDF, delete, flatten, redact.
PdfBookmarkEditorFacade for bookmark (outline) manipulation: create, extract, delete bookmarks.
PdfContentEditorFacade for content-level editing: text replacement, link creation, image operations.
PdfConverterFacade for converting PDF pages to images.
PdfExtractorFacade for extracting text and images from a PDF document.
PdfFileEditorReal-only additions to PdfFileEditor: exception-handling state, Try* wrappers around the existing working methods, and MemoryStream/file overloads for SplitToBulks/SplitToPages that wrap the real byte[] implementations already present in PdfFileEditor.cs.
PdfFileInfoFacade for accessing PDF document metadata and properties.
PdfFileMendFacade for adding text and images to existing PDF documents.
PdfFileSecurityFacade for encrypting, decrypting, and changing passwords on PDF files.
PdfFileSignatureFacade for signing and reading digital signatures in PDF documents.
PdfFileStampFacade for adding stamps, page numbers, headers, footers, and watermarks.
PdfJavaScriptStripperRemoves all JavaScript from a PDF document.
PdfPageEditorFacade for page-level editing: rotation, resizing, margin adjustment, and page box manipulation (CropBox, TrimBox, BleedBox, ArtBox).
PdfPrintPageInfoClass with 1 property.
PdfViewerFaçade for viewing / printing a PDF document.
PdfXmpMetadataDictionary-style facade over a PDF document’s XMP metadata stream.
RenderingOptions-FacadesRendering options used by PdfConverter and other facade classes.
ReplaceTextStrategyConfigures how ReplaceText(string, string) matches and substitutes text.
SignatureNameIdentifies a signature field by both its partial name (Name) and full hierarchical name (FullName), and reports whether the field currently carries a signature value via HasSignature.
Stamp-FacadesRepresents a stamp to be applied via PdfFileStamp facade.
StampInfoContains information about a stamp on a page.
TextPropertiesText-display properties consumed by the *TextOperator family.
VerticalAlignmentTypeVertical-alignment selector for legacy facade APIs (e.g.
ViewerPreferenceBag of const int bit-flags describing viewer preferences (page mode, page layout, fullscreen behaviour, duplex, print scaling, reading direction).

Interfaces

InterfaceDescription
IFacadeInterface with 5 methods.
ISaveableFacadeInterface with 5 methods.

Enumerations

EnumerationDescription
AlgorithmEncryption algorithm family used by PdfFileSecurity.
AutoRotateModeAuto-rotation behaviour for the PDF viewer.
BlendingColorSpaceBlend-mode colour-space hint passed to a Stamp.
ConcatenateCorruptedFileActionHow the facade reacts to corrupted input during Concatenate.
DataTypeForm-data source / destination kind consumed by FormDataConverter.
DefaultMetadataPropertiesWell-known XMP-basic-schema property keys exposed by PdfXmpMetadata as a typed alternative to raw “xmp:<name>” strings.
EncodingTypeEncoding type enumeration for FormattedText.
ExtractImageModeImage extraction mode — matches docs.aspose.com Aspose.Pdf.ExtractImageMode.
ExtractTextModeText extraction mode — matches docs.aspose.com “Pure” (0) / “Raw” (1).
FieldType-FacadesThe type of an AcroForm field, as used by AddField and related facade operations.
FontStyleFont style enumeration for FormattedText.
ImageMergeModeLayout strategy used by MergeImages when combining multiple input images into a single output image.
ImportStatusOutcome of importing a single field’s value.
KeySizeKey strength selector paired with Algorithm to pick the concrete RC4/AES variant used by PdfFileSecurity.
NoCharacterAction-FacadesWhat to do when the replacement font lacks a glyph for a character.
PdfConverterImageFormatImage format for PdfConverter output.
PositioningModeText positioning mode for PdfFileMend.
PropertyFlagAttribute flags applied to a form field via SetFieldAttribute.
Scope-FacadesHow many matches to replace per call.
StampTypeStamp kind exposed by StampInfo.
SubmitFormFlagFormat of the data posted by a Submit form action — set per field via SetSubmitFlag.
WordWrapMode-FacadesWord wrap mode for PdfFileMend text operations.

Forms

ClassDescription
AcroFormDataForm-level AcroForm dictionary data surfaced by the form JSON export.
AppearanceEntryOne state of a widget appearance variant (the body of an /AP/N, AP/D, or /AP/R entry).
ButtonFieldPush-button form field (FT=Btn with Pushbutton flag set).
CheckboxFieldClass with 26 methods and 84 properties.
ChoiceFieldClass with 25 methods and 89 properties.
ComboBoxFieldCombo box (drop-down) form field — a ChoiceField with the Combo flag set.
DefaultResourcesDataForm-level default resources (/DR) surfaced by the form JSON export.
DocMDPSignaturePairs a Signature (which carries the signing certificate) with the DocMDPAccessPermissions level a certifying signature will impose.
ExportFieldsToJsonOptionsOptions passed to ExportToJson.
FieldRepresents a form field.
FieldExportingDataData-transfer object describing a single form field (or the form-level AcroForm dictionary) as produced by the form JSON export.
FieldSerializationResultPer-field outcome of an ExportToJson or ImportFromJson call.
FlattenSettingsSettings for Flatten(FlattenSettings).
Form-FormsRepresents the interactive form (AcroForm) of a PDF document.
FormFieldBuilderCreates new interactive form fields and adds them to a PDF document.
IconFitPDF Annotation Handler “IF” entry — icon-fit dictionary for push-button widgets.
ListBoxFieldList box form field — a ChoiceField without the Combo flag.
OptionClass represents option of choice field.
OptionCollectionMutable collection of Option values backed by the owning ChoiceField’s /Opt entry.
PKCS1Class with 7 methods and 14 properties.
PKCS7Class with 6 methods and 14 properties.
PKCS7DetachedA detached PKCS#7 (CMS) signature configuration.
RadioButtonFieldClass with 27 methods and 95 properties.
RadioButtonGroupA logical radio-button group — a set of mutually exclusive options sharing the same field name in the AcroForm hierarchy.
RadioButtonOptionA single option within a radio button group.
RadioButtonOptionFieldOne option of a RadioButtonField.
RichTextBoxFieldA Tx form field that carries the rich-text flag (bit 26 of /Ff).
SignatureRepresents a digital signature in a PDF document.
SignatureCustomAppearanceVisual-layout knobs for a signature’s appearance stream — font, size, padding and which signer metadata strings are rendered inside the widget annotation.
SignatureFieldSignatureField.Sign(signature) applies a digital signature to a form field, and Flatten() can make the signature appearance permanent in the document.
TextBoxFieldThe TextBoxField class lets developers create AcroForm text fields with multiple constructors and supports adding barcodes and images to the field.
XFAXmlNode-based accessor for the document’s XFA packets (template / datasets / config / form / xdp).
XfaAccessorProvides indexer access to XFA field values by path.
XfaFieldRepresents a single field of an XFA form addressed by its template SOM path (e.g.

Enumerations

EnumerationDescription
BoxShapeOuter shape of a checkbox / radio-button widget border.
BoxStyleVisual style of the checkbox glyph (/MK /CA mapping).
DocMDPAccessPermissions/DocMDP /TransformParams /P access-permission levels per PDF 32000-1 §12.8.2.2.
FieldSerializationStatusOutcome of serializing a single form field through ExportToJson or ImportFromJson.
FieldType-FormsThe type of a form field.
FormTypeRepresents the type of a PDF form.
IconCaptionPositionPDF Annotation Handler “TP” entry — caption / icon layout for push-button widgets.
ScalingModeHow a button icon is scaled to fit its rectangle (/MK /IF /SW).
ScalingReasonWhen to scale the icon to fit its rectangle (/MK /IF /S).
SignDependentElementsRenderingModesHow widgets dependent on signature appearance are rendered when the form is converted.
SubjectNameElementsX.500 distinguished-name components rendered inside the visible signature appearance when UseDigitalSubjectFormat is set.

Functions

ClassDescription
ExponentialFunctionExponential interpolation function (§7.10.3).
PdfFunctionAbstract base for all PDF function types.
PostScriptEvaluatorPostScript calculator evaluator for Type 4 PDF functions (PDF32000 §7.10.5).
PostScriptFunctionPostScript calculator function (§7.10.5).
SampledFunctionSampled function (§7.10.2): lookup table with linear interpolation.
StitchingFunctionStitching function (§7.10.4): combines sub-functions over sub-domains.

Generator

ClassDescription
BaseParagraphBase class for paragraph-level DOM content (text fragments, tables, images, header/footer fragments, floating boxes).
BorderInfoRepresents border information for table cells and rows.
CellRepresents a cell in a table row.
CellsA collection of cells in a row.
ColumnInfoColumnInfo stores table layout details, exposing ColumnWidths, ColumnSpacing, and ColumnCount properties for precise column sizing.
FileHyperlinkHyperlink that launches an external file (e.g.
FloatingBoxRepresents a floating box that can be positioned absolutely or flowed on a page.
GraphInfoStroke / fill settings for drawable shapes and table-cell borders.
HeaderFooterRepresents a header or footer that can be applied to PDF pages.
HeadingRepresents a TOC heading entry that links to a destination page.
HyperlinkBase type for hyperlinks attached to text fragments or annotations.
LevelFormatPer-heading-level TOC formatting descriptor (line-dash style, margins, indent, text state).
LocalHyperlinkHyperlink that jumps to another paragraph or page in the same document.
MarginInfoRepresents margin information for page elements.
NoteA footnote or endnote attached to a TextFragment.
ParagraphsContainer for paragraph-level content (text fragments, tables, images, header/footer fragments, etc.) attached to a Page, Cell, HeaderFooter or FloatingBox.
RowRepresents a row in a table.
RowsA collection of rows in a table.
TableRepresents a table that can be added to a PDF page.
TocInfoTable of contents information for a page.
WebHyperlinkHyperlink that opens an external URL.

Enumerations

EnumerationDescription
BorderCornerStyleCorner-rounding style for a Table’s border box.
BorderSideSpecifies which sides of a border to draw.
ColumnAdjustmentHow a Table sizes its columns (API parity).
ParagraphPositioningModeHow Left / Top are interpreted.
TableBrokenTableBroken enum indicates how a table is split across pages, with values None, Vertical, VerticalInSamePage, and IsInNextPage.

Geometry

ClassDescription
MatrixRepresents a 3x3 transformation matrix [a b 0; c d 0; e f 1].
Matrix3D4×3 affine 3D matrix (Aspose.Pdf shape for PDF 3D camera positioning).
PageSize-PdfStandard page size constants (dimensions in points, portrait orientation).
Point-PdfRepresents a point in 2D space.
Point3DRepresents a point in 3D space (used by 3D annotations).
Rectangle-PdfRepresents a rectangle defined by lower-left and upper-right coordinates (PDF user-space convention: Y increases upward).

Groupprocessor

StructDescription
ObjectKeyIdentifies a PDF indirect object by its object number and generation number.

Helpers

ClassDescription
BoundsCheckableListA list of T that optionally enforces container bounds on insertion.
OptimizedMemoryStreamA growable in-memory stream that can exceed the 2 GB single-array limit of MemoryStream by storing data in fixed-size chunks.
PolygonsHelperPolygon and rectangle geometry utilities — point/polygon containment, segment hit-testing and rectangle/polygon classification.

Enumerations

EnumerationDescription
BoundsCheckModeHow a BoundsCheckableList{T} reacts when an item lies outside its container.
RectanglePositionPosition of a rectangle relative to a polygon, as returned by GetRectanglePositionRelativePolygon.

Html

ClassDescription
CssSavingInfoContext passed to a CssSavingStrategy callback.
CssUrlRequestInfoContext passed to a CssUrlMakingStrategy callback.
HtmlFragmentRepresents an HTML content fragment that can be added to PDF pages via HeaderFooter.Paragraphs or Page.Paragraphs.
HtmlImageSavingInfoContext passed to a per-image saving callback.
HtmlLoadOptionsOptions for loading HTML content into PDF.
HtmlPageMarkupSavingInfoContext passed to a HtmlPageMarkupSavingStrategy callback.
HtmlSaveOptionsOptions for saving a PDF document as HTML.

Enumerations

EnumerationDescription
AntialiasingProcessingTypeAntialiasing pass applied to the resulting HTML.
FontEncodingRulesBacking-byte enum: the Aspose.Pdf reflection signature is byte-typed.
FontSavingModesHow fonts are emitted into the output HTML.
HtmlDocumentTypeHTML document flavour produced by HtmlSaveOptions.
HtmlImageTypeImage type produced for embedded raster content.
HtmlMarkupGenerationModesGranularity of HTML markup produced.
HtmlMediaTypeSpecifies the media type for HTML rendering.
HtmlPageLayoutOptionHow the generated PDF page layout reacts to wide HTML content.
ImageParentTypesContainer element that hosts an image.
LettersPositioningMethodsHow letter positions are encoded in the output CSS.
PartsEmbeddingModesWhether and how secondary parts (CSS / images / fonts) are embedded.
RasterImagesSavingModesHow raster images are saved alongside the HTML.

Interop

ClassDescription
BitmapInfoClass with 2 methods and 4 properties.

Interfaces

InterfaceDescription
IIndexBitmapConverterInterface with 3 methods.

Enumerations

EnumerationDescription
PixelFormatEnum with 6 members.

Io

ClassDescription
ZDeflaterOutputStreamzlib (RFC 1950) deflating output stream — a public helper matching the Aspose.Pdf surface.
ZInflaterInputStreamzlib (RFC 1950) inflating input stream — a public helper matching the Aspose.Pdf surface.

Logicalstructure

ClassDescription
AnnotElementClass with 11 methods and 13 properties.
ArtElementClass with 11 methods and 13 properties.
AttributeNameA typed value for a standard attribute name (the /Name-valued entries in an attribute object, e.g.
BibEntryElementClass with 11 methods and 13 properties.
BlockQuoteElementClass with 11 methods and 13 properties.
CaptionElementClass with 11 methods and 13 properties.
CodeElementClass with 11 methods and 13 properties.
DivElementClass with 11 methods and 13 properties.
DocumentElementThe document root structure element (/S Document).
Element-LogicalStructureCommon base for nodes in the logical-structure tree.
ElementListAn ordered list of structure elements, as returned by ChildElements.
FigureElement-LogicalStructureFigureElement also offers AdjustPosition(settings) to reposition the figure according to layout settings.
FormElementClass with 11 methods and 13 properties.
FormulaElementClass with 12 methods and 17 properties.
HeaderElementClass with 11 methods and 13 properties.
IllustrationElementAbstract base for illustration-kind structure elements (Figure, Formula).
IndexElementClass with 11 methods and 13 properties.
LinkElementClass with 11 methods and 15 properties.
ListElementClass with 11 methods and 13 properties.
ListLBodyElementClass with 11 methods and 13 properties.
ListLIElementClass with 11 methods and 13 properties.
ListLblElementClass with 11 methods and 13 properties.
MCRElementA marked-content reference leaf (role “MCR”) emitted by the auto-tagger to mark where a structure element’s page content lives.
NonStructElementNonStructElement.SetTag(tag) assigns a custom tag to a non‑structural element, influencing its identification in the PDF structure tree.
NoteElementClass with 11 methods and 13 properties.
OBJRElementAn object reference (role “OBJR”) — links a structure element to a PDF object on a page (typically an annotation, e.g.
ParagraphElementParagraphElement provides methods to modify its text, tag, ID, and hierarchical position within a PDF structure.
PartElementClass with 11 methods and 13 properties.
PrivateElementClass with 11 methods and 13 properties.
QuoteElementClass with 11 methods and 13 properties.
ReferenceElementClass with 11 methods and 13 properties.
RubyElementClass with 11 methods and 13 properties.
SectElementSectElement provides methods such as AppendChild, SetTag, SetText, and Remove to build and manipulate structural elements within a PDF document.
SpanElementSpanElement methods such as AppendChild, SetTag, SetText, SetId, AdjustPosition, and ChangeParentElement let developers build and manipulate structured PDF content.
StructTreeRootElementThe /StructTreeRoot wrapper at the top of the logical- structure tree.
StructureAttributeA single tagged-PDF structure attribute (key plus one typed value).
StructureAttributesAn owner-scoped set of StructureAttribute objects attached to a structure element (one PDF attribute dictionary with a fixed /O owner).
StructureElementBase class for tagged-PDF logical-structure elements.
StructureElementAttributesThe attribute manager exposed by Attributes.
StructureTextStateText-state snapshot used to format inline structure-element runs.
StructureTypeA structure-type role (the /S entry value), exposed via S.
TOCElementClass with 11 methods and 13 properties.
TOCIElementClass with 11 methods and 13 properties.
TableElementClass with 14 methods and 31 properties.
TableTBodyElementClass with 12 methods and 13 properties.
TableTDElementTableTDElement.ColSpan and RowSpan properties allow a cell to span multiple columns or rows within a Table.
TableTFootElementClass with 12 methods and 13 properties.
TableTHElementClass with 11 methods and 23 properties.
TableTHeadElementClass with 12 methods and 13 properties.
TableTRElementClass with 13 methods and 23 properties.
WarichuElementClass with 11 methods and 13 properties.

Interfaces

InterfaceDescription
ITextElementA structure element that can carry inline text content (written to the element’s /ActualText entry).

Enumerations

EnumerationDescription
AttributeKeyStandard tagged-PDF attribute keys (ISO 32000-1 §14.8.5).
AttributeOwnerStandardStandard owners of a tagged-PDF attribute set (the /O entry of an attribute object, ISO 32000-1 Table 348).

Navigation

ClassDescription
DestinationArrayOpaque wrapper around a PDF destination array, created by NamedDestination factory methods.
DestinationCollectionNamed-destination collection exposed as IEnumerable<KeyValuePair<string, object>> for Aspose.Pdf parity.
NamedDestinationRepresents a named destination in the document (PDF32000 §12.3.2.3).
NamedDestinationCollectionCollection of named destinations in the document.
OutlineBuilderBuilder for creating bookmarks (outlines) programmatically.
OutlineCollectionClass with 11 methods and 8 properties.
OutlineItemRepresents a bookmark (outline item) in the document outline hierarchy.
OutlineItemBuilderBuilder for a single outline item with fluent API.
OutlineItemCollectionThe document outline (bookmark tree).
OutlinesDocument-level bookmark (outline) collection.
PageLabelRepresents a page label range.
PageLabelBuilderBuilder for creating page labels on a document.
PageLabelCollectionCollection of page label ranges from the /PageLabels number tree.

Enumerations

EnumerationDescription
NumberingStyleNumbering style for page labels.

Optimization

ClassDescription
AutoTaggingSettingsSettings controlling automatic structure-tree generation during conversion.
FontEmbeddingOptionsFont-embedding behaviour during conversion.
HeadingLevelsHeading-level recognition tuning for AutoTaggingSettings.
ImageCompressionOptionsImage-compression sub-options for OptimizationOptions.
OptimizationOptions-OptimizationClass which describes document optimization algorithm.
PdfANonSpecificationFlagsPDF/A non-spec compliance toggles.
PdfASymbolicFontEncodingStrategyStrategy for re-encoding symbolic fonts during PDF/A conversion.
PdfFormatConversionOptionsOptions for converting a PDF document to a specific PDF/A conformance level.
QueueItemOne entry in the priority queue — names a single (platformID, platformSpecificID) cmap subtable.
RgbToDeviceGrayConversionStrategyConverts all RGB color operators and image color spaces on a page to DeviceGray.
ToUnicodeProcessingRulesRules applied when generating ToUnicode CMaps during conversion.

Enumerations

EnumerationDescription
CMapEncodingTableTypeOpenType cmap subtable selector.
ConvertErrorActionAction to take when a conversion error is found.
ConvertSoftMaskActionSoft-mask handling strategy during PDF/A conversion.
ConvertTransparencyActionAction to take when transparency is encountered during PDF/A conversion.
HeadingRecognitionStrategyAlgorithm used to detect headings during auto-tagging.
ImageCompressionVersionStrategy version for image compression.
ImageEncodingHow image streams are re-encoded during optimization.
PdfFormatPDF format/conformance level for validation and conversion.
PuaProcessingStrategyStrategy for processing Private-Use-Area Unicode characters.
RemoveFontsStrategyStrategy for removing or excluding fonts during conversion.
SegmentAlignStrategyStrategy for collapsing adjacent text segments during PDF/A conversion.

Options

ClassDescription
BorderPartStyleClass with 1 method and 1 property.
CompositingParametersImage-blending parameters consumed by Stream, int, float, float, float, float, CompositingParameters).
LayerCollectionRepresents the collection of layers on a specific page.
LayerEntryRepresents a layer being built by OptionalContentBuilder.
LoadOptionsClass with 4 properties.
MarginPartStyleOne side of a MarginInfo: either a fixed PDF-point value or an auto-fit hint.
OptionalContentBuilderCreates optional content groups (layers) in a PDF document.
OptionalContentGroupRepresents an Optional Content Group (layer) in a PDF document.
OptionalContentPropertiesCollection of Optional Content Groups (layers) in a document.
OutputIntentRepresents a PDF OutputIntent entry (PDF32000 §14.11.5).
OutputIntentsCollection of OutputIntent entries on the document catalog’s /OutputIntents array.
PdfSaveOptionsClass with 8 properties.
ProgressEventHandlerInfoClass in the Pdf NET API.
RenderingOptions-PdfRendering options used by the page-to-image converters (PngDevice, JpegDevice, PdfConverter, …).
ResourceLoadingResultClass with 1 method and 1 property.
ResourceSavingInfoClass with 1 property.
SaveOptionsThe SaveOptions class exposes properties such as SaveFormat, CloseResponse, and WarningHandler to control PDF saving behavior.
SvgImageSavingInfoClass with 2 properties.
SvgSaveOptionsSvgSaveOptions provides properties such as SaveFormat to control how a PDF is saved as SVG.
UnifiedSaveOptionsClass with 7 properties.
ViewerPreferencesRepresents the document’s viewer preferences (PDF32000 §12.2).

Enumerations

EnumerationDescription
BlendModePDF blend modes (Table 136 of PDF 32000-1:2008).
DefaultStateDefault visibility state of an Optional Content Group (layer).
HtmlBorderLineTypeEnum with 9 members.
LoadFormatSource format selector used by LoadOptions.
NodeLevelResourceTypeNodeLevelResourceType enum distinguishes between Font and Image resources when working with structural elements.
PageLayoutModePage layout mode for the document (PDF32000 §12.2, Table 28).
PageModeValuePage mode specifying how the document should be displayed on opening (PDF32000 §12.2, Table 28).
ProgressEventTypeConversion-progress milestones reported via EventType.
SaveFormatSave format enumeration.
SvgExternalImageTypeImage format used by the SVG embedded-image saver.

Printing

ClassDescription
CustomPrintEventArgsEvent args raised by PdfViewer.CustomPrint.
PageSettingsPer-page print settings (paper size / orientation / margins).
PaperSizeThe PaperSize class lets developers define custom page dimensions by specifying a name, width, and height.
PdfQueryPageSettingsEventArgsEvent args supplied to PdfViewer.PdfQueryPageSettings.
PrinterSettingsPrinter-side settings (printer name, copies, range).
StartEndPageEventArgsEvent args raised by PdfViewer.StartPage / EndPage.

Security

ClassDescription
BitStringA variable-length bit string supporting bitwise operations, concatenation, substring extraction, and conversion to/from bytes and hex.
CertificateEncryptionOptionsBundles the public certificate used to encrypt a document and the private-key store needed to decrypt it.
EncryptionInfoInformation about a document’s encryption.
EncryptionParametersParameters parsed from the document’s /Encrypt dictionary and passed to Initialize when a custom security handler takes over for an alternative /Filter.
HashAlgorithmFactoryCreates a HashAlgorithm for a DigestHashAlgorithm.
MathExtensionsSmall integer math helpers shared by the security primitives.
PdfCertificateRepresents a certificate + private key for PDF signing.
PdfSignerSigns PDF documents with X.509 certificates using PKCS#7/CMS detached signatures.
Sha3_256SHA3-256 (FIPS 202) — own Keccak implementation.
Sha3_384SHA3-384 (FIPS 202) — own Keccak implementation.
Sha3_512SHA3-512 (FIPS 202) — own Keccak implementation.
SignatureAlgorithmInfoAlgorithm + digest + envelope-standard triple extracted from a PDF signature value.
SignatureAppearanceDefines the visual appearance for a digital signature annotation.
SignatureOptionsOptions for signing a PDF document.
ValidationOptionsTunes the verification policy used by Verify(SignatureName, ValidationOptions, out ValidationResult).
ValidationResultVerification outcome produced by Verify(SignatureName, ValidationOptions, out ValidationResult).

Interfaces

InterfaceDescription
ICustomSecurityHandlerPluggable custom security handler — implement this to handle non-Standard /Filter entries (e.g.

Enumerations

EnumerationDescription
CryptoAlgorithmPDF encryption algorithm.
CryptographicStandardCryptographic envelope standard reported by a PDF signature SubFilter entry.
DigestHashAlgorithmDigest hash algorithm used by a PDF signature (PKCS#7 messageDigest attribute).
SignatureAlgorithmTypeSigning-algorithm family extracted from a signature’s PKCS#7 signatureAlgorithm OID.
ValidationMethodRevocation-check protocol selector used by ValidationMethod.
ValidationModeHow aggressively VerifySignature(string, ValidationOptions, out ValidationResult) reports problems.
ValidationStatusOutcome categories reported by Status.

Shading

ClassDescription
AxialShadingAxial (linear) shading (Type 2, §8.7.4.3).
CoonsPatchShadingCoons patch mesh (Type 6, §8.7.4.5.7).
FreeFormGouraudShadingFree-form Gouraud-shaded triangle mesh (Type 4, §8.7.4.5.5).
FunctionBasedShadingFunction-based shading (Type 1, §8.7.4.2).
LatticeFormGouraudShadingLattice-form Gouraud-shaded triangle mesh (Type 5, §8.7.4.5.6).
PatternAbstract base for all PDF pattern types.
RadialShadingRadial (circular) shading (Type 3, §8.7.4.4).
ShadingBaseAbstract base for all PDF shading types (§8.7.4.1).
ShadingPatternShading pattern (PatternType 2, §8.7.3.2): smooth gradient.
TensorPatchShadingTensor-product patch mesh (Type 7, §8.7.4.5.8).
TilingPatternTiling pattern (PatternType 1, §8.7.3.1): repeating tile.

Enumerations

EnumerationDescription
ShadingTypeShading type — /ShadingType entry.

Stamps

ClassDescription
PageNumberStampA stamp that adds page numbers to PDF pages.
PdfPageStampStamps the content of one PDF page onto another page.
Stamp-StampsBase class for stamps that can be applied to PDF pages.
TextStamp-StampsA text stamp that can be applied to PDF pages.
WatermarkStampA watermark stamp that draws diagonal text across the page.

Structure

ClassDescription
Element-StructureA node in a PDF’s logical-structure tree (the /StructTreeRoot /K subtree, plus their /K descendants).
ElementCollectionA live, mutable collection of structure elements held under a parent’s /K array.
FigureElement-StructureA figure structure element (/S = “Figure”) that wraps a raster or vector picture.
RootElementTop-level wrapper for the PDF /StructTreeRoot dictionary.
StructElementA generic structure element (anything other than the recognised typed subclasses).
TextElementA text-bearing structure element (Span / P / Quote / Note / Reference / BibEntry).

Tagged

ClassDescription
MarkedContentInfoInformation about a marked content sequence, used to wrap content in BDC/EMC operators.
PositionSettingsLayout/position settings for a tagged structure element, passed to AdjustPosition.
StructTreeElementRead-only view of a single structure element in a tagged document’s structure tree: its role, accessibility text, attributes, marked-content references, and child elements.
StructTreeRootRead-only view of a tagged document’s structure-tree root (/StructTreeRoot).
StructureElementBuilderBuilder for creating a structure element with children and marked content.
StructureTreeBuilderBuilds a logical structure tree for a tagged PDF document.
TaggedContentProvides access to tagged PDF metadata (title, language) and the logical structure tree.
TaggedExceptionException thrown when a tagged PDF structure operation violates PDF spec constraints.

Interfaces

InterfaceDescription
ITaggedContentThe author-facing surface for a tagged PDF document.

Text

ClassDescription
AbsorbedCellRepresents a cell in an absorbed table.
AbsorbedRowRepresents a row in an absorbed table.
AbsorbedTableRepresents a table detected on a PDF page.
CharInfoPer-character layout information (glyph rectangle + page position).
CharInfoCollectionCollection of CharInfo entries — supports the public surface used by TextSegment.Characters but stays empty by default.
CustomFontSubstitutionBaseClass with 1 method.
ExternalFontCacheManages the set of folders searched for external (non-embedded) TrueType/OpenType faces during rendering and conversion.
FileFontSourceA font source backed by a single font file on disk.
FolderFontSourceA font source that searches fonts in a specific directory.
FontType alias for FontInfo, matching the Font class name.
FontAbsorberCollects all fonts used in a PDF document or a single page.
FontCollectionCollection of fonts referenced by a page.
FontDataRepresents a font with its name and type.
FontEmbedderEmbeds TrueType fonts into PDF documents for custom text rendering.
FontInfoInformation about a font used in a PDF.
FontRepositoryProvides access to fonts available for use in PDF documents.
FontSourceBase class for font sources.
FontSourceCollectionA collection of font sources used by FontRepository.
FontSubstitutionBase type for font substitutions held in FontSubstitutionCollection.
FontSubstitutionCollectionClass with 9 methods and 3 properties.
FontUtilitiesProvides font management utilities for a document.
MarkupParagraphA paragraph within a markup section.
MarkupSectionA section of text on a page — a spatially coherent group of lines.
MemoryFontSourceA font source backed by an in-memory font byte buffer.
OneBasedListRead-only list with 1-based indexer, matching the public API.
OriginalFontSpecificationClass with 1 method and 3 properties.
PageMarkupRepresents the text markup of a single page, organized into sections.
ParagraphAbsorberAbsorbs text from PDF pages and organizes it into sections and paragraphs.
ParagraphAbsorberOptionsOptions for ParagraphAbsorber controlling section detection thresholds.
PdfFontViewThin engine-font view used by Aspose.Pdf parity (Font.iPdfFont).
PhysicalTextSegmentPhysical (page-space) projection of an absorbed TextSegment.
PositionThe Position class can be used to specify X and Y indents for layout adjustments; its XIndent and YIndent properties are read‑only after construction.
RegexManagerGlobal configuration for regular-expression text search (for example via TextFragmentAbsorber).
SimpleFontSubstitutionClass with 3 methods and 3 properties.
SystemFontSourceA font source that searches the system’s installed fonts.
TabStopRepresents a single tab stop position.
TabStopsA collection of tab stop positions for text layout.
TableAbsorberDetects and extracts tables from PDF pages by analyzing text positions and line drawing operations.
TextAbsorberExtracts text from PDF pages by parsing content streams.
TextBuilderAppends text fragments to a PDF page by registering fonts in the page resources and writing content stream operators.
TextEditOptionsOptions that control how text is edited (replaced, font-substituted, language-transformed).
TextExtractionErrorDiagnostic produced by TextFragmentAbsorber when a page-level extraction fails or partially succeeds.
TextExtractionErrorLocationStructured location of a TextExtractionError within a page’s content stream.
TextExtractionOptionsOptions for text extraction operations.
TextFormattingOptionsRepresents text formatting options for a TextParagraph.
TextFragmentRepresents a fragment of text on a page with position and style information.
TextFragmentAbsorberSearches for text fragments on PDF pages, optionally matching a search phrase.
TextFragmentCollectionA 1-indexed collection of TextFragment objects, matching the public API.
TextFragmentStateFragment-level text formatting state.
TextOptionsBase class for text-processing options.
TextParagraphRepresents a text paragraph that can be placed on a page via AppendParagraph.
TextReplaceOptionsOptions for text replacement operations.
TextReplacerFinds and replaces text in PDF content streams.
TextSearchOptionsOptions for text search operations in PDF documents.
TextSegmentA single segment within a TextFragment.
TextSegmentCollectionA 1-indexed collection of TextSegment objects belonging to a TextFragment.
TextStateText formatting state.

Interfaces

InterfaceDescription
IFontOptionsPer-font runtime options (currently only the font-embedding error toggle).

Enumerations

EnumerationDescription
ClippingPathsProcessingModeHow clipping paths are processed when text edits affect clipped regions.
CoordinateOriginHow the lowest Y coordinate of a text fragment is interpreted in positioning APIs (CoordinateOrigin and per-segment SetPosition overloads).
FontReplaceFont-replacement strategy when the original font cannot encode replacement text.
FontSizeAdjustmentFont size adjustment strategy when replaced text has a different size.
FontStylesRepresents a position on a page.
FontSubsetStrategyStrategy for font subsetting when saving a document.
FontTypeFont type classification.
FontTypesStream-loadable font formats accepted by Stream, FontTypes).
LanguageTransformationLanguage transformation behavior (RTL, ligatures, etc).
LineSpacingModeHow line spacing is interpreted (font-derived vs full glyph extent).
NoCharacterAction-TextAction to perform if font does not contain required character.
ReplaceAdjustmentSpecifies how text replacement adjustments are handled.
Scope-TextReplace-scope selector (canonical screaming-snake naming).
TabAlignmentTypeTab alignment type for tab stops.
TabLeaderTypeTab leader character type.
TextFormattingModeSpecifies how extracted text is formatted.
TextRenderingModePDF text rendering mode (Tr operator).
WordWrapMode-TextWord wrap mode that controls how text wraps within a paragraph rectangle.

Vector

ClassDescription
GraphicElementSingle vector-graphics element (path segment, image, text run) extracted from a PDF content stream.
GraphicElementCollectionMutable collection of GraphicElement entries.
GraphicsAbsorberExtracts the painted vector sub-paths of a page as SubPath elements, each carrying its page-space bounding Rectangle.
SubPathA single painted sub-path extracted from a content stream: its construction operators (in their original user-space coordinates), the CTM in effect when it was drawn, and the painting operator that closed it.
XFormPlacementClass in the Pdf NET API.

Xmp

ClassDescription
MetadataXMP metadata accessor exposed by per-resource members such as Metadata.
XmpFieldOne named XMP field — a (prefix, local-name) pair plus a typed value.
XmpMetadataProvides access to XMP metadata embedded in the PDF.
XmpPacketContainerThe XMP packet exposed by getData; its WorkingPacket yields the live RDF/XML.
XmpPdfAExtensionFieldOne field of a PDF/A XMP-extension structured value type.
XmpPdfAExtensionObjectOne PDF/A XMP-extension property/value pair.
XmpPdfAExtensionPropertyOne PDF/A XMP-extension property declaration (name, value, value type, category, description).
XmpPdfAExtensionSchemaOne PDF/A XMP-extension schema, holding a description and its associated XmpPdfAExtensionObjects.
XmpPdfAExtensionSchemaDescriptionHuman-readable description of a PDF/A XMP extension schema.
XmpPdfAExtensionValueTypeOne PDF/A XMP-extension structured value type, holding its fields.
XmpValueRepresents a typed XMP metadata value.
XmpWorkingPacketA working XMP packet; GetXml returns the packet’s RDF/XML with rdf:RDF as the document element so callers can XPath into it.

Enumerations

EnumerationDescription
XmpFieldTypeXMP field categories (matches the Aspose.Pdf reflection signature exactly — the underlying integer values are not load-bearing because callers compare against the named members).
XmpPdfAExtensionCategoryTypeWhether a PDF/A XMP-extension property is for external (publicly visible) or internal (private) use.

See Also

 English