本文介绍与文字文档WaterMark相关的API。
WaterMarks
ActiveDocument.Sections.Item(Index).WaterMarks
获取单个节对象的所有水印。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.ActiveDocument.Sections.Item(Index).WaterMarks
表达式:文档类型应用对象
参数
属性
数据类型
是否必填
描述
Index
Number
是
示例
async function example() { await instance.ready(); const app = instance.Application; //获取单个节对象的所有水印 const waterMarks = await app.ActiveDocument.Sections.Item(1).WaterMarks; }
方法
ActiveDocument.Sections.Item(Index).WaterMarks.AddTemplateWaterMark()
通过AddTemplateWaterMark()
方法,您可以插入模板水印。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.ActiveDocument.Sections.Item(Index).WaterMarks.AddTemplateWaterMark({ Index, ApplyTo })
表达式:文档类型应用对象
参数
属性
数据类型
是否必填
描述
Index
Number
是
使用预设的模板水印的索引。
ApplyTo
Number
否
插入的位置。取值范围如下:
0:当前节。
1(默认):整个文档。
示例
async function example() { await instance.ready(); const app = instance.Application; //获取单个节对象的所有水印 const waterMarks = await app.ActiveDocument.Sections.Item(1).WaterMarks; //在整个文档插入第2个预设的模板水印 waterMarks.AddTemplateWaterMark({ Index: 2, ApplyTo: 1, }); }
ActiveDocument.Sections.Item(Index).WaterMarks.AddTextWaterMark()
通过AddTextWaterMark()
方法,您可以插入文字水印。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.ActiveDocument.Sections.Item(Index).WaterMarks.AddTextWaterMark({ Text, FontName, FontSize, FontColor, Transparency, Gradient })
表达式:文档类型应用对象
参数
属性
数据类型
是否必填
描述
Text
String
是
水印文本。
FontName
String
是
水印字体类型。
FontSize
Number
是
水印字体大小。
FontColor
String
是
水印字体颜色,默认值为0xC0C0C0。
Transparency
Number
是
水印透明度。取值范围为0(完全透明)~1(完全不透明)。
Gradient
Boolean
是
水印是否倾斜。取值范围如下:
false(默认):不倾斜。
true:倾斜。
ApplyTo
Number
是
水印插入位置。取值范围如下:
0:当前节。
1(默认):整个文档。
示例
async function example() { await instance.ready(); const app = instance.Application; //获取单个节对象的所有水印 const waterMarks = await app.ActiveDocument.Sections.Item(1).WaterMarks; //在整个文档插入文字水印 await waterMarks.AddTextWaterMark({ Text: '水印文本', //水印文本 FontName: '宋体', //水印字体类型 FontSize: 40, //水印字体大小 FontColor: '#171717', //水印字体颜色 Transparency: 0.3, //透明度 Gradient: false, //倾斜度 ApplyTo: 1, //插入位置 }); }
ActiveDocument.Sections.Item(Index).WaterMarks.DeleteWaterMark()
通过DeleteWaterMark()
方法,您可以删除水印。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.ActiveDocument.Sections.Item(Index).WaterMarks.DeleteWaterMark()
表达式:文档类型应用对象
示例
async function example() { await instance.ready(); const app = instance.Application; //获取单个节对象的所有水印 const waterMarks = await app.ActiveDocument.Sections.Item(1).WaterMarks; //删除水印 waterMarks.DeleteWaterMark(); }
ActiveDocument.Sections.Item(Index).WaterMarks.EditTextWaterMark()
通过EditTextWaterMark()
方法,您可以编辑水印。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.ActiveDocument.Sections.Item(Index).WaterMarks.EditTextWaterMark({ Text, FontName, FontSize, FontColor, Transparency, Gradient })
表达式:文档类型应用对象
参数
属性
数据类型
是否必填
描述
Text
String
是
水印文本。
FontName
String
是
水印字体类型。
FontSize
Number
是
水印字体大小。
FontColor
String
是
水印字体颜色,默认值为0xC0C0C0。
Transparency
Number
是
水印透明度。
Gradient
Boolean
是
水印倾斜度。取值范围如下:
false(默认):不倾斜。
true:倾斜。
ApplyTo
Number
是
水印插入位置。取值范围如下:
0:当前节。
1(默认):整个文档。
示例
async function example() { await instance.ready(); const app = instance.Application; //获取单个节对象的所有水印 const waterMarks = await app.ActiveDocument.Sections.Item(1).WaterMarks; //编辑水印 await waterMarks.EditTextWaterMark({ Text: '水印文本', //水印文本 FontName: '宋体', //水印字体类型 FontSize: 66, //水印字体大小 FontColor: '#f00', //水印字体颜色 Transparency: 1, //透明度 Gradient: true, //倾斜度 ApplyTo: 1, //插入位置 }); }
WaterMark
ActiveDocument.Sections.Item(Index).WaterMarks.Item(Index)
获取单个节对象中的单个水印对象。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.ActiveDocument.Sections.Item(Index).WaterMarks.Item(Index)
表达式:文档类型应用对象
参数
属性
数据类型
是否必填
描述
Index
Number
是
第Index个水印对象。
示例
async function example() { await instance.ready(); const app = instance.Application; //获取单个节对象的所有水印 const waterMarks = await app.ActiveDocument.Sections.Item(1).WaterMarks; //获取单个水印对象 const waterMark = await waterMarks.Item(1); }
属性
ActiveDocument.Sections.Item(Index).WaterMarks.Item(Index).FontColor
通过FontColor
属性,您可以设置水印的字体颜色。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.ActiveDocument.Sections.Item(Index).WaterMarks.Item(Index).FontColor
表达式:文档类型应用对象
示例
async function example() { await instance.ready(); const app = instance.Application; //获取单个节对象的所有水印 const waterMarks = await app.ActiveDocument.Sections.Item(1).WaterMarks; //获取单个水印对象 const waterMark = await waterMarks.Item(1); //设置水印的字体颜色 waterMark.FontColor = '#fff000'; }
ActiveDocument.Sections.Item(Index).WaterMarks.Item(Index).FontName
通过FontName
属性,您可以设置水印的字体类型。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.ActiveDocument.Sections.Item(Index).WaterMarks.Item(Index).FontName
表达式:文档类型应用对象
示例
async function example() { await instance.ready(); const app = instance.Application; //获取单个节对象的所有水印 const waterMarks = await app.ActiveDocument.Sections.Item(1).WaterMarks; //获取单个水印对象 const waterMark = await waterMarks.Item(1); //设置水印的字体类型 waterMark.FontName = '楷体'; }
ActiveDocument.Sections.Item(Index).WaterMarks.Item(Index).FontSize
通过FontSize
属性,您可以设置水印的字体大小。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.ActiveDocument.Sections.Item(Index).WaterMarks.Item(Index).FontSize
表达式:文档类型应用对象
示例
async function example() { await instance.ready(); const app = instance.Application; //获取单个节对象的所有水印 const waterMarks = await app.ActiveDocument.Sections.Item(1).WaterMarks; //获取单个水印对象 const waterMark = await waterMarks.Item(1); //设置水印的字体大小 waterMark.FontSize = 80; }
ActiveDocument.Sections.Item(Index).WaterMarks.Item(Index).Gradient
通过Gradient
属性,您可以设置水印的倾斜度。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.ActiveDocument.Sections.Item(Index).WaterMarks.Item(Index).Gradient
表达式:文档类型应用对象
示例
async function example() { await instance.ready(); const app = instance.Application; //获取单个节对象的所有水印 const waterMarks = await app.ActiveDocument.Sections.Item(1).WaterMarks; //获取单个水印对象 const waterMark = await waterMarks.Item(1); //设置水印的倾斜度 waterMark.Gradient = true; }
ActiveDocument.Sections.Item(Index).WaterMarks.Item(Index).Text
通过Text
属性,您可以设置水印的文本。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.ActiveDocument.Sections.Item(Index).WaterMarks.Item(Index).Text
表达式:文档类型应用对象
示例
async function example() { await instance.ready(); const app = instance.Application; //获取单个节对象的所有水印 const waterMarks = await app.ActiveDocument.Sections.Item(1).WaterMarks; //获取单个水印对象 const waterMark = await waterMarks.Item(1); //设置水印的文本 waterMark.Text = 'Aliyun'; }
ActiveDocument.Sections.Item(Index).WaterMarks.Item(Index).Transparency
通过Transparency
属性,您可以设置水印的透明度。
JS-SDK V1.1.10及以上版本支持此功能。
语法
表达式.ActiveDocument.Sections.Item(Index).WaterMarks.Item(Index).Transparency
表达式:文档类型应用对象
示例
async function example() { await instance.ready(); const app = instance.Application; //获取单个节对象的所有水印 const waterMarks = await app.ActiveDocument.Sections.Item(1).WaterMarks; //获取单个水印对象 const waterMark = await waterMarks.Item(1); //设置水印的透明度 waterMark.Transparency = 0; }