Partager via


GroupContentControl, interface

Représente une région protégée d'un document que les utilisateurs ne peuvent pas modifier ou supprimer.

Espace de noms :  Microsoft.Office.Tools.Word
Assembly :  Microsoft.Office.Tools.Word (dans Microsoft.Office.Tools.Word.dll)

Syntaxe

'Déclaration
<GuidAttribute("1fc77d35-6978-4dbc-a615-9ed8a8f728f5")> _
Public Interface GroupContentControl _
    Inherits ContentControlBase, IBindableComponent, IComponent, IDisposable,  _
    ISupportInitialize
[GuidAttribute("1fc77d35-6978-4dbc-a615-9ed8a8f728f5")]
public interface GroupContentControl : ContentControlBase, 
    IBindableComponent, IComponent, IDisposable, ISupportInitialize

Le type GroupContentControl expose les membres suivants.

Propriétés

  Nom Description
Propriété publique Application Obtient une Microsoft.Office.Interop.Word.Application qui représente l'instance actuelle de Microsoft Office Word.
Propriété publique BindingContext Obtient ou définit la collection de gestionnaires de devise pour IBindableComponent. (Hérité de IBindableComponent.)
Propriété publique Container Infrastructure. (Hérité de ContentControlBase.)
Propriété publique ContainerComponent Infrastructure. (Hérité de ContentControlBase.)
Propriété publique Creator Obtient un entier 32 bits qui indique l'application dans laquelle le GroupContentControl a été créé.
Propriété publique DataBindings Obtient la collection d'objets de liaison de données pour ce IBindableComponent. (Hérité de IBindableComponent.)
Propriété publique DefaultDataSourceUpdateMode Obtient ou définit la valeur DataSourceUpdateMode par défaut de ContentControlBase. (Hérité de ContentControlBase.)
Propriété publique ID Obtient un nombre unique qui identifie le contrôle de contenu. (Hérité de ContentControlBase.)
Propriété publique InnerObject Obtient l'objet Microsoft.Office.Interop.Word.ContentControl sous-jacent de Microsoft.Office.Tools.Word.ContentControlBase. (Hérité de ContentControlBase.)
Propriété publique LockContentControl Obtient ou définit une valeur qui spécifie si le GroupContentControl peut être supprimé du document.
Propriété publique Parent Définit le parent du GroupContentControl.
Propriété publique ParentContentControl Obtient le contrôle de contenu parent d'un GroupContentControl imbriqué dans un autre contrôle de contenu.
Propriété publique Range Obtient une Range qui représente le contenu du GroupContentControl.
Propriété publique Site Obtient ou définit le ISite associé à IComponent. (Hérité de IComponent.)
Propriété publique Tag Obtient ou définit une chaîne à associer au GroupContentControl.
Propriété publique Text Obtient le texte dans le GroupContentControl.
Propriété publique Title Obtient ou définit le titre de la GroupContentControl.

Début

Méthodes

  Nom Description
Méthode publique BeginInit Signale à l'objet que l'initialisation démarre. (Hérité de ISupportInitialize.)
Méthode publique Copy Copie le GroupContentControl du document vers le Presse-papiers.
Méthode publique Cut Supprime le GroupContentControl du document et l'ajoute au Presse-papiers.
Méthode publique Delete Supprime un contrôle de contenu créé dynamiquement du document et le retire de ControlCollection dans le document. (Hérité de ContentControlBase.)
Méthode publique Dispose Exécute les tâches définies par l'application associées à la libération ou à la redéfinition des ressources non managées. (Hérité de IDisposable.)
Méthode publique EndInit Signale à l'objet que l'initialisation est terminée. (Hérité de ISupportInitialize.)

Début

Événements

  Nom Description
Événement public Added Se produit après l'ajout du contrôle de contenu au document. (Hérité de ContentControlBase.)
Événement public BindingContextChanged Se produit lorsque la valeur de la propriété BindingContext de ContentControlBase est modifiée. (Hérité de ContentControlBase.)
Événement public ContentUpdating Se produit juste avant que Microsoft Office Word mette à jour le texte dans le contrôle de contenu, si ce dernier est lié à une partie XML personnalisée. (Hérité de ContentControlBase.)
Événement public Deleting Se produit juste avant que le contrôle de contenu soit supprimé du document. (Hérité de ContentControlBase.)
Événement public Disposed Représente la méthode qui gère l'événement Disposed d'un composant. (Hérité de IComponent.)
Événement public Entering Se produit lorsque l'utilisateur clique dans le contrôle de contenu ou lorsque le curseur est amené par programme dans le contrôle de contenu. (Hérité de ContentControlBase.)
Événement public Exiting Se produit lorsque l'utilisateur clique en dehors du contrôle de contenu, ou lorsque le curseur quitte le contrôle de contenu par programme. (Hérité de ContentControlBase.)
Événement public StoreUpdating Se produit juste avant que Microsoft Office Word mette à jour les données dans une partie XML personnalisée liée au contrôle de contenu (à savoir, après la modification du texte dans le contrôle de contenu). (Hérité de ContentControlBase.)
Événement public Validated Se produit lorsque le contrôle de contenu a été validé. (Hérité de ContentControlBase.)
Événement public Validating Se produit lorsque le contenu du contrôle est validé. (Hérité de ContentControlBase.)

Début

Notes

Utilisez un GroupContentControl pour définir une région protégée d'un document que les utilisateurs ne peuvent pas modifier ou supprimer. Un GroupContentControl peut contenir n'importe quels éléments de document, tels que du texte, des tables, des graphiques, et même d'autres contrôles de contenu. Un GroupContentControl ne fournit aucune interface utilisateur visible par l'utilisateur. Pour plus d'informations sur l'utilisation d'un GroupContentControl pour protéger une partie d'un document, consultez Contrôles de contenu et Comment : protéger des parties de documents à l'aide de contrôles de contenu.

Notes

Cette interface est implémentée par Visual Studio Tools pour Office Runtime. Elle n'est pas destinée à être implémentée dans votre code. Pour plus d'informations, consultez Vue d'ensemble de Visual Studio Tools pour Office Runtime.

Contrôles de contenu

Le GroupContentControl est l'un des huit types de contrôles de contenu que vous pouvez utiliser pour créer des documents et des modèles dans Microsoft Office Word. Les contrôles de contenu ont une interface utilisateur (IU) dont les entrées sont contrôlées comme dans le cas d'un formulaire. Vous pouvez utiliser des contrôles de contenu pour empêcher les utilisateurs de modifier des sections protégées du document ou du modèle et vous pouvez également lier des contrôles de contenu à une source de données. Pour plus d'informations, consultez Contrôles de contenu.

Utilisation

Cette documentation décrit la version de ce type utilisée dans les projets Office qui ciblent .NET Framework 4. Dans les projets qui ciblent .NET Framework 3.5, ce type peut contenir d'autres membres, et les exemples de code qui y figurent sont susceptibles de ne pas fonctionner. Pour obtenir de la documentation sur ce type dans les projets ciblant .NET Framework 3.5, consultez la section de référence suivante dans la documentation Visual Studio 2008 : https://go.microsoft.com/fwlink/?LinkId=160658.

Exemples

L'exemple de code suivant ajoute un nouveau paragraphe au début du document et crée un nouveau GroupContentControl qui contient ce paragraphe. GroupContentControl empêche des utilisateurs de modifier le texte dans le paragraphe.

Cette version est destinée à une personnalisation au niveau du document. Pour utiliser ce code, collez-le dans la classe ThisDocument de votre projet, puis appelez la méthode AddGroupControlAtSelection à partir de la méthode ThisDocument_Startup.

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
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");
}

Cette version est destinée à un complément d'application. Pour utiliser ce code, collez-le dans la classe ThisAddIn de votre projet, puis appelez la méthode AddGroupControlAtSelection à partir de la méthode ThisAddIn_Startup.

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
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");
}

Voir aussi

Référence

Microsoft.Office.Tools.Word, espace de noms

Autres ressources

Contrôles de contenu

Comment : ajouter des contrôles de contenu à des documents Word

Comment : protéger des parties de documents à l'aide de contrôles de contenu

Procédure pas à pas : création d'un modèle à l'aide de contrôles de contenu