Metodo ControlCollection.AddPlainTextContentControl (ContentControl, String)

Articolo
01/06/2014

Aggiunge un nuovo oggetto PlainTextContentControl 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 AddPlainTextContentControl ( _
    contentControl As ContentControl, _
    name As String _
) As PlainTextContentControl

PlainTextContentControl AddPlainTextContentControl(
    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.PlainTextContentControl
Oggetto PlainTextContentControl 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à Type di contentControl non ha il valore Microsoft.Office.Interop.Word.WdContentControlType.wdContentControlText.

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à Type di contentControl non ha il valore Microsoft.Office.Interop.Word.WdContentControlType.wdContentControlText.

Note

Utilizzare questo metodo per aggiungere un nuovo oggetto PlainTextContentControl basato su un controllo contenuto nativo presente nel documento in fase di esecuzione. Questa operazione si rivela utile quando, nella creazione di un oggetto PlainTextContentControl 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 PlainTextContentControl per ciascun controllo di testo normale 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 CreateTextControlsFromNativeControls dal metodo ThisDocument_Startup.

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

Private Sub CreatePlainTextControlsFromNativeControls()
    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.wdContentControlText Then
            count += 1
            Dim tempControl As Microsoft.Office.Tools.Word.PlainTextContentControl = _
                Me.Controls.AddPlainTextContentControl(nativeControl, _
                "VSTOPlainTextContentControl" + count.ToString())
            plainTextControls.Add(tempControl)
        End If
    Next nativeControl
End Sub

private System.Collections.Generic.List<Microsoft.Office.Tools.Word.PlainTextContentControl> plainTextControls;

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

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

    foreach (Word.ContentControl nativeControl in this.ContentControls)
    {
        if (nativeControl.Type == Word.WdContentControlType.wdContentControlText)
        {
            count++;
            Microsoft.Office.Tools.Word.PlainTextContentControl tempControl =
                this.Controls.AddPlainTextContentControl(nativeControl,
                "VSTOPlainTextContentControl" + count.ToString());
            plainTextControls.Add(tempControl);
        }
    }
}

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

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

Private Sub CreatePlainTextControlsFromNativeControls()
    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.wdContentControlText Then
            count += 1
            Dim tempControl As Microsoft.Office.Tools.Word.PlainTextContentControl = _
                vstoDoc.Controls.AddPlainTextContentControl(nativeControl, _
                "VSTOPlainTextContentControl" + count.ToString())
            plainTextControls.Add(tempControl)
        End If
    Next nativeControl
End Sub

private System.Collections.Generic.List<Microsoft.Office.Tools.Word.PlainTextContentControl> plainTextControls;

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

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

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

    foreach (Word.ContentControl nativeControl in vstoDoc.ContentControls)
    {
        if (nativeControl.Type == Word.WdContentControlType.wdContentControlText)
        {
            count++;
            Microsoft.Office.Tools.Word.PlainTextContentControl tempControl =
                vstoDoc.Controls.AddPlainTextContentControl(nativeControl,
                "VSTOPlainTextContentControl" + count.ToString());
            plainTextControls.Add(tempControl);
        }
    }
}

Nell'esempio di codice seguente viene creato un nuovo oggetto PlainTextContentControl per ciascun controllo di testo normale 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_PlainTextContentControlAfterAdd all'evento ContentControlAfterAdd della classe ThisDocument.

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

    If NewContentControl.Type = Word.WdContentControlType.wdContentControlText Then
        Me.Controls.AddPlainTextContentControl(NewContentControl, _
            "PlainTextControl" + NewContentControl.ID)
    End If
End Sub

void ThisDocument_PlainTextContentControlAfterAdd(Word.ContentControl NewContentControl, bool InUndoRedo)
{
    if (NewContentControl.Type == Word.WdContentControlType.wdContentControlText)
    {
        this.Controls.AddPlainTextContentControl(NewContentControl,
            "PlainTextControl" + NewContentControl.ID);
    }
}

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

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

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

void ActiveDocument_PlainTextContentControlAfterAdd(
    Word.ContentControl NewContentControl, bool InUndoRedo)
{
    Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
    if (NewContentControl.Type == Word.WdContentControlType.wdContentControlText)
    {
        vstoDoc.Controls.AddPlainTextContentControl(NewContentControl,
            "PlainTextControl" + 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.