Export (0) Print
Expand All

Form.TransparencyKey Property

Gets or sets the color that will represent transparent areas of the form.

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

public Color TransparencyKey { get; set; }

Property Value

Type: System.Drawing.Color
A Color that represents the color to display transparently on the form.

When the TransparencyKey property is assigned a Color, the areas of the form that have the same BackColor will be displayed transparently. Any mouse actions, such as the click of the mouse, that are performed on the transparent areas of the form will be transferred to the windows below the transparent area. For example, if the client region of a form is made transparent, clicking the mouse on that area would send the event notification of the click to any window that is below it. If the color assigned to the TransparencyKey property is the same as any controls on the form, they also will be displayed transparently. For example, if you have a Button control on a form that has its TransparencyKey property set to SystemColors.Control, the control will be displayed transparently unless the BackColor property of the Button control is changed to a different color.

This property is not supported when RightToLeftLayout is true.

Windows 2000, Windows Server 2003, Windows XP Home Edition, Windows XP Professional x64 Edition, Windows Server 2003 Platform Note: Transparent windows and regions are only supported starting with Windows 2000.

The following code example creates a window that has a transparent client region regardless of background color of the form. This example requires that the example method is defined within a form class.

public void InitializeMyForm()
 {
    this.BackColor = Color.Red;
    // Make the background color of form display transparently. 
    this.TransparencyKey = BackColor;
 }
    

.NET Framework

Supported in: 4.5.2, 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 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.

Show:
© 2014 Microsoft