Aspose.PDF FOSS for Go
API reference for Aspose.Pdf FOSS for Go. 206 public types organized by module.
Core API
| Class | Description |
|---|---|
AIClient | AIClient is the contract every copilot consumes: one call, one chat completion. |
APIError | APIError is returned when the AI endpoint answers with a non-2xx status. |
Action | Action is the common interface implemented by every concrete action type. |
ActionType | ActionType identifies the kind of action attached to an annotation (typically a LinkAnnotation’s /A entry). |
Annotation | Annotation is the common interface implemented by every concrete annotation type. |
AnnotationCollection | AnnotationCollection is the live, ordered set of annotations attached to a single page. |
AnnotationType | AnnotationType identifies the kind of annotation. |
BmpDevice | BmpDevice renders a page to BMP. |
BookletBinding | BookletBinding selects the binding edge of a booklet. |
BookletOptions | BookletOptions configures Booklet imposition. |
BorderEffect | BorderEffect controls the /BE/S entry per ISO 32000-1 §12.5.4 Table 167. |
BorderInfo | BorderInfo describes a border drawn around a table or cell. |
BorderSide | BorderSide is a bitmask selecting which sides of a rectangular border are drawn. |
BorderStyle | BorderStyle controls the /BS dict for drawing annotations per ISO 32000-1 §12.5.4 Table 168. |
ButtonAppearance | ButtonAppearance configures a push button’s rich appearance: separate captions for the normal / rollover / down states, an optional icon image, and face/border/text colours. |
ButtonField | ButtonField is a push button — action only, no value semantics. |
ButtonIconPosition | ButtonIconPosition controls how a push button lays out its icon and caption — the /MK /TP entry per ISO 32000-1 §12.5.6.19 Table 189. |
CaretAnnotation | CaretAnnotation marks a point of text insertion or deletion, drawn as an upward caret ("^") filled with the annotation colour. |
CaretSymbol | CaretSymbol is the /Sy entry of a Caret annotation per ISO 32000-1 §12.5.6.11 Table 180 — an optional symbol drawn together with the caret to associate it with an editing action. |
Cell | Cell is a single cell within a Row. |
CertifyPermission | CertifyPermission is the DocMDP permission level of a certification signature (ISO 32000-1 §12.8.2.2 Table 254). |
ChatCopilot | ChatCopilot answers questions about a document, keeping conversation history. |
ChatOptions | ChatOptions configures a ChatCopilot. |
CheckboxField | CheckboxField is a checkbox with on/off state. |
ChoiceOption | ChoiceOption is one option of a ComboBoxField or ListBoxField. |
CircleAnnotation | CircleAnnotation draws an elliptical annotation. |
Color | Color represents an RGBA color with values in [0, 1]. |
ComboBoxField | ComboBoxField is a single-select dropdown choice field. |
CompletionRequest | CompletionRequest describes one chat-completion call. |
CompletionResponse | CompletionResponse is the model’s reply. |
DateField | DateField is a text field with a JavaScript date-format action and a format mask (e.g. |
Destination | Destination is the common interface for all explicit destinations. |
DestinationFit | DestinationFit — [page /Fit]. |
DestinationFitB | DestinationFitB — [page /FitB]. |
DestinationFitBH | DestinationFitBH — [page /FitBH top]. |
DestinationFitBV | DestinationFitBV — [page /FitBV left]. |
DestinationFitH | DestinationFitH — [page /FitH top]. |
DestinationFitR | DestinationFitR — [page /FitR left bottom right top]. |
DestinationFitV | DestinationFitV — [page /FitV left]. |
DestinationType | DestinationType identifies the destination flavor. |
DestinationXYZ | DestinationXYZ — [page /XYZ left top zoom]. |
Document | Document is a PDF document. |
DocumentInfo | DocumentInfo contains document information from the PDF Info dictionary. |
EmbeddedFile | EmbeddedFile is one attachment: a /Filespec dictionary with an embedded stream. |
EmbeddedFiles | EmbeddedFiles is the document’s collection of attached (embedded) files — the /Catalog/Names/EmbeddedFiles name tree (ISO 32000-1 §7.11.4). |
EncryptionAlgorithm | EncryptionAlgorithm selects the cipher and security-handler revision used by (*Document).SetEncryption. |
EncryptionOptions | EncryptionOptions bundles every knob that controls how a document is encrypted when saved. |
Field | Field is the common interface implemented by every concrete form field type (TextBoxField, CheckboxField, RadioButtonField, etc.). |
FieldStyle | FieldStyle is the visual styling applied to a form field’s widget(s). |
FigureAlt | FigureAlt is a /Figure structure element that has no alternate text, paired with the image it brackets (when resolvable). |
FileAttachmentAnnotation | FileAttachmentAnnotation embeds a file in the document and shows an icon at the annotation’s /Rect. |
FileAttachmentIcon | FileAttachmentIcon names per ISO 32000-1 §12.5.6.15 Table 178. |
FileSelectBoxField | FileSelectBoxField is a text field whose value is a file path (FileSelect flag), used to attach a local file on submit. |
FloatSide | FloatSide selects which edge a floated box hugs while text wraps around it. |
FloatingBox | FloatingBox is a positioned content container (Tier 2 of the flow model): a box with an optional border, background and padding that lays its own content (paragraphs, headings, images, lists) inside its width. |
Flow | Flow is a document generator that lays content out top-to-bottom and paginates automatically — the “flow” counterpart to the Rectangle-based drawing API. |
FlowOptions | FlowOptions configures a Flow. |
Font | Font is implemented by standard 14 fonts and embedded TTF fonts. |
Form | Form is the document’s AcroForm view. |
FormFieldType | FormFieldType identifies the kind of form field. |
FreeTextAnnotation | FreeTextAnnotation displays text directly on the page, rendered into /AP/N using an embedded font. |
FreeTextIntent | FreeTextIntent per ISO 32000-1 §12.5.6.6 /IT entry. |
GenericAnnotation | GenericAnnotation is the catch-all surface for /Subtype values this release does not yet model (Stamp, FreeText, Ink, etc.). |
GifDevice | GifDevice renders a page to GIF. |
GoToAction | GoToAction navigates to a page within the same document. |
GoToURIAction | GoToURIAction opens a URI in the user’s default handler (typically a web browser). |
Gradient | Gradient is a fill that varies colour across a shape: either a LinearGradient or a RadialGradient. |
GradientStop | GradientStop is one colour stop in a gradient, positioned at Offset (0 at the gradient’s start, 1 at its end). |
HAlign | HAlign specifies horizontal text alignment within a rectangle. |
HTMLMode | HTMLMode selects how SaveHTML / WriteHTML represents page text. |
HTMLSaveOptions | HTMLSaveOptions configures SaveHTML / WriteHTML. |
HighlightAnnotation | HighlightAnnotation marks a region with semi-transparent highlight color. |
Image | Image holds an extracted image with its encoded data and metadata. |
ImageColorSpace | ImageColorSpace describes the original color space of the image in the PDF. |
ImageDescriptionCopilot | ImageDescriptionCopilot describes images with a vision model. |
ImageDescriptionOptions | ImageDescriptionOptions configures an ImageDescriptionCopilot. |
ImageFormat | ImageFormat describes the output format of an extracted image. |
ImageInfo | ImageInfo holds metadata about an image found on a page without decoding pixel data. |
ImageStamp | ImageStamp overlays a raster image (PNG or JPEG), stretched to fill Rect. |
ImageToDocumentOptions | ImageToDocumentOptions controls page sizing for ImageToDocument. |
InkAnnotation | InkAnnotation draws a series of free-form strokes — typically used to represent handwritten ink. |
JSONExportOptions | JSONExportOptions controls (*Form).ExportJSON / WriteJSON. |
JavaScriptAction | JavaScriptAction holds a JavaScript snippet attached to an annotation. |
JavaScriptCollection | JavaScriptCollection is the document-level JavaScript store, backed by the /Catalog/Names/JavaScript name tree (ISO 32000-1 §7.7.4 / §8.5.1). |
JpegDevice | JpegDevice renders a page to JPEG. |
LLMOCREngine | LLMOCREngine recognizes text by sending the page image to a vision-capable chat model. |
LLMOCROptions | LLMOCROptions configures the vision-model OCR engine. |
Layer | Layer is one Optional Content Group (OCG) in the document. |
LineAnnotation | LineAnnotation draws a straight line between two points, with optional line endings on each end (arrows, circles, etc. |
LineCap | LineCap is the /J line cap style per ISO 32000-1 §8.4.3.3 Table 54. |
LineEndingStyle | LineEndingStyle is one of the 10 line-ending shapes per ISO 32000-1 §12.5.6.7 Table 176, used in /Line annotations’ /LE entry. |
LineJoin | LineJoin is the /j line join style per ISO 32000-1 §8.4.3.4 Table 55. |
LineStyle | LineStyle describes how a stroked path is drawn. |
LinearGradient | LinearGradient interpolates colour along the line from (X1, Y1) to (X2, Y2). |
LinkAnnotation | LinkAnnotation is a clickable region. |
LinkHighlightMode | LinkHighlightMode controls the visual feedback when the link is activated by the user (the /H entry per ISO 32000-1 §12.5.6.5). |
ListBoxField | ListBoxField is a single- or multi-select list choice field. |
MarginInfo | MarginInfo describes margins or padding in points: Top / Right / Bottom / Left. |
MarkdownOptions | MarkdownOptions configures Markdown rendering. |
MarkdownSaveOptions | MarkdownSaveOptions configures SaveMarkdown / WriteMarkdown. |
MarkupParagraph | MarkupParagraph is a run of consecutive lines forming one paragraph. |
MarkupSection | MarkupSection is a column of paragraphs (left-to-right across the page). |
Message | Message is a single chat message. |
MessageImage | MessageImage is an inline image attached to a message, sent as a base64 data: URL. |
NUpOptions | NUpOptions configures NUp imposition. |
NUpOrder | NUpOrder controls the order in which source pages fill the grid cells of an N-up sheet. |
NamedAction | NamedAction triggers a built-in viewer command (FirstPage, Print, …). |
NamedActionType | NamedActionType identifies one of the standard viewer commands supported by /Named actions per ISO 32000-1 §12.6.4.11. |
NamedDestination | NamedDestination wraps a name reference into the document’s NamedDestinations collection. |
NamedDestinations | NamedDestinations is a name-to-destination map per ISO 32000-1 §12.3.2.3. |
NumberField | NumberField is a text field with a JavaScript number-format action, so viewers display and validate the value as a formatted number. |
NumberFormatOptions | NumberFormatOptions configures a NumberField’s display formatting (maps to Acrobat’s AFNumber_Format). |
OCRBox | OCRBox is a rectangle in image pixel space: origin at the top-left corner, Y increasing downward (the usual raster convention — distinct from PDF user space on purpose). |
OCREngine | OCREngine recognizes text on one page image. |
OCRLine | OCRLine is one physical text line. |
OCRResult | OCRResult is the recognized content of one page image. |
OCRWord | OCRWord is word-level detail within a line, for engines that provide it. |
OcrCopilot | OcrCopilot recognizes text on scanned pages. |
OcrOptions | OcrOptions configures an OcrCopilot. |
OpenAIClient | OpenAIClient talks to an OpenAI-compatible chat-completions endpoint using only the standard library. |
OpenAIClientOptions | OpenAIClientOptions configures NewOpenAIClient. |
OptimizationOptions | OptimizationOptions selects which reductions Document.Optimize applies. |
OptimizationResult | OptimizationResult reports what Document.Optimize changed. |
OptimizeImageOptions | OptimizeImageOptions controls image optimization behavior. |
OutlineItemCollection | OutlineItemCollection represents an outline entry and the collection of its children. |
PDFAFormat | PDFAFormat identifies a PDF/A conformance level. |
PDFAIssue | PDFAIssue describes a single PDF/A conformance violation. |
PDFAValidationReport | PDFAValidationReport is returned by (*Document).ValidatePDFA. |
PDFUAIssue | PDFUAIssue describes a single PDF/UA (accessibility) conformance violation. |
PDFUAValidationReport | PDFUAValidationReport is returned by (*Document).ValidatePDFUA. |
Page | Page is a live view of a single page within a Document. |
PageFormat | PageFormat describes a page size in points (1/72 inch). |
PageLabelRange | PageLabelRange describes a contiguous run of pages that share a numbering style. |
PageLabelStyle | PageLabelStyle is the numbering style applied within a PageLabelRange. |
PageMarkup | PageMarkup is the structured text of one page. |
PageNumberStamp | PageNumberStamp stamps the page number (and optionally the total), formatted by Format. |
PageRange | PageRange specifies an inclusive range of pages (1-based). |
PageSize | PageSize holds the width and height of a PDF page in points (1/72 inch). |
PasswordBoxField | PasswordBoxField is a text field whose input is masked (Password flag). |
Path | Path is a sequence of MoveTo/LineTo/CurveTo/Close operations defining an arbitrary 2D path in PDF user space (origin at page bottom-left, Y up). |
PdfPageStamp | PdfPageStamp overlays (or underlays) a page from another PDF document as a stamp — the source page is imported once as a Form XObject and drawn into the stamp’s Rect, scaled to fit while preserving aspect ratio, positioned by HAlign/VAlign, and honoring Opacity, RotateAngle and Background. |
Permissions | Permissions controls what a viewer allows on an encrypted PDF. |
PngDevice | PngDevice renders a page to PNG at a fixed resolution. |
Point | Point is a single point in PDF user-space coordinates. |
PolygonAnnotation | PolygonAnnotation draws a closed polygon through a list of vertices, with a stroked border and optional interior fill. |
PolylineAnnotation | PolylineAnnotation draws an open polyline through a list of vertices, with a stroked border, optional line endings at the first and last vertex, and optional interior fill for closed endings. |
QuadPoint | QuadPoint is one quadrilateral within a markup annotation’s /QuadPoints array. |
RadialGradient | RadialGradient interpolates colour from the focal point (FX, FY) out to the circle centred at (CX, CY) with radius R. |
RadioButtonField | RadioButtonField is a group of mutually exclusive options. |
RadioButtonOptionField | RadioButtonOptionField is one of the option widgets inside a RadioButtonField. |
RadioItem | RadioItem describes one widget inside a radio group. |
Rectangle | Rectangle represents a PDF rectangle [llx, lly, urx, ury] in points (1/72 inch). |
RedactAnnotation | RedactAnnotation marks regions for redaction. |
RenderOptions | RenderOptions controls page rasterization. |
ReplaceOptions | ReplaceOptions tunes how ReplaceText matches the search text. |
ResetFormAction | ResetFormAction resets named form fields to their /DV defaults. |
Resolution | Resolution is a rendering resolution in DPI. |
RichTextBoxField | RichTextBoxField is a text field that carries a rich-text value (RichText flag + /RV) in addition to its plain /V. |
RotationAngle | RotationAngle represents a valid PDF page rotation in clockwise degrees. |
Row | Row is a single row within a Table. |
SVG | SVG is the pre-parsed SVG document. |
SVGFontResolver | SVGFontResolver maps an SVG font-family + style to a pdf.Font. |
SVGSaveOptions | SVGSaveOptions configures SaveSVG / WriteSVG. |
SearchOptions | SearchOptions tunes how SearchText interprets the query. |
ShapeStyle | ShapeStyle combines a stroke (LineStyle) with an optional fill color. |
SignOptions | SignOptions configures a digital signature. |
SignatureAppearance | SignatureAppearance controls the visible signature block’s content and styling. |
SignatureVerification | SignatureVerification is the result of verifying one digital signature. |
SquareAnnotation | SquareAnnotation draws a rectangular annotation with stroked border and optional interior fill. |
SquigglyAnnotation | SquigglyAnnotation draws a wavy underline under text (typically used for spell-check style hints). |
Stamp | Stamp is content overlaid on (or behind) a page: a TextStamp, an ImageStamp, or a PageNumberStamp. |
StampAnnotation | StampAnnotation is a rubber-stamp annotation. |
StampName | StampName names per ISO 32000-1 §12.5.6.13 Table 184. |
StrikeOutAnnotation | StrikeOutAnnotation draws a horizontal line through text. |
StructElement | StructElement is a node in the logical structure tree. |
StructType | StructType is a PDF standard structure type (ISO 32000-1 §14.8.4), used as the /S value of a structure element. |
SubmitFormAction | SubmitFormAction submits form field values to a URL. |
SubmitFormFlags | SubmitFormFlags is the /Flags bitfield for a /SubmitForm action per ISO 32000-1 Table 237. |
SummaryCopilot | SummaryCopilot produces document summaries with an AI model. |
SummaryOptions | SummaryOptions configures a SummaryCopilot. |
TOCEntry | TOCEntry is one line of a table of contents: a title, an indent level (0 = top level), and the page it points at. |
TOCOptions | TOCOptions controls how a table of contents is rendered. |
Table | Table is a transient builder for a tabular layout drawn onto a Page. |
TaggedContent | TaggedContent is the facade for authoring a Tagged PDF (ISO 32000-1 §14.8): it owns the document’s logical structure tree and sets the catalog marks PDF/UA requires. |
TextAnnotation | TextAnnotation is a sticky-note annotation. |
TextBoxField | TextBoxField is a single- or multi-line text input. |
TextExtractOptions | TextExtractOptions configures ExtractText. |
TextExtractionMode | TextExtractionMode selects how ExtractText orders the extracted text. |
TextFragment | TextFragment represents a contiguous run of text with uniform font. |
TextIcon | TextIcon names per ISO 32000-1 §12.5.6.4 Table 172, used in /Subtype /Text annotations’ /Name entry. |
TextLine | TextLine represents a horizontal line of text fragments at a common Y position. |
TextMatch | TextMatch is a single occurrence located by SearchText. |
TextRecognitionResult | TextRecognitionResult is the recognized text of one processed page. |
TextStamp | TextStamp overlays a line (or wrapped block) of text. |
TextStyle | TextStyle defines reusable text formatting properties. |
TiffDevice | TiffDevice renders pages to TIFF. |
TilingPattern | TilingPattern is a repeating fill (PatternType 1, ISO 32000-1 §8.7.3.1): a small cell of content tiled across whatever shape it fills. |
UnderlineAnnotation | UnderlineAnnotation draws a horizontal line under text. |
Usage | Usage reports token counts when the provider returns them. |
VAlign | VAlign specifies vertical text alignment within a rectangle. |
ValidationIssue | ValidationIssue describes a single problem found in a PDF file. |
ValidationReport | ValidationReport is returned by Validate and summarises the structural integrity of a PDF. |
WidgetAnnotation | WidgetAnnotation is the read-only view of a form widget annotation surfaced through AnnotationCollection. |
XForm | XForm is a reusable Form XObject (ISO 32000-1 §8.10) — a self-contained content stream (with its own resources) that can be placed on any number of pages and positions with a single Do invocation. |
XMPMetadata | XMPMetadata is the document’s XMP packet modelled as common schema fields plus a list of arbitrary Custom properties. |
XMPProperty | XMPProperty is a single simple (string-valued) XMP property in an arbitrary namespace. |
