Console.CursorSize Property

Definition

Namespace:

System

Assembly:

System.Console.dll

Source:

Console.cs

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

public:
 static property int CursorSize { int get(); void set(int value); };

public static int CursorSize { [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] [System.Runtime.Versioning.UnsupportedOSPlatform("android")] [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] get; [System.Runtime.Versioning.SupportedOSPlatform("windows")] set; }

[<get: System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
[<set: System.Runtime.Versioning.SupportedOSPlatform("windows")>]
[<get: System.Runtime.Versioning.UnsupportedOSPlatform("android")>]
[<get: System.Runtime.Versioning.UnsupportedOSPlatform("ios")>]
[<get: System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>]
static member CursorSize : int with get, set

Public Shared Property CursorSize As Integer

Property Value

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.

Attributes

UnsupportedOSPlatformAttribute SupportedOSPlatformAttribute

Exceptions

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.

PlatformNotSupportedException

The set operation is invoked on an operating system other than Windows.

Examples

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 namespace System;
int main()
{
   String^ m0 = "This example increments the cursor size from 1% to 100%:\n";
   String^ m1 = "Cursor size = {0}%. (Press any key to continue...)";
   array<Int32>^sizes = {1,10,20,30,40,50,60,70,80,90,100};
   int saveCursorSize;
   
   //
   saveCursorSize = Console::CursorSize;
   Console::WriteLine( m0 );
   System::Collections::IEnumerator^ myEnum = sizes->GetEnumerator();
   while ( myEnum->MoveNext() )
   {
      int size =  *safe_cast<Int32^>(myEnum->Current);
      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...)

*/

// 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...)

*/

// This example demonstrates the Console.CursorSize property.
open System

let sizes = [ 1; 10; 20; 30; 40; 50; 60; 70; 80; 90; 100 ]

let saveCursorSize = Console.CursorSize
printfn "This example increments the cursor size from 1%% to 100%%:\n"

for size in sizes do
    Console.CursorSize <- size
    printfn $"Cursor size = {size}%%. (Press any key to continue...)"

    Console.ReadKey() |> ignore

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...)

' This example demonstrates the Console.CursorSize property.
Class Sample
   Public Shared Sub Main()
      Dim m0 As String = "This example increments the cursor size from " & _
                         "1% to 100%:" & vbCrLf
      Dim m1 As String = "Cursor size = {0}%. (Press any key to continue...)"
      Dim sizes As Integer() =  {1, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100}
      Dim saveCursorSize As Integer
      '
      saveCursorSize = Console.CursorSize
      Console.WriteLine(m0)
      Dim size As Integer
      For Each size In  sizes
         Console.CursorSize = size
         Console.WriteLine(m1, size)
         Console.ReadKey()
      Next size
      Console.CursorSize = saveCursorSize
   End Sub
End Class
'
'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...)
'

Remarks

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.