Word.Font class

Spécifie si la police est mise en forme comme toutes les lettres majuscules, ce qui fait apparaître les lettres minuscules sous forme de lettres majuscules. Les valeurs possibles sont les suivantes :

• true : tout le texte a l’attribut Toutes les majuscules .

• false : aucun du texte n’a l’attribut Toutes les majuscules .

• null : retourné si une partie, mais pas la totalité, du texte a l’attribut Toutes les majuscules .

allCaps: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie si la police est en gras. true si la police est mise en gras ; sinon, false.

bold: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Exemples

// Bold format text
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to make the current selection bold.
    selection.font.bold = true;

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The selection is now bold.');
});

Spécifie si la police est mise en gras dans un document de langue de droite à gauche. Les valeurs possibles sont les suivantes :

• true : tout le texte est en gras.

• false : aucun texte n’est en gras.

• null : retourné si une partie, mais pas la totalité, du texte est en gras.

boldBidirectional: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Renvoie un BorderUniversalCollection objet qui représente toutes les bordures de la police.

readonly borders: Word.BorderUniversalCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie la couleur de la police. Vous pouvez fournir la valeur au format « #RRGGBB » ou le nom de la couleur.

color: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Exemples

// Change the font color
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to change the font color of the current selection.
    selection.font.color = 'blue';

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The font color of the selection has been changed.');
});

Spécifie une ColorIndex valeur qui représente la couleur de la police.

colorIndex: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor";

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie la couleur de l’objet Font dans un document linguistique de droite à gauche.

colorIndexBidirectional: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor";

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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 si les alternatives contextuelles sont activées pour la police.

contextualAlternates: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie la couleur à utiliser pour les signes diacritiques de l’objet Font . Vous pouvez fournir la valeur au format « #RRGGBB ».

diacriticColor: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie si Microsoft Word ignore le nombre de caractères par ligne pour l’objet correspondantFont.

disableCharacterSpaceGrid: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie si la police a un double barré. true si la police est mise en forme en tant que texte barré double ; sinon, false.

doubleStrikeThrough: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Spécifie si la police est mise en relief. Les valeurs possibles sont les suivantes :

• true : tout le texte est en relief.

• false : aucun texte n’est en relief.

• null : retourné si une partie, mais pas la totalité, du texte est en relief.

emboss: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie une EmphasisMark valeur qui représente la marque d’accentuation d’un caractère ou d’une chaîne de caractères désignée.

emphasisMark: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle";

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie si la police est au format gravé. Les valeurs possibles sont les suivantes :

• true : tout le texte est gravé.

• false : aucun texte n’est gravé.

• null : retourné si une partie, mais pas la totalité, du texte est gravée.

engrave: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Renvoie un FillFormat objet qui contient des propriétés de mise en forme de remplissage pour la police utilisée par la plage de texte.

readonly fill: Word.FillFormat;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Renvoie un GlowFormat objet qui représente la mise en forme de la lumière pour la police utilisée par la plage de texte.

readonly glow: Word.GlowFormat;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie si la police est marquée comme masquée. true si la police est mise en forme en tant que texte masqué ; sinon, false.

hidden: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

Spécifie la couleur de surbrillance. Pour la définir, utilisez une valeur au format « #RRGGBB » ou au nom de la couleur. Pour supprimer la couleur de surbrillance, définissez-la sur null. La couleur de surlignage retournée peut être au format « #RRGGBB », une chaîne vide pour les couleurs de surlignage mixtes ou null sans couleur de surbrillance. Remarque : Seules les couleurs de surbrillance par défaut sont disponibles dans Office pour Windows Desktop. Il s’agit de « Yellow », « Lime », « Turquoise », « Pink », « Blue », « Red », « DarkBlue », « Teal », « Green », « Purple », « DarkRed », « Olive », « Gray », « LightGray » et « Black ». Lorsque le complément s’exécute dans Office pour Windows Desktop, toute autre couleur est convertie en couleur la plus proche lorsqu’elle est appliquée à la police.

highlightColor: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Exemples

// Highlight selected text
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to highlight the current selection.
    selection.font.highlightColor = '#FFFF00'; // Yellow

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The selection has been highlighted.');
});

Spécifie si la police est en italique. true si la police est en italique ; sinon, false.

italic: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Spécifie si la police est en italique dans un document de langue de droite à gauche. Les valeurs possibles sont les suivantes :

• true : tout le texte est en italique.

• false : aucun texte n’est en italique.

• null : retourné si une partie, mais pas la totalité, du texte est en italique.

italicBidirectional: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie la taille de police minimale pour laquelle Microsoft Word ajustera automatiquement le crénage.

