ContentControlBase Interface

  • Reference

Definition

Namespace:
Microsoft.Office.Tools.Word
Assemblies:
Microsoft.Office.Tools.Word.dll, Microsoft.Office.Tools.Word.v4.0.Utilities.dll

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

public interface class ContentControlBase : IDisposable, System::ComponentModel::IComponent, System::ComponentModel::ISupportInitialize, System::Windows::Forms::IBindableComponent
[System.Runtime.InteropServices.Guid("6E36F826-A7DA-441D-87E3-2D7BE852867E")]
public interface ContentControlBase : IDisposable, System.ComponentModel.IComponent, System.ComponentModel.ISupportInitialize, System.Windows.Forms.IBindableComponent
[<System.Runtime.InteropServices.Guid("6E36F826-A7DA-441D-87E3-2D7BE852867E")>]
type ContentControlBase = interface
    interface IBindableComponent
    interface IComponent
    interface IDisposable
    interface ISupportInitialize
Public Interface ContentControlBase
Implements IBindableComponent, IComponent, IDisposable, ISupportInitialize
Derived
Attributes
GuidAttribute
Implements
IComponent ISupportInitialize IDisposable IBindableComponent

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

Properties

Container
ContainerComponent
DefaultDataSourceUpdateMode

Gets or sets the default DataSourceUpdateMode for the ContentControlBase.
ID

Gets a unique number that identifies the content control.
InnerObject

Gets the underlying ContentControl object for the ContentControlBase.

Methods

Delete(Boolean)

Deletes a dynamically created content control from the document and removes it from the ControlCollection in the document.

Events

Added

Occurs after the content control is added to the document.
BindingContextChanged

Occurs when the value of the BindingContext property of the ContentControlBase changes.
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.
Deleting

Occurs just before the content control is deleted from the document.
Entering

Occurs when the user clicks in the content control, or when the cursor is moved into the content control programmatically.
Exiting

Occurs when the user clicks outside the content control, or when the cursor is moved outside the content control programmatically.
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).
Validated

Occurs when the content control has been successfully validated.
Validating

Occurs when the contents of the content control are being validated.

Applies to