BuildingBlockGalleryContentControl, interface

Article
08/10/2011

Représente une galerie de blocs de construction de document que les utilisateurs peuvent insérer dans un document.

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

Syntaxe

'Déclaration
<GuidAttribute("d8d887a2-69fe-4a86-a8dd-352003dc0e7e")> _
Public Interface BuildingBlockGalleryContentControl _
    Inherits ContentControlBase, IBindableComponent, IComponent, IDisposable,  _
    ISupportInitialize

[GuidAttribute("d8d887a2-69fe-4a86-a8dd-352003dc0e7e")]
public interface BuildingBlockGalleryContentControl : ContentControlBase, 
    IBindableComponent, IComponent, IDisposable, ISupportInitialize

Le type BuildingBlockGalleryContentControl expose les membres suivants.

Propriétés

	Nom	Description
	Application	Obtient une Microsoft.Office.Interop.Word.Application qui représente l'instance actuelle de Microsoft Office Word.
	BindingContext	Obtient ou définit la collection de gestionnaires de devise pour IBindableComponent. (Hérité de IBindableComponent.)
	BuildingBlockCategory	Obtient ou définit la catégorie des blocs de construction affichés dans le BuildingBlockGalleryContentControl.
	BuildingBlockType	Obtient ou définit le type des blocs de construction affichés dans le BuildingBlockGalleryContentControl.
	Container	Infrastructure. (Hérité de ContentControlBase.)
	ContainerComponent	Infrastructure. (Hérité de ContentControlBase.)
	Creator	Obtient un entier 32 bits qui indique l'application dans laquelle le BuildingBlockGalleryContentControl a été créé.
	DataBindings	Obtient la collection d'objets de liaison de données pour ce IBindableComponent. (Hérité de IBindableComponent.)
	DefaultDataSourceUpdateMode	Obtient ou définit la valeur DataSourceUpdateMode par défaut de ContentControlBase. (Hérité de ContentControlBase.)
	DefaultTextStyle	Obtient le nom du style de caractère à utiliser pour mettre en forme le texte dans le BuildingBlockGalleryContentControl.
	ID	Obtient un nombre unique qui identifie le contrôle de contenu. (Hérité de ContentControlBase.)
	InnerObject	Obtient l'objet Microsoft.Office.Interop.Word.ContentControl sous-jacent de Microsoft.Office.Tools.Word.ContentControlBase. (Hérité de ContentControlBase.)
	LockContentControl	Obtient ou définit une valeur qui spécifie si le BuildingBlockGalleryContentControl peut être supprimé du document.
	LockContents	Obtient ou définit une valeur qui spécifie si le contenu de BuildingBlockGalleryContentControl peut être modifié.
	Parent	Définit le parent du BuildingBlockGalleryContentControl.
	ParentContentControl	Obtient le contrôle de contenu parent d'un BuildingBlockGalleryContentControl imbriqué dans un autre contrôle de contenu.
	PlaceholderText	Obtient ou définit le texte affiché dans le BuildingBlockGalleryContentControl jusqu'à ce que le texte soit modifié par une action utilisateur ou une autre opération.
	Range	Obtient un Range qui représente le contenu du BuildingBlockGalleryContentControl.
	ShowingPlaceholderText	Obtient une valeur qui indique si le BuildingBlockGalleryContentControl affiche actuellement le texte de l'espace réservé.
	Site	Obtient ou définit le ISite associé à IComponent. (Hérité de IComponent.)
	Tag	Obtient ou définit une chaîne à associer au BuildingBlockGalleryContentControl.
	Temporary	Obtient ou définit une valeur qui spécifie si le BuildingBlockGalleryContentControl est supprimé automatiquement du document lorsque le contrôle est modifié.
	Text	Obtient ou définit le texte dans le BuildingBlockGalleryContentControl.
	Title	Obtient ou définit le titre de la BuildingBlockGalleryContentControl.

Début

Méthodes

	Nom	Description
	BeginInit	Signale à l'objet que l'initialisation démarre. (Hérité de ISupportInitialize.)
	Copy	Copie le BuildingBlockGalleryContentControl du document vers le Presse-papiers.
	Cut	Supprime le BuildingBlockGalleryContentControl du document et l'ajoute au Presse-papiers.
	Delete	Supprime un contrôle de contenu créé dynamiquement du document et le retire de ControlCollection dans le document. (Hérité de ContentControlBase.)
	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.)
	EndInit	Signale à l'objet que l'initialisation est terminée. (Hérité de ISupportInitialize.)
	SetPlaceholderText	Affiche le texte qui se trouve dans Microsoft.Office.Interop.Word.BuildingBlock, Range ou une chaîne sous forme de texte d'espace réservé dans BuildingBlockGalleryContentControl.

