Excel.TableStyleCollection class

Pacote:

excel

Representa uma coleção de estilos de tabela.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

Propriedades

context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
items	Obtém os itens filhos carregados nesta coleção.

Métodos

add(name, makeUniqueName)	Cria um em branco TableStyle com o nome especificado.
getCount()	Obtém o número de estilos de tabelas na coleção.
getDefault()	Obtém o estilo de tabela padrão para o escopo do objeto pai.
getItem(name)	Obtém um TableStyle por nome.
getItemOrNullObject(name)	Obtém um TableStyle por nome. Se o estilo de tabela não existir, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
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.
setDefault(newDefaultStyle)	Define o estilo de tabela padrão para uso no escopo do objeto pai.
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.) Considerando que o objeto original Excel.TableStyleCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.TableStyleCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

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

Excel.RequestContext

items

Obtém os itens filhos carregados nesta coleção.

readonly items: Excel.TableStyle[];

Valor da propriedade

Excel.TableStyle[]

Detalhes do método

add(name, makeUniqueName)

Cria um em branco TableStyle com o nome especificado.

add(name: string, makeUniqueName?: boolean): Excel.TableStyle;

Parâmetros

name

string

O nome exclusivo para o novo estilo de tabela. Gerará um InvalidArgument erro se o nome já estiver em uso.

makeUniqueName

boolean

Opcional. Padrão para false. Se true, adicionará números ao nome para torná-lo exclusivo, se necessário.

Retornos

Excel.TableStyle

O recém-criado TableStyle.

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

getCount()

Obtém o número de estilos de tabelas na coleção.

getCount(): OfficeExtension.ClientResult<number>;

Retornos

OfficeExtension.ClientResult<number>

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

getDefault()

Obtém o estilo de tabela padrão para o escopo do objeto pai.

getDefault(): Excel.TableStyle;

Retornos

Excel.TableStyle

O TableStyle objeto que é o estilo de tabela padrão atual.

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

getItem(name)

Obtém um TableStyle por nome.

getItem(name: string): Excel.TableStyle;

Parâmetros

name

string

Nome do estilo de tabela a ser recuperado.

Retornos

Excel.TableStyle

O TableStyle objeto cujo nome corresponde à entrada.

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

getItemOrNullObject(name)

Obtém um TableStyle por nome. Se o estilo de tabela não existir, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

getItemOrNullObject(name: string): Excel.TableStyle;

Parâmetros

name

string

Nome do estilo de tabela a ser recuperado.

Retornos

Excel.TableStyle

O TableStyle objeto cujo nome corresponde à entrada.

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

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?: Excel.Interfaces.TableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableStyleCollection;

Parâmetros

options

Excel.Interfaces.TableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

Retornos

Excel.TableStyleCollection

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[]): Excel.TableStyleCollection;

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

Excel.TableStyleCollection

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?: OfficeExtension.LoadOption): Excel.TableStyleCollection;

Parâmetros

propertyNamesAndPaths

OfficeExtension.LoadOption

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

Excel.TableStyleCollection

setDefault(newDefaultStyle)

Define o estilo de tabela padrão para uso no escopo do objeto pai.

setDefault(newDefaultStyle: TableStyle | string): void;

Parâmetros

newDefaultStyle

Excel.TableStyle | string

O TableStyle objeto, ou nome do TableStyle objeto, que deve ser o novo padrão.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

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.) Considerando que o objeto original Excel.TableStyleCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.TableStyleCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

toJSON(): Excel.Interfaces.TableStyleCollectionData;

Retornos

Excel.Interfaces.TableStyleCollectionData