跳到主要内容

ApiParagraph

表示 ApiParagraph 类。

方法​

方法返回值描述
AddBookmarkCrossRefboolean向当前段落添加书签交叉引用。💡 请注意，此段落必须在文档中。
AddCaptionboolean在当前段落之后（或之前）添加题注段落。💡 请注意，当前段落必须在文档中（不在页脚/页眉中）。如果当前段落位于形状中，则题注将添加到父形状之后（或之前）。
AddCaptionCrossRefboolean向当前段落添加题注交叉引用。💡 请注意，此段落必须在文档中。
AddColumnBreakApiRun在当前位置添加分栏符，并从新栏开始下一个元素。
AddCommentApiComment向当前段落添加批注。💡 请注意，此段落必须在文档中。
AddDrawingApiRun向当前段落添加图形对象（图像、形状或图表）。
AddElementboolean向当前段落添加元素。
AddEndnoteCrossRefboolean向当前段落添加尾注交叉引用。💡 请注意，此段落必须在文档中。
AddFootnoteCrossRefboolean向当前段落添加脚注交叉引用。💡 请注意，此段落必须在文档中。
AddHeadingCrossRefboolean向当前段落添加标题交叉引用。💡 请注意，此段落必须在文档中。
AddHyperlinkApiHyperlink向段落添加超链接。
AddInlineLvlSdtApiInlineLvlSdt添加行内容器。
AddLineBreakApiRun在当前位置添加换行符，并从新行开始下一个元素。
AddNumberedCrossRefboolean向当前段落添加编号交叉引用。💡 请注意，此段落必须在文档中。
AddPageBreakApiRun添加分页符，并从下一页开始下一个元素。
AddPageNumberApiRun将当前文档页码插入到段落中。
AddPagesCountApiRun将当前文档的总页数插入到段落中。
AddTabStopApiRun向当前段落添加制表位。
AddTextApiRun向当前段落添加文本。
CopyApiParagraph创建段落副本。忽略批注、脚注引用和复杂域。
Deleteboolean删除当前段落。
GetAllChartsApiChart[]返回段落中的图表对象集合。
GetAllContentControlsApiInlineLvlSdt[]返回段落中的内容控件对象集合。
GetAllDrawingObjectsDrawing[]返回段落中的图形对象集合。
GetAllImagesApiImage[]返回段落中的图像对象集合。
GetAllOleObjectsApiOleObject[]返回段落中的 OLE 对象集合。
GetAllShapesApiShape[]返回段落中的形状对象集合。
GetClassType"paragraph"返回 ApiParagraph 类的类型。
GetElementParagraphContent使用指定的位置返回段落元素。
GetElementsCountnumber返回当前段落中的元素数量。
GetFontNamesstring[]返回当前段落中所有元素的所有字体名称。
GetIndFirstLinetwips | undefined返回段落首行缩进。
GetIndLefttwips | undefined返回段落左侧缩进。
GetIndRighttwips | undefined返回段落右侧缩进。
GetInternalIdstring返回当前内容段落的内部 ID。
GetJc"left" | "right" | "both" | "center" | undefined返回段落内容对齐方式。
GetLastRunWithTextApiRun返回当前段落中最后一个包含文本的 Run。
GetNextApiParagraph | null返回下一个段落。
GetNumberingApiNumberingLevel返回编号列表的编号定义和编号级别。
GetOutlineLvlNumber返回指定属性的大纲级别。
GetParaIdnumber返回当前段落的唯一 ID。
GetParaPrApiParaPr返回段落属性。
GetParagraphMarkTextPrApiTextPr返回用于标记段落结尾的段落标记的文本属性。该标记也可以具有常见的文本属性，如粗体、斜体、下划线等。
GetParentContentControlApiBlockLvlSdt | null返回包含当前段落的内容控件。
GetParentTableApiTable | null返回包含当前段落的表格。
GetParentTableCellApiTableCell | null返回包含当前段落的表格单元格。
GetPosInParentNumber返回段落在其父元素中的位置。
GetPreviousApiParagraph返回上一个段落。
GetRangeApiRange | null返回表示指定段落中所包含文档部分的 Range 对象。在调用此方法之前，段落必须已附加到文档。
GetSectionApiSection返回段落所在的节。
GetShdApiColor返回应用于段落内容的底纹。
GetSpacingAftertwips返回当前段落的段后间距值。
GetSpacingBeforetwips返回当前段落的段前间距值。
GetSpacingLineRule"auto" | "atLeast" | "exact" | undefined返回段落行距规则。
GetSpacingLineValuetwips | line240 | undefined返回段落行距值。
GetStyleApiStyle返回段落样式方法。
GetTextstring返回段落文本。
GetTextPrApiTextPr返回段落结束标记的文本属性。
InsertInContentControlApiParagraph | ApiBlockLvlSdt用富文本内容控件包装段落对象。
InsertParagraphApiParagraph | null在指定位置插入段落。
LastParagraphContent返回段落的最后一个元素。
Pushboolean向当前段落添加元素。
RemoveAllElementsboolean从当前段落中移除所有元素。💡 当从段落中移除所有元素时，将自动创建一个新的空 Run。如果要向此 Run 添加内容，请使用 ApiParagraph#GetElement 方法。
RemoveElementboolean使用指定的位置移除元素。💡 如果移除的元素是段落的最后一个元素（即所有元素都从段落中移除），将自动创建一个新的空 Run。如果要向此 Run 添加内容，请使用 ApiParagraph#GetElement 方法。
ReplaceByElementboolean用新元素替换当前段落。
SearchApiRange[]在段落对象的范围内搜索。搜索结果是 ApiRange 对象的集合。
Selectboolean选择当前段落。
SetBetweenBorderboolean指定在具有相同段落边框设置的一组段落中每个段落之间显示的边框。
SetBoldApiParagraph为文本字符设置粗体属性。
SetBottomBorderboolean指定在具有相同段落边框设置的一组段落下方显示的边框。💡 连续的相同样式段落被视为一个整体，因此边框添加到整个块而不是块中的每个段落。
SetCapsApiParagraph指定此段落中的任何小写字符仅格式化显示为其对应的大写字母。
SetColorApiParagraph设置当前段落的文本颜色。
SetContextualSpacingboolean指定当前后段落具有相同段落样式时，使用 ApiParaPr#SetSpacingBefore 或 ApiParaPr#SetSpacingAfter 间距元素设置的此段落前后任何间距不应被应用，分别影响顶部和底部间距。
SetDoubleStrikeoutApiParagraph指定此段落的内容显示为每个字符都有两条水平线穿过。
SetFontFamilyApiParagraph使用指定的字体系列设置所有 4 个字体槽。
SetFontSizeApiParagraph设置当前段落字符的字体大小。
SetHighlightApiParagraph指定应用于当前段落内容背景的高亮颜色。
SetIndFirstLineboolean设置段落首行缩进。
SetIndLeftboolean设置段落左侧缩进。
SetIndRightboolean设置段落右侧缩进。
SetItalicApiParagraph为文本字符设置斜体属性。
SetJcboolean设置段落内容对齐方式。
SetKeepLinesboolean指定在使用页面视图呈现文档时，尽可能将当前段落的所有行保持在同一页上。
SetKeepNextboolean指定在使用分页视图呈现文档时，尽可能将当前段落的内容至少部分地与下一段落呈现在同一页上。
SetLeftBorderboolean指定将在指定段落周围的页面左侧显示的边框。
SetNumPrboolean指定当前段落引用当前文档中的编号定义实例。
SetNumberingboolean指定当前段落引用当前文档中的编号定义实例。
SetOutlineLvlboolean设置指定属性的大纲级别。
SetPageBreakBeforeboolean指定在使用分页视图呈现文档时，当前段落的内容呈现在文档新页的开头。
SetParaIdboolean为当前段落指定唯一 ID。
SetPositionApiParagraph指定此段落的文本相对于周围非定位文本的默认基线升高或降低的量。
SetReadingOrderApiParagraph指定当前段落的阅读顺序。可能的值有：null - 使用标准方向参数；"ltr" - 从左到右的文本方向；"rtl" - 从右到左的文本方向。
SetRightBorderboolean指定将在指定段落周围的页面右侧显示的边框。
SetSectionboolean将指定的节设置到当前段落。
SetShdboolean指定应用于段落内容的底纹。
SetSmallCapsApiParagraph指定此段落中的所有小写字母仅格式化显示为比指定字体大小小两磅的大写字母。
SetSpacingApiParagraph设置以二十分之一磅为单位测量的文本间距。
SetSpacingAfterboolean设置当前段落的段后间距。如果 isAfterAuto 参数的值为 true，则 nAfter 的任何值都将被忽略。如果未指定 isAfterAuto 参数，则将其解释为 false。
SetSpacingBeforeboolean设置当前段落的段前间距。如果 isBeforeAuto 参数的值为 true，则 nBefore 的任何值都将被忽略。如果未指定 isBeforeAuto 参数，则将其解释为 false。
SetSpacingLineboolean设置段落行距。如果 sLineRule 参数的值为 "atLeast" 或 "exact"，则 nLine 的值将被解释为磅的二十分之一。如果 sLineRule 参数的值为 "auto"，则 nLine 参数的值将被解释为行的 240 分之一。
SetStrikeoutApiParagraph指定此段落的内容显示为中间有一条水平线穿过。
SetStyleboolean段落样式基础方法。💡 此方法本身不单独使用，它仅构成 ApiParagraph#SetStyle 方法的基础，该方法为段落设置选定或创建的样式。
SetTabsboolean指定将用于当前段落中任何制表符的自定义制表位序列。警告：aPos 数组和 aVal 数组的长度必须相等。
SetTextPrboolean设置段落文本属性。
SetTopBorderboolean指定在具有相同段落边框设置的一组段落上方显示的边框。💡 连续的相同样式段落被视为一个整体，因此边框添加到整个块而不是块中的每个段落。
SetUnderlineApiParagraph指定此段落的内容显示时在字符正下方有一条线（小于行中字符上下的所有间距）。
SetVertAlignApiParagraph | null指定将应用于此段落内容相对于段落文本默认外观的对齐方式："baseline" - 当前段落中的字符将按默认文本基线对齐。"subscript" - 当前段落中的字符将对齐到默认文本基线下方。"superscript" - 当前段落中的字符将对齐到默认文本基线上方。
SetWidowControlboolean指定在显示时是否通过将当前段落的单独一行移动到下一页来使其与其余内容显示在不同的页面上。
ToJSONJSON将 ApiParagraph 对象转换为 JSON 对象。
WrapInMailMergeFieldboolean将段落内容包装在邮件合并域中。