Excel.TimelineStyleCollection interface

Representa uma coleção de TimelineStyles.

Métodos

add(name, makeUniqueName)

Cria um TimelineStyle em branco com o nome especificado.

getCount()

Obtém o número de estilos de linha do tempo na coleção.

getDefault()

Obtém o padrão TimelineStyle para o escopo do objeto pai.

getItem(name)

Obtém uma TimelineStyle por nome.

getItemOrNullObject(name)

Obtém uma TimelineStyle por nome. Se o TimelineStyle não existir, retornará um objeto null.

load(propertyNames)

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 padrão TimelineStyle para uso no escopo do objeto pai.

Detalhes do método

add(name, makeUniqueName)

Cria um TimelineStyle em branco com o nome especificado.

add(name: string, makeUniqueName?: boolean): TimelineStyle;

Parâmetros

name
string

O nome exclusivo para o novo timelinestyle. Lançará uma exceção de argumento inválida se o nome já estiver em uso.

makeUniqueName
boolean

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

Retornos

getCount()

Obtém o número de estilos de linha do tempo na coleção.

getCount(): ClientResult<number>;

Retornos

ClientResult<number>

getDefault()

Obtém o padrão TimelineStyle para o escopo do objeto pai.

getDefault(): TimelineStyle;

Retornos

getItem(name)

Obtém uma TimelineStyle por nome.

getItem(name: string): TimelineStyle;

Parâmetros

name
string

Nome do timelinestyle a ser recuperado.

Retornos

getItemOrNullObject(name)

Obtém uma TimelineStyle por nome. Se o TimelineStyle não existir, retornará um objeto null.

getItemOrNullObject(name: string): TimelineStyle;

Parâmetros

name
string

Nome do timelinestyle a ser recuperado.

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[]): void;

Parâmetros

propertyNames
string | string[]

Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

void

setDefault(newDefaultStyle)

Define o padrão TimelineStyle para uso no escopo do objeto pai.

setDefault(newDefaultStyle: TimelineStyle | string): void;

Parâmetros

newDefaultStyle
TimelineStyle | string

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

Retornos

void