Metodo ControlCollection.AddRichTextContentControl (ContentControl, String)

Articolo
08/11/2011

Aggiunge un nuovo oggetto RichTextContentControl basato su un controllo del contenuto nativo presente nel documento.

Spazio dei nomi: Microsoft.Office.Tools.Word
Assembly: Microsoft.Office.Tools.Word (in Microsoft.Office.Tools.Word.dll)

Sintassi

'Dichiarazione
Function AddRichTextContentControl ( _
    contentControl As ContentControl, _
    name As String _
) As RichTextContentControl

RichTextContentControl AddRichTextContentControl(
    ContentControl contentControl,
    string name
)

Parametri

contentControl
Tipo: Microsoft.Office.Interop.Word.ContentControl
Oggetto Microsoft.Office.Interop.Word.ContentControl alla base del nuovo controllo.

name
Tipo: System.String
Nome del nuovo controllo.

Valore restituito

Tipo: Microsoft.Office.Tools.Word.RichTextContentControl
Oggetto RichTextContentControl aggiunto al documento.

Eccezioni

Eccezione	Condizione
ArgumentNullException	contentControl è nullriferimento null (Nothing in Visual Basic). In alternativa name è nullriferimento null (Nothing in Visual Basic) oppure ha lunghezza zero.
ControlNameAlreadyExistsException	In ControlCollection è già presente un controllo con lo stesso nome.
ArgumentException	contentControl non è una raccolta di blocchi predefiniti, vale a dire che la proprietà Microsoft.Office.Interop.Word.ContentControl.Type di contentControl non ha il valore Microsoft.Office.Interop.Word.WdContentControlType.wdContentControlRichText.

ArgumentNullException

contentControl è nullriferimento null (Nothing in Visual Basic).

In alternativa

name è nullriferimento null (Nothing in Visual Basic) oppure ha lunghezza zero.

ControlNameAlreadyExistsException

In ControlCollection è già presente un controllo con lo stesso nome.

ArgumentException

contentControl non è una raccolta di blocchi predefiniti, vale a dire che la proprietà Microsoft.Office.Interop.Word.ContentControl.Type di contentControl non ha il valore Microsoft.Office.Interop.Word.WdContentControlType.wdContentControlRichText.

Note

Utilizzare questo metodo per aggiungere un nuovo oggetto RichTextContentControl basato su un controllo contenuto nativo presente nel documento in fase di esecuzione. Questa operazione si rivela utile quando, nella creazione di un oggetto RichTextContentControl in fase di esecuzione, si desidera ricreare lo stesso controllo alla successiva apertura del documento. Per ulteriori informazioni, vedere Aggiunta di controlli ai documenti di Office in fase di esecuzione.

Esempi

Nell'esempio di codice seguente viene creato un nuovo oggetto RichTextContentControl per ciascun controllo RTF nativo presente nel documento.

Questa versione è valida per una personalizzazione a livello di documento. Per utilizzare questo codice, incollarlo nella classe ThisDocument del progetto e quindi chiamare il metodo CreateRichTextControlsFromNativeControls dal metodo ThisDocument_Startup.

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

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

Questa versione è valida per un componente aggiuntivo a livello di applicazione destinato a .NET Framework 4. Per utilizzare questo codice, incollarlo nella classe ThisAddIn del progetto e quindi chiamare il metodo CreateRichTextControlsFromNativeControls dal metodo ThisAddIn_Startup.

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

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

Nell'esempio di codice seguente viene creato un nuovo oggetto RichTextContentControl per ciascun controllo RTF nativo aggiunto dall'utente al documento.

Questa versione è valida per una personalizzazione a livello di documento. Per utilizzare il codice, incollarlo nella classe ThisDocument del progetto. In C# è inoltre necessario collegare il gestore eventi ThisDocument_RichTextContentControlAfterAdd all'evento ContentControlAfterAdd della classe ThisDocument.

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

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

Questa versione è valida per un componente aggiuntivo a livello di applicazione destinato a .NET Framework 4. Per utilizzare il codice, incollarlo nella classe ThisAddIn del progetto. È inoltre necessario collegare il gestore eventi ActiveDocument_RichTextContentControlAfterAdd all'evento ContentControlAfterAdd del documento attivo.

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

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

Sicurezza di .NET Framework

Attendibilità totale per il chiamante immediato. Impossibile utilizzare questo membro in codice parzialmente attendibile. Per ulteriori informazioni, vedere Utilizzo di librerie da codice parzialmente attendibile.