Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

RichTextContentControl.PlaceholderText Property

Gets or sets the text that is displayed in the RichTextContentControl until the text is changed by a user action or some other operation.

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

string PlaceholderText { get; set; }

Property Value

Type: System.String
The text that is displayed in the control until the text is changed by a user action or some other operation.

The placeholder text is displayed until a user edits the control, the control is populated with data from a data source, or the control's contents are deleted.

To set the placeholder text to text that is in a Microsoft.Office.Interop.Word.BuildingBlock or a Range, use the SetPlaceholderText method.

The following code example adds a new RichTextContentControl to the beginning of the document. The example sets the PlaceholderText property to a string that prompts the user to type his or her first name.

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

private Microsoft.Office.Tools.Word.RichTextContentControl richTextControl1;

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

    richTextControl1 = this.Controls.AddRichTextContentControl("richTextControl1");
    richTextControl1.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 AddRichTextControlAtSelection method from the ThisAddIn_Startup method.

private Microsoft.Office.Tools.Word.RichTextContentControl richTextControl1;

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

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

    richTextControl1 = vstoDoc.Controls.AddRichTextContentControl("richTextControl1");
    richTextControl1.PlaceholderText = "Enter your first name";
}

Show:
© 2015 Microsoft