ControlExtensions.AddListBox メソッド (ControlCollection, Range, String)
新しい ListBox コントロールをワークシートの指定の範囲に追加します。
名前空間: Microsoft.Office.Tools.Excel
アセンブリ: Microsoft.Office.Tools.Excel.v4.0.Utilities (Microsoft.Office.Tools.Excel.v4.0.Utilities.dll 内)
構文
'宣言
<ExtensionAttribute> _
Public Shared Function AddListBox ( _
controls As ControlCollection, _
range As Range, _
name As String _
) As ListBox
public static ListBox AddListBox(
this ControlCollection controls,
Range range,
string name
)
パラメーター
- controls
型 : Microsoft.Office.Tools.Excel.ControlCollection
コントロールを追加するコレクション。このパラメーターは手動で指定しないでください。(アプリケーション レベルのプロジェクトの) Worksheet.Controls プロパティまたは (ドキュメント レベルのプロジェクトの) WorksheetBase.Controls プロパティによって返されたコレクションでこのメソッドを呼び出す場合、このパラメーターは自動的に指定されます。
- range
型 : Microsoft.Office.Interop.Excel.Range
コントロールの境界を表す Range。
- name
型 : System.String
ControlCollection インスタンス内のコントロールにインデックスを付けるために使用できるコントロールの名前。
戻り値
型 : Microsoft.Office.Tools.Excel.Controls.ListBox
ControlCollection インスタンスに追加された ListBox コントロール。
使用上の注意
Visual Basic および Visual C# では、このメソッドを、ControlCollection 型のオブジェクトのインスタンス メソッドとして呼び出すことができます。インスタンス メソッド構文を使用してこのメソッドを呼び出す場合は、最初のパラメーターを省略します。詳細については、「拡張メソッド (Visual Basic)」または「拡張メソッド (C# プログラミング ガイド)」を参照してください。
例外
| 例外 | 条件 |
|---|---|
| ArgumentNullException | name 引数または range 引数が nullnull 参照 (Visual Basic では Nothing)。または、name 引数の長さが 0 の場合。 |
| ControlNameAlreadyExistsException | 同じ名前のコントロールが既に ControlCollection インスタンスに存在します。 |
| InvalidRangeException | 指定された範囲が無効である場合。複数の領域で構成される範囲は使用できません。範囲は、ControlCollection インスタンスと同じワークシート上であることが必要です。 |
解説
AddListBox メソッドを使用すると、ListBox オブジェクトを ControlCollection の最後に追加できます。以前にプログラムで追加された ListBox を削除するには、Remove メソッドを使用します。
範囲のサイズが変更されると、コントロールのサイズが自動的に変更されます。
例
次のコード例は、セル A1 ～ B6 に ListBox コントロールを追加し、そのリスト ボックスに 2 つの項目を追加して、最初の項目を選択します。この例を使用するには、これをドキュメント レベルのプロジェクトの Sheet1 クラスから実行します。
Private Sub ExcelRangeAddListBox()
Dim ListBox1 As Microsoft.Office.Tools.Excel. _
Controls.ListBox = Me.Controls.AddListBox( _
Me.Range("A1", "B6"), "ListBox1")
ListBox1.Items.Add("First Item")
ListBox1.Items.Add("Second Item")
ListBox1.SelectedIndex = 0
End Sub
private void ExcelRangeAddListBox()
{
Microsoft.Office.Tools.Excel.Controls.ListBox
listBox1 = this.Controls.AddListBox(
this.Range["A1", "B6"], "lisBox1");
listBox1.Items.Add("First Item");
listBox1.Items.Add("Second Item");
listBox1.SelectedIndex = 0;
}
.NET Framework セキュリティ
- 直前の呼び出し元に対する完全な信頼。このメンバーは、部分的に信頼されているコードから使用することはできません。詳細については、「部分信頼コードからのライブラリの使用」を参照してください。