FontInfo Class (System.Web.UI.WebControls)

Switch View :

ScriptFree

.NET Framework Class Library

FontInfo Class

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Encapsulates the font properties of text. This class cannot be inherited.

Inheritance Hierarchy

System.Object
System.Web.UI.WebControls.FontInfo

Namespace: System.Web.UI.WebControls
Assembly: System.Web (in System.Web.dll)

Syntax

Visual Basic


<TypeConverterAttribute(GetType(ExpandableObjectConverter))> _
Public NotInheritable Class FontInfo


[TypeConverterAttribute(typeof(ExpandableObjectConverter))]
public sealed class FontInfo

Visual C++


[TypeConverterAttribute(typeof(ExpandableObjectConverter))]
public ref class FontInfo sealed


[<Sealed>]
[<TypeConverterAttribute(typeof(ExpandableObjectConverter))>]
type FontInfo =  class end

The FontInfo type exposes the following members.

Properties

	Name	Description
	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.

Top

Methods

	Name	Description
	ClearDefaults	Resets all FontInfo properties to the unset state and clears the view state.
	CopyFrom	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.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (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	Combines the font properties of the specified FontInfo with the instance of the FontInfo class that this method is called from.
	ShouldSerializeNames	Infrastructure. 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. (Overrides Object.ToString().)

Top

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.

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.

Visual Basic


<%@ 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 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>


<%@ 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 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>

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

Platforms

Windows 8 Release Preview, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Reference

System.Web.UI.WebControls Namespace

WebControl

Font

Style

Font