PowerPoint.ShapeLineFormat class

Paquet:: powerpoint

Représente la mise en forme de ligne pour l’objet forme. Pour les images et les formes géométriques, la mise en forme des lignes représente la bordure de la forme.

Extends: OfficeExtension.ClientObject

Remarques

Jeu d’API : PowerPointApi 1.4

Utilisateur

PowerPoint.Shape : lineFormat

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-shapes-by-type.yaml

// Changes the dash style of every line in the slide.
await PowerPoint.run(async (context) => {
  // Get the type of shape for every shape in the collection.
  const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
  shapes.load("type");
  await context.sync();

  // Change the dash style for shapes of the type `line`.
  shapes.items.forEach((shape) => {
    if (shape.type === PowerPoint.ShapeType.line) {
      shape.lineFormat.style = PowerPoint.ShapeLineStyle.thickThin;
      shape.lineFormat.dashStyle = PowerPoint.ShapeLineDashStyle.dashDot;
    }
  });
  await context.sync();
});

Propriétés

color	Représente la couleur de ligne au format de couleur HTML, sous la forme #RRGGBB (par exemple, « FFA500 ») ou sous la forme d’une couleur HTML nommée (par exemple, « orange »).
context	Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
dashStyle	Représente le style de tiret de la ligne. Renvoie null lorsque la ligne n’est pas visible ou que les styles de tiret sont incohérents. Pour plus d’informations , voir PowerPoint.ShapeLineDashStyle .
style	Représente le style de trait de la forme. Renvoie null lorsque la ligne n’est pas visible ou que les styles sont incohérents. Pour plus d’informations , consultez PowerPoint.ShapeLineStyle .
transparency	Spécifie le pourcentage de transparence de la ligne sous la forme d’une valeur comprise entre 0,0 (opaque) et 1,0 (clair). Renvoie la valeur null lorsque la forme a des transparences incohérentes.
visible	Spécifie si la mise en forme de ligne d’un élément de forme est visible. Revient `null` lorsque la forme présente des visibilités incohérentes.
weight	Représente l’épaisseur de ligne, en points. Renvoie `null` lorsque la ligne n’est pas visible ou que les épaisseurs de ligne sont incohérentes.

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

Détails de la propriété

color

Représente la couleur de ligne au format de couleur HTML, sous la forme #RRGGBB (par exemple, « FFA500 ») ou sous la forme d’une couleur HTML nommée (par exemple, « orange »).

color: string;

Valeur de propriété

string

Remarques

Jeu d’API : PowerPointApi 1.4

context

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é

PowerPoint.RequestContext

dashStyle

Représente le style de tiret de la ligne. Renvoie null lorsque la ligne n’est pas visible ou que les styles de tiret sont incohérents. Pour plus d’informations , voir PowerPoint.ShapeLineDashStyle .

dashStyle: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";

Valeur de propriété

Remarques

Jeu d’API : PowerPointApi 1.4

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-shapes-by-type.yaml

// Changes the dash style of every line in the slide.
await PowerPoint.run(async (context) => {
  // Get the type of shape for every shape in the collection.
  const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
  shapes.load("type");
  await context.sync();

  // Change the dash style for shapes of the type `line`.
  shapes.items.forEach((shape) => {
    if (shape.type === PowerPoint.ShapeType.line) {
      shape.lineFormat.style = PowerPoint.ShapeLineStyle.thickThin;
      shape.lineFormat.dashStyle = PowerPoint.ShapeLineDashStyle.dashDot;
    }
  });
  await context.sync();
});

style

Représente le style de trait de la forme. Renvoie null lorsque la ligne n’est pas visible ou que les styles sont incohérents. Pour plus d’informations , consultez PowerPoint.ShapeLineStyle .

style: PowerPoint.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin";

Valeur de propriété

Remarques

Jeu d’API : PowerPointApi 1.4

transparency

Spécifie le pourcentage de transparence de la ligne sous la forme d’une valeur comprise entre 0,0 (opaque) et 1,0 (clair). Renvoie la valeur null lorsque la forme a des transparences incohérentes.

transparency: number;

Valeur de propriété

number

Remarques

Jeu d’API : PowerPointApi 1.4

visible

Spécifie si la mise en forme de ligne d’un élément de forme est visible. Revient null lorsque la forme présente des visibilités incohérentes.

visible: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : PowerPointApi 1.4

weight

Représente l’épaisseur de ligne, en points. Renvoie null lorsque la ligne n’est pas visible ou que les épaisseurs de ligne sont incohérentes.

weight: number;

Valeur de propriété

number

Remarques

Jeu 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.ShapeLineFormatLoadOptions): PowerPoint.ShapeLineFormat;

Paramètres

options: PowerPoint.Interfaces.ShapeLineFormatLoadOptions

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

Retours

PowerPoint.ShapeLineFormat

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

Paramètres

propertyNames: string | string[]

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

Retours

PowerPoint.ShapeLineFormat

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

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

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.ShapeLineFormat est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) PowerPoint.Interfaces.ShapeLineFormatDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): PowerPoint.Interfaces.ShapeLineFormatData;

Retours

PowerPoint.Interfaces.ShapeLineFormatData

Commentaires

Cette page a-t-elle été utile ?