ControlCollection.AddPlainTextContentControl Methode
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Überlädt
| AddPlainTextContentControl(String) |
Fügt bei der aktuellen Auswahl im Dokument ein neues PlainTextContentControl hinzu. |
| AddPlainTextContentControl(ContentControl, String) |
Fügt ein neues PlainTextContentControl hinzu, das auf einem nativen Inhaltssteuerelement im Dokument basiert. |
| AddPlainTextContentControl(Range, String) |
Fügt ein neues PlainTextContentControl im angegebenen Bereich im Dokument hinzu. |
AddPlainTextContentControl(String)
Fügt bei der aktuellen Auswahl im Dokument ein neues PlainTextContentControl hinzu.
public Microsoft.Office.Tools.Word.PlainTextContentControl AddPlainTextContentControl (string name);
Parameter
- name
- String
Der Name des neuen Steuerelements.
Gibt zurück
Das PlainTextContentControl, das dem Dokument hinzugefügt wurde.
Ausnahmen
name ist null oder hat die Länge 0 (null).
Ein Steuerelement mit dem gleichen Namen ist bereits in der ControlCollection enthalten.
Beispiele
Im folgenden Codebeispiel wird PlainTextContentControl am Anfang des Dokuments ein neues hinzugefügt.
Diese Version ist für eine Anpassung auf Dokument Ebene vorgesehen. Um diesen Code zu verwenden, fügen Sie ihn in die ThisDocument -Klasse in Ihrem Projekt ein, und nennen Sie die- AddTextControlAtSelection Methode von der- ThisDocument_Startup Methode.
private Microsoft.Office.Tools.Word.PlainTextContentControl textControl1;
private void AddTextControlAtSelection()
{
this.Paragraphs[1].Range.InsertParagraphBefore();
this.Paragraphs[1].Range.Select();
textControl1 = this.Controls.AddPlainTextContentControl("textControl1");
textControl1.PlaceholderText = "Enter your first name";
}
Dim plainTextControl1 As Microsoft.Office.Tools.Word.PlainTextContentControl
Private Sub AddPlainTextControlAtSelection()
Me.Paragraphs(1).Range.InsertParagraphBefore()
Me.Paragraphs(1).Range.Select()
plainTextControl1 = Me.Controls.AddPlainTextContentControl("plainTextControl1")
plainTextControl1.PlaceholderText = "Enter your first name"
End Sub
Diese Version bezieht sich auf ein Add-In auf Anwendungsebene, das auf .NET Framework 4 oder .NET Framework 4.5 abzielt. Um diesen Code zu verwenden, fügen Sie ihn in die ThisAddIn -Klasse in Ihrem Projekt ein, und nennen Sie die- AddTextControlAtSelection Methode von der- ThisAddIn_Startup Methode.
private Microsoft.Office.Tools.Word.PlainTextContentControl textControl1;
private void AddTextControlAtSelection()
{
if (this.Application.ActiveDocument == null)
return;
Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
vstoDoc.Paragraphs[1].Range.InsertParagraphBefore();
vstoDoc.Paragraphs[1].Range.Select();
textControl1 = vstoDoc.Controls.AddPlainTextContentControl("textControl1");
textControl1.PlaceholderText = "Enter your first name";
}
Dim plainTextControl1 As Microsoft.Office.Tools.Word.PlainTextContentControl
Private Sub AddPlainTextControlAtSelection()
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()
plainTextControl1 = vstoDoc.Controls.AddPlainTextContentControl("plainTextControl1")
plainTextControl1.PlaceholderText = "Enter your first name"
End Sub
Hinweise
Verwenden Sie diese Methode, um zur PlainTextContentControl Laufzeit einen neuen an der aktuellen Auswahl im Dokument hinzuzufügen. Weitere Informationen finden Sie unter Adding Controls to Office Documents at Run Time.
Gilt für
AddPlainTextContentControl(ContentControl, String)
Fügt ein neues PlainTextContentControl hinzu, das auf einem nativen Inhaltssteuerelement im Dokument basiert.
public Microsoft.Office.Tools.Word.PlainTextContentControl AddPlainTextContentControl (Microsoft.Office.Interop.Word.ContentControl contentControl, string name);
Parameter
- contentControl
- ContentControl
Das ContentControl, das die Grundlage für das neue Steuerelement ist.
- name
- String
Der Name des neuen Steuerelements.
Gibt zurück
Das PlainTextContentControl, das dem Dokument hinzugefügt wurde.
Ausnahmen
Ein Steuerelement mit dem gleichen Namen ist bereits in der ControlCollection enthalten.
contentControl ist kein Bausteinkatalog (d.h. die Type-Eigenschaft von contentControl weist nicht den Wert Microsoft.Office.Interop.Word.WdContentControlType.wdContentControlText auf).
Beispiele
Im folgenden Codebeispiel wird ein neues-Element für jedes systemeigene nur-Text-Steuerelement erstellt PlainTextContentControl , das im Dokument enthalten ist.
Diese Version ist für eine Anpassung auf Dokument Ebene vorgesehen. Um diesen Code zu verwenden, fügen Sie ihn in die ThisDocument -Klasse in Ihrem Projekt ein, und nennen Sie die- CreateTextControlsFromNativeControls Methode von der- ThisDocument_Startup Methode.
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);
}
}
}
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
Diese Version bezieht sich auf ein Add-In auf Anwendungsebene, das auf .NET Framework 4 oder .NET Framework 4.5 abzielt. Um diesen Code zu verwenden, fügen Sie ihn in die ThisAddIn -Klasse in Ihrem Projekt ein, und nennen Sie die- CreateTextControlsFromNativeControls Methode von der- ThisAddIn_Startup Methode.
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);
}
}
}
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
Im folgenden Codebeispiel wird ein neues-Element für jedes systemeigene nur-Text-Steuerelement erstellt PlainTextContentControl , das dem Dokument hinzugefügt wird.
Diese Version ist für eine Anpassung auf Dokument Ebene vorgesehen. Wenn Sie diesen Code verwenden möchten, fügen Sie ihn in die- ThisDocument Klasse in Ihrem Projekt ein. Für c# müssen Sie auch den- ThisDocument_PlainTextContentControlAfterAdd Ereignishandler an das- ContentControlAfterAdd Ereignis der- ThisDocument Klasse anfügen.
void ThisDocument_PlainTextContentControlAfterAdd(Word.ContentControl NewContentControl, bool InUndoRedo)
{
if (NewContentControl.Type == Word.WdContentControlType.wdContentControlText)
{
this.Controls.AddPlainTextContentControl(NewContentControl,
"PlainTextControl" + NewContentControl.ID);
}
}
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
Diese Version bezieht sich auf ein Add-In auf Anwendungsebene, das auf .NET Framework 4 oder .NET Framework 4.5 abzielt. Wenn Sie diesen Code verwenden möchten, fügen Sie ihn in die- ThisAddIn Klasse in Ihrem Projekt ein. Außerdem müssen Sie den- ActiveDocument_PlainTextContentControlAfterAdd Ereignishandler an das- ContentControlAfterAdd Ereignis des aktiven Dokuments anfügen.
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);
}
}
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
Hinweise
Verwenden Sie diese Methode, um ein neues hinzuzufügen PlainTextContentControl , das auf einem systemeigenen Inhalts Steuerelement im Dokument zur Laufzeit basiert. Dies ist hilfreich, wenn Sie einen PlainTextContentControl zur Laufzeit erstellen und das gleiche Steuerelement beim nächsten Öffnen des Dokuments neu erstellen möchten. Weitere Informationen finden Sie unter Adding Controls to Office Documents at Run Time.
Gilt für
AddPlainTextContentControl(Range, String)
Fügt ein neues PlainTextContentControl im angegebenen Bereich im Dokument hinzu.
public Microsoft.Office.Tools.Word.PlainTextContentControl AddPlainTextContentControl (Microsoft.Office.Interop.Word.Range range, string name);
Parameter
- name
- String
Der Name des neuen Steuerelements.
Gibt zurück
Das PlainTextContentControl, das dem Dokument hinzugefügt wurde.
Ausnahmen
name ist null oder hat die Länge 0 (null).
Ein Steuerelement mit dem gleichen Namen ist bereits in der ControlCollection enthalten.
Beispiele
Im folgenden Codebeispiel wird PlainTextContentControl am Anfang des Dokuments ein neues hinzugefügt.
Diese Version ist für eine Anpassung auf Dokument Ebene vorgesehen. Um diesen Code zu verwenden, fügen Sie ihn in die ThisDocument -Klasse in Ihrem Projekt ein, und nennen Sie die- AddTextControlAtRange Methode von der- ThisDocument_Startup Methode.
private Microsoft.Office.Tools.Word.PlainTextContentControl textControl2;
private void AddTextControlAtRange()
{
this.Paragraphs[1].Range.InsertParagraphBefore();
textControl2 = this.Controls.AddPlainTextContentControl(this.Paragraphs[1].Range,
"textControl2");
textControl2.PlaceholderText = "Enter your first name";
}
Dim plainTextControl2 As Microsoft.Office.Tools.Word.PlainTextContentControl
Private Sub AddPlainTextControlAtRange()
Me.Paragraphs(1).Range.InsertParagraphBefore()
plainTextControl2 = Me.Controls.AddPlainTextContentControl(Me.Paragraphs(1).Range, "plainTextControl2")
plainTextControl2.PlaceholderText = "Enter your first name"
End Sub
Diese Version bezieht sich auf ein Add-In auf Anwendungsebene, das auf .NET Framework 4 oder .NET Framework 4.5 abzielt. Um diesen Code zu verwenden, fügen Sie ihn in die ThisAddIn -Klasse in Ihrem Projekt ein, und nennen Sie die- AddTextControlAtRange Methode von der- ThisAddIn_Startup Methode.
private Microsoft.Office.Tools.Word.PlainTextContentControl textControl2;
private void AddTextControlAtRange()
{
if (this.Application.ActiveDocument == null)
return;
Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
vstoDoc.Paragraphs[1].Range.InsertParagraphBefore();
textControl2 = vstoDoc.Controls.AddPlainTextContentControl(
vstoDoc.Paragraphs[1].Range,
"textControl2");
textControl2.PlaceholderText = "Enter your first name";
}
Dim plainTextControl2 As Microsoft.Office.Tools.Word.PlainTextContentControl
Private Sub AddPlainTextControlAtRange()
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()
plainTextControl2 = vstoDoc.Controls.AddPlainTextContentControl( _
vstoDoc.Paragraphs(1).Range, "plainTextControl2")
plainTextControl2.PlaceholderText = "Enter your first name"
End Sub
Hinweise
Verwenden Sie diese Methode, um zur Laufzeit einen neuen zu PlainTextContentControl einem angegebenen Bereich im Dokument hinzuzufügen. Weitere Informationen finden Sie unter Adding Controls to Office Documents at Run Time.