Ignite UI™ API Documentation

alignment

.alignment( );
Return Type:: ig.excel.HorizontalCellAlignment
Return Type Description:: The horizontal alignment of the content in a cell.

Gets the horizontal alignment of the content in a cell.

Exceptions

Exception	Description
ig.excel.InvalidEnumArgumentException	The value assigned is not defined in the HorizontalCellAlignment enumeration.

alignment

.alignment( value:ig.excel.HorizontalCellAlignment );
Return Type:: ig.excel.HorizontalCellAlignment
Return Type Description:: The horizontal alignment of the content in a cell.

Sets the horizontal alignment of the content in a cell.

value
Type:ig.excel.HorizontalCellAlignment

Exceptions

Exception	Description
ig.excel.InvalidEnumArgumentException	The value assigned is not defined in the HorizontalCellAlignment enumeration.

bottomBorderColorInfo

.bottomBorderColorInfo( );
Return Type:: ig.excel.WorkbookColorInfo
Return Type Description:: The bottom border color.

Gets the bottom border color.

Remarks

If the border color is set to a non-default value and the IWorksheetCellFormat.bottomBorderStyle is set to Default, it will be resolved to Thin.

bottomBorderColorInfo

.bottomBorderColorInfo( value:ig.excel.WorkbookColorInfo );
Return Type:: ig.excel.WorkbookColorInfo
Return Type Description:: The bottom border color.

Sets the bottom border color.

value
Type:ig.excel.WorkbookColorInfo

Remarks

If the border color is set to a non-default value and the IWorksheetCellFormat.bottomBorderStyle is set to Default, it will be resolved to Thin.

bottomBorderStyle

.bottomBorderStyle( );
Return Type:: ig.excel.CellBorderLineStyle
Return Type Description:: The bottom border style.

Gets the bottom border style.

Exceptions

Exception	Description
ig.excel.InvalidEnumArgumentException	The value assigned is not defined in the CellBorderLineStyle enumeration.

Remarks

If the border style is set to a non-default value and the IWorksheetCellFormat.bottomBorderColorInfo is null, it will be resolved to WorkbookColorInfo.automatic.

bottomBorderStyle

.bottomBorderStyle( value:ig.excel.CellBorderLineStyle );
Return Type:: ig.excel.CellBorderLineStyle
Return Type Description:: The bottom border style.

Sets the bottom border style.

value
Type:ig.excel.CellBorderLineStyle

Exceptions

Exception	Description
ig.excel.InvalidEnumArgumentException	The value assigned is not defined in the CellBorderLineStyle enumeration.

Remarks

If the border style is set to a non-default value and the IWorksheetCellFormat.bottomBorderColorInfo is null, it will be resolved to WorkbookColorInfo.automatic.

diagonalBorderColorInfo

.diagonalBorderColorInfo( );
Return Type:: ig.excel.WorkbookColorInfo
Return Type Description:: The diagonal border color.

Gets the diagonal border color.

Remarks

If the border color is set to a non-default value and the IWorksheetCellFormat.diagonalBorderStyle is set to Default, it will be resolved to Thin.

diagonalBorderColorInfo

.diagonalBorderColorInfo( value:ig.excel.WorkbookColorInfo );
Return Type:: ig.excel.WorkbookColorInfo
Return Type Description:: The diagonal border color.

Sets the diagonal border color.

value
Type:ig.excel.WorkbookColorInfo

Remarks

If the border color is set to a non-default value and the IWorksheetCellFormat.diagonalBorderStyle is set to Default, it will be resolved to Thin.

diagonalBorders

.diagonalBorders( );
Return Type:: ig.excel.DiagonalBorders
Return Type Description:: The diagonal border style.

Gets the diagonal borders.

Exceptions

Exception	Description
ig.excel.InvalidEnumArgumentException	The value assigned is not defined in the CellBorderLineStyle enumeration.

Remarks

