C++ 的 Aspose.PDF FOSS

API reference 用于 Aspose.Pdf FOSS 用于 C++ v1.0.0. 244 个公共类型按模块组织。

核心 API

类描述
Artifact类,拥有 14 个方法。
ArtifactCollection类,拥有 7 个方法和 1 个属性。
BaseParagraph类,包含23个方法和1个属性。
BitmapInfoBitmapInfo 能够创建具有指定像素格式、宽度、高度和像素数据的原始位图图像,支持在没有外部依赖的情况下进行图像处理。
BmpDevice类,包含1个方法。
BorderInfo类,包含10个方法。
Cell具有 27 个方法的类。
Cells具有 9 个方法的类。
Color具有 147 个方法的类。
DeviceDevice 基类提供了一个虚拟析构函数,确保对派生的光栅‑设备对象(如 PngDevice 或 JpegDevice)进行正确的清理。
Document可以通过 Document.Info() 和访问器方法 Title()、Author()、Creator()、Producer()、Subject() 和 Keywords() 读取文档元数据。
DocumentDevice包含 4 个方法的类。
DocumentInfo包含 24 个方法和 1 个属性的类。
DocumentPrivilege包含 34 个方法的类。
EmbeddedFileCollection包含 9 个方法的类。
FileSpecificationFileSpecification 对象允许为嵌入的文件设置元数据,包括 MIME 类型、描述、Unicode 名称,以及通过 Encoding 属性进行压缩。
FloatingBox包含 12 个方法的类。
FontFont 类允许开发者查询字体是否嵌入在 PDF 中以及是否为子集化,从而实现对 PDF/A 的合规性检查。
FontRepository类有 2 个方法。
GraphInfo类有 25 个方法。
Hyperlink类有 6 个方法和 1 个属性。
ImageDevice类有 10 个方法。
JpegDevice包含 1 个方法的类。
LoadOptions包含 3 个方法的类。
MarginInfoMarginInfo 允许通过双精度的 getter 和 setter 精确控制页面边距,包括左、右、上、下的数值。
Margins包含 8 个方法的类。
MetadataMetadata 类实现了类似字典的接口,提供 Add(key, value)、Remove(key) 和 TryGetValue(key, value) 用于管理 XMP 元数据条目。
NamedDestinationCollection具有 6 个方法和 1 个属性的类。
OutlineCollectionPdf CPP API 中的类。
OutlineItemCollection具有 18 个方法的类。
Outlines具有 12 个方法的类。
Page页面标签(例如,罗马数字、自定义前缀)通过 PageLabel 和 PageLabelCollection 类进行管理。
PageCollectionPageCollection 类提供了添加新空白页、在特定位置插入页以及按编号或范围删除页的方法。
PageDevicePageDevice.Process(page, outputFileName) 可以直接将页面渲染到文件路径。
PageLabelPageLabel.StartingValue() 获取或设置页面标签序列的数字起始值。
PageLabelCollectionPageLabelCollection.GetLabel(pageIndex) 检索分配给特定页面的 PageLabel。
PageSizePageSize.Width() 和 Height() 用于获取或设置页面尺寸,而 IsLandscape() 表示方向。
Paragraphs包含 6 个方法的类。
PngDevice包含 3 个方法的类。
Point包含 6 个方法的类。
PositionPosition 类提供 XIndent 和 YIndent 的 getter 与 setter,用于微调注释的水平和垂直偏移。
Rectangle-Aspose_Pdf包含 28 个方法的类。
RenderingOptions包含 26 个方法的类。
ResolutionResolution 通过 X() 和 Y() 的 getter 与 setter 存储水平和垂直 DPI。
ResourcesClass 包含 3 个方法和 1 个属性。
RowClass 包含 23 个方法。
RowsRows 和 Row 类提供一个表格模型,用于构建具有每单元格样式、边框和内边距的 PDF 表格。
SvgLoadOptionsSvgLoadOptions 允许通过 AdjustPageSize 属性可选地调整页面尺寸来导入 SVG 文件。
TableTable 类让开发者能够构建 PDF 表格,全面控制行、列宽、边框、单元格内边距以及默认文本状态。
TextAbsorber类包含 6 个方法和 1 个属性。
TextBuilder类包含 2 个方法。
TextDevice类包含 3 个方法。
TextFragment包含 7 个方法的类。
TextFragmentAbsorber包含 4 个方法的类。
TextFragmentCollection包含 2 个方法的类。
TextFragmentState包含 1 个方法的类。
TextParagraph包含 18 个方法的类。
TextStateTextState 类提供对字体、字体大小、前景/背景/描边颜色以及诸如下划线、删除线、下标和上标等文本装饰的 getter 和 setter。
TiffDevice包含 11 个方法的类。
TiffSettings包含 13 个方法的类。
WatermarkArtifactPdf CPP 中的类 API。
XImageXImage 通过 Width() 和 Height() 方法公开图像的像素尺寸。
XImageCollectionXImageCollection 管理多个 XImage 对象,提供 Add、Replace、Delete 和 Clear 操作。
XmpValueXmpValue 提供转换助手:ToString()、ToInteger()、ToDouble()、ToArray(),以及类型查询方法,如 IsString() 和 IsArray()。

