PlainTextContentControl-Schnittstelle

Artikel
05/07/2013

Stellt einen Textblock in einem Dokument dar.

Namespace: Microsoft.Office.Tools.Word
Assembly: Microsoft.Office.Tools.Word (in Microsoft.Office.Tools.Word.dll)

Syntax

'Declaration
<GuidAttribute("a8c46931-fa10-4760-8b46-0f2d881e269f")> _
Public Interface PlainTextContentControl _
    Inherits ContentControlBase, IBindableComponent, IComponent, IDisposable,  _
    ISupportInitialize

[GuidAttribute("a8c46931-fa10-4760-8b46-0f2d881e269f")]
public interface PlainTextContentControl : ContentControlBase, 
    IBindableComponent, IComponent, IDisposable, ISupportInitialize

Der PlainTextContentControl-Typ macht die folgenden Member verfügbar.

Eigenschaften

	Name	Beschreibung
	Application	Ruft eine Microsoft.Office.Interop.Word.Application ab, die die aktuelle Instanz von Microsoft Office Word darstellt.
	BindingContext	Ruft die Auflistung von CurrencyManager-Objekten für die IBindableComponent ab oder legt diese fest. (Von IBindableComponent geerbt.)
	Container	Infrastruktur. (Von ContentControlBase geerbt.)
	ContainerComponent	Infrastruktur. (Von ContentControlBase geerbt.)
	Creator	Ruft eine 32-Bit-Ganzzahl ab, die die Anwendung angibt, in der das PlainTextContentControl erstellt wurde.
	DataBindings	Ruft die Auflistung der Datenbindungsobjekte für diese IBindableComponent ab. (Von IBindableComponent geerbt.)
	DefaultDataSourceUpdateMode	Ruft den Standard-DataSourceUpdateMode für den ContentControlBase ab oder legt diesen fest. (Von ContentControlBase geerbt.)
	DefaultTextStyle	Ruft den Namen des Zeichenstils ab, der verwendet wird, um im PlainTextContentControl Text zu formatieren, oder legt den Namen fest.
	ID	Ruft eine eindeutige Zahl ab, die das Inhaltssteuerelement identifiziert. (Von ContentControlBase geerbt.)
	InnerObject	Ruft das zugrunde liegende Microsoft.Office.Interop.Word.ContentControl-Objekt für das Microsoft.Office.Tools.Word.ContentControlBase ab. (Von ContentControlBase geerbt.)
	LockContentControl	Ruft einen Wert ab, der angibt, ob das PlainTextContentControl aus dem Dokument gelöscht werden kann, oder legt den Wert fest.
	LockContents	Ruft einen Wert ab, der angibt, ob der Inhalt vom PlainTextContentControl bearbeitet werden kann, oder legt den Wert fest.
	MultiLine	Ruft einen Wert ab, der angibt, ob das PlainTextContentControl Zeilenumbrüche enthalten kann, oder legt einen Wert fest.
	Parent	Ruft das übergeordnete Element für das PlainTextContentControl ab.
	ParentContentControl	Ruft das übergeordnete Inhaltssteuerelement von einem PlainTextContentControl ab, das in einem anderen Inhaltselement geschachtelt ist.
	PlaceholderText	Ruft den Text ab, der im PlainTextContentControl angezeigt wird, bis der Text durch eine Benutzeraktion oder einen anderen Vorgang geändert wird, oder legt den Text fest.
	Range	Ruft ein Range-Element ab, das den Inhalt des PlainTextContentControl-Elements darstellt.
	ShowingPlaceholderText	Ruft einen Wert ab, der angibt, ob das PlainTextContentControl derzeit Platzhaltertext anzeigt.
	Site	Ruft den dem IComponent zugeordneten ISite ab oder legt diesen fest. (Von IComponent geerbt.)
	Tag	Ruft eine Zeichenfolge ab, die Sie dem PlainTextContentControl zuordnen, oder legt eine Zeichenfolge fest.
	Temporary	Ruft einen Wert ab, der angibt, ob das PlainTextContentControl bei Bearbeitung des Steuerelements automatisch aus dem Dokument gelöscht wird, oder legt den Wert fest.
	Text	Ruft den Text im PlainTextContentControl ab oder legt ihn fest.
	Title	Ruft den Titel für das PlainTextContentControl ab oder legt diesen fest.
	XMLMapping	Ruft eine XMLMapping ab, die die Bindung zwischen dem PlainTextContentControl und einem Element in einem benutzerdefinierten XML-Abschnitt darstellt.

Zum Seitenanfang

Methoden

	Name	Beschreibung
	BeginInit	Signalisiert dem Objekt den Start der Initialisierung. (Von ISupportInitialize geerbt.)
	Copy	Kopiert das PlainTextContentControl aus dem Dokument in die Zwischenablage.
	Cut	Entfernt das PlainTextContentControl aus dem Dokument und fügt es der Zwischenablage hinzu.
	Delete	Löscht ein dynamisch erstelltes Inhaltssteuerelement aus dem Dokument und entfernt es aus der ControlCollection im Dokument. (Von ContentControlBase geerbt.)
	Dispose	Führt anwendungsspezifische Aufgaben aus, die mit dem Freigeben, Zurückgeben oder Zurücksetzen von nicht verwalteten Ressourcen zusammenhängen. (Von IDisposable geerbt.)
	EndInit	Signalisiert dem Objekt den Abschluss der Initialisierung. (Von ISupportInitialize geerbt.)
	SetPlaceholderText	Zeigt Text an, der sich in einem BuildingBlock, einem Range oder in einer Zeichenfolge als Platzhaltertext im PlainTextContentControl befindet.

Zum Seitenanfang

Ereignisse

	Name	Beschreibung
	Added	Tritt auf, nachdem dem Dokument das Inhaltssteuerelement hinzugefügt wurde. (Von ContentControlBase geerbt.)
	BindingContextChanged	Tritt ein, wenn der Wert der BindingContext-Eigenschaft des ContentControlBase geändert wird. (Von ContentControlBase geerbt.)
	ContentUpdating	Tritt auf, kurz bevor Microsoft Office Word den Text im Inhaltssteuerelement aktualisiert, wenn das Inhaltssteuerelement an einen benutzerdefinierten XML-Abschnitt gebunden ist. (Von ContentControlBase geerbt.)
	Deleting	Tritt kurz vor dem Löschen des Inhaltssteuerelements aus dem Dokument auf. (Von ContentControlBase geerbt.)
	Disposed	Stellt die Methode dar, die das Disposed-Ereignis einer Komponente behandelt. (Von IComponent geerbt.)
	Entering	Tritt auf, wenn der Benutzer in das Inhaltssteuerelement klickt oder der Cursor programmgesteuert in das Inhaltssteuerelement bewegt wird. (Von ContentControlBase geerbt.)
	Exiting	Tritt auf, wenn der Benutzer außerhalb des Inhaltssteuerelements klickt oder der Cursor programmgesteuert aus dem Inhaltssteuerelement heraus bewegt wird. (Von ContentControlBase geerbt.)
	StoreUpdating	Tritt auf, kurz bevor Microsoft Office Word Daten in einem benutzerdefinierten XML-Abschnitt aktualisiert, der an das Inhaltssteuerelement gebunden ist (nachdem der Text im Inhaltssteuerelement sich ändert). (Von ContentControlBase geerbt.)
	Validated	Tritt ein, wenn das Inhaltssteuerelement erfolgreich überprüft wurde. (Von ContentControlBase geerbt.)
	Validating	Tritt auf, wenn der Inhalt des Inhaltssteuerelements überprüft wird. (Von ContentControlBase geerbt.)

Zum Seitenanfang

Hinweise

Ein PlainTextContentControl kann nur Text enthalten.Sie können Text in einem PlainTextContentControl formatieren. Es wird jedoch auf den gesamten Text im Steuerelement automatisch die gleiche Formatierung angewendet.Wenn Sie beispielsweise ein Wort in einem Satz, der sich in einem PlainTextContentControl befindet, kursiv formatieren, wird der gesamte Text im Steuerelement kursiv formatiert.

Verwenden Sie die Text-Eigenschaft, um auf den Text in einem PlainTextContentControl zuzugreifenStandardmäßig kann ein PlainTextContentControl keine Zeilenumbrüche enthalten.Verwenden Sie die MultiLine-Eigenschaft, um dieses Verhalten zu ändern.

Zum Erstellen eines Dokumentbereichs, der Text und viele andere Inhaltstypen, einschließlich Tabellen, Bilder oder anderer Inhaltssteuerelemente, enthalten kann, verwenden Sie ein RichTextContentControl.

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 Übersicht über die Visual Studio Tools for Office-Laufzeit.

Inhaltssteuerelemente

Das PlainTextContentControl ist einer von acht Steuerelementtypen, die Sie in Microsoft Office Word zum Entwerfen von Dokumenten und Vorlagen verwenden können.Inhaltssteuerelemente haben eine Benutzeroberfläche mit verwalteten Benutzereingaben wie bei einem Formular.Sie können mithilfe von Inhaltssteuerelementen verhindern, dass Benutzer geschützte Abschnitte des Dokuments bzw. der Vorlage bearbeiten. Außerdem können Sie Inhaltssteuerelemente an eine Datenquelle binden.Weitere Informationen finden Sie unter Inhaltssteuerelemente.

Verwendung

Diese Dokumentation beschreibt die Version des Typs, der in Office-Projekten verwendet wird, die auf .NET Framework 4 und .NET Framework 4.5 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. Dokumentation zu diesem Typ in Projekten mit der Zielversion .NET Framework 3.5 finden Sie im folgenden Verweisabschnitt in der Visual Studio 2008-Dokumentation: https://go.microsoft.com/fwlink/?LinkId=160658.

Beispiele

Im folgenden Codebeispiel wird am Anfang des Dokuments ein neues PlainTextContentControl hinzugefügt.

Diese Version bezieht sich auf eine Anpassung auf Dokumentebene.Zum Verwenden dieses Codes fügen Sie ihn in der ThisDocument-Klasse in das Projekt ein und rufen in der ThisDocument_Startup-Methode die AddTextControlAtSelection-Methode auf.

Dim plainTextControl1 As Microsoft.Office.Tools.Word.PlainTextContentControl

Private Sub AddPlainTextControlAtSelection()
    Me.Paragraphs(1).Range.InsertParagraphBefore()
    Me.Paragraphs(1).Range.Select()
    plainTextControl1 = Me.Controls.AddPlainTextContentControl("plainTextControl1")
    plainTextControl1.PlaceholderText = "Enter your first name"
End Sub

private Microsoft.Office.Tools.Word.PlainTextContentControl textControl1;

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

    textControl1 = this.Controls.AddPlainTextContentControl("textControl1");
    textControl1.PlaceholderText = "Enter your first name";
}

Diese Version bezieht sich auf ein Add-In auf Anwendungsebene.Zum Verwenden dieses Codes fügen Sie ihn in der ThisAddIn-Klasse in das Projekt ein und rufen in der ThisAddIn_Startup-Methode die AddTextControlAtSelection-Methode auf.

Dim plainTextControl1 As Microsoft.Office.Tools.Word.PlainTextContentControl

Private Sub AddPlainTextControlAtSelection()
    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()
    plainTextControl1 = vstoDoc.Controls.AddPlainTextContentControl("plainTextControl1")
    plainTextControl1.PlaceholderText = "Enter your first name"
End Sub

private Microsoft.Office.Tools.Word.PlainTextContentControl textControl1;

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

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

    textControl1 = vstoDoc.Controls.AddPlainTextContentControl("textControl1");
    textControl1.PlaceholderText = "Enter your first name";
}