Partager via

Word.Font class

  • Référence
Paquet:
word

Représente une police.

Extends
OfficeExtension.ClientObject

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

Propriétés

bold

Spécifie une valeur qui indique si la police est en gras. Renvoie true si la police est mise en forme en gras, sinon, false.
color

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

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

Spécifie une valeur qui indique si la police a un double barré. Renvoie true si la police est mise en forme en tant que texte barré double, sinon, false.
highlightColor

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 surlignage, 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.
italic

Spécifie une valeur qui indique si la police est en italique. Renvoie true si la police est en italique, sinon, false.
name

Spécifie une valeur qui représente le nom de la police.
size

Spécifie une valeur qui représente la taille de police en points.
strikeThrough

Spécifie une valeur qui indique si la police a un barré. Renvoie true si la police est mise en forme en tant que texte barré, sinon, false.
subscript

Spécifie une valeur qui indique si la police est un indice. Renvoie true si la police correspond à du texte mis en indice, sinon, false.
superscript

Spécifie une valeur qui indique si la police est un exposant. Renvoie true si la police correspond à du texte mis en exposant, sinon, false.
underline

Spécifie une valeur qui indique le type de soulignement de la police. 'None' si la police n’est pas soulignée.

Méthodes

load(options)

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)

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)

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.
set(properties, options)

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)

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

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.
track()

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.
untrack()

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.

Détails de la propriété

bold

Spécifie une valeur qui indique si la police est en gras. Renvoie true si la police est mise en forme en gras, sinon, false.

bold: boolean;

Valeur de propriété

boolean

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

color

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

color: string;

Valeur de propriété

string

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

context

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é

Word.RequestContext

doubleStrikeThrough

Spécifie une valeur qui indique si la police a un double barré. Renvoie true si la police est mise en forme en tant que texte barré double, sinon, false.

doubleStrikeThrough: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.1 ]

highlightColor

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 surlignage, 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é

string

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

italic

Spécifie une valeur qui indique si la police est en italique. Renvoie true si la police est en italique, sinon, false.

italic: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.1 ]

name

Spécifie une valeur qui représente le nom de la police.

name: string;

Valeur de propriété

string

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

size

Spécifie une valeur qui représente la taille de police en points.

size: number;

Valeur de propriété

number

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

strikeThrough

Spécifie une valeur qui indique si la police a un barré. Renvoie true si la police est mise en forme en tant que texte barré, sinon, false.

strikeThrough: boolean;

Valeur de propriété

boolean

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

subscript

Spécifie une valeur qui indique si la police est un indice. Renvoie true si la police correspond à du texte mis en indice, sinon, false.

subscript: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.1 ]

superscript

Spécifie une valeur qui indique si la police est un exposant. Renvoie true si la police correspond à du texte mis en exposant, sinon, false.

superscript: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.1 ]

underline

Spécifie une valeur qui indique 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é

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

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

Détails de la méthode

load(options)

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

options
Word.Interfaces.FontLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Word.Font

load(propertyNames)

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

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

Word.Font

load(propertyNamesAndPaths)

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

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Word.Font

set(properties, options)

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

properties
Word.Interfaces.FontUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet properties tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

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

properties
Word.Font

Retours

void

toJSON()

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

Word.Interfaces.FontData

track()

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

Word.Font

untrack()

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

Word.Font