Struct

OfficeLength

OfficeIMO

Edit on GitHub

Namespace: OfficeIMO
Assembly: OfficeIMO.Core
Source revision: e163ccb36643 with working tree changes
Source: OfficeLength.cs:18
Base: ValueType
Implements: IEquatable<OfficeLength> IComparable<OfficeLength> IComparable IFormattable
Modifiers: sealed

A signed document length stored as whole English Metric Units (EMUs).

Inheritance

ValueType
OfficeLength

Remarks

Fractional EMUs round to nearest, with midpoint ties away from zero. Arithmetic is checked.

Usage

Explore 153 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 57

Property OfficeContentSafetyOptions.MaximumTinyFontSize
Property OfficeChartPointStyle.OutlineWidth
Property OfficeChartSnapshot.Height
Property OfficeChartSnapshot.Width
Property OfficeChartTrendline.Width
Property OfficeDiagramSnapshot.Height
Property OfficeDiagramSnapshot.Width
Property OfficePageSize.Height
Property OfficePageSize.Width
Property OfficeTextTabLeaderStyle.FontSize
Property OfficeTextTabLineLeader.Width
Property OfficeChartOptions.Height
Property OfficeChartOptions.Width
Method OfficeLength.Centimeters
Method OfficeLength.Emus
Method OfficeLength.Inches
Method OfficeLength.Millimeters
Method OfficeLength.op_Addition
Method OfficeLength.op_Multiply
Method OfficeLength.op_Subtraction
Method OfficeLength.Parse
Method OfficeLength.Pixels
Method OfficeLength.Points
Property OfficeLength.Zero
Property OfficeSeries.MarkerOutlineWidth
Property OfficeSeries.MarkerSize
Property OfficeSeries.StrokeWidth
Property OfficeThemeChartStyle.AxisFontSize
Property OfficeThemeChartStyle.GridlineWidth
Property OfficeThemeChartStyle.LineWidth
Property OfficeThemeChartStyle.TitleFontSize
Property OfficeThemeFooter.FontSize
Property OfficeThemePage.MarginBottom
Property OfficeThemePage.MarginLeft
Property OfficeThemePage.MarginRight
Property OfficeThemePage.MarginTop
Property OfficeThemeParagraphSpacing.After
Property OfficeThemeParagraphSpacing.Before
Property OfficeThemeRule.Width
Property OfficeThemeSpacing.ListIndent
Property OfficeThemeSpacing.ParagraphAfter
Property OfficeThemeSpacing.ParagraphBefore
Property OfficeThemeSpacing.SlideMarginBottom
Property OfficeThemeSpacing.SlideMarginLeft
Property OfficeThemeSpacing.SlideMarginRight
Property OfficeThemeSpacing.SlideMarginTop
Property OfficeThemeTableStyle.BorderWidth
Property OfficeThemeTableStyle.CellPadding
Property OfficeThemeTypeScale.Body
Property OfficeThemeTypeScale.Caption
Property OfficeThemeTypeScale.Heading1
Property OfficeThemeTypeScale.Heading2
Property OfficeThemeTypeScale.Heading3
Property OfficeThemeTypeScale.Heading4
Property OfficeThemeTypeScale.Heading5
Property OfficeThemeTypeScale.Heading6
Property OfficeThemeTypeScale.Title

Accepted by parameters 96

