Share via


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 a borda inferior.

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host 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 a borda esquerda.

right

Obtém a borda direita.

top

Obtém a borda superior.

Métodos

getItem(index)

Obtém um objeto Border usando o respectivo nome.

getItem(indexString)

Obtém um objeto Border usando o respectivo nome.

getItemAt(index)

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

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

Detalhes da propriedade

bottom

Obtém a borda inferior.

readonly bottom: Excel.ConditionalRangeBorder;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

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

count

Número de objetos de borda da coleção.

readonly count: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

items

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

readonly items: Excel.ConditionalRangeBorder[];

Valor da propriedade

left

Obtém a borda esquerda.

readonly left: Excel.ConditionalRangeBorder;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

right

Obtém a borda direita.

readonly right: Excel.ConditionalRangeBorder;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

top

Obtém a borda superior.

readonly top: Excel.ConditionalRangeBorder;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

Detalhes do método

getItem(index)

Obtém um objeto Border usando o respectivo nome.

getItem(index: Excel.ConditionalRangeBorderIndex): Excel.ConditionalRangeBorder;

Parâmetros

index
Excel.ConditionalRangeBorderIndex

Valor de índice do objeto Border a ser recuperado. Confira Excel.ConditionalRangeBorderIndex detalhes.

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

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. Confira Excel.ConditionalRangeBorderIndex detalhes.

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

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

[ Conjunto de API: ExcelApi 1.6 ]

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 quais propriedades do objeto 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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

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

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.ConditionalRangeBorderCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado 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;

Retornos