Método ControlExtensions.AddCheckedListBox (ControlCollection, Range, String)

Artigo
08/01/2011

Adiciona um novo CheckedListBox 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 AddCheckedListBox ( _
    controls As ControlCollection, _
    range As Range, _
    name As String _
) As CheckedListBox

public static CheckedListBox AddCheckedListBox(
    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 sozinho.Quando você chamar 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 de ControlCollection instância.

Valor de retorno

Tipo: Microsoft.Office.Tools.Excel.Controls.CheckedListBox
O CheckedListBox controle foi adicionado para o 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 TRANSLATION FROM VPE FOR CSHARP).

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 AddCheckedListBox método permite que você adicione CheckedListBox objetos no final da ControlCollection. Para remover um CheckedListBox 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 CheckedListBox o controle de células A1 por meio de B5, adiciona dois itens da caixa de listagem marcada e, em seguida, seleciona a caixa de seleção do primeiro Item. Para usar esse exemplo, executá-lo do Sheet1 a classe em um projeto de nível de documento.

    Private Sub ExcelRangeAddCheckedListBox()

        Dim CheckedListBox1 As Microsoft.Office.Tools. _
            Excel.Controls.CheckedListBox = Me.Controls. _
            AddCheckedListBox(Me.Range("A1", "B5"), _
            "CheckedListBox1")
        CheckedListBox1.Items.Add("First Item")
        CheckedListBox1.Items.Add("Second Item")
        CheckedListBox1.SetItemChecked(0, True)

    End Sub

private void ExcelRangeAddCheckedListBox()
{

    Microsoft.Office.Tools.Excel.Controls.CheckedListBox
        checkedListBox1 = this.Controls.AddCheckedListBox(
        this.Range["A1", "B5"], "checkedListBox1");
    checkedListBox1.Items.Add("First Item");
    checkedListBox1.Items.Add("Second Item");
    checkedListBox1.SetItemChecked(0, true);
}

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.

Consulte também

Referência

ControlExtensions Classe

Sobrecargas AddCheckedListBox

Namespace Microsoft.Office.Tools.Excel

Compartilhar via