Word.TableStyle class
Representa o objeto TableStyle.
- Extends
[ Conjunto de API: WordApi 1.6 ]
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/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: Word.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);
});
alignment | Especifica o alinhamento da tabela em relação à margem da página. |
allow |
Especifica se as linhas em tabelas formatadas com um estilo especificado quebram entre páginas. |
bottom |
Especifica a quantidade de espaço a adicionar entre os conteúdos e os limites inferiores das células. |
cell |
Especifica o espaçamento (em pontos) entre as células num estilo de tabela. |
context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
left |
Especifica a quantidade de espaço a adicionar entre os conteúdos e os limites esquerdos das células. |
right |
Especifica a quantidade de espaço a adicionar entre os conteúdos e os limites direitos das células. |
top |
Especifica a quantidade de espaço a adicionar entre os conteúdos e os limites superiores das células. |
load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
set(properties, options) | 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) | Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente. |
toJSON() | Substitui o método JavaScript |
track() | 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 |
untrack() | 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 |
Especifica o alinhamento da tabela em relação à margem da página.
alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";
Valor da propriedade
Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"
Comentários
Especifica se as linhas em tabelas formatadas com um estilo especificado quebram entre páginas.
allowBreakAcrossPage: boolean;
Valor da propriedade
boolean
Comentários
Especifica a quantidade de espaço a adicionar entre os conteúdos e os limites inferiores das células.
bottomCellMargin: number;
Valor da propriedade
number
Comentários
Especifica o espaçamento (em pontos) entre as células num estilo de tabela.
cellSpacing: number;
Valor da propriedade
number
Comentários
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
Especifica a quantidade de espaço a adicionar entre os conteúdos e os limites esquerdos das células.
leftCellMargin: number;
Valor da propriedade
number
Comentários
Especifica a quantidade de espaço a adicionar entre os conteúdos e os limites direitos das células.
rightCellMargin: number;
Valor da propriedade
number
Comentários
Especifica a quantidade de espaço a adicionar entre os conteúdos e os limites superiores das células.
topCellMargin: number;
Valor da propriedade
number
Comentários
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
Fornece opções para as propriedades do objeto a carregar.
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.TableStyle;
Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
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.TableStyle;
Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select
é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand
é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.
Retornos
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.TableStyleUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parâmetros
- properties
- Word.Interfaces.TableStyleUpdateData
Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.
Retornos
void
Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
set(properties: Word.TableStyle): void;
Parâmetros
- properties
- Word.TableStyle
Retornos
void
Substitui o método JavaScript toJSON()
para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify()
. (JSON.stringify
por sua vez, chama o toJSON
método do objeto que lhe é transmitido.) Enquanto o objeto original Word.TableStyle
é um objeto de API, o toJSON
método devolve um objeto JavaScript simples (escrito como Word.Interfaces.TableStyleData
) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Word.Interfaces.TableStyleData;
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.TableStyle;
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.TableStyle;
Retornos
Comentários do Office Add-ins
O Office Add-ins é um projeto código aberto. Selecione um link para fornecer comentários: