IComment

Interface IComment

---

public interface IComment

表示单元格注释。

IComment 附加到工作表单元格，并提供对注释内容、作者、锚点单元格、可见性以及用于显示注释的底层形状的访问。

 IComment comment = worksheet.getRange("B2").addComment("Review this value.");
 String text = comment.getText();
 IRange anchorCell = comment.getAnchorCell();
 comment.setVisible(true);
 

• Method Summary

  All MethodsInstance MethodsAbstract Methods

  Modifier and Type

  Method

  Description

  void

  delete()

  从其单元格中删除此注释。

  void

  fromJson(String json)

  根据指定的 JSON 字符串生成注释。

  IRange

  getAnchorCell()

  获取注释的锚点单元格。

  String

  getAuthor()

  获取注释的作者。

  IShape

  getShape()

  返回表示附加到此注释的形状的 IShape 对象。

  String

  getText()

  获取注释文本。

  boolean

  getVisible()

  获取注释是否可见。

  IComment

  next()

  返回表示下一个注释的 IComment 对象。

  IComment

  previous()

  返回表示上一个注释的 IComment 对象。

  void

  setText(String value)

  设置注释文本。

  void

  setVisible(boolean value)

  设置注释是否可见。

  String

  toJson()

  从注释生成 JSON 字符串。

• Method Details

  • getText

    String getText()

    获取注释文本。

    
     worksheet.getRange("D5").setValue("Review");
     IComment comment = worksheet.getRange("D5").addComment("Check this value.");
     String text = comment.getText();
     

    Returns:

    注释文本。

  • setText

    void setText(String value)

    设置注释文本。

    
     worksheet.getRange("D5").setValue("Review");
     IComment comment = worksheet.getRange("D5").addComment("Check this value.");
     comment.setText("Reviewed and approved.");
     

    Parameters:

    value - 注释文本。

  • getAuthor

    String getAuthor()

    获取注释的作者。

    返回与该注释关联的作者信息。

    
     workbook.setAuthor("Author");
     IComment comment = worksheet.getRange("C3").addComment("Review this value.");
     String author = comment.getAuthor();
     

    Returns:

    注释的作者。

  • getAnchorCell

    IRange getAnchorCell()

    获取注释的锚点单元格。

    返回此注释所附加到的 IRange 对象。

    
     worksheet.getRange("D5").setValue("Review");
     IComment comment = worksheet.getRange("D5").addComment("Check this value.");
     IRange cell = comment.getAnchorCell();
     

    Returns:

    此注释所附加到的 IRange 对象。

  • delete

    void delete()

    从其单元格中删除此注释。

    使用此方法可以删除单个单元格注释。若要删除区域中多个单元格的注释，请使用 IRange.clearComments()。

    
     worksheet.getRange("D5").setValue("Review");
     IComment comment = worksheet.getRange("D5").addComment("Check this value.");
     comment.delete();
     

  • next

    IComment next()

    返回表示下一个注释的 IComment 对象。

    如果当前注释是工作表上的最后一个注释，则返回 null。

    
     worksheet.getRange("C3").addComment("First note.");
     IComment comment = worksheet.getRange("D5").addComment("Second note.");
     worksheet.getRange("F7").addComment("Third note.");
     IComment nextComment = comment.next();
     

    Returns:

    当前注释之后的下一个注释；如果当前注释是工作表上的最后一个注释，则为 null。

  • previous

    IComment previous()

    返回表示上一个注释的 IComment 对象。

    如果当前注释是工作表上的第一个注释，则返回 null。

    
     worksheet.getRange("B2").addComment("First note.");
     IComment comment = worksheet.getRange("D5").addComment("Second note.");
     IComment previousComment = comment.previous();
     

    Returns:

    当前注释之前的上一个注释；如果当前注释是工作表上的第一个注释，则为 null。

  • getVisible

    boolean getVisible()

    获取注释是否可见。

    使用此方法可检查注释是否可见。

    
     IComment comment = worksheet.getRange("C3").addComment("Review this value.");
     comment.setVisible(true);
     boolean visible = comment.getVisible();
     

    Returns:

    如果注释可见，则为 true；否则为 false。

  • setVisible

    void setVisible(boolean value)

    设置注释是否可见。

    使用此方法可显示或隐藏注释。

    
     IComment comment = worksheet.getRange("C3").addComment("Review this value.");
     comment.setVisible(true);
     

    Parameters:

    value - 如果注释可见，则为 true；否则为 false。

  • getShape

    IShape getShape()

    返回表示附加到此注释的形状的 IShape 对象。

    使用返回的形状可以配置注释的布局，例如其大小、线条、填充和文本格式。

    
     worksheet.getRange("D5").setValue("Review");
     IComment comment = worksheet.getRange("D5").addComment("Check this value.");
     IShape shape = comment.getShape();
     shape.setWidth(220);
     

    Returns:

    附加到注释的 IShape 对象。

  • fromJson

    void fromJson(String json)

    根据指定的 JSON 字符串生成注释。

    使用此方法可以将序列化的注释信息应用到当前注释。JSON 内容通常由 toJson() 生成。

    
     IComment sourceComment = worksheet.getRange("A1").addComment("Review this value.");
     sourceComment.getShape().setWidth(220);
     String json = sourceComment.toJson();
     IComment targetComment = worksheet.getRange("C3").addComment("Draft");
     targetComment.fromJson(json);
     

    Parameters:

    json - 包含注释信息的 JSON 字符串。

  • toJson

    String toJson()

    从注释生成 JSON 字符串。

    返回的字符串包含注释信息，可与 fromJson(String) 一起使用以重新创建或更新注释。

    
     worksheet.getRange("D5").setValue("Review");
     IComment comment = worksheet.getRange("D5").addComment("Check this value.");
     String json = comment.toJson();
     

    Returns:

    包含注释信息的 JSON 字符串。