GridCell (Aspose.Cells for Java)

java.lang.Object
- com.aspose.gridweb.GridCell

public class GridCell
extends java.lang.Object

Represents a cell object.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`containsExternalLink()` Indicates wether this cell contains an external link.
`void`	`copy(GridCell source)` Copies data from a source cell.
`void`	`copyStyle(GridTableItemStyle style)` copy the style and set the style for the cell
`GridComment`	`createComment(java.lang.String note, java.lang.String author, boolean isvisible)` Creates a comment object for a cell.
`GridValidation`	`createValidation(int validationType, boolean isRequried)` Creates a validation object for a cell.
`boolean`	`equals(java.lang.Object obj)` Checks whether this object refers to the same cell with another cell object.
`boolean`	`getBoolValue()` Gets the boolean value contained in the cell.
`int`	`getColumn()` Gets column number (zero based) of the cell.
`GridComment`	`getComment()` Get comment object on this cell
`DateTime`	`getDateValue()` Gets the DateTime value contained in the cell.
`java.lang.String`	`getDisplayStringValue()` Gets the formatted string value of this cell.
`double`	`getDoubleValue()` Gets the double value contained in the cell.
`float`	`getFloatValue()` Gets the float value contained in the cell.
`java.lang.String`	`getFormula()` Gets a formula of the `GridCell`.
`java.lang.String`	`getHtmlString()` Gets the html string which contains data and some formattings in this cell.
`int`	`getIntValue()` Gets the integer value contained in the cell.
`java.lang.String`	`getName()` Gets the name of the cell.
`int`	`getRow()` Gets row number (zero based) of the cell.
`java.lang.String`	`getStringValue()` Gets the string value contained in the cell.
`GridTableItemStyle`	`getStyle()` Gets the copy of cell style.
`int`	`getType()` return the cell value type ,the meaning can see GridCellValueType.java
`java.lang.Object`	`getValue()` Gets the value contained in this cell.
`int`	`getWidthOfValue()` Gets the width of the value in unit of pixels.
`int`	`hashCode()` Serves as a hash function for a particular type.
`boolean`	`isErrorValue()` Checks if a formula can properly evaluate a result.
`boolean`	`isFormula()` Represents if the specified cell contains formula.
`boolean`	`isStyleSet()` Indicates if the cell's style is set.
`void`	`putValue(boolean param_boolean)` Puts a boolean value into the cell.
`void`	`putValue(DateTime param_date)` Puts a DateTime value into the cell.
`void`	`putValue(double param_double)` Puts a double value into the cell.
`void`	`putValue(int param_int)` Puts a int value into the cell.
`void`	`putValue(java.lang.Object objectValue)` Puts an object value into the cell.same as setValue(Object param_object)
`void`	`putValue(java.lang.String param_string)` Puts a String value into the cell.
`void`	`putValue(java.lang.String stringValue, boolean isConverted)` Puts a string value into the cell and converts the value to other data type if appropriate.
`void`	`putValue(java.lang.String stringValue, boolean isConverted, boolean setStyle)` Puts a value into the cell, if appropriate the value will be converted to other data type and cell's number format will be reset.
`void`	`putValueAndSetFormatByValue(java.lang.String stringValue)` Sets the cell's value with a string value and set cell format by this value.
`void`	`removeComment()` Removes the comment object of the cell.
`void`	`removeValidation()` Removes the validation object of the cell.
`void`	`setBorder(WebBorderStyle borderStyle)` Sets borders(top,bottom,left and right) for a cell,all the borders have same borderstyle.
`void`	`setCustom(java.lang.String custom)` sets the custom format, null or empty string means no custom format.
`void`	`setFormula(java.lang.String value)` Sets a formula of the `GridCell`.
`void`	`setFormula(java.lang.String formula, java.lang.Object value)` Set the formula and the value of the formula.
`void`	`setHtmlString(java.lang.String value)` Sets the html string which contains data and some formattings in this cell.
`void`	`setNumberType(int numbertype)` set the display format of numbers and dates
`void`	`setStyle(GridTableItemStyle value)` Gets the copy of cell style.
`void`	`setValue(java.lang.Object value)` Gets the value contained in this cell.
`java.lang.String`	`toString()` Returns a string represents the current Cell object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - toString
```
public java.lang.String toString()
```
    Returns a string represents the current Cell object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
  - getName
```
public java.lang.String getName()
```
    Gets the name of the cell. For example: A1, F102.
  - getValue
