ControlCollection.AddPlainTextContentControl 方法 (String)

项目
05/20/2013

在文档中当前选定的位置添加一个新的 PlainTextContentControl。

命名空间： Microsoft.Office.Tools.Word
程序集： Microsoft.Office.Tools.Word（在 Microsoft.Office.Tools.Word.dll 中）

语法

声明
Function AddPlainTextContentControl ( _
    name As String _
) As PlainTextContentControl

PlainTextContentControl AddPlainTextContentControl(
    string name
)

参数

name
类型：System.String
新控件的名称。

返回值

类型：Microsoft.Office.Tools.Word.PlainTextContentControl
添加到文档的 PlainTextContentControl。

异常

异常	条件
ArgumentNullException	name 为 nullnull 引用（在 Visual Basic 中为 Nothing）或长度为零。
ControlNameAlreadyExistsException	ControlCollection 中已存在一个同名控件。

备注

使用此方法，可以在运行时在文档中的当前选定位置添加一个新的 PlainTextContentControl。有关更多信息，请参见在运行时向 Office 文档添加控件。

示例

下面的代码示例会在文档开头添加一个新的 PlainTextContentControl。

此版本针对的是文档级自定义项。若要使用此代码，请将其粘贴到项目内的 ThisDocument 类中，然后从 ThisDocument_Startup 方法中调用 AddTextControlAtSelection 方法。

Dim plainTextControl1 As Microsoft.Office.Tools.Word.PlainTextContentControl

Private Sub AddPlainTextControlAtSelection()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Me.Paragraphs(1).Range.Select()
    plainTextControl1 = Me.Controls.AddPlainTextContentControl("plainTextControl1")
    plainTextControl1.PlaceholderText = "Enter your first name"
End Sub

private Microsoft.Office.Tools.Word.PlainTextContentControl textControl1;

private void AddTextControlAtSelection()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    this.Paragraphs[1].Range.Select();

    textControl1 = this.Controls.AddPlainTextContentControl("textControl1");
    textControl1.PlaceholderText = "Enter your first name";
}

此版本用于针对 .NET Framework 4 或 .NET Framework 4.5的应用程序级外接程序。若要使用此代码，请将其粘贴到项目内的 ThisAddIn 类中，然后从 ThisAddIn_Startup 方法中调用 AddTextControlAtSelection 方法。

Dim plainTextControl1 As Microsoft.Office.Tools.Word.PlainTextContentControl

Private Sub AddPlainTextControlAtSelection()
    If Me.Application.ActiveDocument Is Nothing Then
        Return
    End If

    Dim vstoDoc As Document = Globals.Factory.GetVstoObject(Me.Application.ActiveDocument)
    vstoDoc.Paragraphs(1).Range.InsertParagraphBefore()
    vstoDoc.Paragraphs(1).Range.Select()
    plainTextControl1 = vstoDoc.Controls.AddPlainTextContentControl("plainTextControl1")
    plainTextControl1.PlaceholderText = "Enter your first name"
End Sub

private Microsoft.Office.Tools.Word.PlainTextContentControl textControl1;

private void AddTextControlAtSelection()
{
    if (this.Application.ActiveDocument == null)
        return;

    Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
    vstoDoc.Paragraphs[1].Range.InsertParagraphBefore();
    vstoDoc.Paragraphs[1].Range.Select();

    textControl1 = vstoDoc.Controls.AddPlainTextContentControl("textControl1");
    textControl1.PlaceholderText = "Enter your first name";
}