Class Shadow
Represents the shadow effect applied to text or objects in a Word document.
Inheritance
Namespace: IronWord.Models
Assembly: IronWord.dll
Syntax
public class Shadow : ObjectConstructors
Shadow()
Create a Shadow instance.
Declaration
public Shadow()Fields
OuterShadow1
Create a predefined outer shadow effect instance.
Declaration
public static Shadow OuterShadow1Field Value
| Type | Description |
|---|---|
| Shadow |
Properties
Alignment
Gets or sets the alignment of the shadow.
Declaration
public RectangleAlignmentValues Alignment { get; set; }Property Value
| Type | Description |
|---|---|
| RectangleAlignmentValues |
BlurRadius
Gets or sets the blur radius of the shadow 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 shadow 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 shadow 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).
HorizontalScalingFactor
Gets or sets the horizontal scaling factor of the shadow effect.
Declaration
public int HorizontalScalingFactor { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
HorizontalSkewAngle
Gets or sets the horizontal skew angle of the shadow 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 shadow effect.
Declaration
public Color SchemeColor { get; set; }Property Value
| Type | Description |
|---|---|
| Color |
VerticalScalingFactor
Gets or sets the vertical scaling factor of the shadow effect.
Declaration
public double VerticalScalingFactor { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double |
VerticalSkewAngle
Gets or sets the vertical skew angle of the shadow 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 shadow 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 shadow effect. |
GetDistanceFromText(MeasurementUnit)
Gets the distance of the shadow 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 shadow effect from the text or object. |
SetBlurRadius(Double, MeasurementUnit)
Sets the blur radius of the shadow 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 shadow effect. |
| MeasurementUnit | measurementUnit | The measurement unit of the specified blur radius. |
SetDistanceFromText(Double, MeasurementUnit)
Sets the distance of the shadow 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 shadow effect from the text or object. |
| MeasurementUnit | measurementUnit | The measurement unit of the specified distance. |