Aspose.PDF FOSS for Go

API reference for Aspose.Pdf FOSS for Go. 123 public types organized by module.

Core API

ClassDescription
ActionAction is the common interface implemented by every concrete action type.
ActionTypeActionType identifies the kind of action attached to an annotation (typically a LinkAnnotation’s /A entry).
AnnotationAnnotation is the common interface implemented by every concrete annotation type.
AnnotationCollectionAnnotationCollection is the live, ordered set of annotations attached to a single page.
AnnotationTypeAnnotationType identifies the kind of annotation.
BmpDeviceBmpDevice renders a page to BMP.
BorderEffectBorderEffect controls the /BE/S entry per ISO 32000-1 §12.5.4 Table 167.
BorderInfoBorderInfo describes a border drawn around a table or cell.
BorderSideBorderSide is a bitmask selecting which sides of a rectangular border are drawn.
BorderStyleBorderStyle controls the /BS dict for drawing annotations per ISO 32000-1 §12.5.4 Table 168.
ButtonAppearanceButtonAppearance configures a push button’s rich appearance: separate captions for the normal / rollover / down states, an optional icon image, and face/border/text colours.
ButtonFieldButtonField is a push button — action only, no value semantics.
ButtonIconPositionButtonIconPosition 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.
CellCell is a single cell within a Row.
CheckboxFieldCheckboxField is a checkbox with on/off state.
ChoiceOptionChoiceOption is one option of a ComboBoxField or ListBoxField.
CircleAnnotationCircleAnnotation draws an elliptical annotation.
ColorColor represents an RGBA color with values in [0, 1].
ComboBoxFieldComboBoxField is a single-select dropdown choice field.
DestinationDestination is the common interface for all explicit destinations.
DestinationFitDestinationFit — [page /Fit].
DestinationFitBDestinationFitB — [page /FitB].
DestinationFitBHDestinationFitBH — [page /FitBH top].
DestinationFitBVDestinationFitBV — [page /FitBV left].
DestinationFitHDestinationFitH — [page /FitH top].
DestinationFitRDestinationFitR — [page /FitR left bottom right top].
DestinationFitVDestinationFitV — [page /FitV left].
DestinationTypeDestinationType identifies the destination flavor.
DestinationXYZDestinationXYZ — [page /XYZ left top zoom].
DocumentDocument is a PDF document.
DocumentInfoDocumentInfo contains document information from the PDF Info dictionary.
EncryptionAlgorithmEncryptionAlgorithm selects the cipher and security-handler revision used by (*Document).SetEncryption.
EncryptionOptionsEncryptionOptions bundles every knob that controls how a document is encrypted when saved.
FieldField is the common interface implemented by every concrete form field type (TextBoxField, CheckboxField, RadioButtonField, etc.).
FieldStyleFieldStyle is the visual styling applied to a form field’s widget(s).
FileAttachmentAnnotationFileAttachmentAnnotation embeds a file in the document and shows an icon at the annotation’s /Rect.
FileAttachmentIconFileAttachmentIcon names per ISO 32000-1 §12.5.6.15 Table 178.
FontFont is implemented by standard 14 fonts and embedded TTF fonts.
FormForm is the document’s AcroForm view.
FormFieldTypeFormFieldType identifies the kind of form field.
FreeTextAnnotationFreeTextAnnotation displays text directly on the page, rendered into /AP/N using an embedded font.
FreeTextIntentFreeTextIntent per ISO 32000-1 §12.5.6.6 /IT entry.
GenericAnnotationGenericAnnotation is the catch-all surface for /Subtype values this release does not yet model (Stamp, FreeText, Ink, etc.).
GifDeviceGifDevice renders a page to GIF.
GoToActionGoToAction navigates to a page within the same document.
GoToURIActionGoToURIAction opens a URI in the user’s default handler (typically a web browser).
GradientGradient is a fill that varies colour across a shape: either a LinearGradient or a RadialGradient.
GradientStopGradientStop is one colour stop in a gradient, positioned at Offset (0 at the gradient’s start, 1 at its end).
HAlignHAlign specifies horizontal text alignment within a rectangle.
HighlightAnnotationHighlightAnnotation marks a region with semi-transparent highlight color.
ImageImage holds an extracted image with its encoded data and metadata.
ImageColorSpaceImageColorSpace describes the original color space of the image in the PDF.
ImageFormatImageFormat describes the output format of an extracted image.
ImageInfoImageInfo holds metadata about an image found on a page without decoding pixel data.
ImageToDocumentOptionsImageToDocumentOptions controls page sizing for ImageToDocument.
InkAnnotationInkAnnotation draws a series of free-form strokes — typically used to represent handwritten ink.
JavaScriptActionJavaScriptAction holds a JavaScript snippet attached to an annotation.
JpegDeviceJpegDevice renders a page to JPEG.
LineAnnotationLineAnnotation draws a straight line between two points, with optional line endings on each end (arrows, circles, etc.
LineCapLineCap is the /J line cap style per ISO 32000-1 §8.4.3.3 Table 54.
LineEndingStyleLineEndingStyle is one of the 10 line-ending shapes per ISO 32000-1 §12.5.6.7 Table 176, used in /Line annotations’ /LE entry.
LineJoinLineJoin is the /j line join style per ISO 32000-1 §8.4.3.4 Table 55.
LineStyleLineStyle describes how a stroked path is drawn.
LinearGradientLinearGradient interpolates colour along the line from (X1, Y1) to (X2, Y2).
LinkAnnotationLinkAnnotation is a clickable region.
LinkHighlightModeLinkHighlightMode controls the visual feedback when the link is activated by the user (the /H entry per ISO 32000-1 §12.5.6.5).
ListBoxFieldListBoxField is a single- or multi-select list choice field.
MarginInfoMarginInfo describes margins or padding in points: Top / Right / Bottom / Left.
NamedActionNamedAction triggers a built-in viewer command (FirstPage, Print, …).
NamedActionTypeNamedActionType identifies one of the standard viewer commands supported by /Named actions per ISO 32000-1 §12.6.4.11.
NamedDestinationNamedDestination wraps a name reference into the document’s NamedDestinations collection.
NamedDestinationsNamedDestinations is a name-to-destination map per ISO 32000-1 §12.3.2.3.
OptimizeImageOptionsOptimizeImageOptions controls image optimization behavior.
OutlineItemCollectionOutlineItemCollection represents an outline entry and the collection of its children.
PagePage is a live view of a single page within a Document.
PageFormatPageFormat describes a page size in points (1/72 inch).
PageLabelRangePageLabelRange describes a contiguous run of pages that share a numbering style.
PageLabelStylePageLabelStyle is the numbering style applied within a PageLabelRange.
PageRangePageRange specifies an inclusive range of pages (1-based).
PageSizePageSize holds the width and height of a PDF page in points (1/72 inch).
PathPath 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).
PermissionsPermissions controls what a viewer allows on an encrypted PDF.
PngDevicePngDevice renders a page to PNG at a fixed resolution.
PointPoint is a single point in PDF user-space coordinates.
QuadPointQuadPoint is one quadrilateral within a markup annotation’s /QuadPoints array.
RadialGradientRadialGradient interpolates colour from the focal point (FX, FY) out to the circle centred at (CX, CY) with radius R.
RadioButtonFieldRadioButtonField is a group of mutually exclusive options.
RadioButtonOptionFieldRadioButtonOptionField is one of the option widgets inside a RadioButtonField.
RadioItemRadioItem describes one widget inside a radio group.
RectangleRectangle represents a PDF rectangle [llx, lly, urx, ury] in points (1/72 inch).
RedactAnnotationRedactAnnotation marks regions for redaction.
RenderOptionsRenderOptions controls page rasterization.
ResetFormActionResetFormAction resets named form fields to their /DV defaults.
ResolutionResolution is a rendering resolution in DPI.
RotationAngleRotationAngle represents a valid PDF page rotation in clockwise degrees.
RowRow is a single row within a Table.
SVGSVG is the pre-parsed SVG document.
SVGFontResolverSVGFontResolver maps an SVG font-family + style to a pdf.Font.
SearchOptionsSearchOptions tunes how SearchText interprets the query.
ShapeStyleShapeStyle combines a stroke (LineStyle) with an optional fill color.
SquareAnnotationSquareAnnotation draws a rectangular annotation with stroked border and optional interior fill.
SquigglyAnnotationSquigglyAnnotation draws a wavy underline under text (typically used for spell-check style hints).
StampAnnotationStampAnnotation is a rubber-stamp annotation.
StampNameStampName names per ISO 32000-1 §12.5.6.13 Table 184.
StrikeOutAnnotationStrikeOutAnnotation draws a horizontal line through text.
SubmitFormActionSubmitFormAction submits form field values to a URL.
SubmitFormFlagsSubmitFormFlags is the /Flags bitfield for a /SubmitForm action per ISO 32000-1 Table 237.
TableTable is a transient builder for a tabular layout drawn onto a Page.
TextAnnotationTextAnnotation is a sticky-note annotation.
TextBoxFieldTextBoxField is a single- or multi-line text input.
TextFragmentTextFragment represents a contiguous run of text with uniform font.
TextIconTextIcon names per ISO 32000-1 §12.5.6.4 Table 172, used in /Subtype /Text annotations’ /Name entry.
TextLineTextLine represents a horizontal line of text fragments at a common Y position.
TextMatchTextMatch is a single occurrence located by SearchText.
TextStyleTextStyle defines reusable text formatting properties.
TiffDeviceTiffDevice renders pages to TIFF.
UnderlineAnnotationUnderlineAnnotation draws a horizontal line under text.
VAlignVAlign specifies vertical text alignment within a rectangle.
ValidationIssueValidationIssue describes a single problem found in a PDF file.
ValidationReportValidationReport is returned by Validate and summarises the structural integrity of a PDF.
WidgetAnnotationWidgetAnnotation is the read-only view of a form widget annotation surfaced through AnnotationCollection.
XMPMetadataXMPMetadata is the document’s XMP packet modelled as common schema fields plus a list of arbitrary Custom properties.
XMPPropertyXMPProperty is a single simple (string-valued) XMP property in an arbitrary namespace.

See Also