com.aspose.cells
Class Validation

java.lang.Object
    com.aspose.cells.Validation

public class Validation 
extends java.lang.Object

Workbook workbook = new Workbook();
   ValidationCollection validations = workbook.getWorksheets().get(0).getValidations();
   CellArea area = CellArea.createCellArea(0, 0, 1, 1);
   Validation validation = validations.get(validations.add(area));
   validation.setType(com.aspose.cells.ValidationType.WHOLE_NUMBER);
   validation.setOperator(OperatorType.BETWEEN);
   validation.setFormula1("3");
   validation.setFormula2("1234");

public int getOperator() / public void setOperator(int value)

Represents the operator for the data validation. The value of the property is OperatorType integer constant.

public void setOperator(int value)

public int getAlertStyle() / public void setAlertStyle(int value)

Represents the validation alert style. The value of the property is ValidationAlertType integer constant.

public void setAlertStyle(int value)

public int getType() / public void setType(int value)

Represents the data validation type. The value of the property is ValidationType integer constant.

public void setType(int value)

public java.lang.String getInputMessage() / public void setInputMessage(java.lang.String value)

Represents the data validation input message.

public void setInputMessage(java.lang.String value)

public java.lang.String getInputTitle() / public void setInputTitle(java.lang.String value)

Represents the title of the data-validation input dialog box.

public void setInputTitle(java.lang.String value)

public java.lang.String getErrorMessage() / public void setErrorMessage(java.lang.String value)

Represents the data validation error message.

public void setErrorMessage(java.lang.String value)

public java.lang.String getErrorTitle() / public void setErrorTitle(java.lang.String value)

Represents the title of the data-validation error dialog box.

public void setErrorTitle(java.lang.String value)

public boolean getShowInput() / 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.

public void setShowInput(boolean value)

public boolean getShowError() / public void setShowError(boolean value)

Indicates whether the data validation error message will be displayed whenever the user enters invalid data.

public void setShowError(boolean value)

public boolean getIgnoreBlank() / public void setIgnoreBlank(boolean value)

Indicates whether blank values are permitted by the range data validation.

public void setIgnoreBlank(boolean value)

public java.lang.String getFormula1() / public void setFormula1(java.lang.String value)

Represents the value or expression associated with the data validation.

public void setFormula1(java.lang.String value)

public java.lang.String getFormula2() / public void setFormula2(java.lang.String value)

Represents the value or expression associated with the data validation.

public void setFormula2(java.lang.String value)

public java.lang.Object getValue1() / public void setValue1(java.lang.Object value)

Represents the first value associated with the data validation.

public void setValue1(java.lang.Object value)

public java.lang.Object getValue2() / public void setValue2(java.lang.Object value)

Represents the second value associated with the data validation.

public void setValue2(java.lang.Object value)

public boolean getInCellDropDown() / public void setInCellDropDown(boolean value)

Indicates whether data validation displays a drop-down list that contains acceptable values.

public void setInCellDropDown(boolean value)

public com.aspose.cells.CellArea[] getAreas()

Gets all CellArea which contain the data validation settings.

public java.lang.String getFormula1(boolean isR1C1, boolean isLocal)

Gets the value or expression associated with this validation.

Parameters:

isR1C1 - Whether the formula needs to be formatted as R1C1.

isLocal - Whether the formula needs to be formatted by locale.

Returns:

The value or expression associated with this validation.

public java.lang.String getFormula2(boolean isR1C1, boolean isLocal)

Gets the value or expression associated with this validation.

Parameters:

isR1C1 - Whether the formula needs to be formatted as R1C1.

isLocal - Whether the formula needs to be formatted by locale.

Returns:

The value or expression associated with this validation.

public java.lang.String getFormula1(boolean isR1C1, boolean isLocal, int row, int column)

Gets the value or expression associated with this validation for specific cell.

Parameters:

isR1C1 - Whether the formula needs to be formatted as R1C1.

