ControlCollection.AddPlainTextContentControl Метод

Ссылка

Определение

Пространство имен:: Microsoft.Office.Tools.Word

Сборки:: Microsoft.Office.Tools.Word.dll, Microsoft.Office.Tools.Word.v4.0.Utilities.dll

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Перегрузки

AddPlainTextContentControl(String)	Добавляет новый элемент управления PlainTextContentControl в выделенном фрагменте документа.
AddPlainTextContentControl(ContentControl, String)	Добавляет новый объект PlainTextContentControl, основанный на собственном элементе управления содержимым, в документ.
AddPlainTextContentControl(Range, String)	Добавляет новый объект PlainTextContentControl в указанный диапазон в документе.

AddPlainTextContentControl(String)

Добавляет новый элемент управления PlainTextContentControl в выделенном фрагменте документа.

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

Параметры

name: String

Имя нового элемента управления.

Возвращаемое значение

PlainTextContentControl

Объект PlainTextContentControl, добавленный в документ.

Исключения

ArgumentNullException

name имеет значение null или нулевую длину.

ControlNameAlreadyExistsException

Элемент управления с таким именем уже содержится в 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, 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

Параметры

contentControl: ContentControl

Объект ContentControl, который является основой для нового элемента управления.

name: String

Имя нового элемента управления.

Возвращаемое значение

PlainTextContentControl

Объект PlainTextContentControl, добавленный в документ.

Исключения

ArgumentNullException

contentControl имеет nullзначение .-or- name is null или имеет нулевую длину.

ControlNameAlreadyExistsException

Элемент управления с таким именем уже содержится в ControlCollection.

ArgumentException

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 обработчик событий к событию ContentControlAfterAddThisDocument класса .

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, 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

Параметры

range: Range

Объект Range, предоставляющий границы для нового элемента управления.

name: String

Имя нового элемента управления.

Возвращаемое значение

PlainTextContentControl

Объект PlainTextContentControl, добавленный в документ.

Исключения

ArgumentNullException

name имеет значение null или нулевую длину.

ControlNameAlreadyExistsException

Элемент управления с таким именем уже содержится в 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.

Применяется к

Поделиться через

ControlCollection.AddPlainTextContentControl Метод

Определение

Перегрузки

AddPlainTextContentControl(String)

Параметры

Возвращаемое значение

Исключения

Примеры

Комментарии

Применяется к

AddPlainTextContentControl(ContentControl, String)

Параметры

Возвращаемое значение

Исключения

Примеры

Комментарии

Применяется к

AddPlainTextContentControl(Range, String)

Параметры

Возвращаемое значение

Исключения

Примеры

Комментарии

Применяется к

Дополнительные ресурсы