ControlExtensions.AddTextBox 方法 (ControlCollection, Range, String)
在工作表中的指定范围添加一个新的 TextBox 控件。
命名空间: Microsoft.Office.Tools.Excel
程序集: Microsoft.Office.Tools.Excel.v4.0.Utilities(在 Microsoft.Office.Tools.Excel.v4.0.Utilities.dll 中)
语法
声明
<ExtensionAttribute> _
Public Shared Function AddTextBox ( _
controls As ControlCollection, _
range As Range, _
name As String _
) As TextBox
public static TextBox AddTextBox(
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.TextBox
添加到 ControlCollection 实例的 TextBox 控件。
使用说明
在 Visual Basic 和 C# 中,可以在 ControlCollection 类型的任何对象上将此方法作为实例方法来调用。当使用实例方法语法调用此方法时,请省略第一个参数。有关更多信息,请参见扩展方法 (Visual Basic)或扩展方法(C# 编程指南)。
异常
异常 | 条件 |
---|---|
ArgumentNullException | 名称参数或范围参数为 nullnull 引用(在 Visual Basic 中为 Nothing),或者名称参数长度为零。 |
ControlNameAlreadyExistsException | ControlCollection 实例中已存在一个同名控件。 |
InvalidRangeException | 指定的范围无效。 不能使用多区域范围。 该范围应与 ControlCollection 实例同在一个工作表中。 |
备注
使用 AddTextBox 方法可以将 TextBox 对象添加到 ControlCollection 的末尾。 若要移除以前以编程方式添加的 TextBox,请使用 Remove 方法。
在调整范围的大小时,控件会自动调整其自身的大小。
示例
下面的代码示例将一个 TextBox 控件添加到单元格**“A1”至“B2”**,然后为该控件指定文本。 若要使用此示例,请从文档级项目内的 Sheet1 类中运行此示例。
Private Sub ExcelRangeAddTextBox()
Dim TextBox1 As Microsoft.Office.Tools.Excel. _
Controls.TextBox = Me.Controls.AddTextBox( _
Me.Range("A1", "B2"), "TextBox1")
TextBox1.Text = "Sample text"
End Sub
private void ExcelRangeAddTextBox()
{
Microsoft.Office.Tools.Excel.Controls.TextBox
textBox1 = this.Controls.AddTextBox(
this.Range["A1", "B2"], "textBox1");
textBox1.Text = "Sample text";
}
.NET Framework 安全性
- 对直接调用方的完全信任。此成员不能由部分信任的代码使用。有关更多信息,请参见通过部分受信任的代码使用库。