com.aspose.cells

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();
Validation validation = validations.get(validations.add());
validation.setType(com.aspose.cells.ValidationType.WHOLE_NUMBER);
validation.setOperator(OperatorType.BETWEEN);
validation.setFormula1("3");
validation.setFormula2("1234");

CellArea area = new CellArea();
area.StartRow = 0;
area.EndRow = 1;
area.StartColumn = 0;
area.EndColumn = 1;

validation.addArea(area);

Property Getters/Setters Summary
intgetAlertStyle()
void
setAlertStyle(intvalue)
           Represents the validation alert style. The value of the property is ValidationAlertType integer constant.
com.aspose.cells.CellArea[]getAreas()
Gets all CellArea which contain the data validation settings.
java.lang.StringgetErrorMessage()
void
setErrorMessage(java.lang.Stringvalue)
           Represents the data validation error message.
java.lang.StringgetErrorTitle()
void
setErrorTitle(java.lang.Stringvalue)
           Represents the title of the data-validation error dialog box.
java.lang.StringgetFormula1()
void
setFormula1(java.lang.Stringvalue)
           Represents the value or expression associated with the data validation.
java.lang.StringgetFormula2()
void
setFormula2(java.lang.Stringvalue)
           Represents the value or expression associated with the data validation.
booleangetIgnoreBlank()
void
setIgnoreBlank(booleanvalue)
           Indicates whether blank values are permitted by the range data validation.
booleangetInCellDropDown()
void
setInCellDropDown(booleanvalue)
           Indicates whether data validation displays a drop-down list that contains acceptable values.
java.lang.StringgetInputMessage()
void
setInputMessage(java.lang.Stringvalue)
           Represents the data validation input message.
java.lang.StringgetInputTitle()
void
setInputTitle(java.lang.Stringvalue)
           Represents the title of the data-validation input dialog box.
intgetOperator()
void
setOperator(intvalue)
           Represents the operator for the data validation. The value of the property is OperatorType integer constant.
booleangetShowError()
void
setShowError(booleanvalue)
           Indicates whether the data validation error message will be displayed whenever the user enters invalid data.
booleangetShowInput()
void
setShowInput(booleanvalue)
           Indicates whether the data validation input message will be displayed whenever the user selects a cell in the data validation range.
intgetType()
void
setType(intvalue)
           Represents the data validation type. The value of the property is ValidationType integer constant.
java.lang.ObjectgetValue1()
void
setValue1(java.lang.Objectvalue)
           Represents the first value associated with the data validation.
java.lang.ObjectgetValue2()
void
setValue2(java.lang.Objectvalue)
           Represents the second value associated with the data validation.
 
