Partager via


RichTextContentControl, interface

Représente un bloc de texte ou d'autres types de contenus 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("fe02ce7e-9ae7-444f-a5f8-af588716d06b")> _
Public Interface RichTextContentControl _
    Inherits ContentControlBase, IBindableComponent, IComponent, IDisposable,  _
    ISupportInitialize
[GuidAttribute("fe02ce7e-9ae7-444f-a5f8-af588716d06b")]
public interface RichTextContentControl : ContentControlBase, 
    IBindableComponent, IComponent, IDisposable, ISupportInitialize

Le type RichTextContentControl 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 RichTextContentControl 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 DefaultTextStyle Obtient le nom du style de caractère à utiliser pour mettre en forme le texte dans le RichTextContentControl.
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 RichTextContentControl peut être supprimé du document.
Propriété publique LockContents Obtient ou définit une valeur qui spécifie si le contenu de RichTextContentControl peut être modifié.
Propriété publique Parent Définit le parent du RichTextContentControl.
Propriété publique ParentContentControl Obtient le contrôle de contenu parent d'un RichTextContentControl imbriqué dans un autre contrôle de contenu.
Propriété publique PlaceholderText Obtient ou définit le texte affiché dans le RichTextContentControl jusqu'à ce que le texte soit modifié par une action utilisateur ou une autre opération.
Propriété publique Range Obtient un Range qui représente le contenu du RichTextContentControl.
Propriété publique ShowingPlaceholderText Obtient une valeur qui indique si le RichTextContentControl affiche actuellement le texte de l'espace réservé.
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 RichTextContentControl.
Propriété publique Temporary Obtient ou définit une valeur qui spécifie si le RichTextContentControl est supprimé automatiquement du document lorsque le contrôle est modifié.
Propriété publique Text Obtient ou définit le texte dans le RichTextContentControl.
Propriété publique Title Obtient ou définit le titre de la RichTextContentControl.

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 RichTextContentControl du document vers le Presse-papiers.
Méthode publique Cut Supprime le RichTextContentControl 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.)
Méthode publique SetPlaceholderText Affiche le texte qui se trouve dans BuildingBlock, Range ou une chaîne sous forme de texte d'espace réservé dans RichTextContentControl.

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

Un RichTextContentControl peut contenir du texte ainsi que de nombreux autres types de contenus, notamment des tableaux, des images ou d'autres contrôles de contenu. Vous pouvez appliquer une combinaison de mise en forme et de styles au texte dans un RichTextContentControl.

Pour créer une région de document qui ne peut contenir que du texte, utilisez un PlainTextContentControl.

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 RichTextContentControl 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 et .NET Framework 4.5. 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 RichTextContentControl au début du document.

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

Dim richTextControl1 As Microsoft.Office.Tools.Word.RichTextContentControl

Private Sub AddRichTextControlAtSelection()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Me.Paragraphs(1).Range.Select()
    richTextControl1 = Me.Controls.AddRichTextContentControl("richTextControl1")
    richTextControl1.PlaceholderText = "Enter your first name"
End Sub
private Microsoft.Office.Tools.Word.RichTextContentControl richTextControl1;

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

    richTextControl1 = this.Controls.AddRichTextContentControl("richTextControl1");
    richTextControl1.PlaceholderText = "Enter your first name";
}

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

Dim richTextControl1 As Microsoft.Office.Tools.Word.RichTextContentControl

Private Sub AddRichTextControlAtSelection()
    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()
    richTextControl1 = vstoDoc.Controls.AddRichTextContentControl("richTextControl1")
    richTextControl1.PlaceholderText = "Enter your first name"
End Sub
private Microsoft.Office.Tools.Word.RichTextContentControl richTextControl1;

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

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

    richTextControl1 = vstoDoc.Controls.AddRichTextContentControl("richTextControl1");
    richTextControl1.PlaceholderText = "Enter your first name";
}

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