Word.Font class

Indique si la police est mise en forme comme toutes les lettres majuscules, ce qui fait apparaître les lettres minuscules comme des lettres majuscules. Les valeurs possibles sont les suivantes :

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

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

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

allCaps: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Indique si la police est en gras. true Si la police est mise en forme en gras, sinon, false.

bold: boolean;

Valeur de propriété

Remarques

Jeu 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.');
});

Indique si la police est mise en forme en gras dans un document linguistique de droite à gauche. Les valeurs possibles sont les suivantes :

• true : tout le texte est en gras.

• false : aucun texte n’est en gras.

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

boldBidirectional: boolean;

Valeur de propriété

Remarques

Jeu 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

Jeu 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

Jeu 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

Jeu d’API : WordApiDesktop 1.3

Spécifie la couleur de l’objet Font dans un document dans un document dans une langue 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

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

contextualAlternates: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

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

diacriticColor: string;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

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

disableCharacterSpaceGrid: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Indique si la police est doublement barrée. true Si la police est mise en forme en tant que texte barré double, sinon, false.

doubleStrikeThrough: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.1

Indique si la police est mise en forme de manière à être gaufrée. Les valeurs possibles sont les suivantes :

• true : tout le texte est en relief.

• false : aucun texte n’est gaufré.

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

emboss: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Indique une EmphasisMark valeur qui représente l’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

Jeu d’API : WordApiDesktop 1.3

Indique si la police est mise en forme comme gravée. Les valeurs possibles sont les suivantes :

• true : Tout le texte est gravé.

• false : Aucun texte n’est gravé.

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

engrave: boolean;

Valeur de propriété

Remarques

Jeu 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

Jeu d’API : WordApiDesktop 1.3

Renvoie un GlowFormat objet qui représente la mise en forme d’éclat pour la police utilisée par la plage de texte.

readonly glow: Word.GlowFormat;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Indique si la police est marquée comme masquée. true Si la police est formatée en tant que texte masqué, sinon, false.

hidden: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Indique la couleur de surbrillance. Pour la définir, utilisez une valeur au format « #RRGGBB » ou le nom de la couleur. Pour supprimer la couleur en surbrillance, définissez-la sur null. La couleur de surbrillance renvoyée peut être au format « #RRGGBB », une chaîne vide pour les couleurs de surbrillance mixtes ou null pour aucune couleur de surbrillance. Remarque : Seules les couleurs de surbrillance par défaut sont disponibles dans Office pour Windows Desktop. Il s’agit de « Jaune », « Citron vert », « Turquoise », « Rose », « Bleu », « Rouge », « Bleu foncé », « Sarcelle », « Vert », « Violet », « Rouge foncé », « Olive », « Gris », « Gris clair » et « Noir ». Lorsque le complément est exécuté dans Office pour Windows Desktop, toute autre couleur est convertie dans la couleur la plus proche lorsqu’elle est appliquée à la police.

highlightColor: string;

Valeur de propriété

Remarques

Jeu 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.');
});

Indique si la police est en italique. true Si la police est en italique, sinon, false.

italic: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.1

Indique si la police est en italique dans un document dans une 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 : renvoyé si une partie, mais pas la totalité, du texte est en italique.

italicBidirectional: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

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

kerning: number;

Valeur de propriété

Remarques

Jeu 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

Jeu d’API : WordApiDesktop 1.3

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

readonly line: Word.LineFormat;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie le nom de la police.

name: string;

Valeur de propriété

Remarques

Jeu 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.');
});

Indique la police utilisée pour le texte latin (caractères dont les codes de caractère sont compris entre 0 (zéro) et 127).

nameAscii: string;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

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

nameBidirectional: string;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

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

nameFarEast: string;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie la police utilisée pour les caractères dont le code est compris entre 128 et 255.

nameOther: string;

Valeur de propriété

Remarques

Jeu 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

Jeu d’API : WordApiDesktop 1.3

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

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

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Indique si la police est mise en forme comme décrit. Les valeurs possibles sont les suivantes :

• true : Tout le texte est décrit.

• false : aucune partie du texte n’est mise en ligne.

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

outline: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Indique la position du texte (en points) par rapport à la ligne de base.

position: number;

Valeur de propriété

Remarques

Jeu 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

Jeu d’API : WordApiDesktop 1.3

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

scaling: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

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

• true : tout le texte est ombragé.

• false : aucun texte n’est ombragé.

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

shadow: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Indique la taille de police en points.

size: number;

Valeur de propriété

Remarques

Jeu 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

Jeu d’API : WordApiDesktop 1.3

Indique si la police est formatée sous forme de petites majuscules, ce qui fait apparaître les lettres minuscules comme de petites 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 : renvoyé si une partie, mais pas la totalité, du texte a l’attribut Petites majuscules .

smallCaps: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

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

spacing: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Indique si la police est barrée. true Si la police est mise en forme en tant que texte barré, sinon, false.

strikeThrough: boolean;

Valeur de propriété

Remarques

Jeu 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

Jeu d’API : WordApiDesktop 1.3

Indique si la police est un indice. true Si la police est mise en indice, sinon, false.

subscript: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApi 1.1

Indique si la police est un exposant. true Si la police est en exposant, sinon, false.

superscript: boolean;

Valeur de propriété

Remarques

Jeu 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

Jeu d’API : WordApiDesktop 1.3

Renvoie un ShadowFormat objet qui spécifie la mise en forme d’ombre de la police.

readonly textShadow: Word.ShadowFormat;

Valeur de propriété

Remarques

Jeu 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

Jeu d’API : WordApiDesktop 1.3

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/apply-bevel-to-text.yaml

if (!Office.context.requirements.isSetSupported("WordApiDesktop", "1.3")) {
  console.error("This sample requires WordApiDesktop 1.3 or later.");
  return;
}

await Word.run(async (context) => {
  const paragraph: Word.Paragraph = context.document.body.insertParagraph(
    "Beveled text",
    Word.InsertLocation.start,
  );
  paragraph.font.size = 48;
  paragraph.font.bold = true;

  const threeDimensionalFormat: Word.ThreeDimensionalFormat = paragraph.font.threeDimensionalFormat;
  threeDimensionalFormat.isVisible = true;
  threeDimensionalFormat.bevelTopType = Word.BevelType.circle;
  threeDimensionalFormat.bevelTopDepth = 6;
  threeDimensionalFormat.bevelTopInset = 6;
  threeDimensionalFormat.load("bevelTopType,bevelTopDepth,bevelTopInset");

  await context.sync();

  console.log("Applied bevel formatting:", {
    type: threeDimensionalFormat.bevelTopType,
    depth: threeDimensionalFormat.bevelTopDepth,
    inset: threeDimensionalFormat.bevelTopInset,
  });
});

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

Jeu 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 pour l’objet Font . Vous pouvez fournir la valeur au format '#RRGGBB'.

underlineColor: string;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

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

decreaseFontSize(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

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

increaseFontSize(): 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.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

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

Jeu 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 simple (typé ) Word.Interfaces.FontDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir 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 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.Font;

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

Retours