This documentation is archived and is not being maintained.

Control.GetStyle Method

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

[Visual Basic]
Protected Function GetStyle( _
   ByVal flag As ControlStyles _
) As Boolean
[C#]
protected bool GetStyle(
 ControlStyles flag
);
[C++]
protected: bool GetStyle(
 ControlStyles flag
);
[JScript]
protected function GetStyle(
   flag : ControlStyles
) : Boolean;

Parameters

flag
The ControlStyles bit to return the value from.

Return Value

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.

Example

[Visual Basic, C#, C++] The following 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

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

[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));
   }

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

Control Class | Control Members | System.Windows.Forms Namespace | SetStyle | ControlStyles

Show: