GridValidation (Aspose.Cells for Java)

java.lang.Object
- com.aspose.gridweb.GridValidation

public class GridValidation
extends java.lang.Object

Represents data validation.settings.

Field Summary

Fields
Modifier and Type Field and Description

GridCustomServerValidation ServerValidation
Gets or sets the serverside validation javascript function name.

Fields
Modifier and Type	Field and Description
`GridCustomServerValidation`	`ServerValidation` Gets or sets the serverside validation javascript function name.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addACell(int row, int column)` add the validation settings in the cell.
`void`	`addACell(java.lang.String cellname)` add the validation settings in the cell.
`void`	`addArea(GridCellArea cellArea)` Applies the validation to the area.
`java.util.ArrayList`	`getAreaList()` Represents a collection of `GridCellArea` which contains the data validation settings.
`java.lang.String`	`getClientValidationFunction()` Gets the client validation javascript function name.
`java.lang.String`	`getErrorMessage()` Represents the data validation error message.
`java.lang.String`	`getErrorTitle()` Represents the title of the data-validation error dialog box.
`java.lang.String`	`getFormula1()` Represents the value or expression associated with the data validation.
`java.lang.String`	`getFormula2()` Represents the value or expression associated with the second part of the data validation.
`java.lang.String`	`getInputMessage()` Represents the data validation error message.
`java.lang.String`	`getInputTitle()` Represents the title of the data-validation input dialog box.
`java.lang.Object`	`getListValue(int row, int column)` Get the value for list of the validation for the specified cell.
`int`	`getOperator()` Represents the operator for the data validation.
`java.lang.String`	`getRegEx()` Gets the regular expression string.
`boolean`	`getShowError()` Indicates whether the data validation error message will be displayed whenever the user enters invalid data.
`boolean`	`getShowInput()` Indicates whether the data validation input message will be displayed whenever the user selects a cell in the data validation range.
`int`	`getValidationType()` Gets the validation type.
`java.lang.Object[]`	`getValue1()` Represents the value associated with the data validation.
`java.util.ArrayList<java.lang.String>`	`getValueList()` Gets the value list object.
`boolean`	`isRequired()` Gets whether the cell value is required.
`void`	`removeACell(int row, int column)` Remove the validation settings in the cell.
`void`	`removeArea(GridCellArea cellArea)` Remove the validation settings in the range.
`void`	`setClientValidationFunction(java.lang.String value)` Sets the client validation javascript function name.
`void`	`setErrorMessage(java.lang.String value)` Represents the data validation error message.
`void`	`setErrorTitle(java.lang.String value)` Represents the title of the data-validation error dialog box.
`void`	`setFormula1(java.lang.String value)` Represents the value or expression associated with the data validation.
`void`	`setFormula2(java.lang.String value)` Represents the value or expression associated with the second part of the data validation.
`void`	`setInputMessage(java.lang.String value)` Represents the data validation error message.
`void`	`setInputTitle(java.lang.String value)` Represents the title of the data-validation input dialog box.
`void`	`setOperator(int value)` Represents the operator for the data validation.
`void`	`setRegEx(java.lang.String value)` Sets the regular expression string.
`void`	`setRequired(boolean value)` Sets whether the cell value is required.
`void`	`setShowError(boolean value)` Indicates whether the data validation error message will be displayed whenever the user enters invalid data.
`void`	`setShowInput(boolean value)` Indicates whether the data validation input message will be displayed whenever the user selects a cell in the data validation range.
`void`	`setValidationType(int value)` Sets the validation type.
`void`	`setValueList(java.util.ArrayList<java.lang.String> value)` Sets the value list object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ServerValidation
```
public GridCustomServerValidation ServerValidation
```
    Gets or sets the serverside validation javascript function name.
    Remarks
    Use the GridCustomServerValidation property to specify the serverside validation .
- Method Detail
  - getValidationType
```
public int getValidationType()
```
    Gets the validation type.
    See GridValidationType.
  - setValidationType
```
public void setValidationType(int value)
```
    Sets the validation type.
    See GridValidationType.
  - isRequired
```
public boolean isRequired()
```
    Gets whether the cell value is required.
  - setRequired
```
public void setRequired(boolean value)
```
    Sets whether the cell value is required.
  - getValueList
```
public java.util.ArrayList<java.lang.String> getValueList()
```
    Gets the value list object.
  - setValueList
```
public void setValueList(java.util.ArrayList<java.lang.String> value)
```
    Sets the value list object.
  - addACell
```
public void addACell(int row,
            int column)
```
    add the validation settings in the cell.
    
    Parameters:
    row - The row index.
    column - The column index.
  - addACell
```
public void addACell(java.lang.String cellname)
```
    add the validation settings in the cell.
    
    Parameters:
    cellname - cell name.
  - addArea
```
public void addArea(GridCellArea cellArea)
```
    Applies the validation to the area.
    Remarks
    In this method , we will remove all old validations on this area.
    
    Parameters:
    cellArea - The area.
  - removeArea
```
public void removeArea(GridCellArea cellArea)
```
    Remove the validation settings in the range.
    
    Parameters:
    cellArea - The range which contains the data validation settings.
  - removeACell
```
public void removeACell(int row,
               int column)