isLocal - Whether the formula needs to be formatted by locale.

row - The row index.

column - The column index.

Returns:

The value or expression associated with this validation.

public java.lang.String getFormula2(boolean isR1C1, boolean isLocal, int row, int column)

Gets the value or expression associated with this validation for specific cell.

Parameters:

isR1C1 - Whether the formula needs to be formatted as R1C1.

isLocal - Whether the formula needs to be formatted by locale.

row - The row index.

column - The column index.

Returns:

The value or expression associated with this validation.

public void setFormula1(java.lang.String formula, boolean isR1C1, boolean isLocal)

Sets the value or expression associated with this validation.

Parameters:

formula - The value or expression associated with this format condition.

isR1C1 - Whether the formula is R1C1 formula.

isLocal - Whether the formula is locale formatted.

public void setFormula2(java.lang.String formula, boolean isR1C1, boolean isLocal)

Sets the value or expression associated with this validation.

Parameters:

formula - The value or expression associated with this format condition.

isR1C1 - Whether the formula is R1C1 formula.

isLocal - Whether the formula is locale formatted.

public java.lang.Object getListValue(int row, int column)

Get the value for list of the validation for the specified cell.

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.

public void addArea(CellArea cellArea)

Applies the validation to the area.

It is equivalent to use addArea(com.aspose.cells.CellArea, boolean, boolean) with checking intersection and edge.

Parameters:

cellArea - The area.

public void addArea(CellArea cellArea, boolean checkIntersection, boolean checkEdge)

Applies the validation to the area.

In this method, we will remove all old validations in given area. For the top-left one of Validation's applied ranges, firstly its StartRow is smallest, secondly its StartColumn is the smallest one of those areas who have the same smallest StartRow.

Parameters:

cellArea - The area.

checkIntersection - Whether check the intersection of given area with existing validations' areas. If one validation has been applied in given area(or part of it), then the existing validation should be removed at first from given area. Otherwise corruption may be caused for the generated Validations. If user is sure that the added area does not intersect with any existing area, this parameter can be set as false for performance consideration.

checkEdge - Whether check the edge of this validation's applied areas. Validation's internal settings depend on the top-left one of its applied ranges, so if given area will become the new top-left one of the applied ranges, the internal settings should be changed and rebuilt, otherwise unexpected result may be caused. If user is sure that the added area is not the top-left one, this parameter can be set as false for performance consideration.

public void addAreas(com.aspose.cells.CellArea[] areas, boolean checkIntersection, boolean checkEdge)

Applies the validation to given areas.

In this method, we will remove all old validations in given area. For the top-left one of Validation's applied ranges, firstly its StartRow is smallest, secondly its StartColumn is the smallest one of those areas who have the same smallest StartRow.

Parameters:

areas - The areas.

checkIntersection - Whether check the intersection of given area with existing validations' areas. If one validation has been applied in given area(or part of it), then the existing validation should be removed at first from given area. Otherwise corruption may be caused for the generated Validations. If user is sure that all the added areas do not intersect with any existing area, this parameter can be set as false for performance consideration.

checkEdge - Whether check the edge of this validation's applied areas. Validation's internal settings depend on the top-left one of its applied ranges, so if one of given areas will become the new top-left one of the applied ranges, the internal settings should be changed and rebuilt, otherwise unexpected result may be caused. If user is sure that no one of those added areas is the top-left, this parameter can be set as false for performance consideration.

public void removeArea(CellArea cellArea)

Remove the validation settings in the range.

Parameters:

cellArea - the areas where this validation settings should be removed.

public void removeAreas(com.aspose.cells.CellArea[] areas)

Removes this validation from given areas.

Parameters:

areas - the areas where this validation settings should be removed.

public void removeACell(int row, int column)

Remove the validation settings in the cell.

Parameters:

row - The row index.

column - The column index.

public void copy(Validation source, CopyOptions copyOption)

Copy validation.

Parameters:

source - The source validation.

copyOption - The copy option.