ControlExtensions.AddRichTextBox (Método) (ControlCollection, Single, Single, Single, Single, String)
Agrega un nuevo control RichTextBox 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 AddRichTextBox ( _
controls As ControlCollection, _
left As Single, _
top As Single, _
width As Single, _
height As Single, _
name As String _
) As RichTextBox
public static RichTextBox AddRichTextBox(
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.RichTextBox
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. |
Comentarios
Este método permite agregar objetos RichTextBox al final de ControlCollection.
Para quitar un control RichTextBox agregado mediante programación, utilice el método Remove.
Ejemplos
En el ejemplo de código siguiente se agrega un control RichTextBox al inicio del documento, se asigna texto al control y, a continuación, se aplica formato al texto.Para usar este ejemplo, ejecútelo desde la clase ThisDocument en un proyecto de nivel de documento.
Private Sub WordAddRichTextBox()
Me.Paragraphs(1).Range.InsertParagraphBefore()
Dim RichTextBox1 As Microsoft.Office.Tools.Word.Controls. _
RichTextBox = Me.Controls.AddRichTextBox(0, 0, 75, 15, _
"RichTextBox1")
RichTextBox1.Text = "Sample text"
RichTextBox1.Select(0, 6)
RichTextBox1.SelectionFont = New Font("Times New Roman", _
10, FontStyle.Bold)
End Sub
private void WordAddRichTextBox()
{
this.Paragraphs[1].Range.InsertParagraphBefore();
Microsoft.Office.Tools.Word.Controls.RichTextBox
richTextBox1 = this.Controls.AddRichTextBox(
0, 0, 75, 15, "richTextBox1");
richTextBox1.Text = "Sample text";
richTextBox1.Select(0, 6);
richTextBox1.SelectionFont = new Font("Times New Roman",
10, FontStyle.Bold);
}
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.