Console.CursorSize Property

 

Gets or sets the height of the cursor within a character cell.

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

public static int CursorSize { get; set; }

Property Value

Type: System.Int32

The size of the cursor expressed as a percentage of the height of a character cell. The property value ranges from 1 to 100.

Exception Condition
ArgumentOutOfRangeException

The value specified in a set operation is less than 1 or greater than 100.

SecurityException

The user does not have permission to perform this action.

IOException

An I/O error occurred.

The cursor appearance varies, ranging from a horizontal line at the bottom of the cell when the property value is 1, to completely filling the cell when the property value is 100.

Win9xFamily

In a set operation, the operating system produces an approximation of the specified value.

The effect of a set operation persists until the termination of the application that performs the operation. The cursor size reverts to its original value after the application terminates.

This example demonstrates the CursorSize property. The example increases the size of the cursor each time any console key is pressed, then restores the cursor to its original size before terminating.

// This example demonstrates the Console.CursorSize property.
using System;

class Sample 
{
    public static void Main() 
    {
    string m0 = "This example increments the cursor size from 1% to 100%:\n";
    string m1 = "Cursor size = {0}%. (Press any key to continue...)";
    int[] sizes = {1, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100};
    int saveCursorSize;
//
    saveCursorSize = Console.CursorSize;
    Console.WriteLine(m0);
    foreach (int size in sizes)
        {
        Console.CursorSize = size;
        Console.WriteLine(m1, size);
        Console.ReadKey();
        }
    Console.CursorSize = saveCursorSize;
    }
}
/*
This example produces the following results:

This example increments the cursor size from 1% to 100%:

Cursor size = 1%. (Press any key to continue...)
Cursor size = 10%. (Press any key to continue...)
Cursor size = 20%. (Press any key to continue...)
Cursor size = 30%. (Press any key to continue...)
Cursor size = 40%. (Press any key to continue...)
Cursor size = 50%. (Press any key to continue...)
Cursor size = 60%. (Press any key to continue...)
Cursor size = 70%. (Press any key to continue...)
Cursor size = 80%. (Press any key to continue...)
Cursor size = 90%. (Press any key to continue...)
Cursor size = 100%. (Press any key to continue...)

*/

UIPermission

for modifying safe top-level windows and subwindows. Associated enumeration: UIPermissionWindow.SafeTopLevelWindows

.NET Framework
Available since 2.0
Return to top
Show: