Condividi tramite

PlainTextContentControl Interface

  • Articolo

Represents a block of text in a document.

Namespace:  Microsoft.Office.Tools.Word
Assembly:  Microsoft.Office.Tools.Word (in Microsoft.Office.Tools.Word.dll)

Syntax

'Declaration
<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

The PlainTextContentControl type exposes the following members.

Properties

  Name Description
Public property Application Gets a Microsoft.Office.Interop.Word.Application that represents the current instance of Microsoft Office Word.
Public property BindingContext Gets or sets the collection of currency managers for the IBindableComponent. (Inherited from IBindableComponent.)
Public property Container Infrastructure. (Inherited from ContentControlBase.)
Public property ContainerComponent Infrastructure. (Inherited from ContentControlBase.)
Public property Creator Gets a 32-bit integer that indicates the application in which the PlainTextContentControl was created.
Public property DataBindings Gets the collection of data-binding objects for this IBindableComponent. (Inherited from IBindableComponent.)
Public property DefaultDataSourceUpdateMode Gets or sets the default DataSourceUpdateMode for the ContentControlBase. (Inherited from ContentControlBase.)
Public property DefaultTextStyle Gets the name of the character style to use to format text in the PlainTextContentControl.
Public property ID Gets a unique number that identifies the content control. (Inherited from ContentControlBase.)
Public property InnerObject Gets the underlying Microsoft.Office.Interop.Word.ContentControl object for the Microsoft.Office.Tools.Word.ContentControlBase. (Inherited from ContentControlBase.)
Public property LockContentControl Gets or sets a value that specifies whether the PlainTextContentControl can be deleted from the document.
Public property LockContents Gets or sets a value that specifies whether the contents of the PlainTextContentControl can be edited.
Public property MultiLine Gets or sets a value that specifies whether the PlainTextContentControl can contain line breaks.
Public property Parent Gets the parent of the PlainTextContentControl.
Public property ParentContentControl Gets the parent content control of a PlainTextContentControl that is nested in another content control.
Public property PlaceholderText Gets or sets the text that is displayed in the PlainTextContentControl until the text is changed by a user action or some other operation.
Public property Range Gets a Range that represents the contents of the PlainTextContentControl.
Public property ShowingPlaceholderText Gets a value that specifies whether the PlainTextContentControl is currently displaying placeholder text.
Public property Site Gets or sets the ISite associated with the IComponent. (Inherited from IComponent.)
Public property Tag Gets or sets a string that you want to associate with the PlainTextContentControl.
Public property Temporary Gets or sets a value that specifies whether the PlainTextContentControl is automatically deleted from the document when the control is edited.
Public property Text Gets or sets the text in the PlainTextContentControl.
Public property Title Gets or sets the title of the PlainTextContentControl.
Public property XMLMapping Gets an XMLMapping that represents the binding between the PlainTextContentControl and an element in a custom XML part.

Top

Methods

  Name Description
Public method BeginInit Signals the object that initialization is starting. (Inherited from ISupportInitialize.)
Public method Copy Copies the PlainTextContentControl from the document to the Clipboard.
Public method Cut Removes the PlainTextContentControl from the document and adds it to the Clipboard.
Public method Delete Deletes a dynamically created content control from the document and removes it from the ControlCollection in the document. (Inherited from ContentControlBase.)
Public method Dispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
Public method EndInit Signals the object that initialization is complete. (Inherited from ISupportInitialize.)
Public method SetPlaceholderText Displays text that is in a BuildingBlock, a Range, or a string as the placeholder text in the PlainTextContentControl.

Top

Events

  Name Description
Public event Added Occurs after the content control is added to the document. (Inherited from ContentControlBase.)
Public event BindingContextChanged Occurs when the value of the BindingContext property of the ContentControlBase changes. (Inherited from ContentControlBase.)
Public event ContentUpdating Occurs just before Microsoft Office Word updates the text in the content control, if the content control is bound to a custom XML part. (Inherited from ContentControlBase.)
Public event Deleting Occurs just before the content control is deleted from the document. (Inherited from ContentControlBase.)
Public event Disposed Represents the method that handles the Disposed event of a component. (Inherited from IComponent.)
Public event Entering Occurs when the user clicks in the content control, or when the cursor is moved into the content control programmatically. (Inherited from ContentControlBase.)
Public event Exiting Occurs when the user clicks outside the content control, or when the cursor is moved outside the content control programmatically. (Inherited from ContentControlBase.)
Public event StoreUpdating Occurs just before Microsoft Office Word updates data in a custom XML part that is bound to the content control (that is, after the text in the content control changes). (Inherited from ContentControlBase.)
Public event Validated Occurs when the content control has been successfully validated. (Inherited from ContentControlBase.)
Public event Validating Occurs when the contents of the content control are being validated. (Inherited from ContentControlBase.)

Top

Remarks

A PlainTextContentControl can contain only text. You can format the text in a PlainTextContentControl, but all of the text in the control automatically has the same formatting. For example, if you italicize one word of a sentence that is in a PlainTextContentControl, all the text inside the control is italicized.

To access the text in a PlainTextContentControl, use the Text property. By default, a PlainTextContentControl cannot contain line breaks. To change this behavior, use the MultiLine property.

To create a document region that can contain text and many other types of content, including tables, pictures, or other content controls, use a RichTextContentControl.

Note

This interface is implemented by the Visual Studio Tools for Office runtime. It is not intended to be implemented in your code. For more information, see Visual Studio Tools for Office Runtime Overview.

Content Controls

The PlainTextContentControl is one of eight types of content controls that you can use to design documents and templates in Microsoft Office Word. Content controls have a user interface (UI) that has controlled input like a form. You can use content controls to prevent users from editing protected sections of the document or template, and you can also bind content controls to a data source. For more information, see Content Controls.

Usage

This documentation describes the version of this type that is used in Office projects that target the .NET Framework 4 and the .NET Framework 4.5. In projects that target the .NET Framework 3.5, this type might have different members and the code examples provided for this type might not work. For documentation about this type in projects that target the .NET Framework 3.5, see the following reference section in the Visual Studio 2008 documentation: https://go.microsoft.com/fwlink/?LinkId=160658.

Examples

The following code example adds a new PlainTextContentControl to the beginning of the document.

This version is for a document-level customization. To use this code, paste it into the ThisDocument class in your project, and call the AddTextControlAtSelection method from the ThisDocument_Startup method.

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";
}

This version is for an application-level add-in. To use this code, paste it into the ThisAddIn class in your project, and call the AddTextControlAtSelection method from the ThisAddIn_Startup method.

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";
}

See Also

Reference

Microsoft.Office.Tools.Word Namespace

Other Resources

Content Controls

How to: Add Content Controls to Word Documents

How to: Protect Parts of Documents by Using Content Controls

Walkthrough: Creating a Template By Using Content Controls

Walkthrough: Binding Content Controls to Custom XML Parts