WPS WebOffice 开放平台WPS WebOffice 开放平台 | 开发文档

深色模式

水印(WaterMarks) ​

仅支持PC端

水印对象

语法 ​

表达式.ActiveDocument.Sections.Item(Index).WaterMarks

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

参数 ​

属性数据类型默认值必填说明
Index
Number
是
第 Index 个代表所选内容、范围或文档中的部分

示例 ​

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 水印对象
  const waterMarks = await app.ActiveDocument.Sections.Item(1).WaterMarks
}

方法列表 ​

方法说明
AddTemplateWaterMark()
插入模板水印
AddTextWaterMark()
插入文字水印
DeleteWaterMark()
删除水印
EditTextWaterMark()
编辑水印
Item(Index)
单个水印对象，返回 WaterMark 对象
Item().FontColor
水印的字体颜色设置
Item().FontName
水印的字体类型设置
Item().FontSize
水印的字体大小设置
Item().Gradient
水印的倾斜度设置
Item().Text
水印的文本设置
Item().Transparency
水印的透明度设置

AddTemplateWaterMark() ​

仅支持PC端

插入模板水印

语法 ​

表达式.ActiveDocument.Sections.Item(Index).WaterMarks.AddTemplateWaterMark({ Index, ApplyTo })

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

参数 ​

属性数据类型默认值必填说明
Index
Number
是
使用预设的模板水印的索引
ApplyTo
Number
否
插入的位置：0-当前节，1-整个文档

示例 ​

js
//@file=base.docx
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
  })
}

AddTextWaterMark() ​

仅支持PC端

插入文字水印

语法 ​

表达式.ActiveDocument.Sections.Item(Index).WaterMarks.AddTextWaterMark({ Text, FontName, FontSize, FontColor, Transparency, Gradient })

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

参数 ​

属性数据类型默认值必填说明
Text
String
是
水印文本
FontName
String
是
水印字体类型
FontSize
Number
是
水印字体大小
FontColor
String
0xC0C0C0
是
水印字体颜色
Transparency
Number
是
透明度
Gradient
Boolean
是
倾斜度
ApplyTo
Number
整个文档
是
插入位置

示例 ​

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 水印对象
  const waterMarks = await app.ActiveDocument.Sections.Item(1).WaterMarks

  // 插入文字水印
  await waterMarks.AddTextWaterMark({
    Text: '水印文本', // Text：水印文本
    FontName: '宋体', // FontName：水印字体类型
    FontSize: 40, // FontSize：水印字体大小
    FontColor: '#171717', // FontColor：水印字体颜色
    Transparency: 0.3, // Transparency：透明度
    Gradient: false, // Gradient：倾斜度
    ApplyTo: 1 // ApplyTo：插入位置
  })
}

DeleteWaterMark() ​

仅支持PC端

删除水印

语法 ​

表达式.ActiveDocument.Sections.Item(Index).WaterMarks.DeleteWaterMark()

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

示例 ​

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 水印对象
  const waterMarks = await app.ActiveDocument.Sections.Item(1).WaterMarks

  // 删除水印
  waterMarks.DeleteWaterMark()
}

EditTextWaterMark() ​

仅支持PC端

编辑水印

语法 ​

表达式.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
是
倾斜度
ApplyTo
Number
整个文档
是
插入位置

示例 ​

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 水印对象
  const waterMarks = await app.ActiveDocument.Sections.Item(1).WaterMarks

  // 修改水印
  await waterMarks.EditTextWaterMark({
    Text: '', // Text：水印文本
    FontName: '宋体', // FontName：水印字体类型
    FontSize: 66, // FontSize：水印字体大小
    FontColor: '#f00', // FontColor：水印字体颜色
    Transparency: 0.8, // Transparency：透明度
    Gradient: true, // Gradient：倾斜度
    ApplyTo: 1 // ApplyTo：插入位置
  })
}

Item(Index) ​

仅支持PC端

单个水印对象，返回 WaterMark 对象

语法 ​

表达式.ActiveDocument.Sections.Item(Index).WaterMarks.Item(Index)

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

参数 ​

属性数据类型默认值必填说明
Index
Number
是
第 Index 个水印对象

示例 ​

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 水印对象
  const waterMarks = await app.ActiveDocument.Sections.Item(1).WaterMarks

  // 第 1 个水印对象
  const waterMark = await waterMarks.Item(1)
}

Item().FontColor ​

仅支持PC端

水印的字体颜色设置

语法 ​

表达式.ActiveDocument.Sections.Item(Index).WaterMarks.Item(Index).FontColor

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

示例 ​

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 插入文字水印
  await app.ActiveDocument.ActiveWindow.Selection.AddFontNameWaterMark({
    Text: '水印文本', // FontName：水印文本
    FontName: '宋体', // FontName：水印字体类型
    FontSize: 40, // FontSize：水印字体大小
    FontColor: '#171717', // FontColor：水印字体颜色
    Transparency: 0.3, // Transparency：透明度
    Gradient: false, // Gradient：倾斜度
    ApplyTo: 1 // ApplyTo：插入位置
  })

  // 水印对象
  const waterMarks = await app.ActiveDocument.Sections.Item(1).WaterMarks

  // 获取水印
  const waterMark = await waterMarks.Item(1)

  // 设置水印的字体颜色
  waterMark.FontColor = '#fff000'
}

