Excel.AllowEditRangeCollection class

Pacote:

excel

Representa o conjunto de AllowEditRange objetos encontrados em uma planilha. AllowEditRange os objetos funcionam com propriedades de proteção de planilha. Quando a proteção de planilha está habilitada, um AllowEditRange objeto pode ser usado para permitir a edição de um intervalo específico, mantendo a proteção no restante da planilha.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

Propriedades

context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
items	Obtém os itens filhos carregados nesta coleção.

Métodos

add(title, rangeAddress, options)	Adiciona um AllowEditRange objeto à planilha. A proteção de planilha deve ser desabilitada ou pausada para que esse método funcione corretamente. Se a proteção de planilha estiver habilitada e não pausada, esse método gerará um AccessDenied erro e a operação de adição falhará.
getCount()	Retorna o número de AllowEditRange objetos na coleção.
getItem(key)	Obtém o AllowEditRange objeto pelo título.
getItemAt(index)	Retorna um AllowEditRange objeto por seu índice na coleção.
getItemOrNullObject(key)	Obtém o AllowEditRange objeto pelo título.
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.
pauseProtection(password)	Pausa a proteção de planilha para todos os AllowEditRange objetos encontrados nesta planilha que têm a senha fornecida para o usuário na sessão atual. Esse método não faz nada se a proteção de planilha não estiver habilitada ou for pausada. Se a proteção de planilha não puder ser pausada, esse método gerará um UnsupportedOperation erro e falhará em pausar a proteção para o intervalo. Se a senha não corresponder a nenhum AllowEditRange objeto na coleção, esse método gerará um BadPassword erro e falhará em pausar a proteção para qualquer intervalo na coleção.
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.AllowEditRangeCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.AllowEditRangeCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

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

items

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

readonly items: Excel.AllowEditRange[];

Valor da propriedade

Excel.AllowEditRange[]

Detalhes do método

add(title, rangeAddress, options)

Adiciona um AllowEditRange objeto à planilha. A proteção de planilha deve ser desabilitada ou pausada para que esse método funcione corretamente. Se a proteção de planilha estiver habilitada e não pausada, esse método gerará um AccessDenied erro e a operação de adição falhará.

add(title: string, rangeAddress: string, options?: Excel.AllowEditRangeOptions): void;

Parâmetros

title

string

A cadeia de caracteres de título do objeto a AllowEditRange ser adicionado.

rangeAddress

string

O endereço de intervalo do objeto a AllowEditRange ser adicionado.

options

Excel.AllowEditRangeOptions

Opções adicionais a serem adicionadas ao AllowEditRange objeto, como a senha.

Retornos

void

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

getCount()

Retorna o número de AllowEditRange objetos na coleção.

getCount(): OfficeExtension.ClientResult<number>;

Retornos

OfficeExtension.ClientResult<number>

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

getItem(key)

Obtém o AllowEditRange objeto pelo título.

getItem(key: string): Excel.AllowEditRange;

Parâmetros

key

string

O título do AllowEditRange.

Retornos

Excel.AllowEditRange

O AllowEditRange com o título. Se não houver nenhum AllowEditRange com o título determinado, um ItemNotFound erro será gerado.

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

getItemAt(index)

Retorna um AllowEditRange objeto por seu índice na coleção.

getItemAt(index: number): Excel.AllowEditRange;

Parâmetros

index

number

O índice do AllowEditRange objeto na coleção.

Retornos

Excel.AllowEditRange

O AllowEditRange no índice determinado.

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

getItemOrNullObject(key)

Obtém o AllowEditRange objeto pelo título.

getItemOrNullObject(key: string): Excel.AllowEditRange;

Parâmetros

key

string

O título do AllowEditRange.

Retornos

Excel.AllowEditRange

O AllowEditRange com o título. Se não houver nenhum AllowEditRange com o título fornecido, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

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.AllowEditRangeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.AllowEditRangeCollection;

Parâmetros

options

Excel.Interfaces.AllowEditRangeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

Retornos

Excel.AllowEditRangeCollection

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

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

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

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

Excel.AllowEditRangeCollection

pauseProtection(password)

Pausa a proteção de planilha para todos os AllowEditRange objetos encontrados nesta planilha que têm a senha fornecida para o usuário na sessão atual. Esse método não faz nada se a proteção de planilha não estiver habilitada ou for pausada. Se a proteção de planilha não puder ser pausada, esse método gerará um UnsupportedOperation erro e falhará em pausar a proteção para o intervalo. Se a senha não corresponder a nenhum AllowEditRange objeto na coleção, esse método gerará um BadPassword erro e falhará em pausar a proteção para qualquer intervalo na coleção.

pauseProtection(password: string): void;

Parâmetros

password

string

A senha para pausar a proteção nos AllowEditRange objetos.

Retornos

void

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

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

toJSON(): Excel.Interfaces.AllowEditRangeCollectionData;

Retornos

Excel.Interfaces.AllowEditRangeCollectionData