Class $.wijmo.wijspread.Col

Class Summary
Constructor Attributes	Constructor Name and Description
	$.wijmo.wijspread.Col(sheet, index, sheetArea) Represents a column in a sheet.

Method Summary
Method Attributes	Method Name and Description
	backColor(value) Gets or sets the background color for the column.
	borderBottom(value) Gets or sets the bottom border for the column.
	borderLeft(value) Gets or sets the left border for the column.
	borderRight(value) Gets or sets the right border for the column.
	borderTop(value) Gets or sets the top border for the column.
	clearStyleProperty(propertyName) Clears the style setting for the specified property.
	dataValidator(value) Gets or sets the data validator for the column.
	font(value) Gets or sets the font for the column.
	foreColor(value) Gets or sets the color of the text in the column.
	formatter(value) Gets or sets the formatter for the column.
	hAlign(value) Gets or sets the horizontal alignment of the contents of the cells in the column.
	locked(value) Gets or sets whether the cells in the column are locked.
	resizable(value) Gets or sets if the column can be resized by the user.
	shrinkToFit(value) Gets or sets whether the contents of the cells in the column can shrink to fit.
	textIndent(value) Gets or sets the text indent for the column.
	themeFont(value) Gets or sets the theme font for the column.
	vAlign(value) Gets or sets the vertical alignment of the contents of the cells in the column.
	visible(value) Gets or sets whether the column is displayed.
	width(value) Gets or sets the width of the column.
	wordWrap(value) Gets or sets whether text wraps in the cells in the column.

Class Detail

$.wijmo.wijspread.Col(sheet, index, sheetArea)

Represents a column in a sheet.

Parameters:
{$.wijmo.wijspread.Sheet} sheet: The sheet that contains this column.
{number} index: The column index.
{$.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 column.

activeSheet.getColumn(3).backColor("pink");

Parameters:
{string} value: The column's background color.

Returns:: {string} The column's background color.

{$.wijmo.wijspread.LineBorder} borderBottom(value)

Gets or sets the bottom border for the column.

activeSheet.getColumn(3).borderBottom(new $.wijmo.wijspread.$.wijmo.wijspread.LineBorder("blue", $.wijmo.wijspread.UI.LineStyle.mediumDashed));

Parameters:
{$.wijmo.wijspread.LineBorder} value: The column bottom border line.

Returns:: {$.wijmo.wijspread.LineBorder} The column bottom border line.

{$.wijmo.wijspread.LineBorder} borderLeft(value)

Gets or sets the left border for the column.

activeSheet.getColumn(3).borderLeft(new $.wijmo.wijspread.$.wijmo.wijspread.LineBorder("blue", $.wijmo.wijspread.UI.LineStyle.mediumDashed));

Parameters:
{$.wijmo.wijspread.LineBorder} value: The column left border line.

Returns:: {$.wijmo.wijspread.LineBorder} The column left border line.

{$.wijmo.wijspread.LineBorder} borderRight(value)

Gets or sets the right border for the column.

activeSheet.getColumn(3).borderRight(new $.wijmo.wijspread.$.wijmo.wijspread.LineBorder("blue", $.wijmo.wijspread.UI.LineStyle.mediumDashed));

Parameters:
{$.wijmo.wijspread.LineBorder} value: The column right border.

Returns:: {$.wijmo.wijspread.LineBorder} The column right border.

{$.wijmo.wijspread.LineBorder} borderTop(value)

Gets or sets the top border for the column.

activeSheet.getColumn(3).borderTop(new $.wijmo.wijspread.$.wijmo.wijspread.LineBorder("blue", $.wijmo.wijspread.UI.LineStyle.mediumDashed));

Parameters:
{$.wijmo.wijspread.LineBorder} value: The column top border line.

Returns:: {$.wijmo.wijspread.LineBorder} The column top border line.

clearStyleProperty(propertyName)

Clears the style setting for the specified property.

Parameters:
{string} propertyName: The property name.

{$.wijmo.wijspread.DataValidator} dataValidator(value)

Gets or sets the data validator for the column.

Parameters:
{$.wijmo.wijspread.DataValidator} value: The column data validator.

Returns:: {$.wijmo.wijspread.DataValidator} The column data validator.

{string} font(value)

Gets or sets the font for the column.

activeSheet.getColumn(3).font("12pt Arial");

Parameters:
{string} value: The column font.

Returns:: {string} The column font.

{string} foreColor(value)

Gets or sets the color of the text in the column.

activeSheet.getColumn(3).foreColor("blue");

Parameters:
{string} value: The color of the text in the column.

Returns:: {string} The color of the text in the column.

{string} formatter(value)

Gets or sets the formatter for the column.

Parameters:
{string} value: The column formatter.

Returns:: {string} The column formatter.

{$.wijmo.wijspread.HorizontalAlign} hAlign(value)

Gets or sets the horizontal alignment of the contents of the cells in the column.

activeSheet.getColumn(3).hAlign($.wijmo.wijspread.$.wijmo.wijspread.HorizontalAlign.right);

Parameters:
{$.wijmo.wijspread.HorizontalAlign} value: The horizontal alignment.

Returns:: {$.wijmo.wijspread.HorizontalAlign} The horizontal alignment.

{boolean} locked(value)

Gets or sets whether the cells in the column are locked.

activeSheet.getColumn(3).locked(true);

Parameters:
{boolean} value: Set to true to lock the cells in the column for editing.

Returns:: {boolean} true if the cells in the column are locked; otherwise, false.

{boolean} resizable(value)

Gets or sets if the column can be resized by the user.

activeSheet.getColumn(3).resizable(true);

Parameters:
{number} value: Set to true to let users resize the column.

Returns:: {boolean} true if the column can be resized; otherwise, false.

{boolean} shrinkToFit(value)

Gets or sets whether the contents of the cells in the column can shrink to fit.

activeSheet.getColumn(3).shrinkToFit(true);

Parameters:
{boolean} value: Set to true to shrink the contents to fit within the cells.

Returns:: {boolean} true if the contents shrink to fit the cells; otherwise, false.

{number} textIndent(value)

Gets or sets the text indent for the column.

activeSheet.getColumn(3).textIndent(1);

Parameters:
{number} value: The column text indent.

Returns:: {number} The column text indent.

{string} themeFont(value)

Gets or sets the theme font for the column.

Parameters:
{string} value: The column theme font.

Returns:: {string} The column theme font.

{$.wijmo.wijspread.VerticalAlign} vAlign(value)

Gets or sets the vertical alignment of the contents of the cells in the column.

activeSheet.getColumn(3).vAlign($.wijmo.wijspread.$.wijmo.wijspread.VerticalAlign.top);

Parameters:
{$.wijmo.wijspread.VerticalAlign} value: The vertical alignment.

Returns:: {$.wijmo.wijspread.VerticalAlign} The vertical alignment.

{boolean} visible(value)

Gets or sets whether the column is displayed.

Parameters:
{boolean} value: Set to true to display the column.

Returns:: {boolean} true if the column is displayed; otherwise, false.

{number} width(value)

Gets or sets the width of the column.

Parameters:
{number} value: The column width.

Returns:: {number} The column width.

{boolean} wordWrap(value)

Gets or sets whether text wraps in the cells in the column.

activeSheet.getColumn(3).wordWrap(true);

Parameters:
{boolean} value: Set to true to let text wrap in the cells.

Returns:: {boolean} true if the text can wrap; otherwise, false.

Classes

Class $.wijmo.wijspread.Col