Export (0) Print
Expand All

Console.ForegroundColor Property

Gets or sets the foreground color of the console.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)

'Declaration
Public Shared Property ForegroundColor As ConsoleColor

Property Value

Type: System.ConsoleColor
A ConsoleColor that specifies the foreground color of the console; that is, the color of each character that is displayed. The default is gray.

ExceptionCondition
ArgumentException

The color specified in a set operation is not a valid member of System.ConsoleColor.

SecurityException

The user does not have permission to perform this action.

IOException

An I/O error occurred.

A get operation for a Windows-based application, in which a console does not exist, returns Gray.

The following example saves the values of the ConsoleColor enumeration to an array and stores the current values of the BackgroundColor and ForegroundColor properties to variables. It then changes the foreground color to each color in the ConsoleColor enumeration except to the color that matches the current background, and it changes the background color to each color in the ConsoleColor enumeration except to the color that matches the current foreground. (If the foreground color is the same as the background color, the text isn't visible.) Finally, it calls the ResetColor method to restore the original console colors.

Public Module Example
   Public Sub Main()
      ' Get an array with the values of ConsoleColor enumeration members. 
      Dim colors() As ConsoleColor = ConsoleColor.GetValues(GetType(ConsoleColor))
      ' Save the current background and foreground colors. 
      Dim currentBackground As ConsoleColor = Console.BackgroundColor
      Dim currentForeground As ConsoleColor = Console.ForegroundColor

      ' Display all foreground colors except the one that matches the background.
      Console.WriteLine("All the foreground colors except {0}, the background color:",
                        currentBackground)
      For Each color In colors
         If color = currentBackground Then Continue For

         Console.ForegroundColor = color
         Console.WriteLine("   The foreground color is {0}.", color)
      Next 
      Console.WriteLine()

      ' Restore the foreground color.
      Console.ForegroundColor = currentForeground

      ' Display each background color except the one that matches the current foreground color.
      Console.WriteLine("All the background colors except {0}, the foreground color:",
                        currentForeground)
      For Each color In colors
         If color = currentForeground  then Continue For
         Console.BackgroundColor = color
         Console.WriteLine("   The background color is {0}.", color)
      Next 
      ' Restore the original console colors.
      Console.ResetColor
      Console.WriteLine()
      Console.WriteLine("Original colors restored...")
   End Sub 
End Module 
'The example displays output like the following: 
'       The background color is DarkCyan. 
'       The background color is DarkRed. 
'       The background color is DarkMagenta. 
'       The background color is DarkYellow. 
'       The background color is Gray. 
'       The background color is DarkGray. 
'       The background color is Blue. 
'       The background color is Green. 
'       The background color is Cyan. 
'       The background color is Red. 
'       The background color is Magenta. 
'       The background color is Yellow. 
'     
'    Original colors restored...

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), 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.

Show:
© 2014 Microsoft