ControlCollection.AddRichTextContentControl Метод (ContentControl, String) (2007 System)

Статья
11/16/2008

Обновлен: Июль 2008

Добавляет новый элемент управления RichTextContentControl, основанный на исходном элементе управления содержимым в документе.

Пространство имен: Microsoft.Office.Tools.Word
Сборка: Microsoft.Office.Tools.Word.v9.0 (в Microsoft.Office.Tools.Word.v9.0.dll)

Синтаксис

'Декларация
Public Function AddRichTextContentControl ( _
    contentControl As ContentControl, _
    name As String _
) As RichTextContentControl
'Применение
Dim instance As ControlCollection
Dim contentControl As ContentControl
Dim name As String
Dim returnValue As RichTextContentControl

returnValue = instance.AddRichTextContentControl(contentControl, _
    name)

public RichTextContentControl AddRichTextContentControl(
    ContentControl contentControl,
    string name
)

Параметры

contentControl
Тип: Microsoft.Office.Interop.Word.ContentControl
Элемент управления Microsoft.Office.Interop.Word.ContentControl, служащий основой для нового элемента управления.

name
Тип: System.String
Имя нового элемента управления.

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

Тип: Microsoft.Office.Tools.Word.RichTextContentControl
Элемент управления RichTextContentControl, добавленный в документ.

Исключения

Исключение	Условие
ArgumentNullException	Значение параметра contentControl равно nullссылка null (Nothing в Visual Basic). –или– Параметр name имеет значение nullссылка null (Nothing в Visual Basic) или нулевую длину.
ControlNameAlreadyExistsException	Элемент управления с таким именем уже имеется в данном экземпляре коллекции ControlCollection.
ArgumentException	Параметр contentControl не является коллекцией стандартных блоков (это значит, что свойству Microsoft.Office.Interop.Word.ContentControl.Type объекта contentControl не присвоено значение Microsoft.Office.Interop.Word.WdContentControlType.wdContentControlRichText).

ArgumentNullException

Значение параметра contentControl равно nullссылка null (Nothing в Visual Basic).

–или–

Параметр name имеет значение nullссылка null (Nothing в Visual Basic) или нулевую длину.

ControlNameAlreadyExistsException

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

ArgumentException

Параметр contentControl не является коллекцией стандартных блоков (это значит, что свойству Microsoft.Office.Interop.Word.ContentControl.Type объекта contentControl не присвоено значение Microsoft.Office.Interop.Word.WdContentControlType.wdContentControlRichText).

Заметки

Этот метод используется для добавления во время выполнения нового элемента управления RichTextContentControl, основанного на исходном элементе управления содержимым в документе. Это полезно при создании элемента управления RichTextContentControl во время выполнения, если необходимо повторно создать такой же элемент управления при следующем открытии документа. Дополнительные сведения см. в разделе Добавление элементов управления в документы Office во время выполнения.

Примеры

В приведенном ниже примере кода создается новый элемент управления RichTextContentControl для каждого элемента управления текстом в формате RTF, который изначально присутствовал в документе.

Эта версия предназначена для настройки уровня документа. Чтобы воспользоваться этим кодом, вставьте его в проекте в класс ThisDocument и вызовите из метода ThisDocument_Startup метод CreateRichTextControlsFromNativeControls.

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

Private Sub CreateRichTextControlsFromNativeControls()
    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.wdContentControlRichText Then
            count += 1
            Dim tempControl As Microsoft.Office.Tools.Word.RichTextContentControl = _
                Me.Controls.AddRichTextContentControl(nativeControl, _
                "VSTORichTextContentControl" + count.ToString())
            richTextControls.Add(tempControl)
        End If
    Next nativeControl
End Sub

private System.Collections.Generic.List
    <Microsoft.Office.Tools.Word.RichTextContentControl> richTextControls;

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

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

    foreach (Word.ContentControl nativeControl in this.ContentControls)
    {
        if (nativeControl.Type ==
            Microsoft.Office.Interop.Word.WdContentControlType.wdContentControlRichText)
        {
            count++;
            Microsoft.Office.Tools.Word.RichTextContentControl tempControl =
                this.Controls.AddRichTextContentControl(nativeControl,
                "VSTORichTextControl" + count.ToString());
            richTextControls.Add(tempControl);
        }
    }
}

