textDecoration property

Article
05/02/2017

Specifies a value that indicates whether the text in the object has blink, line-through, overline, or underline decorations.

Syntax

Integer value = object.put_textDecoration( v);Integer value = object.get_textDecoration(* sDecoration);

Property values

Type: BSTR

one of the values listed in Possible Values.

none (none)

Default. Text has no decoration.

underline (underline)

Text is underlined.

overline (overline)

Text has a line over it.

line-through (line-through)

Text has a line drawn through it.

blink (blink)

Not implemented.

String format

none | underline | overline | line-through | blink

CSS information

Applies To	All elements
Media	visual
Inherited	no
Initial Value	none

Remarks

The default value is different for the following tags.

Default value is underline for a when used with IHTMLLinkElement4::href, u, and ins.
Default value is line-through for strike, s, and del.

If the value none is placed at the end of the values, all values are cleared.

If the object has no text (for example, the img object in HTML) or is an empty object (for example, "<em></em>"), this property has no effect.

If you set the IHTMLCSSStyleDeclaration::textDecoration attribute to none on the body object, the a objects are still underlined. To remove the underline from the a objects, either set the style inline or use a as a selector in the global style sheet.

Specifying the IHTMLCSSStyleDeclaration::textDecoration property for block elements affects all inline children. If it is specified for, or affects, an inline element, it affects all boxes generated by the element.

The overline and blink possible values are available as of Microsoft Internet Explorer 4.0. Although blink is exposed, it is not rendered.

In Windows Internet Explorer 8 and later, when the IHTMLCSSStyleDeclaration::textDecoration property is set to overline and/or underline, the line will remain at the same vertical level and the same thickness across all child elements of the parent element on which the text decoration has been set. (This does not apply to the line-through value.) In Windows Internet Explorer 7 and earlier, the text decoration adjusts to correspond to the size and thickness of each child element.

Examples

The following examples use the IHTMLCSSStyleDeclaration::textDecoration attribute and the IHTMLCSSStyleDeclaration::textDecoration property to decorate text within the object.

This example uses an inline style sheet to draw a line through the text within the object.

Code example: http://samples.msdn.microsoft.com/workshop/samples/author/dhtml/refs/text-decoration.htm

<div style="text-decoration: line-through">
...
</div>

This example uses inline scripting to underline the text within the span object when the user moves the mouse over the span.

Code example: http://samples.msdn.microsoft.com/workshop/samples/author/dhtml/refs/textDecoration.htm

<span style="font-size: 14px" onmouseover="this.style.textDecoration='underline'" 
    onclick="this.style.textDecoration='overline'" 
    ondblclick="this.style.textDecoration='line-through'">
...
</span>

This example demonstrates that, though IHTMLCSSStyleDeclaration::textDecoration is not inheritable, its child elements are formatted with the same decoration (for instance, an underline) as their parent. Even if descendant elements have different color values, the color of the decoration will remain the same as that of the parent element.

Code example: http://samples.msdn.microsoft.com/workshop/samples/author/dhtml/refs/textDecoration_2.htm

<!DOCTYPE html>
<html>
<head>
  <style type="text/css">
    .redunderline {
      color: red;
      text-decoration: underline;
    }
    .blueoverline {
      color: blue;
      text-decoration: overline;
    }
  </style>
</head>
<body>
  <div class="redunderline">
    This <strong>div</strong> has text decoration set to underline,
    <span class="blueoverline">but this<strong>span</strong> has it set to overline.</span>
    The<strong>div</strong> continues here.
  </div>
</body>
</html>

Requirements

Minimum supported client	Windows XP
Minimum supported server	Windows 2000 Server
Header	Mshtml.h
IDL	Mshtml.idl
DLL	Mshtml.dll

Share via