ControlCollection.AddGroupContentControl Method (String)
Adds a new GroupContentControl at the current selection in the document.
Assembly: Microsoft.Office.Tools.Word (in Microsoft.Office.Tools.Word.dll)
Parameters
- name
- Type: String
The name of the new control.
Return Value
Type: Microsoft.Office.Tools.Word.GroupContentControlThe GroupContentControl that was added to the document.
| Exception | Condition |
|---|---|
| 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 GroupContentControl at the current selection 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 paragraph to the beginning of the document, and it creates a new GroupContentControl that contains this paragraph. The GroupContentControl prevents users from editing the text in the paragraph. For more information about using a GroupContentControl to protect a part of a document, see Content Controls.
This version is for a document-level customization. To use this code, paste it into the ThisDocument class in your project, and call the AddGroupControlAtSelection method from the ThisDocument_Startup method.
private Microsoft.Office.Tools.Word.GroupContentControl groupControl1; private void AddGroupControlAtSelection() { this.Paragraphs[1].Range.InsertParagraphBefore(); Word.Range range1 = this.Paragraphs[1].Range; range1.Text = "You cannot edit or change the formatting of text " + "in this paragraph, because this paragraph is in a GroupContentControl."; range1.Select(); groupControl1 = this.Controls.AddGroupContentControl("groupControl1"); }
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 AddGroupControlAtSelection method from the ThisAddIn_Startup method.
private Microsoft.Office.Tools.Word.GroupContentControl groupControl1; private void AddGroupControlAtSelection() { if (this.Application.ActiveDocument == null) return; Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument); vstoDoc.Paragraphs[1].Range.InsertParagraphBefore(); Word.Range range1 = vstoDoc.Paragraphs[1].Range; range1.Text = "You cannot edit or change the formatting of text " + "in this paragraph, because this paragraph is in a GroupContentControl."; range1.Select(); groupControl1 = vstoDoc.Controls.AddGroupContentControl("groupControl1"); }
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.
