This documentation is archived and is not being maintained.

FontInfo Class

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

For a list of all members of this type, see FontInfo Members.

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

[Visual Basic]
NotInheritable Public Class FontInfo
[C#]
public sealed class FontInfo
[C++]
public __gc __sealed class FontInfo
[JScript]
public class FontInfo

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.

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.

Example

[Visual Basic, C#, JScript] The following example demonstrates how to programmatically modify the properties of a FontInfo to specify the font properties for a Label control.

[Visual Basic] 
<%@ Page Language="VB" AutoEventWireup="True" %>

<html>

   <head>

      <script runat="server">
        
         Sub DisplayFontInfo(sender As Object, e As EventArgs)

            ' Note that the SampleTextLabel.Font property is a FontInfo. 

            ' Display the values of the font.
            NameTextBox.Text = SampleTextLabel.Font.Name
            SizeTextBox.Text = SampleTextLabel.Font.Size.ToString()        
            BoldCheckBox.Checked = SampleTextLabel.Font.Bold
            ItalicCheckBox.Checked = SampleTextLabel.Font.Italic
            OverlineCheckBox.Checked = SampleTextLabel.Font.Overline
            StrikeoutCheckBox.Checked = SampleTextLabel.Font.Strikeout
            UnderlineCheckBox.Checked = SampleTextLabel.Font.Underline
    
            ToStringOutputLabel.Text = SampleTextLabel.Font.ToString()

         End Sub

         Sub SetFontInfo(sender As Object, e As EventArgs)

            ' Note that the SampleTextLabel.Font property is a FontInfo. 

            ' Set the values of the font.
            SampleTextLabel.Font.Name = NameTextBox.Text
            SampleTextLabel.Font.Size = FontUnit.Parse(SizeTextBox.Text)         
            SampleTextLabel.Font.Bold = BoldCheckBox.Checked
            SampleTextLabel.Font.Italic = ItalicCheckBox.Checked
            SampleTextLabel.Font.Overline = OverlineCheckBox.Checked
            SampleTextLabel.Font.Strikeout = StrikeoutCheckBox.Checked
            SampleTextLabel.Font.Underline = UnderlineCheckBox.Checked

         End Sub

      </script>

   </head>

   <body>

      <form runat="server">

         <h3> FontInfo Example </h3>

         <asp:Label  id="SampleTextLabel" 
              Text="Sample Text" 
              Font-Bold="true" 
              Font-Italic="true" 
              Font-Name="Courier" 
              Font-Underline="true"  
              Font-Size="20px"  
              Font-Strikeout="false" 
              runat="server" />

         <br><br>

         <asp:Button id="DisplayButton" 
              Text="Display FontInfo"
              OnClick="DisplayFontInfo" 
              runat="server" />

         <asp:Button id="SetButton"
              Text="Set FontInfo"  
              OnClick="SetFontInfo" 
              runat="server" />

         <br><br>

         Name: 
         <asp:textbox  
              id="NameTextBox" 
              runat="server" />

         <br>

         Size: 
         <asp:textbox  
              id="SizeTextBox" 
              runat="server" />

         <br>

         <asp:CheckBox  
              id="BoldCheckBox" 
              Text="Bold" 
              runat="server" />

         <br>

         <asp:CheckBox  
              id="ItalicCheckBox" 
              Text="Italic" 
              runat="server" />

         <br>

         <asp:CheckBox  
              id="OverlineCheckBox" 
              Text="Overline" runat="server" />

         <br>

         <asp:CheckBox  
              id="StrikeoutCheckBox" 
              Text="Strikeout" 
              runat="server" />

         <br>

         <asp:CheckBox  
              id="UnderlineCheckBox" 
              Text="Underline" runat="server" />

         <br><br>

         <h4>FontInfo.ToString() output:</h4>

         <asp:Label id="ToStringOutputLabel" 
              runat="server" />

      </form>

   </body>

</html>

[C#] 
<%@ Page Language="C#" AutoEventWireup="True" %>

<html>

   <head>

      <script runat="server">
        
         void DisplayFontInfo(Object sender, EventArgs e)
         {

            // Note that the SampleTextLabel.Font property is a FontInfo. 

            // Display the values of the font.
            NameTextBox.Text = SampleTextLabel.Font.Name;
            SizeTextBox.Text = SampleTextLabel.Font.Size.ToString();        
            BoldCheckBox.Checked = SampleTextLabel.Font.Bold;
            ItalicCheckBox.Checked = SampleTextLabel.Font.Italic;
            OverlineCheckBox.Checked = SampleTextLabel.Font.Overline;
            StrikeoutCheckBox.Checked = SampleTextLabel.Font.Strikeout;
            UnderlineCheckBox.Checked = SampleTextLabel.Font.Underline;
    
            ToStringOutputLabel.Text = SampleTextLabel.Font.ToString();

         }

         void SetFontInfo(Object sender, EventArgs e)
         {

            // Note that the SampleTextLabel.Font property is a FontInfo. 

            // Set the values of the font.
            SampleTextLabel.Font.Name = NameTextBox.Text;
            SampleTextLabel.Font.Size = FontUnit.Parse(SizeTextBox.Text);         
            SampleTextLabel.Font.Bold = BoldCheckBox.Checked;
            SampleTextLabel.Font.Italic = ItalicCheckBox.Checked;
            SampleTextLabel.Font.Overline = OverlineCheckBox.Checked;
            SampleTextLabel.Font.Strikeout = StrikeoutCheckBox.Checked;
            SampleTextLabel.Font.Underline = UnderlineCheckBox.Checked;

         }

      </script>

   </head>

   <body>

      <form runat="server">

         <h3> FontInfo Example </h3>

         <asp:Label  id="SampleTextLabel" 
              Text="Sample Text" 
              Font-Bold="true" 
              Font-Italic="true" 
              Font-Name="Courier" 
              Font-Underline="true"  
              Font-Size="20px"  
              Font-Strikeout="false" 
              runat="server" />

         <br><br>

         <asp:Button id="DisplayButton" 
              Text="Display FontInfo"
              OnClick="DisplayFontInfo" 
              runat="server" />

         <asp:Button id="SetButton"
              Text="Set FontInfo"  
              OnClick="SetFontInfo" 
              runat="server" />

         <br><br>

         Name: 
         <asp:textbox  
              id="NameTextBox" 
              runat="server" />

         <br>

         Size: 
         <asp:textbox  
              id="SizeTextBox" 
              runat="server" />

         <br>

         <asp:CheckBox  
              id="BoldCheckBox" 
              Text="Bold" 
              runat="server" />

         <br>

         <asp:CheckBox  
              id="ItalicCheckBox" 
              Text="Italic" 
              runat="server" />

         <br>

         <asp:CheckBox  
              id="OverlineCheckBox" 
              Text="Overline" runat="server" />

         <br>

         <asp:CheckBox  
              id="StrikeoutCheckBox" 
              Text="Strikeout" 
              runat="server" />

         <br>

         <asp:CheckBox  
              id="UnderlineCheckBox" 
              Text="Underline" runat="server" />

         <br><br>

         <h4>FontInfo.ToString() output:</h4>

         <asp:Label id="ToStringOutputLabel" 
              runat="server" />

      </form>

   </body>

</html>

[JScript] 
<%@ Page Language="JScript" AutoEventWireup="True" %>

<html>

   <head>

      <script runat="server">
        
         function DisplayFontInfo(sender, e : EventArgs)
         {

            // Note that the SampleTextLabel.Font property is a FontInfo. 

            // Display the values of the font.
            NameTextBox.Text = SampleTextLabel.Font.Name;
            SizeTextBox.Text = SampleTextLabel.Font.Size.ToString();        
            BoldCheckBox.Checked = SampleTextLabel.Font.Bold;
            ItalicCheckBox.Checked = SampleTextLabel.Font.Italic;
            OverlineCheckBox.Checked = SampleTextLabel.Font.Overline;
            StrikeoutCheckBox.Checked = SampleTextLabel.Font.Strikeout;
            UnderlineCheckBox.Checked = SampleTextLabel.Font.Underline;
    
            ToStringOutputLabel.Text = SampleTextLabel.Font.ToString();

         }

         function SetFontInfo(sender, e : EventArgs)
         {

            // Note that the SampleTextLabel.Font property is a FontInfo. 

            // Set the values of the font.
            SampleTextLabel.Font.Name = NameTextBox.Text;
            SampleTextLabel.Font.Size = FontUnit.Parse(SizeTextBox.Text);         
            SampleTextLabel.Font.Bold = BoldCheckBox.Checked;
            SampleTextLabel.Font.Italic = ItalicCheckBox.Checked;
            SampleTextLabel.Font.Overline = OverlineCheckBox.Checked;
            SampleTextLabel.Font.Strikeout = StrikeoutCheckBox.Checked;
            SampleTextLabel.Font.Underline = UnderlineCheckBox.Checked;

         }

      </script>

   </head>

   <body>

      <form runat="server">

         <h3> FontInfo Example </h3>

         <asp:Label  id="SampleTextLabel" 
              Text="Sample Text" 
              Font-Bold="true" 
              Font-Italic="true" 
              Font-Name="Courier" 
              Font-Underline="true"  
              Font-Size="20px"  
              Font-Strikeout="false" 
              runat="server" />

         <br><br>

         <asp:Button id="DisplayButton" 
              Text="Display FontInfo"
              OnClick="DisplayFontInfo" 
              runat="server" />

         <asp:Button id="SetButton"
              Text="Set FontInfo"  
              OnClick="SetFontInfo" 
              runat="server" />

         <br><br>

         Name: 
         <asp:textbox  
              id="NameTextBox" 
              runat="server" />

         <br>

         Size: 
         <asp:textbox  
              id="SizeTextBox" 
              runat="server" />

         <br>

         <asp:CheckBox  
              id="BoldCheckBox" 
              Text="Bold" 
              runat="server" />

         <br>

         <asp:CheckBox  
              id="ItalicCheckBox" 
              Text="Italic" 
              runat="server" />

         <br>

         <asp:CheckBox  
              id="OverlineCheckBox" 
              Text="Overline" runat="server" />

         <br>

         <asp:CheckBox  
              id="StrikeoutCheckBox" 
              Text="Strikeout" 
              runat="server" />

         <br>

         <asp:CheckBox  
              id="UnderlineCheckBox" 
              Text="Underline" runat="server" />

         <br><br>

         <h4>FontInfo.ToString() output:</h4>

         <asp:Label id="ToStringOutputLabel" 
              runat="server" />

      </form>

   </body>

</html>

[C++] No example is available for C++. To view a Visual Basic, C#, or JScript example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Namespace: System.Web.UI.WebControls

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

Assembly: System.Web (in System.Web.dll)

See Also

FontInfo Members | System.Web.UI.WebControls Namespace | WebControl | Font | Style | Font

Show: