Go 的 Aspose.PDF FOSS

API reference 用于 Aspose.Pdf Go 的 FOSS. 206 个公共类型按模块组织。

核心 API

类描述
AIClientAIClient 是每个 copilot 消耗的契约:一次调用,一次聊天完成。
APIError当 AI 端点返回非 2xx 状态时,会返回 APIError。
ActionAction 是每个具体操作类型实现的通用接口。
ActionTypeActionType 标识附加到注释的操作类型(通常是 LinkAnnotation 的 /A 条目)。
AnnotationAnnotation 是每个具体注释类型实现的通用接口。
AnnotationCollectionAnnotationCollection 是附加到单个页面的实时、有序注释集合。
AnnotationTypeAnnotationType 标识注释的类型。
BmpDeviceBmpDevice 将页面渲染为 BMP。
BookletBindingBookletBinding 选择小册子的装订边。
BookletOptionsBookletOptions 配置小册子排版。
BorderEffectBorderEffect 控制 /BE/S 条目,依据 ISO 32000-1 §12.5.4 表 167.
BorderInfoBorderInfo 描述了在表格或单元格周围绘制的边框。
BorderSideBorderSide 是一个位掩码,用于选择矩形边框的哪些边被绘制。
BorderStyleBorderStyle 控制 /BS 字典,用于绘制注释,依据 ISO 32000-1 §12.5.4 表 168.
ButtonAppearanceButtonAppearance 配置推按钮的丰富外观:为普通 / 悬停 / 按下 状态提供独立的标题,可选的图标图片,以及面板/边框/文本颜色。
ButtonFieldButtonField 是一个推按钮——仅用于动作,不具有取值语义。
ButtonIconPositionButtonIconPosition 控制推按钮布局其图标和标题的方式——依据 ISO 32000-1 §12.5.6.19 表 189 中的 /MK /TP 条目。
CaretAnnotationCaretAnnotation 标记文本插入或删除的位置,显示为向上的插入符(“^”),并填充注释颜色。
CaretSymbolCaretSymbol 是 ISO 32000-1 §12.5.6.11 表 180 中的 /Sy 条目——一个可选符号,与插入符号一起绘制,以将其关联到编辑操作。
CellCell 是 Row 中的单个单元格。
CertifyPermissionCertifyPermission 是认证签名的 DocMDP 权限级别(ISO 32000-1 §12.8.2.2 表 254)。
ChatCopilotChatCopilot 回答有关文档的问题,并保留对话历史。
ChatOptionsChatOptions 配置一个 ChatCopilot。
CheckboxFieldCheckboxField 是一个具有开/关状态的复选框。
ChoiceOptionChoiceOption 是 ComboBoxField 或 ListBoxField 的一个选项。
CircleAnnotationCircleAnnotation 绘制椭圆形注释。
ColorColor 表示一个 RGBA 颜色,取值在 [0, 1]。
ComboBoxFieldComboBoxField 是一个单选下拉选择字段。
CompletionRequestCompletionRequest 描述一次 chat-completion 调用。
CompletionResponseCompletionResponse 是模型的回复。
DateFieldDateField 是一个文本字段,带有 JavaScript 日期格式操作和格式掩码(例如.
DestinationDestination 是所有显式目标的通用接口。
DestinationFitDestinationFit — [page /Fit].
DestinationFitBDestinationFitB — [页面 /FitB].
DestinationFitBHDestinationFitBH — [页面 /FitBH 顶部].
DestinationFitBVDestinationFitBV — [页面 /FitBV 左侧].
DestinationFitHDestinationFitH — [页面 /FitH 顶部].
DestinationFitRDestinationFitR — [page /FitR 左 下 右 上].
DestinationFitVDestinationFitV — [page /FitV 左].
DestinationTypeDestinationType 标识目标风味。
DestinationXYZDestinationXYZ — [page /XYZ 左 上 缩放].
Document文档是一个 PDF 文档。
DocumentInfoDocumentInfo 包含来自 PDF Info 字典的文档信息。
EmbeddedFileEmbeddedFile 是一个附件:一个带有嵌入流的 /Filespec 字典。
EmbeddedFilesEmbeddedFiles 是文档的已附加(嵌入)文件集合——/Catalog/Names/EmbeddedFiles 名称树(ISO 32000-1 §7.11.4)。
EncryptionAlgorithmEncryptionAlgorithm 选择 (*Document).SetEncryption 使用的密码和安全处理程序版本。
EncryptionOptionsEncryptionOptions 打包了所有控制文档保存时加密方式的参数。
FieldField 是每个具体表单字段类型(TextBoxField、CheckboxField、RadioButtonField 等)实现的通用接口。
FieldStyleFieldStyle 是应用于表单字段 widget(s) 的视觉样式。
FigureAltFigureAlt 是一种 /Figure 结构元素,没有替代文本,与其所括的图像配对(当可解析时)。
FileAttachmentAnnotationFileAttachmentAnnotation 将文件嵌入文档,并在注释的 /Rect 位置显示图标。
FileAttachmentIconFileAttachmentIcon 的名称遵循 ISO 32000-1 §12.5.6.15 表 178。
FileSelectBoxFieldFileSelectBoxField 是一个文本字段,其值为文件路径(FileSelect 标志),用于在提交时附加本地文件。
FloatSideFloatSide 选择在文本环绕时浮动框贴靠的边缘。
FloatingBoxFloatingBox 是一个定位的内容容器(流模型的第 2 层):一个带可选边框、背景和内边距的盒子,在其宽度范围内放置自己的内容(段落、标题、图像、列表)。
FlowFlow 是一个文档生成器,它自上而下布局内容并自动分页——是基于矩形绘图的 API 的 “flow” 对应版本。
FlowOptionsFlowOptions 配置 Flow。
Font字体通过标准的 14 种字体和嵌入的 TTF 字体实现。
Form表单是文档的 AcroForm 视图。
FormFieldTypeFormFieldType 标识表单字段的类型。
FreeTextAnnotationFreeTextAnnotation 在页面上直接显示文本,使用嵌入式字体渲染到 /AP/N。
FreeTextIntentFreeTextIntent 按照 ISO 32000-1 §12.5.6.6 /IT 条目。
GenericAnnotationGenericAnnotation 是此版本尚未建模的 /Subtype 值的通用容器(Stamp、FreeText、Ink 等)。
GifDeviceGifDevice 将页面渲染为 GIF。
GoToActionGoToAction 导航到同一文档中的页面。
GoToURIActionGoToURIAction 在用户的默认处理程序中打开 URI(通常是网页浏览器)。
Gradient渐变是一种在形状上变化颜色的填充:可以是 LinearGradient 或 RadialGradient。
GradientStopGradientStop 是渐变中的一个颜色节点,位于偏移位置(0 为渐变开始,1 为结束)。
HAlignHAlign 指定矩形内的水平文本对齐方式。
HTMLModeHTMLMode 选择 SaveHTML / WriteHTML 表示页面文本的方式。
HTMLSaveOptionsHTMLSaveOptions 配置 SaveHTML / WriteHTML。
HighlightAnnotationHighlightAnnotation 用半透明的高亮颜色标记一个区域。
ImageImage 包含已提取的图像及其编码数据和元数据。
ImageColorSpaceImageColorSpace 描述 PDF 中图像的原始色彩空间。
ImageDescriptionCopilotImageDescriptionCopilot 描述使用视觉模型的图像。
ImageDescriptionOptionsImageDescriptionOptions 配置一个 ImageDescriptionCopilot。
ImageFormatImageFormat 描述已提取图像的输出格式。
ImageInfoImageInfo 保存页面上发现的图像的元数据,而不解码像素数据。
ImageStampImageStamp 覆盖栅格图像(PNG 或 JPEG),拉伸以填满 Rect。
ImageToDocumentOptionsImageToDocumentOptions 控制 ImageToDocument 的页面尺寸。
InkAnnotationInkAnnotation 绘制一系列自由形状的笔画——通常用于表示手写墨迹。
JSONExportOptionsJSONExportOptions 控制 (*Form).ExportJSON / WriteJSON。
JavaScriptActionJavaScriptAction 持有一个附加在批注上的 JavaScript snippet。
JavaScriptCollectionJavaScriptCollection 是文档级的 JavaScript 存储,由 /Catalog/Names/JavaScript 名称树提供支持(ISO 32000-1 第7.7.4节 / 第8.5.1节)。
JpegDeviceJpegDevice 将页面渲染为 JPEG。
LLMOCREngineLLMOCREngine 通过将页面图像发送到具备视觉能力的聊天模型来识别文本。
LLMOCROptionsLLMOCROptions 配置视觉模型 OCR 引擎。
LayerLayer 是文档中的一个可选内容组 (OCG)。
LineAnnotationLineAnnotation 在两个点之间绘制一条直线,可在每端选择可选的线端形状(箭头、圆圈等)。
LineCapLineCap 是根据 ISO 32000-1 §8.4.3.3 表 54 的 /J 线帽样式。
LineEndingStyleLineEndingStyle 是根据 ISO 32000-1 §12.5.6.7 表 176 的 10 种线端形状之一,用于 /Line 注释的 /LE 条目。
LineJoinLineJoin 是 ISO 32000-1 第8.4.3.4节表55所定义的 /j 线段连接样式。
LineStyleLineStyle 描述了描边路径的绘制方式。
LinearGradientLinearGradient 在从 (X1, Y1) 到 (X2, Y2) 的线段上插值颜色。
LinkAnnotationLinkAnnotation 是一个可点击的区域。
LinkHighlightModeLinkHighlightMode 控制用户激活链接时的视觉反馈(根据 ISO 32000-1 §12.5.6.5 的 /H 条目)。
ListBoxFieldListBoxField 是单选或多选列表选择字段。
MarginInfoMarginInfo 描述以点为单位的边距或内边距:上 / 右 / 下 / 左。
MarkdownOptionsMarkdownOptions 配置 Markdown 渲染。
MarkdownSaveOptionsMarkdownSaveOptions 配置 SaveMarkdown / WriteMarkdown。
MarkupParagraphMarkupParagraph 是一系列连续的行,形成一个段落。
MarkupSectionMarkupSection 是一列段落(从页面左到右)。
MessageMessage 是单条聊天消息。
MessageImageMessageImage 是一张内嵌在消息中的图片,以 base64 data: URL 形式发送。
NUpOptionsNUpOptions 配置 NUp 排版。
NUpOrderNUpOrder 控制源页面填充 N-up 纸张网格单元格的顺序。
NamedActionNamedAction 触发内置查看器命令(FirstPage、Print、…)。
NamedActionTypeNamedActionType 标识了 ISO 32000-1 §12.6.4.11 中 /Named actions 支持的标准查看器命令之一。
NamedDestinationNamedDestination 将一个名称引用包装到文档的 NamedDestinations 集合中。
NamedDestinationsNamedDestinations 是依据 ISO 32000-1 §12.3.2.3 的名称到目标映射。
NumberFieldNumberField 是一个带有 JavaScript number-format 操作的文本字段,因而查看器会将该值显示并验证为格式化的数字。
NumberFormatOptionsNumberFormatOptions 配置 NumberField 的显示格式(映射到 Acrobat 的 AFNumber_Format)。
OCRBoxOCRBox 是图像像素空间中的矩形:原点在左上角,Y 向下递增(通常的光栅约定 — 为了与 PDF 用户空间区分)。
OCREngineOCREngine 识别单页图像上的文本。
OCRLineOCRLine 是一行实际的文本。
OCRResultOCRResult 是单页图像的识别内容。
OCRWordOCRWord 是行内的词级细节,适用于提供此信息的引擎。
OcrCopilotOcrCopilot 能识别扫描页上的文本。
OcrOptionsOcrOptions 配置一个 OcrCopilot。
OpenAIClientOpenAIClient 使用仅标准库与一个 OpenAI-兼容的 chat-completions 端点进行通信。
OpenAIClientOptionsOpenAIClientOptions 配置 NewOpenAIClient。
OptimizationOptionsOptimizationOptions 选择 Document.Optimize 应用的约简。
OptimizationResultOptimizationResult 报告了 Document.Optimize 更改的内容。
OptimizeImageOptionsOptimizeImageOptions 控制图像优化行为。
OutlineItemCollectionOutlineItemCollection 代表一个大纲条目及其子项的集合。
PDFAFormatPDFAFormat 标识了一个 PDF/A 合规级别。
PDFAIssuePDFAIssue 描述了单个 PDF/A 合规违规。
PDFAValidationReportPDFAValidationReport 由 (*Document).ValidatePDFA 返回。
PDFUAIssuePDFUAIssue 描述了单个 PDF/UA(可访问性)合规违规。
PDFUAValidationReportPDFUAValidationReport 由 (*Document).ValidatePDFUA 返回。
PagePage 是 Document 中单个页面的实时视图。
PageFormatPageFormat 描述了以 points 为单位的页面大小(1/72 英寸)。
PageLabelRangePageLabelRange 描述了一段连续的页面,这些页面共享相同的 numbering style。
PageLabelStylePageLabelStyle 是在 PageLabelRange 中应用的 numbering style。
PageMarkupPageMarkup 是单页的结构化文本。
PageNumberStampPageNumberStamp 在页面上标注页码(可选地包括总页数),格式由 Format 设定。
PageRangePageRange 指定一个包含的页面范围(基于 1 的编号)。
PageSizePageSize 保存 PDF 页面在点(1/72 英寸)单位下的宽度和高度。
PasswordBoxFieldPasswordBoxField 是一个文本字段,其输入被掩码(Password flag)。
PathPath 是一系列 MoveTo/LineTo/CurveTo/Close 操作,用于在 PDF 用户空间(原点位于页面左下角,Y 向上)中定义任意的二维路径。
PdfPageStampPdfPageStamp 将另一 PDF 文档中的页面作为印章进行覆盖(或底层覆盖)——源页面一次性作为 Form XObject 导入,并绘制到印章的 Rect 中,按比例缩放以适应并保持宽高比,通过 HAlign/VAlign 定位,并遵循 Opacity、RotateAngle 和 Background 设置。
PermissionsPermissions 控制查看器在加密 PDF 上允许的操作。
PngDevicePngDevice 将页面渲染为固定分辨率的 PNG。
PointPoint 是 PDF 用户空间坐标中的单个点。
PolygonAnnotationPolygonAnnotation 通过顶点列表绘制闭合多边形,带有描边边框和可选的内部填充。
PolylineAnnotationPolylineAnnotation 通过顶点列表绘制开放折线,带有描边边框,可选在首尾顶点添加线端点,并在闭合端点时可选内部填充。
QuadPointQuadPoint 是标记注释的 /QuadPoints 数组中的一个四边形。
RadialGradientRadialGradient 将颜色从焦点 (FX, FY) 插值到以 (CX, CY) 为中心、半径为 R 的圆。
RadioButtonFieldRadioButtonField 是一组相互排斥的选项。
RadioButtonOptionFieldRadioButtonOptionField 是 RadioButtonField 内的一个选项小部件。
RadioItemRadioItem 描述了单选按钮组中的一个小部件。
RectangleRectangle 表示 PDF 矩形 [llx, lly, urx, ury],单位为点(1/72 英寸)。
RedactAnnotationRedactAnnotation 标记用于编辑的区域。
RenderOptionsRenderOptions 控制页面光栅化。
ReplaceOptionsReplaceOptions 调整 ReplaceText 与搜索文本的匹配方式。
ResetFormActionResetFormAction 将已命名的表单字段重置为其 /DV 默认值。
Resolution分辨率是以 DPI 为单位的渲染分辨率。
RichTextBoxFieldRichTextBoxField 是一个文本字段,除了普通的 /V 外,还携带富文本值(RichText 标志 + /RV)。
RotationAngleRotationAngle 表示有效的 PDF 页面顺时针旋转角度(度)。
RowRow 是表格中的单行。
SVGSVG 是预解析的 SVG 文档。
SVGFontResolverSVGFontResolver 将 SVG 的 font-family + style 映射到 pdf.Font。
SVGSaveOptionsSVGSaveOptions 配置 SaveSVG / WriteSVG。
SearchOptionsSearchOptions 调整 SearchText 解释查询的方式。
ShapeStyleShapeStyle 将描边 (LineStyle) 与可选的填充颜色相结合。
SignOptionsSignOptions 配置数字签名。
SignatureAppearanceSignatureAppearance 控制可见签名块的内容和样式。
SignatureVerificationSignatureVerification 是对单个数字签名进行验证的结果。
SquareAnnotationSquareAnnotation 绘制带描边边框和可选内部填充的矩形注释。
SquigglyAnnotationSquigglyAnnotation 在文本下绘制波浪下划线(通常用于拼写检查样式提示)。
StampStamp 是覆盖在(或位于)页面上的内容:TextStamp、ImageStamp 或 PageNumberStamp。
StampAnnotationStampAnnotation 是一种橡胶印章批注。
StampNameStampName 按照 ISO 32000-1 §12.5.6.13 表 184 命名。
StrikeOutAnnotationStrikeOutAnnotation 在文本上绘制一条水平线。
StructElementStructElement 是逻辑结构树中的一个节点。
StructTypeStructType 是 PDF 标准结构类型(ISO 32000-1 第14.8.4节),用作结构元素的 /S 值。
SubmitFormActionSubmitFormAction 将表单字段值提交到 URL。
SubmitFormFlagsSubmitFormFlags 是根据 ISO 32000-1 表 237 的 /SubmitForm 动作的 /Flags 位字段。
SummaryCopilotSummaryCopilot 使用 AI 模型生成文档摘要。
SummaryOptionsSummaryOptions 配置一个 SummaryCopilot。
TOCEntryTOCEntry 是目录表中的一行:标题、缩进层级(0 = 顶层)以及它指向的页面。
TOCOptionsTOCOptions 控制目录的渲染方式。
TableTable 是一个用于在 Page 上绘制表格布局的瞬态构建器。
TaggedContentTaggedContent 是用于创建带标签 PDF(ISO 32000-1 第14.8节)的外观层:它拥有文档的逻辑结构树,并设置 PDF/UA 所需的目录标记。
TextAnnotationTextAnnotation 是一种便利贴注释。
TextBoxFieldTextBoxField 是单行或多行文本输入。
TextExtractOptionsTextExtractOptions 配置 ExtractText。
TextExtractionModeTextExtractionMode 选择 ExtractText 如何对提取的文本进行排序。
TextFragmentTextFragment 表示具有统一字体的连续文本块。
TextIconTextIcon 名称遵循 ISO 32000-1 §12.5.6.4 表 172,用于 /Subtype /Text 注释的 /Name 条目。
TextLineTextLine 表示在共同的 Y 位置上的水平文本片段行。
TextMatchTextMatch 是由 SearchText 定位的单个出现。
TextRecognitionResultTextRecognitionResult 是已处理页面的识别文本。
TextStampTextStamp 覆盖一行(或换行块)文本。
TextStyleTextStyle 定义可重复使用的文本格式属性。
TiffDeviceTiffDevice 将页面渲染为 TIFF。
TilingPatternTilingPattern 是一种重复填充(PatternType 1,ISO 32000-1 §8.7.3.1):一个小的内容单元,平铺在其填充的任意形状上。
UnderlineAnnotationUnderlineAnnotation 在文本下面绘制水平线。
Usage当提供者返回时,Usage 报告令牌计数。
VAlignVAlign 指定矩形内的垂直文本对齐方式。
ValidationIssueValidationIssue 描述了在 PDF 文件中发现的单个问题。
ValidationReportValidationReport 由 Validate 返回,用于概括 PDF 的结构完整性。
WidgetAnnotationWidgetAnnotation 是通过 AnnotationCollection 显示的表单小部件注释的只读视图。
XFormXForm 是可重用的 Form XObject(ISO 32000-1 §8.10)——一种自包含的内容流(拥有自己的资源),可通过一次 Do 调用放置在任意数量的页面和位置上。
XMPMetadataXMPMetadata 是文档的 XMP 包,建模为通用模式字段加上一系列任意的 Custom 属性。
XMPPropertyXMPProperty 是任意命名空间中的单个简单(字符串值)XMP 属性。

另请参阅

 中文