枚举

枚举描述
AFRelationship具有 7 个成员的枚举。
BorderSide具有 7 个成员的枚举。
ColorDepth具有 5 个成员的枚举。
CompressionType具有 5 个成员的枚举。
CryptoAlgorithmEnum 包含 4 个成员。
FileEncodingEnum 包含 2 个成员。
FormPresentationModeEnum 包含 2 个成员。
HorizontalAlignmentEnum 包含 6 个成员。
NumberingStyle具有6个成员的枚举。
PageCoordinateTypePageCoordinateType 枚举值 MediaBox 和 CropBox 让开发者选择用于坐标计算的页面矩形。
PasswordType包含 4 个成员的枚举。
PdfFormat包含 27 个成员的枚举。
Permissions包含 8 个成员的枚举。
RotationRotation 枚举提供四个方向值:None、on90、on180、on270。
ShapeTypeEnum 包含 3 个成员。
VerticalAlignmentEnum 包含 4 个成员。

注释

类描述
AnnotationClass 包含 36 个方法。
AnnotationCollection类,包含 11 个方法。
AnnotationSelector类,包含 35 个方法和 1 个属性。
BleedMarkAnnotationBleedMarkAnnotation.Accept(visitor) 实现了访问者模式,允许外部访问者对象在不暴露其内部结构的情况下处理该注解。
Border可以通过 Border 类的方法设置其 Width、Style、Effect、EffectIntensity 和角半径来自定义边框外观。
CaretAnnotation包含 5 个方法的类。
Characteristics包含 3 个方法的类。
CircleAnnotation包含 1 个方法的类。
ColorBarAnnotation包含 3 个方法的类。
CommonFigureAnnotation包含 5 个方法的类。
CornerPrinterMarkAnnotation包含 2 个方法的类。
DefaultAppearance包含 8 个方法的类。
ExplicitDestination包含 3 个方法的类。
FileAttachmentAnnotationFileAttachmentAnnotation.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 个方法的类。
InkAnnotationInkAnnotation 表示自由手绘墨迹;其 InkList 属性保存一个可以读取或替换的 StrokeList。
JavascriptActionJavascriptAction 封装了附加到 PDF 对象的 JavaScript 代码片段;可以通过 Script() 的 getter/setter 获取或更新该脚本。
LineAnnotation具有 25 个方法的类。
LinkAnnotationLinkAnnotation 在 PDF 中启用可点击区域,这些区域可以触发 PdfAction 或跳转到已命名的目标。
MarkupAnnotationMarkupAnnotation 提供用于设置审阅状态、不透明度、标题以及评论‑type 批注的富文本的方法。
MovieAnnotationMovieAnnotation 允许您在 PDF 中嵌入视频文件,并提供标题、海报标志、宽高比和旋转等属性。
NamedAction包含 3 个方法的类。
NamedDestination包含 2 个方法的类。
PageInformationAnnotation包含 1 个方法的类。
PdfActionPdfAction.GetECMAScriptString() 返回附加在 PDF 操作上的 JavaScript 代码,能够检查或修改交互脚本。
PolyAnnotation包含 11 个方法的类。
PolygonAnnotation包含 1 个方法的类。
PolylineAnnotation包含 1 个方法的类。
PopupAnnotation包含5个方法的类。
PrinterMarkAnnotationPrinterMarkAnnotation 可以通过 AddPrinterMarks 将裁切标记、出血标记、对准标记或颜色条等印刷标记插入整个文档或单个页面。
RedactionAnnotationRedactionAnnotation 允许您永久删除内容,同时可选择覆盖自定义文本、填充颜色、边框颜色和字体大小。
RegistrationMarkAnnotation包含3个方法的类。
RichMediaAnnotationRichMediaAnnotation 允许嵌入 Flash 或其他富媒体,并支持激活事件和自定义变量。
ScreenAnnotation包含 3 个方法的类。
SoundAnnotation包含 3 个方法的类。
SquareAnnotation包含 1 个方法的类。
SquigglyAnnotation包含 1 个方法的类。
StampAnnotation包含5个方法的类。
StrikeOutAnnotation包含1个方法的类。
SubmitFormAction包含5个方法的类。
TextAnnotation包含5个方法的类。
TextMarkupAnnotation包含 4 个方法的类。
TextStyle包含 9 个方法的类。
TrimMarkAnnotationTrimMarkAnnotation 和 UnderlineAnnotation 都通过 Accept 方法支持访问者模式,该方法将注解转发给访问者对象。
UnderlineAnnotation包含 1 个方法的类。
WatermarkAnnotationWatermarkAnnotation 允许在 PDF 页面上添加可视水印,并让开发者控制其透明度。
WidgetAnnotationWidgetAnnotation 提供对 AcroForm 字段属性的访问,例如 ReadOnly、Required、Exportable 和 DefaultAppearance。
XYZExplicitDestinationXYZExplicitDestination 通过 Left()、Top() 和 Zoom() 方法提供显式页面视图坐标。

