ControlCollection.AddRichTextContentControl 方法 (String)

發行項
05/07/2013

在文件中目前的選取位置加入新的 RichTextContentControl。

命名空間： Microsoft.Office.Tools.Word
組件： Microsoft.Office.Tools.Word (在 Microsoft.Office.Tools.Word.dll 中)

語法

'宣告
Function AddRichTextContentControl ( _
    name As String _
) As RichTextContentControl

RichTextContentControl AddRichTextContentControl(
    string name
)

參數

name
型別：System.String
新控制項的名稱。

傳回值

型別：Microsoft.Office.Tools.Word.RichTextContentControl
加入至文件中的 RichTextContentControl。

例外狀況

例外狀況	條件
ArgumentNullException	name 是 nullnull 參考 (即 Visual Basic 中的 Nothing)，或長度為 0。
ControlNameAlreadyExistsException	ControlCollection 中已有相同名稱的控制項。

備註

在執行階段使用這個方法，將新的 RichTextContentControl 加入至文件中目前的選取位置。如需詳細資訊，請參閱在執行階段將控制項加入至 Office 文件。

範例

下列程式碼範例會將新的 RichTextContentControl 加入至文件的開頭。

這是示範文件層級自訂的版本。若要使用這段程式碼，請將它貼到專案的 ThisDocument 類別中，並從 ThisDocument_Startup 方法呼叫 AddRichTextControlAtSelection 方法。

Dim richTextControl1 As Microsoft.Office.Tools.Word.RichTextContentControl

Private Sub AddRichTextControlAtSelection()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Me.Paragraphs(1).Range.Select()
    richTextControl1 = Me.Controls.AddRichTextContentControl("richTextControl1")
    richTextControl1.PlaceholderText = "Enter your first name"
End Sub

private Microsoft.Office.Tools.Word.RichTextContentControl richTextControl1;

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

    richTextControl1 = this.Controls.AddRichTextContentControl("richTextControl1");
    richTextControl1.PlaceholderText = "Enter your first name";
}

以 .NET Framework 4 或 .NET Framework 4.5的這個版本是應用程式層級增益集。若要使用這段程式碼，請將它貼到專案的 ThisAddIn 類別中，並從 ThisAddIn_Startup 方法呼叫 AddRichTextControlAtSelection 方法。

Dim richTextControl1 As Microsoft.Office.Tools.Word.RichTextContentControl

Private Sub AddRichTextControlAtSelection()
    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()
    richTextControl1 = vstoDoc.Controls.AddRichTextContentControl("richTextControl1")
    richTextControl1.PlaceholderText = "Enter your first name"
End Sub

private Microsoft.Office.Tools.Word.RichTextContentControl richTextControl1;

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

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

    richTextControl1 = vstoDoc.Controls.AddRichTextContentControl("richTextControl1");
    richTextControl1.PlaceholderText = "Enter your first name";
}