SpreadsheetFont.UnderlineType Property
Gets or sets the type of underline applied to the cell content.
Namespace: DevExpress.Spreadsheet
Assembly: DevExpress.Spreadsheet.v18.2.Core.dll
Declaration
Property Value
| Type | Description |
|---|---|
| UnderlineType | An UnderlineType enumeration value. |
Available values:
| Name | Description |
|---|---|
| None | Indicates that the text is not underlined. |
| Single | Specifies a single underline. |
| Double | Specifies a double underline. |
| SingleAccounting | Specifies a single accounting underline (an underline that fills the entire cell width). |
| DoubleAccounting | Specifies a double accounting underline (an underline that fills the entire cell width). |
Remarks
To specify all the required font characteristics, use the SpreadsheetFont object properties such as SpreadsheetFont.Name, SpreadsheetFont.FontStyle, SpreadsheetFont.Size, SpreadsheetFont.Script, etc. Access this object via the Formatting.Font property.
- To specify the font of an individual cell, access the SpreadsheetFont object using the cell’s Formatting.Font property directly.
- To specify the font of a cell range, modify the SpreadsheetFont object within the Range.BeginUpdateFormatting - Range.EndUpdateFormatting method pair.
- To share the same font settings between multiple cells in one step, apply the style with the specified font to the required cells. To specify the cell style font, access the Style object from the IWorkbook.Styles collection and use this style’s Formatting.Font property within the Formatting.BeginUpdate-Formatting.EndUpdate paired methods to access and modify the SpreadsheetFont object.
For examples on how to specify formatting for an individual cell and cell range or modify a style, refer to the How to: Format a Cell or Range of Cells or How to: Create or Modify a Style documents.
To underline entire cells or rows, specify their bottom borders. For details, see the How to: Add and Remove Cell Borders example.
Example
This example demonstrates how to format cell font characteristics (e.g., font name, size, color, style) by modifying the SpreadsheetFont object accessed via the Formatting.Font property of the Cell object.
Note
A complete sample project is available at https://github.com/DevExpress-Examples/winforms-spreadsheetcontrol-api-e4655
// Access the Font object.
SpreadsheetFont cellFont = worksheet.Cells["A1"].Font;
// Set the font name.
cellFont.Name = "Times New Roman";
// Set the font size.
cellFont.Size = 14;
// Set the font color.
cellFont.Color = Color.Blue;
// Format text as bold.
cellFont.Bold = true;
// Set font to be underlined.
cellFont.UnderlineType = UnderlineType.Single;
Related GitHub Examples
The following code snippets (auto-collected from DevExpress Examples) contain references to the UnderlineType property.
Note
The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.