Class Effect3D
Represents a 3D effect applied to an object or text in a Word document.
Inheritance
Namespace: IronWord.Models
Assembly: IronWord.dll
Syntax
public class Effect3D : ObjectConstructors
Effect3D()
Create a 3D effect instance.
Declaration
public Effect3D()Fields
DefaultEffect
Create a predefined 3D effect instance.
Declaration
public static Effect3D DefaultEffectField Value
| Type | Description |
|---|---|
| Effect3D |
Properties
BevelBottom
Gets or sets the bevel effect applied to the bottom of the object or text.
Declaration
public Bevel BevelBottom { get; set; }Property Value
| Type | Description |
|---|---|
| Bevel |
BevelTop
Gets or sets the bevel effect applied to the top of the object or text.
Declaration
public Bevel BevelTop { get; set; }Property Value
| Type | Description |
|---|---|
| Bevel |
ContourColor
Gets or sets the color of the contour effect.
Declaration
public Color ContourColor { get; set; }Property Value
| Type | Description |
|---|---|
| Color |
ContourWidth
Gets or sets the width of the contour effect.
Declaration
public double ContourWidth { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double |
Remarks
The width is specified in points (1/72 inch).
ExtrusionColor
Gets or sets the color of the extrusion effect.
Declaration
public Color ExtrusionColor { get; set; }Property Value
| Type | Description |
|---|---|
| Color |
ExtrusionHeight
Gets or sets the height of the extrusion effect.
Declaration
public double ExtrusionHeight { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double |
Remarks
The height is specified in points (1/72 inch).
PresetMaterialType
Gets or sets the preset material type for the 3D effect.
Declaration
public PresetMaterialTypeValues PresetMaterialType { get; set; }Property Value
| Type | Description |
|---|---|
| PresetMaterialTypeValues |
Methods
GetContourWidth(MeasurementUnit)
Gets the width of the contour effect in the specified measurement unit.
Declaration
public double GetContourWidth(MeasurementUnit measurementUnit)Parameters
| Type | Name | Description |
|---|---|---|
| MeasurementUnit | measurementUnit | The measurement unit to convert the width to. |
Returns
| Type | Description |
|---|---|
| System.Double | The width of the contour effect. |
GetExtrusionHeight(MeasurementUnit)
Gets the height of the extrusion effect in the specified measurement unit.
Declaration
public double GetExtrusionHeight(MeasurementUnit measurementUnit)Parameters
| Type | Name | Description |
|---|---|---|
| MeasurementUnit | measurementUnit | The measurement unit to convert the height to. |
Returns
| Type | Description |
|---|---|
| System.Double | The height of the extrusion effect. |
SetContourWidth(Double, MeasurementUnit)
Sets the width of the contour effect to the specified value in the specified measurement unit.
Declaration
public void SetContourWidth(double contourWidth, MeasurementUnit measurementUnit)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | contourWidth | The width of the contour effect. |
| MeasurementUnit | measurementUnit | The measurement unit of the specified width. |
SetExtrusionHeight(Double, MeasurementUnit)
Sets the height of the extrusion effect to the specified value in the specified measurement unit.
Declaration
public void SetExtrusionHeight(double height, MeasurementUnit measurementUnit)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | height | The height of the extrusion effect. |
| MeasurementUnit | measurementUnit | The measurement unit of the specified height. |