Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 606 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Struct

OdfLength

Edit on GitHub
Namespace OfficeIMO.OpenDocument
Assembly OfficeIMO.OpenDocument
Source revision 804a7612eee4 with working tree changes
Source OdfLength.cs:13
Base ValueType
Implements
IEquatable<OdfLength>
Modifiers sealed

Preserves an ODF length's invariant lexical representation.

Inheritance

  • ValueType
  • OdfLength

Guides & Samples

Authored walkthroughs and practical samples linked to this API.

  • Editable OpenDocument proposal Sample

    Create an ODT service proposal with styled text, acceptance conditions, assumptions and a PDF review copy. Includes the ODT and runnable C# source.

  • Workshop agenda in ODT and flat XML Sample

    Save one structured workshop agenda as editable ODT, inspectable FODT and a PDF review copy. Download all three formats and the generating C# source.

  • Client appointment letter Sample

    Create an editable ODT client letter with a dated appointment, preparation notes, follow-up commitment and clear typography. Export a PDF copy.

Usage

Explore 173 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 145

Accepted by parameters 28

Methods

public static OdfLength Centimeters(Double value) #
OdfLength.cs:18
Returns: OdfLength

Creates a centimeter length.

Parameters

value System.Double requiredposition: 0
Equals 2 overloads
public Boolean Equals(OdfLength other) #
OdfLength.cs:67
Returns: Boolean

Indicates whether the current object is equal to another object of the same type.

Parameters

other OfficeIMO.OpenDocument.OdfLength requiredposition: 0
An object to compare with this object.

Returns

true if the current object is equal to the other parameter; otherwise, false.

public override Boolean Equals(Object? obj) #
OdfLength.cs:69
Returns: Boolean

Indicates whether this instance and a specified object are equal.

Parameters

obj System.Object? requiredposition: 0
The object to compare with the current instance.

Returns

true if obj and this instance are the same type and represent the same value; otherwise, false.

public override Int32 GetHashCode() #
OdfLength.cs:71
Returns: Int32

Returns the hash code for this instance.

Returns

A 32-bit signed integer that is the hash code for this instance.

public static OdfLength Inches(Double value) #
OdfLength.cs:20
Returns: OdfLength

Creates an inch length.

Parameters

value System.Double requiredposition: 0
public static OdfLength Parse(String value) #
OdfLength.cs:13
Returns: OdfLength

Creates a length from an ODF lexical value such as `2.54cm` or `12pt`.

Parameters

value System.String requiredposition: 0
public static OdfLength Points(Double value) #
OdfLength.cs:22
Returns: OdfLength

Creates a point length.

Parameters

value System.Double requiredposition: 0
public Double ToCentimeters() #
OdfLength.cs:62
Returns: Double

Converts this absolute ODF length to centimeters.

public Double ToPoints() #
OdfLength.cs:26
Returns: Double

Converts this absolute ODF length to points.

public override String ToString() #
OdfLength.cs:65
Returns: String

Returns the fully qualified type name of this instance.

Returns

The fully qualified type name.

public Boolean TryToPoints(out Double points) #
OdfLength.cs:42
Returns: Boolean

Attempts to convert an absolute ODF length to points without throwing for relative or unsupported units.

Parameters

points System.Double requiredposition: 0