Word.Frame class

Renvoie un BorderUniversalCollection objet qui représente toutes les bordures du cadre.

readonly borders: Word.BorderUniversalCollection;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Spécifie la hauteur (en points) de l’image.

height: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie une FrameSizeRule valeur qui représente la règle pour déterminer la hauteur du cadre.

heightRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact";

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie la distance horizontale entre le cadre et le texte environnant, en points.

horizontalDistanceFromText: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie la distance horizontale entre le bord du cadre et l’élément spécifié par la relativeHorizontalPosition propriété.

horizontalPosition: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Indique si le cadre est verrouillé.

lockAnchor: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Renvoie un Range objet qui représente la partie du document contenue dans le cadre.

readonly range: Word.Range;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie la position horizontale relative de l’image.

relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie la position verticale relative de l’image.

relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Renvoie un ShadingUniversal objet qui fait référence à la mise en forme d’ombrage de l’image.

readonly shading: Word.ShadingUniversal;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie si le texte du document est renvoyé à la ligne autour du cadre.

textWrap: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie la distance verticale (en points) entre le cadre et le texte environnant.

verticalDistanceFromText: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie la distance verticale entre le bord du cadre et l’élément spécifié par la relativeVerticalPosition propriété.

verticalPosition: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie la largeur (en points) du cadre.

width: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie la règle utilisée pour déterminer la largeur du cadre.

widthRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact";

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Copie le cadre dans le Presse-papiers.

copy(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

Supprime le cadre du document et le place dans le Presse-papiers.

cut(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

Supprime le cadre.

delete(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

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.FrameLoadOptions): Word.Frame;

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.Frame;

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.Frame;

Paramètres

Retours

Sélectionne le cadre.

select(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

set(properties: Interfaces.FrameUpdateData, 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.Frame): 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.Frame est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Word.Interfaces.FrameDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Word.Interfaces.FrameData;

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 entre 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 suivis lors de la création initiale de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.Frame;

Retours

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est l’abréviation de 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 libération de mémoire prenne effet.

untrack(): Word.Frame;

Retours