If the diagonal borders are set to something other than None and the IWorksheetCellFormat.diagonalBorderStyle is set to Default, it will be resolved to Thin. Similarly, if the IWorksheetCellFormat.diagonalBorderColorInfo is null, it will be resolved to Color.Black.

diagonalBorders

.diagonalBorders( value:ig.excel.DiagonalBorders );
Return Type:: ig.excel.DiagonalBorders
Return Type Description:: The diagonal border style.

Sets the diagonal borders.

value
Type:ig.excel.DiagonalBorders

Exceptions

Exception	Description
ig.excel.InvalidEnumArgumentException	The value assigned is not defined in the CellBorderLineStyle enumeration.

Remarks

If the diagonal borders are set to something other than None and the IWorksheetCellFormat.diagonalBorderStyle is set to Default, it will be resolved to Thin. Similarly, if the IWorksheetCellFormat.diagonalBorderColorInfo is null, it will be resolved to Color.Black.

diagonalBorderStyle

.diagonalBorderStyle( );
Return Type:: ig.excel.CellBorderLineStyle
Return Type Description:: The diagonal border style.

Gets the diagonal border style.

Exceptions

Exception	Description
ig.excel.InvalidEnumArgumentException	The value assigned is not defined in the CellBorderLineStyle enumeration.

Remarks

If the border style is set to a non-default value and the IWorksheetCellFormat.diagonalBorderColorInfo is null, it will be resolved to WorkbookColorInfo.automatic.

diagonalBorderStyle

.diagonalBorderStyle( value:ig.excel.CellBorderLineStyle );
Return Type:: ig.excel.CellBorderLineStyle
Return Type Description:: The diagonal border style.

Sets the diagonal border style.

value
Type:ig.excel.CellBorderLineStyle

Exceptions

Exception	Description
ig.excel.InvalidEnumArgumentException	The value assigned is not defined in the CellBorderLineStyle enumeration.

Remarks

If the border style is set to a non-default value and the IWorksheetCellFormat.diagonalBorderColorInfo is null, it will be resolved to WorkbookColorInfo.automatic.

fill

.fill( );
Return Type:: ig.excel.CellFill
Return Type Description:: The fill of the cell.

Gets the fill of the cell.

fill

.fill( value:ig.excel.CellFill );
Return Type:: ig.excel.CellFill
Return Type Description:: The fill of the cell.

Sets the fill of the cell.

value
Type:ig.excel.CellFill

font

.font( );
Return Type:: ig.excel.IWorkbookFont
Return Type Description:: The default font formatting.

Gets the default font formatting.

Remarks

This font formatting is just the default font used in the cell. This can be overridden by strings on a character by character basis by using the FormattedString class.

formatOptions

.formatOptions( );

Gets the groups of properties provided by the format.

Remarks

For style formats, this value indicates which properties should be used in the format when applying the style to a cell. All other groups of properties will return a default value.

For cell and differential formats, this value indicates which properties should be resolved and returned by the format. All other properties should will be resolved and returned by the parent IWorksheetCellFormat.style.

formatOptions

.formatOptions( value:ig.excel.WorksheetCellFormatOptions );

Sets the groups of properties provided by the format.

value
Type:ig.excel.WorksheetCellFormatOptions

Remarks

For style formats, this value indicates which properties should be used in the format when applying the style to a cell. All other groups of properties will return a default value.

For cell and differential formats, this value indicates which properties should be resolved and returned by the format. All other properties should will be resolved and returned by the parent IWorksheetCellFormat.style.

formatString

.formatString( );
Return Type:: string
Return Type Description:: The number format string.

Gets the number format string.

Exceptions

Exception	Description
ig.ArgumentException	The assigned value is an invalid format string and Workbook.validateFormatStrings is True.

Remarks

For more information on excel format strings, consult Microsoft Excel help.

formatString

