aspose.cells
Class Row

Represents a single row in a worksheet.

Property Getters/Setters Summary
functiongetFirstCell()
           Gets the first cell object in the row.
functiongetFirstDataCell()
           Gets the first non-blank cell in the row.
functiongetGroupLevel()
           Gets the group level of the row.
functiongetHeight()
functionsetHeight(value)
           Gets and sets the row height in unit of Points.
functiongetIndex()
           Gets the index of this row.
functionisBlank()
           Indicates whether the row contains any data
functionisHeightMatched()
functionsetHeightMatched(value)
           Indicates that row height and default font height matches
functionisHidden()
functionsetHidden(value)
           Indicates whether the row is hidden.
functiongetLastCell()
           Gets the last cell object in the row.
functiongetLastDataCell()
           Gets the last non-blank cell in the row.
functiongetStyle()
           Represents the style of this row.
functionget(column)
           Gets the cell.
 
Method Summary
functionapplyStyle(style, flag)
           Applies formats for a whole row.
functioncopySettings(source, checkStyle)
           Copy settings of row, such as style, height, visibility, ...etc.
functionequals(row)
           Checks whether this object refers to the same row with another row object.
functionequals(obj)
           Checks whether this object refers to the same row with another.
functiongetCellByIndex(index)
           Get the cell by specific index in the list.
functiongetCellOrNull(column)
           Gets the cell or null in the specific index.
functioniterator()
           Gets the cells enumerator
 

Property Getters/Setters Detail

isBlank : boolean 

function isBlank()
Indicates whether the row contains any data

getHeight/setHeight : Number 

function getHeight() / function setHeight(value)
Gets and sets the row height in unit of Points.

isHidden/setHidden : boolean 

function isHidden() / function setHidden(value)
Indicates whether the row is hidden.

getIndex : Number 

function getIndex()
Gets the index of this row.

getGroupLevel : byte 

function getGroupLevel()
Gets the group level of the row.

isHeightMatched/setHeightMatched : boolean 

function isHeightMatched() / function setHeightMatched(value)
Indicates that row height and default font height matches

getStyle : Style 

function getStyle()
Represents the style of this row. You have to call Row.ApplyStyle() method to save your changing with the row style, otherwise it will not effect.

getFirstCell : Cell 

function getFirstCell()
Gets the first cell object in the row.

getFirstDataCell : Cell 

function getFirstDataCell()
Gets the first non-blank cell in the row.

getLastCell : Cell 

function getLastCell()
Gets the last cell object in the row.

getLastDataCell : Cell 

function getLastDataCell()
Gets the last non-blank cell in the row.

get : Cell 

function get(column)
Gets the cell.
Parameters:
column - The column index
Returns:

Method Detail

getCellByIndex

function getCellByIndex(index)
Get the cell by specific index in the list. NOTE: This member is now obsolete. Instead, please use Row.GetEnumerator() method to iterate all cells in this row. This property will be removed 12 months later since February 2015. Aspose apologizes for any inconvenience you may have experienced.
Parameters:
index: Number - The position.
Returns:
The Cell object.

iterator

function iterator()
Gets the cells enumerator
Returns:
The cells enumerator

getCellOrNull

function getCellOrNull(column)
Gets the cell or null in the specific index.
Parameters:
column: Number - The column index
Returns:
Returns the cell object if the cell exists. Or returns null if the cell object does not exist.

copySettings

function copySettings(source, checkStyle)
Copy settings of row, such as style, height, visibility, ...etc.
Parameters:
source: Row - the source row whose settings will be copied to this one
checkStyle: boolean - whether check and gather style. Only takes effect and be needed when two row objects belong to different workbook and the styles of two workbooks are different.

applyStyle

function applyStyle(style, flag)
Applies formats for a whole row.
Parameters:
style: Style - The style object which will be applied.
flag: StyleFlag - Flags which indicates applied formatting properties.

equals

function equals(obj)
Checks whether this object refers to the same row with another.
Parameters:
obj: Object - another object
Returns:
true if two objects refers to the same row.

equals

function equals(row)
Checks whether this object refers to the same row with another row object.
Parameters:
row: Row - another row object
Returns:
true if two row objects refers to the same row.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.