FontInfo Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Encapsulates the font properties of text. This class cannot be inherited.
public ref class FontInfo sealed
[System.ComponentModel.TypeConverter(typeof(System.ComponentModel.ExpandableObjectConverter))]
public sealed class FontInfo
[<System.ComponentModel.TypeConverter(typeof(System.ComponentModel.ExpandableObjectConverter))>]
type FontInfo = class
Public NotInheritable Class FontInfo
- Inheritance
-
FontInfo
- Attributes
Examples
The following code example demonstrates how to modify the properties of a FontInfo object programmatically to specify the font properties for a Label control.
<%@ Page Language="C#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
void Page_Load(object sender, EventArgs e)
{
// When the page loads, set the myLabel Label control's FontInfo properties.
// Note that myLabel.Font is a FontInfo object.
myLabel.Font.Bold = true;
myLabel.Font.Italic = false;
myLabel.Font.Name = "verdana";
myLabel.Font.Overline = false;
myLabel.Font.Size = 10;
myLabel.Font.Strikeout = false;
myLabel.Font.Underline = true;
// Write information on the FontInfo object to the myLabel label.
myLabel.Text = myLabel.Font.ToString();
}
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>FontInfo Example</title>
</head>
<body>
<form id="form1" runat="server">
<h3>FontInfo Example</h3>
<asp:Label id="myLabel"
runat="server" >
</asp:Label>
</form>
</body>
</html>
<%@ Page Language="VB" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
' When the page loads, set the myLabel Label control's FontInfo properties.
' Note that myLabel.Font is a FontInfo object.
myLabel.Font.Bold = True
myLabel.Font.Italic = False
myLabel.Font.Name = "verdana"
myLabel.Font.Overline = False
myLabel.Font.Size = 10
myLabel.Font.Strikeout = False
myLabel.Font.Underline = True
' Write information on the FontInfo object to the myLabel label.
myLabel.Text = myLabel.Font.ToString()
End Sub
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
<title>FontInfo Example</title>
</head>
<body>
<form id="form1" runat="server">
<h3>FontInfo Example</h3>
<asp:Label id="myLabel"
runat="server" >
</asp:Label>
</form>
</body>
</html>
Remarks
Use the FontInfo class to encapsulate the font properties of text. You can specify the font name and font size. You can also specify whether the style of the font is bold, italic, overlined, strikethrough, or underlined.
This class is commonly used in a property for a class that requires font information, such as the Font property of the WebControl class.
Note
This class does not have a public constructor. A new instance of the class cannot be created directly.
Properties
Bold |
Gets or sets a value that indicates whether the font is bold. |
Italic |
Gets or sets a value that indicates whether the font is italic. |
Name |
Gets or sets the primary font name. |
Names |
Gets or sets an ordered array of font names. |
Overline |
Gets or sets a value that indicates whether the font is overlined. |
Size |
Gets or sets the font size. |
Strikeout |
Gets or sets a value that indicates whether the font is strikethrough. |
Underline |
Gets or sets a value that indicates whether the font is underlined. |
Methods
ClearDefaults() |
Resets all FontInfo properties to the unset state and clears the view state. |
CopyFrom(FontInfo) |
Duplicates the font properties of the specified FontInfo into the instance of the FontInfo class that this method is called from. |
Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
GetType() |
Gets the Type of the current instance. (Inherited from Object) |
MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
MergeWith(FontInfo) |
Combines the font properties of the specified FontInfo with the instance of the FontInfo class that this method is called from. |
ShouldSerializeNames() |
Determines whether the Names property should be persisted. |
ToString() |
Returns a string that contains the font name and size for an instance of the FontInfo class. |