与文字文档Field相关的API有哪些_智能媒体管理(IMM)-阿里云帮助中心

本文介绍与文字文档Field相关的API。

Fields

ActiveDocument.Fields

获取文档中的所有域。

重要

JS-SDK V1.1.10及以上版本支持此功能。
在当前版本的文字文档中，用户使用@人插件后调用此API才有效。

语法
表达式.ActiveDocument.Fields
表达式：文档类型应用对象

示例

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

  const app = instance.Application;

  //获取文档中的所有域
  const Fields = await app.ActiveDocument.Fields;
}

方法

ActiveDocument.Fields.List()

通过List()方法，您可以获取文档中所有域的列表。

重要

JS-SDK V1.1.10及以上版本支持此功能。
在当前版本的文字文档中，您使用@人插件后调用此API才有效，例如插入一个@人就会有一项Item。

语法
表达式.ActiveDocument.Fields.List()
表达式：文档类型应用对象

示例

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

  const app = instance.Application;

  //获取文档中的所有域
  const Fields = await app.ActiveDocument.Fields;

  //获取文档中所有域的列表
  const List = await Fields.List;
  console.log(List);
}

Field

ActiveDocument.Fields.Item()

获取单个域对象。

重要

JS-SDK V1.1.10及以上版本支持此功能。
在当前版本的文字文档中，您使用@人插件后调用此API才有效，例如插入一个@人就会有一项Item。

语法
表达式.ActiveDocument.Fields.Item(Index)
表达式：文档类型应用对象

示例

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

  const app = instance.Application;

  //获取文档中的所有域
  const Fields = await app.ActiveDocument.Fields;

  //获取单个域对象
  const Field = await Fields.Item(1);
}

属性

ActiveDocument.Fields.Item(Index).Code

通过Code属性，您可以获取文档中单个域的Code。

重要

JS-SDK V1.1.10及以上版本支持此功能。

语法
表达式.ActiveDocument.Fields.Item(Index).Code
表达式：文档类型应用对象

示例

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

  const app = instance.Application;

  //获取文档中的所有域
  const Fields = await app.ActiveDocument.Fields;

  //获取单个域对象
  const Field = await Fields.Item(1);

  //获取文档中单个域的Code
  const Code = await Field.Code;
  console.log(Code);
}

ActiveDocument.Fields.Item(Index).Type

通过Type属性，您可以获取文档中单个域的类型。

重要

JS-SDK V1.1.10及以上版本支持此功能。

语法
表达式.ActiveDocument.Fields.Item(Index).Type
表达式：文档类型应用对象

示例

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

  const app = instance.Application;

  //获取文档中的所有域
  const Fields = await app.ActiveDocument.Fields;

  //获取单个域对象
  const Field = await Fields.Item(1);

  //获取文档中单个域的类型
  const Type = await Field.Type;
  console.log(Type);
}

DocumentFields

ActiveDocument.DocumentFields

获取文档中的所有公文域。

重要

JS-SDK V1.1.10及以上版本支持此功能。

语法
表达式.ActiveDocument.DocumentFields
表达式：文档类型应用对象

示例

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

  const app = instance.Application;
  
  //获取所有公文域
  const documentFields = await app.ActiveDocument.DocumentFields;
}

方法

ActiveDocument.DocumentFields.Add()

通过Add()方法，您可以插入公文域。

重要

JS-SDK V1.1.10及以上版本支持此功能。

语法
表达式.ActiveDocument.DocumentFields.Add({ Name, Range, Hidden, PrintOut, ReadOnly })
表达式：文档类型应用对象

参数

属性	数据类型	是否必填	描述
Name	String	是	公文域名称。
Range	Object	是	公文域范围。
Hidden	Boolean	否	是否隐藏。取值范围如下： false（默认）：显示。 true：隐藏。
PrintOut	Boolean	否	是否可打印。取值范围如下： true（默认）：可打印。 false：不可打印。
ReadOnly	Boolean	否	是否只读。取值范围如下： false（默认）：否。 true：是。

