Excel.TimelineStyleCollection class
Representa uma coleção de estilos de linha cronológica.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.10 ]
Propriedades
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| items | Obtém os itens filhos carregados nesta coleção. |
Métodos
| add(name, make |
Cria um espaço em branco |
| get |
Obtém o número de estilos de linha do tempo na coleção. |
| get |
Obtém o estilo de linha cronológica predefinido para o âmbito do objeto principal. |
| get |
Obtém um |
| get |
Obtém um |
| 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 |
Define o estilo de linha cronológica predefinido para utilização no âmbito do objeto principal. |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
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
items
Obtém os itens filhos carregados nesta coleção.
readonly items: Excel.TimelineStyle[];Valor da propriedade
Detalhes do método
add(name, makeUniqueName)
Cria um espaço em branco TimelineStyle com o nome especificado.
add(name: string, makeUniqueName?: boolean): Excel.TimelineStyle;Parâmetros
- name
-
string
O nome exclusivo do novo estilo de linha cronológica. Emitirá um InvalidArgument erro se o nome já estiver a ser utilizado.
- makeUniqueName
-
boolean
Opcional. A predefinição é false. Se true, irá acrescentar números ao nome para torná-lo exclusivo, se necessário.
Retornos
O recém-criado TimelineStyle.
Comentários
getCount()
Obtém o número de estilos de linha do tempo na coleção.
getCount(): OfficeExtension.ClientResult<number>;Retornos
OfficeExtension.ClientResult<number>
Comentários
getDefault()
Obtém o estilo de linha cronológica predefinido para o âmbito do objeto principal.
getDefault(): Excel.TimelineStyle;Retornos
O TimelineStyle objeto que é o estilo de linha cronológica predefinido atual.
Comentários
getItem(name)
Obtém um TimelineStyle pelo nome.
getItem(name: string): Excel.TimelineStyle;Parâmetros
- name
-
string
Nome do estilo de linha cronológica a obter.
Retornos
O TimelineStyle objeto cujo nome corresponde à entrada.
Comentários
getItemOrNullObject(name)
Obtém um TimelineStyle pelo nome. Se o estilo da linha cronológica não existir, este método devolve um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
getItemOrNullObject(name: string): Excel.TimelineStyle;Parâmetros
- name
-
string
Nome do estilo de linha cronológica a obter.
Retornos
O TimelineStyle objeto cujo nome corresponde à entrada.
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?: Excel.Interfaces.TimelineStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TimelineStyleCollection;Parâmetros
- options
-
Excel.Interfaces.TimelineStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
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[]): Excel.TimelineStyleCollection;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?: OfficeExtension.LoadOption): Excel.TimelineStyleCollection;Parâmetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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
setDefault(newDefaultStyle)
Define o estilo de linha cronológica predefinido para utilização no âmbito do objeto principal.
setDefault(newDefaultStyle: TimelineStyle | string): void;Parâmetros
- newDefaultStyle
-
Excel.TimelineStyle | string
O TimelineStyle objeto, ou nome do TimelineStyle objeto, que deve ser a nova predefinição.
Retornos
void
Comentários
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 Excel.TimelineStyleCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.TimelineStyleCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): Excel.Interfaces.TimelineStyleCollectionData;