Excel.ShapeLineFormat class

Paquet:: excel

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 : ExcelApi 1.9

Utilisateur

Excel.Shape : lineFormat

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 trait de la forme. Renvoie `null` lorsque la ligne n’est pas visible ou que des styles de tiret sont incohérents. Pour `Excel.ShapeLineDashStyle` plus de détails.
style	Représente le style de trait de la forme. Renvoie `null` lorsque la ligne n’est pas visible ou que des styles sont incohérents. Pour `Excel.ShapeLineStyle` plus de détails.
transparency	Renvoie ou définit le degré de transparence du remplissage spécifié sous la forme d’une valeur comprise entre 0,0 (opaque) et 1,0 (transparent). Retourne `null` lorsque la forme présente 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.
set(properties, options)	Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit 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 `Excel.ShapeLineFormat` est un objet API, la `toJSON` méthode renvoie un objet JavaScript simple (typé ) `Excel.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 : ExcelApi 1.9

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é

Excel.RequestContext

dashStyle

Représente le style de trait de la forme. Renvoie null lorsque la ligne n’est pas visible ou que des styles de tiret sont incohérents. Pour Excel.ShapeLineDashStyle plus de détails.

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

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

style

Représente le style de trait de la forme. Renvoie null lorsque la ligne n’est pas visible ou que des styles sont incohérents. Pour Excel.ShapeLineStyle plus de détails.

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

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

transparency

Renvoie ou définit le degré de transparence du remplissage spécifié sous la forme d’une valeur comprise entre 0,0 (opaque) et 1,0 (transparent). Retourne null lorsque la forme présente des transparences incohérentes.

transparency: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.9

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 : ExcelApi 1.9

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-fill-and-line-formatting.yaml

await Excel.run(async (context) => {
    // Hide the shape's outline.
    const sheet = context.workbook.worksheets.getItem("Sample");
    const badge = sheet.shapes.getItem("Badge");
    const lineFormat: Excel.ShapeLineFormat = badge.lineFormat;
    lineFormat.visible = false;

    await context.sync();
});

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 : ExcelApi 1.9

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?: Excel.Interfaces.ShapeLineFormatLoadOptions): Excel.ShapeLineFormat;

Paramètres

options: Excel.Interfaces.ShapeLineFormatLoadOptions

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

Retours

Excel.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[]): Excel.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

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

Excel.ShapeLineFormat

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

set(properties: Interfaces.ShapeLineFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties: Excel.Interfaces.ShapeLineFormatUpdateData

Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux 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 de propriétés 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: Excel.ShapeLineFormat): void;

Paramètres

properties: Excel.ShapeLineFormat

Retours

void

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-fill-and-line-formatting.yaml

await Excel.run(async (context) => {
    // Apply outline formatting to the shape.
    const sheet = context.workbook.worksheets.getItem("Sample");
    const badge = sheet.shapes.getItem("Badge");
    const lineFormat: Excel.ShapeLineFormat = badge.lineFormat;
    lineFormat.set({
        color: "#C55A11",
        dashStyle: Excel.ShapeLineDashStyle.dashDotDot,
        style: Excel.ShapeLineStyle.thinThick,
        transparency: 0.2,
        visible: true,
        weight: 4
    });

    await context.sync();
});

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

toJSON(): Excel.Interfaces.ShapeLineFormatData;

Retours

Excel.Interfaces.ShapeLineFormatData

Commentaires

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