GroupContentControl Interface

 

Represents a protected region of a document that users cannot edit or delete.

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

[GuidAttribute("1fc77d35-6978-4dbc-a615-9ed8a8f728f5")]
public interface GroupContentControl : ContentControlBase, IBindableComponent, 
	IComponent, IDisposable, ISupportInitialize

NameDescription
System_CAPS_pubpropertyApplication

Gets a Microsoft.Office.Interop.Word.Application that represents the current instance of Microsoft Office Word.

System_CAPS_pubpropertyBindingContext

(Inherited from IBindableComponent.)

System_CAPS_pubpropertyContainer

This API supports the product infrastructure and is not intended to be used directly from your code. (Inherited from ContentControlBase.)

System_CAPS_pubpropertyContainerComponent

This API supports the product infrastructure and is not intended to be used directly from your code. (Inherited from ContentControlBase.)

System_CAPS_pubpropertyCreator

Gets a 32-bit integer that indicates the application in which the GroupContentControl was created.

System_CAPS_pubpropertyDataBindings

(Inherited from IBindableComponent.)

System_CAPS_pubpropertyDefaultDataSourceUpdateMode

Gets or sets the default DataSourceUpdateMode for the ContentControlBase.(Inherited from ContentControlBase.)

System_CAPS_pubpropertyID

Gets a unique number that identifies the content control.(Inherited from ContentControlBase.)

System_CAPS_pubpropertyInnerObject
System_CAPS_pubpropertyLockContentControl

Gets or sets a value that specifies whether the GroupContentControl can be deleted from the document.

System_CAPS_pubpropertyParent

Gets the parent of the GroupContentControl.

System_CAPS_pubpropertyParentContentControl

Gets the parent content control of a GroupContentControl that is nested in another content control.

System_CAPS_pubpropertyRange

Gets a Range that represents the contents of the GroupContentControl.

System_CAPS_pubpropertySite

(Inherited from IComponent.)

System_CAPS_pubpropertyTag

Gets or sets a string that you want to associate with the GroupContentControl.

System_CAPS_pubpropertyText

Gets the text in the GroupContentControl.

System_CAPS_pubpropertyTitle

Gets or sets the title of the GroupContentControl.

NameDescription
System_CAPS_pubmethodBeginInit()

(Inherited from ISupportInitialize.)

System_CAPS_pubmethodCopy()

Copies the GroupContentControl from the document to the Clipboard.

System_CAPS_pubmethodCut()

Removes the GroupContentControl from the document and adds it to the Clipboard.

System_CAPS_pubmethodDelete(Boolean)

Deletes a dynamically created content control from the document and removes it from the ControlCollection in the document.(Inherited from ContentControlBase.)

System_CAPS_pubmethodDispose()

(Inherited from IDisposable.)

System_CAPS_pubmethodEndInit()

(Inherited from ISupportInitialize.)

NameDescription
System_CAPS_pubeventAdded

Occurs after the content control is added to the document. (Inherited from ContentControlBase.)

System_CAPS_pubeventBindingContextChanged

Occurs when the value of the BindingContext property of the ContentControlBase changes.(Inherited from ContentControlBase.)

System_CAPS_pubeventContentUpdating

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.)

System_CAPS_pubeventDeleting

Occurs just before the content control is deleted from the document.(Inherited from ContentControlBase.)

System_CAPS_pubeventDisposed

(Inherited from IComponent.)

System_CAPS_pubeventEntering

Occurs when the user clicks in the content control, or when the cursor is moved into the content control programmatically.(Inherited from ContentControlBase.)

System_CAPS_pubeventExiting

Occurs when the user clicks outside the content control, or when the cursor is moved outside the content control programmatically.(Inherited from ContentControlBase.)

System_CAPS_pubeventStoreUpdating

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.)

System_CAPS_pubeventValidated

Occurs when the content control has been successfully validated.(Inherited from ContentControlBase.)

System_CAPS_pubeventValidating

Occurs when the contents of the content control are being validated. (Inherited from ContentControlBase.)

Use a GroupContentControl to define a protected region of a document that users cannot edit or delete. A GroupContentControl can contain any document items, such as text, tables, graphics, and even other content controls. A GroupContentControl provides no UI that is visible to the user. For more information about using a GroupContentControl to protect a part of a document, see Content Controls and How to: Protect Parts of Documents by Using Content Controls.

System_CAPS_noteNote

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.

The GroupContentControl 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.

This documentation describes the version of this type that is used in Office projects that target the .NET Framework 4 or later. 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: http://go.microsoft.com/fwlink/?LinkId=160658.

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.

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. 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");
}
Return to top
Show: