Word.ListItem class

Paquet:

word

Représente le format d’élément de liste de paragraphes.

Extends

OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Propriétés

context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
level	Spécifie le niveau de l’élément dans la liste.
listString	Obtient la puce, le nombre ou l’image de l’élément de liste sous forme de chaîne.
siblingIndex	Obtient le numéro d’ordre de l’élément de liste relativement à ses frères.

Méthodes

getAncestor(parentOnly)	Obtient le parent de l’élément de liste, ou l’ancêtre le plus proche si le parent n’existe pas. Génère une ItemNotFound erreur si l’élément de liste n’a pas d’ancêtre.
getAncestorOrNullObject(parentOnly)	Obtient le parent de l’élément de liste, ou l’ancêtre le plus proche si le parent n’existe pas. Si l’élément de liste n’a pas d’ancêtre, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
getDescendants(directChildrenOnly)	Obtient tous les éléments de liste descendants de l’élément de liste.
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 ListItem est un objet API. La toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.ListItemDataque ) 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é

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

level

Spécifie le niveau de l’élément dans la liste.

level: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/insert-list.yaml

// This example starts a new list with the second paragraph.
await Word.run(async (context) => {
  const paragraphs = context.document.body.paragraphs;
  paragraphs.load("$none");

  await context.sync();

  // Start new list using the second paragraph.
  const list = paragraphs.items[1].startNewList();
  list.load("$none");

  await context.sync();

  // To add new items to the list, use Start or End on the insertLocation parameter.
  list.insertParagraph("New list item at the start of the list", "Start");
  const paragraph = list.insertParagraph("New list item at the end of the list (set to list level 5)", "End");

  // Set up list level for the list item.
  paragraph.listItem.level = 4;

  // To add paragraphs outside the list, use Before or After.
  list.insertParagraph("New paragraph goes after (not part of the list)", "After");

  await context.sync();
});

listString

Obtient la puce, le nombre ou l’image de l’élément de liste sous forme de chaîne.

readonly listString: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.3 ]

siblingIndex

Obtient le numéro d’ordre de l’élément de liste relativement à ses frères.

readonly siblingIndex: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.3 ]

Détails de la méthode

getAncestor(parentOnly)

Obtient le parent de l’élément de liste, ou l’ancêtre le plus proche si le parent n’existe pas. Génère une ItemNotFound erreur si l’élément de liste n’a pas d’ancêtre.

getAncestor(parentOnly?: boolean): Word.Paragraph;

Paramètres

parentOnly

boolean

Facultatif. Spécifie que seul le parent de l’élément de liste sera retourné. La valeur par défaut est false qui spécifie d’obtenir l’ancêtre le plus bas.

Retours

Word.Paragraph

Remarques

[ Ensemble d’API : WordApi 1.3 ]

getAncestorOrNullObject(parentOnly)

Obtient le parent de l’élément de liste, ou l’ancêtre le plus proche si le parent n’existe pas. Si l’élément de liste n’a pas d’ancêtre, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getAncestorOrNullObject(parentOnly?: boolean): Word.Paragraph;

Paramètres

parentOnly

boolean

Facultatif. Spécifie que seul le parent de l’élément de liste sera retourné. La valeur par défaut est false qui spécifie d’obtenir l’ancêtre le plus bas.

Retours

Word.Paragraph

Remarques

[ Ensemble d’API : WordApi 1.3 ]

getDescendants(directChildrenOnly)

Obtient tous les éléments de liste descendants de l’élément de liste.

getDescendants(directChildrenOnly?: boolean): Word.ParagraphCollection;

Paramètres

directChildrenOnly

boolean

Facultatif. Spécifie que seuls les enfants directs de l’élément de liste seront retournés. La valeur par défaut est false, ce qui indique d’obtenir tous les éléments descendants.

Retours

Word.ParagraphCollection

Remarques

[ Ensemble d’API : WordApi 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.ListItemLoadOptions): Word.ListItem;

Paramètres

options

Word.Interfaces.ListItemLoadOptions

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

Retours

Word.ListItem

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

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.ListItem

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

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.ListItem

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

Paramètres

properties

Word.Interfaces.ListItemUpdateData

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

Paramètres

properties

Word.ListItem

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

toJSON(): Word.Interfaces.ListItemData;

Retours

Word.Interfaces.ListItemData

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

Retours

Word.ListItem

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

Retours

Word.ListItem