Excel.AllowEditRange class

Pacote:

excel

Representa um AllowEditRange objeto encontrado em uma planilha. Esse objeto funciona 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

address	Especifica o intervalo associado ao objeto. 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 for pausada, esse método gerará um AccessDenied erro e não definirá o intervalo.
context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
isPasswordProtected	Especifica se o objeto está protegido por senha.
title	Especifica o título do objeto. 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 for pausada, esse método gerará um AccessDenied erro e não definirá o título. Se já houver um existente AllowEditRange com a mesma cadeia de caracteres ou se a cadeia de caracteres estiver null ou vazia (""), esse método gerará um InvalidArgument erro e não definirá o título.

Métodos

delete()	Exclui o objeto do AllowEditRangeCollection. 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 for pausada, esse método gerará um AccessDenied erro e falhará na operação de exclusão.
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 o objeto 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 já estiver 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 objeto. Se a senha estiver incorreta, esse método gera um BadPassword erro e falha ao pausar a proteção para o objeto. Se uma senha for fornecida, mas o objeto não exigir uma senha, a senha inserida será ignorada e a operação será bem-sucedida.
set(properties, options)	Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties)	Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
setPassword(password)	Altera a senha associada ao objeto. Definir a cadeia de caracteres de senha como vazia ("") ou null removerá a proteção de senha do objeto. 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 conjunto falhará.
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.) Enquanto o objeto Excel.AllowEditRange original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.AllowEditRangeData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

Detalhes da propriedade

address

Especifica o intervalo associado ao objeto. 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 for pausada, esse método gerará um AccessDenied erro e não definirá o intervalo.

address: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

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

isPasswordProtected

Especifica se o objeto está protegido por senha.

readonly isPasswordProtected: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

title

Especifica o título do objeto. 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 for pausada, esse método gerará um AccessDenied erro e não definirá o título. Se já houver um existente AllowEditRange com a mesma cadeia de caracteres ou se a cadeia de caracteres estiver null ou vazia (""), esse método gerará um InvalidArgument erro e não definirá o título.

title: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

Detalhes do método

delete()

Exclui o objeto do AllowEditRangeCollection. 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 for pausada, esse método gerará um AccessDenied erro e falhará na operação de exclusão.

delete(): void;

Retornos

void

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.AllowEditRangeLoadOptions): Excel.AllowEditRange;

Parâmetros

options

Excel.Interfaces.AllowEditRangeLoadOptions

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

Retornos

Excel.AllowEditRange

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

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

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?: {
            select?: string;
            expand?: string;
        }): Excel.AllowEditRange;

Parâmetros

propertyNamesAndPaths

{ select?: string; expand?: string; }

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

pauseProtection(password)

Pausa a proteção de planilha para o objeto 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 já estiver 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 objeto. Se a senha estiver incorreta, esse método gera um BadPassword erro e falha ao pausar a proteção para o objeto. Se uma senha for fornecida, mas o objeto não exigir uma senha, a senha inserida será ignorada e a operação será bem-sucedida.

pauseProtection(password?: string): void;

Parâmetros

password

string

A senha associada ao AllowEditRange objeto.

Retornos

void

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.AllowEditRangeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties

Excel.Interfaces.AllowEditRangeUpdateData

Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.

options

OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Excel.AllowEditRange): void;

Parâmetros

properties

Excel.AllowEditRange

Retornos

void

setPassword(password)

Altera a senha associada ao objeto. Definir a cadeia de caracteres de senha como vazia ("") ou null removerá a proteção de senha do objeto. 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 conjunto falhará.

setPassword(password?: string): void;

Parâmetros

password

string

A senha associada ao AllowEditRange objeto.

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.) Enquanto o objeto Excel.AllowEditRange original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.AllowEditRangeData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.AllowEditRangeData;

Retornos

Excel.Interfaces.AllowEditRangeData