Excel.AllowEditRangeCollection class

Pacote:

excel

Representa o conjunto de AllowEditRange objetos encontrados numa folha de cálculo. AllowEditRange Os objetos funcionam com as propriedades de proteção da folha de cálculo. Quando a proteção da folha de cálculo está ativada, um AllowEditRange objeto pode ser utilizado para permitir a edição de um intervalo específico, mantendo a proteção no resto da folha de cálculo.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

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(title, rangeAddress, options)	Adiciona um AllowEditRange objeto à folha de cálculo. A proteção da folha de cálculo tem de ser desativada ou colocada em pausa para que este método funcione corretamente. Se a proteção da folha de cálculo estiver ativada e não estiver em pausa, este método gera um AccessDenied erro e a operação de adição falha.
getCount()	Devolve o número de AllowEditRange objetos na coleção.
getItem(key)	Obtém o AllowEditRange objeto pelo respetivo título.
getItemAt(index)	Devolve um AllowEditRange objeto pelo respetivo índice na coleção.
getItemOrNullObject(key)	Obtém o AllowEditRange objeto pelo respetivo 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)	Coloca em pausa a proteção da folha de cálculo para todos os AllowEditRange objetos encontrados nesta folha de cálculo que tenham a palavra-passe especificada para o utilizador na sessão atual. Este método não faz nada se a proteção da folha de cálculo não estiver ativada ou estiver em pausa. Se não for possível colocar a proteção da folha de cálculo em pausa, este método gera um UnsupportedOperation erro e falha ao colocar em pausa a proteção do intervalo. Se a palavra-passe não corresponder a nenhum AllowEditRange objeto na coleção, este método gera um BadPassword erro e falha ao colocar em pausa a proteção de qualquer intervalo na coleção.
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.AllowEditRangeCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito 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 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

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 à folha de cálculo. A proteção da folha de cálculo tem de ser desativada ou colocada em pausa para que este método funcione corretamente. Se a proteção da folha de cálculo estiver ativada e não estiver em pausa, este método gera um AccessDenied erro e a operação de adição falha.

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

Parâmetros

title

string

A cadeia de título do AllowEditRange objeto a adicionar.

rangeAddress

string

O endereço de intervalo do AllowEditRange objeto a adicionar.

options

Excel.AllowEditRangeOptions

Opções adicionais a adicionar ao AllowEditRange objeto, como a palavra-passe.

Retornos

void

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

getCount()

Devolve 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 respetivo 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 existir nenhum AllowEditRange com o título especificado, é gerado um ItemNotFound erro.

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

getItemAt(index)

Devolve um AllowEditRange objeto pelo respetivo índice na coleção.

getItemAt(index: number): Excel.AllowEditRange;

Parâmetros

index

number

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

Retornos

Excel.AllowEditRange

No AllowEditRange índice indicado.

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

getItemOrNullObject(key)

Obtém o AllowEditRange objeto pelo respetivo 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 existir nenhum AllowEditRange com o título especificado, 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).

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

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

Excel.AllowEditRangeCollection

pauseProtection(password)

Coloca em pausa a proteção da folha de cálculo para todos os AllowEditRange objetos encontrados nesta folha de cálculo que tenham a palavra-passe especificada para o utilizador na sessão atual. Este método não faz nada se a proteção da folha de cálculo não estiver ativada ou estiver em pausa. Se não for possível colocar a proteção da folha de cálculo em pausa, este método gera um UnsupportedOperation erro e falha ao colocar em pausa a proteção do intervalo. Se a palavra-passe não corresponder a nenhum AllowEditRange objeto na coleção, este método gera um BadPassword erro e falha ao colocar em pausa a proteção de qualquer intervalo na coleção.

pauseProtection(password: string): void;

Parâmetros

password

string

A palavra-passe para colocar em pausa 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 é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.AllowEditRangeCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito 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