ContentControl Interface

  • Article

Represents a content control a document.

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

Syntax

'Declaration
<GuidAttribute("ee82979b-2814-48b1-95dd-4bfcc636a7ec")> _
Public Interface ContentControl _
    Inherits ContentControlBase, IBindableComponent, IComponent, IDisposable,  _
    ISupportInitialize

[GuidAttribute("ee82979b-2814-48b1-95dd-4bfcc636a7ec")]
public interface ContentControl : ContentControlBase, 
    IBindableComponent, IComponent, IDisposable, ISupportInitialize

The ContentControl type exposes the following members.

Properties

  Name Description
Public property Application Gets a Microsoft.Office.Interop.Word.Application that represents the current instance of Microsoft Office Word.
Public property BindingContext Gets or sets the collection of currency managers for the IBindableComponent. (Inherited from IBindableComponent.)
Public property BuildingBlockCategory Gets or sets the category of building blocks that are displayed in a ContentControl that represents a building block gallery.
Public property BuildingBlockType Gets or sets the type of the building blocks that are displayed in a ContentControl that represents a building block gallery.
Public property Checked Gets or sets a value that indicates whether a ContentControl that represents a check box control is checked or unchecked. This property can be used only in Word 2010 projects.
Public property Container Infrastructure. (Inherited from ContentControlBase.)
Public property ContainerComponent Infrastructure. (Inherited from ContentControlBase.)
Public property Creator Gets a 32-bit integer that indicates the application in which the ContentControl was created.
Public property DataBindings Gets the collection of data-binding objects for this IBindableComponent. (Inherited from IBindableComponent.)
Public property DateCalendarType Gets or sets the type of calendar that is displayed in a ContentControl that represents a date picker.
Public property DateDisplayFormat Gets or sets a string that specifies the format of dates that are displayed in a ContentControl that represents a date picker.
Public property DateDisplayLocale Gets or sets the language format of the date that is displayed in a ContentControl that represents a date picker.
Public property DateStorageFormat Gets or sets the format in which dates are saved in a custom XML part by a ContentControl that represents a date picker.
Public property DefaultDataSourceUpdateMode Gets or sets the default DataSourceUpdateMode for the ContentControlBase. (Inherited from ContentControlBase.)
Public property DefaultTextStyle Gets the name of the character style that is used to format text in the ContentControl.
Public property DropDownListEntries Gets the collection of items that are displayed by a ContentControl that represents a drop-down list or a combo box.
Public property ID Gets a unique number that identifies the content control. (Inherited from ContentControlBase.)
Public property InnerObject Gets the underlying Microsoft.Office.Interop.Word.ContentControl object for the Microsoft.Office.Tools.Word.ContentControlBase. (Inherited from ContentControlBase.)
Public property LockContentControl Gets or sets a value that specifies whether the ContentControl can be deleted from the document.
Public property LockContents Gets or sets a value that specifies whether the contents of the ContentControl can be edited.
Public property MultiLine Gets or sets a value that specifies whether the ContentControl can contain line breaks.
Public property Parent Gets the parent of the ContentControl.
Public property ParentContentControl Gets the parent content control of a ContentControl that is nested in another content control.
Public property PlaceholderText Gets the text that is displayed in the ContentControl until the text is changed by a user action or some other operation.
Public property Range Gets a Range that represents the contents of the ContentControl.
Public property ShowingPlaceholderText Gets a value that specifies whether the ContentControl is currently displaying placeholder text.
Public property Site Gets or sets the ISite associated with the IComponent. (Inherited from IComponent.)
Public property Tag Gets or sets a string that you want to associate with the ContentControl.
Public property Temporary Gets or sets a value that specifies whether the ContentControl is automatically deleted from the document when the control is edited.
Public property Title Gets or sets the title of the ContentControl.
Public property Type Gets or sets a value that specifies the type of content control that the ContentControl represents.
Public property XMLMapping Gets an XMLMapping that represents the binding between the ContentControl and an element in a custom XML part.

Top

Methods

  Name Description
Public method BeginInit Signals the object that initialization is starting. (Inherited from ISupportInitialize.)
Public method Copy Copies the ContentControl from the document to the Clipboard.
Public method Cut Removes the ContentControl from the document and adds it to the Clipboard.
Public method Delete Deletes a dynamically created content control from the document and removes it from the ControlCollection in the document. (Inherited from ContentControlBase.)
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.)
Public method SetCheckedSymbol Sets the symbol used to represent the checked state of a ContentControl that represents a check box control. This method can be used only in Word 2010 projects.
Public method SetPlaceholderText Displays text that is in a BuildingBlock, a Range, or a string as the placeholder text in the ContentControl.
Public method SetUncheckedSymbol Sets the symbol used to represent the unchecked state of a ContentControl that represents a check box control. This method can be used only in Word 2010 projects
Public method Ungroup Removes the group content control that contains the ContentControl from the document so that the region is no longer protected.

Top

Events

  Name Description
Public event Added Occurs after the content control is added to the document. (Inherited from ContentControlBase.)
Public event BindingContextChanged Occurs when the value of the BindingContext property of the ContentControlBase changes. (Inherited from ContentControlBase.)
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. (Inherited from ContentControlBase.)
Public event Deleting Occurs just before the content control is deleted from the document. (Inherited from ContentControlBase.)
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. (Inherited from ContentControlBase.)
Public event Exiting Occurs when the user clicks outside the content control, or when the cursor is moved outside the content control programmatically. (Inherited from ContentControlBase.)
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). (Inherited from ContentControlBase.)
Public event Validated Occurs when the content control has been successfully validated. (Inherited from ContentControlBase.)
Public event Validating Occurs when the contents of the content control are being validated. (Inherited from ContentControlBase.)

Top

Remarks

A ContentControl object is a mutable control that can represent any of the eight types of content controls that you can use in Microsoft Office Word. For example, if you create a ContentControl that initially has the functionality of a plain text control, you can change it at run time so that it behaves like a combo box. Other content controls cannot be used in this way. For example, a RichTextContentControl can only represent a rich text control. For more information about content controls, see Content Controls.

To create a ContentControl, use one of the AddContentControl methods. You cannot add a ContentControl to a document at design time.

When you create a ContentControl, you must specify the type of the content control that you want to create, or you can base the new control on an existing content control. After you create a ContentControl, you can change the type of content control that it represents by using the Type property.

Some ContentControl members will throw an exception if you use them while the control is set to a type of control that is not intended to use the member. For example, the DateCalendarType property will throw an exception if you try to use it on a ContentControl that does not represent a date picker.

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

How to: Protect Parts of Documents by Using Content Controls