C++ 的 Aspose.PDF FOSS
API reference 用于 Aspose.Pdf FOSS 用于 C++ v1.0.0. 244 个公共类型按模块组织。
核心 API
| 类 | 描述 |
|---|
Artifact | 类,拥有 14 个方法。 |
ArtifactCollection | 类,拥有 7 个方法和 1 个属性。 |
BaseParagraph | 类,包含23个方法和1个属性。 |
BitmapInfo | BitmapInfo 能够创建具有指定像素格式、宽度、高度和像素数据的原始位图图像,支持在没有外部依赖的情况下进行图像处理。 |
BmpDevice | 类,包含1个方法。 |
BorderInfo | 类,包含10个方法。 |
Cell | 具有 27 个方法的类。 |
Cells | 具有 9 个方法的类。 |
Color | 具有 147 个方法的类。 |
Device | Device 基类提供了一个虚拟析构函数,确保对派生的光栅‑设备对象(如 PngDevice 或 JpegDevice)进行正确的清理。 |
Document | 可以通过 Document.Info() 和访问器方法 Title()、Author()、Creator()、Producer()、Subject() 和 Keywords() 读取文档元数据。 |
DocumentDevice | 包含 4 个方法的类。 |
DocumentInfo | 包含 24 个方法和 1 个属性的类。 |
DocumentPrivilege | 包含 34 个方法的类。 |
EmbeddedFileCollection | 包含 9 个方法的类。 |
FileSpecification | FileSpecification 对象允许为嵌入的文件设置元数据,包括 MIME 类型、描述、Unicode 名称,以及通过 Encoding 属性进行压缩。 |
FloatingBox | 包含 12 个方法的类。 |
Font | Font 类允许开发者查询字体是否嵌入在 PDF 中以及是否为子集化,从而实现对 PDF/A 的合规性检查。 |
FontRepository | 类有 2 个方法。 |
GraphInfo | 类有 25 个方法。 |
Hyperlink | 类有 6 个方法和 1 个属性。 |
ImageDevice | 类有 10 个方法。 |
JpegDevice | 包含 1 个方法的类。 |
LoadOptions | 包含 3 个方法的类。 |
MarginInfo | MarginInfo 允许通过双精度的 getter 和 setter 精确控制页面边距,包括左、右、上、下的数值。 |
Margins | 包含 8 个方法的类。 |
Metadata | Metadata 类实现了类似字典的接口,提供 Add(key, value)、Remove(key) 和 TryGetValue(key, value) 用于管理 XMP 元数据条目。 |
NamedDestinationCollection | 具有 6 个方法和 1 个属性的类。 |
OutlineCollection | Pdf CPP API 中的类。 |
OutlineItemCollection | 具有 18 个方法的类。 |
Outlines | 具有 12 个方法的类。 |
Page | 页面标签(例如,罗马数字、自定义前缀)通过 PageLabel 和 PageLabelCollection 类进行管理。 |
PageCollection | PageCollection 类提供了添加新空白页、在特定位置插入页以及按编号或范围删除页的方法。 |
PageDevice | PageDevice.Process(page, outputFileName) 可以直接将页面渲染到文件路径。 |
PageLabel | PageLabel.StartingValue() 获取或设置页面标签序列的数字起始值。 |
PageLabelCollection | PageLabelCollection.GetLabel(pageIndex) 检索分配给特定页面的 PageLabel。 |
PageSize | PageSize.Width() 和 Height() 用于获取或设置页面尺寸,而 IsLandscape() 表示方向。 |
Paragraphs | 包含 6 个方法的类。 |
PngDevice | 包含 3 个方法的类。 |
Point | 包含 6 个方法的类。 |
Position | Position 类提供 XIndent 和 YIndent 的 getter 与 setter,用于微调注释的水平和垂直偏移。 |
Rectangle-Aspose_Pdf | 包含 28 个方法的类。 |
RenderingOptions | 包含 26 个方法的类。 |
Resolution | Resolution 通过 X() 和 Y() 的 getter 与 setter 存储水平和垂直 DPI。 |
Resources | Class 包含 3 个方法和 1 个属性。 |
Row | Class 包含 23 个方法。 |
Rows | Rows 和 Row 类提供一个表格模型,用于构建具有每单元格样式、边框和内边距的 PDF 表格。 |
SvgLoadOptions | SvgLoadOptions 允许通过 AdjustPageSize 属性可选地调整页面尺寸来导入 SVG 文件。 |
Table | Table 类让开发者能够构建 PDF 表格,全面控制行、列宽、边框、单元格内边距以及默认文本状态。 |
TextAbsorber | 类包含 6 个方法和 1 个属性。 |
TextBuilder | 类包含 2 个方法。 |
TextDevice | 类包含 3 个方法。 |
TextFragment | 包含 7 个方法的类。 |
TextFragmentAbsorber | 包含 4 个方法的类。 |
TextFragmentCollection | 包含 2 个方法的类。 |
TextFragmentState | 包含 1 个方法的类。 |
TextParagraph | 包含 18 个方法的类。 |
TextState | TextState 类提供对字体、字体大小、前景/背景/描边颜色以及诸如下划线、删除线、下标和上标等文本装饰的 getter 和 setter。 |
TiffDevice | 包含 11 个方法的类。 |
TiffSettings | 包含 13 个方法的类。 |
WatermarkArtifact | Pdf CPP 中的类 API。 |
XImage | XImage 通过 Width() 和 Height() 方法公开图像的像素尺寸。 |
XImageCollection | XImageCollection 管理多个 XImage 对象,提供 Add、Replace、Delete 和 Clear 操作。 |
XmpValue | XmpValue 提供转换助手:ToString()、ToInteger()、ToDouble()、ToArray(),以及类型查询方法,如 IsString() 和 IsArray()。 |
枚举
| 枚举 | 描述 |
|---|
AFRelationship | 具有 7 个成员的枚举。 |
BorderSide | 具有 7 个成员的枚举。 |
ColorDepth | 具有 5 个成员的枚举。 |
CompressionType | 具有 5 个成员的枚举。 |
CryptoAlgorithm | Enum 包含 4 个成员。 |
FileEncoding | Enum 包含 2 个成员。 |
FormPresentationMode | Enum 包含 2 个成员。 |
HorizontalAlignment | Enum 包含 6 个成员。 |
NumberingStyle | 具有6个成员的枚举。 |
PageCoordinateType | PageCoordinateType 枚举值 MediaBox 和 CropBox 让开发者选择用于坐标计算的页面矩形。 |
PasswordType | 包含 4 个成员的枚举。 |
PdfFormat | 包含 27 个成员的枚举。 |
Permissions | 包含 8 个成员的枚举。 |
Rotation | Rotation 枚举提供四个方向值:None、on90、on180、on270。 |
ShapeType | Enum 包含 3 个成员。 |
VerticalAlignment | Enum 包含 4 个成员。 |
注释
| 类 | 描述 |
|---|
Annotation | Class 包含 36 个方法。 |
AnnotationCollection | 类,包含 11 个方法。 |
AnnotationSelector | 类,包含 35 个方法和 1 个属性。 |
BleedMarkAnnotation | BleedMarkAnnotation.Accept(visitor) 实现了访问者模式,允许外部访问者对象在不暴露其内部结构的情况下处理该注解。 |
Border | 可以通过 Border 类的方法设置其 Width、Style、Effect、EffectIntensity 和角半径来自定义边框外观。 |
CaretAnnotation | 包含 5 个方法的类。 |
Characteristics | 包含 3 个方法的类。 |
CircleAnnotation | 包含 1 个方法的类。 |
ColorBarAnnotation | 包含 3 个方法的类。 |
CommonFigureAnnotation | 包含 5 个方法的类。 |
CornerPrinterMarkAnnotation | 包含 2 个方法的类。 |
DefaultAppearance | 包含 8 个方法的类。 |
ExplicitDestination | 包含 3 个方法的类。 |
FileAttachmentAnnotation | FileAttachmentAnnotation.File() 通过 FileSpecification 对象获取或设置附加的文件,允许在 PDF 中嵌入外部资源。 |
FitBExplicitDestination | 包含 1 个方法的类。 |
FitBHExplicitDestination | 包含 2 个方法的类。 |
FitBVExplicitDestination | 包含 2 个方法的类。 |
FitExplicitDestination | 带有 1 个方法的类。 |
FitHExplicitDestination | 类包含2个方法。 |
FitRExplicitDestination | 类包含5个方法。 |
FitVExplicitDestination | 类包含2个方法。 |
FreeTextAnnotation | 类包含23个方法。 |
GoToAction | 包含 4 个方法的类。 |
GoToURIAction | 包含 4 个方法的类。 |
HighlightAnnotation | 包含 1 个方法的类。 |
InkAnnotation | InkAnnotation 表示自由手绘墨迹;其 InkList 属性保存一个可以读取或替换的 StrokeList。 |
JavascriptAction | JavascriptAction 封装了附加到 PDF 对象的 JavaScript 代码片段;可以通过 Script() 的 getter/setter 获取或更新该脚本。 |
LineAnnotation | 具有 25 个方法的类。 |
LinkAnnotation | LinkAnnotation 在 PDF 中启用可点击区域,这些区域可以触发 PdfAction 或跳转到已命名的目标。 |
MarkupAnnotation | MarkupAnnotation 提供用于设置审阅状态、不透明度、标题以及评论‑type 批注的富文本的方法。 |
MovieAnnotation | MovieAnnotation 允许您在 PDF 中嵌入视频文件,并提供标题、海报标志、宽高比和旋转等属性。 |
NamedAction | 包含 3 个方法的类。 |
NamedDestination | 包含 2 个方法的类。 |
PageInformationAnnotation | 包含 1 个方法的类。 |
PdfAction | PdfAction.GetECMAScriptString() 返回附加在 PDF 操作上的 JavaScript 代码,能够检查或修改交互脚本。 |
PolyAnnotation | 包含 11 个方法的类。 |
PolygonAnnotation | 包含 1 个方法的类。 |
PolylineAnnotation | 包含 1 个方法的类。 |
PopupAnnotation | 包含5个方法的类。 |
PrinterMarkAnnotation | PrinterMarkAnnotation 可以通过 AddPrinterMarks 将裁切标记、出血标记、对准标记或颜色条等印刷标记插入整个文档或单个页面。 |
RedactionAnnotation | RedactionAnnotation 允许您永久删除内容,同时可选择覆盖自定义文本、填充颜色、边框颜色和字体大小。 |
RegistrationMarkAnnotation | 包含3个方法的类。 |
RichMediaAnnotation | RichMediaAnnotation 允许嵌入 Flash 或其他富媒体,并支持激活事件和自定义变量。 |
ScreenAnnotation | 包含 3 个方法的类。 |
SoundAnnotation | 包含 3 个方法的类。 |
SquareAnnotation | 包含 1 个方法的类。 |
SquigglyAnnotation | 包含 1 个方法的类。 |
StampAnnotation | 包含5个方法的类。 |
StrikeOutAnnotation | 包含1个方法的类。 |
SubmitFormAction | 包含5个方法的类。 |
TextAnnotation | 包含5个方法的类。 |
TextMarkupAnnotation | 包含 4 个方法的类。 |
TextStyle | 包含 9 个方法的类。 |
TrimMarkAnnotation | TrimMarkAnnotation 和 UnderlineAnnotation 都通过 Accept 方法支持访问者模式,该方法将注解转发给访问者对象。 |
UnderlineAnnotation | 包含 1 个方法的类。 |
WatermarkAnnotation | WatermarkAnnotation 允许在 PDF 页面上添加可视水印,并让开发者控制其透明度。 |
WidgetAnnotation | WidgetAnnotation 提供对 AcroForm 字段属性的访问,例如 ReadOnly、Required、Exportable 和 DefaultAppearance。 |
XYZExplicitDestination | XYZExplicitDestination 通过 Left()、Top() 和 Zoom() 方法提供显式页面视图坐标。 |
枚举
| 枚举 | 描述 |
|---|
AnnotationFlags | AnnotationFlags 枚举包含一个 Locked 标志,设置后会阻止对注释属性的进一步修改。 |
AnnotationState | 具有 7 个成员的枚举。 |
AnnotationStateModel | 具有 3 个成员的枚举。 |
AnnotationType | 具有 33 个成员的枚举。 |
BorderEffect | 具有 2 个成员的枚举。 |
BorderStyle | 枚举包含5个成员。 |
CapStyle | 枚举包含2个成员。 |
CaptionPosition | 枚举包含2个成员。 |
CaretSymbol | 枚举包含2个成员。 |
ColorsOfCMYK | 具有 4 个成员的枚举。 |
ExplicitDestinationType | 包含 8 个成员的枚举。 |
FileIcon | 包含 4 个成员的枚举。 |
FreeTextIntent | 包含 4 个成员的枚举。 |
HighlightingMode | 包含 5 个成员的枚举。 |
Justification | 具有 3 个成员的枚举。 |
LineEnding | 具有 10 个成员的枚举。 |
LineIntent | 具有 3 个成员的枚举。 |
PolyIntent | 具有 4 个成员的枚举。 |
PredefinedAction | 具有71个成员的枚举。 |
PrinterMarkCornerPosition | 具有4个成员的枚举。 |
PrinterMarkSidePosition | 具有4个成员的枚举。 |
PrinterMarksKind | 具有7个成员的枚举。 |
ReplyType | ReplyType 枚举区分 Reply、Group 和 Undefined 回复类别。 |
RichTextFontStyles | 具有 4 个成员的枚举。 |
SoundIcon | 具有 2 个成员的枚举。 |
StampIcon | 具有 14 个成员的枚举。 |
TextAlignment | 具有3个成员的枚举。 |
TextIcon | 具有15个成员的枚举。 |
Drawing
| 类 | 描述 |
|---|
Circle | 具有7个方法的类。 |
Ellipse | 具有9个方法的类。 |
Graph | 包含16个方法的类。 |
Line | 包含3个方法的类。 |
Rectangle-Aspose_Pdf_Drawing | 包含11个方法的类。 |
Shape | 包含4个方法的类。 |
Facades
| 类 | 描述 |
|---|
AlignmentType | 包含4个方法的类。 |
Bookmark | 包含 35 个方法的类。 |
Bookmarks | 书签可以层次化组织;使用 Bookmark.ChildItem() 或 Bookmark.ChildItems() 来访问嵌套书签并设置诸如 Action、Destination 等属性,以及显示标志如 BoldFlag 和 ItalicFlag。 |
Facade | Facade.BindPdf 重载接受文件路径字符串 (srcFile) 或现有的 Aspose::Pdf::Document (srcDoc) 来加载 PDF 内容。 |
FormEditor | 包含 53 个方法的类。 |
FormFieldFacade | 包含30个方法和26个属性的类。 |
PdfAnnotationEditor | PdfAnnotationEditor 可以从 FDF 或 XFDF 文件导入批注,并将其扁平化到页面内容中,删除交互式元素。 |
PdfBookmarkEditor | PdfBookmarkEditor.CreateBookmarkOfPage(title, pageNumber) 添加一个指向指定页面的新书签。 |
PdfContentEditor | PdfContentEditor.ReplaceText(srcText, destText) 在整个文档中搜索并替换匹配的字符串,如果至少进行了一次替换则返回 true。 |
PdfConverter | 具有 37 个方法的类。 |
PdfExtractor | PdfExtractor 通过调用 ExtractText() 提取文本,然后使用 GetText(outputFile) 将提取的纯文本写入文件。 |
PdfFileEditor | 具有 72 个方法的类。 |
PdfFileInfo | PdfFileInfo 提供标准元数据字段(如 Author、Creator)的 getter 和 setter,以及通过 GetMetaInfo(name) 和 SetMetaInfo(name, value) 处理自定义键。 |
PdfFileSecurity | 包含 20 个方法的类。 |
PdfFileSignature | 包含 41 个方法的类。 |
PdfFileStamp | 包含 26 个方法和 8 个属性的类。 |
PdfPageEditor | 包含 28 个方法和 16 个属性的类。 |
PdfXmpMetadata | 具有15个方法的类。 |
SaveableFacade | SaveableFacade 提供了一个简单的接口,通过 Save(destFile) 将 PDF 对象持久化到文件路径。 |
SignatureName | SignatureName.HasSignature() 在 PDF 包含分离的 PKCS#7 签名时返回 true,ToString() 提供签名名称的文本表示。 |
VerticalAlignmentType | VerticalAlignmentType 提供静态工厂方法 Top()、Center() 和 Bottom() 来获取对齐对象,并通过 ToString() 获取它们的文本表示。 |
枚举
| 枚举 | 描述 |
|---|
Algorithm | 具有 2 个成员的枚举。 |
AutoRotateMode | 具有 3 个成员的枚举。 |
BlendingColorSpace | 具有 4 个成员的枚举。 |
DataType | 具有 6 个成员的枚举。 |
DefaultMetadataProperties | 具有9个成员的枚举。 |
EncodingType | 包含 7 个成员的枚举。 |
FieldType | 包含 13 个成员的枚举。 |
FontStyle | 包含 16 个成员的枚举。 |
ImageMergeMode | 包含 3 个成员的枚举。 |
KeySize | 具有 3 个成员的枚举。 |
PositioningMode | 具有 3 个成员的枚举。 |
PropertyFlag | 具有 4 个成员的枚举。 |
StampType | 具有 2 个成员的枚举。 |
SubmitFormFlag | 具有 6 个成员的枚举。 |
WordWrapMode | WordWrapMode 枚举定义了两种文本换行策略:Default 和 ByWords。 |
Forms
| 类 | 描述 |
|---|
BarcodeField | 具有 6 个方法的类。 |
ButtonField | 具有 11 个方法的类。 |
CheckboxField | 包含 16 个方法的类。 |
ChoiceField | 包含 14 个方法的类。 |
ComboBoxField | 包含 5 个方法的类。 |
DateField | 包含 4 个方法的类。 |
DocMDPSignature | 包含 1 个方法的类。 |
ExternalSignature | Pdf CPP 中的类 API。 |
Field | Field.Recalculate() 重新计算表单字段的值,并在成功时返回 true。 |
FileSelectBoxField | 包含 1 个方法的类。 |
Form | 表单文本框字段可以通过在 TextBoxField 实例上调用 AddBarcode(code) 程序化地添加条形码。 |
IconFit | IconFit 允许对表单字段的缩放进行细粒度控制;开发者可以在渲染前设置 ScalingReason、ScalingMode 和剩余边距。 |
ListBoxField | 包含 3 个方法的类。 |
NumberField | 包含 3 个方法的类。 |
Option | 具有 8 个方法的类。 |
OptionCollection | 包含 9 个方法的类。 |
PKCS1 | 包含 1 个方法的类。 |
PKCS7 | 包含 1 个方法的类。 |
PKCS7Detached | 包含 1 个方法的类。 |
PasswordBoxField | 包含 1 个方法的类。 |
RadioButtonField | 类包含 7 个方法。 |
RadioButtonOptionField | 类包含 5 个方法。 |
RichTextBoxField | RichTextBoxField 提供一个表单字段,用于存储带有样式、对齐方式和格式化值的富文本。 |
Signature | 签名对象允许在 PDF 文档上创建和验证分离的 PKCS#7 签名。 |
SignatureCustomAppearance | 具有 37 个方法的类。 |
SignatureField | 具有 2 个方法的类。 |
TextBoxField | 具有 15 个方法的类。 |
XFA | XFA 提供对基于 XML 的 XFA 表单数据的访问;调用 FieldNames() 将返回 XFA 文档中所有字段标识符的列表。 |
枚举
| 枚举 | 描述 |
|---|
BoxStyle | 具有 6 个成员的枚举。 |
DocMDPAccessPermissions | DocMDPAccessPermissions 枚举定义了对已签名 PDF 的允许修改方式:NoChanges 阻止任何编辑,FillingInForms 允许填写表单,AnnotationModification 允许更改批注。 |
FormType | 枚举包含 3 个成员。 |
IconCaptionPosition | 枚举包含 7 个成员。 |
ScalingMode | ScalingMode 枚举定义了图像变换的等比例和变形缩放选项。 |
ScalingReason | ScalingReason 枚举指示何时应应用缩放:Always、IconIsBigger、IconIsSmaller 或 Never。 |
SubjectNameElements | 具有 7 个成员的枚举。 |
Symbology | 具有 3 个成员的枚举。 |
另请参阅