Método ControlCollection.AddListObject (Range, String)

Artigo
08/01/2011

Adiciona um novo ListObject o controle para a planilha no intervalo especificado.

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

Sintaxe

'Declaração
Function AddListObject ( _
    range As Range, _
    name As String _
) As ListObject

ListObject AddListObject(
    Range range,
    string name
)

Parâmetros

range
Tipo: Microsoft.Office.Interop.Excel.Range
A Range que fornece os limites para o controle.

name
Tipo: System.String
O nome do controle que pode ser usado para indexar o controle de ControlCollection instância.

Valor de retorno

Tipo: Microsoft.Office.Tools.Excel.ListObject
O ListObject controle foi adicionado para o ControlCollection instância.

Exceções

Exceção	Condição
ArgumentNullException	O argumento do nome ou o intervalo é nulluma referência nula (Nothing no Visual Basic), ou o argumento nome tem comprimento zero.
ControlNameAlreadyExistsException	Um controle com o mesmo nome já está na ControlCollection instância.
InvalidRangeException	O intervalo especificado não é válido. Intervalos de múltiplas áreas não podem ser usados. O intervalo deve estar na mesma planilha como o ControlCollection instância.

Comentários

O AddListObject método permite que você adicione ListObject controles para o fim da ControlCollection. Para remover um ListObject o controle que foi previamente adicionado programaticamente, use o Remove método.

Exemplos

O exemplo de código a seguir adiciona um ListObject de controle na parte superior da planilha e, em seguida, exibe uma caixa de mensagem mostrando o número de linhas na ListObject.

Private Sub ExcelAddListObject()
    Dim List1 As Microsoft.Office.Tools.Excel. _
        ListObject = Me.Controls.AddListObject( _
        Me.Range("A1", "C5"), "List1")

    MessageBox.Show("The list object has " _
        & List1.Range.Rows.Count.ToString() + " rows.")

End Sub

private void ExcelAddListObject()
{
    Microsoft.Office.Tools.Excel.ListObject list1 =
        this.Controls.AddListObject(this.Range["A1", "C5"], 
        "list1");
    MessageBox.Show("The list object has " + 
        list1.Range.Rows.Count.ToString() + " rows.");
}

Segurança do .NET Framework

Confiança total para o chamador imediato. O membro não pode ser usado por código parcialmente confiável. Para obter mais informações, consulte Usando bibliotecas de código parcialmente confiáveis.