ControlCollection.AddPlainTextContentControl Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Sobrecargas
AddPlainTextContentControl(String) |
Agrega un nuevo objeto PlainTextContentControl en la selección actual del documento. |
AddPlainTextContentControl(ContentControl, String) |
Agrega un nuevo objeto PlainTextContentControl basado en un control de contenido nativo del documento. |
AddPlainTextContentControl(Range, String) |
Agrega un nuevo objeto PlainTextContentControl en el intervalo especificado en el documento. |
AddPlainTextContentControl(String)
Agrega un nuevo objeto PlainTextContentControl en la selección actual del documento.
public:
Microsoft::Office::Tools::Word::PlainTextContentControl ^ AddPlainTextContentControl(System::String ^ name);
public Microsoft.Office.Tools.Word.PlainTextContentControl AddPlainTextContentControl(string name);
abstract member AddPlainTextContentControl : string -> Microsoft.Office.Tools.Word.PlainTextContentControl
Public Function AddPlainTextContentControl (name As String) As PlainTextContentControl
Parámetros
- name
- String
El nombre del nuevo control.
Devoluciones
El objeto PlainTextContentControl que se agregó al documento.
Excepciones
name
es null
o tiene una longitud cero.
Un control con el mismo nombre ya se encuentra en el objeto ControlCollection.
Ejemplos
En el ejemplo de código siguiente se agrega un nuevo PlainTextContentControl al principio del documento.
Esta versión es para una personalización de nivel de documento. Para usar este código, péguelo en la ThisDocument
clase del proyecto y llame al AddTextControlAtSelection
método desde el ThisDocument_Startup
método .
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
Esta versión es para un complemento de nivel de aplicación que tiene como destino .NET Framework 4 o .NET Framework 4.5. Para usar este código, péguelo en la ThisAddIn
clase del proyecto y llame al AddTextControlAtSelection
método desde el ThisAddIn_Startup
método .
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
Comentarios
Use este método para agregar un nuevo PlainTextContentControl en la selección actual del documento en tiempo de ejecución. Para obtener más información, consulta Adding Controls to Office Documents at Run Time.
Se aplica a
AddPlainTextContentControl(ContentControl, String)
Agrega un nuevo objeto PlainTextContentControl basado en un control de contenido nativo del documento.
public:
Microsoft::Office::Tools::Word::PlainTextContentControl ^ AddPlainTextContentControl(Microsoft::Office::Interop::Word::ContentControl ^ contentControl, System::String ^ name);
public Microsoft.Office.Tools.Word.PlainTextContentControl AddPlainTextContentControl(Microsoft.Office.Interop.Word.ContentControl contentControl, string name);
abstract member AddPlainTextContentControl : Microsoft.Office.Interop.Word.ContentControl * string -> Microsoft.Office.Tools.Word.PlainTextContentControl
Public Function AddPlainTextContentControl (contentControl As ContentControl, name As String) As PlainTextContentControl
Parámetros
- contentControl
- ContentControl
El objeto ContentControl que es la base del nuevo control.
- name
- String
El nombre del nuevo control.
Devoluciones
El objeto PlainTextContentControl que se agregó al documento.
Excepciones
contentControl
es null
.-o- name
es null
o tiene una longitud cero.
Un control con el mismo nombre ya se encuentra en el objeto ControlCollection.
contentControl
no es una galería de bloques de creación (es decir, la Type propiedad de contentControl
no tiene el valor Microsoft.Office.Interop.Word. WdContentControlType.wdContentControlText).
Ejemplos
En el ejemplo de código siguiente se crea un nuevo PlainTextContentControl para cada control de texto sin formato nativo que se encuentra en el documento.
Esta versión es para una personalización de nivel de documento. Para usar este código, péguelo en la ThisDocument
clase del proyecto y llame al CreateTextControlsFromNativeControls
método desde el ThisDocument_Startup
método .
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
Esta versión es para un complemento de nivel de aplicación que tiene como destino .NET Framework 4 o .NET Framework 4.5. Para usar este código, péguelo en la ThisAddIn
clase del proyecto y llame al CreateTextControlsFromNativeControls
método desde el ThisAddIn_Startup
método .
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
En el ejemplo de código siguiente se crea un nuevo PlainTextContentControl para cada control de texto sin formato nativo que el usuario agrega al documento.
Esta versión es para una personalización de nivel de documento. Para usar este código, péguelo en la ThisDocument
clase del proyecto. Para C#, también debe adjuntar el ThisDocument_PlainTextContentControlAfterAdd
controlador de eventos al ContentControlAfterAdd evento de la ThisDocument
clase .
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
Esta versión es para un complemento de nivel de aplicación que tiene como destino .NET Framework 4 o .NET Framework 4.5. Para usar este código, péguelo en la ThisAddIn
clase del proyecto. Además, debe adjuntar el ActiveDocument_PlainTextContentControlAfterAdd
controlador de eventos al ContentControlAfterAdd evento del documento activo.
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
Comentarios
Utilice este método para agregar un nuevo PlainTextContentControl elemento basado en un control de contenido nativo en el documento en tiempo de ejecución. Esto resulta útil al crear un objeto PlainTextContentControl en tiempo de ejecución y desea volver a crear el mismo control la próxima vez que se abra el documento. Para obtener más información, consulta Adding Controls to Office Documents at Run Time.
Se aplica a
AddPlainTextContentControl(Range, String)
Agrega un nuevo objeto PlainTextContentControl en el intervalo especificado en el documento.
public:
Microsoft::Office::Tools::Word::PlainTextContentControl ^ AddPlainTextContentControl(Microsoft::Office::Interop::Word::Range ^ range, System::String ^ name);
public Microsoft.Office.Tools.Word.PlainTextContentControl AddPlainTextContentControl(Microsoft.Office.Interop.Word.Range range, string name);
abstract member AddPlainTextContentControl : Microsoft.Office.Interop.Word.Range * string -> Microsoft.Office.Tools.Word.PlainTextContentControl
Public Function AddPlainTextContentControl (range As Range, name As String) As PlainTextContentControl
Parámetros
- name
- String
El nombre del nuevo control.
Devoluciones
El objeto PlainTextContentControl que se agregó al documento.
Excepciones
name
es null
o tiene una longitud cero.
Un control con el mismo nombre ya se encuentra en el objeto ControlCollection.
Ejemplos
En el ejemplo de código siguiente se agrega un nuevo PlainTextContentControl al principio del documento.
Esta versión es para una personalización de nivel de documento. Para usar este código, péguelo en la ThisDocument
clase del proyecto y llame al AddTextControlAtRange
método desde el ThisDocument_Startup
método .
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
Esta versión es para un complemento de nivel de aplicación que tiene como destino .NET Framework 4 o .NET Framework 4.5. Para usar este código, péguelo en la ThisAddIn
clase del proyecto y llame al AddTextControlAtRange
método desde el ThisAddIn_Startup
método .
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
Comentarios
Use este método para agregar un nuevo PlainTextContentControl en un intervalo especificado en el documento en tiempo de ejecución. Para obtener más información, consulta Adding Controls to Office Documents at Run Time.