Constructor OfficeChartPointStyle.OfficeChartPointStyle parameter outlineWidth
Constructor OfficeChartSnapshot.OfficeChartSnapshot parameter height
Constructor OfficeChartSnapshot.OfficeChartSnapshot parameter width
Method OfficeChartSnapshot.WithSize parameter height
Method OfficeChartSnapshot.WithSize parameter width
Constructor OfficeChartTrendline.OfficeChartTrendline parameter width
Constructor OfficeDiagramSnapshot.OfficeDiagramSnapshot parameter height
Constructor OfficeDiagramSnapshot.OfficeDiagramSnapshot parameter width
Constructor OfficePageSize.OfficePageSize parameter height
Constructor OfficePageSize.OfficePageSize parameter width
Constructor OfficeTextTabLeaderStyle.OfficeTextTabLeaderStyle parameter fontSize
Constructor OfficeTextTabLineLeader.OfficeTextTabLineLeader parameter width
Method OfficeLength.CompareTo parameter other
Method OfficeLength.Equals parameter other
Method OfficeLength.op_Addition parameter left
Method OfficeLength.op_Addition parameter right
Method OfficeLength.op_Equality parameter left
Method OfficeLength.op_Equality parameter right
Method OfficeLength.op_GreaterThan parameter left
Method OfficeLength.op_GreaterThan parameter right
Method OfficeLength.op_GreaterThanOrEqual parameter left
Method OfficeLength.op_GreaterThanOrEqual parameter right
Method OfficeLength.op_Inequality parameter left
Method OfficeLength.op_Inequality parameter right
Method OfficeLength.op_LessThan parameter left
Method OfficeLength.op_LessThan parameter right
Method OfficeLength.op_LessThanOrEqual parameter left
Method OfficeLength.op_LessThanOrEqual parameter right
Method OfficeLength.op_Multiply parameter length
Method OfficeLength.op_Subtraction parameter left
Method OfficeLength.op_Subtraction parameter right
Method OfficeLength.TryParse parameter result
Constructor OfficeSeries.OfficeSeries parameter markerOutlineWidth
Constructor OfficeSeries.OfficeSeries parameter markerSize
Constructor OfficeSeries.OfficeSeries parameter strokeWidth
Method OfficeSeries.CreateBubble parameter markerOutlineWidth
Constructor OfficeThemeChartStyle.OfficeThemeChartStyle parameter axisFontSize
Constructor OfficeThemeChartStyle.OfficeThemeChartStyle parameter gridlineWidth
Constructor OfficeThemeChartStyle.OfficeThemeChartStyle parameter lineWidth
Constructor OfficeThemeChartStyle.OfficeThemeChartStyle parameter titleFontSize
Method OfficeThemeChartStyle.With parameter axisFontSize
Method OfficeThemeChartStyle.With parameter gridlineWidth
Method OfficeThemeChartStyle.With parameter lineWidth
Method OfficeThemeChartStyle.With parameter titleFontSize
Constructor OfficeThemeFooter.OfficeThemeFooter parameter fontSize
Method OfficeThemeFooter.With parameter fontSize
Constructor OfficeThemePage.OfficeThemePage parameter marginBottom
Constructor OfficeThemePage.OfficeThemePage parameter marginLeft
Constructor OfficeThemePage.OfficeThemePage parameter marginRight
Constructor OfficeThemePage.OfficeThemePage parameter marginTop
Method OfficeThemePage.With parameter marginBottom
Method OfficeThemePage.With parameter marginLeft
Method OfficeThemePage.With parameter marginRight
Method OfficeThemePage.With parameter marginTop
Constructor OfficeThemeParagraphSpacing.OfficeThemeParagraphSpacing parameter after
Constructor OfficeThemeParagraphSpacing.OfficeThemeParagraphSpacing parameter before
Method OfficeThemeParagraphSpacing.With parameter after
Method OfficeThemeParagraphSpacing.With parameter before
Constructor OfficeThemeRule.OfficeThemeRule parameter width
Method OfficeThemeRule.With parameter width
Constructor OfficeThemeSpacing.OfficeThemeSpacing parameter listIndent
Constructor OfficeThemeSpacing.OfficeThemeSpacing parameter paragraphAfter
Constructor OfficeThemeSpacing.OfficeThemeSpacing parameter paragraphBefore
Constructor OfficeThemeSpacing.OfficeThemeSpacing parameter slideMarginBottom
Constructor OfficeThemeSpacing.OfficeThemeSpacing parameter slideMarginLeft
Constructor OfficeThemeSpacing.OfficeThemeSpacing parameter slideMarginRight
Constructor OfficeThemeSpacing.OfficeThemeSpacing parameter slideMarginTop
Method OfficeThemeSpacing.With parameter listIndent
Method OfficeThemeSpacing.With parameter paragraphAfter
Method OfficeThemeSpacing.With parameter paragraphBefore
Method OfficeThemeSpacing.With parameter slideMarginBottom
Method OfficeThemeSpacing.With parameter slideMarginLeft
Method OfficeThemeSpacing.With parameter slideMarginRight
Method OfficeThemeSpacing.With parameter slideMarginTop
Constructor OfficeThemeTableStyle.OfficeThemeTableStyle parameter borderWidth
Constructor OfficeThemeTableStyle.OfficeThemeTableStyle parameter cellPadding
Method OfficeThemeTableStyle.With parameter borderWidth
Method OfficeThemeTableStyle.With parameter cellPadding
Constructor OfficeThemeTypeScale.OfficeThemeTypeScale parameter body
Constructor OfficeThemeTypeScale.OfficeThemeTypeScale parameter caption
Constructor OfficeThemeTypeScale.OfficeThemeTypeScale parameter heading1
Constructor OfficeThemeTypeScale.OfficeThemeTypeScale parameter heading2
Constructor OfficeThemeTypeScale.OfficeThemeTypeScale parameter heading3
Constructor OfficeThemeTypeScale.OfficeThemeTypeScale parameter heading4
Constructor OfficeThemeTypeScale.OfficeThemeTypeScale parameter heading5
Constructor OfficeThemeTypeScale.OfficeThemeTypeScale parameter heading6
Constructor OfficeThemeTypeScale.OfficeThemeTypeScale parameter title
Method OfficeThemeTypeScale.With parameter body
Method OfficeThemeTypeScale.With parameter caption
Method OfficeThemeTypeScale.With parameter heading1
Method OfficeThemeTypeScale.With parameter heading2
Method OfficeThemeTypeScale.With parameter heading3
Method OfficeThemeTypeScale.With parameter heading4
Method OfficeThemeTypeScale.With parameter heading5
Method OfficeThemeTypeScale.With parameter heading6
Method OfficeThemeTypeScale.With parameter title

