API Reference

Class

LegacyXlsFont

Namespace OfficeIMO.Excel.LegacyXls.Model
Assembly OfficeIMO.Excel
Modifiers sealed

Represents a parsed legacy XLS Font record.

Inheritance

  • Object
  • LegacyXlsFont

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

Constructors

public LegacyXlsFont(UInt16 fontIndex, String name, Nullable<Double> size, UInt16 colorIndex, Boolean bold, Boolean italic, Boolean underline, Boolean strikeout, Byte underlineStyle = 0, LegacyXlsFontEscapement escapement = None, Byte family = 0, Byte characterSet = 1, Boolean outline = false, Boolean shadow = false, Boolean condense = false, Boolean extend = false) #

Creates a parsed legacy XLS font.

Parameters

fontIndex System.UInt16 requiredposition: 0
Zero-based position in the Font record collection.
name System.String requiredposition: 1
Font family name.
size System.Nullable{System.Double} requiredposition: 2
Font size in points, when present.
colorIndex System.UInt16 requiredposition: 3
Legacy IcvFont color index.
bold System.Boolean requiredposition: 4
Whether the font weight is bold.
italic System.Boolean requiredposition: 5
Whether the font is italic.
underline System.Boolean requiredposition: 6
Whether the font uses an underline style.
strikeout System.Boolean requiredposition: 7
Whether the font uses strikethrough.
underlineStyle System.Byte = 0 optionalposition: 8
BIFF underline style byte.
escapement OfficeIMO.Excel.LegacyXls.Model.LegacyXlsFontEscapement = None optionalposition: 9
Legacy superscript or subscript positioning.
family System.Byte = 0 optionalposition: 10
BIFF font family classification byte.
characterSet System.Byte = 1 optionalposition: 11
BIFF font character set byte.
outline System.Boolean = false optionalposition: 12
Whether the font uses the BIFF outline flag.
shadow System.Boolean = false optionalposition: 13
Whether the font uses the BIFF shadow flag.
condense System.Boolean = false optionalposition: 14
Whether the font uses the BIFF condense flag.
extend System.Boolean = false optionalposition: 15
Whether the font uses the BIFF extend flag.

Properties

public UInt16 FontIndex { get; } #

Gets the zero-based position in the Font record collection.

public String Name { get; } #

Gets the font family name.

public Nullable<Double> Size { get; } #

Gets the font size in points.

public UInt16 ColorIndex { get; } #

Gets the legacy IcvFont color index.

public Boolean Bold { get; } #

Gets whether the font weight is bold.

public Boolean Italic { get; } #

Gets whether the font is italic.

public Boolean Underline { get; } #

Gets whether the font uses an underline style.

public Byte UnderlineStyle { get; } #

Gets the BIFF underline style byte.

public Boolean Strikeout { get; } #

Gets whether the font uses strikethrough.

public LegacyXlsFontEscapement Escapement { get; } #

Gets superscript or subscript positioning for the font.

public Byte Family { get; } #

Gets the BIFF font family classification byte.

public Byte CharacterSet { get; } #

Gets the BIFF font character set byte.

public Boolean Outline { get; } #

Gets whether the font uses the BIFF outline flag.

public Boolean Shadow { get; } #

Gets whether the font uses the BIFF shadow flag.

public Boolean Condense { get; } #

Gets whether the font uses the BIFF condense flag.

public Boolean Extend { get; } #

Gets whether the font uses the BIFF extend flag.