チュートリアル : 初めての Word 用ドキュメント レベルのカスタマイズの作成
この入門編のチュートリアルでは、Microsoft Office Word 用のドキュメント レベルのカスタマイズを作成する方法について説明します。この種のソリューションに作成した機能は、特定の文書が開いている場合にのみ使用できます。ドキュメント レベルのカスタマイズでは、文書が開いたときに新しいリボン タブを表示するなどの、アプリケーション全体の変更を行うことはできません。
対象: このトピックの情報は、Word 2013 と Word 2010 のドキュメント レベルのプロジェクトに適用されます。詳細については、「Office アプリケーションおよびプロジェクト タイプ別の使用可能な機能」を参照してください。
このチュートリアルでは、次の作業について説明します。
Word 文書プロジェクトを作成する。
Visual Studio デザイナーでホストされるドキュメントにテキストを追加する。
Word のオブジェクト モデルを使用して、カスタマイズされた文書が開かれるときにテキストを追加するコードを記述する。
プロジェクトをビルドし、実行してテストする。
プロジェクトをクリーンアップして、不必要なビルド ファイルおよびセキュリティ設定を開発用コンピューターから削除する。
[!メモ]
お使いのマシンで、Visual Studio ユーザー インターフェイスの一部の要素の名前や場所が、次の手順とは異なる場合があります。これらの要素は、使用している Visual Studio のエディションや独自の設定によって決まります。詳細については、「Visual Studio の設定」を参照してください。
必須コンポーネント
このチュートリアルを実行するには、次のコンポーネントが必要です。
-
Microsoft Office Developer Tools が含まれているエディションの Visual Studio 2012。詳細については、「[Office ソリューションを開発できるようにコンピューターを構成する](bb398242\(v=vs.110\).md)」を参照してください。
- Word 2013 または Word 2010。
プロジェクトの作成
Visual Studio で新しい Word 文書プロジェクトを作成するには
Visual Studio を起動します。
[ファイル] メニューの [新規作成] をポイントし、[プロジェクト] をクリックします。
テンプレート ペインで、または [Visual C#] **[Visual Basic]を展開し、[Office/SharePoint]**を展開します。
[Office/SharePoint] の展開したノードの下で、[Office Add-ins] のノードを選択します。
プロジェクト テンプレートの一覧で、[Word 2010 ドキュメント] または [Word 2013 ドキュメント] を選択します。
[プロジェクト名] ボックスに「FirstDocumentCustomization」と入力します。
[OK] をクリックします。
Visual Studio Tools for Office プロジェクト ウィザードが開きます。
[新規ドキュメントの作成] を選択し、[OK] をクリックします。
Visual Studio により FirstDocumentCustomization プロジェクトが作成され、FirstDocumentCustomization ドキュメントおよび ThisDocument コード ファイルがプロジェクトに追加されます。FirstDocumentCustomization ドキュメントが自動的にデザイナーで開かれます。
デザイナーでドキュメントを閉じ、再び開く
プロジェクトを開発しているときにデザイナーで開いていたドキュメントを意識的にまたは誤って閉じた場合は、そのドキュメントを再び開くことができます。
デザイナーでドキュメントを閉じ、再び開くには
デザイナー ウィンドウの **[閉じる]**ボタン (X) をクリックしてドキュメントを閉じます。
ソリューション エクスプローラーで、ThisDocument コード ファイルを右クリックし、[デザイナーの表示] をクリックします。
または
ソリューション エクスプローラーで ThisDocument コード ファイルをダブルクリックします。
デザイナーを使用したドキュメントへのテキストの追加
デザイナーで開いたドキュメントを変更することで、カスタマイズのユーザー インターフェイス (UI: User Interface) をデザインできます。たとえば、テキスト、テーブル、または Word コントロールを追加できます。デザイナーを使用する方法の詳細については、「Visual Studio 環境における Office プロジェクト」を参照してください。
デザイナーを使用してドキュメントにテキストを追加するには
デザイナーで開いているドキュメントに次のテキストを入力します。
This text was added by using the designer.
プログラムによるドキュメントへのテキストの追加
次に、ThisDocument コード ファイルにコードを追加します。この新しいコードでは、Word のオブジェクト モデルを使用して、ドキュメントに 2 番目の段落を追加します。ThisDocument コード ファイルには、次のコードが既定で含まれています。
ThisDocument クラスの部分定義。このクラスは、ドキュメントのプログラミング モデルを表し、Word のオブジェクト モデルへのアクセスを提供します。詳細については、「Document ホスト項目」および「Word オブジェクト モデルの概要」を参照してください。ThisDocument クラスの残りの部分は、変更することができない非表示のコード ファイルに定義されています。
ThisDocument_Startup イベント ハンドラーおよび ThisDocument_Shutdown イベント ハンドラー。これらのイベント ハンドラーは、ドキュメントを開いたとき、または閉じたときに呼び出されます。これらのイベント ハンドラーを使用して、ドキュメントが開いたときにはカスタマイズを初期化し、ドキュメントが閉じたときにはカスタマイズが使用したリソースをクリーンアップします。詳細については、「Office プロジェクトのイベント」を参照してください。
コードを使用してドキュメントに 2 番目の段落を追加するには
ソリューション エクスプローラーで、ThisDocument を右クリックし、[コードの表示] をクリックします。
Visual Studio でコード ファイルが開かれます。
ThisDocument_Startup イベント ハンドラーを次のコードで置き換えます。ドキュメントが開かれると、この新しいコードにより、2 番目の段落がドキュメントに追加されます。
Private Sub ThisDocument_Startup(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Startup Me.Paragraphs(1).Range.InsertParagraphAfter() Me.Paragraphs(2).Range.Text = "This text was added by using code." End Sub
private void ThisDocument_Startup(object sender, System.EventArgs e) { this.Paragraphs[1].Range.InsertParagraphAfter(); this.Paragraphs[2].Range.Text = "This text was added by using code."; }
[!メモ]
このコードでは、インデックス値 1 を使用して、Paragraphs プロパティ内の最初の段落にアクセスします。Visual Basic や Visual C# ではインデックス番号が 0 から始まる配列が使用されますが、Word オブジェクト モデルのほとんどのコレクションでは、配列の下位のインデックスは 1 から始まります。詳細については、「Office ソリューションのコードの記述」を参照してください。
プロジェクトのテスト
文書をテストするには
F5 キーを押して、プロジェクトをビルドおよび実行します。
プロジェクトをビルドすると、コードはアセンブリにコンパイルされ、ドキュメントに関連付けられます。Visual Studio は、ドキュメントおよびアセンブリのコピーをプロジェクトのビルド出力フォルダーに格納し、カスタマイズを実行できるように開発用コンピューター上のセキュリティ設定を行います。詳細については、「Office ソリューションのビルド」を参照してください。
次のテキストが文書に追加されることを確認します。
This text was added by using the designer.
This text was added by using code.
ドキュメントを閉じます。
プロジェクトのクリーンアップ
プロジェクトの開発が完了したら、ビルド プロセスによって作成されたビルド出力フォルダー内のファイルおよびセキュリティ設定を削除する必要があります。
開発用コンピューターから完成したプロジェクトをクリーンアップするには
- Visual Studio で、[ビルド] メニューの [ソリューションのクリーン] をクリックします。
次の手順
Word 用の基本的なドキュメント レベルのカスタマイズを作成した後は、カスタマイズの開発方法の詳細について、以下のトピックを参照してください。
ドキュメント レベルのカスタマイズで実行できる一般的なプログラミング タスク : ドキュメント レベルのカスタマイズのプログラミング
Word 用のドキュメント レベルのカスタマイズに固有のプログラミング タスク : Word ソリューション
Word のオブジェクト モデルの使用 : Word オブジェクト モデルの概要
Word の UI のカスタマイズ (リボンへのカスタム タブの追加、独自の操作ウィンドウの作成など) : Office UI のカスタマイズ
拡張Wordオブジェクトを使用してVisual StudioのOfficeソリューションでWordオブジェクト モデルではないタスクを実行するために用意されており (たとえば、ドキュメント、バインディングのWordコントロールのマネージ コントロールをWindowsフォーム データ バインディング モデルを使用してデータをホストする) : 拡張オブジェクトによる Word の自動化。
Word 用のドキュメント レベルのカスタマイズのビルドとデバッグ : Office ソリューションのビルド
Word 用のドキュメント レベルのカスタマイズの配置 : Office ソリューションの配置