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

深色模式

评论(Comments) ​

评论对象

属性列表 ​

属性说明
Count
返回评论总数

方法列表 ​

方法说明
Add()
新增评论，返回 Comment 对象
GoToCommentItem()
跳转到指定评论的位置
Item()
返回第 Index 个评论，即 Comment 对象
Item().Author
获取评论作者
Item().AuthorId
获取评论作者 ID
Item().CommentId
获取评论 ID
Item().DateTime
获取评论时间戳
Item().Replies
获取评论回复列表，对应 Comments 对象
Item().SlideId
获取幻灯片 ID
Item().Text
获取评论文本

Count ​

仅支持 PC 端

返回评论总数

语法 ​

表达式.ActivePresentation.Slides.Comments.Count

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

示例 ​

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

  const app = instance.Application

  // 返回评论总数
  const count = await app.ActivePresentation.SlideShowWindow.View.Slide.Comments
    .Count
  console.log(count)
}

Add() ​

仅支持 PC 端

新增评论，返回 Comment 对象

语法 ​

表达式.ActivePresentation.Slides.Comments.Add({ SlideId, Text, Replyer })

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

参数 ​

属性数据类型默认值必填说明
SlideId
Number
是
幻灯片 ID
Text
String
是
评论文本
Replyer
Object
是
评论信息体

Replyer 说明

属性数据类型默认值必填说明
AuthorName
String
是
作者名称
AuthorId
String
是
作者 ID
CommentId
String
是
评论 ID

示例 ​

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

  const app = instance.Application

  // 假设页面有 1 个评论
  let item1 =
    await app.ActivePresentation.SlideShowWindow.View.Slide.Comments.Item(1)
  let SlideId = await item1.SlideId
  let Text = '这是一条新评论'
  let Author = await item1.Author
  let AuthorId = await item1.AuthorId
  let CommentId = await item1.CommentId

  // 新增评论
  await app.ActivePresentation.SlideShowWindow.View.Slide.Comments.Add({
    SlideId,
    Text,
    Replyer: {
      Author,
      AuthorId,
      CommentId
    }
  })
}

GoToCommentItem() ​

仅支持 PC 端

跳转到指定评论的位置

语法 ​

表达式.ActivePresentation.Slides.Comments.GoToCommentItem({ SlideId, CommentId })

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

参数 ​

属性数据类型默认值必填说明
SlideId
Number
是
幻灯片 ID
CommentId
String
是
评论 ID

示例 ​

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

  const app = instance.Application

  // 假设页面有 1 个评论
  let item1 =
    await app.ActivePresentation.SlideShowWindow.View.Slide.Comments.Item(1)
  let SlideId = await item1.SlideId
  let CommentId = await item1.CommentId

  // 跳转到指定评论的位置
  await app.ActivePresentation.SlideShowWindow.View.Slide.Comments.GoToCommentItem(
    { SlideId, CommentId }
  )
}

Item() ​

仅支持 PC 端

返回第 Index 个评论，即 Comment 对象

语法 ​

表达式.ActivePresentation.Slides.Comments.Item(Index)

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

参数 ​

属性数据类型默认值必填说明
Index
Number
是
第 Index 个评论

示例 ​

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

  const app = instance.Application

  // 假设页面有 1 个评论
  let item1 =
    await app.ActivePresentation.SlideShowWindow.View.Slide.Comments.Item(1)
  console.log(item1)
}

Item().Author ​

仅支持 PC 端

获取评论作者

语法 ​

表达式.ActivePresentation.Slides.Comments.Item(Index).Author

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

返回值 ​

返回 String 表示作者

示例 ​

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

  const app = instance.Application

  // 假设页面有 1 个评论
  let Author =
    await app.ActivePresentation.SlideShowWindow.View.Slide.Comments.Item(1)
      .Author

  // 获取评论作者
  console.log(Author)
}

Item().AuthorId ​

仅支持 PC 端

获取评论作者 ID

语法 ​

表达式.ActivePresentation.Slides.Comments.Item(Index).AuthorId

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

返回值 ​

返回 String 表示作者 ID

示例 ​

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

  const app = instance.Application

  // 假设页面有 1 个评论
  let AuthorId =
    await app.ActivePresentation.SlideShowWindow.View.Slide.Comments.Item(1)
      .AuthorId

  // 获取评论作者 ID
  console.log(AuthorId)
}

Item().CommentId ​

仅支持 PC 端

获取评论 ID

语法 ​

表达式.ActivePresentation.Slides.Comments.Item(Index).CommentId

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

返回值 ​

返回 String 表示评论 ID

示例 ​

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

  const app = instance.Application

  // 假设页面有 1 个评论
  let CommentId =
    await app.ActivePresentation.SlideShowWindow.View.Slide.Comments.Item(1)
      .CommentId

  // 获取评论 ID
  console.log(CommentId)
}

Item().DateTime ​

仅支持 PC 端

获取评论时间戳

语法 ​

表达式.ActivePresentation.Slides.Comments.Item(Index).DateTime

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

返回值 ​

返回 Number 表示评论时间戳

示例 ​

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

  const app = instance.Application

  // 假设页面有 1 个评论
  let DateTime =
    await app.ActivePresentation.SlideShowWindow.View.Slide.Comments.Item(1)
      .DateTime

  // 获取评论时间戳
  console.log(DateTime)
}

Item().Replies ​

仅支持 PC 端

获取评论回复列表，对应 Comments 对象

语法 ​

表达式.ActivePresentation.Slides.Comments.Item(Index).Replies

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

返回值 ​

返回 Comments 对象

示例 ​

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

  const app = instance.Application

  // 假设页面有 1 个评论
  let Replies =
    await app.ActivePresentation.SlideShowWindow.View.Slide.Comments.Item(1)
      .Replies

  // 获取评论回复列表，对应 Comments 对象
  console.log(Replies)
}

Item().SlideId ​

仅支持 PC 端

获取幻灯片 ID

语法 ​

表达式.ActivePresentation.Slides.Comments.Item(Index).SlideId

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

返回值 ​

返回 Number 表示幻灯片 ID

示例 ​

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

  const app = instance.Application

  // 假设页面有 1 个评论
  let SlideId =
    await app.ActivePresentation.SlideShowWindow.View.Slide.Comments.Item(1)
      .SlideId

  // 获取幻灯片 ID
  console.log(SlideId)
}

Item().Text ​

仅支持 PC 端

获取评论文本

语法 ​

表达式.ActivePresentation.Slides.Comments.Item(Index).Text

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

返回值 ​

返回 String 表示评论文本

示例 ​

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

  const app = instance.Application

  // 假设页面有 1 个评论
  let Text =
    await app.ActivePresentation.SlideShowWindow.View.Slide.Comments.Item(1)
      .Text

  // 获取评论文本
  console.log(Text)
}