Word.ListFormat class

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Indica se o ListFormat objeto contém uma única lista.

readonly isSingleList: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Indica se o ListFormat objeto contém um único modelo de lista.

readonly isSingleListTemplate: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Devolve um List objeto que representa a primeira lista formatada contida no ListFormat objeto.

readonly list: Word.List;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica o número de nível de lista do primeiro parágrafo para o ListFormat objeto.

listLevelNumber: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Obtém a representação de cadeia do valor de lista do primeiro parágrafo no intervalo do ListFormat objeto.

readonly listString: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Obtém o modelo de lista associado ao ListFormat objeto.

readonly listTemplate: Word.ListTemplate;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Obtém o tipo da lista para o ListFormat objeto.

readonly listType: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet";

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Obtém o valor numérico do primeiro parágrafo no intervalo do ListFormat objeto.

readonly listValue: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Adiciona marcas de lista e formatação aos parágrafos no intervalo.

applyBulletDefault(defaultListBehavior: Word.DefaultListBehavior): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Adiciona marcas de lista e formatação aos parágrafos no intervalo.

applyBulletDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Aplica um modelo de lista com um nível específico aos parágrafos no intervalo.

applyListTemplateWithLevel(listTemplate: Word.ListTemplate, options?: Word.ListTemplateApplyOptions): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Adiciona numeração e formatação aos parágrafos no intervalo.

applyNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Adiciona numeração e formatação aos parágrafos no intervalo.

applyNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Adiciona numeração e formatação hierárquicas aos parágrafos no intervalo.

applyOutlineNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Adiciona numeração e formatação hierárquicas aos parágrafos no intervalo.

applyOutlineNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Determina se o ListFormat objeto pode continuar uma lista anterior.

canContinuePreviousList(listTemplate: Word.ListTemplate): OfficeExtension.ClientResult<Word.Continue>;

Parâmetros

Retornos

Um Continue valor que indica se a continuação é possível.

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Converte números na lista em texto simples.

convertNumbersToText(numberType: Word.NumberType): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Converte números na lista em texto simples.

convertNumbersToText(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Conta os itens numerados na lista.

countNumberedItems(options?: Word.ListFormatCountNumberedItemsOptions): OfficeExtension.ClientResult<number>;

Parâmetros

Retornos

O número de itens.

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Avançar a lista por um nível.

listIndent(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Diminui o avanço da lista por um nível.

listOutdent(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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.ListFormatLoadOptions): Word.ListFormat;

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

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

Parâmetros

Retornos

Remove a numeração da lista.

removeNumbers(numberType: Word.NumberType): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Remove a numeração da lista.

removeNumbers(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

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

Parâmetros

Retornos

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

set(properties: Word.ListFormat): void;

Parâmetros

Retornos

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Word.ListFormat é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.ListFormatData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Word.Interfaces.ListFormatData;

Retornos

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este 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, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.

track(): Word.ListFormat;

Retornos

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta 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. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.

untrack(): Word.ListFormat;

Retornos