kerning: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie le paramètre de ligature de l’objet Font .

ligature: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All";

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Retourne un LineFormat objet qui spécifie la mise en forme d’une ligne.

readonly line: Word.LineFormat;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie le nom de la police.

name: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Exemples

// Change the font name
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to change the current selection's font name.
    selection.font.name = 'Arial';

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The font name has changed.');
});

Spécifie la police utilisée pour le texte latin (caractères avec des codes de caractères compris entre 0 (zéro) et 127).

nameAscii: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie le nom de la police dans un document de langue de droite à gauche.

nameBidirectional: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie le nom de la police d’Asie de l’Est.

nameFarEast: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie la police utilisée pour les caractères dont les codes sont compris entre 128 et 255.

nameOther: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie le paramètre de feuille de nombres pour une police OpenType.

numberForm: Word.NumberForm | "Default" | "Lining" | "OldStyle";

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie le paramètre d’espacement numérique pour la police.

numberSpacing: Word.NumberSpacing | "Default" | "Proportional" | "Tabular";

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie si la police est au format hiérarchique. Les valeurs possibles sont les suivantes :

• true : tout le texte est encadré.

• false : aucun texte n’est encadré.

• null : retourné si une partie, mais pas la totalité, du texte est encadrée.

outline: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie la position du texte (en points) par rapport à la ligne de base.

position: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Renvoie un ReflectionFormat objet qui représente la mise en forme de réflexion d’une forme.

readonly reflection: Word.ReflectionFormat;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie le pourcentage de mise à l’échelle appliqué à la police.

scaling: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie si la police est au format ombré. Les valeurs possibles sont les suivantes :

• true : tout le texte est ombré.

• false : aucun texte n’est ombré.

• null : retourné si une partie, mais pas la totalité, du texte est ombrée.

shadow: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie la taille de police en points.

size: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Exemples

// Change the font size
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to change the current selection's font size.
    selection.font.size = 20;

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The font size has changed.');
});

Spécifie la taille de police en points pour le texte de droite à gauche.

sizeBidirectional: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie si la police est mise en forme en petites majuscules, ce qui fait apparaître les lettres minuscules sous forme de lettres majuscules. Les valeurs possibles sont les suivantes :

• true : tout le texte a l’attribut Petites majuscules .

• false : aucun texte n’a l’attribut Petites majuscules .

• null : retourné si une partie, mais pas la totalité, du texte a l’attribut Petites majuscules .

smallCaps: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie l’espacement entre les caractères.

spacing: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie si la police a un barré. true si la police est mise en forme en tant que texte barré ; sinon, false.

strikeThrough: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Exemples

// Strike format text
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to strikethrough the font of the current selection.
    selection.font.strikeThrough = true;

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The selection now has a strikethrough.');
});

Spécifie l’ensemble stylistique de la police.

stylisticSet: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20";

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie si la police est un indice. true si la police est au format indice ; sinon, false.

subscript: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Spécifie si la police est un exposant. true si la police est mise en forme en exposant ; sinon, false.

superscript: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Renvoie un ColorFormat objet qui représente la couleur de la police.

readonly textColor: Word.ColorFormat;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Retourne un ShadowFormat objet qui spécifie la mise en forme de l’ombre pour la police.

readonly textShadow: Word.ShadowFormat;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Renvoie un ThreeDimensionalFormat objet qui contient des propriétés de mise en forme d’effet 3D (3D) pour la police.

readonly threeDimensionalFormat: Word.ThreeDimensionalFormat;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie le type de soulignement de la police. none si la police n’est pas soulignée.

underline: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";

Valeur de propriété

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Exemples

// Underline format text
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to underline the current selection.
    selection.font.underline = Word.UnderlineType.single;

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The selection now has an underline style.');
});

Spécifie la couleur du soulignement de l’objet Font . Vous pouvez fournir la valeur au format « #RRGGBB ».

underlineColor: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Applique à la police la taille inférieure disponible la plus proche.

decreaseFontSize(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Applique à la police la taille supérieure disponible la plus proche.

increaseFontSize(): void;

Retours

Remarques

[ Ensemble 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.FontLoadOptions): Word.Font;

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

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

Paramètres

Retours

Supprime la mise en forme manuelle des caractères.

reset(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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.FontUpdateData, 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.Font): void;

Paramètres

Retours

Définit la mise en forme de caractères spécifiée comme valeur par défaut à la fois du document actif et de tous les nouveaux documents basés sur le modèle actif.

setAsTemplateDefault(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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.Font est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.FontDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Word.Interfaces.FontData;

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

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

Retours