API Reference

Struct

OfficeFontInfo

Edit on GitHub

Namespace OfficeIMO.Drawing

Assembly OfficeIMO.Core

Source ../../../../_/OfficeIMO.Core/OfficeFontInfo.cs:14

Base ValueType

Implements

IEquatable<OfficeFontInfo>

Modifiers sealed

Small immutable font descriptor used by OfficeIMO packages without taking a dependency on a font engine.

Inheritance

ValueType
OfficeFontInfo

Usage

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

Returned or exposed by

Property OfficeDrawingText.Font
Method OfficeFontInfo.WithFamilyName
Method OfficeFontInfo.WithSize
Method OfficeFontInfo.WithStyle
Property OfficeFontInfo.Default
Property OfficeMathRenderOptions.Font
Property OfficeTextMeasurementStyle.FontInfo
Property OfficeTextMeasurer.FallbackFontInfo

Accepted by parameters

Method OfficeDrawing.AddClippedPositionedText parameter font
Method OfficeDrawing.AddClippedPositionedText parameter font
Method OfficeDrawing.AddClippedText parameter font
Method OfficeDrawing.AddPositionedText parameter font
Method OfficeDrawing.AddPositionedText parameter font
Method OfficeDrawing.AddPositionedText parameter font
Method OfficeDrawing.AddPositionedText parameter font
Method OfficeDrawing.AddPositionedText parameter font
Method OfficeDrawing.AddStyledText parameter font
Method OfficeDrawing.AddStyledText parameter font
Method OfficeDrawing.AddText parameter font
Method OfficeDrawing.AddText parameter font
Method OfficeDrawing.AddTextBehindContent parameter font
Method OfficeDrawing.AddVerticalText parameter font
Constructor OfficeDrawingText.OfficeDrawingText parameter font
Constructor OfficeDrawingText.OfficeDrawingText parameter font
Constructor OfficeDrawingText.OfficeDrawingText parameter font
Method OfficeFontInfo.Equals parameter other
Method OfficeFontInfo.op_Equality parameter left
Method OfficeFontInfo.op_Equality parameter right
Method OfficeFontInfo.op_Inequality parameter left
Method OfficeFontInfo.op_Inequality parameter right
Method OfficeTextMeasurer.Create parameter fallbackFontInfo
Method OfficeTextMeasurer.CreateStyle parameter fontInfo
Method OfficeTextMeasurer.CreateStyle parameter fontInfo

Constructors

public OfficeFontInfo(String familyName, Double size = 11, OfficeFontStyle style = Regular) #

../../../../_/OfficeIMO.Core/OfficeFontInfo.cs:14

Creates a font descriptor.

Parameters

familyName System.String requiredposition: 0
size System.Double = 11 optionalposition: 1
style OfficeIMO.Drawing.OfficeFontStyle = Regular optionalposition: 2

Methods

Equals 2 overloads

public virtual Boolean Equals(OfficeFontInfo other) #

../../../../_/OfficeIMO.Core/OfficeFontInfo.cs:54

Returns: Boolean

Parameters

other OfficeIMO.Drawing.OfficeFontInfo requiredposition: 0

public override Boolean Equals(Object obj) #

../../../../_/OfficeIMO.Core/OfficeFontInfo.cs:59

Returns: Boolean

Parameters

obj System.Object requiredposition: 0

public override Int32 GetHashCode() #

../../../../_/OfficeIMO.Core/OfficeFontInfo.cs:64

Returns: Int32

public static Boolean op_Equality(OfficeFontInfo left, OfficeFontInfo right) #

../../../../_/OfficeIMO.Core/OfficeFontInfo.cs:80

Returns: Boolean

Equality operator.

Parameters

left OfficeIMO.Drawing.OfficeFontInfo requiredposition: 0
right OfficeIMO.Drawing.OfficeFontInfo requiredposition: 1

public static Boolean op_Inequality(OfficeFontInfo left, OfficeFontInfo right) #

../../../../_/OfficeIMO.Core/OfficeFontInfo.cs:83

Returns: Boolean

Inequality operator.

Parameters

left OfficeIMO.Drawing.OfficeFontInfo requiredposition: 0
right OfficeIMO.Drawing.OfficeFontInfo requiredposition: 1

public override String ToString() #

../../../../_/OfficeIMO.Core/OfficeFontInfo.cs:74

Returns: String

public OfficeFontInfo WithFamilyName(String familyName) #

../../../../_/OfficeIMO.Core/OfficeFontInfo.cs:44

Returns: OfficeFontInfo

Creates a copy with a different family name.

Parameters

familyName System.String requiredposition: 0

public OfficeFontInfo WithSize(Double size) #

../../../../_/OfficeIMO.Core/OfficeFontInfo.cs:47

Returns: OfficeFontInfo

Creates a copy with a different point size.

Parameters

size System.Double requiredposition: 0

public OfficeFontInfo WithStyle(OfficeFontStyle style) #

../../../../_/OfficeIMO.Core/OfficeFontInfo.cs:50

Returns: OfficeFontInfo

Creates a copy with different style flags.

Parameters

style OfficeIMO.Drawing.OfficeFontStyle requiredposition: 0

Inherited Methods

Properties

public String FamilyName { get; } #

../../../../_/OfficeIMO.Core/OfficeFontInfo.cs:20

Font family name, when known.

public Double Size { get; } #

../../../../_/OfficeIMO.Core/OfficeFontInfo.cs:23

Font size in points.

public OfficeFontStyle Style { get; } #

../../../../_/OfficeIMO.Core/OfficeFontInfo.cs:26

Font style flags.

public Boolean IsBold { get; } #

../../../../_/OfficeIMO.Core/OfficeFontInfo.cs:29

Whether the descriptor includes bold styling.

public Boolean IsItalic { get; } #

../../../../_/OfficeIMO.Core/OfficeFontInfo.cs:32

Whether the descriptor includes italic styling.

public Boolean IsUnderline { get; } #

../../../../_/OfficeIMO.Core/OfficeFontInfo.cs:35

Whether the descriptor includes underline styling.

public Boolean IsStrikethrough { get; } #

../../../../_/OfficeIMO.Core/OfficeFontInfo.cs:38

Whether the descriptor includes strikethrough styling.

public static OfficeFontInfo Default { get; } #

../../../../_/OfficeIMO.Core/OfficeFontInfo.cs:41

Default Office font descriptor.