ControlExtensions.AddLinkLabel 方法 (ControlCollection, Range, Single, Single, String)
按照指定的大小和位置向文档中添加一个新的 LinkLabel 控件。
命名空间: Microsoft.Office.Tools.Word
程序集: Microsoft.Office.Tools.Word.v4.0.Utilities(在 Microsoft.Office.Tools.Word.v4.0.Utilities.dll 中)
语法
声明
<ExtensionAttribute> _
Public Shared Function AddLinkLabel ( _
controls As ControlCollection, _
range As Range, _
width As Single, _
height As Single, _
name As String _
) As LinkLabel
public static LinkLabel AddLinkLabel(
this ControlCollection controls,
Range range,
float width,
float height,
string name
)
参数
- controls
类型:Microsoft.Office.Tools.Word.ControlCollection
要添加控件的集合。不需要您自己提供此参数。对 Document.Controls 属性(在应用程序级项目中)或 DocumentBase.Controls 属性(在文档级项目中)返回的集合调用此方法时,将自动提供此参数。
- range
类型:Microsoft.Office.Interop.Word.Range
控件的位置。
- width
类型:System.Single
控件的宽度(以磅为单位)。
- height
类型:System.Single
控件的高度(以磅为单位)。
- name
类型:System.String
可用于索引 ControlCollection 实例中控件的控件名称。
返回值
类型:Microsoft.Office.Tools.Word.Controls.LinkLabel
添加到文档的控件。
使用说明
在 Visual Basic 和 C# 中,可以在 ControlCollection 类型的任何对象上将此方法作为实例方法来调用。当使用实例方法语法调用此方法时,请省略第一个参数。有关更多信息,请参见扩展方法 (Visual Basic)或扩展方法(C# 编程指南)。
异常
异常 | 条件 |
---|---|
ArgumentNullException | name 或 range 参数为 nullnull 引用(在 Visual Basic 中为 Nothing),或者 name 参数长度为零。 |
ControlNameAlreadyExistsException | ControlCollection 实例中已存在一个同名控件。 |
InvalidRangeException | 指定的范围无效。 |
备注
使用此方法可以将 LinkLabel 对象添加到 ControlCollection 的末尾。
若要移除通过编程方式添加的 LinkLabel,请使用 Remove 方法。
示例
下面的代码示例向文档的第一个段落添加一个 LinkLabel 控件,然后将文本更改为 First Name。 然后,该代码将链接的颜色更改为蓝色并将 LinkBehavior 属性设置为 LinkBehavior 枚举的 HoverUnderline 值。 若要使用此示例,请从文档级项目内的 ThisDocument 类中运行此示例。
Private Sub WordRangeAddLinkLabel()
Me.Paragraphs(1).Range.InsertParagraphBefore()
Dim LinkLabel1 As Microsoft.Office.Tools.Word.Controls. _
LinkLabel = Me.Controls.AddLinkLabel(Me.Paragraphs(1). _
Range, 75, 17.25F, "LinkLabel1")
LinkLabel1.Text = "First Name"
LinkLabel1.LinkColor = Color.Blue
LinkLabel1.LinkBehavior = LinkBehavior.HoverUnderline
End Sub
private void WordRangeAddLinkLabel()
{
this.Paragraphs[1].Range.InsertParagraphBefore();
Microsoft.Office.Tools.Word.Controls.LinkLabel
linkLabel1 = this.Controls.AddLinkLabel(
this.Paragraphs[1].Range, 75, 17.25F, "linkLabel1");
linkLabel1.Text = "First Name";
linkLabel1.LinkColor = Color.Blue;
linkLabel1.LinkBehavior = LinkBehavior.HoverUnderline;
}
.NET Framework 安全性
- 对直接调用方的完全信任。此成员不能由部分信任的代码使用。有关更多信息,请参见通过部分受信任的代码使用库。