RichTextContentControl - интерфейс

Представляет блок текста или иных типов содержимого в документе.

Пространство имен:  Microsoft.Office.Tools.Word
Сборка:  Microsoft.Office.Tools.Word (в Microsoft.Office.Tools.Word.dll)

Синтаксис

'Декларация
<GuidAttribute("fe02ce7e-9ae7-444f-a5f8-af588716d06b")> _
Public Interface RichTextContentControl _
    Inherits ContentControlBase, IBindableComponent, IComponent, IDisposable,  _
    ISupportInitialize

[GuidAttribute("fe02ce7e-9ae7-444f-a5f8-af588716d06b")]
public interface RichTextContentControl : ContentControlBase, 
    IBindableComponent, IComponent, IDisposable, ISupportInitialize

Тип RichTextContentControl предоставляет следующие члены.

Свойства

	Имя	Описание
	Application	Получает объект Microsoft.Office.Interop.Word.Application, представляющий текущий экземпляр Microsoft Office Word.
	BindingContext	Получает или задает коллекцию диспетчеров денежных единиц для объекта IBindableComponent. (Унаследовано от IBindableComponent.)
	Container	Инфраструктура. (Унаследовано от ContentControlBase.)
	ContainerComponent	Инфраструктура. (Унаследовано от ContentControlBase.)
	Creator	Возвращает 32-разрядное целое число, указывающее приложение, в котором был создан элемент управления RichTextContentControl.
	DataBindings	Получает коллекцию объектов привязки к данным для этого компонента IBindableComponent. (Унаследовано от IBindableComponent.)
	DefaultDataSourceUpdateMode	Получает или задает значение DataSourceUpdateMode по умолчанию для ContentControlBase. (Унаследовано от ContentControlBase.)
	DefaultTextStyle	Возвращает имя стиля знака, используемого для форматирования текста в элементе управления RichTextContentControl.
	ID	Возвращает уникальное число, идентифицирующее элемент управления содержимым. (Унаследовано от ContentControlBase.)
	InnerObject	Получает базовый объект Microsoft.Office.Interop.Word.ContentControl для объекта Microsoft.Office.Tools.Word.ContentControlBase. (Унаследовано от ContentControlBase.)
	LockContentControl	Возвращает или задает значение, указывающее, можно ли удалить из документа элемент управления RichTextContentControl.
	LockContents	Возвращает или задает значение, указывающее, можно ли изменять содержимое элемента управления RichTextContentControl.
	Parent	Возвращает родительский объект для элемента управления RichTextContentControl.
	ParentContentControl	Возвращает родительский элемент управления содержимым для элемента управления RichTextContentControl, вложенного в другой элемент управления содержимым.
	PlaceholderText	Возвращает или задает текст, отображаемый в элементе управления RichTextContentControl, пока текст не будет изменен в результате действий пользователя или иной операции.
	Range	Получает объект Range, представляющий содержимое объекта RichTextContentControl.
	ShowingPlaceholderText	Возвращает значение, указывающее, отображается ли в настоящее время в элементе управления RichTextContentControl замещающий текст.
	Site	Получает или задает интерфейс ISite, связанный с интерфейсом IComponent. (Унаследовано от IComponent.)
	Tag	Возвращает или задает строку, которую необходимо связать с элементом управления RichTextContentControl.
	Temporary	Возвращает или задает значение, указывающее, будет ли элемент управления RichTextContentControl автоматически удаляться из документа при изменении этого элемента управления.
	Text	Возвращает или задает текст в элементе управления RichTextContentControl.
	Title	Получает или задает заголовок RichTextContentControl.

В начало страницы

Методы

	Имя	Описание
	BeginInit	Подает сигнал объекту о начале инициализации. (Унаследовано от ISupportInitialize.)
	Copy	Копирует элемент управления RichTextContentControl из документа в буфер обмена.
	Cut	Удаляет из документа элемент управления RichTextContentControl и заносит его в буфер обмена.
	Delete	Удаляет из документа и коллекции ControlCollection динамически созданный элемент управления содержимым. (Унаследовано от ContentControlBase.)
	Dispose	Выполняет определяемые приложением задачи, связанные с высвобождением или сбросом неуправляемых ресурсов. (Унаследовано от IDisposable.)
	EndInit	Подает объекту сигнал о завершении инициализации. (Унаследовано от ISupportInitialize.)
	SetPlaceholderText	Выводит текст, хранящийся в объекте BuildingBlock, объекте Range или строке в качестве замещающего текста в элементе управления RichTextContentControl.

В начало страницы

События

	Имя	Описание
	Added	Происходит после добавления в документ элемента управления содержимым. (Унаследовано от ContentControlBase.)
	BindingContextChanged	Происходит при изменении значения свойства BindingContext объекта ContentControlBase. (Унаследовано от ContentControlBase.)
	ContentUpdating	Происходит непосредственно перед тем, как приложение Microsoft Office Word обновляет текст в элементе управления содержимым, если этот элемент управления привязан к настраиваемой XML-части. (Унаследовано от ContentControlBase.)
	Deleting	Происходит непосредственно перед удалением из документа элемента управления содержимым. (Унаследовано от ContentControlBase.)
	Disposed	Представляет метод, обрабатывающий событие Disposed компонента. (Унаследовано от IComponent.)
	Entering	Происходит, когда пользователь щелкает мышью внутри элемента управления содержимым, либо при программном перемещении курсора внутрь элемента управления содержимым. (Унаследовано от ContentControlBase.)
	Exiting	Происходит, когда пользователь щелкает мышью за пределами элемента управления содержимым, либо при программном перемещении курсора за пределы элемента управления содержимым. (Унаследовано от ContentControlBase.)
	StoreUpdating	Происходит непосредственно перед тем, как приложение Microsoft Office Word обновляет в пользовательской XML-части, связанной с элементом управления содержимым (то есть после того, как изменится текст в элементе управления содержимым). (Унаследовано от ContentControlBase.)
	Validated	Происходит после успешной проверки элемента управления содержимым. (Унаследовано от ContentControlBase.)
	Validating	Происходит при проверке содержимого элемента управления. (Унаследовано от ContentControlBase.)

В начало страницы

Заметки

Объект RichTextContentControl может содержать текст, а также другие типы содержимого, включая таблицы, рисунки и иные элементы управления содержимым. К тексту в элементе управления RichTextContentControl можно применить любое сочетание параметров форматирования и стилей.

Чтобы создать область документа, которая может содержать только текст, воспользуйтесь элементом управления PlainTextContentControl.

Примечание

Данный интерфейс реализован средствами Visual Studio Tools для среды выполнения Office. Он не предназначен для реализации в пользовательском коде. Дополнительные сведения см. в разделе Общие сведения об инструментах Visual Studio для среды выполнения Office.

Элементы управления содержимым

Элемент управления RichTextContentControl является одним из восьми типов элементов управления содержимым, используемых для разработки документов и шаблонов в приложении Microsoft Office Word. Элементы управления с содержимым обладают пользовательским интерфейсом с управляемым вводом, подобным тому, который используется в формах. С помощью элементов управления содержимым можно запретить пользователям редактировать защищенные разделы документа или шаблона; эти элементы управления также можно привязать к источнику данных. Дополнительные сведения см. в разделе Элементы управления содержимым.

Использование

В настоящей документации описывается версия данного типа, которая используется в проектах Office, предназначенных для платформы .NET Framework 4. В проектах, предназначенных для платформы .NET Framework 3.5, этот тип может содержать другие члены и примеры, предназначенные для данного типа, могут не работать. Документацию о данном типе в проектах, предназначенных для платформы .NET Framework 3.5, см. в следующем справочном разделе документации Visual Studio 2008: https://go.microsoft.com/fwlink/?LinkId=160658.

Примеры

В следующем примере кода в начало документа добавляется новый элемент управления RichTextContentControl.

Эта версия предназначена для настройки уровня документа. Чтобы воспользоваться этим кодом, вставьте его в проекте в класс ThisDocument и вызовите из метода ThisDocument_Startup метод AddRichTextControlAtSelection.

Dim richTextControl1 As Microsoft.Office.Tools.Word.RichTextContentControl

Private Sub AddRichTextControlAtSelection()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Me.Paragraphs(1).Range.Select()
    richTextControl1 = Me.Controls.AddRichTextContentControl("richTextControl1")
    richTextControl1.PlaceholderText = "Enter your first name"
End Sub

private Microsoft.Office.Tools.Word.RichTextContentControl richTextControl1;

private void AddRichTextControlAtSelection()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    this.Paragraphs[1].Range.Select();

    richTextControl1 = this.Controls.AddRichTextContentControl("richTextControl1");
    richTextControl1.PlaceholderText = "Enter your first name";
}

Эта версия предназначена для надстройки уровня приложения. Чтобы воспользоваться этим кодом, вставьте его в проекте в класс ThisAddIn и вызовите из метода ThisAddIn_Startup метод AddRichTextControlAtSelection.

Dim richTextControl1 As Microsoft.Office.Tools.Word.RichTextContentControl

Private Sub AddRichTextControlAtSelection()
    If Me.Application.ActiveDocument Is Nothing Then
        Return
    End If

    Dim vstoDoc As Document = Globals.Factory.GetVstoObject(Me.Application.ActiveDocument)
    vstoDoc.Paragraphs(1).Range.InsertParagraphBefore()
    vstoDoc.Paragraphs(1).Range.Select()
    richTextControl1 = vstoDoc.Controls.AddRichTextContentControl("richTextControl1")
    richTextControl1.PlaceholderText = "Enter your first name"
End Sub

private Microsoft.Office.Tools.Word.RichTextContentControl richTextControl1;

private void AddRichTextControlAtSelection()
{
    if (this.Application.ActiveDocument == null)
        return;

    Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
    vstoDoc.Paragraphs[1].Range.InsertParagraphBefore();
    vstoDoc.Paragraphs[1].Range.Select();

    richTextControl1 = vstoDoc.Controls.AddRichTextContentControl("richTextControl1");
    richTextControl1.PlaceholderText = "Enter your first name";
}

См. также

Ссылки

Microsoft.Office.Tools.Word - пространство имен

Другие ресурсы

Элементы управления содержимым

Практическое руководство. Добавление элементов управления содержимым в документы Word

Практическое руководство. Защита частей документов с помощью элементов управления содержимым

Пошаговое руководство. Создание шаблона с помощью элементов управления содержимым