ControlExtensions.AddCheckBox (Método) (ControlCollection, Single, Single, Single, Single, String)

Artículo
05/15/2013

Agrega un nuevo control CheckBox al documento con el tamaño y en la ubicación especificados.

Espacio de nombres: Microsoft.Office.Tools.Word
Ensamblado: Microsoft.Office.Tools.Word.v4.0.Utilities (en Microsoft.Office.Tools.Word.v4.0.Utilities.dll)

Sintaxis

'Declaración
<ExtensionAttribute> _
Public Shared Function AddCheckBox ( _
    controls As ControlCollection, _
    left As Single, _
    top As Single, _
    width As Single, _
    height As Single, _
    name As String _
) As CheckBox

public static CheckBox AddCheckBox(
    this ControlCollection controls,
    float left,
    float top,
    float width,
    float height,
    string name
)

Parámetros

controls
Tipo: Microsoft.Office.Tools.Word.ControlCollection
Colección a la que se va a agregar el control.No proporcione este parámetro personalmente.Cuando se llama a este método en la colección devuelta por la propiedad Document.Controls (en un proyecto de nivel de aplicación) o la propiedad DocumentBase.Controls (en un proyecto de nivel de documento), este parámetro se proporciona automáticamente.

left
Tipo: System.Single
Distancia, expresada en puntos, entre el borde izquierdo del control y el borde izquierdo del documento.

top
Tipo: System.Single
Distancia, expresada en puntos, entre el borde superior del control y el borde superior del documento.

width
Tipo: System.Single
Ancho del control, expresado en puntos.

height
Tipo: System.Single
Alto del control, expresado en puntos.

name
Tipo: System.String
Nombre que se puede usar para indizar el control en la instancia de ControlCollection.

Valor devuelto

Tipo: Microsoft.Office.Tools.Word.Controls.CheckBox
Control que se ha agregado al documento.

Nota sobre el uso

En Visual Basic y C#, se puede llamar a este método como a un método de instancia en cualquier objeto de tipo ControlCollection. Cuando emplee la sintaxis del método de instancia para llamar a este método, omita el primer parámetro. Para obtener más información, vea Métodos de extensión (Visual Basic) o Métodos de extensión (Guía de programación de C#).

Excepciones

Excepción	Condición
ArgumentNullException	El argumento name es nullreferencia null (Nothing en Visual Basic) o tiene longitud cero.
ControlNameAlreadyExistsException	Ya existe un control con el mismo nombre en la instancia de ControlCollection.

Ejemplos

En el ejemplo de código siguiente se agrega un control CheckBox al inicio del documento y, a continuación, se agrega texto a la casilla.Para usar este ejemplo, ejecútelo desde la clase ThisDocument en un proyecto de nivel de documento.

Private Sub WordAddCheckBox()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Dim CheckBox1 As Microsoft.Office.Tools.Word.Controls. _
        CheckBox = Me.Controls.AddCheckBox(0, 0, 78, 18, _
        "CheckBox1")
    checkBox1.Text = "Underline"
End Sub

private void WordAddCheckBox()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.CheckBox checkBox1 =
        this.Controls.AddCheckBox(0, 0, 78, 18, "checkBox1");
    checkBox1.Text = "Underline";
}

Seguridad de .NET Framework

Plena confianza para el llamador inmediato. Un código de confianza parcial no puede utilizar este miembro. Para obtener más información, vea Utilizar bibliotecas de código que no es de plena confianza.