Range说明
属性
数据类型
是否必填
描述
Start
Number
是
开始位置。
End
Number
是
结束位置。
返回值
属性
数据类型
描述
params1
String
返回值1说明。
params2
Number
返回值2说明。

示例

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

  const app = instance.Application;
  
  //插入公文域
  await app.ActiveDocument.DocumentFields.Add({
    Name: '1',
    Range: { Start: 12, End: 20 },
    Hidden: false, //设置公文域显示
    PrintOut: true, //设置公文域可打印
    ReadOnly: true, //设置公文域可读写
  });
}

ActiveDocument.DocumentFields.AddDocumentFields()

通过AddDocumentFields()方法，您可以批量插入公文域。

重要

JS-SDK V1.1.10及以上版本支持此功能。

语法
表达式.ActiveDocument.DocumentFields.AddDocumentFields()
表达式：文档类型应用对象

参数

属性	数据类型	是否必填	描述
Name	String	是	公文域名称。
Range	Object	是	公文域范围。
Hidden	Boolean	否	是否隐藏。取值范围如下： false（默认）：显示。 true：隐藏。
PrintOut	Boolean	否	是否可打印。取值范围如下： true（默认）：可打印。 false：不可打印。
ReadOnly	Boolean	否	是否只读。取值范围如下： false（默认）：否。 true：是。
Value	String	否	域对应的值。

Range说明
属性
数据类型
是否必填
描述
Start
Number
是
开始位置。
End
Number
是
结束位置。

示例

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

  const app = instance.Application;
  
  //批量插入公文域
  await app.ActiveDocument.DocumentFields.AddDocumentFields([
    {
      Name: '1', //设置公文域名称
      Range: { Start: 0, End: 10 }, //设置公文域位置
      Value: 'WebOffice1', //设置公文域值
    },
    {
      Name: '2', //设置公文域名称
      Range: { Start: 12, End: 18 }, //设置公文域位置
      Value: 'WebOffice2', //设置公文域值
    },
  ]);
}

ActiveDocument.DocumentFields.Exists()

通过Exists()方法，您可以判断是否存在某个公文域。

重要

JS-SDK V1.1.10及以上版本支持此功能。

语法
表达式.ActiveDocument.DocumentFields.Exists({ Name })
表达式：文档类型应用对象
参数
属性
数据类型
是否必填
描述
Name
String
是
公文域名称。
返回值
返回Boolean表示是否存在某个公文域。

示例

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

  const app = instance.Application;
  
  //批量插入公文域
  await app.ActiveDocument.DocumentFields.AddDocumentFields([
    {
      Name: '1', //设置公文域名称
      Range: { Start: 0, End: 10 }, //设置公文域位置
      Value: 'WebOffice1', //设置公文域值
    },
    {
      Name: '2', //设置公文域名称
      Range: { Start: 12, End: 18 }, //设置公文域位置
      Value: 'WebOffice2', //设置公文域值
    },
  ]);

  //判断是否存在某个公文域
  const hasOne = await app.ActiveDocument.DocumentFields.Exists('1');
  console.log(hasOne); 
}

ActiveDocument.DocumentFields.GetAllNames()

通过GetAllNames()方法，您可以获取所有公文域的名称。

重要

JS-SDK V1.1.10及以上版本支持此功能。

语法
表达式.ActiveDocument.DocumentFields.GetAllNames()
表达式：文档类型应用对象
返回值
返回Array表示所有公文域的名称。

示例

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

  const app = instance.Application;
  
  //批量插入公文域
  await app.ActiveDocument.DocumentFields.AddDocumentFields([
    {
      Name: '1', //设置公文域名称
      Range: { Start: 0, End: 10 }, //设置公文域位置
      Value: 'WebOffice1', //设置公文域值
    },
    {
      Name: '2', //设置公文域名称
      Range: { Start: 12, End: 18 }, //设置公文域位置
      Value: 'WebOffice2', //设置公文域值
    },
  ]);

  //获取所有公文域的名称
  const names = await app.ActiveDocument.DocumentFields.GetAllNames();
  console.log(names);
}

ActiveDocument.DocumentFields.SetDocumentFieldsValues()