Début

Événements

	Nom	Description
	Added	Se produit après l'ajout du contrôle de contenu au document. (Hérité de ContentControlBase.)
	BindingContextChanged	Se produit lorsque la valeur de la propriété BindingContext de ContentControlBase est modifiée. (Hérité de ContentControlBase.)
	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.)
	Deleting	Se produit juste avant que le contrôle de contenu soit supprimé du document. (Hérité de ContentControlBase.)
	Disposed	Représente la méthode qui gère l'événement Disposed d'un composant. (Hérité de IComponent.)
	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.)
	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.)
	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.)
	Validated	Se produit lorsque le contrôle de contenu a été validé. (Hérité de ContentControlBase.)
	Validating	Se produit lorsque le contenu du contrôle est validé. (Hérité de ContentControlBase.)

Début

Notes

Un BuildingBlockGalleryContentControl affiche la liste des blocs de construction de document que les utilisateurs peuvent insérer dans un document. Un bloc de construction de document est une partie de contenu créée pour être utilisée plusieurs fois, telle qu'une page de garde, une table mise en forme ou un en-tête communs. Pour choisir les blocs de construction à afficher, utilisez les propriétés BuildingBlockCategory et BuildingBlockType.

Pour plus d'informations sur les blocs de construction de document, consultez Nouveautés pour les développeurs dans Word 2007.

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 BuildingBlockGalleryContentControl 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 BuildingBlockGalleryContentControl au début du document. BuildingBlockGalleryContentControl affiche des blocs de construction d'équation fournis par Microsoft Office Word.

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 AddBuildingBlockControlAtSelection à partir de la méthode ThisDocument_Startup.

Dim buildingBlockGalleryControl1 As Microsoft.Office.Tools.Word.BuildingBlockGalleryContentControl

Private Sub AddBuildingBlockGalleryControlAtSelection()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Me.Paragraphs(1).Range.Select()
    buildingBlockGalleryControl1 = Me.Controls.AddBuildingBlockGalleryContentControl( _
        "buildingBlockGalleryControl1")
    With buildingBlockGalleryControl1
        .PlaceholderText = "Choose an equation"
        .BuildingBlockCategory = "Built-In"
        .BuildingBlockType = Word.WdBuildingBlockTypes.wdTypeEquations
    End With
End Sub

private Microsoft.Office.Tools.Word.BuildingBlockGalleryContentControl buildingBlockControl1;

private void AddBuildingBlockControlAtSelection()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    this.Paragraphs[1].Range.Select();

    buildingBlockControl1 = this.Controls.AddBuildingBlockGalleryContentControl(
        "buildingBlockControl1");
    buildingBlockControl1.PlaceholderText = "Choose an equation";
    buildingBlockControl1.BuildingBlockCategory = "Built-In";
    buildingBlockControl1.BuildingBlockType = Word.WdBuildingBlockTypes.wdTypeEquations;
}

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 AddBuildingBlockControlAtSelection à partir de la méthode ThisAddIn_Startup.

Dim buildingBlockGalleryControl1 As BuildingBlockGalleryContentControl

Private Sub AddBuildingBlockGalleryControlAtSelection()
    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()
    buildingBlockGalleryControl1 = vstoDoc.Controls.AddBuildingBlockGalleryContentControl( _
        "buildingBlockGalleryControl1")
    With buildingBlockGalleryControl1
        .PlaceholderText = "Choose an equation"
        .BuildingBlockCategory = "Built-In"
        .BuildingBlockType = Word.WdBuildingBlockTypes.wdTypeEquations
    End With
End Sub

private Microsoft.Office.Tools.Word.BuildingBlockGalleryContentControl buildingBlockControl1;

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

    Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
    vstoDoc.Paragraphs[1].Range.InsertParagraphBefore();
    vstoDoc.Paragraphs[1].Range.Select();

    buildingBlockControl1 = vstoDoc.Controls.AddBuildingBlockGalleryContentControl(
        "buildingBlockControl1");
    buildingBlockControl1.PlaceholderText = "Choose an equation";
    buildingBlockControl1.BuildingBlockCategory = "Built-In";
    buildingBlockControl1.BuildingBlockType = Word.WdBuildingBlockTypes.wdTypeEquations;
}