Word.OleFormat class

Spécifie le type de classe pour l’objet, l’image ou le champ OLE spécifié.

classType: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Spécifie l’icône utilisée lorsque la displayAsIcon propriété est true.

iconIndex: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie le texte affiché sous l’icône de l’objet OLE.

iconLabel: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie le fichier programme dans lequel l’icône de l’objet OLE est stockée.

iconName: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient le chemin du fichier dans lequel l’icône de l’objet OLE est stockée.

readonly iconPath: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient si l’objet spécifié est affiché sous forme d’icône.

readonly isDisplayedAsIcon: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Spécifie si la mise en forme effectuée dans Microsoft Word à l’objet OLE lié est conservée.

isFormattingPreservedOnUpdate: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient une chaîne utilisée pour identifier la partie du fichier source qui est liée.

readonly label: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Obtient l’identificateur programmatique (ProgId) de l’objet OLE spécifié.

readonly progId: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Active l’objet OleFormat .

activate(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Définit la valeur du registre Windows qui détermine l'application utilisée par défaut pour activer l'objet OLE spécifié.

activateAs(classType: string): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Demande que l’objet OLE exécute l’un de ses verbes disponibles.

doVerb(verbIndex: Word.OleVerb): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Demande que l’objet OLE exécute l’un de ses verbes disponibles.

doVerb(verbIndex: "Primary" | "Show" | "Open" | "Hide" | "UiActivate" | "InPlaceActivate" | "DiscardUndoState"): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Ouvre l’objet OLE pour modification dans l’application dans laquelle il a été créé.

edit(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Word.Interfaces.OleFormatLoadOptions): Word.OleFormat;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

Retours

Ouvre l’objet OleFormat .

open(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

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

Paramètres

Retours

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Word.OleFormat): void;

Paramètres

Retours

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.OleFormat est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.OleFormatDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Word.Interfaces.OleFormatData;

Retours

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run », et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.OleFormat;

Retours

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la mise en production de la mémoire ne prenne effet.

untrack(): Word.OleFormat;

Retours