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 Word の現在のインスタンスを表す Microsoft.Office.Interop.Word.Application を取得します。 | |
BindingContext | IBindableComponent の CurrencyManager のコレクションを取得または設定します。 (IBindableComponent から継承されます。) | |
Container | インフラストラクチャ。 (ContentControlBase から継承されます。) | |
ContainerComponent | インフラストラクチャ。 (ContentControlBase から継承されます。) | |
Creator | RichTextContentControl が作成されたアプリケーションを示す 32 ビット整数を取得します。 | |
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 の親を取得します。 | |
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 | アンマネージ リソースの解放およびリセットに関連付けられているアプリケーション定義のタスクを実行します。 (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 | コンテンツ コントロールにバインドされているカスタム XML 部分にあるデータを Microsoft Office Word が更新する直前 (コンテンツ コントロール内のテキストが変更された後) に発生します。 (ContentControlBase から継承されます。) | |
Validated | コンテンツ コントロールの検証が正常に完了したときに発生します。 (ContentControlBase から継承されます。) | |
Validating | コンテンツ コントロール内のコンテンツを検証中であるときに発生します。 (ContentControlBase から継承されます。) |
このページのトップへ
解説
RichTextContentControl には、テキストだけでなく、その他の種類のコンテンツ (表や画像などのコンテンツ コントロール) を含めることができます。書式設定やスタイルを組み合わせて、RichTextContentControl 内のテキストに適用できます。
テキストだけを含めることのできる文書領域を作成するには、PlainTextContentControl を使用します。
[!メモ]
これは、Visual Studio Tools for Office Runtime によって実装されたインターフェイスです。コードに実装されるものではありません。詳細については、「Visual Studio Tools for Office Runtime の概要」を参照してください。
コンテンツ コントロール
Microsoft Office Word には、文書やテンプレートのデザインに使用できるコンテンツ コントロールが 8 種類あります。RichTextContentControl は、そのコンテンツ コントロールの 1 つです。コンテンツ コントロールには、フォームと同様に、入力を制御するユーザー インターフェイス (UI) があります。コンテンツ コントロールを使用して、保護されている文書やテンプレートのセクションをユーザーが編集しないようにすることができます。また、コンテンツ コントロールをデータ ソースにバインドすることも可能です。詳細については、「コンテンツ コントロール」を参照してください。
使用方法
ここでは、.NET Framework 4 および .NET Framework 4.5 を対象とする 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 名前空間