Share via


ContentControlBase Interface

Provides the base interface for content controls in Word solutions created by using the Office development tools in Visual Studio.

Namespace:  Microsoft.Office.Tools.Word
Assemblies:   Microsoft.Office.Tools.Word.v4.0.Utilities (in Microsoft.Office.Tools.Word.v4.0.Utilities.dll)
  Microsoft.Office.Tools.Word (in Microsoft.Office.Tools.Word.dll)

Syntax

'Declaration
<GuidAttribute("6E36F826-A7DA-441D-87E3-2D7BE852867E")> _
Public Interface ContentControlBase _
    Inherits IBindableComponent, IComponent, IDisposable, ISupportInitialize
[GuidAttribute("6E36F826-A7DA-441D-87E3-2D7BE852867E")]
public interface ContentControlBase : IBindableComponent, 
    IComponent, IDisposable, ISupportInitialize

The ContentControlBase type exposes the following members.

Properties

  Name Description
Public property BindingContext Gets or sets the collection of currency managers for the IBindableComponent. (Inherited from IBindableComponent.)
Public property Container Infrastructure.
Public property ContainerComponent Infrastructure.
Public property DataBindings Gets the collection of data-binding objects for this IBindableComponent. (Inherited from IBindableComponent.)
Public property DefaultDataSourceUpdateMode Gets or sets the default DataSourceUpdateMode for the ContentControlBase.
Public property ID Gets a unique number that identifies the content control.
Public property InnerObject Gets the underlying ContentControl object for the Microsoft.Office.Tools.Word.ContentControlBase.
Public property Site Gets or sets the ISite associated with the IComponent. (Inherited from IComponent.)

Top

Methods

  Name Description
Public method BeginInit Signals the object that initialization is starting. (Inherited from ISupportInitialize.)
Public method Delete Deletes a dynamically created content control from the document and removes it from the ControlCollection in the document.
Public method Dispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
Public method EndInit Signals the object that initialization is complete. (Inherited from ISupportInitialize.)

Top

Events

  Name Description
Public event Added Occurs after the content control is added to the document.
Public event BindingContextChanged Occurs when the value of the BindingContext property of the ContentControlBase changes.
Public event ContentUpdating Occurs just before Microsoft Office Word updates the text in the content control, if the content control is bound to a custom XML part.
Public event Deleting Occurs just before the content control is deleted from the document.
Public event Disposed Represents the method that handles the Disposed event of a component. (Inherited from IComponent.)
Public event Entering Occurs when the user clicks in the content control, or when the cursor is moved into the content control programmatically.
Public event Exiting Occurs when the user clicks outside the content control, or when the cursor is moved outside the content control programmatically.
Public event StoreUpdating 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).
Public event Validated Occurs when the content control has been successfully validated.
Public event Validating Occurs when the contents of the content control are being validated.

Top

Remarks

The ContentControlBase interface defines members that are shared by all content controls. There are 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.

Note

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.

Usage

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

See Also

Reference

Microsoft.Office.Tools.Word Namespace

Other Resources

Content Controls

How to: Add Content Controls to Word Documents

Walkthrough: Creating a Template By Using Content Controls