PlainTextContentControl (Interfaz)

Artículo
08/10/2011

Representa un bloque de texto de un documento.

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

Sintaxis

'Declaración
<GuidAttribute("a8c46931-fa10-4760-8b46-0f2d881e269f")> _
Public Interface PlainTextContentControl _
    Inherits ContentControlBase, IBindableComponent, IComponent, IDisposable,  _
    ISupportInitialize

[GuidAttribute("a8c46931-fa10-4760-8b46-0f2d881e269f")]
public interface PlainTextContentControl : ContentControlBase, 
    IBindableComponent, IComponent, IDisposable, ISupportInitialize

El tipo PlainTextContentControl expone los siguientes miembros.

Propiedades

	Nombre	Descripción
	Application	Obtiene un objeto Microsoft.Office.Interop.Word.Application que representa la instancia actual de Microsoft Office Word.
	BindingContext	Obtiene o establece la colección de administradores de moneda para IBindableComponent. (Se hereda de IBindableComponent).
	Container	Infraestructura. (Se hereda de ContentControlBase).
	ContainerComponent	Infraestructura. (Se hereda de ContentControlBase).
	Creator	Obtiene un entero de 32 bits que indica la aplicación en que se creó el control PlainTextContentControl.
	DataBindings	Obtiene la colección de objetos de enlace de datos para esta interfaz IBindableComponent. (Se hereda de IBindableComponent).
	DefaultDataSourceUpdateMode	Obtiene o establece el objeto DataSourceUpdateMode predeterminado de ContentControlBase. (Se hereda de ContentControlBase).
	DefaultTextStyle	Obtiene el nombre del estilo de caracteres que se va a utilizar para dar formato al texto del control PlainTextContentControl.
	ID	Obtiene un número único que identifica el control de contenido. (Se hereda de ContentControlBase).
	InnerObject	Obtiene el objeto Microsoft.Office.Interop.Word.ContentControl subyacente de Microsoft.Office.Tools.Word.ContentControlBase. (Se hereda de ContentControlBase).
	LockContentControl	Obtiene o establece un valor que especifica si el control PlainTextContentControl se puede eliminar del documento.
	LockContents	Obtiene o establece un valor que especifica si se puede editar el contenido de PlainTextContentControl.
	MultiLine	Obtiene o establece un valor que especifica si PlainTextContentControl puede contener saltos de línea.
	Parent	Obtiene el objeto principal de PlainTextContentControl.
	ParentContentControl	Obtiene el control de contenido primario de un objeto PlainTextContentControl que está anidado en otro control de contenido.
	PlaceholderText	Obtiene o establece el texto que se muestra en PlainTextContentControl hasta que este texto se modifica mediante una acción del usuario o alguna otra operación.
	Range	Obtiene un objeto Range que representa el contenido de PlainTextContentControl.
	ShowingPlaceholderText	Obtiene un valor que especifica si PlainTextContentControl está mostrando actualmente el texto del marcador de posición.
	Site	Obtiene o establece la interfaz ISite asociada a la interfaz IComponent. (Se hereda de IComponent).
	Tag	Obtiene o establece una cadena que se va a asociar al control PlainTextContentControl.
	Temporary	Obtiene o establece un valor que especifica si PlainTextContentControl se elimina automáticamente del documento cuando se edita el control.
	Text	Obtiene o establece el texto de PlainTextContentControl.
	Title	Obtiene o establece el título de PlainTextContentControl.
	XMLMapping	Obtiene un objeto XMLMapping que representa el enlace entre PlainTextContentControl y un objeto de un elemento XML personalizado.

Arriba

Métodos

	Nombre	Descripción
	BeginInit	Indica al objeto que está comenzando la inicialización. (Se hereda de ISupportInitialize).
	Copy	Copia el control PlainTextContentControl del documento en el Portapapeles.
	Cut	Quita el control PlainTextContentControl del documento y lo agrega al Portapapeles.
	Delete	Elimina del documento un control de contenido creado dinámicamente y lo quita de la colección ControlCollection del documento. (Se hereda de ContentControlBase).
	Dispose	Realiza tareas definidas por la aplicación asociadas a la liberación o al restablecimiento de recursos no administrados. (Se hereda de IDisposable).
	EndInit	Indica al objeto que se ha completado la inicialización. (Se hereda de ISupportInitialize).
	SetPlaceholderText	Muestra el texto de un objeto BuildingBlock, un objeto Range o una cadena como texto del marcador de posición de PlainTextContentControl.

Arriba

Eventos

	Nombre	Descripción
	Added	Se produce una vez que se ha agregado el control de contenido al documento. (Se hereda de ContentControlBase).
	BindingContextChanged	Se produce cuando cambia el valor de la propiedad BindingContext de la clase ContentControlBase. (Se hereda de ContentControlBase).
	ContentUpdating	Se produce inmediatamente antes de que Microsoft Office Word actualice el texto del control de contenido, si el control de contenido está enlazado a un elemento XML personalizado. (Se hereda de ContentControlBase).
	Deleting	Se produce inmediatamente antes de que se elimine el control de contenido del documento. (Se hereda de ContentControlBase).
	Disposed	Representa el método que controla el evento Disposed de un componente. (Se hereda de IComponent).
	Entering	Se produce cuando el usuario hace clic en el control de contenido o cuando el cursor se mueve dentro del control de contenido mediante programación. (Se hereda de ContentControlBase).
	Exiting	Se produce cuando el usuario hace clic fuera del control de contenido o cuando el cursor se mueve fuera del control de contenido mediante programación. (Se hereda de ContentControlBase).
	StoreUpdating	Se produce inmediatamente antes de que Microsoft Office Word actualice los datos de un elemento XML personalizado que está enlazado al control de contenido (es decir, una vez que se ha modificado el texto del control de contenido). (Se hereda de ContentControlBase).
	Validated	Se produce cuando el control de contenido se ha validado correctamente. (Se hereda de ContentControlBase).
	Validating	Se produce cuando se valida el contenido del control de contenido. (Se hereda de ContentControlBase).

Arriba

Comentarios

Un control PlainTextContentControl sólo puede contener texto. Puede dar formato al texto de un control PlainTextContentControl, pero automáticamente se aplicará el mismo formato a todo el texto del control. Por ejemplo, si pone en cursiva una palabra de una frase que se encuentra en un control PlainTextContentControl, todo el texto incluido en el control se pone en cursiva.

Para obtener acceso al texto de un control PlainTextContentControl, utilice la propiedad Text. De forma predeterminada, los controles PlainTextContentControl no pueden contener saltos de línea. Para cambiar este comportamiento, utilice la propiedad MultiLine.

Para crear una región de documento que pueda contener texto y muchos otros tipos de contenido, como tablas, imágenes o controles de contenido de otro tipo, utilice un control RichTextContentControl.

Nota

Esta interfaz está implementada por el motor en tiempo de ejecución de Visual Studio Tools para Office. No está prevista su implementación en el código. Para obtener más información, vea Información general sobre el Motor en tiempo de ejecución de Microsoft Visual Studio Tools para Office.

Controles de contenido

El control PlainTextContentControl es uno de los ocho tipos de controles de contenido que se pueden utilizar para diseñar documentos y plantillas en Microsoft Office Word. Los controles de contenido tienen una interfaz de usuario con entrada controlada, como un formulario. Puede usar los controles de contenido para evitar que los usuarios modifiquen las secciones protegidas del documento o plantilla y también puede enlazar los controles de contenido a un origen de datos. Para obtener más información, vea Controles de contenido.

Uso

Esta documentación describe la versión de este tipo que se utiliza en los proyectos de Office destinados a .NET Framework 4. En los proyectos destinados a .NET Framework 3.5, este tipo puede tener miembros diferentes y es posible que los ejemplos de código proporcionados para dicho tipo no funcionen. Para informarse sobre este tipo en los proyectos destinados a .NET Framework 3.5, vea la siguiente sección de referencia en la documentación de Visual Studio 2008: https://go.microsoft.com/fwlink/?LinkId=160658.

Ejemplos

En el ejemplo de código siguiente se agrega un nuevo PlainTextContentControl al principio del documento.

Se trata de una versión para una personalización en el nivel del documento. Para usar este código, péguelo en la clase ThisDocument del proyecto y llame al método AddTextControlAtSelection desde el método ThisDocument_Startup.

Dim plainTextControl1 As Microsoft.Office.Tools.Word.PlainTextContentControl

Private Sub AddPlainTextControlAtSelection()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Me.Paragraphs(1).Range.Select()
    plainTextControl1 = Me.Controls.AddPlainTextContentControl("plainTextControl1")
    plainTextControl1.PlaceholderText = "Enter your first name"
End Sub

private Microsoft.Office.Tools.Word.PlainTextContentControl textControl1;

private void AddTextControlAtSelection()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    this.Paragraphs[1].Range.Select();

    textControl1 = this.Controls.AddPlainTextContentControl("textControl1");
    textControl1.PlaceholderText = "Enter your first name";
}

Se trata de una versión para un complemento en el nivel de la aplicación. Para usar este código, péguelo en la clase ThisAddIn del proyecto y llame al método AddTextControlAtSelection desde el método ThisAddIn_Startup.

Dim plainTextControl1 As Microsoft.Office.Tools.Word.PlainTextContentControl

Private Sub AddPlainTextControlAtSelection()
    If Me.Application.ActiveDocument Is Nothing Then
        Return
    End If

    Dim vstoDoc As Document = Globals.Factory.GetVstoObject(Me.Application.ActiveDocument)
    vstoDoc.Paragraphs(1).Range.InsertParagraphBefore()
    vstoDoc.Paragraphs(1).Range.Select()
    plainTextControl1 = vstoDoc.Controls.AddPlainTextContentControl("plainTextControl1")
    plainTextControl1.PlaceholderText = "Enter your first name"
End Sub

private Microsoft.Office.Tools.Word.PlainTextContentControl textControl1;

private void AddTextControlAtSelection()
{
    if (this.Application.ActiveDocument == null)
        return;

    Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
    vstoDoc.Paragraphs[1].Range.InsertParagraphBefore();
    vstoDoc.Paragraphs[1].Range.Select();

    textControl1 = vstoDoc.Controls.AddPlainTextContentControl("textControl1");
    textControl1.PlaceholderText = "Enter your first name";
}