XmlMappedRange.NoteText 方法

获取或设置与 XmlMappedRange 控件相关联的单元格说明。

命名空间:  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 解决方案中的可选参数

示例

下面的代码示例使用 NoteText 方法向 XmlMappedRange 添加一个说明,然后提示用户使用 ClearNotes 方法移除该说明。 此代码示例假定当前工作表包含一个名为 CustomerLastNameCell 的 XmlMappedRange

Private Sub SetNote()
    Me.CustomerLastNameCell.NoteText("This cell contains customer " & _
        "last names.")

    If MessageBox.Show("Remove the note?", "Test", MessageBoxButtons.YesNo) = _
        DialogResult.Yes Then
        Me.CustomerLastNameCell.ClearNotes()
    End If
End Sub
private void SetNote()
{
    this.CustomerLastNameCell.NoteText("This cell contains customer " +
        "last names.", missing, missing);

    if (MessageBox.Show("Remove the note?", "Test",
        MessageBoxButtons.YesNo) == DialogResult.Yes)
    {
        this.CustomerLastNameCell.ClearNotes();
    }
}

.NET Framework 安全性

请参见

参考

XmlMappedRange 接口

Microsoft.Office.Tools.Excel 命名空间