Back to Devexpress

SpreadsheetFont.UnderlineType Property

officefileapi-devexpress-dot-spreadsheet-dot-spreadsheetfont-79885192.md

latest9.3 KB
Original Source

SpreadsheetFont.UnderlineType Property

Gets or sets the type of underline applied to the cell content.

Namespace : DevExpress.Spreadsheet

Assembly : DevExpress.Spreadsheet.v25.2.Core.dll

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

csharp
UnderlineType UnderlineType { get; set; }
vb
Property UnderlineType As UnderlineType

Property Value

TypeDescription
UnderlineType

An UnderlineType enumeration value.

|

Available values:

NameDescription
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.

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.

View Example

csharp
// 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;
vb
' Access the Font object.
Dim cellFont As SpreadsheetFont = 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

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.

winforms-spreadsheetcontrol-api-part1/CS/SpreadsheetControl/SpreadsheetActions/FormattingActions.cs#L402

csharp
// Set font to be underlined.
cellFont.UnderlineType = UnderlineType.Single;
#endregion #FontSettings

wpf-spreadsheetcontrol-api-part-1/CS/SpreadsheetControl_WPF_API/SpreadsheetActions/FormattingActions.cs#L371

csharp
// Set font to be underlined.
cellFont.UnderlineType = UnderlineType.Single;
#endregion #FontSettings

spreadsheet-document-api-examples-part1/CS/SpreadsheetExamples/SpreadsheetActions/FormattingActions.cs#L262

csharp
// Specify the font underline type.
cellFont.UnderlineType = UnderlineType.Double;
#endregion #FontSettings

winforms-spreadsheetcontrol-api-part1/VB/SpreadsheetControl/SpreadsheetActions/FormattingActions.vb#L390

vb
' Set font to be underlined.
                cellFont.UnderlineType = UnderlineType.Single
' #End Region ' #FontSettings

wpf-spreadsheetcontrol-api-part-1/VB/SpreadsheetControl_WPF_API/SpreadsheetActions/FormattingActions.vb#L358

vb
' Set font to be underlined.
                cellFont.UnderlineType = UnderlineType.Single
' #End Region ' #FontSettings

spreadsheet-document-api-examples-part1/VB/SpreadsheetExamples/SpreadsheetActions/FormattingActions.vb#L214

vb
' Specify the font underline type.
            cellFont.UnderlineType = UnderlineType.Double
#End Region ' #FontSettings

See Also

Name

Size

FontStyle

Color

Strikethrough

Script

WinForms Spreadsheet Control Examples

SpreadsheetFont Interface

SpreadsheetFont Members

DevExpress.Spreadsheet Namespace