com.spire.xls.core.spreadsheet
Class XlsValidation

java.lang.Object
  com.spire.xls.core.spreadsheet.XlsValidation

All Implemented Interfaces:

IDataValidation, IOptimizedUpdate

public class XlsValidation
extends java.lang.Object
implements IDataValidation

Represents data validation for a worksheet range.

Constructor Summary

XlsValidation(XlsDataValidationCollection parent)

Method Summary

void	addRange(XlsRange range) Adds range to the collection.
void	addRange(XlsValidation dv)
boolean	containsCell(long lCellIndex) Indicates whether this object contains data validation settings for cell with specified index.
AlertStyleType	getAlertStyle()
CellDataType	getAllowType() Type of the allowed data.
ValidationComparisonOperator	getCompareOperator() Compare operator used.
IXLSRange	getDataRange() Range of possible values.
java.util.Date	getDate1() First formula's DateTime value.
java.util.Date	getDate2() Second formula's DateTime value.
java.lang.String	getErrorMessage() Text of the error message.
java.lang.String	getErrorTitle() Title of the error box.
java.lang.String	getFormula1() Value of the first formula.
java.lang.String	getFormula2() Value of the second formula.
boolean	getIgnoreBlank() Indicates whether empty cell is allowed.
java.lang.String	getInputMessage() Text of the prompt box.
java.lang.String	getInputTitle() Title of the prompt box.
java.lang.Object	getParent() Parent object for this object.
XlsDataValidationCollection	getParentCollection() Gets / sets parent data validation collection.
int	getPromptBoxHPosition() Horizontal position of the prompt box.
int	getPromptBoxVPosition() Vertical position of the prompt box.
int	getShapesCount() Gets number of required shapes objects.
boolean	getShowError() Indicates whether to show error box.
boolean	getShowInput() Indicates whether to show prompt box.
java.lang.String[]	getValues() If this is data validation list, then gets / sets array of all possible values.
XlsWorksheet	getWorksheet() Parent worksheet.
boolean	isInputPositionFixed()
void	isInputPositionFixed(boolean value)
boolean	isInputVisible()
void	isInputVisible(boolean value)
boolean	isListInFormula() Indicates whether formula contains list of values.
boolean	isSuppressDropDownArrow() Indicates whether to suppress drop-down arrow.
void	isSuppressDropDownArrow(boolean value) Indicates whether to suppress drop-down arrow.
void	removeRange(java.awt.Rectangle[] rectangles) Removes ranges from collection.
void	removeRange(XlsRange range) Removes range from collection.
void	setAlertStyle(AlertStyleType value)
void	setAllowType(CellDataType value) Type of the allowed data.
void	setCompareOperator(ValidationComparisonOperator value) Compare operator used.
void	setDataRange(IXLSRange value)
void	setDate1(java.util.Date value) First formula's DateTime value.
void	setDate2(java.util.Date value) Second formula's DateTime value.
void	setErrorMessage(java.lang.String value) Text of the error message.
void	setErrorTitle(java.lang.String value) Title of the error box.
void	setFormula1(java.lang.String value) Value of the first formula.
void	setFormula2(java.lang.String value) Value of the second formula.
void	setIgnoreBlank(boolean value) Indicates whether empty cell is allowed.
void	setInputMessage(java.lang.String value) Text of the prompt box.
void	setInputTitle(java.lang.String value) Title of the prompt box.
void	setPromptBoxHPosition(int value) Horizontal position of the prompt box.
void	setPromptBoxVPosition(int value) Vertical position of the prompt box.
void	setShowError(boolean value) Indicates whether to show error box.
void	setShowInput(boolean value) Indicates whether to show prompt box.
void	setValues(java.lang.String[] value) If this is data validation list, then gets / sets array of all possible values.

Methods inherited from interface com.spire.xls.core.interfacess.IOptimizedUpdate

beginUpdate, endUpdate

Constructor Detail

XlsValidation

public XlsValidation(XlsDataValidationCollection parent)

Method Detail

getInputTitle

public java.lang.String getInputTitle()

Description copied from interface: IDataValidation

Title of the prompt box.

Specified by:

getInputTitle in interface IDataValidation

setInputTitle

public void setInputTitle(java.lang.String value)

Description copied from interface: IDataValidation

Title of the prompt box.

Specified by:

setInputTitle in interface IDataValidation

getInputMessage

public java.lang.String getInputMessage()

Description copied from interface: IDataValidation

Text of the prompt box.

Specified by:

getInputMessage in interface IDataValidation

setInputMessage

public void setInputMessage(java.lang.String value)

Description copied from interface: IDataValidation

Text of the prompt box.

Specified by:

setInputMessage in interface IDataValidation

getErrorTitle

public java.lang.String getErrorTitle()

Description copied from interface: IDataValidation

Title of the error box.

Specified by:

getErrorTitle in interface IDataValidation

setErrorTitle

public void setErrorTitle(java.lang.String value)

Description copied from interface: IDataValidation

Title of the error box.

Specified by:

setErrorTitle in interface IDataValidation

getErrorMessage

public java.lang.String getErrorMessage()

Description copied from interface: IDataValidation

Text of the error message.

Specified by:

getErrorMessage in interface IDataValidation

setErrorMessage

public void setErrorMessage(java.lang.String value)

Description copied from interface: IDataValidation

Text of the error message.

Specified by:

setErrorMessage in interface IDataValidation

getFormula1

public java.lang.String getFormula1()

Description copied from interface: IDataValidation

Value of the first formula.

Specified by:

getFormula1 in interface IDataValidation

setFormula1

public void setFormula1(java.lang.String value)

Description copied from interface: IDataValidation

Value of the first formula.

Specified by:

setFormula1 in interface IDataValidation

getDate1

public java.util.Date getDate1()

First formula's DateTime value.

Specified by:

getDate1 in interface IDataValidation

setDate1

public void setDate1(java.util.Date value)

First formula's DateTime value.

Specified by:

setDate1 in interface IDataValidation

getFormula2

public java.lang.String getFormula2()

Description copied from interface: IDataValidation

Value of the second formula.

Specified by:

getFormula2 in interface IDataValidation

setFormula2

public void setFormula2(java.lang.String value)

Description copied from interface: IDataValidation

Value of the second formula.

Specified by:

setFormula2 in interface IDataValidation

getDate2

public java.util.Date getDate2()

Second formula's DateTime value.

Specified by:

getDate2 in interface IDataValidation

setDate2

public void setDate2(java.util.Date value)

Second formula's DateTime value.

Specified by:

setDate2 in interface IDataValidation

getAllowType

public CellDataType getAllowType()

Description copied from interface: IDataValidation

Type of the allowed data.

Specified by:

getAllowType in interface IDataValidation

setAllowType

public void setAllowType(CellDataType value)

Description copied from interface: IDataValidation

Type of the allowed data.

Specified by:

setAllowType in interface IDataValidation

getCompareOperator

public ValidationComparisonOperator getCompareOperator()

Description copied from interface: IDataValidation

Compare operator used.

Specified by:

getCompareOperator in interface IDataValidation

setCompareOperator

public void setCompareOperator(ValidationComparisonOperator value)

Description copied from interface: IDataValidation

Compare operator used.

Specified by:

setCompareOperator in interface IDataValidation

isListInFormula

public boolean isListInFormula()

Description copied from interface: IDataValidation

Indicates whether formula contains list of values.

Specified by:

isListInFormula in interface IDataValidation

getIgnoreBlank

public boolean getIgnoreBlank()

Description copied from interface: IDataValidation

Indicates whether empty cell is allowed.

Specified by:

getIgnoreBlank in interface IDataValidation

setIgnoreBlank

public void setIgnoreBlank(boolean value)

Description copied from interface: IDataValidation

Indicates whether empty cell is allowed.

Specified by:

setIgnoreBlank in interface IDataValidation

isSuppressDropDownArrow

public boolean isSuppressDropDownArrow()

Description copied from interface: IDataValidation

Indicates whether to suppress drop-down arrow.

Specified by:

