ControlCollection.AddRichTextContentControl Método

Referência

Definição

Namespace:: Microsoft.Office.Tools.Word

Assemblies:: Microsoft.Office.Tools.Word.dll, Microsoft.Office.Tools.Word.v4.0.Utilities.dll

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Sobrecargas

AddRichTextContentControl(String)	Adiciona um novo RichTextContentControl na seleção atual no documento.
AddRichTextContentControl(ContentControl, String)	Adiciona um novo RichTextContentControl que se baseia em um controle de conteúdo nativo no documento.
AddRichTextContentControl(Range, String)	Adiciona um novo RichTextContentControl no intervalo especificado no documento.

AddRichTextContentControl(String)

Adiciona um novo RichTextContentControl na seleção atual no documento.

public:
 Microsoft::Office::Tools::Word::RichTextContentControl ^ AddRichTextContentControl(System::String ^ name);

public Microsoft.Office.Tools.Word.RichTextContentControl AddRichTextContentControl (string name);

abstract member AddRichTextContentControl : string -> Microsoft.Office.Tools.Word.RichTextContentControl

Public Function AddRichTextContentControl (name As String) As RichTextContentControl

Parâmetros

name: String

O nome do novo controle.

Retornos

RichTextContentControl

O RichTextContentControl adicionado ao documento.

Exceções

ArgumentNullException

name é null ou tem tamanho zero.

ControlNameAlreadyExistsException

Um controle com o mesmo nome já está no ControlCollection.

Exemplos

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

Esta versão destina-se a uma personalização no nível de documento. Para usar esse código, cole-o na classe ThisDocument do projeto e chame o método AddRichTextControlAtSelection no método ThisDocument_Startup.

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";
}

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

Esta versão é para um suplemento no nível do aplicativo que tem como destino o .NET Framework 4 ou o .NET Framework 4.5. Para usar esse código, cole-o na classe ThisAddIn do projeto e chame o método AddRichTextControlAtSelection no método ThisAddIn_Startup.

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";
}

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

Comentários

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

Aplica-se a

AddRichTextContentControl(ContentControl, String)

Adiciona um novo RichTextContentControl que se baseia em um controle de conteúdo nativo no documento.

public:
 Microsoft::Office::Tools::Word::RichTextContentControl ^ AddRichTextContentControl(Microsoft::Office::Interop::Word::ContentControl ^ contentControl, System::String ^ name);

public Microsoft.Office.Tools.Word.RichTextContentControl AddRichTextContentControl (Microsoft.Office.Interop.Word.ContentControl contentControl, string name);

abstract member AddRichTextContentControl : Microsoft.Office.Interop.Word.ContentControl * string -> Microsoft.Office.Tools.Word.RichTextContentControl

Public Function AddRichTextContentControl (contentControl As ContentControl, name As String) As RichTextContentControl

Parâmetros

contentControl: ContentControl

O ContentControl que é a base do novo controle.

name: String

O nome do novo controle.

Retornos

RichTextContentControl

O RichTextContentControl adicionado ao documento.

Exceções

ArgumentNullException

contentControl é null.-ou- name é null ou tem comprimento zero.

ControlNameAlreadyExistsException

Um controle com o mesmo nome já está no ControlCollection.

ArgumentException

contentControlnão é uma galeria de blocos de construção (ou seja, o Microsoft.Office.Interop.Word. A propriedade ContentControl.Type de contentControl não tem o valor Microsoft.Office.Interop.Word. WdContentControlType.wdContentControlRichText).

Exemplos

O exemplo de código a seguir cria um novo RichTextContentControl para cada controle de rich text nativo que está no documento.

Esta versão destina-se a uma personalização no nível de documento. Para usar esse código, cole-o na classe ThisDocument do projeto e chame o método CreateRichTextControlsFromNativeControls no método ThisDocument_Startup.

private System.Collections.Generic.List
    <Microsoft.Office.Tools.Word.RichTextContentControl> richTextControls;

