ApiParagraph

ApiParagraph 是 ApiParaPr 的子类。

方法

方法	返回值	描述
AddBookmarkCrossRef	boolean	向当前段落添加书签交叉引用。
AddCaption	boolean	在当前段落之后（或之前）添加题注段落。
AddCaptionCrossRef	boolean	向当前段落添加题注交叉引用。
AddColumnBreak	ApiRun	在当前位置添加分栏符，并从新栏开始下一个元素。
AddComment	ApiComment	向当前段落添加批注。
AddDrawing	ApiRun	向当前段落添加图形对象（图像、形状或图表）。
AddElement	boolean	向当前段落添加元素。
AddEndnoteCrossRef	boolean	向当前段落添加尾注交叉引用。
AddFootnoteCrossRef	boolean	向当前段落添加脚注交叉引用。
AddHeadingCrossRef	boolean	向当前段落添加标题交叉引用。
AddHyperlink	ApiHyperlink	向段落添加超链接。
AddInlineLvlSdt	ApiInlineLvlSdt	添加行内容器。
AddLineBreak	ApiRun	在当前位置添加换行符，并从新行开始下一个元素。
AddNumberedCrossRef	boolean	向当前段落添加编号交叉引用。
AddPageBreak	ApiRun	添加分页符，并从下一页开始下一个元素。
AddPageBreakBefore	ApiParagraph	在段落前强制分页。
AddPageNumber	ApiRun	将当前文档页码插入到段落中。
AddPagesCount	ApiRun	将当前文档的总页数插入到段落中。
AddTabStop	ApiRun	向当前段落添加制表位。
AddText	ApiRun	向当前段落添加文本。
Copy	ApiParagraph	创建段落副本。忽略批注、脚注引用和复杂域。
Delete	boolean	删除当前段落。
GetAllCharts	ApiChart[]	返回段落中的图表对象集合。
GetAllContentControls	ApiInlineLvlSdt[]	返回段落中的内容控件对象集合。
GetAllDrawingObjects	Drawing[]	返回段落中的图形对象集合。
GetAllImages	ApiImage[]	返回段落中的图像对象集合。
GetAllOleObjects	ApiOleObject[]	返回段落中的 OLE 对象集合。
GetAllShapes	ApiShape[]	返回段落中的形状对象集合。
GetBetweenBorder	Border | undefined	返回当前段落的段间边框。
GetBottomBorder	Border | undefined	返回当前段落的底部边框。
GetClassType	"paragraph"	返回 ApiParagraph 类的类型。
GetContextualSpacing	boolean | undefined	返回当前段落的上下文间距值。
GetElement	ParagraphContent	使用指定的位置返回段落元素。
GetElementsCount	number	返回当前段落中的元素数量。
GetFontNames	string[]	返回当前段落中所有元素的所有字体名称。
GetIndFirstLine	twips | undefined	返回段落首行缩进。
GetIndLeft	twips | undefined	返回段落左侧缩进。
GetIndRight	twips | undefined	返回段落右侧缩进。
GetInternalId	string	返回当前内容段落的内部 ID。
GetJc	"left" | "right" | "both" | "center" | undefined	返回段落内容对齐方式。
GetKeepLines	boolean | undefined	返回当前段落的保持行在一起值。
GetKeepNext	boolean | undefined	返回当前段落的与下段同页值。
GetLastRunWithText	ApiRun	返回当前段落中最后一个包含文本的 Run。
GetLeftBorder	Border | undefined	返回当前段落的左边框。
GetNext	ApiParagraph | null	返回下一个段落。
GetNumPr	ApiNumberingLevel | undefined	返回当前段落的编号级别，引用当前文档中的编号定义实例。
GetNumbering	ApiNumberingLevel	返回编号列表的编号定义和编号级别。
GetOutlineLvl	Number | undefined	返回指定属性的大纲级别。
GetPageBreakBefore	boolean | undefined	返回当前段落的段前分页值。
GetParaId	number	返回当前段落的唯一 ID。
GetParaPr	ApiParaPr	返回段落属性。
GetParagraphMarkTextPr	ApiTextPr	返回用于标记段落结尾的段落标记的文本属性。该标记也可以获取
GetParentContentControl	ApiBlockLvlSdt | null	返回包含当前段落的内容控件。
GetParentTable	ApiTable | null	返回包含当前段落的表格。
GetParentTableCell	ApiTableCell | null	返回包含当前段落的表格单元格。
GetPosInParent	Number	返回段落在其父元素中的位置。
GetPrevious	ApiParagraph	返回上一个段落。
GetRange	ApiRange | null	返回表示指定段落中包含的文档部分的 Range 对象。
GetRightBorder	Border | undefined	返回当前段落的右边框。
GetSection	ApiSection	返回段落所在的节。
GetShd	Shd | undefined	返回应用于段落内容的底纹。
GetSpacingAfter	twips	返回当前段落的段后间距值。
GetSpacingBefore	twips	返回当前段落的段前间距值。
GetSpacingLineRule	"auto" | "atLeast" | "exact" | undefined	返回段落行距规则。
GetSpacingLineValue	twips | line240 | undefined	返回段落行距值。
GetStyle	ApiStyle	返回段落样式方法。
GetTabs	TabStop[]	返回当前段落的自定义制表位。
GetText	string	返回段落文本。
GetTextPr	ApiTextPr	返回段落结束标记的文本属性。
GetTopBorder	Border | undefined	返回当前段落的顶部边框。
GetWidowControl	boolean | undefined	返回当前段落的孤行控制值。
InsertInContentControl	ApiParagraph | ApiBlockLvlSdt	用富文本内容控件包装段落对象。
InsertParagraph	ApiParagraph | null	在指定位置插入段落。
Last	ParagraphContent	返回段落的最后一个元素。
MoveCursorToEnd	boolean	将光标移动到段落末尾。
MoveCursorToStart	boolean	将光标移动到段落开头。
Push	boolean	向当前段落添加元素。
RemoveAllElements	boolean	从当前段落中移除所有元素。
RemoveElement	boolean	使用指定的位置移除元素。
ReplaceByElement	boolean	用新元素替换当前段落。
Search	ApiRange[]	在段落对象的范围内搜索。搜索结果是 ApiRange 对象的集合。
Select	boolean	选择当前段落。
SetBetweenBorder	boolean	指定在具有相同段落边框设置的一组段落中每个段落之间显示的边框。
SetBold	ApiParagraph	为文本字符设置粗体属性。
SetBottomBorder	boolean	指定在具有相同段落边框设置的一组段落下方显示的边框。
SetCaps	ApiParagraph	指定此段落中的任何小写字符仅格式化显示为其对应的大写字母。
SetColor	ApiParagraph	设置当前段落的文本颜色。
SetContextualSpacing	boolean	指定使用
SetDoubleStrikeout	ApiParagraph	指定此段落的内容显示为每个字符都有两条水平线穿过。
SetFontFamily	ApiParagraph	使用指定的字体系列设置所有 4 个字体槽。
SetFontSize	ApiParagraph	设置当前段落字符的字体大小。
SetHighlight	ApiParagraph	指定应用于当前段落内容背景的高亮颜色。
SetIndFirstLine	boolean	设置段落首行缩进。
SetIndLeft	boolean	设置段落左侧缩进。
SetIndRight	boolean	设置段落右侧缩进。
SetItalic	ApiParagraph	为文本字符设置斜体属性。
SetJc	boolean	设置段落内容对齐方式。
SetKeepLines	boolean	指定在使用页面视图呈现文档时，尽可能将当前段落的所有行保持在同一页上。
SetKeepNext	boolean	指定在使用分页视图呈现文档时，当前段落的内容至少
SetLeftBorder	boolean	指定将在指定段落周围的页面左侧显示的边框。
SetNumPr	boolean	指定当前段落引用当前文档中的编号定义实例。
SetNumbering	boolean	指定当前段落引用当前文档中的编号定义实例。
SetOutlineLvl	boolean	设置指定属性的大纲级别。
SetPageBreakBefore	boolean	指定在使用分页视图呈现文档时，当前段落的内容呈现在
SetParaId	boolean	为当前段落指定唯一 ID。
SetPosition	ApiParagraph	指定此段落的文本相对于默认
SetReadingOrder	ApiParagraph	指定当前段落的阅读顺序。
SetRightBorder	boolean	指定将在指定段落周围的页面右侧显示的边框。
SetSection	boolean	将指定的节设置到当前段落。
SetShd	boolean	指定应用于段落内容的底纹。
SetSmallCaps	ApiParagraph	指定此段落中的所有小写字母字符仅格式化显示为其对应的大写
SetSpacing	ApiParagraph	设置以二十分之一磅为单位测量的文本间距。
SetSpacingAfter	boolean	设置当前段落的段后间距。如果 isAfterAuto 参数的值为 true，则
SetSpacingBefore	boolean	设置当前段落的段前间距。如果 isBeforeAuto 参数的值为 true，则
SetSpacingLine	boolean	设置段落行距。如果 sLineRule 参数的值为
SetStrikeout	ApiParagraph	指定此段落的内容显示为中间有一条水平线穿过。
SetStyle	boolean	段落样式基础方法。
SetTabs	boolean	指定将用于当前段落中任何制表符的自定义制表位序列。
SetText	ApiRun	用指定文本替换段落内容。
SetTextPr	boolean	设置段落文本属性。
SetTopBorder	boolean	指定在具有相同段落边框设置的一组段落上方显示的边框。
SetUnderline	ApiParagraph	指定此段落的内容显示时，字符正下方会出现一条线
SetVertAlign	ApiParagraph | null	指定将应用于此段落内容的对齐方式，相对于段落文本的默认外观：
SetWidowControl	boolean	指定在显示时是否通过将当前段落的单独一行移动到下一页来使其与其余内容显示在不同的页面上。
ToHtml	string	将段落转换为 HTML。
ToJSON	JSON	将 ApiParagraph 对象转换为 JSON 对象。
WrapInMailMergeField	boolean	将段落内容包装在邮件合并域中。