Class Reflection

Represents a reflection effect applied to text or objects.

Inheritance

System.Object

Reflection

Namespace: IronWord.Models

Assembly: IronWord.dll

Syntax

public class Reflection : Object

Reflection is the mirrored-image effect a developer attaches when text in a Word document should appear to reflect off a surface below it. It describes the faded copy that falls beneath the original, the polished touch on a title or heading that makes the type look like it is sitting on glass. A developer styling a document reaches for it when flat text needs a sense of depth, and it is the effect most easily confused with Shadow, which casts a dark offset rather than a faded mirror.

A reflection is set as the ReflectionEffect on a TextEffect, so it is configured as part of a text style's effects rather than on its own. Build the reflection's geometry and fade once, attach it to the text effect, and the mirrored copy renders wherever that styled text appears.

The fade is controlled by StartingOpacity and EndingOpacity together with StartPosition and EndPosition, which set where the reflection begins and ends and how it dissolves. BlurRadius softens the mirrored image, DistanceFromText pushes it away from the original, and Alignment and FadeDirectionAngle orient it. The skew and scaling properties (HorizontalSkewAngle, VerticalSkewAngle, HorizontalScalingFactor, VerticalScalingFactor) shear and size the reflected copy, while SchemeColor and DirectionAngle tune its tint and direction. Because Word measurements can be expressed in several units, the SetBlurRadius, SetDistanceFromText, SetStartPosition, and SetEndPosition methods take a value plus a MeasurementUnit, and the matching Get methods read those values back in a chosen unit. Prefer the Set methods over the raw properties whenever the unit matters, so the dimension is recorded unambiguously.

using IronWord.Models;
using IronWord.Models.Enums;

var reflection = new Reflection();
reflection.StartingOpacity = 60;
reflection.EndingOpacity = 0;
reflection.SetBlurRadius(2, MeasurementUnit.Point);
reflection.SetDistanceFromText(1, MeasurementUnit.Point);

The reflection text effect how-to walks through applying it, the shadow text effect how-to covers the related offset effect, and the glow text effect how-to shows another text styling option.

Constructors

Reflection()

Declaration

public Reflection()

Properties

Alignment

Gets or sets the alignment of the reflection effect.

Declaration

public RectangleAlignmentValues Alignment { get; set; }

Property Value

Type	Description
RectangleAlignmentValues

BlurRadius

Gets or sets the blur radius of the reflection effect.

Declaration

public double BlurRadius { get; set; }

Property Value

Type	Description
System.Double

Remarks

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

DirectionAngle

Gets or sets the direction angle of the reflection effect.

Declaration

public double DirectionAngle { get; set; }

Property Value

Type	Description
System.Double

Remarks

The direction angle is specified in degrees.

DistanceFromText

Gets or sets the distance of the reflection effect from the text or object.

Declaration

public double DistanceFromText { get; set; }

Property Value

Type	Description
System.Double

Remarks

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

EndingOpacity

Gets or sets the ending opacity of the reflection effect.

Declaration

public double EndingOpacity { get; set; }

Property Value

Type	Description
System.Double

EndPosition

Gets or sets the ending position of the reflection effect.

Declaration

public double EndPosition { get; set; }

Property Value

Type	Description
System.Double

FadeDirectionAngle

Gets or sets the fade direction of the reflection effect.

Declaration

public double FadeDirectionAngle { get; set; }

Property Value

Type	Description
System.Double

HorizontalScalingFactor

Gets or sets the horizontal scaling factor of the reflection effect.

Declaration

public int HorizontalScalingFactor { get; set; }

Property Value

Type	Description
System.Int32

HorizontalSkewAngle

Gets or sets the horizontal skew angle of the reflection effect.

Declaration

public double HorizontalSkewAngle { get; set; }

Property Value

Type	Description
System.Double

Remarks

The skew angle is specified in degrees.

SchemeColor

Gets or sets the scheme color of the reflection effect.

Declaration

public Color SchemeColor { get; set; }

Property Value

Type	Description
Color

StartingOpacity

Gets or sets the starting opacity of the reflection effect.

Declaration

public double StartingOpacity { get; set; }

Property Value

Type	Description
System.Double

StartPosition

Gets or sets the starting position of the reflection effect.

Declaration

public double StartPosition { get; set; }

Property Value

Type	Description
System.Double

VerticalScalingFactor

Gets or sets the vertical scaling factor of the reflection effect.

Declaration

public double VerticalScalingFactor { get; set; }

Property Value

Type	Description
System.Double

VerticalSkewAngle

Gets or sets the vertical skew angle of the reflection effect.

Declaration

public double VerticalSkewAngle { get; set; }

Property Value

Type	Description
System.Double

Remarks

The skew angle is specified in degrees.

Methods

GetBlurRadius(MeasurementUnit)

Gets the blur radius of the reflection effect in the specified measurement unit.

Declaration

public double GetBlurRadius(MeasurementUnit measurementUnit)

Parameters

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

Returns

Type	Description
System.Double	The blur radius of the reflection effect.

GetDistanceFromText(MeasurementUnit)

Gets the distance of the reflection effect from the text or object in the specified measurement unit.

Declaration

public double GetDistanceFromText(MeasurementUnit measurementUnit)

Parameters

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

Returns

Type	Description
System.Double	The distance of the reflection effect from the text or object.

GetEndPosition(MeasurementUnit)

Gets the End position of the reflection effect in the specified measurement unit.

Declaration

public double GetEndPosition(MeasurementUnit measurementUnit)

Parameters

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

Returns

Type	Description
System.Double	The End position of the reflection effect from the text or object.

GetStartPosition(MeasurementUnit)

Gets the Start position of the reflection effect in the specified measurement unit.

Declaration

public double GetStartPosition(MeasurementUnit measurementUnit)

Parameters

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

Returns

Type	Description
System.Double	The Start position of the reflection effect from the text or object.

SetBlurRadius(Double, MeasurementUnit)

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

Declaration

public void SetBlurRadius(double blurRadius, MeasurementUnit measurementUnit)

Parameters

Type	Name	Description
System.Double	blurRadius	The blur radius of the reflection effect.
MeasurementUnit	measurementUnit	The measurement unit of the specified blur radius.

SetDistanceFromText(Double, MeasurementUnit)

Sets the distance of the reflection effect from the text or object to the specified value in the specified measurement unit.

Declaration

public void SetDistanceFromText(double distance, MeasurementUnit measurementUnit)

Parameters

Type	Name	Description
System.Double	distance	The distance of the reflection effect from the text or object.
MeasurementUnit	measurementUnit	The measurement unit of the specified distance.

SetEndPosition(Double, MeasurementUnit)

Sets the distance of the reflection effect from the text or object to the specified value in the specified measurement unit.

Declaration

public void SetEndPosition(double endPosition, MeasurementUnit measurementUnit)

Parameters

Type	Name	Description
System.Double	endPosition	The End position of the reflection effect from the text or object.
MeasurementUnit	measurementUnit	The measurement unit of the specified position.

SetStartPosition(Double, MeasurementUnit)

Sets the distance of the reflection effect from the text or object to the specified value in the specified measurement unit.

Declaration

public void SetStartPosition(double startPosition, MeasurementUnit measurementUnit)

Parameters

Type	Name	Description
System.Double	startPosition	The Start position of the reflection effect from the text or object.
MeasurementUnit	measurementUnit	The measurement unit of the specified position.