Word.List class

El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Obtiene el identificador de la lista.

readonly id: number;

Valor de propiedad

Comentarios

Conjunto de API: WordApi 1.3

Comprueba si cada uno de los 9 niveles existe en la lista. true Indica que el nivel existe, lo que significa que hay al menos un elemento de lista en ese nivel.

readonly levelExistences: boolean[];

Valor de propiedad

Comentarios

Conjunto de API: WordApi 1.3

Ejemplos

// 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]}`);
  }
});

Obtiene todos los tipos de los 9 niveles de la lista. Cada tipo puede ser bullet, numbero picture.

readonly levelTypes: Word.ListLevelType[];

Valor de propiedad

Comentarios

Conjunto de API: WordApi 1.3

Ejemplos

// 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]}`);
  }
});

Obtiene los párrafos de la lista.

readonly paragraphs: Word.ParagraphCollection;

Valor de propiedad

Comentarios

Conjunto de API: WordApi 1.3

Obtiene la fuente de la viñeta, el número o la imagen en el nivel especificado en la lista.

getLevelFont(level: number): Word.Font;

Parámetros

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.1

Obtiene los párrafos que se producen en el nivel especificado de la lista.

getLevelParagraphs(level: number): Word.ParagraphCollection;

Parámetros

Devoluciones

Comentarios

Conjunto de API: WordApi 1.3

Obtiene la representación de cadena codificada en base64 de la imagen en el nivel especificado en la lista.

getLevelPicture(level: number): OfficeExtension.ClientResult<string>;

Parámetros

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.1

Obtiene la viñeta, el número o la imagen en el nivel especificado como una cadena.

getLevelString(level: number): OfficeExtension.ClientResult<string>;

Parámetros

Devoluciones

Comentarios

Conjunto de API: WordApi 1.3

Inserta un párrafo en la ubicación especificada.

insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): Word.Paragraph;

Parámetros

Devoluciones

Comentarios

Conjunto de API: WordApi 1.3

Ejemplos

// 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();
});

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: Word.Interfaces.ListLoadOptions): Word.List;

Parámetros

Devoluciones

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNames?: string | string[]): Word.List;

Parámetros

Devoluciones

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.List;

Parámetros

Devoluciones

Restablece la fuente de la viñeta, el número o la imagen al nivel especificado en la lista.

resetLevelFont(level: number, resetFontName?: boolean): void;

Parámetros

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.1

Establece la alineación de la viñeta, el número o la imagen en el nivel especificado en la lista.

setLevelAlignment(level: number, alignment: Word.Alignment): void;

Parámetros

Devoluciones

Comentarios

Conjunto de API: WordApi 1.3

Establece la alineación de la viñeta, el número o la imagen en el nivel especificado en la lista.

setLevelAlignment(level: number, alignment: "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"): void;

Parámetros

Devoluciones

Comentarios

Conjunto de API: WordApi 1.3

Establece el formato de viñeta en el nivel especificado de la lista. Si la bala es custom, se charCode requiere.

setLevelBullet(level: number, listBullet: Word.ListBullet, charCode?: number, fontName?: string): void;

Parámetros

Devoluciones

Comentarios

Conjunto de API: WordApi 1.3

Ejemplos

// 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();
});

Establece el formato de viñeta en el nivel especificado de la lista. Si la bala es custom, se charCode requiere.

setLevelBullet(level: number, listBullet: "Custom" | "Solid" | "Hollow" | "Square" | "Diamonds" | "Arrow" | "Checkmark", charCode?: number, fontName?: string): void;

Parámetros

Devoluciones

Comentarios

Conjunto de API: WordApi 1.3

Establece las dos sangrías del nivel especificado de la lista.

setLevelIndents(level: number, textIndent: number, bulletNumberPictureIndent: number): void;

Parámetros

Devoluciones

Comentarios

Conjunto de API: WordApi 1.3

Establece el formato de numeración en el nivel especificado de la lista.

setLevelNumbering(level: number, listNumbering: Word.ListNumbering, formatString?: Array<string | number>): void;

Parámetros

Devoluciones

Comentarios

Conjunto de API: WordApi 1.3

Ejemplos

// 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();
});

Establece el formato de numeración en el nivel especificado de la lista.

setLevelNumbering(level: number, listNumbering: "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter", formatString?: Array<string | number>): void;

Parámetros

Devoluciones

Comentarios

Conjunto de API: WordApi 1.3

Establece la imagen en el nivel especificado en la lista.

setLevelPicture(level: number, base64EncodedImage?: string): void;

Parámetros

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.1

Establece el número de inicio en el nivel especificado de la lista. El valor predeterminado es 1.

setLevelStartingNumber(level: number, startingNumber: number): void;

Parámetros

Devoluciones

Comentarios

Conjunto de API: WordApi 1.3

Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Word.List es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Word.Interfaces.ListData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

toJSON(): Word.Interfaces.ListData;

Devoluciones

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura de context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y recibe un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos objeto de seguimiento cuando se creó el objeto por primera vez. Si este objeto forma parte de una colección, también debe realizar un seguimiento de la colección primaria.

track(): Word.List;

Devoluciones

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es la abreviatura de context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Deberá llamar context.sync() antes de que la liberación de memoria surta efecto.

untrack(): Word.List;

Devoluciones