```
    Remove the validation settings in the cell.
    
    Parameters:
    row - The row index.
    column - The column index.
  - getAreaList
```
public java.util.ArrayList getAreaList()
```
    Represents a collection of GridCellArea which contains the data validation settings.
    Remarks
    The old valvidations on the area will not be removed if directly adding are to this list.
  - getFormula1
```
public java.lang.String getFormula1()
```
    Represents the value or expression associated with the data validation.
  - setFormula1
```
public void setFormula1(java.lang.String value)
```
    Represents the value or expression associated with the data validation.
  - getListValue
```
public java.lang.Object getListValue(int row,
                            int column)
```
    Get the value for list of the validation for the specified cell.
    Remarks
    Only for validation whose type is List and has been applied to given cell, otherwise null will be returned.
    
    Parameters:
    row - The row index.
    column - The column index.
    
    Returns:
    The value to produce the list of this validation for the specified cell. If the list references to a range, then the returned value will be a ReferredArea object; Otherwise the returned value may be null, object[], or simple object.
  - getValue1
```
public java.lang.Object[] getValue1()
```
    Represents the value associated with the data validation.
  - getFormula2
```
public java.lang.String getFormula2()
```
    Represents the value or expression associated with the second part of the data validation.
  - setFormula2
```
public void setFormula2(java.lang.String value)
```
    Represents the value or expression associated with the second part of the data validation.
  - getOperator
```
public int getOperator()
```
    Represents the operator for the data validation.
    See GridOperatorType.
  - setOperator
```
public void setOperator(int value)
```
    Represents the operator for the data validation.
    See GridOperatorType.
  - getShowInput
```
public boolean getShowInput()
```
    Indicates whether the data validation input message will be displayed whenever the user selects a cell in the data validation range.
  - setShowInput
```
public void setShowInput(boolean value)
```
    Indicates whether the data validation input message will be displayed whenever the user selects a cell in the data validation range.
  - getInputMessage
```
public java.lang.String getInputMessage()
```
    Represents the data validation error message.
  - setInputMessage
```
public void setInputMessage(java.lang.String value)
```
    Represents the data validation error message.
  - getInputTitle
```
public java.lang.String getInputTitle()
```
    Represents the title of the data-validation input dialog box.
  - setInputTitle
```
public void setInputTitle(java.lang.String value)
```
    Represents the title of the data-validation input dialog box.
  - getShowError
```
public boolean getShowError()
```
    Indicates whether the data validation error message will be displayed whenever the user enters invalid data.
  - setShowError
```
public void setShowError(boolean value)
```
    Indicates whether the data validation error message will be displayed whenever the user enters invalid data.
  - getErrorMessage
```
public java.lang.String getErrorMessage()
```
    Represents the data validation error message.
  - setErrorMessage
```
public void setErrorMessage(java.lang.String value)
```
    Represents the data validation error message.
  - getErrorTitle
```
public java.lang.String getErrorTitle()
```
    Represents the title of the data-validation error dialog box.
  - setErrorTitle
```
public void setErrorTitle(java.lang.String value)
```
    Represents the title of the data-validation error dialog box.
  - getRegEx
```
public java.lang.String getRegEx()
```
    Gets the regular expression string.
  - setRegEx
```
public void setRegEx(java.lang.String value)
```
    Sets the regular expression string.
  - getClientValidationFunction
```
public java.lang.String getClientValidationFunction()
```
    Gets the client validation javascript function name.
    Remarks
    Use the ClientValidationFunction property to specify the client validation function's name. The function should be declared as this formation:
    function customValicationFunction(source, value)
    The parameter "source" is the cell object. The parameter "value" is the string value of a cell to be checked. The function should returns true if the value is valid.
  - setClientValidationFunction
```
public void setClientValidationFunction(java.lang.String value)
```
    Sets the client validation javascript function name.
    Remarks
    Use the ClientValidationFunction property to specify the client validation function's name. The function should be declared as this formation:
    function customValicationFunction(source, value)
    The parameter "source" is the cell object. The parameter "value" is the string value of a cell to be checked. The function should returns true if the value is valid.

Class GridValidation

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ServerValidation

Method Detail

getValidationType

setValidationType

isRequired

setRequired

getValueList

setValueList

addACell

addACell

addArea

removeArea

removeACell

getAreaList

getFormula1

setFormula1

getListValue

getValue1

getFormula2

setFormula2

getOperator

setOperator

getShowInput

setShowInput

getInputMessage

setInputMessage

getInputTitle

setInputTitle

getShowError

setShowError

getErrorMessage

setErrorMessage

getErrorTitle

setErrorTitle

getRegEx

setRegEx

getClientValidationFunction

setClientValidationFunction