Paragraph

本文介绍与文字文档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

    间距单位。更多信息,请参见WdLineSpacingUnit

  • 示例

    //@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;
    }