 | Length Structure |
Struct that represents a measurable length.
Provides conversion between units, parsing of string representations, and basic mathematical operations.
The unit used in PDF documents is pt(Double) which is also used internally by the Length object to store length values. For that reason, when converting units from and to the internally used unit, minor numerical differences can occur due to floating-point arithmetic.
Inheritance HierarchySystemObject
SystemValueType
PdfTools.Geometry.UnitsLength
SystemValueType
PdfTools.Geometry.UnitsLength
Namespace: PdfTools.Geometry.Units
Assembly: PdfTools (in PdfTools.dll) Version: 1.0.0
SyntaxC#
public struct Length
The Length type exposes the following members.
Properties
Methods| Name | Description | |
|---|---|---|
  | Abs | |
| cm | Get the numerical length value in centimetres (symbol cm, equal to 0.01m). |
| cm(Double) | Create a Length object with the unit centimetre (symbol cm, equal to 0.01m). |
| Equals | (Overrides ValueTypeEquals(Object)) |
| GetHashCode | (Overrides ValueTypeGetHashCode) |
| in | Get the numerical length value in inches (symbol in, equal to 25.4mm or 72pt). |
| in(Double) | Create a Length object with the unit inch (symbol in, equal to 25.4mm or 72pt). |
| km | Get the numerical length value in kilometres (symbol km, equal to 1000m). |
| km(Double) | Create a Length object with the unit kilometre (symbol km, equal to 1000m). |
| m | Get the numerical length value in metres (symbol m, is the SI unit of length). |
| m(Double) | Create a Length object with the unit metre (symbol m, is the SI unit of length). |
| Max | |
| Min | |
| mm | Get the numerical length value in millimetres (symbol mm, equal to 0.001m). |
| mm(Double) | Create a Length object with the unit millimetre (symbol mm, equal to 0.001m). |
| Parse | Creates a Length object by parsing a string representation of a length with its unit. |
| ParseArray(String) | Creates an array of Length by parsing a string representation of lengths with units. |
| ParseArray(String, Int32) | Creates an array of Length by parsing a string representation of lengths with units. |
| ParseUnit | Creates a Length object. |
| pt | Get the numerical length value in points (symbol pt, is the default unit used in PDF documents, equal to 1/72in or 25.4/72mm). |
| pt(Double) | Create a Length object with the unit point (symbol pt, is the default unit used in PDF documents, equal to 1/72in or 25.4/72mm). |
| ToString |
Creates a string representation with an associated suitable metric unit "m", "cm" or "mm".
(Overrides ValueTypeToString) |
| um | Get the numerical length value in micrometres (symbol um, equal to 0.000001m). |
| um(Double) | Create a Length object with the unit micrometre (symbol um, equal to 0.000001m). |
OperatorsTop
See Also