PlainTextContentControl インターフェイス

  • [アーティクル]

文書内のテキストのブロックを表します。

名前空間:  Microsoft.Office.Tools.Word
アセンブリ:  Microsoft.Office.Tools.Word (Microsoft.Office.Tools.Word.dll 内)

構文

'宣言
<GuidAttribute("a8c46931-fa10-4760-8b46-0f2d881e269f")> _
Public Interface PlainTextContentControl _
    Inherits ContentControlBase, IBindableComponent, IComponent, IDisposable,  _
    ISupportInitialize

[GuidAttribute("a8c46931-fa10-4760-8b46-0f2d881e269f")]
public interface PlainTextContentControl : ContentControlBase, 
    IBindableComponent, IComponent, IDisposable, ISupportInitialize

PlainTextContentControl 型で公開されるメンバーは以下のとおりです。

プロパティ

  名前 説明
パブリック プロパティ Application Microsoft Office Word の現在のインスタンスを表す Microsoft.Office.Interop.Word.Application を取得します。
パブリック プロパティ BindingContext IBindableComponent の CurrencyManager のコレクションを取得または設定します。 (IBindableComponent から継承されます。)
パブリック プロパティ Container インフラストラクチャ。 (ContentControlBase から継承されます。)
パブリック プロパティ ContainerComponent インフラストラクチャ。 (ContentControlBase から継承されます。)
パブリック プロパティ Creator PlainTextContentControl が作成されたアプリケーションを示す 32 ビット整数を取得します。
パブリック プロパティ DataBindings このIBindableComponent のデータ バインディング オブジェクトのコレクションを取得します。 (IBindableComponent から継承されます。)
パブリック プロパティ DefaultDataSourceUpdateMode ContentControlBase の既定の DataSourceUpdateMode を取得または設定します。 (ContentControlBase から継承されます。)
パブリック プロパティ DefaultTextStyle PlainTextContentControl 内のテキストへの書式設定に使用する、文字スタイルの名前を取得します。
パブリック プロパティ ID コンテンツ コントロールを示す一意の数字を取得します。 (ContentControlBase から継承されます。)
パブリック プロパティ InnerObject Microsoft.Office.Tools.Word.ContentControlBase の基になる Microsoft.Office.Interop.Word.ContentControl オブジェクトを取得します。 (ContentControlBase から継承されます。)
パブリック プロパティ LockContentControl PlainTextContentControl を文書から削除できるかどうかを指定する値を取得または設定します。
パブリック プロパティ LockContents PlainTextContentControl のコンテンツを編集できるかどうかを指定する値を取得または設定します。
パブリック プロパティ MultiLine PlainTextContentControl に改行を含めることができるかどうかを指定する値を取得または設定します。
パブリック プロパティ Parent PlainTextContentControl の親を取得します。
パブリック プロパティ ParentContentControl 別のコンテンツ コントロールに入れ子になっている PlainTextContentControl の親コンテンツ コントロールを取得します。
パブリック プロパティ PlaceholderText ユーザーによる操作やその他の操作によってテキストが変更されない限り、PlainTextContentControl に表示されるテキストを取得または設定します。
パブリック プロパティ Range PlainTextContentControl のコンテンツを表す Range を取得します。
パブリック プロパティ ShowingPlaceholderText PlainTextContentControl が現在表示されているプレースホルダー テキストであるかどうかを指定する値を取得します。
パブリック プロパティ Site IComponent に関連付けられた ISite を取得または設定します。 (IComponent から継承されます。)
パブリック プロパティ Tag PlainTextContentControl に関連付ける文字列を取得または設定します。
パブリック プロパティ Temporary コントロールが編集されたときに文書から PlainTextContentControl を自動的に削除するかどうかを指定する値を取得または設定します。
パブリック プロパティ Text PlainTextContentControl 内のテキストを取得または設定します。
パブリック プロパティ Title PlainTextContentControl のタイトルを取得または設定します。
パブリック プロパティ XMLMapping PlainTextContentControl とカスタム XML 部分にある要素の間のバインディングを表す XMLMapping を取得します。

このページのトップへ

メソッド

  名前 説明
