Word.PictureContentControl class

Gibt die Darstellung des Inhaltssteuerelements an.

appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden";

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den Rot-Grün-Blau-Wert (RGB) der Farbe des Inhaltssteuerelements an. Sie können den Wert im Format "#RRGGBB" angeben.

color: string;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Gibt die Identifikation für das Inhaltssteuerelement zurück.

readonly id: string;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt an, ob das Inhaltssteuerelement aus dem aktiven Dokument entfernt werden soll, wenn der Benutzer den Inhalt des Steuerelements bearbeitet.

isTemporary: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt die Ebene des Inhaltssteuerelements zurück– unabhängig davon, ob das Inhaltssteuerelement Text, Absätze, Tabellenzellen oder Tabellenzeilen umgibt; oder , wenn es inline ist.

readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell";

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt an, ob das Inhaltssteuerelement gesperrt ist (kann nicht gelöscht werden). true bedeutet, dass der Benutzer es nicht aus dem aktiven Dokument löschen kann, was bedeutet, false dass es gelöscht werden kann.

lockContentControl: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt an, ob der Inhalt des Inhaltssteuerelements gesperrt (nicht bearbeitbar) ist. true bedeutet, dass der Benutzer den Inhalt nicht bearbeiten kann, was bedeutet, false dass die Inhalte bearbeitbar sind.

lockContents: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt ein BuildingBlock -Objekt zurück, das den Platzhaltertext für das Inhaltssteuerelement darstellt.

readonly placeholderText: Word.BuildingBlock;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt ein Range -Objekt zurück, das den Inhalt des Inhaltssteuerelements im aktiven Dokument darstellt.

readonly range: Word.Range;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt zurück, ob der Platzhaltertext für das Inhaltssteuerelement angezeigt wird.

readonly showingPlaceholderText: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt ein Tag zum Identifizieren des Inhaltssteuerelements an.

tag: string;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den Titel für das Inhaltssteuerelement an.

title: string;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt ein XmlMapping -Objekt zurück, das die Zuordnung des Inhaltssteuerelements zu XML-Daten im Datenspeicher des Dokuments darstellt.

readonly xmlMapping: Word.XmlMapping;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Kopiert das Inhaltssteuerelement aus dem aktiven Dokument in die Zwischenablage.

copy(): void;

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Entfernt das Inhaltssteuerelement aus dem aktiven Dokument und verschiebt dieses in die Zwischenablage.

cut(): void;

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Löscht das Inhaltssteuerelement und optional seinen Inhalt.

delete(deleteContents?: boolean): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: Word.Interfaces.PictureContentControlLoadOptions): Word.PictureContentControl;

Parameter

Gibt zurück

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames?: string | string[]): Word.PictureContentControl;

Parameter

Gibt zurück

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.PictureContentControl;

Parameter

Gibt zurück

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

set(properties: Interfaces.PictureContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

Gibt zurück

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Word.PictureContentControl): void;

Parameter

Gibt zurück

Legt den Platzhaltertext fest, der im Inhaltssteuerelement angezeigt wird, bis ein Benutzer einen eigenen Text einfügt.

setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Word.PictureContentControl Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.PictureContentControlData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Word.Interfaces.PictureContentControlData;

Gibt zurück

Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über .sync Aufrufe hinweg und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Auflistung ist, sollten Sie auch die übergeordnete Auflistung nachverfolgen.

track(): Word.PictureContentControl;

Gibt zurück

Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.

untrack(): Word.PictureContentControl;

Gibt zurück