.formatString( value:string );
Return Type:: string
Return Type Description:: The number format string.

Sets the number format string.

value
Type:string

Exceptions

Exception	Description
ig.ArgumentException	The assigned value is an invalid format string and Workbook.validateFormatStrings is True.

Remarks

For more information on excel format strings, consult Microsoft Excel help.

indent

.indent( );
Return Type:: number
Return Type Description:: The indent in units of average character widths or -1 to use the default indent.

Gets the indent in units of average character widths.

Exceptions

Exception	Description
ig.ArgumentOutOfRangeException	The assigned value is not -1 and is outside the valid indent level range of 0 and 250.

Remarks

A value of -1 indicates that the default value should be used.

indent

.indent( value:number );
Return Type:: number
Return Type Description:: The indent in units of average character widths or -1 to use the default indent.

Sets the indent in units of average character widths.

value
Type:number

Exceptions

Exception	Description
ig.ArgumentOutOfRangeException	The assigned value is not -1 and is outside the valid indent level range of 0 and 250.

Remarks

A value of -1 indicates that the default value should be used.

leftBorderColorInfo

.leftBorderColorInfo( );
Return Type:: ig.excel.WorkbookColorInfo
Return Type Description:: The left border color.

Gets the left border color.

Remarks

If the border color is set to a non-default value and the IWorksheetCellFormat.leftBorderStyle is set to Default, it will be resolved to Thin.

leftBorderColorInfo

.leftBorderColorInfo( value:ig.excel.WorkbookColorInfo );
Return Type:: ig.excel.WorkbookColorInfo
Return Type Description:: The left border color.

Sets the left border color.

value
Type:ig.excel.WorkbookColorInfo

Remarks

If the border color is set to a non-default value and the IWorksheetCellFormat.leftBorderStyle is set to Default, it will be resolved to Thin.

leftBorderStyle

.leftBorderStyle( );
Return Type:: ig.excel.CellBorderLineStyle
Return Type Description:: The left border style.

Gets the left border style.

Exceptions

Exception	Description
ig.excel.InvalidEnumArgumentException	The value assigned is not defined in the CellBorderLineStyle enumeration.

Remarks

If the border style is set to a non-default value and the IWorksheetCellFormat.leftBorderColorInfo is null, it will be resolved to WorkbookColorInfo.automatic.

leftBorderStyle

.leftBorderStyle( value:ig.excel.CellBorderLineStyle );
Return Type:: ig.excel.CellBorderLineStyle
Return Type Description:: The left border style.

Sets the left border style.

value
Type:ig.excel.CellBorderLineStyle

Exceptions

Exception	Description
ig.excel.InvalidEnumArgumentException	The value assigned is not defined in the CellBorderLineStyle enumeration.

Remarks

If the border style is set to a non-default value and the IWorksheetCellFormat.leftBorderColorInfo is null, it will be resolved to WorkbookColorInfo.automatic.

locked

.locked( );

locked

.locked( value:boolean );

value
Type:boolean

rightBorderColorInfo

.rightBorderColorInfo( );
Return Type:: ig.excel.WorkbookColorInfo
Return Type Description:: The right border color.

Gets the right border color.

Remarks

If the border color is set to a non-default value and the IWorksheetCellFormat.rightBorderStyle is set to Default, it will be resolved to Thin.

rightBorderColorInfo

.rightBorderColorInfo( value:ig.excel.WorkbookColorInfo );
Return Type:: ig.excel.WorkbookColorInfo
Return Type Description:: The right border color.

Sets the right border color.

value
Type:ig.excel.WorkbookColorInfo

Remarks

If the border color is set to a non-default value and the IWorksheetCellFormat.rightBorderStyle is set to Default, it will be resolved to Thin.

rightBorderStyle

.rightBorderStyle( );
Return Type:: ig.excel.CellBorderLineStyle
Return Type Description:: The right border style.

Gets the right border style.

Exceptions

