Word.ListItem class

Pacote:

word

Representa o formato de item da lista de parágrafos.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: WordApi 1.3 ]

Propriedades

context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
level	Especifica o nível do item na lista.
listString	Obtém o item de lista bala, número ou imagem como uma cadeia de caracteres.
siblingIndex	Obtém o número da ordem de item de lista em relação a seus irmãos.

Métodos

getAncestor(parentOnly)	Obtém o pai do item de lista ou o ancestral mais próximo se o pai não existir. Gerará um ItemNotFound erro se o item da lista não tiver nenhum ancestral.
getAncestorOrNullObject(parentOnly)	Obtém o pai do item de lista ou o ancestral mais próximo se o pai não existir. Se o item de lista não tiver nenhum ancestral, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
getDescendants(directChildrenOnly)	Obtém todos os itens de lista descendentes do item de lista.
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.
set(properties, options)	Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties)	Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
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. O objeto ListItem é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.ListItemData) que contém cópias rasas de quaisquer 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

level

Especifica o nível do item na lista.

level: number;

Valor da propriedade

number

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

listString

Obtém o item de lista bala, número ou imagem como uma cadeia de caracteres.

readonly listString: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.3 ]

siblingIndex

Obtém o número da ordem de item de lista em relação a seus irmãos.

readonly siblingIndex: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApi 1.3 ]

Detalhes do método

getAncestor(parentOnly)

Obtém o pai do item de lista ou o ancestral mais próximo se o pai não existir. Gerará um ItemNotFound erro se o item da lista não tiver nenhum ancestral.

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

Parâmetros

parentOnly

boolean

Opcional. Especifica que somente o pai do item de lista será retornado. O padrão é falso que especifica para obter o ancestral mais baixo.

Retornos

Word.Paragraph

Comentários

[ Conjunto de API: WordApi 1.3 ]

getAncestorOrNullObject(parentOnly)

Obtém o pai do item de lista ou o ancestral mais próximo se o pai não existir. Se o item de lista não tiver nenhum ancestral, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

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

Parâmetros

parentOnly

boolean

Opcional. Especifica que somente o pai do item de lista será retornado. O padrão é falso que especifica para obter o ancestral mais baixo.

Retornos

Word.Paragraph

Comentários

[ Conjunto de API: WordApi 1.3 ]

getDescendants(directChildrenOnly)

Obtém todos os itens de lista descendentes do item de lista.

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

Parâmetros

directChildrenOnly

boolean

Opcional. Especifica que somente as crianças diretas do item de lista serão retornadas. O padrão é falso que indica obter todos os itens descendentes.

Retornos

Word.ParagraphCollection

Comentários

[ Conjunto de API: WordApi 1.3 ]

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

Parâmetros

options

Word.Interfaces.ListItemLoadOptions

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

Retornos

Word.ListItem

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

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

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

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

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.ListItemUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties

Word.Interfaces.ListItemUpdateData

Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.

options

OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Word.ListItem): void;

Parâmetros

properties

Word.ListItem

Retornos

void

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. O objeto ListItem é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.ListItemData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Word.Interfaces.ListItemData;

Retornos

Word.Interfaces.ListItemData

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

Retornos

Word.ListItem

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

Retornos

Word.ListItem