ExcelScript.AllowEditRange interface
Representa um AllowEditRange objeto encontrado em uma planilha. Esse objeto funciona com propriedades de proteção de planilha. Quando a proteção da 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.
Métodos
| delete() | Exclui o objeto do |
| get |
Especifica o intervalo associado ao objeto. |
| get |
Especifica se o objeto é protegido por senha. |
| get |
Especifica o título do objeto. |
| pause |
Pausa a proteção da planilha para o objeto para o usuário na sessão atual. Esse método não fará nada se a proteção da planilha não estiver habilitada ou já estiver pausada. Se a proteção da planilha não puder ser pausada, esse método gerará um |
| set |
Especifica o intervalo associado ao objeto. A proteção da planilha deve ser desabilitada ou pausada para que esse método funcione corretamente. Se a proteção da planilha estiver habilitada e não pausada, esse método gerará um |
| set |
Altera a senha associada ao objeto. Definir a cadeia de caracteres de senha como vazia ("") ou |
| set |
Especifica o título do objeto. A proteção da planilha deve ser desabilitada ou pausada para que esse método funcione corretamente. Se a proteção da planilha estiver habilitada e não pausada, esse método gerará um |
Detalhes do método
delete()
Exclui o objeto do AllowEditRangeCollectionarquivo . A proteção da planilha deve ser desabilitada ou pausada para que esse método funcione corretamente. Se a proteção da planilha estiver habilitada e não pausada, esse método gerará um AccessDenied erro e falhará na operação de exclusão.
delete(): void;
Retornos
void
getAddress()
Especifica o intervalo associado ao objeto.
getAddress(): string;
Retornos
string
getIsPasswordProtected()
Especifica se o objeto é protegido por senha.
getIsPasswordProtected(): boolean;
Retornos
boolean
getTitle()
Especifica o título do objeto.
getTitle(): string;
Retornos
string
pauseProtection(password)
Pausa a proteção da planilha para o objeto para o usuário na sessão atual. Esse método não fará nada se a proteção da planilha não estiver habilitada ou já estiver pausada. Se a proteção da planilha não puder ser pausada, esse método gerará um UnsupportedOperation erro e não pausará a proteção para o objeto. Se a senha estiver incorreta, esse método gerará um BadPassword erro e falhará 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 terá êxito.
pauseProtection(password?: string): void;
Parâmetros
- password
-
string
A senha associada ao AllowEditRange objeto.
Retornos
void
setAddress(address)
Especifica o intervalo associado ao objeto. A proteção da planilha deve ser desabilitada ou pausada para que esse método funcione corretamente. Se a proteção da planilha estiver habilitada e não pausada, esse método gerará um AccessDenied erro e não definirá o intervalo.
setAddress(address: string): void;
Parâmetros
- address
-
string
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 por senha do objeto. A proteção da planilha deve ser desabilitada ou pausada para que esse método funcione corretamente. Se a proteção da planilha estiver habilitada e não pausada, esse método gerará um AccessDenied erro e a operação set falhará.
setPassword(password?: string): void;
Parâmetros
- password
-
string
A senha associada ao AllowEditRange objeto.
Retornos
void
setTitle(title)
Especifica o título do objeto. A proteção da planilha deve ser desabilitada ou pausada para que esse método funcione corretamente. Se a proteção da planilha estiver habilitada e não pausada, esse método gerará um AccessDenied erro e falhará ao definir o título. Se já houver um existente AllowEditRange com a mesma cadeia de caracteres, ou se a cadeia de caracteres estiver null vazia (""), esse método gerará um InvalidArgument erro e não definirá o título.
setTitle(title: string): void;
Parâmetros
- title
-
string
Retornos
void