Word.ListFormat class

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é

Indique si l’objet ListFormat contient une seule liste.

readonly isSingleList: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Indique si l’objet ListFormat contient un modèle de liste unique.

readonly isSingleListTemplate: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Renvoie un List objet qui représente la première liste mise en forme contenue dans l’objet ListFormat .

readonly list: Word.List;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Spécifie le numéro au niveau de la liste pour le premier paragraphe de l’objet ListFormat .

listLevelNumber: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Obtient la représentation sous forme de chaîne de la valeur de liste du premier paragraphe de la plage de l’objet ListFormat .

readonly listString: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Obtient le modèle de liste associé à l’objet ListFormat .

readonly listTemplate: Word.ListTemplate;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Obtient le type de la liste pour l’objet ListFormat .

readonly listType: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet";

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Obtient la valeur numérique du premier paragraphe de la plage de l’objet ListFormat .

readonly listValue: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Ajoute des puces et une mise en forme aux paragraphes de la plage.

applyBulletDefault(defaultListBehavior: Word.DefaultListBehavior): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Ajoute des puces et une mise en forme aux paragraphes de la plage.

applyBulletDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Applique un modèle de liste avec un niveau spécifique aux paragraphes de la plage.

applyListTemplateWithLevel(listTemplate: Word.ListTemplate, options?: Word.ListTemplateApplyOptions): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Ajoute la numérotation et la mise en forme aux paragraphes de la plage.

applyNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Ajoute la numérotation et la mise en forme aux paragraphes de la plage.

applyNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Ajoute la numérotation et la mise en forme hiérarchiques aux paragraphes de la plage.

applyOutlineNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Ajoute la numérotation et la mise en forme hiérarchiques aux paragraphes de la plage.

applyOutlineNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Détermine si l’objet ListFormat peut continuer une liste précédente.

canContinuePreviousList(listTemplate: Word.ListTemplate): OfficeExtension.ClientResult<Word.Continue>;

Paramètres

Retours

Valeur Continue indiquant si la continuation est possible.

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Convertit les nombres de la liste en texte brut.

convertNumbersToText(numberType: Word.NumberType): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Convertit les nombres de la liste en texte brut.

convertNumbersToText(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Compte les éléments numérotés dans la liste.

countNumberedItems(options?: Word.ListFormatCountNumberedItemsOptions): OfficeExtension.ClientResult<number>;

Paramètres

Retours

le nombre d’éléments ;

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Met en retrait la liste d’un niveau.

listIndent(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Dépasse la liste d’un niveau.

listOutdent(): void;

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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.ListFormatLoadOptions): Word.ListFormat;

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

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

Paramètres

Retours

Supprime la numérotation de la liste.

removeNumbers(numberType: Word.NumberType): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Supprime la numérotation de la liste.

removeNumbers(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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

toJSON(): Word.Interfaces.ListFormatData;

Retours

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

Retours

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

Retours