Partager via


Word.TableColumn class

Représente une colonne de table dans un document Word.

Extends

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Propriétés

borders

Renvoie un BorderUniversalCollection objet qui représente toutes les bordures de la colonne de table.

columnIndex

Retourne la position de cette colonne dans une collection.

context

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

isFirst

Retourne true si la colonne ou la ligne est la première de la table ; false sinon.

isLast

Retourne true si la colonne ou la ligne est la dernière de la table ; false sinon.

nestingLevel

Retourne le niveau d’imbrication de la colonne.

preferredWidth

Spécifie la largeur préférée (en points ou en pourcentage de la largeur de la fenêtre) pour la colonne. L’unité de mesure peut être spécifiée par la preferredWidthType propriété .

preferredWidthType

Spécifie l’unité de mesure préférée à utiliser pour la largeur de la colonne de table.

shading

Renvoie un ShadingUniversal objet qui fait référence à la mise en forme d’ombrage de la colonne.

width

Spécifie la largeur de la colonne, en points.

Méthodes

autoFit()

Modifie la largeur de la colonne de tableau pour qu’elle s’ajuste à la largeur du texte sans modifier la façon dont le texte s’encapsule dans les cellules.

delete()

Supprime la colonne.

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.

select()

Sélectionne la colonne de table.

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.

setWidth(columnWidth, rulerStyle)

Définit la largeur de la colonne dans un tableau.

setWidth(columnWidth, rulerStyle)

Définit la largeur de la colonne dans un tableau.

sort()

Trie la colonne de table.

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.TableColumn est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.TableColumnDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées 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é

borders

Renvoie un BorderUniversalCollection objet qui représente toutes les bordures de la colonne de table.

readonly borders: Word.BorderUniversalCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

columnIndex

Retourne la position de cette colonne dans une collection.

readonly columnIndex: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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é

isFirst

Retourne true si la colonne ou la ligne est la première de la table ; false sinon.

readonly isFirst: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

isLast

Retourne true si la colonne ou la ligne est la dernière de la table ; false sinon.

readonly isLast: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

nestingLevel

Retourne le niveau d’imbrication de la colonne.

readonly nestingLevel: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

preferredWidth

Spécifie la largeur préférée (en points ou en pourcentage de la largeur de la fenêtre) pour la colonne. L’unité de mesure peut être spécifiée par la preferredWidthType propriété .

preferredWidth: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

preferredWidthType

Spécifie l’unité de mesure préférée à utiliser pour la largeur de la colonne de table.

preferredWidthType: Word.PreferredWidthType | "Auto" | "Percent" | "Points";

Valeur de propriété

Word.PreferredWidthType | "Auto" | "Percent" | "Points"

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

shading

Renvoie un ShadingUniversal objet qui fait référence à la mise en forme d’ombrage de la colonne.

readonly shading: Word.ShadingUniversal;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

width

Spécifie la largeur de la colonne, en points.

width: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Détails de la méthode

autoFit()

Modifie la largeur de la colonne de tableau pour qu’elle s’ajuste à la largeur du texte sans modifier la façon dont le texte s’encapsule dans les cellules.

autoFit(): void;

Retours

void

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

delete()

Supprime la colonne.

delete(): void;

Retours

void

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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.TableColumnLoadOptions): Word.TableColumn;

Paramètres

options
Word.Interfaces.TableColumnLoadOptions

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.TableColumn;

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.TableColumn;

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

select()

Sélectionne la colonne de table.

select(): void;

Retours

void

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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

Paramètres

properties
Word.Interfaces.TableColumnUpdateData

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.TableColumn): void;

Paramètres

properties
Word.TableColumn

Retours

void

setWidth(columnWidth, rulerStyle)

Définit la largeur de la colonne dans un tableau.

setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void;

Paramètres

columnWidth

number

Largeur à définir.

rulerStyle
Word.RulerStyle

Style de règle à appliquer.

Retours

void

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

setWidth(columnWidth, rulerStyle)

Définit la largeur de la colonne dans un tableau.

setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void;

Paramètres

columnWidth

number

Largeur à définir.

rulerStyle

"None" | "Proportional" | "FirstColumn" | "SameWidth"

Style de règle à appliquer.

Retours

void

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

sort()

Trie la colonne de table.

sort(): void;

Retours

void

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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.TableColumn est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.TableColumnDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Word.Interfaces.TableColumnData;

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.TableColumn;

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.TableColumn;

Retours