Class $.wijmo.wijspread.Row
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
$.wijmo.wijspread.Row(sheet, index, sheetArea)
Represents a row in a sheet.
|
| Method Attributes | Method Name and Description |
|---|---|
|
backColor(value)
Gets or sets the background color for the row.
|
|
|
borderBottom(value)
Gets or sets the bottom border for the row.
|
|
|
borderLeft(value)
Gets or sets the left border for the row.
|
|
|
borderRight(value)
Gets or sets the right border for the row.
|
|
|
borderTop(value)
Gets or sets the top border for the row.
|
|
|
clearStyleProperty(propertyName)
Clears the style setting for the specified property.
|
|
|
dataValidator(value)
Gets or sets the data validator for the row.
|
|
|
font(value)
Gets or sets the font for the row.
|
|
|
foreColor(value)
Gets or sets the text color for the row.
|
|
|
formatter(value)
Gets or sets the formatter for the row.
|
|
|
hAlign(value)
Gets or sets the horizontal alignment for the contents of the row.
|
|
|
height(value)
Gets or sets the height of the row.
|
|
|
locked(value)
Gets or sets whether the cells in the row are locked.
|
|
|
resizable(value)
Gets or sets whether the row can be resized by the user.
|
|
|
shrinkToFit(value)
Gets or sets whether the content of the cells in the row shrinks to fit.
|
|
|
textIndent(value)
Gets or sets the text indent for the row.
|
|
|
themeFont(value)
Gets or sets the theme font for the row.
|
|
|
vAlign(value)
Gets or sets the vertical alignment for the contents of the row.
|
|
|
visible(value)
Gets or set whether the row is displayed.
|
|
|
wordWrap(value)
Gets or sets whether text can wrap in the cells in the row.
|
Class Detail
$.wijmo.wijspread.Row(sheet, index, sheetArea)
Represents a row in a sheet.
- Parameters:
- {$.wijmo.wijspread.Sheet} sheet
- The sheet that contains this row.
- {number} index
- The row index of the row.
- {$.wijmo.wijspread.SheetArea} sheetArea
- The sheet area. If you do not provide this parameter, it will default to viewport.
Method Detail
{string}
backColor(value)
Gets or sets the background color for the row.
activeSheet.getRow(2).backColor("lightblue");
- Parameters:
- {string} value
- The row background color.
- Returns:
- {string} The row background color.
{$.wijmo.wijspread.LineBorder}
borderBottom(value)
Gets or sets the bottom border for the row.
activeSheet.getRow(2).borderBottom(new $.wijmo.wijspread.$.wijmo.wijspread.LineBorder("green", $.wijmo.wijspread.UI.LineStyle.mediumDashed));
- Parameters:
- {$.wijmo.wijspread.LineBorder} value
- The row bottom border line.
- Returns:
- {$.wijmo.wijspread.LineBorder} The row bottom border line.
{$.wijmo.wijspread.LineBorder}
borderLeft(value)
Gets or sets the left border for the row.
activeSheet.getRow(2).borderLeft(new $.wijmo.wijspread.$.wijmo.wijspread.LineBorder("green", $.wijmo.wijspread.UI.LineStyle.mediumDashed));
- Parameters:
- {$.wijmo.wijspread.LineBorder} value
- The row left border line.
- Returns:
- {$.wijmo.wijspread.LineBorder} The row left border line.
{$.wijmo.wijspread.LineBorder}
borderRight(value)
Gets or sets the right border for the row.
activeSheet.getRow(2).borderRight(new $.wijmo.wijspread.$.wijmo.wijspread.LineBorder("green", $.wijmo.wijspread.UI.LineStyle.mediumDashed));
- Parameters:
- {$.wijmo.wijspread.LineBorder} value
- The row right border line.
- Returns:
- {$.wijmo.wijspread.LineBorder} The row right border line.
{$.wijmo.wijspread.LineBorder}
borderTop(value)
Gets or sets the top border for the row.
activeSheet.getRow(2).borderTop(new $.wijmo.wijspread.$.wijmo.wijspread.LineBorder("green", $.wijmo.wijspread.UI.LineStyle.mediumDashed));
- Parameters:
- {$.wijmo.wijspread.LineBorder} value
- The row top border line.
- Returns:
- {$.wijmo.wijspread.LineBorder} The row top border line.
clearStyleProperty(propertyName)
Clears the style setting for the specified property.
- Parameters:
- {string} propertyName
- The row property name.
{$.wijmo.wijspread.DefaultDataValidator}
dataValidator(value)
Gets or sets the data validator for the row.
- Parameters:
- {$.wijmo.wijspread.DefaultDataValidator} value
- The row data validator.
- Returns:
- {$.wijmo.wijspread.DefaultDataValidator} The row data valiadtor.
{string}
font(value)
Gets or sets the font for the row.
activeSheet.getRow(2).font("12pt Arial");
- Parameters:
- {string} value
- The row font.
- Returns:
- {string} The row font.
{string}
foreColor(value)
Gets or sets the text color for the row.
activeSheet.getRow(2).foreColor("green");
- Parameters:
- {string} value
- The row foreground color.
- Returns:
- {string} The row foreground color.
{string}
formatter(value)
Gets or sets the formatter for the row.
- Parameters:
- {string} value
- The row formatter.
- Returns:
- {string} The row formatter.
{$.wijmo.wijspread.HorizontalAlign}
hAlign(value)
Gets or sets the horizontal alignment for the contents of the row.
activeSheet.getRow(2).hAlign($.wijmo.wijspread.$.wijmo.wijspread.HorizontalAlign.left);
- Parameters:
- {$.wijmo.wijspread.HorizontalAlign} value
- The row horizontal alignment.
- Returns:
- {$.wijmo.wijspread.HorizontalAlign} The row horizontal alignment.
{number}
height(value)
Gets or sets the height of the row.
- Parameters:
- {number} value
- The cell row height.
- Returns:
- {number} The row height.
{boolean}
locked(value)
Gets or sets whether the cells in the row are locked.
activeSheet.getRow(2).locked(false);
- Parameters:
- {boolean} value
- Set to true to lock the cells in the row so the user cannot edit them.
- Returns:
- {boolean} true if the cells in the row are locked; otherwise, false.
{booolean}
resizable(value)
Gets or sets whether the row can be resized by the user.
activeSheet.getRow(2).resizable(false);
- Parameters:
- {boolean} value
- Set to true to make the row resizable.
- Returns:
- {booolean} true if the user can resize the row; otherwise, false.
{boolean}
shrinkToFit(value)
Gets or sets whether the content of the cells in the row shrinks to fit.
activeSheet.getRow(2).shrinkToFit(false);
- Parameters:
- {boolean} value
- Set to true to let the contents in the cells in the row shrink to fit within the cell.
- Returns:
- {boolean} true if the contents can shrink to fit; otherwise, false.
{number}
textIndent(value)
Gets or sets the text indent for the row.
activeSheet.getRow(2).textIndent(1);
- Parameters:
- {number} value
- The row text indent.
- Returns:
- {number} The row text indent.
{string}
themeFont(value)
Gets or sets the theme font for the row.
- Parameters:
- {string} value
- The row theme font.
- Returns:
- {string} The row theme font.
{$.wijmo.wijspread.VerticalAlign}
vAlign(value)
Gets or sets the vertical alignment for the contents of the row.
activeSheet.getRow(2).vAlign($.wijmo.wijspread.$.wijmo.wijspread.VerticalAlign.bottom);
- Parameters:
- {$.wijmo.wijspread.VerticalAlign} value
- The row vertical alignment.
- Returns:
- {$.wijmo.wijspread.VerticalAlign} The row vertical alignment.
{booolean}
visible(value)
Gets or set whether the row is displayed.
- Parameters:
- {boolean} value
- Set to true to make the row visible.
- Returns:
- {booolean} true if the row is displayed; otherwise, false.
{boolean}
wordWrap(value)
Gets or sets whether text can wrap in the cells in the row.
activeSheet.getRow(2).wordWrap(false);
- Parameters:
- {boolean} value
- Set to true to let text wrap in the cells in the row.
- Returns:
- {boolean} true if the text can wrap; otherwise, false.