Exception	Description
ig.excel.InvalidEnumArgumentException	The value assigned is not defined in the CellBorderLineStyle enumeration.

Remarks

If the border style is set to a non-default value and the IWorksheetCellFormat.rightBorderColorInfo is null, it will be resolved to WorkbookColorInfo.automatic.

rightBorderStyle

.rightBorderStyle( value:ig.excel.CellBorderLineStyle );
Return Type:: ig.excel.CellBorderLineStyle
Return Type Description:: The right border style.

Sets the right border style.

value
Type:ig.excel.CellBorderLineStyle

Exceptions

Exception	Description
ig.excel.InvalidEnumArgumentException	The value assigned is not defined in the CellBorderLineStyle enumeration.

Remarks

If the border style is set to a non-default value and the IWorksheetCellFormat.rightBorderColorInfo is null, it will be resolved to WorkbookColorInfo.automatic.

rotation

.rotation( );
Return Type:: number
Return Type Description:: The rotation of the cell content in degrees.

Gets the rotation of the cell content in degrees.

Remarks

Cell text rotation, in degrees; 0 – 90 is up 0 – 90 degrees, 91 – 180 is down 1 – 90 degrees, and 255 is vertical.

rotation

.rotation( value:number );
Return Type:: number
Return Type Description:: The rotation of the cell content in degrees.

Sets the rotation of the cell content in degrees.

value
Type:number

Remarks

Cell text rotation, in degrees; 0 – 90 is up 0 – 90 degrees, 91 – 180 is down 1 – 90 degrees, and 255 is vertical.

setFormatting

.setFormatting( source:ig.excel.IWorksheetCellFormat );

Copies all cell format properties to from the specified cell format.

source
Type:ig.excel.IWorksheetCellFormat
The cell format from which to copy the properties.

shrinkToFit

.shrinkToFit( );

shrinkToFit

.shrinkToFit( value:boolean );

value
Type:boolean

style

.style( );
Return Type:: ig.excel.WorkbookStyle
Return Type Description:: A WorkbookStyle instance if this is a cell or differential format, or null if this is a style format.

Gets the parent WorkbookStyle of the format.

Exceptions

Exception	Description
ig.InvalidOperationException	The value assigned is non-null and the format is a style format.
ig.ArgumentException	The value assigned is from a different Workbook.

Remarks

The parent style of a cell or differential format provides default format values. Depending on which IWorksheetCellFormat.formatOptions flags are present, only certain groups of format properties will be resolved from parent style. When any of the properties in a group is set to a non-default value, the FormatOptions will automatically have that flag included so the format provides values in that group rather than the style providing values in that group.

By default, all cell and differential formats will have a parent style of the normal style, which is exposed by the WorkbookStyleCollection.normalStyle property. If a value of null is assigned as the Style for a cell or differential format, then NormalStyle will actually be set.

style

.style( value:ig.excel.WorkbookStyle );
Return Type:: ig.excel.WorkbookStyle
Return Type Description:: A WorkbookStyle instance if this is a cell or differential format, or null if this is a style format.

Sets the parent WorkbookStyle of the format.

value
Type:ig.excel.WorkbookStyle

Exceptions

Exception	Description
ig.InvalidOperationException	The value assigned is non-null and the format is a style format.
ig.ArgumentException	The value assigned is from a different Workbook.

Remarks

The parent style of a cell or differential format provides default format values. Depending on which IWorksheetCellFormat.formatOptions flags are present, only certain groups of format properties will be resolved from parent style. When any of the properties in a group is set to a non-default value, the FormatOptions will automatically have that flag included so the format provides values in that group rather than the style providing values in that group.

By default, all cell and differential formats will have a parent style of the normal style, which is exposed by the WorkbookStyleCollection.normalStyle property. If a value of null is assigned as the Style for a cell or differential format, then NormalStyle will actually be set.

topBorderColorInfo

