Partager via

PowerPoint.ShapeFont class

  • Référence
Paquet:
powerpoint

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

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

bold

Représente le format de police Gras. Retourne null si inclut des TextRange fragments de texte en gras et non gras.
color

Représentation par code de couleur HTML de la couleur du texte (par exemple, « #FF0000 » représente le rouge). Retourne null si inclut des TextRange 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.
italic

Représente le format de police Italique. Retourne « null » si « TextRange » inclut des fragments de texte italique et non italique.
name

Représente 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.
size

Représente la taille de police en points (par exemple, 11). Renvoie la valeur null si le TextRange inclut les fragments de texte avec les différentes couleurs.
underline

Type de soulignement appliqué à la police. Retourne null si inclut 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é

bold

Représente le format de police Gras. Retourne null si inclut des TextRange fragments de texte en gras et non gras.

bold: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

color

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

color: string;

Valeur de propriété

string

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é

PowerPoint.RequestContext

italic

Représente le format de police Italique. Retourne « null » si « TextRange » inclut des fragments de texte italique et non italique.

italic: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

name

Représente 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.

name: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

size

Représente la taille de police en points (par exemple, 11). Renvoie la valeur null si le TextRange inclut les fragments de texte avec les différentes couleurs.

size: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

underline

Type de soulignement appliqué à la police. Retourne null si inclut 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";

Valeur de propriété

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

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

PowerPoint.ShapeFont

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

PowerPoint.ShapeFont

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

PowerPoint.ShapeFont

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

PowerPoint.Interfaces.ShapeFontData