ControlCollection.AddPlainTextContentControl Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Перегрузки
| AddPlainTextContentControl(String) |
Добавляет новый элемент управления PlainTextContentControl в выделенном фрагменте документа. |
| AddPlainTextContentControl(ContentControl, String) |
Добавляет новый объект PlainTextContentControl, основанный на собственном элементе управления содержимым, в документ. |
| AddPlainTextContentControl(Range, String) |
Добавляет новый объект PlainTextContentControl в указанный диапазон в документе. |
AddPlainTextContentControl(String)
Добавляет новый элемент управления PlainTextContentControl в выделенном фрагменте документа.
public Microsoft.Office.Tools.Word.PlainTextContentControl AddPlainTextContentControl (string name);
Параметры
- name
- String
Имя нового элемента управления.
Возвращаемое значение
Объект PlainTextContentControl, добавленный в документ.
Исключения
name имеет значение null или нулевую длину.
Элемент управления с таким именем уже содержится в ControlCollection.
Примеры
В следующем примере кода в начало документа добавляется новый PlainTextContentControl .
Эта версия предназначена для настройки на уровне документа. Чтобы использовать этот код, вставьте его в ThisDocument класс в проекте и вызовите AddTextControlAtSelection метод из ThisDocument_Startup метода.
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
Эта версия предназначена для надстройки уровня приложения, предназначенной для платформы .NET Framework 4 или .NET Framework 4.5. Чтобы использовать этот код, вставьте его в ThisAddIn класс в проекте и вызовите AddTextControlAtSelection метод из ThisAddIn_Startup метода.
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
Комментарии
Этот метод используется для добавления нового объекта в PlainTextContentControl текущее выделение в документе во время выполнения. Для получения дополнительной информации см. Adding Controls to Office Documents at Run Time.
Применяется к
AddPlainTextContentControl(ContentControl, String)
Добавляет новый объект PlainTextContentControl, основанный на собственном элементе управления содержимым, в документ.
public Microsoft.Office.Tools.Word.PlainTextContentControl AddPlainTextContentControl (Microsoft.Office.Interop.Word.ContentControl contentControl, string name);
Параметры
- contentControl
- ContentControl
Объект ContentControl, который является основой для нового элемента управления.
- name
- String
Имя нового элемента управления.
Возвращаемое значение
Объект PlainTextContentControl, добавленный в документ.
Исключения
contentControl имеет значение null.
-или-
name имеет значение null или нулевую длину.
Элемент управления с таким именем уже содержится в ControlCollection.
contentControl не является коллекцией стандартных блоков (то есть свойство Type объекта contentControl не имеет значения Microsoft.Office.Interop.Word.WdContentControlType.wdContentControlText).
Примеры
В следующем примере кода создается новый объект PlainTextContentControl для каждого встроенного элемента управления обычным текстом, который находится в документе.
Эта версия предназначена для настройки на уровне документа. Чтобы использовать этот код, вставьте его в ThisDocument класс в проекте и вызовите CreateTextControlsFromNativeControls метод из ThisDocument_Startup метода.
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
Эта версия предназначена для надстройки уровня приложения, предназначенной для платформы .NET Framework 4 или .NET Framework 4.5. Чтобы использовать этот код, вставьте его в ThisAddIn класс в проекте и вызовите CreateTextControlsFromNativeControls метод из ThisAddIn_Startup метода.
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
В следующем примере кода создается новый объект PlainTextContentControl для каждого встроенного элемента управления обычным текстом, который пользователь добавляет в документ.
Эта версия предназначена для настройки на уровне документа. Чтобы использовать этот код, вставьте его в ThisDocument класс проекта. Для C# необходимо также присоединить ThisDocument_PlainTextContentControlAfterAdd обработчик событий к ContentControlAfterAdd событию ThisDocument класса.
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
Эта версия предназначена для надстройки уровня приложения, предназначенной для платформы .NET Framework 4 или .NET Framework 4.5. Чтобы использовать этот код, вставьте его в ThisAddIn класс проекта. Кроме того, необходимо присоединить ActiveDocument_PlainTextContentControlAfterAdd обработчик событий к ContentControlAfterAdd событию активного документа.
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
Комментарии
Используйте этот метод, чтобы добавить новый объект PlainTextContentControl , основанный на собственном элементе управления содержимым в документе во время выполнения. Это полезно, когда вы создаете PlainTextContentControl во время выполнения и хотите повторно создать тот же элемент управления при следующем открытии документа. Для получения дополнительной информации см. Adding Controls to Office Documents at Run Time.
Применяется к
AddPlainTextContentControl(Range, String)
Добавляет новый объект PlainTextContentControl в указанный диапазон в документе.
public Microsoft.Office.Tools.Word.PlainTextContentControl AddPlainTextContentControl (Microsoft.Office.Interop.Word.Range range, string name);
Параметры
- name
- String
Имя нового элемента управления.
Возвращаемое значение
Объект PlainTextContentControl, добавленный в документ.
Исключения
name имеет значение null или нулевую длину.
Элемент управления с таким именем уже содержится в ControlCollection.
Примеры
В следующем примере кода в начало документа добавляется новый PlainTextContentControl .
Эта версия предназначена для настройки на уровне документа. Чтобы использовать этот код, вставьте его в ThisDocument класс в проекте и вызовите AddTextControlAtRange метод из ThisDocument_Startup метода.
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
Эта версия предназначена для надстройки уровня приложения, предназначенной для платформы .NET Framework 4 или .NET Framework 4.5. Чтобы использовать этот код, вставьте его в ThisAddIn класс в проекте и вызовите AddTextControlAtRange метод из ThisAddIn_Startup метода.
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
Комментарии
Этот метод используется для добавления нового элемента PlainTextContentControl в указанный диапазон документа во время выполнения. Для получения дополнительной информации см. Adding Controls to Office Documents at Run Time.