ControlCollection.AddGroupContentControl Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Sobrecargas
AddGroupContentControl(String) |
Adiciona um novo GroupContentControl na seleção atual no documento. |
AddGroupContentControl(ContentControl, String) |
Adiciona um novo GroupContentControl que se baseia em um controle de conteúdo nativo no documento. |
AddGroupContentControl(Range, String) |
Adiciona um novo GroupContentControl no intervalo especificado no documento. |
AddGroupContentControl(String)
Adiciona um novo GroupContentControl na seleção atual no documento.
public:
Microsoft::Office::Tools::Word::GroupContentControl ^ AddGroupContentControl(System::String ^ name);
public Microsoft.Office.Tools.Word.GroupContentControl AddGroupContentControl (string name);
abstract member AddGroupContentControl : string -> Microsoft.Office.Tools.Word.GroupContentControl
Public Function AddGroupContentControl (name As String) As GroupContentControl
Parâmetros
- name
- String
O nome do novo controle.
Retornos
O GroupContentControl adicionado ao documento.
Exceções
name
é null
ou tem tamanho zero.
Um controle com o mesmo nome já está no ControlCollection.
Exemplos
O exemplo de código a seguir adiciona um novo parágrafo ao início do documento e cria um novo GroupContentControl que contém este parágrafo. O GroupContentControl impede que os usuários editem o texto no parágrafo. Para obter mais informações sobre como usar um GroupContentControl para proteger uma parte de um documento, consulte Controles de Conteúdo.
Esta versão destina-se a uma personalização no nível de documento. Para usar esse código, cole-o na classe ThisDocument
do projeto e chame o método AddGroupControlAtSelection
no método ThisDocument_Startup
.
private Microsoft.Office.Tools.Word.GroupContentControl groupControl1;
private void AddGroupControlAtSelection()
{
this.Paragraphs[1].Range.InsertParagraphBefore();
Word.Range range1 = this.Paragraphs[1].Range;
range1.Text = "You cannot edit or change the formatting of text " +
"in this paragraph, because this paragraph is in a GroupContentControl.";
range1.Select();
groupControl1 = this.Controls.AddGroupContentControl("groupControl1");
}
Dim groupControl1 As Microsoft.Office.Tools.Word.GroupContentControl
Private Sub AddGroupControlAtSelection()
Me.Paragraphs(1).Range.InsertParagraphBefore()
Me.Paragraphs(1).Range.Text = "You cannot edit or change the formatting of text " & _
"in this paragraph, because this paragraph is in a GroupContentControl."
Me.Paragraphs(1).Range.Select()
groupControl1 = Me.Controls.AddGroupContentControl("groupControl1")
End Sub
Esta versão é para um suplemento no nível do aplicativo que tem como destino o .NET Framework 4 ou o .NET Framework 4.5. Para usar esse código, cole-o na classe ThisAddIn
do projeto e chame o método AddGroupControlAtSelection
no método ThisAddIn_Startup
.
private Microsoft.Office.Tools.Word.GroupContentControl groupControl1;
private void AddGroupControlAtSelection()
{
if (this.Application.ActiveDocument == null)
return;
Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
vstoDoc.Paragraphs[1].Range.InsertParagraphBefore();
Word.Range range1 = vstoDoc.Paragraphs[1].Range;
range1.Text = "You cannot edit or change the formatting of text " +
"in this paragraph, because this paragraph is in a GroupContentControl.";
range1.Select();
groupControl1 = vstoDoc.Controls.AddGroupContentControl("groupControl1");
}
Dim groupControl1 As Microsoft.Office.Tools.Word.GroupContentControl
Private Sub AddGroupControlAtSelection()
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.Text = "You cannot edit or change the formatting of text " & _
"in this paragraph, because this paragraph is in a GroupContentControl."
vstoDoc.Paragraphs(1).Range.Select()
groupControl1 = vstoDoc.Controls.AddGroupContentControl("groupControl1")
End Sub
Comentários
Use esse método para adicionar um novo GroupContentControl na seleção atual no documento em tempo de execução. Para obter mais informações, consulte Adicionando controles a documentos do Office em tempo de execução.
Aplica-se a
AddGroupContentControl(ContentControl, String)
Adiciona um novo GroupContentControl que se baseia em um controle de conteúdo nativo no documento.
public:
Microsoft::Office::Tools::Word::GroupContentControl ^ AddGroupContentControl(Microsoft::Office::Interop::Word::ContentControl ^ contentControl, System::String ^ name);
public Microsoft.Office.Tools.Word.GroupContentControl AddGroupContentControl (Microsoft.Office.Interop.Word.ContentControl contentControl, string name);
abstract member AddGroupContentControl : Microsoft.Office.Interop.Word.ContentControl * string -> Microsoft.Office.Tools.Word.GroupContentControl
Public Function AddGroupContentControl (contentControl As ContentControl, name As String) As GroupContentControl
Parâmetros
- contentControl
- ContentControl
O ContentControl que é a base do novo controle.
- name
- String
O nome do novo controle.
Retornos
O GroupContentControl adicionado ao documento.
Exceções
contentControl
é null
.-ou- name
é null
ou tem comprimento zero.
Um controle com o mesmo nome já está no ControlCollection.
contentControl
não é uma galeria de blocos de construção (ou seja, a Type propriedade de contentControl
não tem o valor Microsoft.Office.Interop.Word. WdContentControlType.wdContentControlGroup).
Exemplos
O exemplo de código a seguir cria um novo GroupContentControl para cada controle de grupo nativo que está no documento.
Esta versão destina-se a uma personalização no nível de documento. Para usar esse código, cole-o na classe ThisDocument
do projeto e chame o método CreateGroupControlsFromNativeControls
no método ThisDocument_Startup
.
private System.Collections.Generic.List
<Microsoft.Office.Tools.Word.GroupContentControl> groupControls;
private void CreateGroupControlsFromNativeControls()
{
if (this.ContentControls.Count <= 0)
return;
groupControls = new System.Collections.Generic.List
<Microsoft.Office.Tools.Word.GroupContentControl>();
int count = 0;
foreach (Word.ContentControl nativeControl in this.ContentControls)
{
if (nativeControl.Type == Word.WdContentControlType.wdContentControlGroup)
{
count++;
Microsoft.Office.Tools.Word.GroupContentControl tempControl =
this.Controls.AddGroupContentControl(nativeControl,
"VSTOGroupControl" + count.ToString());
groupControls.Add(tempControl);
}
}
}
Private groupControls As New System.Collections.Generic.List _
(Of Microsoft.Office.Tools.Word.GroupContentControl)
Private Sub CreateGroupControlsFromNativeControls()
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.wdContentControlGroup Then
count += 1
Dim tempControl As Microsoft.Office.Tools.Word.GroupContentControl = _
Me.Controls.AddGroupContentControl(nativeControl, _
"VSTOGroupContentControl" + count.ToString())
groupControls.Add(tempControl)
End If
Next nativeControl
End Sub
Esta versão é para um suplemento no nível do aplicativo que tem como destino o .NET Framework 4 ou o .NET Framework 4.5. Para usar esse código, cole-o na classe ThisAddIn
do projeto e chame o método CreateGroupControlsFromNativeControls
no método ThisAddIn_Startup
.
private System.Collections.Generic.List
<Microsoft.Office.Tools.Word.GroupContentControl> groupControls;
private void CreateGroupControlsFromNativeControls()
{
if (this.Application.ActiveDocument == null)
return;
Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
if (vstoDoc.ContentControls.Count <= 0)
return;
groupControls = new System.Collections.Generic.List
<Microsoft.Office.Tools.Word.GroupContentControl>();
int count = 0;
foreach (Word.ContentControl nativeControl in vstoDoc.ContentControls)
{
if (nativeControl.Type == Word.WdContentControlType.wdContentControlGroup)
{
count++;
Microsoft.Office.Tools.Word.GroupContentControl tempControl =
vstoDoc.Controls.AddGroupContentControl(nativeControl,
"VSTOGroupControl" + count.ToString());
groupControls.Add(tempControl);
}
}
}
Private groupControls As New System.Collections.Generic.List _
(Of Microsoft.Office.Tools.Word.GroupContentControl)
Private Sub CreateGroupControlsFromNativeControls()
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.wdContentControlGroup Then
count += 1
Dim tempControl As Microsoft.Office.Tools.Word.GroupContentControl = _
vstoDoc.Controls.AddGroupContentControl(nativeControl, _
"VSTOGroupContentControl" + count.ToString())
groupControls.Add(tempControl)
End If
Next nativeControl
End Sub
O exemplo de código a seguir cria um novo GroupContentControl para cada controle de grupo nativo que o usuário adiciona ao documento.
Esta versão destina-se a uma personalização no nível de documento. Para usar esse código, cole-o na classe ThisDocument
do projeto. Para C#, você também deve anexar o ThisDocument_GroupContentControlAfterAdd
manipulador de eventos ao ContentControlAfterAdd evento da ThisDocument
classe .
void ThisDocument_GroupContentControlAfterAdd(Word.ContentControl NewContentControl, bool InUndoRedo)
{
if (NewContentControl.Type == Word.WdContentControlType.wdContentControlGroup)
{
this.Controls.AddGroupContentControl(NewContentControl,
"GroupControl" + NewContentControl.ID);
}
}
Private Sub ThisDocument_GroupContentControlAfterAdd(ByVal NewContentControl As Word.ContentControl, _
ByVal InUndoRedo As Boolean) Handles Me.ContentControlAfterAdd
If NewContentControl.Type = Word.WdContentControlType.wdContentControlGroup Then
Me.Controls.AddGroupContentControl(NewContentControl, _
"GroupControl" + NewContentControl.ID)
End If
End Sub
Esta versão é para um suplemento no nível do aplicativo que tem como destino o .NET Framework 4 ou o .NET Framework 4.5. Para usar esse código, cole-o na classe ThisAddIn
do projeto. Além disso, você deve anexar o ActiveDocument_GroupContentControlAfterAdd
manipulador de eventos ao ContentControlAfterAdd evento do documento ativo.
void ActiveDocument_GroupContentControlAfterAdd(
Word.ContentControl NewContentControl, bool InUndoRedo)
{
Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
if (NewContentControl.Type == Word.WdContentControlType.wdContentControlGroup)
{
vstoDoc.Controls.AddGroupContentControl(NewContentControl,
"GroupControl" + NewContentControl.ID);
}
}
Private Sub ActiveDocument_GroupContentControlAfterAdd( _
ByVal NewContentControl As Word.ContentControl, _
ByVal InUndoRedo As Boolean)
Dim vstoDoc As Document = Globals.Factory.GetVstoObject(Me.Application.ActiveDocument)
If NewContentControl.Type = Word.WdContentControlType. _
wdContentControlGroup Then
vstoDoc.Controls.AddGroupContentControl(NewContentControl, _
"GroupControl" + NewContentControl.ID)
End If
End Sub
Comentários
Use esse método para adicionar um novo GroupContentControl baseado em um controle de conteúdo nativo no documento em tempo de execução. Isso é útil quando você cria um GroupContentControl em tempo de execução e deseja recriar o mesmo controle na próxima vez que o documento for aberto. Para obter mais informações, consulte Adicionando controles a documentos do Office em tempo de execução.
Aplica-se a
AddGroupContentControl(Range, String)
Adiciona um novo GroupContentControl no intervalo especificado no documento.
public:
Microsoft::Office::Tools::Word::GroupContentControl ^ AddGroupContentControl(Microsoft::Office::Interop::Word::Range ^ range, System::String ^ name);
public Microsoft.Office.Tools.Word.GroupContentControl AddGroupContentControl (Microsoft.Office.Interop.Word.Range range, string name);
abstract member AddGroupContentControl : Microsoft.Office.Interop.Word.Range * string -> Microsoft.Office.Tools.Word.GroupContentControl
Public Function AddGroupContentControl (range As Range, name As String) As GroupContentControl
Parâmetros
- name
- String
O nome do novo controle.
Retornos
O GroupContentControl adicionado ao documento.
Exceções
name
é null
ou tem tamanho zero.
Um controle com o mesmo nome já está no ControlCollection.
Exemplos
O exemplo de código a seguir adiciona um novo parágrafo ao início do documento e cria um GroupContentControl que contém esse parágrafo. O GroupContentControl impede que os usuários editem o texto no parágrafo. Para obter mais informações sobre como usar um GroupContentControl para proteger uma parte de um documento, consulte Controles de Conteúdo.
Esta versão destina-se a uma personalização no nível de documento. Para usar esse código, cole-o na classe ThisDocument
do projeto e chame o método AddGroupControlAtRange
no método ThisDocument_Startup
.
private Microsoft.Office.Tools.Word.GroupContentControl groupControl2;
private void AddGroupControlAtRange()
{
this.Paragraphs[1].Range.InsertParagraphBefore();
Word.Range range1 = this.Paragraphs[1].Range;
range1.Text = "You cannot edit or change the formatting of text " +
"in this paragraph, because this paragraph is in a GroupContentControl.";
range1.Select();
groupControl2 = this.Controls.AddGroupContentControl(range1, "groupControl2");
}
Dim groupControl2 As Microsoft.Office.Tools.Word.GroupContentControl
Private Sub AddGroupControlAtRange()
Me.Paragraphs(1).Range.InsertParagraphBefore()
Dim range1 As Word.Range = Me.Paragraphs(1).Range
range1.Text = "You cannot edit or change the formatting of text " & _
"in this paragraph, because this paragraph is in a GroupContentControl."
range1.Select()
groupControl2 = Me.Controls.AddGroupContentControl(range1, "groupControl2")
End Sub
Esta versão é para um suplemento no nível do aplicativo que tem como destino o .NET Framework 4 ou o .NET Framework 4.5. Para usar esse código, cole-o na classe ThisAddIn
do projeto e chame o método AddGroupControlAtRange
no método ThisAddIn_Startup
.
private Microsoft.Office.Tools.Word.GroupContentControl groupControl2;
private void AddGroupControlAtRange()
{
if (this.Application.ActiveDocument == null)
return;
Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
vstoDoc.Paragraphs[1].Range.InsertParagraphBefore();
Word.Range range1 = vstoDoc.Paragraphs[1].Range;
range1.Text = "You cannot edit or change the formatting of text " +
"in this paragraph, because this paragraph is in a GroupContentControl.";
range1.Select();
groupControl2 = vstoDoc.Controls.AddGroupContentControl(range1, "groupControl2");
}
Dim groupControl2 As Microsoft.Office.Tools.Word.GroupContentControl
Private Sub AddGroupControlAtRange()
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()
Dim range1 As Word.Range = vstoDoc.Paragraphs(1).Range
range1.Text = "You cannot edit or change the formatting of text " & _
"in this paragraph, because this paragraph is in a GroupContentControl."
range1.Select()
groupControl2 = vstoDoc.Controls.AddGroupContentControl(range1, "groupControl2")
End Sub
Comentários
Use esse método para adicionar um novo GroupContentControl em um intervalo especificado no documento em tempo de execução. Para obter mais informações, consulte Adicionando controles a documentos do Office em tempo de execução.