.NET Framework Class Library
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)
Syntax

Visual Basic (Declaration)
Public Property TransparencyKey As Color
Visual Basic (Usage)
Dim instance As Form
Dim value As Color

value = instance.TransparencyKey

instance.TransparencyKey = value
C#
public Color TransparencyKey { get; set; }
Visual C++
public:
property Color TransparencyKey {
    Color get ();
    void set (Color value);
}
JScript
public function get TransparencyKey () : Color
public function set TransparencyKey (value : Color)

Property Value

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

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.

Examples

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.

Visual Basic
Public Sub InitializeMyForm()
    BackColor = Color.Red
    ' Make the background color of form display transparently.
    TransparencyKey = BackColor
End Sub 'InitializeMyForm
C#
public void InitializeMyForm()
 {
    this.BackColor = Color.Red;
    // Make the background color of form display transparently.
    this.TransparencyKey = BackColor;
 }

Visual C++
public:
   void InitializeMyForm()
   {
      this->BackColor = Color::Red;
      // Make the background color of form display transparently.
      this->TransparencyKey = BackColor;
   }
Platforms

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.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
See Also

Reference

Tags :


Page view tracker