Format Cells
Sets the number format, font, fill, alignment and borders of a range. Options left empty keep the cells' current format.
Behaviour
Risk: Low · Idempotent: Yes · Safe to retry: Yes · Recovery: Replayed after a crash
Package Excel activities Velophex.Excel.Activities 0.7.1-rc.7 · Supported (Core profile) · type id velophex.excel.formatCells
Properties#
Input#
Sheet#
Sheet · String · Required · Default: Sheet1
The name of the sheet.
Range#
Range · String · Optional · Default: Not specified in package metadata
The cells to format. Empty formats the used range.
Number Format#
NumberFormat · String · Optional · Default: Not specified in package metadata
An Excel number format code.
Bold#
Bold · Boolean? · Optional · Default: Not specified in package metadata
Bold text; empty keeps it.
Italic#
Italic · Boolean? · Optional · Default: Not specified in package metadata
Italic text; empty keeps it.
Underline#
Underline · Boolean? · Optional · Default: Not specified in package metadata
Single underline; empty keeps it.
Font Name#
FontName · String · Optional · Default: Not specified in package metadata
The font family.
Font Size#
FontSize · Double? · Optional · Default: Not specified in package metadata
The size in points.
Font Color#
FontColor · String · Optional · Default: Not specified in package metadata
A #RRGGBB code or a color name.
Fill Color#
FillColor · String · Optional · Default: Not specified in package metadata
A #RRGGBB code or a color name.
Horizontal Alignment#
HorizontalAlignment · String · Optional · Default: Not specified in package metadata
Empty keeps it.
Allowed values: Left, Center, Right, Justify, General.
Vertical Alignment#
VerticalAlignment · String · Optional · Default: Not specified in package metadata
Empty keeps it.
Allowed values: Top, Center, Bottom.
Wrap Text#
WrapText · Boolean? · Optional · Default: Not specified in package metadata
Wrap long text in the cell; empty keeps it.
Borders#
Borders · Boolean? · Optional · Default: Not specified in package metadata
On draws thin borders around and between the cells; off removes them; empty keeps them.
Workbook#
Workbook · ExcelWorkbookReference · Optional · Default: Not specified in package metadata
The Excel file to use. Empty uses the innermost enclosing Use Excel File; set it to the Reference As name of a Use Excel File to use that one.
Rules#
- Must be inside Use Excel File.
Retry and risk#
This activity is safe to retry: running it again after a transient failure does not repeat a side effect. If a run is interrupted and the outcome of a step is unknown, the step is never retried automatically (what to do). How activities declare this: characteristics, retries and risk.
Every activity also has the engine's common properties: Timeout and Continue On Error.
Related activities#
- Append Range (Excel)
- Auto Fill
- Auto Fit Range
- Clear Range
- Copy Paste Range
- Copy Sheet
- Create Sheet
- Create Table
Generated from Velophex.Excel.Activities 0.7.1-rc.7. Category: Excel. Keywords: excel, workbook, xlsx, spreadsheet, format, font, bold, number format, alignment, border, color.
Properties
Input
Rules
Retry and risk
Related activities