Item().FontName ​

仅支持PC端

水印的字体类型设置

语法 ​

表达式.ActiveDocument.Sections.Item(Index).WaterMarks.Item(Index).FontName

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

示例 ​

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 插入文字水印
  await app.ActiveDocument.ActiveWindow.Selection.AddFontNameWaterMark({
    Text: '水印文本', // FontName：水印文本
    FontName: '宋体', // FontName：水印字体类型
    FontSize: 40, // FontSize：水印字体大小
    FontColor: '#171717', // FontColor：水印字体颜色
    Transparency: 0.3, // Transparency：透明度
    Gradient: false, // Gradient：倾斜度
    ApplyTo: 1 // ApplyTo：插入位置
  })

  // 水印对象
  const waterMarks = await app.ActiveDocument.Sections.Item(1).WaterMarks

  // 获取水印
  const waterMark = await waterMarks.Item(1)

  // 设置水印的字体类型
  waterMark.FontName = '楷体'
}

Item().FontSize ​

仅支持PC端

水印的字体大小设置

语法 ​

表达式.ActiveDocument.Sections.Item(Index).WaterMarks.Item(Index).FontSize

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

示例 ​

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 插入文字水印
  await app.ActiveDocument.ActiveWindow.Selection.AddFontNameWaterMark({
    Text: '水印文本', // FontName：水印文本
    FontName: '宋体', // FontName：水印字体类型
    FontSize: 40, // FontSize：水印字体大小
    FontColor: '#171717', // FontColor：水印字体颜色
    Transparency: 0.3, // Transparency：透明度
    Gradient: false, // Gradient：倾斜度
    ApplyTo: 1 // ApplyTo：插入位置
  })

  // 水印对象
  const waterMarks = await app.ActiveDocument.Sections.Item(1).WaterMarks

  // 获取水印
  const waterMark = await waterMarks.Item(1)

  // 设置水印的字体大小
  waterMark.FontSize = 80
}

Item().Gradient ​

仅支持PC端

水印的倾斜度设置

语法 ​

表达式.ActiveDocument.Sections.Item(Index).WaterMarks.Item(Index).Gradient

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

示例 ​

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 插入文字水印
  await app.ActiveDocument.ActiveWindow.Selection.AddFontNameWaterMark({
    Text: '水印文本', // FontName：水印文本
    FontName: '宋体', // FontName：水印字体类型
    FontSize: 40, // FontSize：水印字体大小
    FontColor: '#171717', // FontColor：水印字体颜色
    Transparency: 0.3, // Transparency：透明度
    Gradient: false, // Gradient：倾斜度
    ApplyTo: 1 // ApplyTo：插入位置
  })

  // 水印对象
  const waterMarks = await app.ActiveDocument.Sections.Item(1).WaterMarks

  // 获取水印
  const waterMark = await waterMarks.Item(1)

  // 设置水印的倾斜度
  waterMark.Gradient = true
}

Item().Text ​

仅支持PC端

水印的文本设置

语法 ​

表达式.ActiveDocument.Sections.Item(Index).WaterMarks.Item(Index).Text

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

示例 ​

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 插入文字水印
  await app.ActiveDocument.ActiveWindow.Selection.AddTextWaterMark({
    Text: '水印文本', // Text：水印文本
    FontName: '宋体', // FontName：水印字体类型
    FontSize: 40, // FontSize：水印字体大小
    FontColor: '#171717', // FontColor：水印字体颜色
    Transparency: 0.3, // Transparency：透明度
    Gradient: false, // Gradient：倾斜度
    ApplyTo: 1 // ApplyTo：插入位置
  })

  // 水印对象
  const waterMarks = await app.ActiveDocument.Sections.Item(1).WaterMarks

  // 获取水印
  const waterMark = await waterMarks.Item(1)

  // 设置水印的文本
  waterMark.Text = 'WebOffice'
}

Item().Transparency ​

仅支持PC端

水印的透明度设置

语法 ​

表达式.ActiveDocument.Sections.Item(Index).WaterMarks.Item(Index).Transparency

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

示例 ​

js
//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 插入文字水印
  await app.ActiveDocument.ActiveWindow.Selection.AddFontNameWaterMark({
    Text: '水印文本', // FontName：水印文本
    FontName: '宋体', // FontName：水印字体类型
    FontSize: 40, // FontSize：水印字体大小
    FontColor: '#171717', // FontColor：水印字体颜色
    Transparency: 0.3, // Transparency：透明度
    Gradient: false, // Gradient：倾斜度
    ApplyTo: 1 // ApplyTo：插入位置
  })

  // 水印对象
  const waterMarks = await app.ActiveDocument.Sections.Item(1).WaterMarks

  // 获取水印
  const waterMark = await waterMarks.Item(1)

  // 设置水印的透明度
  waterMark.Transparency = 0
}