private void CreateRichTextControlsFromNativeControls()
{
    if (this.ContentControls.Count <= 0)
        return;

    richTextControls = new System.Collections.Generic.List
        <Microsoft.Office.Tools.Word.RichTextContentControl>();
    int count = 0;

    foreach (Word.ContentControl nativeControl in this.ContentControls)
    {
        if (nativeControl.Type ==
            Microsoft.Office.Interop.Word.WdContentControlType.wdContentControlRichText)
        {
            count++;
            Microsoft.Office.Tools.Word.RichTextContentControl tempControl =
                this.Controls.AddRichTextContentControl(nativeControl,
                "VSTORichTextControl" + count.ToString());
            richTextControls.Add(tempControl);
        }
    }
}

Private richTextControls As New System.Collections.Generic.List _
        (Of Microsoft.Office.Tools.Word.RichTextContentControl)

Private Sub CreateRichTextControlsFromNativeControls()
    If Me.ContentControls.Count <= 0 Then
        Return
    End If

    Dim count As Integer = 0
    For Each nativeControl As Word.ContentControl In Me.ContentControls
        If nativeControl.Type = Word.WdContentControlType.wdContentControlRichText Then
            count += 1
            Dim tempControl As Microsoft.Office.Tools.Word.RichTextContentControl = _
                Me.Controls.AddRichTextContentControl(nativeControl, _
                "VSTORichTextContentControl" + count.ToString())
            richTextControls.Add(tempControl)
        End If
    Next nativeControl
End Sub

Esta versão é para um suplemento no nível do aplicativo que tem como destino o .NET Framework 4 ou o .NET Framework 4.5. Para usar esse código, cole-o na classe ThisAddIn do projeto e chame o método CreateRichTextControlsFromNativeControls no método ThisAddIn_Startup.

private System.Collections.Generic.List
    <Microsoft.Office.Tools.Word.RichTextContentControl> richTextControls;

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

    Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
    if (vstoDoc.ContentControls.Count <= 0)
        return;

    richTextControls = new System.Collections.Generic.List
        <Microsoft.Office.Tools.Word.RichTextContentControl>();
    int count = 0;
    
    foreach (Word.ContentControl nativeControl in vstoDoc.ContentControls)
    {
        if (nativeControl.Type ==
            Microsoft.Office.Interop.Word.WdContentControlType.wdContentControlRichText)
        {
            count++;
            Microsoft.Office.Tools.Word.RichTextContentControl tempControl =
                vstoDoc.Controls.AddRichTextContentControl(nativeControl,
                "VSTORichTextControl" + count.ToString());
            richTextControls.Add(tempControl);
        }
    }
}

Private richTextControls As New System.Collections.Generic.List _
        (Of Microsoft.Office.Tools.Word.RichTextContentControl)

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

    Dim vstoDoc As Document = Globals.Factory.GetVstoObject(Me.Application.ActiveDocument)
    If vstoDoc.ContentControls.Count <= 0 Then
        Return
    End If

    Dim count As Integer = 0
    For Each nativeControl As Word.ContentControl In vstoDoc.ContentControls
        If nativeControl.Type = Word.WdContentControlType.wdContentControlRichText Then
            count += 1
            Dim tempControl As Microsoft.Office.Tools.Word.RichTextContentControl = _
                vstoDoc.Controls.AddRichTextContentControl(nativeControl, _
                "VSTORichTextContentControl" + count.ToString())
            richTextControls.Add(tempControl)
        End If
    Next nativeControl
End Sub

O exemplo de código a seguir cria um novo RichTextContentControl para cada controle de rich text nativo que o usuário adiciona ao documento.

Esta versão destina-se a uma personalização no nível de documento. Para usar esse código, cole-o na classe ThisDocument do projeto. Para C#, você também deve anexar o ThisDocument_RichTextContentControlAfterAdd manipulador de eventos ao ContentControlAfterAdd evento da ThisDocument classe .

void ThisDocument_RichTextContentControlAfterAdd(Word.ContentControl NewContentControl, bool InUndoRedo)
{
    if (NewContentControl.Type == Word.WdContentControlType.wdContentControlRichText)
    {
        this.Controls.AddRichTextContentControl(NewContentControl,
            "RichTextControl" + NewContentControl.ID);
    }
}

Private Sub ThisDocument_RichTextContentControlAfterAdd(ByVal NewContentControl As Word.ContentControl, _
    ByVal InUndoRedo As Boolean) Handles Me.ContentControlAfterAdd

    If NewContentControl.Type = Word.WdContentControlType.wdContentControlRichText Then
        Me.Controls.AddRichTextContentControl(NewContentControl, _
            "RichTextControl" + NewContentControl.ID)
    End If
End Sub

Esta versão é para um suplemento no nível do aplicativo que tem como destino o .NET Framework 4 ou o .NET Framework 4.5. Para usar esse código, cole-o na classe ThisAddIn do projeto. Além disso, você deve anexar o ActiveDocument_RichTextContentControlAfterAdd manipulador de eventos ao ContentControlAfterAdd evento do documento ativo.

void ActiveDocument_RichTextContentControlAfterAdd(
    Word.ContentControl NewContentControl, bool InUndoRedo)
{
    Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
    if (NewContentControl.Type == Word.WdContentControlType.wdContentControlRichText)
    {
        vstoDoc.Controls.AddRichTextContentControl(NewContentControl,
            "RichTextControl" + NewContentControl.ID);
    }
}

Private Sub ActiveDocument_RichTextContentControlAfterAdd( _
    ByVal NewContentControl As Word.ContentControl, _
    ByVal InUndoRedo As Boolean)

    Dim vstoDoc As Document = Globals.Factory.GetVstoObject(Me.Application.ActiveDocument)
    If NewContentControl.Type = Word.WdContentControlType. _
        wdContentControlRichText Then
        vstoDoc.Controls.AddRichTextContentControl(NewContentControl, _
            "RichTextControl" + NewContentControl.ID)
    End If
End Sub

Comentários

Use esse método para adicionar um novo RichTextContentControl baseado em um controle de conteúdo nativo no documento em tempo de execução. Isso é útil quando você cria um RichTextContentControl em tempo de execução e deseja recriar o mesmo controle na próxima vez que o documento for aberto. Para obter mais informações, consulte Adicionando controles a documentos do Office em tempo de execução.

Aplica-se a

AddRichTextContentControl(Range, String)

Adiciona um novo RichTextContentControl no intervalo especificado no documento.

public:
 Microsoft::Office::Tools::Word::RichTextContentControl ^ AddRichTextContentControl(Microsoft::Office::Interop::Word::Range ^ range, System::String ^ name);

public Microsoft.Office.Tools.Word.RichTextContentControl AddRichTextContentControl (Microsoft.Office.Interop.Word.Range range, string name);

abstract member AddRichTextContentControl : Microsoft.Office.Interop.Word.Range * string -> Microsoft.Office.Tools.Word.RichTextContentControl

Public Function AddRichTextContentControl (range As Range, name As String) As RichTextContentControl

Parâmetros

range: Range

Um Range que fornece os limites para o novo controle.

name: String

O nome do novo controle.

Retornos

RichTextContentControl

O RichTextContentControl adicionado ao documento.

Exceções

ArgumentNullException

name é null ou tem tamanho zero.

ControlNameAlreadyExistsException

Um controle com o mesmo nome já está no ControlCollection.

Exemplos

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

Esta versão destina-se a uma personalização no nível de documento. Para usar esse código, cole-o na classe ThisDocument do projeto e chame o método AddRichTextControlAtRange no método ThisDocument_Startup.

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";
}

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()
{
    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";
}

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

Comentários

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

Aplica-se a

Compartilhar via

ControlCollection.AddRichTextContentControl Método

Definição

Sobrecargas

AddRichTextContentControl(String)

Parâmetros

Retornos

Exceções

Exemplos

Comentários

Aplica-se a

AddRichTextContentControl(ContentControl, String)

Parâmetros

Retornos

Exceções

Exemplos

Comentários

Aplica-se a

AddRichTextContentControl(Range, String)

Parâmetros

Retornos

Exceções

Exemplos

Comentários

Aplica-se a

Recursos adicionais