Word.Border class

Spécifie la couleur de la bordure. La couleur est spécifiée au format « #RRGGBB » ou en utilisant le nom de la couleur.

color: string;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.1

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/border-properties.yaml

// Sets the bottom border color to red.
await Word.run(async (context) => {
  const style: Word.Style = context.document.getStyles().getByName("Bordered Text");
  const border: Word.Border = style.borders.getByLocation(Word.BorderLocation.bottom);

  border.color = "red";
  await context.sync();
});

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é

Récupère l’emplacement de la bordure.

readonly location: Word.BorderLocation | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All";

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.1

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/border-properties.yaml

// Gets the location of the border in its border collection.
await Word.run(async (context) => {
  const style: Word.Style = context.document.getStyles().getByName("Bordered Text");
  const border: Word.Border = style.borders.getByLocation(Word.BorderLocation.bottom);
  border.load("location");
  await context.sync();

  console.log(`Border location: ${border.location}`);
});

Spécifie le type de bordure de la bordure.

type: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.1

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/border-properties.yaml

// Sets the bottom border type to a dashed line.
await Word.run(async (context) => {
  const style: Word.Style = context.document.getStyles().getByName("Bordered Text");
  const border: Word.Border = style.borders.getByLocation(Word.BorderLocation.bottom);

  border.type = Word.BorderType.dashed;
  await context.sync();
});

Indique si la bordure est visible.

visible: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.1

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/border-properties.yaml

// Hides the bottom border.
await Word.run(async (context) => {
  const style: Word.Style = context.document.getStyles().getByName("Bordered Text");
  const border: Word.Border = style.borders.getByLocation(Word.BorderLocation.bottom);

  border.visible = false;
  await context.sync();
});

Spécifie la largeur de la bordure.

width: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.1

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/border-properties.yaml

// Sets the bottom border width to 4.5 points.
await Word.run(async (context) => {
  const style: Word.Style = context.document.getStyles().getByName("Bordered Text");
  const border: Word.Border = style.borders.getByLocation(Word.BorderLocation.bottom);

  border.width = Word.BorderWidth.pt450;
  await context.sync();
});

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?: Word.Interfaces.BorderLoadOptions): Word.Border;

Paramètres

Retours

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[]): Word.Border;

Paramètres

Retours

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

Paramètres

Retours

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.BorderUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

Retours

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Word.Border): void;

Paramètres

Retours

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

toJSON(): Word.Interfaces.BorderData;

Retours

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/border-properties.yaml

// Loads all scalar properties and returns them as a plain JavaScript object.
await Word.run(async (context) => {
  const style: Word.Style = context.document.getStyles().getByName("Bordered Text");
  const border: Word.Border = style.borders.getByLocation(Word.BorderLocation.bottom);
  border.load("color, location, type, visible, width");
  await context.sync();

  console.log("Border properties:", border.toJSON());
});

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet entre des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run » et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivis lors de la création initiale de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.Border;

Retours

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est l’abréviation de context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la libération de mémoire prenne effet.

untrack(): Word.Border;

Retours