Class Glow

Represents the glow effect applied to an object or text.

Inheritance

System.Object

Glow

Namespace: IronWord.Models

Assembly: IronWord.dll

Syntax

public class Glow : Object

When text in a Word document needs a soft luminous halo around its outline, Glow describes that effect. You set its color and its spread, then attach the configured object to the GlowEffect property of a TextEffect so the run carries the glow when the document renders.

Two properties hold the settings. GlowColor takes a Color for the halo, and GlowRadius controls how far the glow spreads as a double. Because radius is unit-sensitive, read and write it through GetGlowRadius and SetGlowRadius, which both take a MeasurementUnit so a value is interpreted in points, centimeters, or inches rather than a raw number. Construct a Glow, set the color and radius, and assign it to TextEffect.GlowEffect; a wider radius and a lighter color produce a subtler halo, while a tight radius reads as a sharp edge.

Glow glow = new Glow();
glow.GlowColor = Color.Blue;
glow.SetGlowRadius(5, MeasurementUnit.Point);

The glow text effect how-to walks through applying it, and the glow effect example shows a working run.

Constructors

Glow()

Declaration

public Glow()

Properties

GlowColor

Gets or sets the color of the glow effect.

Declaration

public Color GlowColor { get; set; }

Property Value

Type	Description
Color

GlowRadius

Gets or sets the radius of the glow effect.

Declaration

public double GlowRadius { get; set; }

Property Value

Type	Description
System.Double

Remarks

The glow radius is specified in points (1/72 inch).

Methods

GetGlowRadius(MeasurementUnit)

Gets the radius of the glow effect in the specified measurement unit.

Declaration

public double GetGlowRadius(MeasurementUnit measurementUnit)

Parameters

Type	Name	Description
MeasurementUnit	measurementUnit	The measurement unit to convert the glow radius to.

Returns

Type	Description
System.Double	The radius of the glow effect.

SetGlowRadius(Double, MeasurementUnit)

Sets the radius of the glow effect to the specified value in the specified measurement unit.

Declaration

public void SetGlowRadius(double glowRadius, MeasurementUnit measurementUnit)

Parameters

Type	Name	Description
System.Double	glowRadius	The radius of the glow effect.
MeasurementUnit	measurementUnit	The measurement unit of the specified glow radius.