Method Summary
voidaddArea(CellArea cellArea)
Applies the validation to the area.
voidaddArea(CellArea cellArea, boolean checkIntersection, boolean checkEdge)
Applies the validation to the area.
voidaddAreas(com.aspose.cells.CellArea[] areas, boolean checkIntersection, boolean checkEdge)
Applies the validation to given areas.
voidcopy(Validation source, CopyOptions copyOption)
Copy validation.
java.lang.StringgetFormula1(boolean isR1C1, boolean isLocal)
Gets the value or expression associated with this validation.
java.lang.StringgetFormula1(boolean isR1C1, boolean isLocal, int row, int column)
Gets the value or expression associated with this validation for specific cell.
java.lang.StringgetFormula2(boolean isR1C1, boolean isLocal)
Gets the value or expression associated with this validation.
java.lang.StringgetFormula2(boolean isR1C1, boolean isLocal, int row, int column)
Gets the value or expression associated with this validation for specific cell.
java.lang.ObjectgetListValue(int row, int column)
Get the value for list of the validation for the specified cell.
voidremoveACell(int row, int column)
Remove the validation settings in the cell.
voidremoveArea(CellArea cellArea)
Remove the validation settings in the range.
voidremoveAreas(com.aspose.cells.CellArea[] areas)
Removes this validation from given areas.
voidsetFormula1(java.lang.String formula, boolean isR1C1, boolean isLocal)
Sets the value or expression associated with this validation.
voidsetFormula2(java.lang.String formula, boolean isR1C1, boolean isLocal)
Sets the value or expression associated with this validation.
 

    • Property Getters/Setters Detail

      • getOperator/setOperator

        public int getOperator() / public void setOperator(int value)
        Represents the operator for the data validation. The value of the property is OperatorType integer constant.

      • getAlertStyle/setAlertStyle

        public int getAlertStyle() / public void setAlertStyle(int value)
        Represents the validation alert style. The value of the property is ValidationAlertType integer constant.

      • getType/setType

        public int getType() / public void setType(int value)
        Represents the data validation type. The value of the property is ValidationType integer constant.

      • getInputMessage/setInputMessage

        public java.lang.String getInputMessage() / public void setInputMessage(java.lang.String value)
        Represents the data validation input message.

      • getInputTitle/setInputTitle

        public java.lang.String getInputTitle() / public void setInputTitle(java.lang.String value)
        Represents the title of the data-validation input dialog box.

      • getErrorMessage/setErrorMessage

        public java.lang.String getErrorMessage() / public void setErrorMessage(java.lang.String value)
        Represents the data validation error message.

      • getErrorTitle/setErrorTitle

        public java.lang.String getErrorTitle() / public void setErrorTitle(java.lang.String value)
        Represents the title of the data-validation error dialog box.

      • getShowInput/setShowInput

        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.

      • getShowError/setShowError

        public boolean getShowError() / public void setShowError(boolean value)
        Indicates whether the data validation error message will be displayed whenever the user enters invalid data.

      • getIgnoreBlank/setIgnoreBlank

        public boolean getIgnoreBlank() / public void setIgnoreBlank(boolean value)
        Indicates whether blank values are permitted by the range data validation.

      • getFormula1/setFormula1

        public java.lang.String getFormula1() / public void setFormula1(java.lang.String value)
        Represents the value or expression associated with the data validation.

      • getFormula2/setFormula2

        public java.lang.String getFormula2() / public void setFormula2(java.lang.String value)
        Represents the value or expression associated with the data validation.

      • getValue1/setValue1

        public java.lang.Object getValue1() / public void setValue1(java.lang.Object value)
        Represents the first value associated with the data validation.

      • getValue2/setValue2

        public java.lang.Object getValue2() / public void setValue2(java.lang.Object value)
        Represents the second value associated with the data validation.

      • getInCellDropDown/setInCellDropDown

        public boolean getInCellDropDown() / public void setInCellDropDown(boolean value)
        Indicates whether data validation displays a drop-down list that contains acceptable values.

      • getAreas

        public com.aspose.cells.CellArea[] getAreas()
        Gets all CellArea which contain the data validation settings.

    setOperator

    public voidsetOperator(intvalue)
    Represents the operator for the data validation. The value of the property is OperatorType integer constant.

    setAlertStyle

    public voidsetAlertStyle(intvalue)
    Represents the validation alert style. The value of the property is ValidationAlertType integer constant.

    setType

    public voidsetType(intvalue)
    Represents the data validation type. The value of the property is ValidationType integer constant.

    setInputMessage

    public voidsetInputMessage(java.lang.Stringvalue)
    Represents the data validation input message.

    setInputTitle

    public voidsetInputTitle(java.lang.Stringvalue)
    Represents the title of the data-validation input dialog box.

    setErrorMessage

    public voidsetErrorMessage(java.lang.Stringvalue)
    Represents the data validation error message.

    setErrorTitle

    public voidsetErrorTitle(java.lang.Stringvalue)
    Represents the title of the data-validation error dialog box.

    setShowInput

    public voidsetShowInput(booleanvalue)
    Indicates whether the data validation input message will be displayed whenever the user selects a cell in the data validation range.

    setShowError

    public voidsetShowError(booleanvalue)
    Indicates whether the data validation error message will be displayed whenever the user enters invalid data.

    setIgnoreBlank

    public voidsetIgnoreBlank(booleanvalue)
    Indicates whether blank values are permitted by the range data validation.

    setFormula1

    public voidsetFormula1(java.lang.Stringvalue)
    Represents the value or expression associated with the data validation.

    setFormula2

    public voidsetFormula2(java.lang.Stringvalue)
    Represents the value or expression associated with the data validation.

    setValue1

    public voidsetValue1(java.lang.Objectvalue)
    Represents the first value associated with the data validation.

    setValue2

    public voidsetValue2(java.lang.Objectvalue)
    Represents the second value associated with the data validation.

    setInCellDropDown

    public voidsetInCellDropDown(booleanvalue)
    Indicates whether data validation displays a drop-down list that contains acceptable values.

    • Method Detail

      • 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.

      • getListValue

        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.

      • addArea

        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 thoses 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(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 thoses 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(com.aspose.cells.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.