Word.List class

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Obtém a ID da lista.

readonly id: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.3

Verifica se cada um dos 9 níveis existe na lista. true indica que o nível existe, o que significa que há pelo menos um item de lista nesse nível.

readonly levelExistences: boolean[];

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.3

Exemplos

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

Obtém todos os tipos de nível 9 na lista. Cada tipo pode ser bullet, number, ou picture.

readonly levelTypes: Word.ListLevelType[];

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.3

Exemplos

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

Obtém parágrafos na lista.

readonly paragraphs: Word.ParagraphCollection;

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.3

Obtém a fonte do marcador, número ou imagem no nível especificado na lista.

getLevelFont(level: number): Word.Font;

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.1

Obtém os parágrafos que ocorrem no nível especificado na lista.

getLevelParagraphs(level: number): Word.ParagraphCollection;

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApi 1.3

Obtém a representação da cadeia de caracteres codificada em Base64 da imagem no nível especificado na lista.

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

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.1

Obtém o marcador, o número ou a imagem no nível especificado como uma cadeia de caracteres.

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

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApi 1.3

Insere um parágrafo no local especificado.

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

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApi 1.3

Exemplos

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

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

Retornos

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

Retornos

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

Retornos

Redefine a fonte do marcador, número ou imagem no nível especificado na lista.

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

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.1

Define o alinhamento do marcador, número ou imagem no nível especificado na lista.

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

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApi 1.3

Define o alinhamento do marcador, número ou imagem no nível especificado na lista.

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

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApi 1.3

Define o formato de marcador no nível especificado na lista. Se o marcador for custom, o charCode é necessário.

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

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApi 1.3

Exemplos

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

Define o formato de marcador no nível especificado na lista. Se o marcador for custom, o charCode é necessário.

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

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApi 1.3

Define os dois recuos do nível especificado na lista.

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

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApi 1.3

Define o formato de numeração no nível especificado na lista.

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

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApi 1.3

Exemplos

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

Define o formato de numeração no nível especificado na lista.

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

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApi 1.3

Define a imagem no nível especificado na lista.

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

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.1

Define o número inicial no nível especificado na lista. O valor padrão é 1.

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

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApi 1.3

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Word.List é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.ListData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Word.Interfaces.ListData;

Retornos

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação de context.trackedObjects.add(thisObject). Se você estiver usando esse objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.

track(): Word.List;

Retornos

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é a forma abreviada de context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Você precisará ligar context.sync() antes que a liberação de memória entre em vigor.

untrack(): Word.List;

Retornos