Word.List class

Pacote:

word

Contém uma coleção de Word. Objetos de parágrafo.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: 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 = 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();
});

Propriedades

context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
id	Obtém a ID da lista.
levelExistences	Verifica se cada um dos 9 níveis existe na lista. Um valor true indica que o nível existe, o que significa que há pelo menos um item de lista nesse nível.
levelTypes	Obtém todos os tipos de nível 9 na lista. Cada tipo pode ser 'Bullet', 'Number' ou 'Picture'.
paragraphs	Obtém parágrafos na lista. Somente leitura.

Métodos

getLevelParagraphs(level)	Obtém os parágrafos que ocorrem no nível especificado na lista.
getLevelString(level)	Obtém a bala, o número ou a imagem no nível especificado como uma cadeia de caracteres.
insertParagraph(paragraphText, insertLocation)	Insere um parágrafo no local especificado.
load(options)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
setLevelAlignment(level, alignment)	Define o alinhamento da bala, número ou imagem no nível especificado na lista.
setLevelAlignment(level, alignmentString)	Define o alinhamento da bala, número ou imagem no nível especificado na lista.
setLevelBullet(level, listBullet, charCode, fontName)	Define o formato de marcador no nível especificado na lista. Se o marcador é 'Custom', o charCode é necessário.
setLevelBullet(level, listBulletString, charCode, fontName)	Define o formato de marcador no nível especificado na lista. Se o marcador é 'Custom', o charCode é necessário.
setLevelIndents(level, textIndent, bulletNumberPictureIndent)	Define os dois recuos do nível especificado na lista.
setLevelNumbering(level, listNumbering, formatString)	Define o formato de numeração no nível especificado na lista.
setLevelNumbering(level, listNumberingString, formatString)	Define o formato de numeração no nível especificado na lista.
setLevelStartingNumber(level, startingNumber)	Define o número inicial no nível especificado na lista. O valor padrão é 1.
toJSON()	Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o Word original. Objeto List é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.ListData) que contém cópias rasas de todas as propriedades filho carregadas do objeto original.
track()	Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação para 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, você 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.
untrack()	Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é abreviada para 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á chamar context.sync() antes que a versão da memória entre em vigor.

Detalhes da propriedade

context

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

Word.RequestContext

id

Obtém a ID da lista.

readonly id: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApi 1.3 ]

levelExistences

Verifica se cada um dos 9 níveis existe na lista. Um valor 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

boolean[]

Comentários