枚举

枚举描述
AnnotationFlagsAnnotationFlags 枚举包含一个 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个成员的枚举。
ReplyTypeReplyType 枚举区分 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。
FacadeFacade.BindPdf 重载接受文件路径字符串 (srcFile) 或现有的 Aspose::Pdf::Document (srcDoc) 来加载 PDF 内容。
FormEditor包含 53 个方法的类。
FormFieldFacade包含30个方法和26个属性的类。
PdfAnnotationEditorPdfAnnotationEditor 可以从 FDF 或 XFDF 文件导入批注,并将其扁平化到页面内容中,删除交互式元素。
PdfBookmarkEditorPdfBookmarkEditor.CreateBookmarkOfPage(title, pageNumber) 添加一个指向指定页面的新书签。
PdfContentEditorPdfContentEditor.ReplaceText(srcText, destText) 在整个文档中搜索并替换匹配的字符串,如果至少进行了一次替换则返回 true。
PdfConverter具有 37 个方法的类。
PdfExtractorPdfExtractor 通过调用 ExtractText() 提取文本,然后使用 GetText(outputFile) 将提取的纯文本写入文件。
PdfFileEditor具有 72 个方法的类。
PdfFileInfoPdfFileInfo 提供标准元数据字段(如 Author、Creator)的 getter 和 setter,以及通过 GetMetaInfo(name) 和 SetMetaInfo(name, value) 处理自定义键。
PdfFileSecurity包含 20 个方法的类。
PdfFileSignature包含 41 个方法的类。
PdfFileStamp包含 26 个方法和 8 个属性的类。
PdfPageEditor包含 28 个方法和 16 个属性的类。
PdfXmpMetadata具有15个方法的类。
SaveableFacadeSaveableFacade 提供了一个简单的接口,通过 Save(destFile) 将 PDF 对象持久化到文件路径。
SignatureNameSignatureName.HasSignature() 在 PDF 包含分离的 PKCS#7 签名时返回 true,ToString() 提供签名名称的文本表示。
VerticalAlignmentTypeVerticalAlignmentType 提供静态工厂方法 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 个成员的枚举。
WordWrapModeWordWrapMode 枚举定义了两种文本换行策略:Default 和 ByWords。

Forms

类描述
BarcodeField具有 6 个方法的类。
ButtonField具有 11 个方法的类。
CheckboxField包含 16 个方法的类。
ChoiceField包含 14 个方法的类。
ComboBoxField包含 5 个方法的类。
DateField包含 4 个方法的类。
DocMDPSignature包含 1 个方法的类。
ExternalSignaturePdf CPP 中的类 API。
FieldField.Recalculate() 重新计算表单字段的值,并在成功时返回 true。
FileSelectBoxField包含 1 个方法的类。
Form表单文本框字段可以通过在 TextBoxField 实例上调用 AddBarcode(code) 程序化地添加条形码。
IconFitIconFit 允许对表单字段的缩放进行细粒度控制;开发者可以在渲染前设置 ScalingReason、ScalingMode 和剩余边距。
ListBoxField包含 3 个方法的类。
NumberField包含 3 个方法的类。
Option具有 8 个方法的类。
OptionCollection包含 9 个方法的类。
PKCS1包含 1 个方法的类。
PKCS7包含 1 个方法的类。
PKCS7Detached包含 1 个方法的类。
PasswordBoxField包含 1 个方法的类。
RadioButtonField类包含 7 个方法。
RadioButtonOptionField类包含 5 个方法。
RichTextBoxFieldRichTextBoxField 提供一个表单字段,用于存储带有样式、对齐方式和格式化值的富文本。
Signature签名对象允许在 PDF 文档上创建和验证分离的 PKCS#7 签名。
SignatureCustomAppearance具有 37 个方法的类。
SignatureField具有 2 个方法的类。
TextBoxField具有 15 个方法的类。
XFAXFA 提供对基于 XML 的 XFA 表单数据的访问;调用 FieldNames() 将返回 XFA 文档中所有字段标识符的列表。

枚举

枚举描述
BoxStyle具有 6 个成员的枚举。
DocMDPAccessPermissionsDocMDPAccessPermissions 枚举定义了对已签名 PDF 的允许修改方式:NoChanges 阻止任何编辑,FillingInForms 允许填写表单,AnnotationModification 允许更改批注。
FormType枚举包含 3 个成员。
IconCaptionPosition枚举包含 7 个成员。
ScalingModeScalingMode 枚举定义了图像变换的等比例和变形缩放选项。
ScalingReasonScalingReason 枚举指示何时应应用缩放:Always、IconIsBigger、IconIsSmaller 或 Never。
SubjectNameElements具有 7 个成员的枚举。
Symbology具有 3 个成员的枚举。

另请参阅

 中文