```
public java.lang.Object getValue()
```
    Gets the value contained in this cell.
    Remarks
    Possible type:
    null,
    
    Boolean,
    
    DateTime,
    
    Double,
    
    Integer
    
    String.
  - setValue
```
public void setValue(java.lang.Object value)
```
    Gets the value contained in this cell.
    Remarks
    Possible type:
    null,
    
    Boolean,
    
    DateTime,
    
    Double,
    
    Integer
    
    String.
  - copy
```
public void copy(GridCell source)
```
    Copies data from a source cell.
    
    Parameters:
    source - Source GridCell object.
  - getType
```
public int getType()
```
    return the cell value type ,the meaning can see GridCellValueType.java
  - putValue
```
public void putValue(DateTime param_date)
```
    Puts a DateTime value into the cell.
    
    Parameters:
    param_date - Input value
  - putValue
```
public void putValue(java.lang.String param_string)
```
    Puts a String value into the cell.
    
    Parameters:
    param_string - Input value
  - putValue
```
public void putValue(java.lang.Object objectValue)
```
    Puts an object value into the cell.same as setValue(Object param_object)
    
    Parameters:
    objectValue - input value
  - putValue
```
public void putValue(int param_int)
```
    Puts a int value into the cell.
    
    Parameters:
    param_int - Input value
  - putValue
```
public void putValue(java.lang.String stringValue,
            boolean isConverted,
            boolean setStyle)
```
    Puts a value into the cell, if appropriate the value will be converted to other data type and cell's number format will be reset.
    
    Parameters:
    stringValue - Input value
    isConverted - True: converted to other data type if appropriate.
    setStyle - True: set the number format to cell's style when converting to other data type
  - putValue
```
public void putValue(java.lang.String stringValue,
            boolean isConverted)
```
    Puts a string value into the cell and converts the value to other data type if appropriate.
    
    Parameters:
    stringValue - Input value
    isConverted - True: converted to other data type if appropriate.
  - putValue
```
public void putValue(boolean param_boolean)
```
    Puts a boolean value into the cell.
    
    Parameters:
    param_boolean - Input value
  - putValue
```
public void putValue(double param_double)
```
    Puts a double value into the cell.
    
    Parameters:
    param_double - Input value
  - isFormula
```
public boolean isFormula()
```
    Represents if the specified cell contains formula.
  - getFormula
```
public java.lang.String getFormula()
```
    Gets a formula of the GridCell.
    Remarks
    A formula string always begins with an equal sign (=). And please always use comma(,) as parameters delimeter, such as "=SUM(A1, E1, H2)".
    User can set any formula in Workbook designer file. Aspose.Cells will keep all the formulas. If user use this property to set a formula to a cell, major part of Workbook built-in functions is supported. And more is coming. If you have any special need for Workbook built-in functions, please let us know.
    Example
```
 
         GridWeb GridWeb1 = new GridWeb();
         GridWorksheet sheet = GridWeb1.getActiveSheet();
         sheet.getCells().get("B6").setFormula("=SUM(B2:B5, E1) + sheet1!A1");
 
```
  - setFormula
```
public void setFormula(java.lang.String value)
```
    Sets a formula of the GridCell.
    Remarks
    A formula string always begins with an equal sign (=). And please always use comma(,) as parameters delimeter, such as "=SUM(A1, E1, H2)".
    User can set any formula in Workbook designer file. Aspose.Cells will keep all the formulas. If user use this property to set a formula to a cell, major part of Workbook built-in functions is supported. And more is coming. If you have any special need for Workbook built-in functions, please let us know.
  - setFormula
```
public void setFormula(java.lang.String formula,
              java.lang.Object value)
```
    Set the formula and the value of the formula.
    
    Parameters:
    formula - The formula.
    value - The value of the formula.
  - getStringValue
```
public java.lang.String getStringValue()
```
    Gets the string value contained in the cell.
  - getStyle
```
public GridTableItemStyle getStyle()
```
    Gets the copy of cell style. set the style for the cell.
    
    Returns:
    Style object.
  - setStyle
```
public void setStyle(GridTableItemStyle value)
```
    Gets the copy of cell style. set the style for the cell.
  - copyStyle
```
public void copyStyle(GridTableItemStyle style)
```
    copy the style and set the style for the cell
    
    Parameters:
    style - The source style.
  - setCustom
```
public void setCustom(java.lang.String custom)
```
    sets the custom format, null or empty string means no custom format.
    
    Parameters:
    custom - the custom string presentation
  - putValueAndSetFormatByValue