.topBorderColorInfo( );
Return Type:: ig.excel.WorkbookColorInfo
Return Type Description:: The top border color.

Gets the top border color.

Remarks

If the border color is set to a non-default value and the IWorksheetCellFormat.topBorderStyle is set to Default, it will be resolved to Thin.

topBorderColorInfo

.topBorderColorInfo( value:ig.excel.WorkbookColorInfo );
Return Type:: ig.excel.WorkbookColorInfo
Return Type Description:: The top border color.

Sets the top border color.

value
Type:ig.excel.WorkbookColorInfo

Remarks

If the border color is set to a non-default value and the IWorksheetCellFormat.topBorderStyle is set to Default, it will be resolved to Thin.

topBorderStyle

.topBorderStyle( );
Return Type:: ig.excel.CellBorderLineStyle
Return Type Description:: The top border style.

Gets the top border style.

Exceptions

Exception	Description
ig.excel.InvalidEnumArgumentException	The value assigned is not defined in the CellBorderLineStyle enumeration.

Remarks

If the border style is set to a non-default value and the IWorksheetCellFormat.topBorderColorInfo is null, it will be resolved to WorkbookColorInfo.automatic.

topBorderStyle

.topBorderStyle( value:ig.excel.CellBorderLineStyle );
Return Type:: ig.excel.CellBorderLineStyle
Return Type Description:: The top border style.

Sets the top border style.

value
Type:ig.excel.CellBorderLineStyle

Exceptions

Exception	Description
ig.excel.InvalidEnumArgumentException	The value assigned is not defined in the CellBorderLineStyle enumeration.

Remarks

If the border style is set to a non-default value and the IWorksheetCellFormat.topBorderColorInfo is null, it will be resolved to WorkbookColorInfo.automatic.

verticalAlignment

.verticalAlignment( );
Return Type:: ig.excel.VerticalCellAlignment
Return Type Description:: The vertical alignment of the content in a cell.

Gets the vertical alignment of the content in a cell.

Exceptions

Exception	Description
ig.excel.InvalidEnumArgumentException	The value assigned is not defined in the VerticalCellAlignment enumeration.

verticalAlignment

.verticalAlignment( value:ig.excel.VerticalCellAlignment );
Return Type:: ig.excel.VerticalCellAlignment
Return Type Description:: The vertical alignment of the content in a cell.

Sets the vertical alignment of the content in a cell.

value
Type:ig.excel.VerticalCellAlignment

Exceptions

Exception	Description
ig.excel.InvalidEnumArgumentException	The value assigned is not defined in the VerticalCellAlignment enumeration.

wrapText

.wrapText( );

wrapText

.wrapText( value:boolean );

value
Type:boolean

Ignite UI | Samples

ig.excel.IWorksheetCellFormat

Remarks

Dependencies

alignment

Exceptions

See Also

alignment

Exceptions

See Also

bottomBorderColorInfo

Remarks

See Also

bottomBorderColorInfo

Remarks

See Also

bottomBorderStyle

Exceptions

Remarks

See Also

bottomBorderStyle

Exceptions

Remarks

See Also

diagonalBorderColorInfo

Remarks

See Also

diagonalBorderColorInfo

Remarks

See Also

diagonalBorders

Exceptions

Remarks

See Also

diagonalBorders

Exceptions

Remarks

See Also

diagonalBorderStyle

Exceptions

Remarks

See Also

diagonalBorderStyle

Exceptions

Remarks

See Also

fill

See Also

fill

See Also

font

Remarks

formatOptions

Remarks

See Also

formatOptions

Remarks

See Also

formatString

Exceptions

Remarks

See Also

formatString

Exceptions

Remarks

See Also

indent

Exceptions

Remarks

indent

Exceptions

Remarks

leftBorderColorInfo

Remarks

See Also

leftBorderColorInfo

Remarks

See Also

leftBorderStyle

Exceptions