GrapeCity.Documents.Word

GrapeCity.Documents.Word.FontBase

Class FontBase

Namespace: GrapeCity.Documents.Word

Assembly: GcDocs.Word.dll

Contains font attributes (font name, font size, color, and so on) for an object.

public class FontBase : FormattingBag

Inheritance: object

FormattingBag

FontBase

: Font

Inherited Members: FormattingBag.KeyDelimiter

FormattingBag.KeyFormat

FormattingBag.FixInheritedValues()

FormattingBag.GetFormattingKey(string)

FormattingBag.GetShortKey(string)

FormattingBag.GetChildKeyPart(string)

FormattingBag.ConcateKeys(string, string)

FormattingBag.ConcateKeys(string[], string)

FormattingBag.ConcateKeys(string, string[])

FormattingBag.GetFormatting<T>(string, T)

FormattingBag.GetFormatting<T>(string, T, out int, bool)

FormattingBag.GetPropertyFormatting<T>(T, string)

FormattingBag.SetFormatting(string, object, bool)

FormattingBag.UpdateVersion(int?)

FormattingBag.SetPropertyFormatting(object, string)

FormattingBag.SetFormatting<T>(string, object, T, bool)

FormattingBag.SetPropertyFormattingEx<T>(object, T, string)

FormattingBag.GetDirectFormatting<T>(string, T)

FormattingBag.TryGetDirectFormatting<T>(string, T, out T, bool)

FormattingBag.GetDirectPropertyFormatting<T>(T, string)

FormattingBag.SetDirectPropertyFormatting(object, string)

FormattingBag.SetDirectPropertyFormattingEx<T>(object, T, string)

FormattingBag.RemoveDirectFormatting(string)

FormattingBag.HasDirectFormatting(string)

FormattingBag.HasDirectPropertyFormatting(string)

FormattingBag.HasDirectFormatting(string, string)

FormattingBag.HasDirectFormattingWithIgnore(string, string)

FormattingBag.HasDirectFormattingWithIgnore(string, string, string)

FormattingBag.ParentKey

FormattingBag.RootKey

FormattingBag.SyncBaseKeys

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

AllCaps

Gets or sets a value indicating whether the font is formatted as all capital letters.

public bool AllCaps { get; set; }

Property Value

bool

AlwaysHidden

Gets or sets a value indicating whether the given run shall always behave as if it is hidden, even when hidden text is being displayed in the current document.

public bool AlwaysHidden { get; set; }

Property Value

bool

Remarks

This property shall only be used to specify that a paragraph mark shall never be used to break the end of a paragraph for display, even if it is being shown on the document, as would be the case if a regularly hidden paragraph was not being displayed in the document. This property was typically used to ensure that a paragraph style can be applied to a part of a paragraph, and still appear as in the Table of Contents (which in previous word processors would ignore the use of the style if it were being used as a character style. If this font property is applied to any other run, it can be ignored.

Animation

Gets or sets the font animation effect.

public TextAnimation Animation { get; set; }

Property Value

TextAnimation

BaseKey

Gets the base (this class) key for formatting properties.

protected override string BaseKey { get; }

Property Value

string

Bidi

Gets or sets a value indicating whether the contents shall be treated as complex script text regardless of their Unicode character values when determining the formatting. This means that a consumer shall use the complex script formatting (e.g. BoldBi, ItalicBi...) applied by this font when determining the resulting formatting properties.

public bool Bidi { get; set; }

Property Value

bool

Bold

Gets or sets a value indicating whether the font is formatted as bold.

public bool Bold { get; set; }

Property Value

bool

BoldBi

Gets or sets whether the bold property shall be applied to all complex script characters in the contents when displayed in a document.

public bool BoldBi { get; set; }

Property Value

bool

Border

Gets the Border object that specifies borders for the font.

public Border Border { get; }

Property Value

Border

Color

Gets the color of the font.

public WordColor Color { get; }

Property Value

WordColor

DisableCharacterSpaceGrid

Gets or sets a value indicating whether the current run should use the document grid characters per line settings defined in the Document.Grid property when laying out the contents in this run. This setting determines whether the additional character pitch specified in the document grid shall be added to each character in this run as specified by the document grid.

public bool DisableCharacterSpaceGrid { get; set; }

Property Value

bool

DoubleStrikeThrough

Gets or sets a value indicating whether the font is formatted as double strikethrough text.

public bool DoubleStrikeThrough { get; set; }

Property Value

bool

EastAsianLayout

Gets East Asian typography settings which shall be applied to the contents of the run.

public EastAsianLayout EastAsianLayout { get; }

Property Value

EastAsianLayout

Emboss

Gets or sets a value indicating whether the font is formatted as embossed.

public bool Emboss { get; set; }

Property Value

bool

EmphasisMark

Gets or sets a EmphasisMark constant that represents the emphasis mark for a character or designated character string.

public EmphasisMark EmphasisMark { get; set; }

Property Value

EmphasisMark

Engrave

Gets or sets a value indicating whether the font is formatted as engraved.

public bool Engrave { get; set; }

Property Value

bool

FitTextId

Gets or sets a unique ID which shall be used to link multiple contiguous runs with specified FitTextWidth property to each other to ensure that their contents are correctly merged into the specified width in the document. This means that multiple runs which are broken apart due to differences in formatting can be identified as belonging to the same grouping in terms of FitText properties, although they are multiple runs of text in the document.

public int FitTextId { get; set; }

Property Value

int

Remarks

If this property value equals to 0, then the run has no id and shall not be linked with any other run in the parent paragraph.

FitTextWidth

Gets or sets that the contents of the run shall not be automatically displayed based on the width of its contents, rather its contents shall be resized to fit the width specified by the this property. This expansion/contraction shall be performed by equally increasing/decreasing the size of each character in the run's contents when displayed.

public float FitTextWidth { get; set; }

Property Value

float

Remarks

If the property value equals to 0, then the contents of the run shall be displayed based on the size of its contents.

Hidden

Gets or sets a value indicating whether the font is formatted as hidden text.

public bool Hidden { get; set; }

Property Value

bool

HintType

Gets or sets the font type that shall be used to format any ambiguous characters.

public FontHintType HintType { get; set; }

Property Value

FontHintType

Remarks

There are certain characters that are not explicitly stored in the document, and can be mapped into multiple categories of the four mentioned above. This property shall be used to arbitrate that conflict, and determine how ambiguities shall be handled. This is primarily used to handle the formatting on the paragraph mark glyph, and other characters that are not stored as text.

Italic

Gets or sets a value indicating whether the font is formatted as italic.

In an Office Math zone this property takes into account the GrapeCity.Documents.Word.OMathFormat.Style property.

public bool Italic { get; set; }

Property Value

bool

ItalicBi

Gets or sets a value indicating whether Italic shall be applied to all complex script characters in the contents when displayed in a document.

In an Office Math zone this property takes into account the GrapeCity.Documents.Word.OMathFormat.Style property.

public bool ItalicBi { get; set; }

Property Value

bool

Kerning

Gets or sets the font size at which kerning starts.

public float Kerning { get; set; }

Property Value

float

LocaleName

Gets or sets the locale name (language) of the formatted characters.

public string LocaleName { get; set; }

Property Value

string

LocaleNameBi

Gets or sets the locale name (language) of the complex script characters.

public string LocaleNameBi { get; set; }

Property Value

string

LocaleNameFarEast

Gets or sets the locale name (language) of the formatted Asian characters.

public string LocaleNameFarEast { get; set; }

Property Value

string