Microsoft.Office.Tools.Excel..::.ControlCollection クラスおよび Microsoft.Office.Tools.Word..::.ControlCollection クラスには、ホスト コントロールおよび一般的な Windows フォーム コントロールを文書やワークシートに追加するために使用できるヘルパー メソッドが含まれています。各メソッドの名前は Add<control class> という形式です。control class は追加するコントロールの名前のクラス名です。たとえば、NamedRange コントロールを文書に追加するには、AddNamedRange メソッドを使用します。ヘルパー メソッドの一覧については、「ホスト コントロールのヘルパー メソッド」および「Windows フォーム コントロールのヘルパー メソッド」を参照してください。

Excel のドキュメント レベルのプロジェクトの Sheet1 に NamedRange を追加するコード例を次に示します。

Dim range1 As Excel.Range = Globals.Sheet1.Range("A1", "D5")
Dim namedRange1 As Microsoft.Office.Tools.Excel.NamedRange = _
    Globals.Sheet1.Controls.AddNamedRange(range1, "ChartSource")

Excel.Range range1 = Globals.Sheet1.Range["A1", "D5"];
Microsoft.Office.Tools.Excel.NamedRange namedRange1 =
    Globals.Sheet1.Controls.AddNamedRange(range1, "ChartSource");

Microsoft.Office.Tools.Excel..::.Worksheet または Microsoft.Office.Tools.Word..::.Document の Controls プロパティを使用して、デザイン時に追加したコントロールを含むドキュメント内のすべてのコントロールを反復処理できます。デザイン時に追加するコントロールをスタティック コントロールといいます。

コントロールの Delete メソッドを呼び出すか、または各 Controls コレクションの Remove メソッドを呼び出すことにより、ダイナミック コントロールを削除できます。Remove メソッドを使用して、Excel のドキュメント レベルのプロジェクトの Sheet1 から NamedRange を削除するコード例を次に示します。

Globals.Sheet1.Controls.Remove("ChartSource")

Globals.Sheet1.Controls.Remove("ChartSource");

スタティック コントロールは実行時に削除できません。Delete メソッドまたは Remove メソッドを使用してスタティック コントロールを削除しようとすると、CannotRemoveControlException がスローされます。

メモ :
ドキュメントの Shutdown イベント ハンドラでは、コントロールをプログラムで削除しないでください。Shutdown イベントが発生すると、ドキュメントの UI 要素は使用できなくなります。ドキュメントが閉じる前にコントロールを削除するには、Document..::.BeforeClose や Document..::.BeforeSave (Word) または Workbook..::.BeforeClose や Workbook..::.BeforeSave (Excel) などの別のイベント ハンドラにコードを追加します。

使用できるヘルパー メソッド (たとえばカスタム ユーザー コントロール) でサポートされない System.Windows.Forms..::.Control を追加するには、次のメソッドを使用します。

• Excel では、Microsoft.Office.Tools.Excel..::.ControlCollection クラスの AddControl()()() メソッドのいずれかを使用します。

• Word では、Microsoft.Office.Tools.Word..::.ControlCollection クラスの AddControl()()() メソッドのいずれかを使用します。

コントロールを追加するには、System.Windows.Forms..::.Control、コントロールの位置、およびコントロールを一意に識別する名前を AddControl メソッドに渡します。Excel では、このメソッドは OLEObject を返します。Word では、このメソッドは OLEControl を返します。これらのオブジェクトは、コントロールがワークシートまたは文書とどのように対話するかを定義します。

AddControl(Control, Range, String) メソッドを使用して、カスタム ユーザー コントロールをワークシートに動的に追加するコード例を次に示します。この例では、UserControl1 という名前のユーザー コントロール、および range1 という名前の Range コントロールを使用します。この例は、Excel のドキュメント レベルのプロジェクトのいずれかの Sheetn クラスから実行することを前提としています。

Dim customControl As New UserControl1()

Dim dynamicControl As Microsoft.Office.Tools.Excel.OLEObject = _
    Me.Controls.AddControl(customControl, range1, "dynamic")

UserControl1 customControl = new UserControl1();

Microsoft.Office.Tools.Excel.OLEObject dynamicControl =
    this.Controls.AddControl(customControl, range1, "dynamic");

AddControl メソッドの 1 つを使用してコントロールをワークシートまたは文書に追加すると、2 つの異なるコントロール オブジェクトが存在するようになります。

• カスタム コントロールを表す System.Windows.Forms..::.Control。

• ワークシートまたは文書に追加された後のコントロールを表す OLEObject または OLEControl。

これらのコントロールの間で、多くのプロパティおよびメソッドが共有されます。これらのメソッドとプロパティには、適切なコントロールからアクセスする必要があります。

• カスタム コントロールのみに属するプロパティおよびメソッドにアクセスするには、System.Windows.Forms..::.Control を使用します。

• コントロールが共有するプロパティおよびメソッドにアクセスするには、OLEObject または OLEControl を使用します。

System.Windows.Forms..::.Control から共有のメソッドやプロパティにアクセスした場合は、警告や通知なしにアクセスが失敗します。無効な結果が生成される場合もあります。OLEObject または OLEControl のメソッドまたはプロパティを常に使用し、必要なメソッドやプロパティが使用できない場合にのみ System.Windows.Forms..::.Control を参照してください。

たとえば、OLEObject クラスと System.Windows.Forms..::.Control クラスの両方に Top プロパティがあります。コントロールの上端とテキストの上端の間の距離を取得または設定するには、System.Windows.Forms..::.Control の Top プロパティではなく、OLEObject の Top プロパティを使用します。

' Property is set in relation to the document.
dynamicControl.Top = 100

' Property is set in relation to the container control.
customControl.Top = 100

// Property is set in relation to the document.
dynamicControl.Top = 100;

// Property is set in relation to the container control.
customControl.Top = 100;