RichTextContentControl Интерфейс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Представляет блок текста или других типов содержимого в документе.
[System.Runtime.InteropServices.Guid("fe02ce7e-9ae7-444f-a5f8-af588716d06b")]
public interface RichTextContentControl : IDisposable, Microsoft.Office.Tools.Word.ContentControlBase, System.ComponentModel.IComponent, System.ComponentModel.ISupportInitialize, System.Windows.Forms.IBindableComponent
- Атрибуты
- Реализации
Примеры
В следующем примере кода в начало документа добавляется новый RichTextContentControl .
Эта версия предназначена для настройки на уровне документа. Чтобы использовать этот код, вставьте его в ThisDocument класс в проекте и вызовите AddRichTextControlAtSelection метод из ThisDocument_Startup метода.
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";
}
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
Эта версия предназначена для надстройки уровня приложения. Чтобы использовать этот код, вставьте его в ThisAddIn класс в проекте и вызовите AddRichTextControlAtSelection метод из ThisAddIn_Startup метода.
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";
}
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
Комментарии
RichTextContentControlМожет содержать текст, а также много других типов содержимого, включая таблицы, рисунки и другие элементы управления содержимым. К тексту в можно применить сочетание форматирования и стилей RichTextContentControl .
Чтобы создать область документа, которая может содержать только текст, используйте PlainTextContentControl .
Примечание
Данный интерфейс реализуется набором средств Visual Studio для Office (среда выполнения). Он не предназначен для реализации в пользовательском коде. Дополнительные сведения см. в разделе Visual Studio Tools for Office Runtime Overview.
Элементы управления содержимым
RichTextContentControl— Это один из восьми типов элементов управления содержимым, которые можно использовать для проектирования документов и шаблонов в Microsoft Office Word. Элементы управления содержимым имеют пользовательский интерфейс, который имеет контролируемые входные данные, такие как форма. Элементы управления содержимым можно использовать, чтобы запретить пользователям изменять защищенные разделы документа или шаблона, а также можно привязывать элементы управления содержимым к источнику данных. Для получения дополнительной информации см. Content Controls.
Использование
В настоящей документации описывается версия этого типа, которая используется в проектах Office, предназначенных для платформы .NET Framework 4 или более поздних ее версий. В проектах, предназначенных для платформы .NET Framework 3.5, этот тип может содержать другие члены, а примеры кода, приведенные для этого типа, могут не работать. Документацию об этом типе в проектах, предназначенных для платформы .NET Framework 3.5, см. в следующем справочном разделе документации Visual Studio 2008: http://go.microsoft.com/fwlink/?LinkId=160658.
Свойства
| Application |
Получает объект Application, представляющий текущий экземпляр Microsoft Office Word. |
| Container | (Унаследовано от ContentControlBase) |
| ContainerComponent | (Унаследовано от ContentControlBase) |
| Creator |
Возвращает 32-разрядное целое число, указывающее приложение, в котором был создан элемент управления RichTextContentControl. |
| DefaultDataSourceUpdateMode |
Получает или задает значение DataSourceUpdateMode по умолчанию для ContentControlBase. (Унаследовано от ContentControlBase) |
| DefaultTextStyle |
Возвращает имя стиля знака, используемого для форматирования текста в элементе управления RichTextContentControl. |
| ID |
Возвращает уникальное число, идентифицирующее элемент управления содержимым. (Унаследовано от ContentControlBase) |
| InnerObject |
Получает базовый объект ContentControl для объекта ContentControlBase. (Унаследовано от ContentControlBase) |
| LockContentControl |
Получает или задает значение, которое указывает, можно ли удалять объект RichTextContentControl из документа. |
| LockContents |
Получает или задает значение, которое указывает, можно ли редактировать содержимое объекта RichTextContentControl. |
| Parent |
Возвращает родительский класс класса RichTextContentControl. |
| ParentContentControl |
Возвращает родительский элемент управления содержимым для элемента управления RichTextContentControl, вложенного в другой элемент управления содержимым. |
| PlaceholderText |
Возвращает или задает текст, отображаемый в элементе управления RichTextContentControl, пока текст не будет изменен в результате действий пользователя или иной операции. |
| Range |
Получает объект Range, представляющий содержимое объекта RichTextContentControl. |
| ShowingPlaceholderText |
Возвращает значение, указывающее, отображается ли в настоящее время в элементе управления RichTextContentControl замещающий текст. |
| Tag |
Возвращает или задает строку, которую необходимо связать с элементом управления RichTextContentControl. |
| Temporary |
Возвращает или задает значение, указывающее, будет ли элемент управления RichTextContentControl автоматически удаляться из документа при изменении этого элемента управления. |
| Text |
Возвращает или задает текст в элементе управления RichTextContentControl. |
| Title |
Получает или задает заголовок RichTextContentControl. |
Методы
| Copy() |
Копирует элемент управления RichTextContentControl из документа в буфер обмена. |
| Cut() |
Удаляет из документа элемент управления RichTextContentControl и заносит его в буфер обмена. |
| Delete(Boolean) |
Удаляет динамически созданный элемент управления содержимым из документа и из коллекции ControlCollection в документе. (Унаследовано от ContentControlBase) |
| SetPlaceholderText(BuildingBlock, Range, String) |
Выводит текст, хранящийся в объекте BuildingBlock, объекте Range или строке в качестве замещающего текста в элементе управления RichTextContentControl. |
События
| Added |
Происходит после добавления в документ элемента управления содержимым. (Унаследовано от ContentControlBase) |
| BindingContextChanged |
Происходит при изменении значения свойства BindingContext объекта ContentControlBase. (Унаследовано от ContentControlBase) |
| ContentUpdating |
Происходит непосредственно перед тем, как приложение Microsoft Office Word обновляет текст в элементе управления содержимым, если этот элемент управления привязан к настраиваемой XML-части. (Унаследовано от ContentControlBase) |
| Deleting |
Происходит непосредственно перед удалением из документа элемента управления содержимым. (Унаследовано от ContentControlBase) |
| Entering |
Происходит, когда пользователь щелкает мышью внутри элемента управления содержимым, либо при программном перемещении курсора внутрь элемента управления содержимым. (Унаследовано от ContentControlBase) |
| Exiting |
Происходит, когда пользователь щелкает мышью за пределами элемента управления содержимым, либо при программном перемещении курсора за пределы элемента управления содержимым. (Унаследовано от ContentControlBase) |
| StoreUpdating |
Происходит непосредственно перед тем, как Microsoft Office Word автоматически обновляет данные в пользовательской XML-части, которая привязана к элементу управления содержимым (то есть после изменения текста в элементе управления содержимым). (Унаследовано от ContentControlBase) |
| Validated |
Происходит после успешной проверки элемента управления содержимым. (Унаследовано от ContentControlBase) |
| Validating |
Происходит при проверке содержимого элемента управления. (Унаследовано от ContentControlBase) |