NamedRange.AddComment Method (Object)

 

Adds a comment to the NamedRange control.

Namespace:   Microsoft.Office.Tools.Excel
Assembly:  Microsoft.Office.Tools.Excel (in Microsoft.Office.Tools.Excel.dll)

Comment AddComment(
	object Text
)

Parameters

Text
Type: System.Object

The comment text.

Comments can only be added to NamedRange controls that consist of a single cell. You cannot add a comment if the NamedRange control has more than one cell.

For information on optional parameters, see Optional Parameters in Office Solutions.

The following code example uses the AddComment method to add the comment "This is Martha's range." to a NamedRange control that includes cell A1.

This example is for a document-level customization.

private void FindMarthaInTheRange()
{
    this.Range["A1"].Value2 = "Martha lives on a vineyard";

    Microsoft.Office.Tools.Excel.NamedRange namedRange1 =
        this.Controls.AddNamedRange(this.Range["A2"],
        "namedRange1");

    namedRange1.AddComment("This is Martha's range.");
    namedRange1.Value2 = namedRange1.AutoComplete("Ma");

    if (MessageBox.Show("Clear the range?", "Test",
        MessageBoxButtons.YesNo) == DialogResult.Yes)
    {
        namedRange1.Clear();
    }
}
Return to top
Show: