com.aspose.cells

Class Validation

java.lang.Object

com.aspose.cells.Validation

public class Validation
extends java.lang.Object

Represents data validation.settings.

Example

 
         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");
 

Method Summary

Methods

Modifier and Type	Method and Description
void	addArea(CellArea cellArea) Applies the validation to the area.
void	addArea(CellArea cellArea, boolean checkIntersection, boolean checkEdge) Applies the validation to the area.
void	addAreas(CellArea[] areas, boolean checkIntersection, boolean checkEdge) Applies the validation to given areas.
void	copy(Validation source, CopyOptions copyOption) Copy validation.
int	getAlertStyle() Represents the validation alert style.
CellArea[]	getAreas() Gets all CellArea which contain the data validation settings.
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	getFormula1(boolean isR1C1, boolean isLocal) Gets the value or expression associated with this validation.
java.lang.String	getFormula1(boolean isR1C1, boolean isLocal, int row, int column) Gets the value or expression associated with this validation for specific cell.
java.lang.String	getFormula2() Represents the value or expression associated with the data validation.
java.lang.String	getFormula2(boolean isR1C1, boolean isLocal) Gets the value or expression associated with this validation.
java.lang.String	getFormula2(boolean isR1C1, boolean isLocal, int row, int column) Gets the value or expression associated with this validation for specific cell.
boolean	getIgnoreBlank() Indicates whether blank values are permitted by the range data validation.
boolean	getInCellDropDown() Indicates whether data validation displays a drop-down list that contains acceptable values.
java.lang.String	getInputMessage() Represents the data validation input 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.
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	getType() Represents the data validation type.
java.lang.Object	getValue(int row, int column, boolean isValue1) Get the value of validation on the specific cell.
java.lang.Object	getValue1() Represents the first value associated with the data validation.
java.lang.Object	getValue2() Represents the second value associated with the data validation.
void	removeACell(int row, int column) Remove the validation settings in the cell.
void	removeArea(CellArea cellArea) Remove the validation settings in the range.
void	removeAreas(CellArea[] areas) Removes this validation from given areas.
void	setAlertStyle(int value) Represents the validation alert style.
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	setFormula1(java.lang.String formula, boolean isR1C1, boolean isLocal) Sets the value or expression associated with this validation.
void	setFormula2(java.lang.String value) Represents the value or expression associated with the data validation.
void	setFormula2(java.lang.String formula, boolean isR1C1, boolean isLocal) Sets the value or expression associated with this validation.
void	setIgnoreBlank(boolean value) Indicates whether blank values are permitted by the range data validation.
void	setInCellDropDown(boolean value) Indicates whether data validation displays a drop-down list that contains acceptable values.
void	setInputMessage(java.lang.String value) Represents the data validation input 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	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	setType(int value) Represents the data validation type.
void	setValue1(java.lang.Object value) Represents the first value associated with the data validation.
void	setValue2(java.lang.Object value) Represents the second value associated with the data validation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getOperator

public int getOperator()

Represents the operator for the data validation.

See OperatorType.

setOperator

public void setOperator(int value)

Represents the operator for the data validation.

See OperatorType.

getAlertStyle

public int getAlertStyle()

Represents the validation alert style.

See ValidationAlertType.

setAlertStyle

public void setAlertStyle(int value)

Represents the validation alert style.

See ValidationAlertType.

getType

public int getType()

Represents the data validation type.

See ValidationType.

setType

public void setType(int value)

Represents the data validation type.

See ValidationType.

getInputMessage

public java.lang.String getInputMessage()

Represents the data validation input message.

setInputMessage

public void setInputMessage(java.lang.String value)

Represents the data validation input 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.

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.

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.

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.

getIgnoreBlank

public boolean getIgnoreBlank()

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

setIgnoreBlank

public void setIgnoreBlank(boolean value)

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

getFormula1

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.

getFormula2

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.

getFormula1

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.

getFormula2

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.

setFormula1

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.

setFormula2

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.

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.

getFormula2

public java.lang.String getFormula2()

Represents the value or expression associated with the data validation.

setFormula2

public void setFormula2(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 first value associated with the data validation.

setValue1

public void setValue1(java.lang.Object value)

Represents the first value associated with the data validation.

getValue2

public java.lang.Object getValue2()

Represents the second value associated with the data validation.

setValue2

public void setValue2(java.lang.Object value)

Represents the second value associated with the data validation.

getValue

public java.lang.Object getValue(int row,
                        int column,
                        boolean isValue1)

Get the value of validation on the specific cell.

Parameters:

row - The row index.

column - The column index.

isValue1 - Indicates whether getting the first value.

Returns:

getInCellDropDown

public boolean getInCellDropDown()

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

setInCellDropDown

public void setInCellDropDown(boolean value)

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

getAreas

public CellArea[] getAreas()

Gets all CellArea which contain the data validation settings.

addArea

public void addArea(CellArea cellArea)

Applies the validation to the area.

Remarks

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

Parameters:

cellArea - The area.

addArea

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

Applies the validation to the area.

Remarks

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.

addAreas

public void addAreas(CellArea[] areas,
            boolean checkIntersection,
            boolean checkEdge)

Applies the validation to given areas.

Remarks

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.

removeArea

public void removeArea(CellArea cellArea)

Remove the validation settings in the range.

Parameters:

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

removeAreas

public void removeAreas(CellArea[] areas)

Removes this validation from given areas.

Parameters:

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

removeACell

public void removeACell(int row,
               int column)

Remove the validation settings in the cell.

Parameters:

row - The row index.

column - The column index.

copy

public void copy(Validation source,
        CopyOptions copyOption)

Copy validation.

Parameters:

source - The source validation.

copyOption - The copy option.