UI_FONTUNDERLINE enumeration (uiribbon.h)

Specifies values that identify the underline state of a FontControl.

Syntax

typedef enum UI_FONTUNDERLINE {
  UI_FONTUNDERLINE_NOTAVAILABLE = 0,
  UI_FONTUNDERLINE_NOTSET = 1,
  UI_FONTUNDERLINE_SET = 2
} ;

Constants

 
UI_FONTUNDERLINE_NOTAVAILABLE
Value: 0
Underlining is not enabled.
UI_FONTUNDERLINE_NOTSET
Value: 1
Underlining is off.
UI_FONTUNDERLINE_SET
Value: 2
Underlining is on.

Remarks

UI_FONTUNDERLINE is associated with the Underline toggle button of the FontControl as shown in the following screen shot.

Screen shot of the FontControl element with the RichFont attribute set to true. The Underline toggle button is displayed by default in a FontControl but can be hidden, depending on the value of the FontType attribute.

The Underline button is toggled based on the UI_FONTUNDERLINE value in UI_PKEY_FontProperties_Underline.

A solid single line is the only underline style supported by the FontControl.

Requirements

Requirement Value
Minimum supported client Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps only]
Header uiribbon.h

See also

Constants and Enumerations

UI_PKEY_FontProperties_Underline