Console.MoveBufferArea Method (Int32, Int32, Int32, Int32, Int32, Int32, Char, ConsoleColor, ConsoleColor)

Copies a specified source area of the screen buffer to a specified destination area.

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

public static void MoveBufferArea(
	int sourceLeft,
	int sourceTop,
	int sourceWidth,
	int sourceHeight,
	int targetLeft,
	int targetTop,
	char sourceChar,
	ConsoleColor sourceForeColor,
	ConsoleColor sourceBackColor
)

Parameters

sourceLeft
Type: System.Int32

The leftmost column of the source area.

sourceTop
Type: System.Int32

The topmost row of the source area.

sourceWidth
Type: System.Int32

The number of columns in the source area.

sourceHeight
Type: System.Int32

The number of rows in the source area.

targetLeft
Type: System.Int32

The leftmost column of the destination area.

targetTop
Type: System.Int32

The topmost row of the destination area.

sourceChar
Type: System.Char

The character used to fill the source area.

sourceForeColor
Type: System.ConsoleColor

The foreground color used to fill the source area.

sourceBackColor
Type: System.ConsoleColor

The background color used to fill the source area.

ExceptionCondition
ArgumentOutOfRangeException

One or more of the parameters is less than zero.

-or-

sourceLeft or targetLeft is greater than or equal to BufferWidth.

-or-

sourceTop or targetTop is greater than or equal to BufferHeight.

-or-

sourceTop + sourceHeight is greater than or equal to BufferHeight.

-or-

sourceLeft + sourceWidth is greater than or equal to BufferWidth.

ArgumentException

One or both of the color parameters is not a member of the System.ConsoleColor enumeration.

SecurityException

The user does not have permission to perform this action.

IOException

An I/O error occurred.

If the destination and source parameters specify a position located beyond the boundaries of the current screen buffer, only the portion of the source area that fits within the destination area is copied. That is, the source area is clipped to fit the current screen buffer.

The MoveBufferArea method copies the source area to the destination area. If the destination area does not intersect the source area, the source area is filled with the character specified by sourceChar, using the colors specified by sourceForeColor and sourceBackColor. Otherwise, the intersected portion of the source area is not filled.

The MoveBufferArea method performs no operation if sourceWidth or sourceHeight is zero.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2015 Microsoft