Método ControlCollection.AddRichTextContentControl (Range, String)

Artigo
08/01/2011

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
A 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
O 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á na ControlCollection.

Comentários

Use esse método para adicionar um novo RichTextContentControl em um intervalo especificado no documento no tempo de execução. For more information, see Adicionar 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 versão é para uma personalização em nível de documento. Para usar esse código, colá-lo na ThisDocument classe em seu projeto e a chamada a AddRichTextControlAtRange método a partir do ThisDocument_Startup método.

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 é um suplemento de nível de aplicativo que se destina a .NET Framework 4. Para usar esse código, colá-lo na ThisAddIn classe em seu projeto e a chamada a AddRichTextControlAtRange método a partir do ThisAddIn_Startup método.

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áveis.