ErrorCheckOption
Contents
[
Hide
]ErrorCheckOption class
Error check setting applied on certain ranges.
class ErrorCheckOption;
Methods
| Method | Description |
|---|---|
| isErrorCheck(ErrorCheckType) | Checks whether given error type will be checked. |
| setErrorCheck(ErrorCheckType, boolean) | Sets whether given error type will be checked. |
| getCountOfRange() | Gets the count of ranges that influenced by this setting. |
| addRange(CellArea) | Adds one influenced range by this setting. |
| getRange(number) | Gets the influenced range of this setting by given index. |
| removeRange(number) | Removes one range by given index. |
| isNull() | Checks whether the implementation object is null. |
isErrorCheck(ErrorCheckType)
Checks whether given error type will be checked.
isErrorCheck(errorCheckType: ErrorCheckType) : boolean;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| errorCheckType | ErrorCheckType | error type can be checked |
Returns
return true if given error type will be checked(green triangle will be shown for cell if the check failed).
setErrorCheck(ErrorCheckType, boolean)
Sets whether given error type will be checked.
setErrorCheck(errorCheckType: ErrorCheckType, isCheck: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| errorCheckType | ErrorCheckType | error type can be checked. |
| isCheck | boolean | true if given error type needs to be checked(green triangle will be shown for cell if the check failed). |
getCountOfRange()
Gets the count of ranges that influenced by this setting.
getCountOfRange() : number;
Returns
the count of ranges that influenced by this setting.
addRange(CellArea)
Adds one influenced range by this setting.
addRange(ca: CellArea) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| ca | CellArea | the range to be added. |
Returns
the index of the added range in the range list of this setting.
getRange(number)
Gets the influenced range of this setting by given index.
getRange(index: number) : CellArea;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | number | the index of range |
Returns
return influenced range at given index.
removeRange(number)
Removes one range by given index.
removeRange(index: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | number | the index of the range to be removed. |
isNull()
Checks whether the implementation object is null.
isNull() : boolean;