Methods

public static OfficeLength Centimeters(double value) #

OfficeLength.cs:22

Creates a length in centimeters (360,000 EMUs per centimeter).

Parameters

value double required

Returns

OfficeLength

CompareTo 2 overloads

public int CompareTo(OfficeLength other) #

OfficeLength.cs:94

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

Parameters

other OfficeIMO.OfficeLength required: An object to compare with this instance.

Returns

int A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes in the sort order. Zero This instance occurs in the same position in the sort order as . Greater than zero This instance follows in the sort order.

public int CompareTo(object? obj) #

OfficeLength.cs:96

Parameters

obj object? required: An object to compare with this instance.

Returns

Exceptions

ArgumentException – obj is not the same type as this instance.

public static OfficeLength Emus(long value) #

OfficeLength.cs:18

Creates a length from whole EMUs.

Parameters

value long required

Returns

OfficeLength

Equals 2 overloads

public bool Equals(OfficeLength other) #

OfficeLength.cs:88

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

Parameters

other OfficeIMO.OfficeLength required: An object to compare with this object.

Returns

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

public override bool Equals(object? obj) #

OfficeLength.cs:90

Indicates whether this instance and a specified object are equal.

Parameters

obj object? required: The object to compare with the current instance.

Returns

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

public override int GetHashCode() #

OfficeLength.cs:92

Returns the hash code for this instance.

Returns

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

public static OfficeLength Inches(double value) #

OfficeLength.cs:26

Creates a length in inches (914,400 EMUs per inch).

Parameters

value double required

Returns

OfficeLength

public static OfficeLength Millimeters(double value) #

OfficeLength.cs:24

Creates a length in millimeters (36,000 EMUs per millimeter).

Parameters

value double required

Returns

OfficeLength

public static OfficeLength op_Addition(OfficeLength left, OfficeLength right) #

OfficeLength.cs:98

Adds lengths, throwing on overflow.

Parameters

left OfficeIMO.OfficeLength required
right OfficeIMO.OfficeLength required

Returns

OfficeLength

public static bool op_Equality(OfficeLength left, OfficeLength right) #

OfficeLength.cs:106

Compares lengths for equality.

Parameters

left OfficeIMO.OfficeLength required
right OfficeIMO.OfficeLength required

Returns

bool

public static bool op_GreaterThan(OfficeLength left, OfficeLength right) #

OfficeLength.cs:112

Compares signed lengths.

Parameters

left OfficeIMO.OfficeLength required
right OfficeIMO.OfficeLength required

Returns

bool

public static bool op_GreaterThanOrEqual(OfficeLength left, OfficeLength right) #

