通过

NamedRange.NoteText 方法

  • 项目

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

命名空间：  Microsoft.Office.Tools.Excel
程序集：  Microsoft.Office.Tools.Excel（在 Microsoft.Office.Tools.Excel.dll 中）

语法

声明
Function NoteText ( _
    Text As Object, _
    Start As Object, _
    Length As Object _
) As String

string NoteText(
    Object Text,
    Object Start,
    Object Length
)

参数

  • Text
    类型：System.Object
    要添加到说明中的文本（最多 255 个字符）。该文本将从 Start 位置处开始插入，并替换现有注释的 Length 个字符。如果省略此参数，则此方法将返回该注释中从 Start 位置开始的 Length 个字符的当前文本。
  • Start
    类型：System.Object
    所设置或返回的文本的起始位置。如果省略此参数，则此方法将从第一个字符开始。若要向该注释追加文本，请指定一个比现有注释中字符数大的数字。
  • Length
    类型：System.Object
    要设置或返回的字符数。如果省略此参数，则 Microsoft Office Excel 将设置或返回从注释的起始位置到末尾的字符（最多 255 个字符）。如果从注释的 Start 到末尾有 255 以上的字符，则此方法只返回 255 个字符。

返回值

类型：System.String

备注

单元格说明已替换为范围注释。有关更多信息，请参见 Comment 对象。

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

可选参数

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

示例

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

此示例针对的是文档级自定义项。

' <Snippet36>
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

' </Snippet35>

// <Snippet36>
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();
    }
}
// </Snippet35>

.NET Framework 安全性

请参见

参考

NamedRange 接口

Microsoft.Office.Tools.Excel 命名空间