パブリック メソッド BeginInit 初期化の開始を通知するシグナルをオブジェクトに送信します。 (ISupportInitialize から継承されます。)
パブリック メソッド Copy 文書からクリップボードに、PlainTextContentControl をコピーします。
パブリック メソッド Cut PlainTextContentControl を文書から削除し、クリップボードに追加します。
パブリック メソッド Delete 動的に作成されたコンテンツ コントロールを、文書から削除し、さらに文書内の ControlCollection から削除します。 (ContentControlBase から継承されます。)
パブリック メソッド Dispose アンマネージ リソースの解放およびリセットに関連付けられているアプリケーション定義のタスクを実行します。 (IDisposable から継承されます。)
パブリック メソッド EndInit 初期化の完了を通知するシグナルをオブジェクトに送信します。 (ISupportInitialize から継承されます。)
パブリック メソッド SetPlaceholderText BuildingBlock 、Range、または PlainTextContentControl 内にプレースホルダー テキストとして存在する文字列にあるテキストを表示します。

このページのトップへ

イベント

  名前 説明
パブリック イベント 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 から継承されます。)

このページのトップへ

解説

PlainTextContentControl には、テキストのみを含めることができます。PlainTextContentControl 内のテキストに書式を設定することはできますが、コントロール内にあるすべてのテキストには自動的に同じ書式が設定されます。たとえば、PlainTextContentControl 内の 1 つの単語に斜体を適用すると、そのコントロールに含まれるすべてのテキストに斜体が適用されます。

PlainTextContentControl 内のテキストにアクセスするには、Text プロパティを使用します。既定では、PlainTextContentControl に改行を含めることはできません。この動作を変更するには、MultiLine プロパティを使用します。

テキストだけでなく、その他の種類のコンテンツ (表や画像などのコンテンツ コントロール) を含めることができる文書領域を作成するには、RichTextContentControl を使用します。

[!メモ]

これは、Visual Studio Tools for Office Runtime によって実装されたインターフェイスです。コードに実装されるものではありません。詳細については、「Visual Studio Tools for Office Runtime の概要」を参照してください。

コンテンツ コントロール

Microsoft Office Word には、文書やテンプレートのデザインに使用できるコンテンツ コントロールが 8 種類あります。PlainTextContentControl は、そのコンテンツ コントロールの 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 を参照してください。

例

次のコード例は、文書の先頭に新しい PlainTextContentControl を追加します。

このバージョンは、ドキュメント レベルのカスタマイズに使用されます。このコードを使用するには、プロジェクトの ThisDocument クラスにコードを貼り付け、ThisDocument_Startup メソッドから AddTextControlAtSelection メソッドを呼び出します。

Dim plainTextControl1 As Microsoft.Office.Tools.Word.PlainTextContentControl

Private Sub AddPlainTextControlAtSelection()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Me.Paragraphs(1).Range.Select()
    plainTextControl1 = Me.Controls.AddPlainTextContentControl("plainTextControl1")
    plainTextControl1.PlaceholderText = "Enter your first name"
End Sub

private Microsoft.Office.Tools.Word.PlainTextContentControl textControl1;

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

    textControl1 = this.Controls.AddPlainTextContentControl("textControl1");
    textControl1.PlaceholderText = "Enter your first name";
}

このバージョンは、アプリケーション レベルのアドインに使用されます。このコードを使用するには、プロジェクトの ThisAddIn クラスにコードを貼り付け、ThisAddIn_Startup メソッドから AddTextControlAtSelection メソッドを呼び出します。

Dim plainTextControl1 As Microsoft.Office.Tools.Word.PlainTextContentControl

Private Sub AddPlainTextControlAtSelection()
    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()
    plainTextControl1 = vstoDoc.Controls.AddPlainTextContentControl("plainTextControl1")
    plainTextControl1.PlaceholderText = "Enter your first name"
End Sub

private Microsoft.Office.Tools.Word.PlainTextContentControl textControl1;

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

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

    textControl1 = vstoDoc.Controls.AddPlainTextContentControl("textControl1");
    textControl1.PlaceholderText = "Enter your first name";
}

参照

関連項目

Microsoft.Office.Tools.Word 名前空間

その他の技術情報

コンテンツ コントロール

方法 : Word 文書にコンテンツ コントロールを追加する

方法 : コンテンツ コントロールを使用して文書を保護する

チュートリアル : コンテンツ コントロールによるテンプレートの作成

チュートリアル : カスタム XML 部分へのコンテンツ コントロールのバインド