Método ControlCollection.AddRichTextContentControl (Range, String)

Artigo
01/09/2014

Adiciona um novo RichTextContentControl no intervalo especificado no documento.

Namespace: Microsoft.Office.Tools.Word
Assembly: Microsoft.Office.Tools.Word (em Microsoft.Office.Tools.Word.dll)

Sintaxe

'Declaração
Function AddRichTextContentControl ( _
    range As Range, _
    name As String _
) As RichTextContentControl

RichTextContentControl AddRichTextContentControl(
    Range range,
    string name
)

Parâmetros

range
Tipo: Microsoft.Office.Interop.Word.Range
Range que fornece os limites para o novo controle.

name
Tipo: System.String
O nome do novo controle.

Valor de retorno

Tipo: Microsoft.Office.Tools.Word.RichTextContentControl
RichTextContentControl que foi adicionado ao documento.

Exceções

Exceção	Condição
ArgumentNullException	name é nulluma referência nula (Nothing no Visual Basic) ou tem comprimento zero.
ControlNameAlreadyExistsException	Um controle com o mesmo nome já está em ControlCollection.

Comentários

Use este método para adicionar em tempo de execução novo RichTextContentControl em um intervalo especificado no documento. Para obter mais informações, consulte Adicionando controles a documentos do Office em tempo de execução.

Exemplos

O exemplo de código a seguir adiciona um novo RichTextContentControl para o início do documento.

Esta é uma versão para personalização de um documento nível. Para usar este código, colagem na classe de ThisDocument em seu projeto, e chame o método de AddRichTextControlAtRange de método ThisDocument_Startup .

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

Private Sub AddRichTextControlAtRange()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    richTextControl2 = Me.Controls.AddRichTextContentControl(Me.Paragraphs(1).Range, _
        "richTextControl2")
    richTextControl2.PlaceholderText = "Enter your first name"
End Sub

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

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

    richTextControl2 = this.Controls.AddRichTextContentControl(this.Paragraphs[1].Range,
        "richTextControl2");
    richTextControl2.PlaceholderText = "Enter your first name";
}

Esta versão é para um suplemento ao nível que direciona .NET Framework 4 ou .NET Framework 4.5. Para usar este código, colagem na classe de ThisAddIn em seu projeto, e chame o método de AddRichTextControlAtRange de método ThisAddIn_Startup .

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

Private Sub AddRichTextControlAtRange()
    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()
    richTextControl2 = vstoDoc.Controls.AddRichTextContentControl( _
        vstoDoc.Paragraphs(1).Range, _
        "richTextControl2")
    richTextControl2.PlaceholderText = "Enter your first name"
End Sub

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

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

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

    richTextControl2 = vstoDoc.Controls.AddRichTextContentControl(vstoDoc.Paragraphs[1].Range,
        "richTextControl2");
    richTextControl2.PlaceholderText = "Enter your first name";
}

Segurança do .NET Framework

Confiança total para o chamador imediato. O membro não pode ser usado por código parcialmente confiável. Para obter mais informações, consulte Usando bibliotecas de código parcialmente confiável.