isSuppressDropDownArrow in interface IDataValidation

isSuppressDropDownArrow

public void isSuppressDropDownArrow(boolean value)

Description copied from interface: IDataValidation

Indicates whether to suppress drop-down arrow.

Specified by:

isSuppressDropDownArrow in interface IDataValidation

getShapesCount

public int getShapesCount()

Gets number of required shapes objects.

getShowInput

public boolean getShowInput()

Description copied from interface: IDataValidation

Indicates whether to show prompt box.

Specified by:

getShowInput in interface IDataValidation

setShowInput

public void setShowInput(boolean value)

Description copied from interface: IDataValidation

Indicates whether to show prompt box.

Specified by:

setShowInput in interface IDataValidation

getShowError

public boolean getShowError()

Description copied from interface: IDataValidation

Indicates whether to show error box.

Specified by:

getShowError in interface IDataValidation

setShowError

public void setShowError(boolean value)

Description copied from interface: IDataValidation

Indicates whether to show error box.

Specified by:

setShowError in interface IDataValidation

getPromptBoxHPosition

public int getPromptBoxHPosition()

Description copied from interface: IDataValidation

Horizontal position of the prompt box.

Specified by:

getPromptBoxHPosition in interface IDataValidation

setPromptBoxHPosition

public void setPromptBoxHPosition(int value)

Description copied from interface: IDataValidation

Horizontal position of the prompt box.

Specified by:

setPromptBoxHPosition in interface IDataValidation

getPromptBoxVPosition

public int getPromptBoxVPosition()

Description copied from interface: IDataValidation

Vertical position of the prompt box.

Specified by:

getPromptBoxVPosition in interface IDataValidation

setPromptBoxVPosition

public void setPromptBoxVPosition(int value)

Description copied from interface: IDataValidation

Vertical position of the prompt box.

Specified by:

setPromptBoxVPosition in interface IDataValidation

isInputVisible

public boolean isInputVisible()

Specified by:

isInputVisible in interface IDataValidation

isInputVisible

public void isInputVisible(boolean value)

Specified by:

isInputVisible in interface IDataValidation

isInputPositionFixed

public boolean isInputPositionFixed()

Specified by:

isInputPositionFixed in interface IDataValidation

isInputPositionFixed

public void isInputPositionFixed(boolean value)

Specified by:

isInputPositionFixed in interface IDataValidation

getAlertStyle

public AlertStyleType getAlertStyle()

Specified by:

getAlertStyle in interface IDataValidation

setAlertStyle

public void setAlertStyle(AlertStyleType value)

Specified by:

setAlertStyle in interface IDataValidation

getValues

public java.lang.String[] getValues()

If this is data validation list, then gets / sets array of all possible values.

Specified by:

getValues in interface IDataValidation

setValues

public void setValues(java.lang.String[] value)

If this is data validation list, then gets / sets array of all possible values.

Specified by:

setValues in interface IDataValidation

getDataRange

public IXLSRange getDataRange()

Description copied from interface: IDataValidation

Range of possible values.

Specified by:

getDataRange in interface IDataValidation

setDataRange

public void setDataRange(IXLSRange value)

addRange

public void addRange(XlsValidation dv)

Parameters:

dv -

addRange

public void addRange(XlsRange range)

Adds range to the collection.

Parameters:

range - Range to add.

removeRange

public void removeRange(java.awt.Rectangle[] rectangles)

Removes ranges from collection.

Parameters:

rectangles - Ranges to remove.

removeRange

public void removeRange(XlsRange range)

Removes range from collection.

Parameters:

range - Range to remove.

getWorksheet

public XlsWorksheet getWorksheet()

Parent worksheet.

containsCell

public boolean containsCell(long lCellIndex)

Indicates whether this object contains data validation settings for cell with specified index.

Parameters:

lCellIndex - Cell index to search.

Returns:

True if this object contains data validation settings for cell with specified index.

getParent

public java.lang.Object getParent()

Parent object for this object.

getParentCollection

public XlsDataValidationCollection getParentCollection()

Gets / sets parent data validation collection.