Information
Switch
Switch
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Control::Region Property

.NET Framework (current version)
 
Use BaseTrue

Gets or sets the window region associated with the control.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

C#
C++
F#
VB
Copy 
public:
[BrowsableAttribute(false)]
property Region^ Region {
	Region^ get();
	void set(Region^ value);
}

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.

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

C#
C++
VB
Copy 
private:
   // 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.
   void roundButton_Paint( Object^ sender,
      System::Windows::Forms::PaintEventArgs^ e )
   {
      System::Drawing::Drawing2D::GraphicsPath^ buttonPath =
         gcnew 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 = gcnew System::Drawing::Region( buttonPath );
   }

UIPermission

for all windows to set this property value. Associated enumeration: UIPermissionWindow::AllWindows

.NET Framework
Available since 1.1
Return to top
Show: