Word.OleFormat class
Stellt die OLE-Merkmale (mit Ausnahme der Verknüpfung) für ein OLE-Objekt, ActiveX-Steuerelement oder ein Feld dar.
- Extends
Eigenschaften
| class |
Gibt den Klassentyp für das angegebene OLE-Objekt, -Bild oder -Feld an. |
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| icon |
Gibt das Symbol an, das verwendet wird, wenn die |
| icon |
Gibt den Text an, der unter dem Symbol für das OLE-Objekt angezeigt wird. |
| icon |
Gibt die Programmdatei an, in der das Symbol für das OLE-Objekt gespeichert ist. |
| icon |
Ruft den Pfad der Datei ab, in der das Symbol für das OLE-Objekt gespeichert ist. |
| is |
Ruft ab, ob das angegebene Objekt als Symbol angezeigt wird. |
| is |
Gibt an, ob die in Microsoft Word vorgenommenen Formatierungen für das verknüpfte OLE-Objekt beibehalten werden. |
| label | Ruft eine Zeichenfolge ab, die verwendet wird, um den Teil der Quelldatei zu identifizieren, der verknüpft wird. |
| prog |
Ruft den programmgesteuerten Bezeichner ( |
Methoden
| activate() | Aktiviert das |
| activate |
Legt den Windows-Registrierungswert fest, der die Standardanwendung zum Aktivieren des angegebenen OLE-Objekts bestimmt. |
| do |
Fordert an, dass das OLE-Objekt eines der verfügbaren Verben ausführt. |
| do |
Fordert an, dass das OLE-Objekt eines der verfügbaren Verben ausführt. |
| edit() | Öffnet das OLE-Objekt zur Bearbeitung in der Anwendung, in der es erstellt wurde. |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| open() | Öffnet das |
| set(properties, options) | 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) | Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt. |
| toJSON() | Überschreibt die JavaScript-Methode |
| track() | 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 aufrufübergreifend |
| untrack() | 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 einen Aufruf durchführen |
Details zur Eigenschaft
classType
Gibt den Klassentyp für das angegebene OLE-Objekt, -Bild oder -Feld an.
classType: string;Eigenschaftswert
string
Hinweise
context
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
iconIndex
Gibt das Symbol an, das verwendet wird, wenn die displayAsIcon Eigenschaft .true
iconIndex: number;Eigenschaftswert
number
Hinweise
iconLabel
Gibt den Text an, der unter dem Symbol für das OLE-Objekt angezeigt wird.
iconLabel: string;Eigenschaftswert
string
Hinweise
iconName
Gibt die Programmdatei an, in der das Symbol für das OLE-Objekt gespeichert ist.
iconName: string;Eigenschaftswert
string
Hinweise
iconPath
Ruft den Pfad der Datei ab, in der das Symbol für das OLE-Objekt gespeichert ist.
readonly iconPath: string;Eigenschaftswert
string
Hinweise
isDisplayedAsIcon
Ruft ab, ob das angegebene Objekt als Symbol angezeigt wird.
readonly isDisplayedAsIcon: boolean;Eigenschaftswert
boolean
Hinweise
isFormattingPreservedOnUpdate
Gibt an, ob die in Microsoft Word vorgenommenen Formatierungen für das verknüpfte OLE-Objekt beibehalten werden.
isFormattingPreservedOnUpdate: boolean;Eigenschaftswert
boolean
Hinweise
label
Ruft eine Zeichenfolge ab, die verwendet wird, um den Teil der Quelldatei zu identifizieren, der verknüpft wird.
readonly label: string;Eigenschaftswert
string
Hinweise
progId
Ruft den programmgesteuerten Bezeichner (ProgId) für das angegebene OLE-Objekt ab.
readonly progId: string;Eigenschaftswert
string
Hinweise
Details zur Methode
activate()
Aktiviert das OleFormat Objekt.
activate(): void;Gibt zurück
void
Hinweise
activateAs(classType)
Legt den Windows-Registrierungswert fest, der die Standardanwendung zum Aktivieren des angegebenen OLE-Objekts bestimmt.
activateAs(classType: string): void;Parameter
- classType
-
string
Der Klassentyp, als der aktiviert werden soll.
Gibt zurück
void
Hinweise
doVerb(verbIndex)
Fordert an, dass das OLE-Objekt eines der verfügbaren Verben ausführt.
doVerb(verbIndex: Word.OleVerb): void;Parameter
- verbIndex
- Word.OleVerb
Optional. Der Index des aufzuführenden Verbs.
Gibt zurück
void
Hinweise
doVerb(verbIndex)
Fordert an, dass das OLE-Objekt eines der verfügbaren Verben ausführt.
doVerb(verbIndex: "Primary" | "Show" | "Open" | "Hide" | "UiActivate" | "InPlaceActivate" | "DiscardUndoState"): void;Parameter
- verbIndex
-
"Primary" | "Show" | "Open" | "Hide" | "UiActivate" | "InPlaceActivate" | "DiscardUndoState"
Optional. Der Index des aufzuführenden Verbs.
Gibt zurück
void
Hinweise
edit()
Öffnet das OLE-Objekt zur Bearbeitung in der Anwendung, in der es erstellt wurde.
edit(): void;Gibt zurück
void
Hinweise
load(options)
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.OleFormatLoadOptions): Word.OleFormat;Parameter
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
Gibt zurück
load(propertyNames)
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.OleFormat;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
load(propertyNamesAndPaths)
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.OleFormat;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
open()
set(properties, options)
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.OleFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Word.Interfaces.OleFormatUpdateData
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt versucht, schreibgeschützte Eigenschaften festzulegen.
Gibt zurück
void
set(properties)
Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
set(properties: Word.OleFormat): void;Parameter
- properties
- Word.OleFormat
Gibt zurück
void
toJSON()
Ü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 sie übergeben wird.) Während das ursprüngliche Word.OleFormat Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Word.Interfaces.OleFormatData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
toJSON(): Word.Interfaces.OleFormatData;Gibt zurück
track()
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 aufrufübergreifend .sync 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 ein "InvalidObjectPath"-Fehler angezeigt wird, müssen Sie das Objekt der nachverfolgten Objektsammlung hinzufügen, wenn das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Sammlung ist, sollten Sie auch die übergeordnete Sammlung nachverfolgen.
track(): Word.OleFormat;Gibt zurück
untrack()
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 einen Aufruf durchführen context.sync() , bevor die Speicherfreigabe wirksam wird.
untrack(): Word.OleFormat;