RichTextContentControl Schnittstelle
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Stellt einen Textblock oder andere Inhaltstypen in einem Dokument dar.
[System.Runtime.InteropServices.Guid("fe02ce7e-9ae7-444f-a5f8-af588716d06b")]
public interface RichTextContentControl : IDisposable, Microsoft.Office.Tools.Word.ContentControlBase, System.ComponentModel.IComponent, System.ComponentModel.ISupportInitialize, System.Windows.Forms.IBindableComponent
- Attribute
- Implementiert
Beispiele
Im folgenden Codebeispiel wird RichTextContentControl am Anfang des Dokuments ein neues hinzugefügt.
Diese Version ist für eine Anpassung auf Dokument Ebene vorgesehen. Um diesen Code zu verwenden, fügen Sie ihn in die ThisDocument -Klasse in Ihrem Projekt ein, und nennen Sie die- AddRichTextControlAtSelection Methode von der- ThisDocument_Startup Methode.
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";
}
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
Diese Version ist für ein Add-in auf Anwendungsebene vorgesehen. Um diesen Code zu verwenden, fügen Sie ihn in die ThisAddIn -Klasse in Ihrem Projekt ein, und nennen Sie die- AddRichTextControlAtSelection Methode von der- ThisAddIn_Startup Methode.
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";
}
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
Hinweise
Ein RichTextContentControl kann Text und viele andere Inhaltstypen enthalten, einschließlich Tabellen, Bilder oder andere Inhalts Steuerelemente. Sie können eine Kombination von Formatierung und Stilen auf Text in einem anwenden RichTextContentControl .
Um einen Dokumentbereich zu erstellen, der nur Text enthalten kann, verwenden Sie einen PlainTextContentControl .
Hinweis
Diese Schnittstelle wird von der Visual Studio-Tools für Office-Laufzeit implementiert. Es ist nicht vorgesehen, dass der Typ direkt vom Code implementiert wird. Weitere Informationen finden Sie unter Visual Studio Tools for Office Runtime Overview.
Inhaltssteuerelemente
Der RichTextContentControl ist einer von acht Typen von Inhalts Steuerelementen, die Sie zum Entwerfen von Dokumenten und Vorlagen in Microsoft Office Word verwenden können. Inhalts Steuerelemente verfügen über eine Benutzeroberfläche (UI), die über kontrollierte Eingaben wie ein Formular verfügt. Sie können Inhalts Steuerelemente verwenden, um zu verhindern, dass Benutzer geschützte Abschnitte des Dokuments oder der Vorlage bearbeiten, und Sie können Inhalts Steuerelemente auch an eine Datenquelle binden. Weitere Informationen finden Sie unter Content Controls.
Verwendung
Diese Dokumentation beschreibt die Version des Typs, der in Office-Projekten verwendet wird, die auf .NET Framework 4 und höher ausgerichtet sind. In Projekten, die auf .NET Framework 3.5 abzielen, verfügt dieser Typ möglicherweise über unterschiedliche Member, und die für diesen Typ bereitgestellten Codebeispiele funktionieren möglicherweise nicht. Eine Dokumentation dieser Art von Projekten, die auf den .NET Framework 3.5 abzielen, erhalten Sie in den folgenden Verweisabschnitten in der Dokumentation zu Visual Studio 2008: http://go.microsoft.com/fwlink/?LinkId=160658.
Eigenschaften
| Application |
Ruft eine Application ab, die die aktuelle Instanz von Microsoft Office Word darstellt. |
| Container | (Geerbt von ContentControlBase) |
| ContainerComponent | (Geerbt von ContentControlBase) |
| Creator |
Ruft eine 32-Bit-Ganzzahl ab, die die Anwendung angibt, in der das RichTextContentControl erstellt wurde. |
| DefaultDataSourceUpdateMode |
Ruft den Standard-DataSourceUpdateMode für das ContentControlBase ab oder legt diesen fest. (Geerbt von ContentControlBase) |
| DefaultTextStyle |
Ruft den Namen des Zeichenstils ab, der verwendet wird, um im RichTextContentControl Text zu formatieren, oder legt den Namen fest. |
| ID |
Ruft eine eindeutige Zahl ab, die das Inhaltssteuerelement identifiziert. (Geerbt von ContentControlBase) |
| InnerObject |
Ruft das zugrunde liegende ContentControl-Objekt für ContentControlBase ab. (Geerbt von ContentControlBase) |
| LockContentControl |
Ruft einen Wert ab, der angibt, ob das RichTextContentControl aus dem Dokument gelöscht werden kann, oder legt diesen Wert fest. |
| LockContents |
Ruft einen Wert ab, der angibt, ob die Inhalte des RichTextContentControl bearbeitet werden können, oder legt diesen Wert fest. |
| Parent |
Ruft das übergeordnete Element von RichTextContentControl ab. |
| ParentContentControl |
Ruft das übergeordnete Inhaltssteuerelement von einem RichTextContentControl ab, das in einem anderen Inhaltselement geschachtelt ist. |
| PlaceholderText |
Ruft den Text ab, der im RichTextContentControl angezeigt wird, bis der Text durch eine Benutzeraktion oder einen anderen Vorgang geändert wird, oder legt den Text fest. |
| Range |
Ruft einen Range ab, der den Inhalt von RichTextContentControl darstellt. |
| ShowingPlaceholderText |
Ruft einen Wert ab, der angibt, ob das RichTextContentControl derzeit Platzhaltertext anzeigt. |
| Tag |
Ruft eine Zeichenfolge ab, die Sie dem RichTextContentControl zuordnen möchten, oder legt eine Zeichenfolge fest. |
| Temporary |
Ruft einen Wert ab, der angibt, ob das RichTextContentControl bei Bearbeitung des Steuerelements automatisch aus dem Dokument gelöscht wird, oder legt den Wert fest. |
| Text |
Ruft den Text im RichTextContentControl ab oder legt ihn fest. |
| Title |
Ruft den Titel für das RichTextContentControl ab oder legt diesen fest. |
Methoden
| Copy() |
Kopiert das RichTextContentControl aus dem Dokument in die Zwischenablage. |
| Cut() |
Entfernt das RichTextContentControl aus dem Dokument und fügt es der Zwischenablage hinzu. |
| Delete(Boolean) |
Löscht ein dynamisch erstelltes Inhaltssteuerelement aus dem Dokument und entfernt es aus der ControlCollection im Dokument. (Geerbt von ContentControlBase) |
| SetPlaceholderText(BuildingBlock, Range, String) |
Zeigt Text an, der sich in einem BuildingBlock, einem Range oder in einer Zeichenfolge als Platzhaltertext im RichTextContentControl befindet. |
Ereignisse
| Added |
Tritt auf, nachdem dem Dokument das Inhaltssteuerelement hinzugefügt wurde. (Geerbt von ContentControlBase) |
| BindingContextChanged |
Tritt ein, wenn der Wert der BindingContext-Eigenschaft des ContentControlBase geändert wird. (Geerbt von ContentControlBase) |
| ContentUpdating |
Tritt auf, kurz bevor Microsoft Office Word den Text im Inhaltssteuerelement aktualisiert, wenn das Inhaltssteuerelement an einen benutzerdefinierten XML-Abschnitt gebunden ist. (Geerbt von ContentControlBase) |
| Deleting |
Tritt kurz vor dem Löschen des Inhaltssteuerelements aus dem Dokument auf. (Geerbt von ContentControlBase) |
| Entering |
Tritt auf, wenn der Benutzer in das Inhaltssteuerelement klickt oder der Cursor programmgesteuert in das Inhaltssteuerelement bewegt wird. (Geerbt von ContentControlBase) |
| Exiting |
Tritt auf, wenn der Benutzer außerhalb des Inhaltssteuerelements klickt oder der Cursor programmgesteuert aus dem Inhaltssteuerelement heraus bewegt wird. (Geerbt von ContentControlBase) |
| StoreUpdating |
Tritt auf, kurz bevor Microsoft Office Word automatisch die Daten in einem benutzerdefinierten XML-Abschnitt aktualisiert, der an das Inhaltssteuerelement gebunden ist (d.h. nachdem sich der Text im Inhaltssteuerelement ändert). (Geerbt von ContentControlBase) |
| Validated |
Tritt ein, wenn das Inhaltssteuerelement erfolgreich überprüft wurde. (Geerbt von ContentControlBase) |
| Validating |
Tritt auf, wenn der Inhalt des Inhaltssteuerelements überprüft wird. (Geerbt von ContentControlBase) |