Compartilhar via

ExcelScript.AllowEditRange interface

  • Referência
Pacote:
ExcelScript

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.

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.
getAddress()

Especifica o intervalo associado ao objeto.
getIsPasswordProtected()

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

Especifica o título do objeto.
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.
setAddress(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.
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.
setTitle(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.

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

getAddress()

Especifica o intervalo associado ao objeto.

getAddress(): string;

Retornos

string

getIsPasswordProtected()

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

getIsPasswordProtected(): boolean;

Retornos

boolean

getTitle()

Especifica o título do objeto.

getTitle(): string;

Retornos

string

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

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

setAddress(address: string): void;

Parâmetros

address

string

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

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

setTitle(title: string): void;

Parâmetros

title

string

Retornos

void