Class Length
Represents a value with a specific measurement unit.
Inheritance
Namespace: IronPdf.Editing
Assembly: IronPdf.dll
Syntax
public class Length : Object
PDF editing in IronPDF is handled through Length. It represents a value with a specific measurement unit.
Length matters when an application needs to configure or invoke PDF editing from C# code. The class encapsulates the related options and behavior in a single object that is set up once and reused across render or processing calls. Typical scenarios include batch generation pipelines, templated document workflows, and integration with existing C# document services.
To use Length, instantiate or obtain it from the relevant entry point in the IronPDF C# API. Key properties include DPI, Unit, Value. Assign options or invoke methods on the instance to configure or perform the operation.
using IronPdf;
// Obtain Length from the relevant entry point in the IronPDF API
void Configure(Length instance)
{
var current = instance.DPI;
instance.ToCentimeter();
}For the broader workflow, see the IronPDF C# documentation for related how-to guides and examples. For broader context, the PDF editing portion of the IronPDF C# API contains related types that work with Length directly. Length exposes additional members beyond those highlighted above; the reference tables on this page list the full set. In application code, treat Length as a configured object that is constructed once and reused across operations rather than instantiated per call. Configuration is generally idempotent: assigning the same property value twice has the same effect as assigning it once. For diagnostic purposes, inspect the relevant Length property after each operation to confirm the configured state. See the constructors, properties, and methods tables below for the complete API surface of Length. Application code typically obtains or instantiates a single Length and shares it across multiple IronPDF operations rather than recreating it per call. For multi-threaded scenarios, follow the threading guidance for the relevant IronPDF entry point; Length instances are not assumed to be thread-safe unless documented.
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 |
| 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. |