Método ControlExtensions.AddListBox (ControlCollection, Range, Single, Single, String)

Artigo
05/21/2013

Adiciona um novo controle de ListBox ao documento no tamanho e no local especificado.

Namespace: Microsoft.Office.Tools.Word
Assembly: Microsoft.Office.Tools.Word.v4.0.Utilities (em Microsoft.Office.Tools.Word.v4.0.Utilities.dll)

Sintaxe

'Declaração
<ExtensionAttribute> _
Public Shared Function AddListBox ( _
    controls As ControlCollection, _
    range As Range, _
    width As Single, _
    height As Single, _
    name As String _
) As ListBox

public static ListBox AddListBox(
    this ControlCollection controls,
    Range range,
    float width,
    float height,
    string name
)

Parâmetros

controls
Tipo: Microsoft.Office.Tools.Word.ControlCollection
A coleção para adicionar ao controle.Não fornecer este parâmetro você mesmo.Quando você chamar esse método retornar a coleção Document.Controls propriedade (um nível do projeto) ou DocumentBase.Controls propriedade (a um nível projeto), este parâmetro estar fornecer automaticamente.

range
Tipo: Microsoft.Office.Interop.Word.Range
O local do controle.

width
Tipo: System.Single
A largura do controle em pontos.

height
Tipo: System.Single
A altura do controle em pontos.

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

Valor de retorno

Tipo: Microsoft.Office.Tools.Word.Controls.ListBox
O controle que foi adicionado ao documento.

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 de name ou de range é nulluma referência nula (Nothing no Visual Basic), ou o argumento de name tem comprimento zero.
ControlNameAlreadyExistsException	Um controle com o mesmo nome já está na instância de ControlCollection .
InvalidRangeException	O intervalo que foi especificado não é válido.

Comentários

Esse método permite que você adicione objetos de ListBox ao final de ControlCollection.

Para remover ListBox que foi adicionado por meio de programação, use o método de Remove .

Exemplos

O exemplo de código a seguir adiciona um controle de ListBox para o primeiro parágrafo no documento, adicionar dois itens à caixa de listagem, e selecione o primeiro item.Para usar este exemplo, ele execução da classe de ThisDocument em um projeto de um documento nível.

Private Sub WordRangeAddListBox()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim ListBox1 As Microsoft.Office.Tools.Word.Controls. _
        ListBox = Me.Controls.AddListBox(Me.Paragraphs(1).Range, _
        90, 71.25F, "LisBox1")
    ListBox1.Items.Add("First Item")
    ListBox1.Items.Add("Second Item")
    ListBox1.SelectedIndex = 0
End Sub

private void WordRangeAddListBox()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.ListBox
         listBox1 = this.Controls.AddListBox(
         this.Paragraphs[1].Range, 90, 71.25F, "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.

Consulte também

Referência

ControlExtensions Classe

Sobrecargas AddListBox

Namespace Microsoft.Office.Tools.Word

Compartilhar via