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 的 Currency 管理員集合。 (繼承自 IBindableComponent)。 | |
Container | 基礎架構。 (繼承自 ContentControlBase)。 | |
ContainerComponent | 基礎架構。 (繼承自 ContentControlBase)。 | |
Creator | 取得 32 位元整數,表示在其中建立 RichTextContentControl 的應用程式。 | |
DataBindings | 取得這個 IBindableComponent 的資料繫結物件集合。 (繼承自 IBindableComponent)。 | |
DefaultDataSourceUpdateMode | 取得或設定 ContentControlBase 的預設 DataSourceUpdateMode。 (繼承自 ContentControlBase)。 | |
DefaultTextStyle | 取得要用來格式化 RichTextContentControl 中之文字的字元樣式名稱。 | |
ID | 取得識別內容控制項的唯一號碼。 (繼承自 ContentControlBase)。 | |
InnerObject | 取得 Microsoft.Office.Tools.Word.ContentControlBase 的基礎 Microsoft.Office.Interop.Word.ContentControl 物件。 (繼承自 ContentControlBase)。 | |
LockContentControl | 取得或設定值,這個值指定是否可以從文件中刪除 RichTextContentControl。 | |
LockContents | 取得或設定值,這個值指定是否可以編輯 RichTextContentControl 的內容。 | |
Parent | 取得 RichTextContentControl 的父代 (Parent)。 | |
ParentContentControl | 取得以巢狀方式置於另一個內容控制項中之 RichTextContentControl 的父內容控制項。 | |
PlaceholderText | 取得或設定 RichTextContentControl 中顯示的文字,直到該文字被使用者動作或其他作業變更為止。 | |
Range | 取得表示 RichTextContentControl 內容的 Range。 | |
ShowingPlaceholderText | 取得值,這個值表示 RichTextContentControl 目前是否顯示預留位置文字。 | |
Site | 取得或設定與 IComponent 相關聯的 ISite。 (繼承自 IComponent)。 | |
Tag | 取得或設定要與 RichTextContentControl 產生關聯的字串。 | |
Temporary | 取得或設定值,這個值指定編輯 RichTextContentControl 控制項時,是否會從文件中自動刪除此控制項。 | |
Text | 取得或設定 RichTextContentControl 中的文字。 | |
Title | 取得或設定 RichTextContentControl 的標題。 |
回頁首
方法
名稱 | 說明 | |
---|---|---|
BeginInit | 表示物件正在啟動初始設定。 (繼承自 ISupportInitialize)。 | |
Copy | 將 RichTextContentControl 從文件複製到 [剪貼簿]。 | |
Cut | 從文件移除 RichTextContentControl 並將它加入至 [剪貼簿]。 | |
Delete | 從文件中刪除動態建立的內容控制項,並從文件中的 ControlCollection 移除這個內容控制項。 (繼承自 ContentControlBase)。 | |
Dispose | 執行與釋放 (Free)、釋放 (Release) 或重設 Unmanaged 資源相關聯之應用程式定義的工作。 (繼承自 IDisposable)。 | |
EndInit | 表示物件已完成初始設定。 (繼承自 ISupportInitialize)。 | |
SetPlaceholderText | 顯示 BuildingBlock、Range 或字串中的文字,做為 RichTextContentControl 中的預留位置文字。 |
回頁首
事件
名稱 | 說明 | |
---|---|---|
Added | 在內容控制項加入至文件之後發生。 (繼承自 ContentControlBase)。 | |
BindingContextChanged | 在 ContentControlBase 的 BindingContext 屬性值變更時發生。 (繼承自 ContentControlBase)。 | |
ContentUpdating | 如果內容控制項已繫結至自訂 XML 組件,只在 Microsoft Office Word 更新內容控制項中的文字之前發生。 (繼承自 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 for Office Runtime 所實作, 並不能實作於您的程式碼中。 如需詳細資訊,請參閱 Visual Studio Tools for Office Runtime 概觀。 |
內容控制項
RichTextContentControl 是八種內容控制項型別的其中一個,可用來設計 Microsoft Office Word 中的文件和範本。 內容控制項有一個使用者介面 (UI) 具有像表單一樣的受控制輸入。 您可以使用內容控制項以避免使用者編輯文件或範本中被保護的區段,也可以將內容控制項繫結至資料來源。 如需詳細資訊,請參閱內容控制項。
使用方式
本文件說明此型別用於以 .NET Framework 4 為目標之 Office 專案的版本。在以 .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 命名空間