# Format Range Workbook (preview)

> Format Range Workbook activity that sets the number format, alignment, and font of the cells in a range.

`UiPath.Excel.Activities.FormatRange`

## Description

Sets the number format, alignment, and font of the cells in a range. This is the cross-platform equivalent of the [Format Cells](https://docs.uipath.com/activities/other/latest/productivity/format-range-x) Windows activity.

:::note
This activity does not support `.xls` files.
:::

## Project compatibility

Windows | Cross-platform

## Properties

### Common

* **DisplayName** - The name displayed for the activity in the Designer panel.

### Input

* **File** - The full path of the resource workbook. To switch to a local path, select the plus icon, and then **Use Local File**. The current field changes to **File (local path)**, where you can provide the full path of the workbook.
* **SheetName** - The name of the sheet from the workbook.
* **Range** - The range to format. This field is required.

### Format

Like the Windows activity, the designer shows one section of the settings at a time. Use the **Format** selector to choose between **Data Type**, **Alignment**, and **Font**. The selector is only used by the designer and is not saved with the workflow. The settings of the sections that are not displayed are kept and still applied.

You can configure any combination of the settings in the three sections. A setting that you leave unset keeps the existing formatting of the cells. This includes **Category**. For example, if you set only **Font style**, the existing number format isn't reset to **General**.

#### Data Type

* **Category** - The number format category to apply. Leave this field unset to keep the existing number format. When you select a category, only the fields of that category are displayed. If you bind **Category** to a variable or an expression, all the category fields are displayed.
  * **Number**
    * **Decimals** - The number of decimal places. The default value is `2`.
    * **Use 1000 Separator** - Select this option to use a thousands separator. By default, this option is not selected.
  * **Currency**
    * **Decimals** - The number of decimal places. The default value is `2`.
    * **Use 1000 Separator** - Select this option to use a thousands separator. By default, this option is not selected.
    * **Symbol** - The currency symbol. The default value is `$`. The symbol can't contain a quotation mark.
    * **Set at the end** - Select this option to place the symbol after the value instead of before it. By default, this option is not selected.
  * **Percentage**
    * **Decimals** - The number of decimal places. The default value is `2`.
  * **Date**
    * **Date format** - The date format: **3/14/2012** (short) or **Wednesday, March 14, 2012** (long). The default value is **3/14/2012**.
  * **Time**
    * **Time format** - The time format: **11:30** (hours and minutes) or **11:30:55** (hours, minutes, and seconds). The default value is **11:30**.
    * **AM/PM** - Select this option to use the 12-hour AM/PM format instead of the 24-hour format. By default, this option is not selected.
  * **Custom**
    * **Custom format** - A custom Excel number format string, used as entered.
  * **General** and **Text** have no additional fields. **General** applies the `General` format, and **Text** applies the `@` format.

#### Alignment

* **Horizontal** - The horizontal alignment of the cell content. Leave this field unset to keep the existing alignment. You can choose from the following options:
  * **General**
  * **Left**
  * **Center**
  * **Right**
  * **Fill**
  * **Justify**
  * **Center Across Selection**
  * **Distributed**
* **Vertical** - The vertical alignment of the cell content. Leave this field unset to keep the existing alignment. You can choose from the following options:
  * **Top**
  * **Center**
  * **Bottom**
  * **Justify**
  * **Distributed**
* **Wrap text** - Select this option to wrap the text within the cell. By default, this option is not selected. The setting is applied when the option is selected, or when a horizontal or vertical alignment is set, so that it can turn the wrapping off. Otherwise, the existing wrapping is kept.

#### Font

* **Font** - The name of the font family. Leave this field unset to keep the existing font.
* **Font style** - The font style. Leave this field unset to keep the existing style. You can choose from the following styles:
  * **Regular**
  * **Italic**
  * **Bold**
  * **Bold Italic**
* **Font size** - The font size, in points. Leave this field unset to keep the existing size.
* **Font color** - The font color, as a color name, for example `Red`, or a hex color, in the `#RRGGBB` or `#AARRGGBB` format. Leave this field unset to keep the existing color.
* **Underline style** - The underline style of the font. Leave this field unset to keep the existing style. To remove an underline, select **None**. You can choose from the following styles:
  * **None**
  * **Single**
  * **Double**
  * **Single Accounting**
  * **Double Accounting**
* **Fill color** - The fill, or background, color. It accepts the same values as **Font color**. Enter `Transparent` to remove the fill. Leave this field unset to keep the existing fill.

### Options

* **Password** - The password of the workbook, if necessary.

### Use Workbook

* **Workbook** - The existing workbook to use instead of a file path.

## Notes

* A setting that has no value isn't applied. A setting that has a value is applied, including `False` and `0`.
* **Font color** and **Fill color** accept a color name, without taking the case into account, for any known `System.Drawing` color, such as `Red` or `LightGray`, or a hex color. Any other value causes an error before any setting is applied. There is no color picker yet, so you enter the colors as text.
* A whole-column or whole-row range, such as `A:A`, applies a single column-level or row-level style. This matches the behavior of Excel, and the style also applies to cells that you fill in later.
* **Range** must refer to the sheet in **SheetName**. A range that includes a sheet name, such as `Sheet2!A1:A10`, is not supported and causes an error.
* A **Custom format** causes an error if, before the first number, date, or time placeholder, the double quotation marks don't occur in pairs. This applies whether or not a quotation mark is preceded by a backslash. For example, `"a"\"0.00` and `\"0.00` are rejected.
