XlsFont Class |
Represents a font style used in Excel documents, encapsulating properties such as font name, size, color, and style attributes like bold or italic.
Inheritance Hierarchy
System
Object
Spire.Xls.Core.Spreadsheet XlsObject
Spire.Xls.Core.Spreadsheet XlsFont
Spire.Xls.Core.Spreadsheet XlsFontStyle
Spire.Xls.Core.Spreadsheet XlsObject
Spire.Xls.Core.Spreadsheet XlsFont
Spire.Xls.Core.Spreadsheet XlsFontStyle
Namespace: Spire.Xls.Core.Spreadsheet
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 15.4.0.0 (15.4.0.5046)
Syntax
The XlsFont type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
|
Color |
Gets or sets the color of the book.
|
|
|
Font |
Returns current font. Read-only.
|
|
|
FontName |
Gets or sets the name of the font.
|
|
|
IsAutoColor |
Gets a value indicating whether the color is automatically determined.
|
|
|
IsBold |
Gets or sets a value indicating whether the font is bold.
|
|
|
IsItalic |
Gets or sets a value indicating whether the font is italic.
|
|
|
IsStrikethrough |
Gets or sets a value indicating whether the text is displayed with a strikethrough.
|
|
|
IsSubscript |
Gets or sets a value indicating whether the font is subscript.
|
|
|
IsSuperscript |
Gets or sets a value indicating whether the font is superscript.
|
|
|
KnownColor |
Gets or sets the known color of the font.
|
|
MacOSOutlineFont |
True if the font is an outline font. Read/write Boolean.
|
|
|
MacOSShadow |
True if the font is a shadow font or if the object has
a shadow. Read/write Boolean.
|
|
|
OColor |
Returns color object.
|
|
|
Parent |
Reference to Parent object. Read-only.
(Inherited from
XlsObject
.)
|
|
|
ReferenceCount |
Get quantity of instance references.
(Inherited from
XlsObject
.)
|
|
|
Scheme |
Gets or sets the scheme used for font conversion.
|
|
|
Size |
Gets or sets the size of the font.
|
|
|
StrikethroughType |
Gets or sets the type of strikethrough applied to the text.
|
|
|
Underline |
Gets or sets the underline style of the font.
|
|
|
VerticalAlignment |
Gets or sets the vertical alignment of the font.
|
Methods
| Name | Description | |
|---|---|---|
|
AddReference |
Increase the quantity of reference. User must use this method when
new wrapper on object is created or reference on object stored.
(Inherited from
XlsObject
.)
|
|
BeginUpdate |
This method should be called before several updates to the object will take place.
|
|
|
CheckDisposed |
Checks whether object was disposed and throws exception if it was.
(Inherited from
XlsObject
.)
|
|
|
Clone |
Creates a clone of the current XlsFont object with the specified parent.
|
|
|
CompareTo |
Compares the current instance with another object of the same type.
|
|
|
Dispose |
Dispose object and free resources.
(Inherited from
XlsObject
.)
|
|
|
EndUpdate |
This method should be called after several updates to the object took place.
|
|
|
Equals |
Determines whether the specified object is equal to the current object.
(Inherited from
Object
.)
|
|
|
Finalize |
Destructor. Call dispose method of current object.
(Inherited from
XlsObject
.)
|
|
|
FindParent(Type) |
This method is used to find parent with specific type.
(Inherited from
XlsObject
.)
|
|
|
FindParent( Type ) |
Find parent of object.
(Inherited from
XlsObject
.)
|
|
|
FindParent(Type, Boolean) |
This method is used to find parent with specific type.
(Inherited from
XlsObject
.)
|
|
|
FindParents |
Finds parent objects.
(Inherited from
XlsObject
.)
|
|
|
GenerateNativeFont |
Generates a native font if it doesn't already exist, using the current font size.
|
|
|
GenerateNativeFont(Single) |
Generates a Font object based on the specified size and the current font settings.
|
|
|
GetHashCode |
Serves as the default hash function.
(Inherited from
Object
.)
|
|
|
GetThemeColor |
Get the theme color.
|
|
|
GetType |
Gets the
Type
of the current instance.
(Inherited from
Object
.)
|
|
|
MeasureString |
Measures the size of a string when rendered with the specified font settings.
|
|
|
MemberwiseClone |
Creates a shallow copy of the current
Object
.
(Inherited from
Object
.)
|
|
|
OnDispose |
Method which can be overriden by users to take any specific actions when
object is disposed.
(Inherited from
XlsObject
.)
|
|
|
ReleaseReference |
Decrease quantity of Reference. User must call this method
when freeing resources.
(Inherited from
XlsObject
.)
|
|
|
SetParent |
Sets parent of the object.
(Inherited from
XlsObject
.)
|
|
|
SetThemeColor |
Set the theme color.
|
|
|
ToString |
Returns a string that represents the current object.
(Inherited from
Object
.)
|
Fields
| Name | Description | |
|---|---|---|
|
m_bIsDisposed |
Flag which indicates if the object was disposed or not.
(Inherited from
XlsObject
.)
|
See Also
