ControlExtensions.AddLabel (Método) (ControlCollection, Range, Single, Single, String)
Agrega un nuevo control Label 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 AddLabel ( _
controls As ControlCollection, _
range As Range, _
width As Single, _
height As Single, _
name As String _
) As Label
public static Label AddLabel(
this ControlCollection controls,
Range range,
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.
- range
Tipo: Microsoft.Office.Interop.Word.Range
Ubicación del control.
- 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.Label
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 o range es nullreferencia null (Nothing en Visual Basic) o el argumento name tiene longitud cero. |
| ControlNameAlreadyExistsException | Ya existe un control con el mismo nombre en la instancia de ControlCollection. |
| InvalidRangeException | El intervalo especificado no es válido. |
Comentarios
Este método permite agregar objetos Label al final de ControlCollection.
Para quitar un control Label agregado mediante programación, utilice el método Remove.
Ejemplos
En el ejemplo de código siguiente se agrega un control Label al primer párrafo del documento y, a continuación, se cambia el texto a Nombre.Para usar este ejemplo, ejecútelo desde la clase ThisDocument en un proyecto de nivel de documento.
Private Sub WordRangeAddLabel()
Me.Paragraphs(1).Range.InsertParagraphBefore()
Dim Label1 As Microsoft.Office.Tools.Word.Controls.Label _
= Me.Controls.AddLabel(Me.Paragraphs(1).Range, 75, _
17.25F, "Label1")
Label1.Text = "First Name"
End Sub
private void WordRangeAddLabel()
{
this.Paragraphs[1].Range.InsertParagraphBefore();
Microsoft.Office.Tools.Word.Controls.Label
label1 = this.Controls.AddLabel(
this.Paragraphs[1].Range, 75, 17.25F, "label1");
label1.Text = "First Name";
}
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.