Word.TableStyle class

  • Référence
Paquet:
word

Représente l’objet TableStyle.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : WordApi 1.6 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/manage-custom-style.yaml

// Gets the table style properties and displays them in the form.
const styleName = $("#style-name")
  .val()
  .toString();
if (styleName == "") {
  console.warn("Please input a table style name.");
  return;
}

await Word.run(async (context) => {
  const tableStyle = context.document.getStyles().getByName(styleName).tableStyle;
  tableStyle.load();
  await context.sync();

  if (tableStyle.isNullObject) {
    console.warn(`There's no existing table style with the name '${styleName}'.`);
    return;
  }

  console.log(tableStyle);
  $("#alignment").val(tableStyle.alignment);
  $("#allow-break-across-page").val(tableStyle.allowBreakAcrossPage.toString());
  $("#top-cell-margin").val(tableStyle.topCellMargin);
  $("#bottom-cell-margin").val(tableStyle.bottomCellMargin);
  $("#left-cell-margin").val(tableStyle.leftCellMargin);
  $("#right-cell-margin").val(tableStyle.rightCellMargin);
  $("#cell-spacing").val(tableStyle.cellSpacing);
});

Propriétés

alignment

Spécifie l’alignement de la table par rapport à la marge de page.
allowBreakAcrossPage

Spécifie si les lignes des tableaux sont mises en forme avec un saut de style spécifié sur les pages.
bottomCellMargin

Spécifie la quantité d’espace à ajouter entre le contenu et les bordures inférieures des cellules.
cellSpacing

Spécifie l’espacement (en points) entre les cellules dans un style de tableau.
context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
leftCellMargin

Spécifie la quantité d’espace à ajouter entre le contenu et les bordures gauches des cellules.
rightCellMargin

Spécifie la quantité d’espace à ajouter entre le contenu et les bordures droites des cellules.
topCellMargin

Spécifie la quantité d’espace à ajouter entre le contenu et les bordures supérieures des cellules.

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 passer un objet brut avec les propriétés appropriées ou 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.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que le Word d’origine. L’objet TableStyle est un objet API. La toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.TableStyleDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
track()

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 sur 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 suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.
untrack()

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour 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 mise en production de la mémoire ne prenne effet.

Détails de la propriété

alignment

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Spécifie l’alignement de la table par rapport à la marge de page.

alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";

Valeur de propriété

Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

allowBreakAcrossPage

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Spécifie si les lignes des tableaux sont mises en forme avec un saut de style spécifié sur les pages.

allowBreakAcrossPage: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi BETA (PRÉVERSION UNIQUEMENT) ]

bottomCellMargin

Spécifie la quantité d’espace à ajouter entre le contenu et les bordures inférieures des cellules.

bottomCellMargin: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.6 ]

cellSpacing

Spécifie l’espacement (en points) entre les cellules dans un style de tableau.

cellSpacing: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.6 ]

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é

Word.RequestContext

leftCellMargin

Spécifie la quantité d’espace à ajouter entre le contenu et les bordures gauches des cellules.

leftCellMargin: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.6 ]

rightCellMargin

Spécifie la quantité d’espace à ajouter entre le contenu et les bordures droites des cellules.

rightCellMargin: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.6 ]

topCellMargin

Spécifie la quantité d’espace à ajouter entre le contenu et les bordures supérieures des cellules.

topCellMargin: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.6 ]

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?: Word.Interfaces.TableStyleLoadOptions): Word.TableStyle;

Paramètres

options
Word.Interfaces.TableStyleLoadOptions

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

Retours

Word.TableStyle

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

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

Word.TableStyle

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

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

Word.TableStyle

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

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

Paramètres

properties
Word.Interfaces.TableStyleUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des 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 properties 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: Word.TableStyle): void;

Paramètres

properties
Word.TableStyle

Retours

void

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que le Word d’origine. L’objet TableStyle est un objet API. La toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.TableStyleDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Word.Interfaces.TableStyleData;

Retours

Word.Interfaces.TableStyleData

track()

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 sur 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 suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.TableStyle;

Retours

Word.TableStyle

untrack()

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour 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 mise en production de la mémoire ne prenne effet.

untrack(): Word.TableStyle;

Retours

Word.TableStyle