Export (0) Print
Expand All

ContentControl Interface

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Represents a content control a document.

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

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

The ContentControl type exposes the following members.

  NameDescription
Public propertyApplicationGets a Microsoft.Office.Interop.Word.Application that represents the current instance of Microsoft Office Word.
Public propertyBindingContextGets or sets the collection of currency managers for the IBindableComponent. (Inherited from IBindableComponent.)
Public propertyBuildingBlockCategoryGets or sets the category of building blocks that are displayed in a ContentControl that represents a building block gallery.
Public propertyBuildingBlockTypeGets or sets the type of the building blocks that are displayed in a ContentControl that represents a building block gallery.
Public propertyCheckedGets or sets a value that indicates whether a ContentControl that represents a check box control is checked or unchecked.
Public propertyContainerInfrastructure. (Inherited from ContentControlBase.)
Public propertyContainerComponentInfrastructure. (Inherited from ContentControlBase.)
Public propertyCreatorGets a 32-bit integer that indicates the application in which the ContentControl was created.
Public propertyDataBindingsGets the collection of data-binding objects for this IBindableComponent. (Inherited from IBindableComponent.)
Public propertyDateCalendarTypeGets or sets the type of calendar that is displayed in a ContentControl that represents a date picker.
Public propertyDateDisplayFormatGets or sets a string that specifies the format of dates that are displayed in a ContentControl that represents a date picker.
Public propertyDateDisplayLocaleGets or sets the language format of the date that is displayed in a ContentControl that represents a date picker.
Public propertyDateStorageFormatGets or sets the format in which dates are saved in a custom XML part by a ContentControl that represents a date picker.
Public propertyDefaultDataSourceUpdateModeGets or sets the default DataSourceUpdateMode for the ContentControlBase. (Inherited from ContentControlBase.)
Public propertyDefaultTextStyleGets the name of the character style that is used to format text in the ContentControl.
Public propertyDropDownListEntriesGets the collection of items that are displayed by a ContentControl that represents a drop-down list or a combo box.
Public propertyIDGets a unique number that identifies the content control. (Inherited from ContentControlBase.)
Public propertyInnerObjectGets the underlying Microsoft.Office.Interop.Word.ContentControl object for the Microsoft.Office.Tools.Word.ContentControlBase. (Inherited from ContentControlBase.)
Public propertyLockContentControlGets or sets a value that specifies whether the ContentControl can be deleted from the document.
Public propertyLockContentsGets or sets a value that specifies whether the contents of the ContentControl can be edited.
Public propertyMultiLineGets or sets a value that specifies whether the ContentControl can contain line breaks.
Public propertyParentGets the parent of the ContentControl.
Public propertyParentContentControlGets the parent content control of a ContentControl that is nested in another content control.
Public propertyPlaceholderTextGets the text that is displayed in the ContentControl until the text is changed by a user action or some other operation.
Public propertyRangeGets a Range that represents the contents of the ContentControl.
Public propertyShowingPlaceholderTextGets a value that specifies whether the ContentControl is currently displaying placeholder text.
Public propertySiteGets or sets the ISite associated with the IComponent. (Inherited from IComponent.)
Public propertyTagGets or sets a string that you want to associate with the ContentControl.
Public propertyTemporaryGets or sets a value that specifies whether the ContentControl is automatically deleted from the document when the control is edited.
Public propertyTitleGets or sets the title of the ContentControl.
Public propertyTypeGets or sets a value that specifies the type of content control that the ContentControl represents.
Public propertyXMLMappingGets an XMLMapping that represents the binding between the ContentControl and an element in a custom XML part.
Top

  NameDescription
Public methodBeginInitSignals the object that initialization is starting. (Inherited from ISupportInitialize.)
Public methodCopyCopies the ContentControl from the document to the Clipboard.
Public methodCutRemoves the ContentControl from the document and adds it to the Clipboard.
Public methodDeleteDeletes a dynamically created content control from the document and removes it from the ControlCollection in the document. (Inherited from ContentControlBase.)
Public methodDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
Public methodEndInitSignals the object that initialization is complete. (Inherited from ISupportInitialize.)
Public methodSetCheckedSymbolSets the symbol used to represent the checked state of a ContentControl that represents a check box control.
Public methodSetPlaceholderTextDisplays text that is in a BuildingBlock, a Range, or a string as the placeholder text in the ContentControl.
Public methodSetUncheckedSymbolSets the symbol used to represent the unchecked state of a ContentControl that represents a check box control
Public methodUngroupRemoves the group content control that contains the ContentControl from the document so that the region is no longer protected.
Top

  NameDescription
Public eventAddedOccurs after the content control is added to the document. (Inherited from ContentControlBase.)
Public eventBindingContextChangedOccurs when the value of the BindingContext property of the ContentControlBase changes. (Inherited from ContentControlBase.)
Public eventContentUpdatingOccurs 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 eventDeletingOccurs just before the content control is deleted from the document. (Inherited from ContentControlBase.)
Public eventDisposedRepresents the method that handles the Disposed event of a component. (Inherited from IComponent.)
Public eventEnteringOccurs when the user clicks in the content control, or when the cursor is moved into the content control programmatically. (Inherited from ContentControlBase.)
Public eventExitingOccurs when the user clicks outside the content control, or when the cursor is moved outside the content control programmatically. (Inherited from ContentControlBase.)
Public eventStoreUpdatingOccurs 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 eventValidatedOccurs when the content control has been successfully validated. (Inherited from ContentControlBase.)
Public eventValidatingOccurs when the contents of the content control are being validated. (Inherited from ContentControlBase.)
Top

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.

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.

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: http://go.microsoft.com/fwlink/?LinkId=160658.

Show:
© 2014 Microsoft