Aspose.PDF FOSS for C++

API reference for Aspose.PDF FOSS for C++ v1.0.1. 245 public types organized by module.

Aspose

Class	Description
`AlignmentType`	Class with 4 methods.
`Annotation`	Class with 36 methods.
`AnnotationCollection`	Class with 11 methods.
`AnnotationSelector`	Class with 35 methods and 1 property.
`Artifact`	Class with 14 methods.
`ArtifactCollection`	Class with 7 methods and 1 property.
`BarcodeField`	Class with 6 methods.
`BaseParagraph`	Class with 23 methods and 1 property.
`BitmapInfo`	BitmapInfo enables creation of raw bitmap images with specified pixel format, width, height, and pixel data, supporting image handling without external dependencies.
`BleedMarkAnnotation`	BleedMarkAnnotation.Accept(visitor) implements the visitor pattern, allowing external visitor objects to process the annotation without exposing its internal structure.
`BmpDevice`	Class with 1 method.
`Bookmark`	Class with 35 methods.
`Bookmarks`	Bookmarks can be organized hierarchically; use Bookmark.ChildItem() or Bookmark.ChildItems() to access nested Bookmarks and set properties such as Action, Destination, and display flags like BoldFlag and ItalicFlag.
`Border`	Border appearance can be customized by setting its Width, Style, Effect, EffectIntensity, and corner radii via the Border class methods.
`BorderInfo`	BorderInfo provides getters and setters for each side’s GraphInfo via Left(), Right(), Top(), Bottom() and a RoundedBorderRadius property for rounded corners.
`ButtonField`	Class with 11 methods.
`CaretAnnotation`	Class with 5 methods.
`Cell`	Class with 27 methods.
`Cells`	Class with 9 methods.
`Characteristics`	Class with 3 methods.
`CheckboxField`	CheckboxField enables creation of interactive check‑box form fields, with methods to set style, active state, checked flag, and export value.
`ChoiceField`	Class with 14 methods.
`Circle`	Class with 7 methods.
`CircleAnnotation`	CircleAnnotation lets developers add circular annotation objects to a PDF page and process them via the visitor pattern.
`Color`	The Color class offers a full set of predefined color factories (e.g., Color::Blue(), Color::Black()) and methods to create custom colors from ARGB or RGB components, enabling consistent color handling in PDF content.
`ColorBarAnnotation`	Class with 3 methods.
`ComboBoxField`	Class with 5 methods.
`CommonFigureAnnotation`	CommonFigureAnnotation lets developers define figure annotations by setting an interior colour and a rectangular frame.
`CornerPrinterMarkAnnotation`	Class with 2 methods.
`DateField`	Class with 4 methods.
`DefaultAppearance`	Class with 8 methods.
`Device`	The Device base class provides a virtual destructor, ensuring proper cleanup of derived raster‑device objects such as PngDevice or JpegDevice.
`DocMDPSignature`	Class with 1 method.
`Document`	Document metadata can be read via `Document.Info()` and the accessor methods `Title()`, `Author()`, `Creator()`, `Producer()`, `Subject()`, and `Keywords()`.
`DocumentDevice`	Class with 4 methods.
`DocumentInfo`	Class with 24 methods and 1 property.
`DocumentPrivilege`	DocumentPrivilege lets developers query and modify PDF permission flags such as printing, copying, and form filling.
`Ellipse`	Class with 9 methods.
`EmbeddedFileCollection`	EmbeddedFileCollection provides Count() to retrieve the total number of embedded files and Keys() to obtain a list of their identifiers.
`Encoding`	Encoding enum lists the standard PDF character encodings that can be selected for text extraction and output.
`ExplicitDestination`	Class with 3 methods.
`ExternalSignature`	Class in the Pdf CPP API.
`Facade`	Facade.BindPdf overloads accept either a file path string (srcFile) or an existing Aspose::Pdf::Document (srcDoc) to load PDF content.
`Field`	Field.Recalculate() recomputes the value of a form field and returns true on success.
`FileAttachmentAnnotation`	FileAttachmentAnnotation.File() gets or sets the attached file via a FileSpecification object, allowing embedding of external resources in a PDF.
`FileSelectBoxField`	Class with 1 method.
`FileSpecification`	FileSpecification objects allow setting metadata for embedded files, including MIME type, description, Unicode name, and compression via the Encoding property.
`FitBExplicitDestination`	Class with 1 method.
`FitBHExplicitDestination`	Class with 2 methods.
`FitBVExplicitDestination`	Class with 2 methods.
`FitExplicitDestination`	Class with 1 method.
`FitHExplicitDestination`	Class with 2 methods.
`FitRExplicitDestination`	Class with 5 methods.
`FitVExplicitDestination`	Class with 2 methods.
`FloatingBox`	FloatingBox.Width() returns the current width of the box as a double, and FloatingBox.Width(value) sets a new width.
`Font`	The Font class lets developers query whether a font is embedded in the PDF and whether it is subsetted, enabling compliance checks for PDF/A.
`FontRepository`	Class with 2 methods.
`Form`	Form text box fields can have a barcode added programmatically by calling `AddBarcode(code)` on a `TextBoxField` instance.
`FormEditor`	FormEditor class allows programmatic creation, modification, and removal of AcroForm fields within a PDF document.
`FormFieldFacade`	Class with 30 methods and 26 properties.
`FreeTextAnnotation`	Class with 23 methods.
`GoToAction`	Class with 4 methods.
`GoToURIAction`	Class with 4 methods.
`Graph`	Class with 16 methods.
`GraphInfo`	GraphInfo class encapsulates drawing attributes such as line width, colour, dash pattern, and geometric transformations for vector graphics.
`HighlightAnnotation`	Class with 1 method.
`Hyperlink`	Class with 6 methods and 1 property.
`IconFit`	IconFit allows fine‑grained control of form field scaling; developers can set ScalingReason, ScalingMode, and leftover margins before rendering.
`ImageDevice`	ImageDevice.GetBitmap(page) returns a BitmapInfo object that contains the rasterised image of the specified page.
`InkAnnotation`	InkAnnotation represents free‑hand ink strokes; its InkList property holds a StrokeList that can be read or replaced.
`JavascriptAction`	JavascriptAction encapsulates a JavaScript snippet attached to PDF objects; the script can be retrieved or updated via Script() getter/setter.
`JpegDevice`	Class with 1 method.
`Line`	Class with 3 methods.
`LineAnnotation`	Class with 25 methods.
`LinkAnnotation`	LinkAnnotation enables clickable areas in a PDF that can trigger a PdfAction or navigate to a named destination.
`ListBoxField`	Class with 3 methods.
`LoadOptions`	Class with 3 methods.
`MarginInfo`	MarginInfo allows precise control of page margins with double-precision getters and setters for left, right, top, and bottom values.
`Margins`	Margins provides getters and setters for the four page margin values (Left, Right, Top, Bottom).
`MarkupAnnotation`	MarkupAnnotation provides methods to set review state, opacity, title, and rich text for comment‑type annotations.
`Metadata`	Metadata class implements a dictionary-like interface with Add(key, value), Remove(key), and TryGetValue(key, value) for managing XMP metadata entries.
`MovieAnnotation`	MovieAnnotation lets you embed a video file in a PDF, with properties for title, poster flag, aspect ratio, and rotation.
`NamedAction`	Class with 3 methods.
`NamedDestination`	NamedDestination provides Name() to obtain the destination’s string identifier and ToString() for a human‑readable representation.
`NamedDestinationCollection`	Class with 6 methods and 1 property.
`NumberField`	Class with 3 methods.
`Option`	Class with 8 methods.
`OptionCollection`	Class with 9 methods.
`OutlineCollection`	OutlineCollection represents the document’s bookmark tree, enabling hierarchical navigation of PDF content.
`OutlineItemCollection`	Class with 18 methods.
`Outlines`	Class with 12 methods.
`PKCS1`	Class with 1 method.
`PKCS7`	Class with 1 method.
`PKCS7Detached`	Class with 1 method.
`Page`	Page labels (e.g., Roman numerals, custom prefixes) are managed through PageLabel and PageLabelCollection classes.
`PageCollection`	The PageCollection class provides methods to add a new blank page, insert a page at a specific position, and delete pages by number or range.
`PageDevice`	PageDevice.Process(page, outputFileName) can render a page directly to a file path.
`PageInformationAnnotation`	Class with 1 method.
`PageLabel`	PageLabel.StartingValue() gets or sets the numeric start for a page label sequence.
`PageLabelCollection`	PageLabelCollection.GetLabel(pageIndex) retrieves the PageLabel assigned to a specific page.
`PageSize`	PageSize.Width() and Height() get or set the page dimensions, while IsLandscape() indicates orientation.
`Paragraphs`	Paragraphs.Add(paragraph) inserts a new paragraph at the end of a collection, while Insert(index, paragraph) inserts a paragraph at a specific position.
`PasswordBoxField`	PasswordBoxField can be instantiated with its default constructor to create a password input field for PDF forms.
`PdfAction`	PdfAction.GetECMAScriptString() returns the JavaScript code attached to a PDF action, enabling inspection or modification of interactive scripts.
`PdfAnnotationEditor`	PdfAnnotationEditor can import annotations from FDF or XFDF files and flatten them into the page content, removing interactive elements.
`PdfBookmarkEditor`	PdfBookmarkEditor.CreateBookmarkOfPage(title, pageNumber) adds a new bookmark that points to the specified page.
`PdfContentEditor`	PdfContentEditor.ReplaceText(srcText, destText) searches the entire document and replaces matching strings, returning true when at least one replacement occurs.
`PdfConverter`	The PdfConverter class enables developers to rasterize PDF pages into multi‑page TIFF images using a single method call.
`PdfExtractor`	PdfExtractor extracts text by calling ExtractText() and then GetText(outputFile) to write the extracted plain‑text to a file.
`PdfFileEditor`	PdfFileEditor offers high‑level file manipulation operations such as concatenation, splitting, and page extraction without requiring a full Document load.
`PdfFileInfo`	PdfFileInfo provides getters and setters for standard metadata fields such as Author, Creator, and custom keys via GetMetaInfo(name) and SetMetaInfo(name, value).
`PdfFileSecurity`	Class with 20 methods.
`PdfFileSignature`	Class with 41 methods.
`PdfFileStamp`	Class with 26 methods and 8 properties.
`PdfPageEditor`	Class with 28 methods and 16 properties.
`PdfXmpMetadata`	Class with 15 methods.
`PngDevice`	Class with 3 methods.
`Point`	Point.X() and Point.Y() retrieve the X and Y coordinates of a point, while the overloads set new coordinate values.
`PolyAnnotation`	Class with 11 methods.
`PolygonAnnotation`	Class with 1 method.
`PolylineAnnotation`	PolylineAnnotation.Accept(visitor) enables a visitor object to process the annotation according to the Visitor pattern.
`PopupAnnotation`	Class with 5 methods.
`Position`	The Position class provides XIndent and YIndent getters and setters to fine‑tune the horizontal and vertical offset of annotations.
`PrinterMarkAnnotation`	PrinterMarkAnnotation can insert printer marks such as trim, bleed, registration, or colour bars into an entire document or a single page via AddPrinterMarks.
`RadioButtonField`	Class with 7 methods.
`RadioButtonOptionField`	RadioButtonOptionField represents a single option in a radio‑button group, exposing OptionName() and Style() accessors.
`Rectangle-Aspose_Pdf_Drawing`	Class with 11 methods.
`Rectangle-Aspose_Pdf`	Class with 28 methods.
`RedactionAnnotation`	RedactionAnnotation lets you permanently remove content while optionally overlaying custom text, fill colour, border colour and font size.
`RegistrationMarkAnnotation`	Class with 3 methods.
`RenderingOptions`	Class with 26 methods.
`Resolution`	Resolution stores horizontal and vertical DPI via X() and Y() getters and setters.
`Resources`	Class with 3 methods and 1 property.
`RichMediaAnnotation`	RichMediaAnnotation enables embedding of Flash or other rich media with activation events and custom variables.
`RichTextBoxField`	RichTextBoxField provides a form field that stores rich text with styling, justification, and formatted value.
`Row`	Class with 23 methods.
`Rows`	Rows and Row classes provide a table model for building PDF tables with per‑cell styling, borders, and padding.
`SaveableFacade`	SaveableFacade offers a simple interface to persist PDF objects to a file path via Save(destFile).
`ScreenAnnotation`	ScreenAnnotation allows getting and setting the annotation title through Title() getter and Title(value) setter.
`Shape`	Shape represents vector graphics and offers a GraphInfo property for low‑level shape data and a CheckBounds method to verify fitting within a container.
`Signature`	Signature objects allow creation and verification of detached PKCS#7 signatures on PDF documents.
`SignatureCustomAppearance`	SignatureCustomAppearance lets developers customize the visual appearance of a digital signature, including foreground image flag, font family, font size, foreground and background colors, and visibility of contact info, reason, and location.
`SignatureField`	Class with 2 methods.
`SignatureName`	SignatureName.HasSignature() returns true if the PDF contains a detached PKCS#7 signature, and ToString() provides a textual representation of the signature name.
`SoundAnnotation`	Class with 3 methods.
`SquareAnnotation`	Class with 1 method.
`SquigglyAnnotation`	Class with 1 method.
`StampAnnotation`	Class with 5 methods.
`StrikeOutAnnotation`	Class with 1 method.
`SubmitFormAction`	Class with 5 methods.
`SvgLoadOptions`	SvgLoadOptions allows SVG files to be imported with optional page‑size adjustment via the AdjustPageSize property.
`Table`	The Table class lets developers construct PDF tables with full control over rows, column widths, borders, cell padding, and default text state.
`TextAbsorber`	Class with 6 methods and 1 property.
`TextAnnotation`	TextAnnotation supports opening a sticky‑note annotation with Open() and setting its icon via Icon() and Icon(value).
`TextBoxField`	Class with 15 methods.
`TextBuilder`	Class with 2 methods.
`TextDevice`	TextDevice lets developers set the character encoding used during text extraction via SetEncoding(encoding) and retrieve the current encoding with GetEncoding().
`TextFragment`	Class with 7 methods.
`TextFragmentAbsorber`	TextFragmentAbsorber extracts positioned text fragments together with font, size, and colour information.
`TextFragmentCollection`	Class with 2 methods.
`TextFragmentState`	Class with 1 method.
`TextMarkupAnnotation`	Class with 4 methods.
`TextParagraph`	Class with 18 methods.
`TextState`	The TextState class provides getters and setters for font, font size, foreground/background/stroking colors, and text decorations such as underline, strike‑out, subscript, and superscript.
`TextStyle`	Class with 9 methods.
`TiffDevice`	Class with 11 methods.
`TiffSettings`	Class with 13 methods.
`TrimMarkAnnotation`	TrimMarkAnnotation and UnderlineAnnotation both support the visitor pattern via an Accept method that forwards the annotation to a visitor object.
`UnderlineAnnotation`	Class with 1 method.
`VerticalAlignmentType`	VerticalAlignmentType offers static factory methods Top(), Center(), and Bottom() to obtain alignment objects, and ToString() to obtain their textual representation.
`WatermarkAnnotation`	WatermarkAnnotation enables adding a visual watermark to a PDF page and lets developers control its transparency.
`WatermarkArtifact`	Class in the Pdf CPP API.
`WidgetAnnotation`	WidgetAnnotation provides access to AcroForm field attributes such as ReadOnly, Required, Exportable, and DefaultAppearance.
`XFA`	XFA provides access to XML‑based XFA form data; calling FieldNames() yields a list of all field identifiers present in the XFA document.
`XImage`	XImage exposes the pixel dimensions of an image via Width() and Height() methods.
`XImageCollection`	XImageCollection manages multiple XImage objects, providing Add, Replace, Delete, and Clear operations.
`XYZExplicitDestination`	XYZExplicitDestination supplies the three components of a PDF destination: Left(), Top(), and Zoom(), each returning a double value.
`XmpValue`	XmpValue offers conversion helpers such as ToString(), ToInteger(), ToDouble(), and ToArray() to retrieve typed XMP metadata values.

Enumerations

Enumeration	Description
`AFRelationship`	AFRelationship enum values (Source, Data, Alternative, Supplement, Unspecified, EncryptedPayload, None) allow developers to specify the nature of an embedded file relationship within a PDF.
`Algorithm`	Enum with 2 members.
`AnnotationFlags`	AnnotationFlags enum includes a Locked flag that, when set, prevents further modifications to the annotation’s properties.
`AnnotationState`	AnnotationState enum defines the possible lifecycle states of an annotation, including Marked, Unmarked, Accepted, Rejected, Cancelled, Completed, and None.
`AnnotationStateModel`	Enum with 3 members.
`AnnotationType`	Enum with 33 members.
`AutoRotateMode`	The AutoRotateMode enum lets developers specify how pages should be automatically rotated during rendering, with options None, ClockWise, and AntiClockWise.
`BlendingColorSpace`	BlendingColorSpace enum lets developers choose how colour values are blended when rendering PDF content, offering options such as Auto, DeviceRGB, and DeviceCMYK.
`BorderEffect`	BorderEffect enum provides visual border styles, with values None and Cloudy, for use in annotation appearance.
`BorderSide`	Enum with 7 members.
`BorderStyle`	BorderStyle enum provides five visual styles (Solid, Dashed, Beveled, Inset, Underline) for drawing annotation borders.
`BoxStyle`	Enum with 6 members.
`CapStyle`	Enum with 2 members.
`CaptionPosition`	Enum with 2 members.
`CaretSymbol`	CaretSymbol enum (None, Paragraph) specifies whether a caret is rendered as a simple marker or as a paragraph break during text extraction.
`ColorDepth`	Enum with 5 members.
`ColorsOfCMYK`	Enum with 4 members.
`CompressionType`	CompressionType enum lists the image compression algorithms (LZW, CCITT4, CCITT3, RLE, None) that the library can apply to PDF streams.
`CryptoAlgorithm`	Enum with 4 members.
`DataType`	Enum with 6 members.
`DefaultMetadataProperties`	DefaultMetadataProperties enum enumerates the standard metadata fields (Advisory, BaseURL, CreateDate, CreatorTool, Identifier, MetadataDate, ModifyDate, Nickname, Thumbnails) that can be accessed via the library’s metadata API.
`DocMDPAccessPermissions`	The DocMDPAccessPermissions enum defines the allowed modifications on a signed PDF: NoChanges prevents any edits, FillingInForms allows form filling, and AnnotationModification permits annotation changes.
`EncodingType`	Enum with 7 members.
`ExplicitDestinationType`	Enum with 8 members.
`FieldType`	FieldType enum defines the supported AcroForm field types such as Text, CheckBox, Radio, and Signature, allowing developers to create appropriate form fields in PDFs.
`FileEncoding`	Enum with 2 members.
`FileIcon`	Enum with 4 members.
`FontStyle`	FontStyle enum enumerates the standard 14 PDF fonts and their common styles, enabling selection of Courier, Helvetica, TimesRoman, Symbol, and their bold/oblique variants.
`FormPresentationMode`	Enum with 2 members.
`FormType`	Enum with 3 members.
`FreeTextIntent`	Enum with 4 members.
`HighlightingMode`	HighlightingMode enum defines visual styles for text‑highlight annotations, including None, Invert, Outline, Push, and Toggle.
`HorizontalAlignment`	Enum with 6 members.
`IconCaptionPosition`	Enum with 7 members.
`ImageMergeMode`	ImageMergeMode enum allows merging multiple images vertically, horizontally, or centering them when composing a single output.
`Justification`	Enum with 3 members.
`KeySize`	KeySize enum defines the supported encryption key lengths (40, 128, 256 bits) for PDF security operations.
`LineEnding`	Enum with 10 members.
`LineIntent`	LineIntent enum distinguishes between undefined lines, arrowed lines, and dimension lines for line annotations.
`NumberingStyle`	Enum with 6 members.
`PageCoordinateType`	PageCoordinateType enum values MediaBox and CropBox let developers choose which page rectangle is used for coordinate calculations.
`PasswordType`	Enum with 4 members.
`PdfFormat`	Enum with 27 members.
`Permissions`	Enum with 8 members.
`PolyIntent`	Enum with 4 members.
`PositioningMode`	Enum with 3 members.
`PredefinedAction`	Enum with 71 members.
`PrinterMarkCornerPosition`	Enum with 4 members.
`PrinterMarkSidePosition`	Enum with 4 members.
`PrinterMarksKind`	Enum with 7 members.
`PropertyFlag`	PropertyFlag enum defines the bit flags ReadOnly, Required, NoExport, and InvalidFlag for use with form‑field property settings.
`ReplyType`	ReplyType enum distinguishes between Reply, Group, and Undefined reply categories.
`RichTextFontStyles`	Enum with 4 members.
`Rotation`	Rotation enum provides four orientation values: None, on90, on180, on270.
`ScalingMode`	ScalingMode enum defines Proportional and Anamorphic scaling options for image transformations.
`ScalingReason`	ScalingReason enum indicates when scaling should be applied: Always, IconIsBigger, IconIsSmaller, or Never.
`ShapeType`	ShapeType enum (None, Landscape, Portrait) indicates the orientation of vector shapes when they are added to a PDF page.
`SoundIcon`	Enum with 2 members.
`StampIcon`	Enum with 14 members.
`StampType`	Enum with 2 members.
`SubjectNameElements`	Enum with 7 members.
`SubmitFormFlag`	Enum with 6 members.
`Symbology`	Enum with 3 members.
`TextAlignment`	TextAlignment enum provides Left, Center, and Right values for horizontal text alignment within a Cell.
`TextIcon`	TextIcon enum supplies a set of standard glyph identifiers (e.g., Note, Comment, Key) that can be used to specify the visual icon for a text annotation.
`VerticalAlignment`	Enum with 4 members.
`WordWrapMode`	WordWrapMode enum defines two text wrapping strategies: Default and ByWords.

Aspose.PDF FOSS for C++

Aspose

Enumerations

See Also