Excel.TimelineStyle class

Pacote:

excel

Representa um TimelineStyle, que define elementos de estilo por região na linha do tempo.

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.
name	Especifica o nome do estilo da linha do tempo.
readOnly	Especifica se esse TimelineStyle objeto é somente leitura.

Métodos

delete()	Exclui o estilo de tabela.
duplicate()	Cria uma duplicata desse estilo de linha do tempo com cópias de todos os elementos de estilo.
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 objeto Excel.TimelineStyle original é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.TimelineStyleData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

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

name

Especifica o nome do estilo da linha do tempo.

name: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

readOnly

Especifica se esse TimelineStyle objeto é somente leitura.

readonly readOnly: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

Detalhes do método

delete()

Exclui o estilo de tabela.

delete(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

duplicate()

Cria uma duplicata desse estilo de linha do tempo com cópias de todos os elementos de estilo.

duplicate(): Excel.TimelineStyle;

Retornos

Excel.TimelineStyle

O novo TimelineStyle objeto que foi duplicado desse estilo de linha do tempo.

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.TimelineStyleLoadOptions): Excel.TimelineStyle;

Parâmetros

options

Excel.Interfaces.TimelineStyleLoadOptions

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

Retornos

Excel.TimelineStyle

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

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

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;
        }): Excel.TimelineStyle;

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

Excel.TimelineStyle

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

Parâmetros

properties

Excel.Interfaces.TimelineStyleUpdateData

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

Parâmetros

properties

Excel.TimelineStyle

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

toJSON(): Excel.Interfaces.TimelineStyleData;

Retornos

Excel.Interfaces.TimelineStyleData