ControlCollection::AddRichTextContentControl Method (ContentControl^, String^)
Adds a new RichTextContentControl that is based on a native content control in the document.
Assembly: Microsoft.Office.Tools.Word (in Microsoft.Office.Tools.Word.dll)
RichTextContentControl^ AddRichTextContentControl( ContentControl^ contentControl, String^ name )
Parameters
- contentControl
-
Type:
Microsoft.Office.Interop.Word::ContentControl^
The Microsoft.Office.Interop.Word::ContentControl that is the basis 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.
| Exception | Condition |
|---|---|
| ArgumentNullException | contentControl is null. -or- name is null or has zero length. |
| ControlNameAlreadyExistsException | A control with the same name is already in the ControlCollection. |
| ArgumentException | contentControl is not a building block gallery (that is, the Microsoft.Office.Interop.Word.ContentControl.Type property of contentControl does not have the value Microsoft.Office.Interop.Word.WdContentControlType.wdContentControlRichText). |
Use this method to add a new RichTextContentControl that is based on a native content control in the document at run time. This is useful when you create a RichTextContentControl at run time, and you want to recreate the same control the next time the document is opened. For more information, see Adding Controls to Office Documents at Run Time.
The following code example creates a new RichTextContentControl for every native rich text control that is in 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 CreateRichTextControlsFromNativeControls method from the ThisDocument_Startup method.
This version is for an application-level add-in that targets the .NET Framework 4 or the .NET Framework 4.5. To use this code, paste it into the ThisAddIn class in your project, and call the CreateRichTextControlsFromNativeControls method from the ThisAddIn_Startup method.
The following code example creates a new RichTextContentControl for every native rich text control that the user adds to the document.
This version is for a document-level customization. To use this code, paste it into the ThisDocument class in your project. For C#, you must also attach the ThisDocument_RichTextContentControlAfterAdd event handler to the ContentControlAfterAdd event of the ThisDocument class.
This version is for an application-level add-in that targets the .NET Framework 4 or the .NET Framework 4.5. To use this code, paste it into the ThisAddIn class in your project. Also, you must attach the ActiveDocument_RichTextContentControlAfterAdd event handler to the ContentControlAfterAdd event of the active document.