ControlExtensions.AddRichTextBox 方法 (ControlCollection, Double, Double, Double, Double, String)
按照指定的大小和位置向工作表添加一个新的 RichTextBox 控件。
命名空间: Microsoft.Office.Tools.Excel
程序集: Microsoft.Office.Tools.Excel.v4.0.Utilities(在 Microsoft.Office.Tools.Excel.v4.0.Utilities.dll 中)
语法
声明
<ExtensionAttribute> _
Public Shared Function AddRichTextBox ( _
controls As ControlCollection, _
left As Double, _
top As Double, _
width As Double, _
height As Double, _
name As String _
) As RichTextBox
public static RichTextBox AddRichTextBox(
this ControlCollection controls,
double left,
double top,
double width,
double height,
string name
)
参数
- controls
类型:Microsoft.Office.Tools.Excel.ControlCollection
要添加控件的集合。不需要您自己提供此参数。对 Worksheet.Controls 属性(在应用程序级项目中)或 WorksheetBase.Controls 属性(在文档级项目中)返回的集合调用此方法时,将自动提供此参数。
- left
类型:System.Double
控件左边缘与工作表左边缘之间的距离(以磅为单位)。
- top
类型:System.Double
控件上边缘与工作表上边缘之间的距离(以磅为单位)。
- width
类型:System.Double
控件的宽度(以磅为单位)。
- height
类型:System.Double
控件的高度(以磅为单位)。
- name
类型:System.String
控件的名称。
返回值
类型:Microsoft.Office.Tools.Excel.Controls.RichTextBox
添加到 ControlCollection 实例的 RichTextBox 控件。
使用说明
在 Visual Basic 和 C# 中,可以在 ControlCollection 类型的任何对象上将此方法作为实例方法来调用。当使用实例方法语法调用此方法时,请省略第一个参数。有关更多信息,请参见扩展方法 (Visual Basic)或扩展方法(C# 编程指南)。
异常
异常 | 条件 |
---|---|
ArgumentNullException | 名称参数为 nullnull 引用(在 Visual Basic 中为 Nothing) 或长度为零。 |
ControlNameAlreadyExistsException | ControlCollection 实例中已存在一个同名控件。 |
备注
使用 AddRichTextBox 方法可以将 RichTextBox 对象添加到 ControlCollection 的末尾。 若要移除以前以编程方式添加的 RichTextBox 控件,请使用 Remove 方法。
示例
下面的代码示例将一个 RichTextBox 控件添加到工作表顶端,为该控件指定文本,然后设置文本格式。 若要使用此示例,请从文档级项目内的 Sheet1 类中运行此示例。
Private Sub ExcelRangeAddRichTextBox()
Dim RichTextBox1 As Microsoft.Office.Tools. _
Excel.Controls.RichTextBox = Me.Controls. _
AddRichTextBox(Me.Range("A1", "B2"), _
"RichTextBox1")
RichTextBox1.Text = "Sample text"
RichTextBox1.Select(0, 6)
RichTextBox1.SelectionFont = New Font( _
"Times New Roman", 10, FontStyle.Bold)
End Sub
private void ExcelRangeAddRichTextBox()
{
Microsoft.Office.Tools.Excel.Controls.RichTextBox
richTextBox1 = this.Controls.AddRichTextBox(
this.Range["A1", "B2"], "richTextBox1");
richTextBox1.Text = "Sample text";
richTextBox1.Select(0, 6);
richTextBox1.SelectionFont = new Font("Times New Roman",
10, FontStyle.Bold);
}
.NET Framework 安全性
- 对直接调用方的完全信任。此成员不能由部分信任的代码使用。有关更多信息,请参见通过部分受信任的代码使用库。