段落(Paragraphs)

方法列表

方法	说明
GetHeadingLevel()	获取标题等级，返回 1-6 标题等级。0 表示选中的不是标题
SetHeader({ HeaderLevel })	设置标题等级
SetBlockquote()	设置为引用
SetOrderedList({ Type })	设置有序列表
SetBulletList({ Type })	设置无序列表
SetTask()	切换任务列表
IncreaseIndent()	增加缩进
DecreaseIndent()	减少缩进
SetIndent({ Level })	设置缩进
SetAlignType({ AlignType })	设置对齐方式

GetHeadingLevel()

获取标题等级，返回 1-6 标题等级。0 表示选中的不是标题

语法

表达式.ActiveOutline.Editor.Document.Paragraphs.GetHeadingLevel()

表达式：文档类型应用对象

返回值

返回 1-6 标题等级。0 表示选中的不是标题

示例

async function example() {
  await instance.ready();

  const app = await instance.Application;
  const editor = await app.ActiveOutline.Editor;
  const doc = await editor.Document;
  const paragraphs = await doc.Paragraphs;

  const GetHeadingLevel = await paragraphs.GetHeadingLevel();
  console.log('GetHeadingLevel: ', GetHeadingLevel);
}

SetHeader({ HeaderLevel })

设置标题等级

语法

表达式.ActiveOutline.Editor.Document.Paragraphs.SetHeader({ HeaderLevel })

表达式：文档类型应用对象

参数

属性	数据类型	默认值	必填	说明
HeaderLevel	Number		否	标题格式等级 0-6（注：0 为段落正文，1-6 为标题）

示例

async function example() {
  await instance.ready();

  const app = await instance.Application;
  const editor = await app.ActiveOutline.Editor;
  const doc = await editor.Document;
  const paragraphs = await doc.Paragraphs;

  // 设置标题格式等级 2
  await paragraphs.SetHeader(2);
}

SetBlockquote()

设置为引用

语法

表达式.ActiveOutline.Editor.Document.Paragraphs.SetBlockquote()

表达式：文档类型应用对象

示例

async function example() {
  await instance.ready();

  const app = await instance.Application;
  const editor = await app.ActiveOutline.Editor;
  const doc = await editor.Document;
  const paragraphs = await doc.Paragraphs;

  //设置为引用
  await paragraphs.SetBlockquote();
}

SetOrderedList({ Type })

设置有序列表

语法

表达式.ActiveOutline.Editor.Document.Paragraphs.SetOrderedList({ Type })

表达式：文档类型应用对象

参数

属性	数据类型	默认值	必填	说明
Type	String 或 Boolean		否	目前展示仅支持 decimal 类型，false 代表取消

示例

async function example() {
  await instance.ready();

  const app = await instance.Application;
  const editor = await app.ActiveOutline.Editor;
  const doc = await editor.Document;
  const paragraphs = await doc.Paragraphs;

  // 设置有序列表
  await paragraphs.SetOrderedList(true);
  // 取消有序列表
  // await paragraphs.SetOrderedList(false);
}

SetBulletList({ Type })

设置无序列表

语法

表达式.ActiveOutline.Editor.Document.Paragraphs.SetBulletList({ Type })

表达式：文档类型应用对象

参数

属性	数据类型	默认值	必填	说明
Type	String 或 Boolean		否	目前暂时仅支持 circle 类型，false 代表取消

示例

async function example() {
  await instance.ready();

  const app = await instance.Application;
  const editor = await app.ActiveOutline.Editor;
  const doc = await editor.Document;
  const paragraphs = await doc.Paragraphs;

  // 设置无序列表
  await paragraphs.SetBulletList(true);
  // 取消无序列表
  // await paragraphs.SetBulletList(false);
}

SetTask()

切换任务列表

语法

表达式.ActiveOutline.Editor.Document.Paragraphs.SetTask()

表达式：文档类型应用对象

示例

async function example() {
  await instance.ready();

  const app = await instance.Application;
  const editor = await app.ActiveOutline.Editor;
  const doc = await editor.Document;
  const paragraphs = await doc.Paragraphs;

  // 切换任务列表效果（之前没有任务列表效果则加上，有的话则去掉）
  await paragraphs.SetTask();
}

IncreaseIndent()

增加缩进

语法

表达式.ActiveOutline.Editor.Document.Paragraphs.IncreaseIndent()

表达式：文档类型应用对象

示例

async function example() {
  await instance.ready();

  const app = await instance.Application;
  const editor = await app.ActiveOutline.Editor;
  const doc = await editor.Document;
  const paragraphs = await doc.Paragraphs;

  // 增加缩进
  await paragraphs.IncreaseIndent();
}

DecreaseIndent()

减少缩进

语法

表达式.ActiveOutline.Editor.Document.Paragraphs.DecreaseIndent()

表达式：文档类型应用对象

示例

async function example() {
  await instance.ready();

  const app = await instance.Application;
  const editor = await app.ActiveOutline.Editor;
  const doc = await editor.Document;
  const paragraphs = await doc.Paragraphs;

  // 减少缩进
  await paragraphs.DecreaseIndent();
}

SetIndent({ Level })

设置缩进

语法

表达式.ActiveOutline.Editor.Document.Paragraphs.SetIndent({ Level })

表达式：文档类型应用对象

参数

属性	数据类型	默认值	必填	说明
Level	Number		否	缩进级别 0-6

示例

async function example() {
  await instance.ready();

  const app = await instance.Application;
  const editor = await app.ActiveOutline.Editor;
  const doc = await editor.Document;
  const paragraphs = await doc.Paragraphs;

  // 设置缩进
  await paragraphs.SetIndent(2);
}

SetAlignType({ AlignType })

设置对齐方式

语法

表达式.ActiveOutline.Editor.Document.Paragraphs.SetAlignType({ AlignType })

表达式：文档类型应用对象

参数

属性	数据类型	默认值	必填	说明
AlignType	String 或 Boolean		否	对齐方式 left/center/right

示例

async function example() {
  await instance.ready();

  const app = await instance.Application;
  const editor = await app.ActiveOutline.Editor;
  const doc = await editor.Document;
  const paragraphs = await doc.Paragraphs;

  // 设置对齐方式
  await paragraphs.SetAlignType('right');
  // 取消对齐列表
  // await paragraphs.SetAlignType(false);
}