Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Control.Region Property

Gets or sets the window region associated with the control.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)
[BrowsableAttribute(false)]
public Region Region { get; set; }

Property Value

Type: System.Drawing.Region
The window Region associated with the control.

The window region is a collection of pixels within the window where the operating system permits drawing. The operating system does not display any portion of a window that lies outside of the window region. The coordinates of a control's region are relative to the upper-left corner of the control, not the client area of the control.

NoteNote

The collection of pixels contained with the region can be noncontiguous.

The following code example demonstrates how to use the Region property by creating a round button. To run the example, paste the following code in a form containing a button called roundButton. This example requires that the Paint event is connected to the event handler defined in the example.

	// This method will change the square button to a circular button by  
	// creating a new circle-shaped GraphicsPath object and setting it  
	// to the RoundButton objects region. 
	private void roundButton_Paint(object sender, 
		System.Windows.Forms.PaintEventArgs e)
	{

		System.Drawing.Drawing2D.GraphicsPath buttonPath = 
			new System.Drawing.Drawing2D.GraphicsPath();

		// Set a new rectangle to the same size as the button's  
		// ClientRectangle property.
		System.Drawing.Rectangle newRectangle = roundButton.ClientRectangle;

		// Decrease the size of the rectangle.
		newRectangle.Inflate(-10, -10);
		
		// Draw the button's border.
		e.Graphics.DrawEllipse(System.Drawing.Pens.Black, newRectangle);

		// Increase the size of the rectangle to include the border.
		newRectangle.Inflate( 1,  1);

		// Create a circle within the new rectangle.
		buttonPath.AddEllipse(newRectangle);
				
		// Set the button's Region property to the newly created  
		// circle region.
		roundButton.Region = new System.Drawing.Region(buttonPath);

	}

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, 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.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.