[ Conjunto de API: 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 = 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 = 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

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

Word.ListLevelType[]

Comentários

[ Conjunto de API: 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 = 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 = 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

Obtém parágrafos na lista. Somente leitura.

readonly paragraphs: Word.ParagraphCollection;

Valor da propriedade

Word.ParagraphCollection

Comentários

[ Conjunto de API: WordApi 1.3 ]

Detalhes do método

getLevelParagraphs(level)

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

getLevelParagraphs(level: number): Word.ParagraphCollection;

Parâmetros

level

number

Obrigatório. O nível na lista.

Retornos

Word.ParagraphCollection

Comentários

[ Conjunto de API: WordApi 1.3 ]

getLevelString(level)

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

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

Parâmetros

level

number

Obrigatório. O nível na lista.

Retornos

OfficeExtension.ClientResult<string>

Comentários

[ Conjunto de API: WordApi 1.3 ]

insertParagraph(paragraphText, insertLocation)

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

paragraphText

string

Obrigatório. O texto do parágrafo a ser inserido.

insertLocation

start | end | before | after | "Start" | "End" | "Before" | "After"

Obrigatório. O valor deve ser 'Start', 'End', 'Before' ou 'After'.

Retornos

Word.Paragraph

Comentários

[ Conjunto de API: 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 = 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();
});

load(options)

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

options

Word.Interfaces.ListLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Word.List

load(propertyNames)

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

propertyNames

string | string[]

Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

Word.List

load(propertyNamesAndPaths)

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

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

Word.List

setLevelAlignment(level, alignment)

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

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

Parâmetros

level

number

Obrigatório. O nível na lista.

alignment

Word.Alignment

Obrigatório. O alinhamento de nível que deve ser 'Left', 'Centered' ou 'Right'.

Retornos

void

Comentários

[ Conjunto de API: WordApi 1.3 ]

setLevelAlignment(level, alignmentString)

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

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

Parâmetros

level

number

Obrigatório. O nível na lista.

alignmentString

"Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"

Obrigatório. O alinhamento de nível que deve ser 'Left', 'Centered' ou 'Right'.

Retornos

void

Comentários

[ Conjunto de API: WordApi 1.3 ]

setLevelBullet(level, listBullet, charCode, fontName)

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

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

Parâmetros

level

number

Obrigatório. O nível na lista.

listBullet

Word.ListBullet

Obrigatório. A bala.

charCode

number

Opcional. O valor de código do caractere de bala. Usado somente se a bala for 'Custom'.

fontName

string

Opcional. O nome da fonte da bala. Usado somente se a bala for 'Custom'.

Retornos

void

Comentários

[ Conjunto de API: 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 = context.document.body.paragraphs;
  paragraphs.load("$none");

  await context.sync();

  // Use the first paragraph to start a new list.
  const 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 = 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)

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

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

Parâmetros

level

number

Obrigatório. O nível na lista.

listBulletString

"Custom" | "Solid" | "Hollow" | "Square" | "Diamonds" | "Arrow" | "Checkmark"

Obrigatório. A bala.

charCode

number

Opcional. O valor de código do caractere de bala. Usado somente se a bala for 'Custom'.

fontName

string

Opcional. O nome da fonte da bala. Usado somente se a bala for 'Custom'.

Retornos

void

Comentários

[ Conjunto de API: WordApi 1.3 ]

setLevelIndents(level, textIndent, bulletNumberPictureIndent)

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

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

Parâmetros

level

number

Obrigatório. O nível na lista.

textIndent

number

Obrigatório. O recuo de texto em pontos. É o mesmo que o recuo esquerdo do parágrafo.

bulletNumberPictureIndent

number

Obrigatório. O recuo relativo, em pontos, da bala, número ou imagem. É o mesmo que o recuo da primeira linha do parágrafo.

Retornos

void

Comentários

[ Conjunto de API: WordApi 1.3 ]

setLevelNumbering(level, listNumbering, formatString)

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

level

number

Obrigatório. O nível na lista.

listNumbering

Word.ListNumbering

Obrigatório. O formato ordinal.

formatString

Array<string | number>

Opcional. O formato de cadeia de caracteres de numeração definido como uma matriz de cadeias de caracteres e/ou inteiros. Cada inteiro é um nível de tipo de número maior ou igual a esse nível. Por exemplo, uma matriz de ["(", level - 1, ".", level, ")"] pode definir o formato de "(2.c)", em que 2 é o número do item do pai e c é o número do item deste nível.

Retornos

void

Comentários

[ Conjunto de API: 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 = context.document.body.paragraphs;
  paragraphs.load("$none");

  await context.sync();

  // Use the first paragraph to start a new list.
  const 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 = 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)

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

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

Parâmetros

level

number

Obrigatório. O nível na lista.

listNumberingString

"None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter"

Obrigatório. O formato ordinal.

formatString

Array<string | number>

Opcional. O formato de cadeia de caracteres de numeração definido como uma matriz de cadeias de caracteres e/ou inteiros. Cada inteiro é um nível de tipo de número maior ou igual a esse nível. Por exemplo, uma matriz de ["(", level - 1, ".", level, ")"] pode definir o formato de "(2.c)", em que 2 é o número do item do pai e c é o número do item deste nível.

Retornos

void

Comentários

[ Conjunto de API: WordApi 1.3 ]

setLevelStartingNumber(level, startingNumber)

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

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

Parâmetros

level

number

Obrigatório. O nível na lista.

startingNumber

number

Obrigatório. O número a ser iniciado.

Retornos

void

Comentários

[ Conjunto de API: WordApi 1.3 ]

toJSON()

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

toJSON(): Word.Interfaces.ListData;

Retornos

Word.Interfaces.ListData

track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação para 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, você 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

Word.List

untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é abreviada para 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á chamar context.sync() antes que a versão da memória entre em vigor.

untrack(): Word.List;

Retornos

Word.List