Partager via

PowerPoint.ShapeLineFormat class

  • Référence
Paquet:
powerpoint

Représente la mise en forme de trait pour l’objet shape. Pour les images et les formes géométriques, la mise en forme de trait représente la bordure de la 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/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.dashStyle = PowerPoint.ShapeLineDashStyle.dashDot;
    }
  });
  await context.sync();
});

Propriétés

color

Représente la couleur de trait 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 . Cela connecte le processus du complément au processus de l’application hôte Office.
dashStyle

Représente le style de tiret de la ligne. Renvoie null lors de la ligne n’est pas visible ou il existe des stylets tiret incohérents. Pour plus d’informations, voir PowerPoint.ShapeLineDashStyle.
style

Représente le style de trait de la forme. Renvoie null lors de la ligne n’est pas visible ou il existe des stylets tiret incohérents. Pour plus d’informations, voir 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. Retourne null lorsque la forme a des visibilités incohérentes.
weight

Représente l’épaisseur de ligne, en points. Retourne null lorsque la ligne n’est pas visible ou qu’il existe des pondérations de ligne 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 brut (typé en tant PowerPoint.Interfaces.ShapeLineFormatDataque ) 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é

color

Représente la couleur de trait 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

[ Ensemble d’API : PowerPointApi 1.4 ]

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

dashStyle

Représente le style de tiret de la ligne. Renvoie null lors de la ligne n’est pas visible ou il existe des stylets tiret 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é

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

Remarques

[ Ensemble 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.dashStyle = PowerPoint.ShapeLineDashStyle.dashDot;
    }
  });
  await context.sync();
});

style

Représente le style de trait de la forme. Renvoie null lors de la ligne n’est pas visible ou il existe des stylets tiret incohérents. Pour plus d’informations, voir PowerPoint.ShapeLineStyle.

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

Valeur de propriété

PowerPoint.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin"

Remarques

[ Ensemble 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

[ Ensemble d’API : PowerPointApi 1.4 ]

visible

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

visible: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

weight

Représente l’épaisseur de ligne, en points. Retourne null lorsque la ligne n’est pas visible ou qu’il existe des pondérations de ligne incohérentes.

weight: number;

Valeur de propriété

number

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.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 qui spécifient 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 brut (typé en tant PowerPoint.Interfaces.ShapeLineFormatDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): PowerPoint.Interfaces.ShapeLineFormatData;

Retours

PowerPoint.Interfaces.ShapeLineFormatData