Partager via


PowerPoint.ShapeFont class

Représente les attributs de police, tels que le nom de la police, la taille de police et la couleur, pour l’objet TextRange d’une forme.

Extends

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml

// Sets the color of the selected text range to green.
await PowerPoint.run(async (context) => {
  const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
  textRange.font.color = "green";
  await context.sync();
});

Propriétés

allCaps

Spécifie si le texte du TextRange est défini pour utiliser l’attribut All Caps , 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 .

bold

Spécifie si le texte du est TextRange défini en gras. 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.

color

Spécifie la représentation par code de couleur HTML de la couleur du texte (par exemple, « #FF0000 » représente le rouge). Retourne null si contient TextRange des fragments de texte de couleurs différentes.

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 si le texte du TextRange est défini pour utiliser l’attribut Double barré . Les valeurs possibles sont les suivantes :

  • true : tout le texte a l’attribut Double barré .

  • false : aucun texte n’a l’attribut Double barré .

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

italic

Spécifie si le texte du est TextRange défini en italique. 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.

name

Spécifie le nom de la police (par exemple, « Calibri »). Si le texte est un script complexe ou une langue d’Asie de l’Est, il s’agit du nom de police correspondant ; sinon, il s’agit du nom de la police latine. Retourne null si contient des fragments de TextRange texte avec des noms de police différents.

size

Spécifie la taille de police en points (par exemple, 11). Retourne null si contient TextRange des fragments de texte avec des tailles de police différentes.

smallCaps

Spécifie si le texte du TextRange est défini pour utiliser l’attribut Petites majuscules qui fait apparaître les lettres minuscules en minuscules 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 .

strikethrough

Spécifie si le texte du est TextRange défini pour utiliser l’attribut Strikethrough . Les valeurs possibles sont les suivantes :

  • true : tout le texte a l’attribut Strikethrough .

  • false : aucun texte n’a l’attribut Strikethrough .

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

subscript

Spécifie si le texte du TextRange est défini pour utiliser l’attribut Indice . Les valeurs possibles sont les suivantes :

  • true : tout le texte a l’attribut Indice .

  • false : aucun texte n’a l’attribut Indice .

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

superscript

Spécifie si le texte du est TextRange défini pour utiliser l’attribut Superscript . Les valeurs possibles sont les suivantes :

  • true : tout le texte a l’attribut Superscript .

  • false : aucun du texte n’a l’attribut Superscript .

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

underline

Spécifie le type de soulignement appliqué à la police. Retourne null si contient des fragments de TextRange texte avec différents styles de soulignement. Pour plus d’informations , voir PowerPoint.ShapeFontUnderlineStyle .

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.

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

Détails de la propriété

allCaps

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Spécifie si le texte du TextRange est défini pour utiliser l’attribut All Caps , 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 | null;

Valeur de propriété

boolean | null

Remarques

[ Ensemble d’API : PowerPointApi BETA (PRÉVERSION UNIQUEMENT) ]

bold

Spécifie si le texte du est TextRange défini en gras. 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.

bold: boolean | null;

Valeur de propriété

boolean | null

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

color

Spécifie la représentation par code de couleur HTML de la couleur du texte (par exemple, « #FF0000 » représente le rouge). Retourne null si contient TextRange des fragments de texte de couleurs différentes.

color: string | null;

Valeur de propriété

string | null

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml

// Sets the color of the selected text range to green.
await PowerPoint.run(async (context) => {
  const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
  textRange.font.color = "green";
  await context.sync();
});

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é

doubleStrikethrough

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Spécifie si le texte du TextRange est défini pour utiliser l’attribut Double barré . Les valeurs possibles sont les suivantes :

  • true : tout le texte a l’attribut Double barré .

  • false : aucun texte n’a l’attribut Double barré .

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

doubleStrikethrough: boolean | null;

Valeur de propriété

boolean | null

Remarques

[ Ensemble d’API : PowerPointApi BETA (PRÉVERSION UNIQUEMENT) ]

italic

Spécifie si le texte du est TextRange défini en italique. 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.

italic: boolean | null;

Valeur de propriété

boolean | null

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

name

Spécifie le nom de la police (par exemple, « Calibri »). Si le texte est un script complexe ou une langue d’Asie de l’Est, il s’agit du nom de police correspondant ; sinon, il s’agit du nom de la police latine. Retourne null si contient des fragments de TextRange texte avec des noms de police différents.

name: string | null;

Valeur de propriété

string | null

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

size

Spécifie la taille de police en points (par exemple, 11). Retourne null si contient TextRange des fragments de texte avec des tailles de police différentes.

size: number | null;

Valeur de propriété

number | null

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

smallCaps

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Spécifie si le texte du TextRange est défini pour utiliser l’attribut Petites majuscules qui fait apparaître les lettres minuscules en minuscules 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 | null;

Valeur de propriété

boolean | null

Remarques

[ Ensemble d’API : PowerPointApi BETA (PRÉVERSION UNIQUEMENT) ]

strikethrough

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Spécifie si le texte du est TextRange défini pour utiliser l’attribut Strikethrough . Les valeurs possibles sont les suivantes :

  • true : tout le texte a l’attribut Strikethrough .

  • false : aucun texte n’a l’attribut Strikethrough .

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

strikethrough: boolean | null;

Valeur de propriété

boolean | null

Remarques

[ Ensemble d’API : PowerPointApi BETA (PRÉVERSION UNIQUEMENT) ]

subscript

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Spécifie si le texte du TextRange est défini pour utiliser l’attribut Indice . Les valeurs possibles sont les suivantes :

  • true : tout le texte a l’attribut Indice .

  • false : aucun texte n’a l’attribut Indice .

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

subscript: boolean | null;

Valeur de propriété

boolean | null

Remarques

[ Ensemble d’API : PowerPointApi BETA (PRÉVERSION UNIQUEMENT) ]

superscript

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Spécifie si le texte du est TextRange défini pour utiliser l’attribut Superscript . Les valeurs possibles sont les suivantes :

  • true : tout le texte a l’attribut Superscript .

  • false : aucun du texte n’a l’attribut Superscript .

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

superscript: boolean | null;

Valeur de propriété

boolean | null

Remarques

[ Ensemble d’API : PowerPointApi BETA (PRÉVERSION UNIQUEMENT) ]

underline

Spécifie le type de soulignement appliqué à la police. Retourne null si contient des fragments de TextRange texte avec différents styles de soulignement. Pour plus d’informations , voir PowerPoint.ShapeFontUnderlineStyle .

underline: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null;

Valeur de propriété

PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

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?: PowerPoint.Interfaces.ShapeFontLoadOptions): PowerPoint.ShapeFont;

Paramètres

options
PowerPoint.Interfaces.ShapeFontLoadOptions

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

Retours

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[]): PowerPoint.ShapeFont;

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

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;
        }): PowerPoint.ShapeFont;

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

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

toJSON(): PowerPoint.Interfaces.ShapeFontData;

Retours