本文介紹與文字文檔Paragraph相關的API。
Paragraphs
ActiveDocument.Range(Start, End).Paragraphs
擷取指定範圍中的所有段落。
JS-SDK V1.1.14及以上版本支援此功能。
僅PC端支援此功能。
文法
運算式.ActiveDocument.Range(Start, End).Paragraphs運算式:文件類型應用對象
樣本
async function example() { await instance.ready(); const app = instance.Application; //擷取指定範圍中的所有段落 const paragraphs = app.ActiveDocument.Range(0, 100).Paragraphs; }
方法
ActiveDocument.Range(Start, End).Paragraphs.Item()
通過Item()方法,您可以擷取單個段落對象。
JS-SDK V1.1.14及以上版本支援此功能。
文法
運算式.ActiveDocument.Range(Start, End).Paragraphs.Item(Index)運算式:文件類型應用對象
參數
屬性
資料類型
是否必填
描述
Index
Number
是
第Index個段落。
樣本
async function example() { await instance.ready(); const app = instance.Application; //擷取指定範圍中的所有段落 const paragraphs = app.ActiveDocument.Range(0, 100).Paragraphs; //擷取第1個段落對象 const paragraph = paragraphs.Item(1); }
屬性
ActiveDocument.Range(Start, End).Paragraphs.Count
通過Count屬性,您可以擷取指定範圍中的段落總數量。
JS-SDK V1.1.14及以上版本支援此功能。
文法
運算式.ActiveDocument.Range(Start, End).Paragraphs.Count運算式:文件類型應用對象
傳回值
返回
Number表示段落的總數量。樣本
async function example() { await instance.ready(); const app = instance.Application; //擷取指定範圍中的段落總數量 const count = await app.ActiveDocument.Range(0, 100).Paragraphs.Count; console.log(count); }
ActiveDocument.Range(Start, End).Paragraphs.Item(Index).Range
通過Range屬性,您可以擷取單個段落對象中包含的文檔部分。
JS-SDK V1.1.14及以上版本支援此功能。
文法
運算式.ActiveDocument.Range(Start, End).Paragraphs.Item(Index).Range運算式:文件類型應用對象
樣本
async function example() { await instance.ready(); const app = instance.Application; //擷取指定範圍中的所有段落 const paragraphs = app.ActiveDocument.Range(0, 100).Paragraphs; //擷取第1個段落對象 const paragraph = paragraphs.Item(1); //擷取該段落中包含的文檔部分 const range = await paragraph.Range; }
ParagraphFormat
ActiveDocument.Range(Start, End).ParagraphFormat
擷取指定範圍中段落的設定。
JS-SDK V1.1.10及以上版本支援此功能。
文法
運算式.ActiveDocument.Range(Start, End).ParagraphFormat或者
運算式.ActiveDocument.ActiveWindow.Selection.ParagraphFormat運算式:文件類型應用對象
樣本
async function example() { await instance.ready(); const app = instance.Application; //擷取指定範圍中段落的設定 const paragraphFormat = await app.ActiveDocument.Range(0, 20).ParagraphFormat; }
方法
ActiveDocument.Range(Start, End).ParagraphFormat.SetFixedLineSpacing(Value, Unit)
通過SetFixedLineSpacing()方法,您可以設定固定行間距。
文法
運算式.ActiveDocument.Range(Start, End).ParagraphFormat.SetFixedLineSpacing或者
運算式.ActiveDocument.ActiveWindow.Selection.ParagraphFormat運算式:文件類型應用對象
參數
屬性
資料類型
是否必填
描述
Value
Number
是
段落間距。磅支援0~1000數值範圍,厘米支援0~55數值範圍,毫米支援0~550數值範圍,英寸支援0~22數值範圍。
Unit
Enum
是
間距單位。
樣本
//@file=base.docx async function example() { await instance.ready(); const app = instance.Application; //段落對象 const paragraphFormat = await app.ActiveDocument.Range(0, 20).ParagraphFormat; //設定行間距為18磅固定行間距 await paragraphFormat.SetFixedLineSpacing(18, 0); }
ActiveDocument.Range(Start, End).ParagraphFormat.setParagraphAlignment
通過setParagraphAlignment()方法,您可以設定段落對齊。
JS-SDK V1.1.19及以上版本支援此功能。
文法
運算式.ActiveDocument.Range(Start, End).ParagraphFormat.setParagraphAlignment運算式:文件類型應用對象
參數
屬性
資料類型
是否必填
描述
Value
Enum
是
段落對齊。
樣本
async function example() { await instance.ready(); const app = instance.Application; // 段落對象 const paragraphFormat = await app.ActiveDocument.Range(0, 20).ParagraphFormat; // 置中對齊 paragraphFormat.setParagraphAlignment(app.Enum.WdAlignmentMode.wdCenter); }
屬性
ActiveDocument.Range(Start, End).ParagraphFormat.CharacterUnitFirstLineIndent
通過CharacterUnitFirstLineIndent屬性,您可以設定段落對象首行縮排。
JS-SDK V1.1.10及以上版本支援此功能。
文法
運算式.ActiveDocument.Range(Start, End).ParagraphFormat.CharacterUnitFirstLineIndent或者
運算式.ActiveDocument.ActiveWindow.Selection.ParagraphFormat運算式:文件類型應用對象
樣本
async function example() { await instance.ready(); const app = instance.Application; //擷取指定範圍中段落的設定 const paragraphFormat = await app.ActiveDocument.Range(0, 20).ParagraphFormat; //首行縮排2個單位 paragraphFormat.CharacterUnitFirstLineIndent = 2; }
ActiveDocument.Range(Start, End).ParagraphFormat.LineSpacingRule
通過LineSpacingRule屬性,您可以設定段落對象的行間距。更多資訊,請參見WdLineSpacing。
JS-SDK V1.1.10及以上版本支援此功能。
文法
運算式.ActiveDocument.Range(Start, End).ParagraphFormat.LineSpacingRule或者
運算式.ActiveDocument.ActiveWindow.Selection.ParagraphFormat運算式:文件類型應用對象
樣本
async function example() { await instance.ready(); const app = instance.Application; //擷取指定範圍中段落的設定 const paragraphFormat = await app.ActiveDocument.Range(0, 20).ParagraphFormat; //設定行距為1.5倍行距 paragraphFormat.LineSpacingRule = 1; }