NamedRange.Comment Property

  • Reference

Definition

Namespace:
Microsoft.Office.Tools.Excel
Assembly:
Microsoft.Office.Tools.Excel.dll

Gets a Comment that represents the comment associated with the cell in the upper left corner of the NamedRange control.

public:
 property Microsoft::Office::Interop::Excel::Comment ^ Comment { Microsoft::Office::Interop::Excel::Comment ^ get(); };
public Microsoft.Office.Interop.Excel.Comment Comment { get; }
member this.Comment : Microsoft.Office.Interop.Excel.Comment
Public ReadOnly Property Comment As Comment

Property Value

Comment

A Comment that represents the comment associated with the cell in the upper left corner of the NamedRange control.

Examples

The following code example creates a NamedRange and adds a comment to the cell. It then displays a message box that causes the comment to become visible if the user clicks OK.

This example is for a document-level customization.

Microsoft.Office.Tools.Excel.NamedRange commentRange;
private void AddCommentToRange()
{
    commentRange = this.Controls.AddNamedRange(
        this.Range["C3"], "setColumnRowRange");
    this.commentRange.AddComment("This is a comment.");
    Excel.Comment comment1 = this.commentRange.Comment;
    comment1.Visible = false;
    if (MessageBox.Show("Display comment?", "Comment Test",
        MessageBoxButtons.OKCancel) == DialogResult.OK)
    {
        comment1.Visible = true;
    }
}

Private commentRange As Microsoft.Office.Tools.Excel.NamedRange

Private Sub AddCommentToRange()
    commentRange = Me.Controls.AddNamedRange( _
        Me.Range("C3"), "setColumnRowRange")
    Me.commentRange.AddComment("This is a comment.")
    Dim comment1 As Excel.Comment = Me.commentRange.Comment
    comment1.Visible = False
    If MessageBox.Show("Display comment?", "Comment Test", _
        MessageBoxButtons.OKCancel) = DialogResult.OK Then
        comment1.Visible = True
    End If
End Sub

Applies to