Class Length

Represents a value with a specific measurement unit.

Inheritance
System.Object
Length
Namespace: IronPdf.Editing
Assembly: IronPdf.dll
Syntax
public class Length : Object

Constructors

Length(Double, MeasurementUnit, Int32)

Initializes a new instance of the Length class with a specified value and measurement unit.

Declaration
public Length(double value = 0, MeasurementUnit unit, int dpi = 96)
Parameters
Type Name Description
System.Double value

The value of the length in the specified measurement unit. The default value is 0.
MeasurementUnit unit

The measurement unit of the length. The default value is MeasurementUnit.Percentage.
System.Int32 dpi

The DPI of the length. The default value is 96.

Properties

DPI

Gets or sets the DPI of this length.

Declaration
public int DPI { get; set; }
Property Value
Type Description
System.Int32

Unit

Gets or sets the measurement unit of this length.

Declaration
public MeasurementUnit Unit { get; set; }
Property Value
Type Description
MeasurementUnit

Value

Gets or sets the value of this length.

Declaration
public double Value { get; set; }
Property Value
Type Description
System.Double

Methods

ToCentimeter(Nullable<Double>)

Converts the Length value to centimeters.

Declaration
public double ToCentimeter(Nullable<double> refValue = null)
Parameters
Type Name Description
System.Nullable<System.Double> refValue

Reference value (cm). Required when Unit is Percentage
Returns
Type Description
System.Double

The converted value in centimeters.

ToInch(Nullable<Double>)

Converts the Length value to inches.

Declaration
public double ToInch(Nullable<double> refValue = null)
Parameters
Type Name Description
System.Nullable<System.Double> refValue

Reference value (inch). Required when Unit is Percentage
Returns
Type Description
System.Double

The converted value in inches.

ToMillimeter(Nullable<Double>)

Converts the Length value to millimeters.

Declaration
public double ToMillimeter(Nullable<double> refValue = null)
Parameters
Type Name Description
System.Nullable<System.Double> refValue

Reference value (mm). Required when Unit is Percentage
Returns
Type Description
System.Double

The converted value in millimeters.

ToPixel(Nullable<Double>)

Converts the Length value to pixel.

Declaration
public double ToPixel(Nullable<double> refValue = null)
Parameters
Type Name Description
System.Nullable<System.Double> refValue

Reference value (pixel). Required when Unit is Percentage
Returns
Type Description
System.Double

The converted value in pixel.

ToPoints(Nullable<Double>)

Converts the Length value to points.

Declaration
public double ToPoints(Nullable<double> refValue = null)
Parameters
Type Name Description
System.Nullable<System.Double> refValue

Reference value (points). Required when Unit is Percentage
Returns
Type Description
System.Double

The converted value in points.