Método ControlExtensions.AddListBox (ControlCollection, Range, String)
Adiciona um novo ListBox o controle para a planilha no intervalo especificado.
Namespace: Microsoft.Office.Tools.Excel
Assembly: Microsoft.Office.Tools.Excel.v4.0.Utilities (em Microsoft.Office.Tools.Excel.v4.0.Utilities.dll)
Sintaxe
'Declaração
<ExtensionAttribute> _
Public Shared Function AddListBox ( _
controls As ControlCollection, _
range As Range, _
name As String _
) As ListBox
public static ListBox AddListBox(
this ControlCollection controls,
Range range,
string name
)
Parâmetros
- controls
Tipo: Microsoft.Office.Tools.Excel.ControlCollection
A coleção para adicionar o controle.Não forneça esse parâmetro por conta própria.Quando você chama esse método na coleção retornada com o Worksheet.Controls propriedade (em um projeto de nível de aplicativo) ou o WorksheetBase.Controls propriedade (em um projeto de nível de documento), este parâmetro é fornecido automaticamente.
- 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 no ControlCollection instância.
Valor de retorno
Tipo: Microsoft.Office.Tools.Excel.Controls.ListBox
O ListBox que foi adicionado ao controle de ControlCollection instância.
Observação de uso
No Visual Basic e no C#, você pode chamar esse método como um método de instância em qualquer objeto do tipo ControlCollection. Quando você usar a sintaxe de método de instância para chamar esse método, omita o primeiro parâmetro. Para obter mais informações, consulte Métodos de extensão (Visual Basic) ou Métodos de extensão (guia de programação do C#).
Exceções
| Exceção | Condição |
|---|---|
| ArgumentNullException | O argumento do nome ou a faixa é nulluma referência nula (Nothing no Visual Basic), ou o argumento nome tem comprimento zero. |
| ControlNameAlreadyExistsException | Um controle com o mesmo nome já está sendo o 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 que o ControlCollection instância. |
Comentários
O AddListBox método permite que você adicione ListBox objetos no final da ControlCollection.Para remover um ListBox que foi previamente adicionado programaticamente, use o Remove método.
O controle é redimensionado automaticamente quando o intervalo é redimensionado.
Exemplos
O exemplo de código a seguir adiciona um ListBox controle às células A1 por meio de B6, adiciona dois itens à caixa de listagem e, em seguida, seleciona o primeiro item.Para usar esse exemplo, executá-lo na Sheet1 classe em um projeto de nível de documento.
Private Sub ExcelRangeAddListBox()
Dim ListBox1 As Microsoft.Office.Tools.Excel. _
Controls.ListBox = Me.Controls.AddListBox( _
Me.Range("A1", "B6"), "ListBox1")
ListBox1.Items.Add("First Item")
ListBox1.Items.Add("Second Item")
ListBox1.SelectedIndex = 0
End Sub
private void ExcelRangeAddListBox()
{
Microsoft.Office.Tools.Excel.Controls.ListBox
listBox1 = this.Controls.AddListBox(
this.Range["A1", "B6"], "lisBox1");
listBox1.Items.Add("First Item");
listBox1.Items.Add("Second Item");
listBox1.SelectedIndex = 0;
}
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.