Excel.ConditionalRangeBorderCollection class
Representa os objetos de borda que compõem a borda do intervalo.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.6 ]
Propriedades
| bottom | Obtém o limite inferior. |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| count | Número de objetos de borda da coleção. |
| items | Obtém os itens filhos carregados nesta coleção. |
| left | Obtém o limite esquerdo. |
| right | Obtém o limite certo. |
| top | Obtém o limite superior. |
Métodos
| get |
Obtém um objeto Border usando o respectivo nome. |
| get |
Obtém um objeto Border usando o respectivo nome. |
| get |
Obtém um objeto Border usando o respectivo índice. |
| 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 |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
bottom
Obtém o limite inferior.
readonly bottom: Excel.ConditionalRangeBorder;Valor da propriedade
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
count
Número de objetos de borda da coleção.
readonly count: number;Valor da propriedade
number
Comentários
items
Obtém os itens filhos carregados nesta coleção.
readonly items: Excel.ConditionalRangeBorder[];Valor da propriedade
left
Obtém o limite esquerdo.
readonly left: Excel.ConditionalRangeBorder;Valor da propriedade
Comentários
right
Obtém o limite certo.
readonly right: Excel.ConditionalRangeBorder;Valor da propriedade
Comentários
top
Obtém o limite superior.
readonly top: Excel.ConditionalRangeBorder;Valor da propriedade
Comentários
Detalhes do método
getItem(index)
Obtém um objeto Border usando o respectivo nome.
getItem(index: Excel.ConditionalRangeBorderIndex): Excel.ConditionalRangeBorder;Parâmetros
Valor de índice do objeto Border a ser recuperado. Veja Excel.ConditionalRangeBorderIndex para obter detalhes.
Retornos
Comentários
getItem(indexString)
Obtém um objeto Border usando o respectivo nome.
getItem(indexString: "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight"): Excel.ConditionalRangeBorder;Parâmetros
- indexString
-
"EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight"
Valor de índice do objeto Border a ser recuperado. Veja Excel.ConditionalRangeBorderIndex para obter detalhes.
Retornos
Comentários
getItemAt(index)
Obtém um objeto Border usando o respectivo índice.
getItemAt(index: number): Excel.ConditionalRangeBorder;Parâmetros
- index
-
number
Valor de índice do objeto a ser recuperado. Indexados com zero.
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?: Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ConditionalRangeBorderCollection;Parâmetros
- options
-
Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions & 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.ConditionalRangeBorderCollection;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.ConditionalRangeBorderCollection;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
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.ConditionalRangeBorderCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ConditionalRangeBorderCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): Excel.Interfaces.ConditionalRangeBorderCollectionData;