通过SetDocumentFieldsValues（）方法，您可以批量替换公文域内容。

重要

JS-SDK V1.1.19及以上版本支持此功能。

语法
表达式.ActiveDocument.DocumentFields.SetDocumentFieldsValues({Value, Data})

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

参数

属性	数据类型	是否必填	描述
Value	String	是	批量替换内容
Data	`Array.<Object>`	是	公文域的Index 或者 Name

Data数据说明

属性	数据类型	是否必填	描述
Index	Number	Index或Name，二选一	序列
Name	String	Index或Name，二选一	名称

示例

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

  const app = instance.Application;
  
   const dfs = [
        {
            Name: '2',
            Range: { Start: 30, End: 31 },
            Value: '2',
        },
        {
            Name: '3',
            Range: { Start: 33, End: 34 },
            Value: '3',
        },
        {
            Name: '4',
            Range: { Start: 35, End: 36 },
            Value: '4',
        }];
    await app.ActiveDocument.DocumentFields.AddDocumentFields(dfs);
    await app.ActiveDocument.DocumentFields.SetDocumentFieldsValues({ Value: "公文域批量替换", Arrays: [{Name: '2'}, {Name: '3'}, {Name: '4'}] });

}

属性

ActiveDocument.DocumentFields.Count

通过Count属性，您可以获取公文域的个数。

重要

JS-SDK V1.1.10及以上版本支持此功能。

语法
表达式.ActiveDocument.DocumentFields.Count
表达式：文档类型应用对象
返回值
返回Number表示公文域的个数。

示例

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

  const app = instance.Application;
  
  //获取公文域的个数
  const count = app.ActiveDocument.DocumentFields.Count;
  console.log(count);
}

ActiveDocument.DocumentFields.Display

通过Display属性，您可以查看公文域的底纹显方式。

重要

JS-SDK V1.1.11及以上版本支持此功能。

语法
表达式.ActiveDocument.DocumentFields.Display
表达式：文档类型应用对象
返回值
返回 Number表示公文域的底纹显示方式。关于公文域底纹类型说明，请参见WdDisplayDocumentFields。

示例

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

  const app = instance.Application;
  
  //查看公文域的底纹显示方式
  app.ActiveDocument.DocumentFields.Display = instance.Enum.WdDisplayDocumentFields.wpsDisplayDocumentFields;
}

DocumentField

ActiveDocument.DocumentFields.Item()

获取单个公文域对象。

重要

JS-SDK V1.1.10及以上版本支持此功能。

语法
表达式.ActiveDocument.DocumentFields.Item({ Index, Name })
表达式：文档类型应用对象
参数
属性
数据类型
是否必填
描述
Index
Number
否
公文域索引。
Name
String
否
公文域名称。
返回值
返回DocumentField表示单个公文域。

示例

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

  const app = instance.Application;
  
  //插入公文域
  await app.ActiveDocument.DocumentFields.Add({
    Name: '1',
    Range: { Start: 12, End: 20 },
    Hidden: false, //设置公文域显示
    PrintOut: true, //设置公文域可打印
    ReadOnly: true, //设置公文域可读写
  });

  //获取单个公文域对象
  const documentField = await app.ActiveDocument.DocumentFields.Item('1');
  console.log(documentField);
}

方法

ActiveDocument.DocumentFields.Item({ Index, Name }).Delete()

通过Delete()方法，您可以删除单个公文域。

重要

JS-SDK V1.1.10及以上版本支持此功能。

语法
表达式.ActiveDocument.DocumentFields.Item({ Index, Name }).Delete()
表达式：文档类型应用对象

示例

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

  const app = instance.Application;
  
  //插入公文域
  await app.ActiveDocument.DocumentFields.Add({
    Name: '1',
    Range: { Start: 12, End: 20 },
    Hidden: false, //设置公文域显示
    PrintOut: true, //设置公文域可打印
    ReadOnly: true, //设置公文域可读写
  });

  //获取单个公文域对象
  const documentField = await app.ActiveDocument.DocumentFields.Item('1');

  //删除该公文域
  await documentField.Delete();
}

ActiveDocument.DocumentFields.Item({ Index, Name }).GotoBegin()

通过GotoBegin()方法，您可以跳转到指定公文域的开始位置。

重要

JS-SDK V1.1.10及以上版本支持此功能。

语法
表达式.ActiveDocument.DocumentFields.Item({ Index, Name }).GotoBegin()
表达式：文档类型应用对象

示例

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

  const app = instance.Application;
  
  //插入公文域
  await app.ActiveDocument.DocumentFields.Add({
    Name: '1',
    Range: { Start: 12, End: 20 },
    Hidden: false, //设置公文域显示
    PrintOut: true, //设置公文域可打印
    ReadOnly: true, //设置公文域可读写
  });

  //获取单个公文域对象
  const documentField = await app.ActiveDocument.DocumentFields.Item('1');

  //跳转到该公文域的开始位置
  await documentField.GotoBegin();
}

ActiveDocument.DocumentFields.Item({ Index, Name }).GotoEnd()

通过GotoEnd()方法，您可以跳转到指定公文域的结束位置。

重要

JS-SDK V1.1.10及以上版本支持此功能。

语法
表达式.ActiveDocument.DocumentFields.Item({ Index, Name }).GotoEnd()
表达式：文档类型应用对象

示例

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

  const app = instance.Application;
  
  //插入公文域
  await app.ActiveDocument.DocumentFields.Add({
    Name: '1',
    Range: { Start: 12, End: 20 },
    Hidden: false, //设置公文域显示
    PrintOut: true, //设置公文域可打印
    ReadOnly: true, //设置公文域可读写
  });

  //获取单个公文域对象
  const documentField = await app.ActiveDocument.DocumentFields.Item('1');

  //跳转到该公文域的结束位置
  await documentField.GotoEnd();
}

属性

ActiveDocument.DocumentFields.Item({ Index, Name }).Hidden

通过Hidden属性，您可以查看指定公文域是否隐藏。

重要

JS-SDK V1.1.10及以上版本支持此功能。

语法
表达式.ActiveDocument.DocumentFields.Item({ Index, Name }).Hidden
表达式：文档类型应用对象
返回值
返回Boolean表示该公文域是否隐藏。

示例

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

  const app = instance.Application;
  
  //插入公文域
  await app.ActiveDocument.DocumentFields.Add({
    Name: '1',
    Range: { Start: 12, End: 20 },
    Hidden: true, //设置公文域显示
    PrintOut: true, //设置公文域可打印
    ReadOnly: true, //设置公文域可读写
  });

  //获取单个公文域对象
  const documentField = await app.ActiveDocument.DocumentFields.Item('1');

  //查看该公文域是否隐藏
  const isHidden = await documentField.Hidden;
  console.log(isHidden);
}

ActiveDocument.DocumentFields.Item({ Index, Name }).Name

通过Name属性，您可以获取指定公文域的名称。

重要

JS-SDK V1.1.10及以上版本支持此功能。

语法
表达式.ActiveDocument.DocumentFields.Item({ Index, Name }).Name
表达式：文档类型应用对象
返回值
返回String表示该公文域的名称。

示例

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

  const app = instance.Application;
  
  //插入公文域
  await app.ActiveDocument.DocumentFields.Add({
    Name: '1',
    Range: { Start: 12, End: 20 },
    Hidden: true, //设置公文域显示
    PrintOut: true, //设置公文域可打印
    ReadOnly: true, //设置公文域可读写
  });

  //获取单个公文域对象
  const documentField = await app.ActiveDocument.DocumentFields.Item('1');
  console.log(documentField);

  //获取该公文域的名称
  const name = await documentField.Name;
  console.log(name);
}

ActiveDocument.DocumentFields.Item({ Index, Name }).PrintOut

通过PrintOut属性，您可以查看指定公文域是否可打印。

重要

JS-SDK V1.1.10及以上版本支持此功能。

语法
表达式.ActiveDocument.DocumentFields.Item({ Index, Name }).PrintOut
表达式：文档类型应用对象
返回值
返回Boolean表示该公文域是否可打印。

示例

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

  const app = instance.Application;
  
  //插入公文域
  await app.ActiveDocument.DocumentFields.Add({
    Name: '1',
    Range: { Start: 12, End: 20 },
    Hidden: false, //设置公文域显示
    PrintOut: true, //设置公文域可打印
    ReadOnly: true, //设置公文域可读写
  });

  //获取单个公文域对象
  const documentField = await app.ActiveDocument.DocumentFields.Item('1');

  //查看该公文域是否可打印
  const isPrintOut = await documentField.PrintOut;
  console.log(isPrintOut);
}

ActiveDocument.DocumentFields.Item({ Index, Name }).Range

通过Range属性，您可以获取指定公文域的范围。

重要

JS-SDK V1.1.10及以上版本支持此功能。

语法
表达式.ActiveDocument.DocumentFields.Item({ Index, Name }).Range
表达式：文档类型应用对象
返回值
返回Range表示该公文域的范围。

示例

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

  const app = instance.Application;
  
  //插入公文域
  await app.ActiveDocument.DocumentFields.Add({
    Name: '1',
    Range: { Start: 12, End: 20 },
    Hidden: false, //设置公文域显示
    PrintOut: true, //设置公文域可打印
    ReadOnly: true, //设置公文域可读写
  });

  //获取单个公文域对象
  const documentField = await app.ActiveDocument.DocumentFields.Item('1');

  //获取指定公文域的范围
  const range = await documentField.Range;
  console.log(range);
}

ActiveDocument.DocumentFields.Item({ Index, Name }).ReadOnly

通过ReadOnly属性，您可以查看指定公文域是否只读。

重要

JS-SDK V1.1.10及以上版本支持此功能。

语法
表达式.ActiveDocument.DocumentFields.Item({ Index, Name }).ReadOnly
表达式：文档类型应用对象
返回值
返回Boolean表示该公文域是否只读。

示例

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

  const app = instance.Application;
  
  //插入公文域
  await app.ActiveDocument.DocumentFields.Add({
    Name: '1',
    Range: { Start: 12, End: 20 },
    Hidden: true, //设置公文域显示
    PrintOut: true, //设置公文域可打印
    ReadOnly: true, //设置公文域可读写
  });

  //获取单个公文域对象
  const documentField = await app.ActiveDocument.DocumentFields.Item('1');

  //查看该公文域是否只读
  const isReadOnly = await documentField.ReadOnly;
  console.log(isReadOnly);
}

ActiveDocument.DocumentFields.Item({ Index, Name }).Style

通过Style属性，您可以查看指定公文域的样式。

语法
表达式.ActiveDocument.DocumentFields.Item({ Index, Name }).Style
表达式：文档类型应用对象
返回值
返回Style表示该公文域的样式。

示例

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

  const app = instance.Application;
  
  //插入公文域
  await app.ActiveDocument.DocumentFields.Add({
    Name: '1',
    Range: { Start: 12, End: 20 },
    Hidden: true, //设置公文域显示
    PrintOut: true, //设置公文域可打印
    ReadOnly: true, //设置公文域可读写
  });

  //获取单个公文域对象
  const documentField = await app.ActiveDocument.DocumentFields.Item('1');

  //查看该公文域的样式
  const style = await documentField.Style;
  console.log(style);
}

ActiveDocument.DocumentFields.Item({ Index, Name }).Value

通过Value属性，您可以获取指定公文域的值。

重要

JS-SDK V1.1.10及以上版本支持此功能。

语法
表达式.ActiveDocument.DocumentFields.Item({ Index, Name }).Value
表达式：文档类型应用对象
返回值
返回String表示对应公文域的值。

示例

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

  const app = instance.Application;
  
  //插入公文域
  await app.ActiveDocument.DocumentFields.Add({
    Name: '1',
    Range: { Start: 12, End: 20 },
    Hidden: true, //设置公文域显示
    PrintOut: true, //设置公文域可打印
    ReadOnly: true, //设置公文域可读写
  });

  //获取单个公文域对象
  const documentField = await app.ActiveDocument.DocumentFields.Item('1');

  //获取该公文域的值
  const value = await documentField.Value;
  console.log(value);
}