Word.TableStyle class
Représente l’objet TableStyle .
- Extends
Remarques
[ Ensemble d’API : WordApi 1.6 ]
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-custom-style.yaml
// Gets the table style properties and displays them in the form.
const styleName = (document.getElementById("style-name") as HTMLInputElement).value;
if (styleName == "") {
console.warn("Please input a table style name.");
return;
}
await Word.run(async (context) => {
const tableStyle: Word.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);
(document.getElementById("alignment") as HTMLInputElement).value = tableStyle.alignment;
(document.getElementById("allow-break-across-page") as HTMLInputElement).value = tableStyle.allowBreakAcrossPage.toString();
(document.getElementById("top-cell-margin") as HTMLInputElement).value = tableStyle.topCellMargin;
(document.getElementById("bottom-cell-margin") as HTMLInputElement).value = tableStyle.bottomCellMargin;
(document.getElementById("left-cell-margin") as HTMLInputElement).value = tableStyle.leftCellMargin;
(document.getElementById("right-cell-margin") as HTMLInputElement).value = tableStyle.rightCellMargin;
(document.getElementById("cell-spacing") as HTMLInputElement).value = tableStyle.cellSpacing;
});
Propriétés
| alignment | Spécifie l’alignement de la table par rapport à la marge de page. |
| allow |
Spécifie si les lignes des tableaux sont mises en forme avec un saut de style entre les pages. |
| borders | Retourne un |
| bottom |
Spécifie la quantité d’espace à ajouter entre le contenu et les bordures inférieures des cellules. |
| cell |
Spécifie l’espacement (en points) entre les cellules dans un style de tableau. |
| column |
Spécifie le nombre de colonnes dans la bande lorsqu’un style spécifie la bande de colonnes impaires ou paires. |
| context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office. |
| is |
Spécifie si Microsoft Word permet d’interrompre la table spécifiée entre les pages. |
| left |
Spécifie la quantité d’espace à ajouter entre le contenu et les bordures gauches des cellules. |
| left |
Spécifie la valeur de retrait gauche (en points) pour les lignes du style de tableau. |
| right |
Spécifie la quantité d’espace à ajouter entre le contenu et les bordures droites des cellules. |
| row |
Spécifie le nombre de lignes à inclure dans le bandeau lorsque le style spécifie la bande impaire ou paire de lignes. |
| shading | Renvoie un |
| table |
Spécifie la direction dans laquelle Microsoft Word commande les cellules dans le style de tableau. |
| top |
Spécifie la quantité d’espace à ajouter entre le contenu et les bordures supérieures des cellules. |
Méthodes
| condition(condition |
Renvoie un objet qui représente une |
| condition(condition |
Renvoie un objet qui représente une |
| load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| 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 |
| 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 |
| 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 |
Détails de la propriété
alignment
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
allowBreakAcrossPage
Spécifie si les lignes des tableaux sont mises en forme avec un saut de style entre les pages.
allowBreakAcrossPage: boolean;Valeur de propriété
boolean
Remarques
borders
Retourne un BorderUniversalCollection qui représente toutes les bordures de la table.
readonly borders: Word.BorderUniversalCollection;Valeur de propriété
Remarques
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
cellSpacing
Spécifie l’espacement (en points) entre les cellules dans un style de tableau.
cellSpacing: number;Valeur de propriété
number
Remarques
columnStripe
Spécifie le nombre de colonnes dans la bande lorsqu’un style spécifie la bande de colonnes impaires ou paires.
columnStripe: number;Valeur de propriété
number
Remarques
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é
isBreakAcrossPagesAllowed
Spécifie si Microsoft Word permet d’interrompre la table spécifiée entre les pages.
isBreakAcrossPagesAllowed: boolean;Valeur de propriété
boolean
Remarques
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
leftIndent
Spécifie la valeur de retrait gauche (en points) pour les lignes du style de tableau.
leftIndent: number;Valeur de propriété
number
Remarques
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
rowStripe
Spécifie le nombre de lignes à inclure dans le bandeau lorsque le style spécifie la bande impaire ou paire de lignes.
rowStripe: number;Valeur de propriété
number
Remarques
shading
Renvoie un ShadingUniversal objet qui fait référence à la mise en forme d’ombrage pour le style de tableau.
readonly shading: Word.Shading;Valeur de propriété
Remarques
tableDirection
Spécifie la direction dans laquelle Microsoft Word commande les cellules dans le style de tableau.
tableDirection: Word.TableDirection | "RightToLeft" | "LeftToRight";Valeur de propriété
Word.TableDirection | "RightToLeft" | "LeftToRight"
Remarques
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
Détails de la méthode
condition(conditionCode)
Renvoie un objet qui représente une ConditionalStyle mise en forme de style spéciale pour une partie d’un tableau.
condition(conditionCode: Word.ConditionCode): Word.ConditionalStyle;Paramètres
- conditionCode
- Word.ConditionCode
Zone du tableau à laquelle appliquer la mise en forme.
Retours
Remarques
condition(conditionCode)
Renvoie un objet qui représente une ConditionalStyle mise en forme de style spéciale pour une partie d’un tableau.
condition(conditionCode: "FirstRow" | "LastRow" | "OddRowBanding" | "EvenRowBanding" | "FirstColumn" | "LastColumn" | "OddColumnBanding" | "EvenColumnBanding" | "TopRightCell" | "TopLeftCell" | "BottomRightCell" | "BottomLeftCell"): Word.ConditionalStyle;Paramètres
- conditionCode
-
"FirstRow" | "LastRow" | "OddRowBanding" | "EvenRowBanding" | "FirstColumn" | "LastColumn" | "OddColumnBanding" | "EvenColumnBanding" | "TopRightCell" | "TopLeftCell" | "BottomRightCell" | "BottomLeftCell"
Zone du tableau à laquelle appliquer la mise en forme.
Retours
Remarques
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
Fournit des options pour les propriétés de l’objet à charger.
Retours
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
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
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.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.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 de l’objet d’origine.
toJSON(): Word.Interfaces.TableStyleData;Retours
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
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;