Excel.DataValidation class
Representa a validação de dados aplicada ao intervalo atual. Para saber mais sobre o modelo de objeto de validação de dados, leia Adicionar validação de dados a intervalos do Excel.
- Extends
Comentários
[Conjunto de apis: ExcelApi 1.8]
Propriedades
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| error |
Alerta de erro quando o usuário insere dados inválidos. |
| ignore |
Especifica se a validação de dados será executada em células em branco. O padrão é |
| prompt | Solicitar quando os usuários selecionarem uma célula. |
| rule | Regra de validação de dados que contém diferentes tipos de critérios de validação de dados. |
| type | Tipo de validação de dados, consulte |
| valid | Representa se todos os valores de célula são válidos de acordo com as regras de validação de dados. Retorna |
Métodos
| clear() | Desfazer a validação de dados do intervalo atual. |
| get |
Retorna um |
| get |
Retorna um |
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| 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. |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
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
errorAlert
Alerta de erro quando o usuário insere dados inválidos.
errorAlert: Excel.DataValidationErrorAlert;Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.8]
ignoreBlanks
Especifica se a validação de dados será executada em células em branco. O padrão é true.
ignoreBlanks: boolean;Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.8]
prompt
Solicitar quando os usuários selecionarem uma célula.
prompt: Excel.DataValidationPrompt;Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.8]
rule
Regra de validação de dados que contém diferentes tipos de critérios de validação de dados.
rule: Excel.DataValidationRule;Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.8]
type
Tipo de validação de dados, consulte Excel.DataValidationType para obter detalhes.
readonly type: Excel.DataValidationType | "None" | "WholeNumber" | "Decimal" | "List" | "Date" | "Time" | "TextLength" | "Custom" | "Inconsistent" | "MixedCriteria";Valor da propriedade
Excel.DataValidationType | "None" | "WholeNumber" | "Decimal" | "List" | "Date" | "Time" | "TextLength" | "Custom" | "Inconsistent" | "MixedCriteria"
Comentários
[Conjunto de apis: ExcelApi 1.8]
valid
Representa se todos os valores de célula são válidos de acordo com as regras de validação de dados. Retorna true se todos os valores de célula são válidos ou false se todos os valores de célula são inválidos. Retorna null se há valores de célula válidos e inválidos no intervalo.
readonly valid: boolean;Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.8]
Detalhes do método
clear()
Desfazer a validação de dados do intervalo atual.
clear(): void;Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.8]
getInvalidCells()
Retorna um RangeAreas objeto, compreendendo um ou mais intervalos retangulares, com valores de célula inválidos. Se todos os valores de célula forem válidos, essa função gerará um ItemNotFound erro.
getInvalidCells(): Excel.RangeAreas;Retornos
Comentários
[Conjunto de apis: ExcelApi 1.9]
getInvalidCellsOrNullObject()
Retorna um RangeAreas objeto, compreendendo um ou mais intervalos retangulares, com valores de célula inválidos. Se todos os valores de célula forem válidos, esta função retornará null.
getInvalidCellsOrNullObject(): Excel.RangeAreas;Retornos
Comentários
[Conjunto de apis: ExcelApi 1.9]
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.DataValidationLoadOptions): Excel.DataValidation;Parâmetros
Fornece opções para quais propriedades do objeto devem ser carregadas.
Retornos
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.DataValidation;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.
Retornos
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.DataValidation;Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.
Retornos
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.DataValidationUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Excel.Interfaces.DataValidationUpdateData
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 de propriedades tentar definir 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.DataValidation): void;Parâmetros
- properties
- Excel.DataValidation
Retornos
void
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Excel.DataValidation é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.DataValidationData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.DataValidationData;