Excel.AllowEditRange class

Pacote:

excel

Representa um AllowEditRange objeto encontrado numa folha de cálculo. Este objeto funciona 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

address	Especifica o intervalo associado ao objeto. 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 falha ao definir o intervalo.
context	O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
isPasswordProtected	Especifica se o objeto está protegido por palavra-passe.
title	Especifica o título do objeto. 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 não define o título. Se já existir um com AllowEditRange a mesma cadeia ou se a cadeia estiver null ou estiver vazia (""), este método gera um InvalidArgument erro e falha ao definir o título.

Métodos

delete()	Elimina o objeto de AllowEditRangeCollection. 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 falha na operação de eliminaçã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)	Coloca em pausa a proteção da folha de cálculo para o objeto do 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 já estiver em pausa. Se a proteção da folha de cálculo não puder ser colocada em pausa, este método gera um UnsupportedOperation erro e falha ao colocar em pausa a proteção do objeto. Se a palavra-passe estiver incorreta, este método gera um BadPassword erro e não interrompe a proteção do objeto. Se for fornecida uma palavra-passe, mas o objeto não precisar de uma palavra-passe, a palavra-passe iniciada será ignorada e a operação será bem-sucedida.
set(properties, options)	Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.
set(properties)	Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
setPassword(password)	Altera a palavra-passe associada ao objeto. Definir a cadeia de palavra-passe como vazia ("") ou null removerá a proteção por palavra-passe do objeto. 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 conjunto falha.
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.AllowEditRange é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.AllowEditRangeData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

Detalhes da propriedade

address

Especifica o intervalo associado ao objeto. 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 falha ao definir o intervalo.

address: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

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

isPasswordProtected

Especifica se o objeto está protegido por palavra-passe.

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 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 não define o título. Se já existir um com AllowEditRange a mesma cadeia ou se a cadeia estiver null ou estiver vazia (""), este método gera um InvalidArgument erro e falha ao definir o título.

title: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

Detalhes do método

delete()

Elimina o objeto de AllowEditRangeCollection. 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 falha na operação de eliminaçã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 as propriedades do objeto a 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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

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

pauseProtection(password)

Coloca em pausa a proteção da folha de cálculo para o objeto do 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 já estiver em pausa. Se a proteção da folha de cálculo não puder ser colocada em pausa, este método gera um UnsupportedOperation erro e falha ao colocar em pausa a proteção do objeto. Se a palavra-passe estiver incorreta, este método gera um BadPassword erro e não interrompe a proteção do objeto. Se for fornecida uma palavra-passe, mas o objeto não precisar de uma palavra-passe, a palavra-passe iniciada será ignorada e a operação será bem-sucedida.

pauseProtection(password?: string): void;

Parâmetros

password

string

A palavra-passe 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. Pode transmitir um objeto simples com as propriedades adequadas 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 que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.

options

OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.

Retornos

void

set(properties)

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

set(properties: Excel.AllowEditRange): void;

Parâmetros

properties

Excel.AllowEditRange

Retornos

void

setPassword(password)

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

setPassword(password?: string): void;

Parâmetros

password

string

A palavra-passe 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 é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.AllowEditRange é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.AllowEditRangeData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.AllowEditRangeData;

Retornos

Excel.Interfaces.AllowEditRangeData