Word.List class
Contient une collection d’objets Word.Paragraph .
- Extends
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: Word.ParagraphCollection = context.document.body.paragraphs;
paragraphs.load("$none");
await context.sync();
// Start new list using the second paragraph.
const list: Word.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: Word.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();
});
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. |
id | Obtient l’ID de la liste. |
level |
Vérifie si chacun des 9 niveaux existe dans la liste. Une valeur True indique le niveau existe, ce qui signifie qu’il existe au moins un élément de liste à ce niveau. |
level |
Obtient les 9 types de niveau de la liste. Chaque type peut être « Bullet », « Number » ou « Picture ». |
paragraphs | Obtient les paragraphes de la liste. En lecture seule. |
Méthodes
get |
Obtient la police de la puce, du nombre ou de l’image au niveau spécifié dans la liste. |
get |
Obtient les paragraphes qui figurent au niveau spécifié de la liste. |
get |
Obtient la représentation sous forme de chaîne encodée en Base64 de l’image au niveau spécifié dans la liste. |
get |
Obtient la puce, le nombre ou l’image au niveau spécifié sous forme de chaîne. |
insert |
Insère un paragraphe à l’emplacement spécifié. |
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 |
reset |
Réinitialise la police de la puce, du numéro ou de l’image au niveau spécifié dans la liste. |
set |
Définit l’alignement de la puce, du nombre ou de l’image au niveau spécifié dans la liste. |
set |
Définit l’alignement de la puce, du nombre ou de l’image au niveau spécifié dans la liste. |
set |
Définit le format de puce au niveau spécifié de la liste. Si la puce est « Custom », la valeur charCode est requise. |
set |
Définit le format de puce au niveau spécifié de la liste. Si la puce est « Custom », la valeur charCode est requise. |
set |
Définit les deux retraits du niveau spécifié de la liste. |
set |
Définit le format de numérotation du niveau spécifié de la liste. |
set |
Définit le format de numérotation du niveau spécifié de la liste. |
set |
Définit l’image au niveau spécifié dans la liste. |
set |
Définit le numéro de départ du niveau spécifié de la liste. La valeur par défaut est 1. |
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é
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é
id
Obtient l’ID de la liste.
readonly id: number;
Valeur de propriété
number
Remarques
levelExistences
Vérifie si chacun des 9 niveaux existe dans la liste. Une valeur True indique le niveau existe, ce qui signifie qu’il existe au moins un élément de liste à ce niveau.
readonly levelExistences: boolean[];
Valeur de propriété
boolean[]
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/organize-list.yaml
// Gets information about the first list in the document.
await Word.run(async (context) => {
const lists: Word.ListCollection = context.document.body.lists;
lists.load("items");
await context.sync();
if (lists.items.length === 0) {
console.warn("There are no lists in this document.");
return;
}
// Get the first list.
const list: Word.List = lists.getFirst();
list.load("levelTypes,levelExistences");
await context.sync();
const levelTypes = list.levelTypes;
console.log("Level types of the first list:");
for (let i = 0; i < levelTypes.length; i++) {
console.log(`- Level ${i + 1} (index ${i}): ${levelTypes[i]}`);
}
const levelExistences = list.levelExistences;
console.log("Level existences of the first list:");
for (let i = 0; i < levelExistences.length; i++) {
console.log(`- Level ${i + 1} (index ${i}): ${levelExistences[i]}`);
}
});
levelTypes
Obtient les 9 types de niveau de la liste. Chaque type peut être « Bullet », « Number » ou « Picture ».
readonly levelTypes: Word.ListLevelType[];
Valeur de propriété
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/organize-list.yaml
// Gets information about the first list in the document.
await Word.run(async (context) => {
const lists: Word.ListCollection = context.document.body.lists;
lists.load("items");
await context.sync();
if (lists.items.length === 0) {
console.warn("There are no lists in this document.");
return;
}
// Get the first list.
const list: Word.List = lists.getFirst();
list.load("levelTypes,levelExistences");
await context.sync();
const levelTypes = list.levelTypes;
console.log("Level types of the first list:");
for (let i = 0; i < levelTypes.length; i++) {
console.log(`- Level ${i + 1} (index ${i}): ${levelTypes[i]}`);
}
const levelExistences = list.levelExistences;
console.log("Level existences of the first list:");
for (let i = 0; i < levelExistences.length; i++) {
console.log(`- Level ${i + 1} (index ${i}): ${levelExistences[i]}`);
}
});
paragraphs
Obtient les paragraphes de la liste. En lecture seule.
readonly paragraphs: Word.ParagraphCollection;
Valeur de propriété
Remarques
Détails de la méthode
getLevelFont(level)
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.
Obtient la police de la puce, du nombre ou de l’image au niveau spécifié dans la liste.
getLevelFont(level: number): Word.Font;
Paramètres
- level
-
number
Obligatoire. Niveau de la liste.
Retours
Remarques
getLevelParagraphs(level)
Obtient les paragraphes qui figurent au niveau spécifié de la liste.
getLevelParagraphs(level: number): Word.ParagraphCollection;
Paramètres
- level
-
number
Obligatoire. Niveau de la liste.
Retours
Remarques
getLevelPicture(level)
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.
Obtient la représentation sous forme de chaîne encodée en Base64 de l’image au niveau spécifié dans la liste.
getLevelPicture(level: number): OfficeExtension.ClientResult<string>;
Paramètres
- level
-
number
Obligatoire. Niveau de la liste.
Retours
OfficeExtension.ClientResult<string>
Remarques
getLevelString(level)
Obtient la puce, le nombre ou l’image au niveau spécifié sous forme de chaîne.
getLevelString(level: number): OfficeExtension.ClientResult<string>;
Paramètres
- level
-
number
Obligatoire. Niveau de la liste.
Retours
OfficeExtension.ClientResult<string>
Remarques
insertParagraph(paragraphText, insertLocation)
Insère un paragraphe à l’emplacement spécifié.
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): Word.Paragraph;
Paramètres
- paragraphText
-
string
Obligatoire. Texte de paragraphe à insérer.
Obligatoire. La valeur doit être « Start », « End », « Before » ou « After ».
Retours
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: Word.ParagraphCollection = context.document.body.paragraphs;
paragraphs.load("$none");
await context.sync();
// Start new list using the second paragraph.
const list: Word.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: Word.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();
});
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.ListLoadOptions): Word.List;
Paramètres
- options
- Word.Interfaces.ListLoadOptions
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.List;
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.List;
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
resetLevelFont(level, resetFontName)
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.
Réinitialise la police de la puce, du numéro ou de l’image au niveau spécifié dans la liste.
resetLevelFont(level: number, resetFontName?: boolean): void;
Paramètres
- level
-
number
Obligatoire. Niveau de la liste.
- resetFontName
-
boolean
Optional. Indique s’il faut réinitialiser le nom de la police. La valeur par défaut est false, ce qui indique que le nom de la police reste inchangé.
Retours
void
Remarques
setLevelAlignment(level, alignment)
Définit l’alignement de la puce, du nombre ou de l’image au niveau spécifié dans la liste.
setLevelAlignment(level: number, alignment: Word.Alignment): void;
Paramètres
- level
-
number
Obligatoire. Niveau de la liste.
- alignment
- Word.Alignment
Obligatoire. Alignement de niveau qui doit être « Gauche », « Centré » ou « Droite ».
Retours
void
Remarques
setLevelAlignment(level, alignmentString)
Définit l’alignement de la puce, du nombre ou de l’image au niveau spécifié dans la liste.
setLevelAlignment(level: number, alignmentString: "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"): void;
Paramètres
- level
-
number
Obligatoire. Niveau de la liste.
- alignmentString
-
"Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"
Obligatoire. Alignement de niveau qui doit être « Gauche », « Centré » ou « Droite ».
Retours
void
Remarques
setLevelBullet(level, listBullet, charCode, fontName)
Définit le format de puce au niveau spécifié de la liste. Si la puce est « Custom », la valeur charCode est requise.
setLevelBullet(level: number, listBullet: Word.ListBullet, charCode?: number, fontName?: string): void;
Paramètres
- level
-
number
Obligatoire. Niveau de la liste.
- listBullet
- Word.ListBullet
Obligatoire. La balle.
- charCode
-
number
Optional. Valeur de code du caractère de puce. Utilisé uniquement si la puce est « Personnalisé ».
- fontName
-
string
Optional. Nom de police de la puce. Utilisé uniquement si la puce est « Personnalisé ».
Retours
void
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/organize-list.yaml
// Inserts a list starting with the first paragraph then set numbering and bullet types of the list items.
await Word.run(async (context) => {
const paragraphs: Word.ParagraphCollection = context.document.body.paragraphs;
paragraphs.load("$none");
await context.sync();
// Use the first paragraph to start a new list.
const list: Word.List = paragraphs.items[0].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: Word.Paragraph = list.insertParagraph("New list item at the end of the list (set to list level 5)", "End");
// Set numbering for list level 1.
list.setLevelNumbering(0, Word.ListNumbering.arabic);
// Set bullet type for list level 5.
list.setLevelBullet(4, Word.ListBullet.arrow);
// Set list level for the last item in this list.
paragraph.listItem.level = 4;
list.load("levelTypes");
await context.sync();
});
setLevelBullet(level, listBulletString, charCode, fontName)
Définit le format de puce au niveau spécifié de la liste. Si la puce est « Custom », la valeur charCode est requise.
setLevelBullet(level: number, listBulletString: "Custom" | "Solid" | "Hollow" | "Square" | "Diamonds" | "Arrow" | "Checkmark", charCode?: number, fontName?: string): void;
Paramètres
- level
-
number
Obligatoire. Niveau de la liste.
- listBulletString
-
"Custom" | "Solid" | "Hollow" | "Square" | "Diamonds" | "Arrow" | "Checkmark"
Obligatoire. La balle.
- charCode
-
number
Optional. Valeur de code du caractère de puce. Utilisé uniquement si la puce est « Personnalisé ».
- fontName
-
string
Optional. Nom de police de la puce. Utilisé uniquement si la puce est « Personnalisé ».
Retours
void
Remarques
setLevelIndents(level, textIndent, bulletNumberPictureIndent)
Définit les deux retraits du niveau spécifié de la liste.
setLevelIndents(level: number, textIndent: number, bulletNumberPictureIndent: number): void;
Paramètres
- level
-
number
Obligatoire. Niveau de la liste.
- textIndent
-
number
Obligatoire. Retrait du texte en points. Il est identique au retrait de paragraphe gauche.
- bulletNumberPictureIndent
-
number
Obligatoire. Retrait relatif, en points, de la puce, du nombre ou de l’image. Il est identique au retrait de première ligne du paragraphe.
Retours
void
Remarques
setLevelNumbering(level, listNumbering, formatString)
Définit le format de numérotation du niveau spécifié de la liste.
setLevelNumbering(level: number, listNumbering: Word.ListNumbering, formatString?: Array<string | number>): void;
Paramètres
- level
-
number
Obligatoire. Niveau de la liste.
- listNumbering
- Word.ListNumbering
Obligatoire. Format ordinal.
- formatString
-
Array<string | number>
Optional. Format de chaîne de numérotation défini comme un tableau de chaînes et/ou d’entiers. Chaque entier est un niveau de type nombre supérieur ou égal à ce niveau. Par exemple, un tableau de ["(« , niveau - 1, « . », level, « )"] peut définir le format de « (2.c) », où 2 est le numéro d’élément du parent et c est le numéro d’élément de ce niveau.
Retours
void
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/organize-list.yaml
// Inserts a list starting with the first paragraph then set numbering and bullet types of the list items.
await Word.run(async (context) => {
const paragraphs: Word.ParagraphCollection = context.document.body.paragraphs;
paragraphs.load("$none");
await context.sync();
// Use the first paragraph to start a new list.
const list: Word.List = paragraphs.items[0].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: Word.Paragraph = list.insertParagraph("New list item at the end of the list (set to list level 5)", "End");
// Set numbering for list level 1.
list.setLevelNumbering(0, Word.ListNumbering.arabic);
// Set bullet type for list level 5.
list.setLevelBullet(4, Word.ListBullet.arrow);
// Set list level for the last item in this list.
paragraph.listItem.level = 4;
list.load("levelTypes");
await context.sync();
});
setLevelNumbering(level, listNumberingString, formatString)
Définit le format de numérotation du niveau spécifié de la liste.
setLevelNumbering(level: number, listNumberingString: "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter", formatString?: Array<string | number>): void;
Paramètres
- level
-
number
Obligatoire. Niveau de la liste.
- listNumberingString
-
"None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter"
Obligatoire. Format ordinal.
- formatString
-
Array<string | number>
Optional. Format de chaîne de numérotation défini comme un tableau de chaînes et/ou d’entiers. Chaque entier est un niveau de type nombre supérieur ou égal à ce niveau. Par exemple, un tableau de ["(« , niveau - 1, « . », level, « )"] peut définir le format de « (2.c) », où 2 est le numéro d’élément du parent et c est le numéro d’élément de ce niveau.
Retours
void
Remarques
setLevelPicture(level, base64EncodedImage)
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.
Définit l’image au niveau spécifié dans la liste.
setLevelPicture(level: number, base64EncodedImage?: string): void;
Paramètres
- level
-
number
Obligatoire. Niveau de la liste.
- base64EncodedImage
-
string
Optional. Image encodée en Base64 à définir. Si elle n’est pas indiquée, l’image par défaut est définie.
Retours
void
Remarques
setLevelStartingNumber(level, startingNumber)
Définit le numéro de départ du niveau spécifié de la liste. La valeur par défaut est 1.
setLevelStartingNumber(level: number, startingNumber: number): void;
Paramètres
- level
-
number
Obligatoire. Niveau de la liste.
- startingNumber
-
number
Obligatoire. Nombre à utiliser pour commencer.
Retours
void
Remarques
toJSON()
Remplace la méthode JavaScript toJSON()
afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify()
. (JSON.stringify
appelle à son tour la toJSON
méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.List
est un objet API, la toJSON
méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.ListData
que ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
toJSON(): Word.Interfaces.ListData;
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.List;
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.List;
Retours
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour