XmlMappedRange.NoteText(Object, Object, Object) Método

Definição

Namespace:

Microsoft.Office.Tools.Excel

Assembly:

Microsoft.Office.Tools.Excel.dll

Obtém ou define a nota de célula associada ao controle XmlMappedRange.

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

Parâmetros

Text

Object

O texto a ser adicionado à nota (até 255 caracteres). O texto é inserido começando na posição Start, substituindo Length os caracteres da anotação existente. Se esse argumento for omitido, esse método retornará o texto atual da anotação começando na posição Start, para Length caracteres.

Start

Object

A posição inicial do texto que é definida ou retornada. Se esse argumento for omitido, esse método iniciará no primeiro caractere. Para acrescentar texto à nota, especifique um número maior que o número de caracteres na nota existente.

Length

Object

O número de caracteres a serem definidos ou retornados. Se esse argumento for omitido, o Microsoft Office Excel definirá ou retornará os caracteres da posição inicial até o final da nota (até 255 caracteres). Se houver mais de 255 caracteres de Start até o final da anotação, esse método retornará apenas 255 caracteres.

Retornos

String

Exemplos

O exemplo de código a seguir usa o NoteText método para adicionar uma anotação a um XmlMappedRangee solicita que o usuário remova a anotação usando o ClearNotes método . Este exemplo de código pressupõe que a planilha atual contenha um XmlMappedRange chamado CustomerLastNameCell.

private void SetNote()
{
    this.CustomerLastNameCell.NoteText("This cell contains customer " +
        "last names.");

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

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

Comentários

As anotações da célula foram substituídas por comentários de intervalo. Para obter mais informações, consulte o Comment objeto .

Para adicionar uma observação que contenha mais de 255 caracteres, use esse método uma vez para especificar os primeiros 255 caracteres e, em seguida, use-o novamente para acrescentar o restante da anotação (não mais do que 255 caracteres por vez).

Parâmetros Opcionais

Para obter informações sobre parâmetros opcionais, consulte Parâmetros opcionais em soluções do Office.