Эта версия предназначена для надстройки уровня приложения. Чтобы воспользоваться этим кодом, вставьте его в проекте в класс ThisAddIn и вызовите из метода ThisAddIn_Startup метод CreateRichTextControlsFromNativeControls.

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

Private Sub CreateRichTextControlsFromNativeControls()
    If Me.Application.ActiveDocument Is Nothing Then
        Return
    End If

    Dim vstoDoc As Document = Me.Application.ActiveDocument.GetVstoObject()
    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.wdContentControlRichText Then
            count += 1
            Dim tempControl As Microsoft.Office.Tools.Word.RichTextContentControl = _
                vstoDoc.Controls.AddRichTextContentControl(nativeControl, _
                "VSTORichTextContentControl" + count.ToString())
            richTextControls.Add(tempControl)
        End If
    Next nativeControl
End Sub

private System.Collections.Generic.List
    <Microsoft.Office.Tools.Word.RichTextContentControl> richTextControls;

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

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

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

    foreach (Word.ContentControl nativeControl in vstoDoc.ContentControls)
    {
        if (nativeControl.Type ==
            Microsoft.Office.Interop.Word.WdContentControlType.wdContentControlRichText)
        {
            count++;
            Microsoft.Office.Tools.Word.RichTextContentControl tempControl =
                vstoDoc.Controls.AddRichTextContentControl(nativeControl,
                "VSTORichTextControl" + count.ToString());
            richTextControls.Add(tempControl);
        }
    }
}

В приведенном ниже примере кода создается новый элемент управления RichTextContentControl для каждого элемента управления текстом в формате RTF, добавляемого пользователем в документ.

Эта версия предназначена для настройки уровня документа. Чтобы воспользоваться этим кодом, вставьте его в проекте в класс ThisDocument. В C# также необходимо присоединить обработчик событий ThisDocument_RichTextContentControlAfterAdd к событию ContentControlAfterAdd класса ThisDocument.

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

    If NewContentControl.Type = Word.WdContentControlType.wdContentControlRichText Then
        Me.Controls.AddRichTextContentControl(NewContentControl, _
            "RichTextControl" + NewContentControl.ID)
    End If
End Sub

void ThisDocument_RichTextContentControlAfterAdd(Word.ContentControl NewContentControl, bool InUndoRedo)
{
    if (NewContentControl.Type == Word.WdContentControlType.wdContentControlRichText)
    {
        this.Controls.AddRichTextContentControl(NewContentControl,
            "RichTextControl" + NewContentControl.ID);
    }
}

Эта версия предназначена для надстройки уровня приложения. Чтобы воспользоваться этим кодом, вставьте его в проекте в класс ThisAddIn. Кроме того, необходимо присоединить обработчик событий ActiveDocument_RichTextContentControlAfterAdd к событию ContentControlAfterAdd активного документа.

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

    Dim vstoDoc As Document = Me.Application.ActiveDocument.GetVstoObject()
    If NewContentControl.Type = Word.WdContentControlType. _
        wdContentControlRichText Then
        vstoDoc.Controls.AddRichTextContentControl(NewContentControl, _
            "RichTextControl" + NewContentControl.ID)
    End If
End Sub

void ActiveDocument_RichTextContentControlAfterAdd(
    Word.ContentControl NewContentControl, bool InUndoRedo)
{            
    Document vstoDoc = this.Application.ActiveDocument.GetVstoObject();
    if (NewContentControl.Type == Word.WdContentControlType.wdContentControlRichText)
    {
        vstoDoc.Controls.AddRichTextContentControl(NewContentControl,
            "RichTextControl" + NewContentControl.ID);
    }
}

Разрешения

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Использование библиотек из не вполне надежного кода.

См. также

Ссылки

ControlCollection Класс

ControlCollection - члены

AddRichTextContentControl - перегрузка

Microsoft.Office.Tools.Word - пространство имен

Другие ресурсы

Добавление элементов управления в документы Office во время выполнения

Вспомогательные методы для элементов управления ведущего приложения

Практическое руководство. Добавление элементов управления содержимым в документы Word

Журнал изменений

Дата	Журнал событий	Причина
Июль 2008	Добавлены версии примеров кода для надстройки уровня приложения.	Изменение функции SP1.

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