334 lines
19 KiB
XML
334 lines
19 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="ControlStyles" FullName="System.Windows.Forms.ControlStyles">
|
|
<TypeSignature Language="C#" Value="public enum ControlStyles" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>System.Windows.Forms</AssemblyName>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>System.Enum</BaseTypeName>
|
|
</Base>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.Flags</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<Docs>
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Controls use this enumeration in various properties and methods to specify functionality. A control can enable a style by calling the <see cref="M:System.Windows.Forms.Control.SetStyle(System.Windows.Forms.ControlStyles,System.Boolean)" /> method and passing in the appropriate <see cref="T:System.Windows.Forms.ControlStyles" /> bit (or bits) and the Boolean value to set the bit(s) to. For example, the following line of Visual Basic code would enable double-buffering.</para>
|
|
<code> myControl.SetStyle(UserPaint Or AllPaintingInWmPaint Or DoubleBuffer, True)</code>
|
|
<para>If the <see cref="F:System.Windows.Forms.ControlStyles.AllPaintingInWmPaint" /> bit is set to true, the window message WM_ERASEBKGND is ignored, and both <see cref="M:System.Windows.Forms.Control.OnPaintBackground(System.Windows.Forms.PaintEventArgs)" /> and <see cref="M:System.Windows.Forms.Control.OnPaint(System.Windows.Forms.PaintEventArgs)" /> methods are called directly from the window message WM_PAINT. This generally reduces flicker unless other controls send the window message WM_ERASEBKGND to the control. You might send the window message WM_ERASEBKGRND to achieve a pseudo-transparent effect similar to <see cref="F:System.Windows.Forms.ControlStyles.SupportsTransparentBackColor" />; for example, a <see cref="T:System.Windows.Forms.ToolBar" /> with flat appearance does this.</para>
|
|
<para />
|
|
<para>To fully enable double-buffering, you can set the <see cref="F:System.Windows.Forms.ControlStyles.OptimizedDoubleBuffer" /> and <see cref="F:System.Windows.Forms.ControlStyles.AllPaintingInWmPaint" /> bits to true. However the preferred method for enabling double buffering, which yields the same result, is to set the <see cref="P:System.Windows.Forms.Control.DoubleBuffered" /> property for the control to true. </para>
|
|
<para>If the <see cref="F:System.Windows.Forms.ControlStyles.SupportsTransparentBackColor" /> bit is set to true, and the <see cref="P:System.Windows.Forms.Control.BackColor" /> is set to a color whose alpha component is less than 255, <see cref="M:System.Windows.Forms.Control.OnPaintBackground(System.Windows.Forms.PaintEventArgs)" /> will simulate transparency by asking its parent control to paint the background. This is not true transparency.</para>
|
|
<block subset="none" type="note">
|
|
<para>If there is another control between the control and its parent, the current control will not show the control in the middle.</para>
|
|
</block>
|
|
<para>When the <see cref="F:System.Windows.Forms.ControlStyles.UserMouse" /> bit is set to true, the following methods are still called: <see cref="M:System.Windows.Forms.Control.OnMouseDown(System.Windows.Forms.MouseEventArgs)" />, <see cref="M:System.Windows.Forms.Control.OnMouseUp(System.Windows.Forms.MouseEventArgs)" />, <see cref="M:System.Windows.Forms.Control.OnMouseEnter(System.EventArgs)" />, <see cref="M:System.Windows.Forms.Control.OnMouseMove(System.Windows.Forms.MouseEventArgs)" />, <see cref="M:System.Windows.Forms.Control.OnMouseHover(System.EventArgs)" />, <see cref="M:System.Windows.Forms.Control.OnMouseLeave(System.EventArgs)" />, and <see cref="M:System.Windows.Forms.Control.OnMouseWheel(System.Windows.Forms.MouseEventArgs)" />.</para>
|
|
<para>When the control is clicked, if the <see cref="F:System.Windows.Forms.ControlStyles.StandardClick" /> bit is set to true the <see cref="M:System.Windows.Forms.Control.OnClick(System.EventArgs)" /> method is called and it raises the <see cref="E:System.Windows.Forms.Control.Click" /> event. When the control is double-clicked, and both the <see cref="F:System.Windows.Forms.ControlStyles.StandardClick" /> and <see cref="F:System.Windows.Forms.ControlStyles.StandardDoubleClick" /> bits are set to true, the click is passed on to the <see cref="E:System.Windows.Forms.Control.DoubleClick" /> event. Then the <see cref="M:System.Windows.Forms.Control.OnDoubleClick(System.EventArgs)" /> method is called and it raises the <see cref="E:System.Windows.Forms.Control.DoubleClick" /> event. However, the control can call <see cref="M:System.Windows.Forms.Control.OnClick(System.EventArgs)" /> or <see cref="M:System.Windows.Forms.Control.OnDoubleClick(System.EventArgs)" /> directly regardless of the <see cref="F:System.Windows.Forms.ControlStyles.StandardClick" /> and <see cref="F:System.Windows.Forms.ControlStyles.StandardDoubleClick" /> bit values. For more information on control click and double click behaviors, see the <see cref="E:System.Windows.Forms.Control.Click" /> and <see cref="E:System.Windows.Forms.Control.DoubleClick" /> topics.</para>
|
|
<para>When the <see cref="F:System.Windows.Forms.ControlStyles.UseTextForAccessibility" /> bit is set and there is a value in the control's Text property, the value of that control's Text property determines the control's default Active Accessibility name and shortcut key. Otherwise, the text of the preceding <see cref="T:System.Windows.Forms.Label" /> control will be used instead. This style is set by default. Certain built-in control types, such as <see cref="T:System.Windows.Forms.TextBox" /> and <see cref="T:System.Windows.Forms.ComboBox" />, reset this style so that the Text property of those controls will not be used by Active Accessibility.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Specifies the style and behavior of a control.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName="AllPaintingInWmPaint">
|
|
<MemberSignature Language="C#" Value="AllPaintingInWmPaint" />
|
|
<MemberType>Field</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Windows.Forms.ControlStyles</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If true, the control ignores the window message WM_ERASEBKGND to reduce flicker. This style should only be applied if the <see cref="F:System.Windows.Forms.ControlStyles.UserPaint" /> bit is set to true.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="CacheText">
|
|
<MemberSignature Language="C#" Value="CacheText" />
|
|
<MemberType>Field</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Windows.Forms.ControlStyles</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If true, the control keeps a copy of the text rather than getting it from the <see cref="P:System.Windows.Forms.Control.Handle" /> each time it is needed. This style defaults to false. This behavior improves performance, but makes it difficult to keep the text synchronized.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="ContainerControl">
|
|
<MemberSignature Language="C#" Value="ContainerControl" />
|
|
<MemberType>Field</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Windows.Forms.ControlStyles</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If true, the control is a container-like control.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="DoubleBuffer">
|
|
<MemberSignature Language="C#" Value="DoubleBuffer" />
|
|
<MemberType>Field</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Windows.Forms.ControlStyles</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If true, drawing is performed in a buffer, and after it completes, the result is output to the screen. Double-buffering prevents flicker caused by the redrawing of the control. If you set <see cref="F:System.Windows.Forms.ControlStyles.DoubleBuffer" /> to true, you should also set <see cref="F:System.Windows.Forms.ControlStyles.UserPaint" /> and <see cref="F:System.Windows.Forms.ControlStyles.AllPaintingInWmPaint" /> to true.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="EnableNotifyMessage">
|
|
<MemberSignature Language="C#" Value="EnableNotifyMessage" />
|
|
<MemberType>Field</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Windows.Forms.ControlStyles</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If true, the <see cref="M:System.Windows.Forms.Control.OnNotifyMessage(System.Windows.Forms.Message)" /> method is called for every message sent to the control's <see cref="M:System.Windows.Forms.Control.WndProc(System.Windows.Forms.Message@)" />. This style defaults to false. <see cref="F:System.Windows.Forms.ControlStyles.EnableNotifyMessage" /> does not work in partial trust.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="FixedHeight">
|
|
<MemberSignature Language="C#" Value="FixedHeight" />
|
|
<MemberType>Field</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Windows.Forms.ControlStyles</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If true, the control has a fixed height when auto-scaled. For example, if a layout operation attempts to rescale the control to accommodate a new <see cref="T:System.Drawing.Font" />, the control's <see cref="P:System.Windows.Forms.Control.Height" /> remains unchanged.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="FixedWidth">
|
|
<MemberSignature Language="C#" Value="FixedWidth" />
|
|
<MemberType>Field</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Windows.Forms.ControlStyles</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If true, the control has a fixed width when auto-scaled. For example, if a layout operation attempts to rescale the control to accommodate a new <see cref="T:System.Drawing.Font" />, the control's <see cref="P:System.Windows.Forms.Control.Width" /> remains unchanged.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Opaque">
|
|
<MemberSignature Language="C#" Value="Opaque" />
|
|
<MemberType>Field</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Windows.Forms.ControlStyles</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If true, the control is drawn opaque and the background is not painted.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="OptimizedDoubleBuffer">
|
|
<MemberSignature Language="C#" Value="OptimizedDoubleBuffer" />
|
|
<MemberType>Field</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Windows.Forms.ControlStyles</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If true, the control is first drawn to a buffer rather than directly to the screen, which can reduce flicker. If you set this property to true, you should also set the <see cref="F:System.Windows.Forms.ControlStyles.AllPaintingInWmPaint" /> to true.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="ResizeRedraw">
|
|
<MemberSignature Language="C#" Value="ResizeRedraw" />
|
|
<MemberType>Field</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Windows.Forms.ControlStyles</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If true, the control is redrawn when it is resized.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Selectable">
|
|
<MemberSignature Language="C#" Value="Selectable" />
|
|
<MemberType>Field</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Windows.Forms.ControlStyles</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If true, the control can receive focus.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="StandardClick">
|
|
<MemberSignature Language="C#" Value="StandardClick" />
|
|
<MemberType>Field</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Windows.Forms.ControlStyles</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If true, the control implements the standard <see cref="E:System.Windows.Forms.Control.Click" /> behavior.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="StandardDoubleClick">
|
|
<MemberSignature Language="C#" Value="StandardDoubleClick" />
|
|
<MemberType>Field</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Windows.Forms.ControlStyles</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If true, the control implements the standard <see cref="E:System.Windows.Forms.Control.DoubleClick" /> behavior. This style is ignored if the <see cref="F:System.Windows.Forms.ControlStyles.StandardClick" /> bit is not set to true.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="SupportsTransparentBackColor">
|
|
<MemberSignature Language="C#" Value="SupportsTransparentBackColor" />
|
|
<MemberType>Field</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Windows.Forms.ControlStyles</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If true, the control accepts a <see cref="P:System.Windows.Forms.Control.BackColor" /> with an alpha component of less than 255 to simulate transparency. Transparency will be simulated only if the <see cref="F:System.Windows.Forms.ControlStyles.UserPaint" /> bit is set to true and the parent control is derived from <see cref="T:System.Windows.Forms.Control" />.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="UserMouse">
|
|
<MemberSignature Language="C#" Value="UserMouse" />
|
|
<MemberType>Field</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Windows.Forms.ControlStyles</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If true, the control does its own mouse processing, and mouse events are not handled by the operating system.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="UserPaint">
|
|
<MemberSignature Language="C#" Value="UserPaint" />
|
|
<MemberType>Field</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Windows.Forms.ControlStyles</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>If true, the control paints itself rather than the operating system doing so. If false, the <see cref="E:System.Windows.Forms.Control.Paint" /> event is not raised. This style only applies to classes derived from <see cref="T:System.Windows.Forms.Control" />.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="UseTextForAccessibility">
|
|
<MemberSignature Language="C#" Value="UseTextForAccessibility" />
|
|
<MemberType>Field</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Windows.Forms.ControlStyles</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Specifies that the value of the control's Text property, if set, determines the control's default Active Accessibility name and shortcut key.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
</Members>
|
|
</Type> |