Excel.DataValidation class
Representa la validación de datos aplicada al rango actual. Para obtener más información sobre el modelo de objetos de validación de datos, lea Agregar validación de datos a rangos de Excel.
- Extends
Comentarios
[Conjunto de API: ExcelApi 1.8]
Propiedades
| context | El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office. |
| error |
Mensaje de error cuando el usuario escribe datos no válidos. |
| ignore |
Especifica si la validación de datos se realizará en celdas en blanco. El valor predeterminado es |
| prompt | Preguntar cuando los usuarios seleccionan una celda. |
| rule | Regla de validación de datos que contiene diferentes tipos de criterios de validación de datos. |
| type | Tipo de validación de datos, consulte |
| valid | Representa si todos los valores de celda son válidos de acuerdo con las reglas de validación de datos. Devuelve |
Métodos
| clear() | Borra la validación de datos del rango actual. |
| get |
Devuelve un objeto compuesto por uno |
| get |
Devuelve un objeto compuesto por uno |
| load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| set(properties, options) | Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto API del mismo tipo. |
| set(properties) | Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente. |
| toJSON() | Reemplaza el método JavaScript |
Detalles de las propiedades
context
El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.
context: RequestContext;Valor de propiedad
errorAlert
Mensaje de error cuando el usuario escribe datos no válidos.
errorAlert: Excel.DataValidationErrorAlert;Valor de propiedad
Comentarios
[Conjunto de API: ExcelApi 1.8]
ignoreBlanks
Especifica si la validación de datos se realizará en celdas en blanco. El valor predeterminado es true.
ignoreBlanks: boolean;Valor de propiedad
boolean
Comentarios
[Conjunto de API: ExcelApi 1.8]
prompt
Preguntar cuando los usuarios seleccionan una celda.
prompt: Excel.DataValidationPrompt;Valor de propiedad
Comentarios
[Conjunto de API: ExcelApi 1.8]
rule
Regla de validación de datos que contiene diferentes tipos de criterios de validación de datos.
rule: Excel.DataValidationRule;Valor de propiedad
Comentarios
[Conjunto de API: ExcelApi 1.8]
type
Tipo de validación de datos, consulte Excel.DataValidationType para obtener más información.
readonly type: Excel.DataValidationType | "None" | "WholeNumber" | "Decimal" | "List" | "Date" | "Time" | "TextLength" | "Custom" | "Inconsistent" | "MixedCriteria";Valor de propiedad
Excel.DataValidationType | "None" | "WholeNumber" | "Decimal" | "List" | "Date" | "Time" | "TextLength" | "Custom" | "Inconsistent" | "MixedCriteria"
Comentarios
[Conjunto de API: ExcelApi 1.8]
valid
Representa si todos los valores de celda son válidos de acuerdo con las reglas de validación de datos. Devuelve true si todos los valores de celda son válidos o false si todos los valores de celda no son válidos. Devuelve null si hay valores de celda válidos y no válidos dentro del rango.
readonly valid: boolean;Valor de propiedad
boolean
Comentarios
[Conjunto de API: ExcelApi 1.8]
Detalles del método
clear()
Borra la validación de datos del rango actual.
clear(): void;Devoluciones
void
Comentarios
[Conjunto de API: ExcelApi 1.8]
getInvalidCells()
Devuelve un objeto compuesto por uno RangeAreas o varios rangos rectangulares con valores de celda no válidos. Si todos los valores de celda son válidos, esta función generará un ItemNotFound error.
getInvalidCells(): Excel.RangeAreas;Devoluciones
Comentarios
[Conjunto de API: ExcelApi 1.9]
getInvalidCellsOrNullObject()
Devuelve un objeto compuesto por uno RangeAreas o varios rangos rectangulares con valores de celda no válidos. Si todos los valores de celda son válidos, esta función devolverá null.
getInvalidCellsOrNullObject(): Excel.RangeAreas;Devoluciones
Comentarios
[Conjunto de API: ExcelApi 1.9]
load(options)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(options?: Excel.Interfaces.DataValidationLoadOptions): Excel.DataValidation;Parámetros
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
load(propertyNames)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames?: string | string[]): Excel.DataValidation;Parámetros
- propertyNames
-
string | string[]
Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.
Devoluciones
load(propertyNamesAndPaths)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.DataValidation;Parámetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.
Devoluciones
set(properties, options)
Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto API del mismo tipo.
set(properties: Interfaces.DataValidationUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Excel.Interfaces.DataValidationUpdateData
Un objeto JavaScript con propiedades que están estructuradas isomorfamente a las propiedades del objeto en el que se llama al método.
- options
- OfficeExtension.UpdateOptions
Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.
Devoluciones
void
set(properties)
Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente.
set(properties: Excel.DataValidation): void;Parámetros
- properties
- Excel.DataValidation
Devoluciones
void
toJSON()
Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.DataValidation es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.DataValidationData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.
toJSON(): Excel.Interfaces.DataValidationData;