NamedRange.NoteText(Object, Object, Object) 方法

定义

命名空间:

Microsoft.Office.Tools.Excel

程序集:

Microsoft.Office.Tools.Excel.dll

获取或设置与 NamedRange 控件左上角中的单元格相关联的单元格注释。

public string NoteText(object Text, object Start, object Length);

abstract member NoteText : obj * obj * obj -> string

Public Function NoteText (Optional Text As Object, Optional Start As Object, Optional Length As Object) As String

参数

Text

Object

要添加到说明中的文本（最多 255 个字符）。 从位置 Start开始插入文本，替换 Length 现有笔记的字符。 如果省略此参数，此方法将返回字符从位置 StartLength 开始的笔记的当前文本。

Start

Object

所设置或返回的文本的起始位置。 如果省略此参数，则此方法将从第一个字符开始。 若要向该注释追加文本，请指定一个比现有注释中字符数大的数字。

Length

Object

要设置或返回的字符数。 如果省略此参数，则 Microsoft Office Excel 将设置或返回从注释的起始位置到末尾的字符（最多 255 个字符）。 如果从到 Start 注释末尾的字符数超过 255 个，则此方法仅返回 255 个字符。

返回

String

示例

下面的代码示例演示如何设置名为 NamedRange1的NamedRange控件的各种格式设置和显示特征。 具体而言，此示例使用 NoteText 方法向 添加一个带有文本 This is a Formatting test的注释NamedRange1。

此示例适用于文档级自定义项。

private void SetRangeFormats()
{
    Microsoft.Office.Tools.Excel.NamedRange namedRange1 =
        this.Controls.AddNamedRange(this.Range["A1", "A5"],
        "namedRange1");

    namedRange1.NoteText("This is a Formatting test");
    namedRange1.Value2 = "Martha";
    namedRange1.Font.Name = "Verdana";
    namedRange1.VerticalAlignment = Excel.XlVAlign.xlVAlignCenter;
    namedRange1.HorizontalAlignment = Excel.XlHAlign.xlHAlignCenter;
    namedRange1.BorderAround(missing, Excel.XlBorderWeight.xlThick, 
        Excel.XlColorIndex.xlColorIndexAutomatic);
    namedRange1.AutoFormat(Excel.XlRangeAutoFormat.xlRangeAutoFormat3DEffects1,
        true, false, true, false, true, true);

    if (MessageBox.Show("Clear the formatting and notes?", "Test",
        MessageBoxButtons.YesNo) == DialogResult.Yes)
    {
        namedRange1.ClearFormats();
        namedRange1.ClearNotes();
    }
}

Private Sub SetRangeFormats()
    Dim namedRange1 As Microsoft.Office.Tools.Excel.NamedRange _
        = Me.Controls.AddNamedRange(Me.Range("A1", "A5"), _
        "namedRange1")

    namedRange1.NoteText("This is a Formatting test", , )
    namedRange1.Value2 = "Martha"
    namedRange1.Font.Name = "Verdana"
    namedRange1.VerticalAlignment = Excel.XlVAlign.xlVAlignCenter
    namedRange1.HorizontalAlignment = Excel.XlHAlign.xlHAlignCenter
    namedRange1.BorderAround(, Excel.XlBorderWeight.xlThick, _
        Excel.XlColorIndex.xlColorIndexAutomatic, )
    namedRange1.AutoFormat( _
        Excel.XlRangeAutoFormat.xlRangeAutoFormat3DEffects1, _
        True, False, True, False, True, True)

    If MessageBox.Show("Clear the formatting and notes?", _
        "Test", MessageBoxButtons.YesNo) = DialogResult.Yes Then
        namedRange1.ClearFormats()
        namedRange1.ClearNotes()
    End If
End Sub

注解

单元格注释已替换为区域注释。 有关详细信息，请参阅 Comment 对象。

若要添加包含超过 255 个字符的注释，请使用此方法一次指定前 255 个字符，然后再次使用它来追加注释的其余部分 (一次不超过 255 个字符) 。

可选参数

有关可选参数的信息，请参阅 Office 解决方案中的可选参数。