Control.GetStyle Method (System.Windows.Forms)

GetStyle Method

.NET Framework Class Library

Control..::.GetStyle Method

Retrieves the value of the specified control style bit for the control.

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

Syntax

Visual Basic (Declaration)

Protected Function GetStyle ( _
    flag As ControlStyles _
) As Boolean

Visual Basic (Usage)

Dim flag As ControlStyles
Dim returnValue As Boolean

returnValue = Me.GetStyle(flag)

protected bool GetStyle(
    ControlStyles flag
)

Visual C++

protected:
bool GetStyle(
    ControlStyles flag
)

JScript

protected function GetStyle(
    flag : ControlStyles
) : boolean

Parameters

flag: Type: System.Windows.Forms..::.ControlStyles
The ControlStyles bit to return the value from.

Return Value

Type: System..::.Boolean
true if the specified control style bit is set to true; otherwise, false.

Remarks

Control style bit flags are used to categorize supported behavior. A control can enable a style by calling the SetStyle method and passing in the appropriate ControlStyles bit and the Boolean value to set the bit to. To determine the value assigned to a specified ControlStyles bit, use the GetStyle method and pass in the ControlStyles member to evaluate.

Examples

The following code example returns the value of the double-buffering related style bits for a Form. This example returns true only if all the style bits are set to true.

Visual Basic

Public Function DoubleBufferingEnabled() As Boolean
   ' Get the value of the double-buffering style bits.
   Return Me.GetStyle((ControlStyles.DoubleBuffer _
     Or ControlStyles.UserPaint _
     Or ControlStyles.AllPaintingInWmPaint))
End Function

public bool DoubleBufferingEnabled()
{
   // Get the value of the double-buffering style bits.
   return this.GetStyle(ControlStyles.DoubleBuffer | 
      ControlStyles.UserPaint | 
      ControlStyles.AllPaintingInWmPaint);
}

Visual C++

public:
   bool DoubleBufferingEnabled()
   {

      // Get the value of the double-buffering style bits.
      return this->GetStyle( static_cast<ControlStyles>(ControlStyles::DoubleBuffer | ControlStyles::UserPaint | ControlStyles::AllPaintingInWmPaint) );
   }

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

Reference

Control Class

Control Members

System.Windows.Forms Namespace

SetStyle

ControlStyles