```
public void putValueAndSetFormatByValue(java.lang.String stringValue)
```
    Sets the cell's value with a string value and set cell format by this value.
    
    Parameters:
    stringValue - Input value.
  - setNumberType
```
public void setNumberType(int numbertype)
```
    set the display format of numbers and dates
    
    Parameters:
    numbertype - the value of ther numbertype,see GridTableItemStyle.NumberType
  - getDateValue
```
public DateTime getDateValue()
```
    Gets the DateTime value contained in the cell.
  - getRow
```
public int getRow()
```
    Gets row number (zero based) of the cell.
  - getColumn
```
public int getColumn()
```
    Gets column number (zero based) of the cell.
  - isErrorValue
```
public boolean isErrorValue()
```
    Checks if a formula can properly evaluate a result.
    Remarks
    Only applies to formula cell.
  - getDisplayStringValue
```
public java.lang.String getDisplayStringValue()
```
    Gets the formatted string value of this cell.
  - getIntValue
```
public int getIntValue()
```
    Gets the integer value contained in the cell.
  - getDoubleValue
```
public double getDoubleValue()
```
    Gets the double value contained in the cell.
  - getFloatValue
```
public float getFloatValue()
```
    Gets the float value contained in the cell.
  - getBoolValue
```
public boolean getBoolValue()
```
    Gets the boolean value contained in the cell.
  - containsExternalLink
```
public boolean containsExternalLink()
```
    Indicates wether this cell contains an external link. Only applies when the cell is a formula cell.
  - getWidthOfValue
```
public int getWidthOfValue()
```
    Gets the width of the value in unit of pixels.
    
    Returns:
  - isStyleSet
```
public boolean isStyleSet()
```
    Indicates if the cell's style is set. If return false, it means this cell has a default cell format.
  - getHtmlString
```
public java.lang.String getHtmlString()
```
    Gets the html string which contains data and some formattings in this cell.
  - setHtmlString
```
public void setHtmlString(java.lang.String value)
```
    Sets the html string which contains data and some formattings in this cell.
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Checks whether this object refers to the same cell with another cell object.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    obj - another GridCell object
    
    Returns:
    true if two cell objects refers to the same cell.
  - hashCode
```
public int hashCode()
```
    Serves as a hash function for a particular type.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    A hash code for current GridCell object.
  - setBorder
```
public void setBorder(WebBorderStyle borderStyle)
```
    Sets borders(top,bottom,left and right) for a cell,all the borders have same borderstyle.
    
    Parameters:
    borderStyle - The border style.
  - createValidation
```
public GridValidation createValidation(int validationType,
                              boolean isRequried)
```
    Creates a validation object for a cell.
    Example
```
 
         GridWeb GridWeb1 = new GridWeb();
         GridWorksheet sheet = GridWeb1.getActiveSheet();
         GridValidation v = sheet.getCells().get("A1").createValidation(GridValidationType.CUSTOM_EXPRESSION, true);
                        // Sets to number validation expression.
                        v.setRegEx("\\d+");
 
```
    Parameters:
    validationType - GridValidationType. Validation type.
    isRequried - Whether the cell value is required.
    
    Returns:
  - removeValidation
```
public void removeValidation()
```
    Removes the validation object of the cell.
  - createComment
```
public GridComment createComment(java.lang.String note,
                        java.lang.String author,
                        boolean isvisible)
```
    Creates a comment object for a cell.
    
    Parameters:
    note - comment note.
    author - comment author.
    isvisible - whether the comment is visible.
    
    Returns:
    GridComment object
  - removeComment
```
public void removeComment()
```
    Removes the comment object of the cell.
  - getComment
```
public GridComment getComment()
```
    Get comment object on this cell

Class GridCell

Method Summary

Methods inherited from class java.lang.Object

Method Detail

toString

getName

getValue

setValue

copy

getType

putValue

putValue

putValue

putValue

putValue

putValue

putValue

putValue

isFormula

getFormula

setFormula

setFormula

getStringValue

getStyle

setStyle

copyStyle

setCustom

putValueAndSetFormatByValue

setNumberType

getDateValue

getRow

getColumn

isErrorValue

getDisplayStringValue

getIntValue

getDoubleValue

getFloatValue

getBoolValue

containsExternalLink

getWidthOfValue

isStyleSet

getHtmlString

setHtmlString

equals

hashCode

setBorder

createValidation

removeValidation

createComment

removeComment

getComment