Api

PDF API 的主类。用于获取当前文档，以及创建段落、表格、图像、批注和表单字段等页面内容。

方法

下表列出了可用的方法。

方法	返回值	描述
CentimetersToPoints	number	将厘米转换为磅。
Color	ApiColor	从通用输入创建 ApiColor。
CreateBlipFill	ApiFill	创建图片填充，使用所选图像作为对象背景应用于对象。
CreateBullet	ApiBullet	使用 sSymbol 参数指定的字符或符号为段落创建项目符号。
CreateButtonField	ApiButtonField	创建按钮字段。
CreateCaretAnnot	ApiCaretAnnotation	创建插入符号批注。
CreateChart	ApiChart | null	使用指定的参数创建图表。
CreateCheckboxField	ApiCheckboxField	创建复选框字段。
CreateCircleAnnot	ApiCircleAnnotation	创建圆形批注。
CreateComboboxField	ApiComboboxField	创建组合框字段。
CreateCustomGeometry	ApiGeometry	创建新的自定义几何图形。
CreateDateField	ApiTextField	创建文本日期字段。
CreateFreeTextAnnot	ApiFreeTextAnnotation	创建自由文本批注。
CreateGoToAction	ApiGoToAction	创建 GoTo 操作。
CreateGradientStop	ApiGradientStop	创建用于不同类型渐变的渐变光圈。
CreateHideShowFormsAction	ApiHideShowFormsAction	创建隐藏/显示表单操作。
CreateHighlightAnnot	ApiHighlightAnnotation	创建高亮批注。
CreateImage	ApiImage	使用指定的参数创建图像。
CreateImageField	ApiButtonField	创建图像字段。
CreateImageStampAnnot	ApiStampAnnotation	从图像创建图章注释。注释尺寸取自已加载的图像，或在图像加载后更新。
CreateInkAnnot	ApiInkAnnotation	创建墨迹批注。
CreateJsAction	ApiJsAction	创建 JS 操作。
CreateLineAnnot	ApiLineAnnotation	创建线条批注。
CreateLinearGradientFill	ApiFill	创建线性渐变填充，使用所选线性渐变作为对象背景应用于对象。
CreateLinkAnnot	ApiLinkAnnotation	创建链接注释。
CreateListboxField	ApiListboxField	创建列表框字段。
CreateMath	ApiMath	根据线性文本字符串创建数学公式。生成的对象可以像文本块一样插入到段落中（例如，通过 ApiParagraph#AddElement 或 ApiParagraph#Push）。
CreateNamedAction	ApiNamedAction	创建命名操作。
CreateNoFill	ApiFill	创建无填充并移除元素的填充。
CreateNumbering	ApiBullet | null | undefined	使用 numType 参数指定的编号字符或符号为段落创建项目符号。
CreateParagraph	ApiParagraph	创建新段落。
CreatePatternFill	ApiFill	创建图案填充，使用所选图案作为对象背景应用于对象。
CreatePolyLineAnnot	ApiPolyLineAnnotation	创建折线批注。
CreatePolygonAnnot	ApiPolygonAnnotation	创建多边形批注。
CreatePresetColor	ApiPresetColor	从可用的颜色预设中选择创建颜色。
CreatePresetGeometry	ApiGeometry | null | undefined	使用可用的预设形状之一创建几何图形。
CreateRGBColor	ApiRGBColor	通过设置红、绿、蓝颜色分量的适当值来创建 RGB 颜色。
CreateRadialGradientFill	ApiFill	创建径向渐变填充，使用所选径向渐变作为对象背景应用于对象。
CreateRadiobuttonField	ApiRadiobuttonField	创建单选按钮字段。
CreateRedactAnnot	ApiRedactAnnotation	创建涂黑批注。
CreateResetFormsAction	ApiHideShowFormsAction	创建重置表单操作。
CreateRichParaPr	ApiParaPr	创建空的富文本段落属性。
CreateRichParagraph	ApiRichParagraph	创建新的富文本段落。
CreateRichRun	ApiRichRun	创建新的富文本文字部分。
CreateRichTextPr	ApiTextPr	创建空的富文本属性。
CreateRun	ApiRun	创建要插入到当前段落或表格中的新的较小文本块。
CreateSchemeColor	ApiSchemeColor	从可用的配色方案中选择创建复杂配色方案。
CreateShadow	ApiShadow	创建可应用于图形对象的阴影。
CreateShape	ApiShape	使用指定的参数创建形状。
CreateShd	ApiShd	创建可应用于文本、段落、表格或表格单元格的底纹。
CreateSignatureField	ApiSignatureField	创建签名字段。
CreateSolidFill	ApiFill	创建纯色填充，使用所选纯色作为对象背景应用于对象。
CreateSquareAnnot	ApiSquareAnnotation	创建方形批注。
CreateStampAnnot	ApiStampAnnotation	创建图章批注。
CreateStrikeoutAnnot	ApiStrikeoutAnnotation	创建删除线批注。
CreateStroke	ApiStroke	创建为元素添加阴影的笔触。
CreateTable	ApiTable	创建表格。
CreateTableRowPr	ApiTableRowPr	创建空的表格行属性。
CreateTextAnnot	ApiTextAnnotation	创建文本批注。
CreateTextField	ApiTextField	创建文本字段。
CreateTextPr	ApiTextPr	创建空的文本属性。
CreateUnderlineAnnot	ApiUnderlineAnnotation	创建下划线批注。
CreateUriAction	ApiUriAction	创建 URI 操作。
EmusToMillimeters	mm	将英制度量单位 (EMU) 转换为毫米。
EmusToPoints	number	将 EMU（英制度量单位）转换为磅。
GetByInternalId	FloatObject | ApiDocumentContent | ApiParagraph | ApiTableRow | ApiTableCell	通过内部 ID 返回对象。
GetDocument	ApiDocument	使用指定的文本字段属性创建文本字段。
GetFullName	string	返回当前打开文件的完整名称。
HexColor	ApiColor	从十六进制字符串创建颜色。
InchesToPoints	number	将英寸转换为磅。
LinesToPoints	number	将行转换为磅（1 行 = 12 磅）。
MergeShapes	Drawing[] | null	将绘图对象数组合并为新形状。生成的形状采用数组中第一个绘图对象的格式。
MillimetersToEmus	EMU	将毫米转换为英制度量单位 (EMU)。
MillimetersToPixels	number	将毫米转换为像素。
MillimetersToPoints	number	将毫米转换为磅。
PicasToPoints	number	将派卡转换为磅。
PixelsToEmus	number	将像素转换为 EMU（英制度量单位）。
PixelsToPoints	number	将像素转换为磅。
PointsToCentimeters	number	将磅转换为厘米。
PointsToEmus	number	将磅转换为 EMU（英制度量单位）。
PointsToInches	number	将磅转换为英寸。
PointsToLines	number	将磅转换为行（1 行 = 12 磅）。
PointsToMillimeters	number	将磅转换为毫米。
PointsToPicas	number	将磅转换为派卡（1 派卡 = 12 磅）。
PointsToPixels	number	将磅转换为像素。
PointsToTwips	number	将磅转换为缇。
RGB	ApiColor	从红、绿、蓝分量创建 RGB 颜色。
RGBA	ApiColor	从红、绿、蓝和透明度分量创建 RGBA 颜色。
ThemeColor	ApiColor	创建主题颜色。
TwipsToPoints	number	将缇转换为磅。
attachEvent	无	订阅指定事件，并在事件触发时调用回调函数。
detachEvent	无	取消订阅指定事件。