Export (0) Print
Expand All

ControlCollection.AddRichTextContentControl Method (, String) (2007 System)

Updated: July 2008

Adds a new RichTextContentControl at the specified range in the document.

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

public RichTextContentControl AddRichTextContentControl(
	Range range,
	string name
)

Parameters

range
Type: Range

A Range that provides the bounds for the new control.

name
Type: System.String

The name of the new control.

Return Value

Type: Microsoft.Office.Tools.Word.RichTextContentControl
The RichTextContentControl that was added to the document.

ExceptionCondition
ArgumentNullException

name is null or has zero length.

ControlNameAlreadyExistsException

A control with the same name is already in the ControlCollection.

Use this method to add a new RichTextContentControl at a specified range in the document at run time. For more information, see Adding Controls to Office Documents at Run Time.

The following code example adds a new RichTextContentControl 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 AddRichTextControlAtRange method from the ThisDocument_Startup method.

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

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

    richTextControl2 = this.Controls.AddRichTextContentControl(this.Paragraphs[1].Range,
        "richTextControl2");
    richTextControl2.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 AddRichTextControlAtRange method from the ThisAddIn_Startup method.

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

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

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

    richTextControl2 = vstoDoc.Controls.AddRichTextContentControl(vstoDoc.Paragraphs[1].Range,
        "richTextControl2");
    richTextControl2.PlaceholderText = "Enter your first name";
}

Date

History

Reason

July 2008

Added a version of the code example for an application-level add-in.

SP1 feature change.

Community Additions

ADD
Show:
© 2015 Microsoft