Word.TableStyle class
Representa o TableStyle objeto .
- Extends
Comentários
[ Conjunto de API: WordApi 1.6 ]
Exemplos
// 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 = (document.getElementById("style-name") as HTMLInputElement).value;
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);
(document.getElementById("alignment") as HTMLInputElement).value = tableStyle.alignment;
(document.getElementById("allow-break-across-page") as HTMLInputElement).value = tableStyle.allowBreakAcrossPage.toString();
(document.getElementById("top-cell-margin") as HTMLInputElement).value = tableStyle.topCellMargin;
(document.getElementById("bottom-cell-margin") as HTMLInputElement).value = tableStyle.bottomCellMargin;
(document.getElementById("left-cell-margin") as HTMLInputElement).value = tableStyle.leftCellMargin;
(document.getElementById("right-cell-margin") as HTMLInputElement).value = tableStyle.rightCellMargin;
(document.getElementById("cell-spacing") as HTMLInputElement).value = tableStyle.cellSpacing;
});
Propriedades
| alignment | Especifica o alinhamento da tabela em relação à margem da página. |
| allow |
Especifica se as linhas em tabelas formatadas com uma quebra de estilo nas páginas. |
| borders | Devolve um |
| 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. |
| column |
Especifica o número de colunas na faixa quando um estilo especifica a banda de colunas pares ou ímpares. |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| is |
Especifica se o Microsoft Word permite quebrar a tabela especificada entre páginas. |
| left |
Especifica a quantidade de espaço a adicionar entre os conteúdos e os limites esquerdos das células. |
| left |
Especifica o valor de avanço esquerdo (em pontos) para as linhas no estilo de tabela. |
| right |
Especifica a quantidade de espaço a adicionar entre os conteúdos e os limites direitos das células. |
| row |
Especifica o número de linhas a incluir na faixa quando o estilo especifica a banda de linhas pares ou ímpares. |
| shading | Devolve um |
| table |
Especifica a direção em que a Microsoft Word ordena as células no estilo de tabela. |
| top |
Especifica a quantidade de espaço a adicionar entre os conteúdos e os limites superiores das células. |
Métodos
| condition(condition |
Devolve um objeto que representa uma |
| condition(condition |
Devolve um objeto que representa uma |
| 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 |
Detalhes da propriedade
alignment
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
allowBreakAcrossPage
Especifica se as linhas em tabelas formatadas com uma quebra de estilo nas páginas.
allowBreakAcrossPage: boolean;Valor da propriedade
boolean
Comentários
borders
Devolve um BorderUniversalCollection que representa todos os limites da tabela.
readonly borders: Word.BorderUniversalCollection;Valor da propriedade
Comentários
bottomCellMargin
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
cellSpacing
Especifica o espaçamento (em pontos) entre as células num estilo de tabela.
cellSpacing: number;Valor da propriedade
number
Comentários
columnStripe
Especifica o número de colunas na faixa quando um estilo especifica a banda de colunas pares ou ímpares.
columnStripe: number;Valor da propriedade
number
Comentários
context
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
isBreakAcrossPagesAllowed
Especifica se o Microsoft Word permite quebrar a tabela especificada entre páginas.
isBreakAcrossPagesAllowed: boolean;Valor da propriedade
boolean
Comentários
leftCellMargin
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
leftIndent
Especifica o valor de avanço esquerdo (em pontos) para as linhas no estilo de tabela.
leftIndent: number;Valor da propriedade
number
Comentários
rightCellMargin
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
rowStripe
Especifica o número de linhas a incluir na faixa quando o estilo especifica a banda de linhas pares ou ímpares.
rowStripe: number;Valor da propriedade
number
Comentários
shading
Devolve um ShadingUniversal objeto que se refere à formatação de sombreado para o estilo de tabela.
readonly shading: Word.Shading;Valor da propriedade
Comentários
tableDirection
Especifica a direção em que a Microsoft Word ordena as células no estilo de tabela.
tableDirection: Word.TableDirection | "RightToLeft" | "LeftToRight";Valor da propriedade
Word.TableDirection | "RightToLeft" | "LeftToRight"
Comentários
topCellMargin
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
Detalhes do método
condition(conditionCode)
Devolve um objeto que representa uma ConditionalStyle formatação de estilo especial para uma parte de uma tabela.
condition(conditionCode: Word.ConditionCode): Word.ConditionalStyle;Parâmetros
- conditionCode
- Word.ConditionCode
A área da tabela à qual pretende aplicar a formatação.
Retornos
Comentários
condition(conditionCode)
Devolve um objeto que representa uma ConditionalStyle formatação de estilo especial para uma parte de uma tabela.
condition(conditionCode: "FirstRow" | "LastRow" | "OddRowBanding" | "EvenRowBanding" | "FirstColumn" | "LastColumn" | "OddColumnBanding" | "EvenColumnBanding" | "TopRightCell" | "TopLeftCell" | "BottomRightCell" | "BottomLeftCell"): Word.ConditionalStyle;Parâmetros
- conditionCode
-
"FirstRow" | "LastRow" | "OddRowBanding" | "EvenRowBanding" | "FirstColumn" | "LastColumn" | "OddColumnBanding" | "EvenColumnBanding" | "TopRightCell" | "TopLeftCell" | "BottomRightCell" | "BottomLeftCell"
A área da tabela à qual pretende aplicar a formatação.
Retornos
Comentários
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
Fornece opções para as propriedades do objeto a carregar.
Retornos
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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
Retornos
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 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
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: 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
set(properties)
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
toJSON()
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.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
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 .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
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 context.sync() antes de a libertação da memória ser aplicada.
untrack(): Word.TableStyle;