|
||
| Home Products Purchase Downloads Demos Forums Blogs Ticket Wiki API Corporate | ||
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||
java.lang.Objectcom.aspose.cells.Validation
public class Validation
Represents data validation.settings.
| Method Summary | |
|---|---|
void |
addCellArea(CellArea cellArea)
Adds an affected cell range to cell range address list . |
int |
getAlertType()
Gets the validation alert style. |
java.util.ArrayList<CellArea> |
getAreaList()
Gets a collection of CellArea |
java.lang.String |
getErrorMessage()
Gets the data validation error message. |
java.lang.String |
getErrorTitle()
Gets the title of the data-validation error dialog box. |
java.lang.String |
getFormula1()
Gets the value or expression associated with the data validation. |
java.lang.String |
getFormula2()
Sets the value or expression associated with the second part of the data validation. |
java.lang.String |
getInputMessage()
Getss the data validation input message. |
java.lang.String |
getInputTitle()
Gets the title of the data validation input dialog box. |
int |
getOperator()
Gets the operator for the data validation. |
int |
getType()
Gets the validation data type. |
boolean |
isIgnoreBlank()
Indicates whether blank values are permitted by the range data validation. |
boolean |
isInCellDropDown()
Indicates whether data validation displays a drop-down list that contains acceptable values. |
boolean |
isShowError()
Indicates whether the data validation error message will be displayed whenever the user enters invalid data. |
boolean |
isShowInput()
Indicates whether the data validation input message will be displayed whenever the user selects a cell in the data validation range. |
void |
setAlertType(int alertType)
Sets the validation alert style. |
void |
setAreaList(java.util.ArrayList<CellArea> areaList)
Sets a collection of CellArea. |
void |
setErrorMessage(java.lang.String errorMessage)
Sets the data validation error message. |
void |
setErrorTitle(java.lang.String errorTitle)
Sets the title of the data-validation error dialog box. |
void |
setFormula1(java.lang.String formula1)
Sets the value or expression associated with the data validation. |
void |
setFormula2(java.lang.String formula2)
Sets the value or expression associated with the data validation. |
void |
setIgnoreBlank(boolean ignoreBlank)
Sets whether blank values are permitted by the range data validation. |
void |
setInCellDropDown(boolean inCellDropDown)
Sets whether data validation displays a drop-down list that contains acceptable values. |
void |
setInputMessage(java.lang.String inputMessage)
Sets the data validation input message. |
void |
setInputTitle(java.lang.String inputTitle)
Sets the title of the data validation input dialog box. |
void |
setOperator(int operator)
Sets the operator for the data validation. |
void |
setShowError(boolean showError)
Sets whether the data validation error message will be displayed whenever the user enters invalid data. |
void |
setShowInput(boolean showInput)
Sets whether the data validation input message will be displayed whenever the user selects a cell in the data validation range. |
void |
setType(int type)
Sets the validation data type. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Method Detail |
|---|
public int getAlertType()
setType(int).public void setAlertType(int alertType)
alertType - the validation alert style.It could be one of the following
values: | ValidationAlertType.INFORMATION |
| ValidationAlertType.STOP |
| ValidationAlertType.WARNING |
CellsException - if the validation has been removed from the validations.public java.util.ArrayList<CellArea> getAreaList()
public void setAreaList(java.util.ArrayList<CellArea> areaList)
areaList - a collection of CellArea which contains the data validation
settings.
CellsException - if the validation has been removed from the validations.public void addCellArea(CellArea cellArea)
cellArea - an affected cell range.
CellsException - if the validation has been removed from the validations.public java.lang.String getErrorMessage()
public void setErrorMessage(java.lang.String errorMessage)
errorMessage - the data validation error message.
CellsException - if the validation has been removed from the validations.public java.lang.String getErrorTitle()
public void setErrorTitle(java.lang.String errorTitle)
errorTitle - the title of the data-validation error dialog box.
CellsException - if the validation has been removed from the validations.public java.lang.String getFormula1()
public void setFormula1(java.lang.String formula1)
| data type | format |
| DATE | yyyy-MM-dd |
| TIME | HH:mm:ss |
| LIST | string,string,...... |
formula1 - the value or expression associated with the data validation.
CellsException - if the validation has been removed from the validations.public java.lang.String getFormula2()
public void setFormula2(java.lang.String formula2)
formula2 - the value or expression associated with the data validation.
CellsException - if the validation has been removed from the validations.setFormula1(String).public boolean isIgnoreBlank()
public void setIgnoreBlank(boolean ignoreBlank)
ignoreBlank - whether blank values are permitted by the range data validation.
CellsException - if the validation has been removed from the validations.public boolean isInCellDropDown()
public void setInCellDropDown(boolean inCellDropDown)
inCellDropDown - whether data validation displays a drop-down list that contains
acceptable values.
CellsException - if the validation has been removed from the validations.public java.lang.String getInputMessage()
public void setInputMessage(java.lang.String inputMessage)
inputMessage - the data validation input message.
CellsException - if the validation has been removed from the validations.public java.lang.String getInputTitle()
public void setInputTitle(java.lang.String inputTitle)
inputTitle - the title of the data validation input dialog box.
CellsException - if the validation has been removed from the validations.public int getOperator()
setOperator(int).public void setOperator(int operator)
operator - the operator for the data validation.It could be one of the
following values: | OperatorType.BETWEEN |
| OperatorType.NOT_BETWEEN |
| OperatorType.EQUAL |
| OperatorType.NOT_EQUAL |
| OperatorType.GREATE_THAN |
| OperatorType.LESS_THAN |
| OperatorType.GREATER_OR_EQUAL |
| OperatorType.LESS_OR_EQUAL |
CellsException - if the validation has been removed from the validations.public boolean isShowError()
public void setShowError(boolean showError)
showError - whether the data validation error message will be displayed
whenever the user enters invalid data.
CellsException - if the validation has been removed from the validations.public boolean isShowInput()
public void setShowInput(boolean showInput)
showInput - whether the data validation input message will be displayed
whenever the user selects a cell in the data validation range.
CellsException - if the validation has been removed from the validations.public int getType()
setType(int).public void setType(int type)
type - the validation data type.It could be one of the following
values: | ValidationType.ANYVALUE |
| ValidationType.WHOLE_NUMBER |
| ValidationType.DECIMAL |
| ValidationType.LIST |
| ValidationType.DATE |
| ValidationType.TIME |
| ValidationType.TEXT_LENGTH |
| ValidationType.CUSTOM |
java.lang.IllegalArgumentException - if the type is not validation data type.
CellsException - if the validation has been removed from the validations.
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||