Word.TableStyle class

Pacote:

word

Representa o objeto TableStyle.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: WordApi 1.6 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/manage-custom-style.yaml

// Gets the table style properties and displays them in the form.
const styleName = $("#style-name")
  .val()
  .toString();
if (styleName == "") {
  console.warn("Please input a table style name.");
  return;
}

await Word.run(async (context) => {
  const tableStyle = context.document.getStyles().getByName(styleName).tableStyle;
  tableStyle.load();
  await context.sync();

  if (tableStyle.isNullObject) {
    console.warn(`There's no existing table style with the name '${styleName}'.`);
    return;
  }

  console.log(tableStyle);
  $("#alignment").val(tableStyle.alignment);
  $("#allow-break-across-page").val(tableStyle.allowBreakAcrossPage.toString());
  $("#top-cell-margin").val(tableStyle.topCellMargin);
  $("#bottom-cell-margin").val(tableStyle.bottomCellMargin);
  $("#left-cell-margin").val(tableStyle.leftCellMargin);
  $("#right-cell-margin").val(tableStyle.rightCellMargin);
  $("#cell-spacing").val(tableStyle.cellSpacing);
});

Propriedades

alignment	Especifica o alinhamento da tabela em relação à margem de página.
allowBreakAcrossPage	Especifica se as linhas em tabelas formatadas com uma quebra de estilo especificada entre páginas.
bottomCellMargin	Especifica a quantidade de espaço a ser adicionada entre o conteúdo e as bordas inferiores das células.
cellSpacing	Especifica o espaçamento (em pontos) entre as células em um estilo de tabela.
context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
leftCellMargin	Especifica a quantidade de espaço a ser adicionada entre o conteúdo e as bordas esquerdas das células.
rightCellMargin	Especifica a quantidade de espaço a ser adicionada entre o conteúdo e as bordas direitas das células.
topCellMargin	Especifica a quantidade de espaço a ser adicionada entre o conteúdo e as bordas superiores das células.

Métodos

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 TableStyle é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.TableStyleData) 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

alignment

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Especifica o alinhamento da tabela em relação à margem de página.

alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";

Valor da propriedade

Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"

Comentários

[ Conjunto de API: WordApi BETA (SOMENTE VERSÃO PRÉVIA) ]

allowBreakAcrossPage

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Especifica se as linhas em tabelas formatadas com uma quebra de estilo especificada entre páginas.

allowBreakAcrossPage: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi BETA (SOMENTE VERSÃO PRÉVIA) ]

bottomCellMargin

Especifica a quantidade de espaço a ser adicionada entre o conteúdo e as bordas inferiores das células.

bottomCellMargin: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApi 1.6 ]

cellSpacing

Especifica o espaçamento (em pontos) entre as células em um estilo de tabela.

cellSpacing: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApi 1.6 ]

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

leftCellMargin

Especifica a quantidade de espaço a ser adicionada entre o conteúdo e as bordas esquerdas das células.

leftCellMargin: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApi 1.6 ]

rightCellMargin

Especifica a quantidade de espaço a ser adicionada entre o conteúdo e as bordas direitas das células.

rightCellMargin: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApi 1.6 ]

topCellMargin

Especifica a quantidade de espaço a ser adicionada entre o conteúdo e as bordas superiores das células.

topCellMargin: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApi 1.6 ]

Detalhes do método

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.TableStyleLoadOptions): Word.TableStyle;

Parâmetros

options

Word.Interfaces.TableStyleLoadOptions

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

Retornos

Word.TableStyle

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

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

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

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

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.TableStyleUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties

Word.Interfaces.TableStyleUpdateData

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.TableStyle): void;

Parâmetros

properties

Word.TableStyle

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

toJSON(): Word.Interfaces.TableStyleData;

Retornos

Word.Interfaces.TableStyleData

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

Retornos

Word.TableStyle

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

Retornos

Word.TableStyle