OfficeLength.cs:116

Compares signed lengths.

Parameters

left OfficeIMO.OfficeLength required
right OfficeIMO.OfficeLength required

Returns

bool

public static bool op_Inequality(OfficeLength left, OfficeLength right) #

OfficeLength.cs:108

Compares lengths for inequality.

Parameters

left OfficeIMO.OfficeLength required
right OfficeIMO.OfficeLength required

Returns

bool

public static bool op_LessThan(OfficeLength left, OfficeLength right) #

OfficeLength.cs:110

Compares signed lengths.

Parameters

left OfficeIMO.OfficeLength required
right OfficeIMO.OfficeLength required

Returns

bool

public static bool op_LessThanOrEqual(OfficeLength left, OfficeLength right) #

OfficeLength.cs:114

Compares signed lengths.

Parameters

left OfficeIMO.OfficeLength required
right OfficeIMO.OfficeLength required

Returns

bool

op_Multiply 2 overloads

public static OfficeLength op_Multiply(OfficeLength length, double scalar) #

OfficeLength.cs:102

Multiplies a length by a finite scalar and rounds to whole EMUs.

Parameters

length OfficeIMO.OfficeLength required
scalar double required

Returns

OfficeLength

public static OfficeLength op_Multiply(double scalar, OfficeLength length) #

OfficeLength.cs:104

Multiplies a length by a finite scalar and rounds to whole EMUs.

Parameters

scalar double required
length OfficeIMO.OfficeLength required

Returns

OfficeLength

public static OfficeLength op_Subtraction(OfficeLength left, OfficeLength right) #

OfficeLength.cs:100

Subtracts lengths, throwing on overflow.

Parameters

left OfficeIMO.OfficeLength required
right OfficeIMO.OfficeLength required

Returns

OfficeLength

public static OfficeLength Parse(string value) #

OfficeLength.cs:48

Parses an invariant number and optional pt, cm, mm, in, px or emu suffix. A bare number means points.

Parameters

value string required

Returns

OfficeLength

public static OfficeLength Pixels(double value) #

OfficeLength.cs:28

Creates a length in pixels at 96 DPI (9,525 EMUs per pixel).

Parameters

value double required

Returns

OfficeLength

public static OfficeLength Points(double value) #

OfficeLength.cs:20

Creates a length in points (12,700 EMUs per point).

Parameters

value double required

Returns

OfficeLength

public double ToCentimeters() #

OfficeLength.cs:34

Returns the length in centimeters.

Returns

double

public long ToEmus() #

OfficeLength.cs:30

Returns the whole EMU value.

Returns

long

public long ToHalfPoints() #

OfficeLength.cs:44

Rounds to whole half-points at write time; midpoint ties round away from zero.

Returns

long

public double ToInches() #

OfficeLength.cs:38

Returns the length in inches.

Returns

double

public double ToMillimeters() #

OfficeLength.cs:36

Returns the length in millimeters.

Returns

double

public double ToPixels() #

OfficeLength.cs:40

Returns the length in 96-DPI pixels.

Returns

double

public double ToPoints() #

OfficeLength.cs:32

Returns the length in points.

Returns

double

ToString 3 overloads

public override string ToString() #

OfficeLength.cs:66

Formats in invariant points with up to four decimal places and no trailing zeros.

Returns

string

public string ToString(string? format) #

OfficeLength.cs:69

Formats in the requested unit, using points when the format is empty or G.

Parameters

format string? required

Returns

string

public string ToString(string? format, IFormatProvider? formatProvider) #

OfficeLength.cs:77

Formats using pt, cm, mm, in, px or emu. An empty format or G means points.

Parameters

format string? required
formatProvider System.IFormatProvider? required

Returns

string

public long ToTwips() #

OfficeLength.cs:42

Rounds to whole twips at write time; midpoint ties round away from zero.

Returns

long

public static bool TryParse(string? value, out OfficeLength result) #

OfficeLength.cs:55

Tries to parse an invariant length. Commas, nonfinite values and overflowing lengths are rejected.

Parameters

value string? required
result OfficeIMO.OfficeLength required

Returns

bool

Inherited Methods

Properties

public static OfficeLength Zero { get; } #

OfficeLength.cs:16

Gets a zero length.