mcs/class/System.Windows.Forms/Documentation/en/System.Windows.Forms/GroupBoxRenderer.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="GroupBoxRenderer" FullName="System.Windows.Forms.GroupBoxRenderer">
   3   <TypeSignature Language="C#" Value="public sealed class GroupBoxRenderer" />
   4   <AssemblyInfo>
   5     <AssemblyName>System.Windows.Forms</AssemblyName>
   6     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   7   </AssemblyInfo>
   8   <Base>
   9     <BaseTypeName>System.Object</BaseTypeName>
  10   </Base>
  11   <Interfaces />
  12   <Docs>
  13     <since version=".NET 2.0" />
  14     <remarks>
  15       <attribution license="cc4" from="Microsoft" modified="false" />
  16       <para>The <see cref="T:System.Windows.Forms.GroupBoxRenderer" /> class provides a set of static methods that can be used to render a group box control. Rendering a control refers to drawing the user interface of a control. To draw a group box, use one of the <see cref="Overload:System.Windows.Forms.GroupBoxRenderer.DrawGroupBox" /> methods. These methods provide a variety of text drawing options. </para>
  17       <para>If visual styles are enabled in the operating system and visual styles are applied to the current application, <see cref="Overload:System.Windows.Forms.GroupBoxRenderer.DrawGroupBox" /> will draw the group box with the current visual style. Otherwise, <see cref="Overload:System.Windows.Forms.GroupBoxRenderer.DrawGroupBox" /> will draw the group box with the classic Windows style. This is useful if you are drawing a custom control that should automatically match the current visual style setting of the operating system.</para>
  18       <para>This class wraps the functionality of a <see cref="T:System.Windows.Forms.VisualStyles.VisualStyleRenderer" /> that is set to one of the elements exposed by the <see cref="T:System.Windows.Forms.VisualStyles.VisualStyleElement.Button.GroupBox" /> class. For more information, see <format type="text/html"><a href="a5b178ba-610e-46c4-a6c0-509c0886a744">Rendering Controls with Visual Styles</a></format>.</para>
  19     </remarks>
  20     <summary>
  21       <attribution license="cc4" from="Microsoft" modified="false" />
  22       <para>Provides methods used to render a group box control with or without visual styles. This class cannot be inherited.</para>
  23     </summary>
  24   </Docs>
  25   <Members>
  26     <Member MemberName="DrawGroupBox">
  27       <MemberSignature Language="C#" Value="public static void DrawGroupBox (System.Drawing.Graphics g, System.Drawing.Rectangle bounds, System.Windows.Forms.VisualStyles.GroupBoxState state);" />
  28       <MemberType>Method</MemberType>
  29       <ReturnValue>
  30         <ReturnType>System.Void</ReturnType>
  31       </ReturnValue>
  32       <Parameters>
  33         <Parameter Name="g" Type="System.Drawing.Graphics" />
  34         <Parameter Name="bounds" Type="System.Drawing.Rectangle" />
  35         <Parameter Name="state" Type="System.Windows.Forms.VisualStyles.GroupBoxState" />
  36       </Parameters>
  37       <Docs>
  38         <since version=".NET 2.0" />
  39         <remarks>
  40           <attribution license="cc4" from="Microsoft" modified="false" />
  41           <para>If visual styles are enabled in the operating system and visual styles are applied to the current application, this method will draw the group box with the current visual style. Otherwise, this method will draw the group box with the classic Windows style.</para>
  42         </remarks>
  43         <summary>
  44           <attribution license="cc4" from="Microsoft" modified="false" />
  45           <para>Draws a group box control in the specified state and bounds.</para>
  46         </summary>
  47         <param name="g">
  48           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Graphics" /> used to draw the group box.</param>
  49         <param name="bounds">
  50           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Rectangle" /> that specifies the bounds of the group box.</param>
  51         <param name="state">
  52           <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.VisualStyles.GroupBoxState" /> values that specifies the visual state of the group box.</param>
  53       </Docs>
  54       <AssemblyInfo>
  55         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  56       </AssemblyInfo>
  57     </Member>
  58     <Member MemberName="DrawGroupBox">
  59       <MemberSignature Language="C#" Value="public static void DrawGroupBox (System.Drawing.Graphics g, System.Drawing.Rectangle bounds, string groupBoxText, System.Drawing.Font font, System.Windows.Forms.VisualStyles.GroupBoxState state);" />
  60       <MemberType>Method</MemberType>
  61       <ReturnValue>
  62         <ReturnType>System.Void</ReturnType>
  63       </ReturnValue>
  64       <Parameters>
  65         <Parameter Name="g" Type="System.Drawing.Graphics" />
  66         <Parameter Name="bounds" Type="System.Drawing.Rectangle" />
  67         <Parameter Name="groupBoxText" Type="System.String" />
  68         <Parameter Name="font" Type="System.Drawing.Font" />
  69         <Parameter Name="state" Type="System.Windows.Forms.VisualStyles.GroupBoxState" />
  70       </Parameters>
  71       <Docs>
  72         <since version=".NET 2.0" />
  73         <remarks>
  74           <attribution license="cc4" from="Microsoft" modified="false" />
  75           <para>If visual styles are enabled in the operating system and visual styles are applied to the current application, this method will draw the group box with the current visual style. Otherwise, this method will draw the group box with the classic Windows style.</para>
  76         </remarks>
  77         <summary>
  78           <attribution license="cc4" from="Microsoft" modified="false" />
  79           <para>Draws a group box control in the specified state and bounds, with the specified text and font.</para>
  80         </summary>
  81         <param name="g">
  82           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Graphics" /> used to draw the group box.</param>
  83         <param name="bounds">
  84           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Rectangle" /> that specifies the bounds of the group box.</param>
  85         <param name="groupBoxText">
  86           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.String" /> to draw with the group box.</param>
  87         <param name="font">
  88           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Font" /> to apply to <paramref name="groupBoxText" />.</param>
  89         <param name="state">
  90           <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.VisualStyles.GroupBoxState" /> values that specifies the visual state of the group box.</param>
  91       </Docs>
  92       <AssemblyInfo>
  93         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  94       </AssemblyInfo>
  95     </Member>
  96     <Member MemberName="DrawGroupBox">
  97       <MemberSignature Language="C#" Value="public static void DrawGroupBox (System.Drawing.Graphics g, System.Drawing.Rectangle bounds, string groupBoxText, System.Drawing.Font font, System.Drawing.Color textColor, System.Windows.Forms.VisualStyles.GroupBoxState state);" />
  98       <MemberType>Method</MemberType>
  99       <ReturnValue>
 100         <ReturnType>System.Void</ReturnType>
 101       </ReturnValue>
 102       <Parameters>
 103         <Parameter Name="g" Type="System.Drawing.Graphics" />
 104         <Parameter Name="bounds" Type="System.Drawing.Rectangle" />
 105         <Parameter Name="groupBoxText" Type="System.String" />
 106         <Parameter Name="font" Type="System.Drawing.Font" />
 107         <Parameter Name="textColor" Type="System.Drawing.Color" />
 108         <Parameter Name="state" Type="System.Windows.Forms.VisualStyles.GroupBoxState" />
 109       </Parameters>
 110       <Docs>
 111         <since version=".NET 2.0" />
 112         <remarks>
 113           <attribution license="cc4" from="Microsoft" modified="false" />
 114           <para>If visual styles are enabled in the operating system and visual styles are applied to the current application, this method will draw the group box with the current visual style. Otherwise, this method will draw the group box with the classic Windows style.</para>
 115         </remarks>
 116         <summary>
 117           <attribution license="cc4" from="Microsoft" modified="false" />
 118           <para>Draws a group box control in the specified state and bounds, with the specified text, font, and color.</para>
 119         </summary>
 120         <param name="g">
 121           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Graphics" /> used to draw the group box.</param>
 122         <param name="bounds">
 123           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Rectangle" /> that specifies the bounds of the group box.</param>
 124         <param name="groupBoxText">
 125           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.String" /> to draw with the group box.</param>
 126         <param name="font">
 127           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Font" /> to apply to <paramref name="groupBoxText" />.</param>
 128         <param name="textColor">
 129           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Color" /> to apply to <paramref name="groupBoxText" />.</param>
 130         <param name="state">
 131           <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.VisualStyles.GroupBoxState" /> values that specifies the visual state of the group box.</param>
 132       </Docs>
 133       <AssemblyInfo>
 134         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 135       </AssemblyInfo>
 136     </Member>
 137     <Member MemberName="DrawGroupBox">
 138       <MemberSignature Language="C#" Value="public static void DrawGroupBox (System.Drawing.Graphics g, System.Drawing.Rectangle bounds, string groupBoxText, System.Drawing.Font font, System.Windows.Forms.TextFormatFlags flags, System.Windows.Forms.VisualStyles.GroupBoxState state);" />
 139       <MemberType>Method</MemberType>
 140       <ReturnValue>
 141         <ReturnType>System.Void</ReturnType>
 142       </ReturnValue>
 143       <Parameters>
 144         <Parameter Name="g" Type="System.Drawing.Graphics" />
 145         <Parameter Name="bounds" Type="System.Drawing.Rectangle" />
 146         <Parameter Name="groupBoxText" Type="System.String" />
 147         <Parameter Name="font" Type="System.Drawing.Font" />
 148         <Parameter Name="flags" Type="System.Windows.Forms.TextFormatFlags" />
 149         <Parameter Name="state" Type="System.Windows.Forms.VisualStyles.GroupBoxState" />
 150       </Parameters>
 151       <Docs>
 152         <since version=".NET 2.0" />
 153         <remarks>
 154           <attribution license="cc4" from="Microsoft" modified="false" />
 155           <para>If visual styles are enabled in the operating system and visual styles are applied to the current application, this method will draw the group box with the current visual style. Otherwise, this method will draw the group box with the classic Windows style.</para>
 156         </remarks>
 157         <summary>
 158           <attribution license="cc4" from="Microsoft" modified="false" />
 159           <para>Draws a group box control in the specified state and bounds, with the specified text, font, and text formatting.</para>
 160         </summary>
 161         <param name="g">
 162           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Graphics" /> used to draw the group box.</param>
 163         <param name="bounds">
 164           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Rectangle" /> that specifies the bounds of the group box.</param>
 165         <param name="groupBoxText">
 166           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.String" /> to draw with the group box.</param>
 167         <param name="font">
 168           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Font" /> to apply to <paramref name="groupBoxText" />.</param>
 169         <param name="flags">
 170           <attribution license="cc4" from="Microsoft" modified="false" />A bitwise combination of the <see cref="T:System.Windows.Forms.TextFormatFlags" /> values.</param>
 171         <param name="state">
 172           <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.VisualStyles.GroupBoxState" /> values that specifies the visual state of the group box.</param>
 173       </Docs>
 174       <AssemblyInfo>
 175         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 176       </AssemblyInfo>
 177     </Member>
 178     <Member MemberName="DrawGroupBox">
 179       <MemberSignature Language="C#" Value="public static void DrawGroupBox (System.Drawing.Graphics g, System.Drawing.Rectangle bounds, string groupBoxText, System.Drawing.Font font, System.Drawing.Color textColor, System.Windows.Forms.TextFormatFlags flags, System.Windows.Forms.VisualStyles.GroupBoxState state);" />
 180       <MemberType>Method</MemberType>
 181       <ReturnValue>
 182         <ReturnType>System.Void</ReturnType>
 183       </ReturnValue>
 184       <Parameters>
 185         <Parameter Name="g" Type="System.Drawing.Graphics" />
 186         <Parameter Name="bounds" Type="System.Drawing.Rectangle" />
 187         <Parameter Name="groupBoxText" Type="System.String" />
 188         <Parameter Name="font" Type="System.Drawing.Font" />
 189         <Parameter Name="textColor" Type="System.Drawing.Color" />
 190         <Parameter Name="flags" Type="System.Windows.Forms.TextFormatFlags" />
 191         <Parameter Name="state" Type="System.Windows.Forms.VisualStyles.GroupBoxState" />
 192       </Parameters>
 193       <Docs>
 194         <since version=".NET 2.0" />
 195         <remarks>
 196           <attribution license="cc4" from="Microsoft" modified="false" />
 197           <para>If visual styles are enabled in the operating system and visual styles are applied to the current application, this method will draw the group box with the current visual style. Otherwise, this method will draw the group box with the classic Windows style.</para>
 198         </remarks>
 199         <summary>
 200           <attribution license="cc4" from="Microsoft" modified="false" />
 201           <para>Draws a group box control in the specified state and bounds, with the specified text, font, color, and text formatting.</para>
 202         </summary>
 203         <param name="g">
 204           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Graphics" /> used to draw the group box.</param>
 205         <param name="bounds">
 206           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Rectangle" /> that specifies the bounds of the group box.</param>
 207         <param name="groupBoxText">
 208           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.String" /> to draw with the group box.</param>
 209         <param name="font">
 210           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Font" /> to apply to <paramref name="groupBoxText" />.</param>
 211         <param name="textColor">
 212           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Color" /> to apply to <paramref name="groupBoxText" />.</param>
 213         <param name="flags">
 214           <attribution license="cc4" from="Microsoft" modified="false" />A bitwise combination of the <see cref="T:System.Windows.Forms.TextFormatFlags" /> values.</param>
 215         <param name="state">
 216           <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.VisualStyles.GroupBoxState" /> values that specifies the visual state of the group box.</param>
 217       </Docs>
 218       <AssemblyInfo>
 219         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 220       </AssemblyInfo>
 221     </Member>
 222     <Member MemberName="DrawParentBackground">
 223       <MemberSignature Language="C#" Value="public static void DrawParentBackground (System.Drawing.Graphics g, System.Drawing.Rectangle bounds, System.Windows.Forms.Control childControl);" />
 224       <MemberType>Method</MemberType>
 225       <ReturnValue>
 226         <ReturnType>System.Void</ReturnType>
 227       </ReturnValue>
 228       <Parameters>
 229         <Parameter Name="g" Type="System.Drawing.Graphics" />
 230         <Parameter Name="bounds" Type="System.Drawing.Rectangle" />
 231         <Parameter Name="childControl" Type="System.Windows.Forms.Control" />
 232       </Parameters>
 233       <Docs>
 234         <remarks>To be added.</remarks>
 235         <since version=".NET 2.0" />
 236         <summary>
 237           <attribution license="cc4" from="Microsoft" modified="false" />
 238           <para>Draws the background of a control's parent in the specified area.</para>
 239         </summary>
 240         <param name="g">
 241           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Graphics" /> used to draw the background of the parent of <paramref name="childControl" />.</param>
 242         <param name="bounds">
 243           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Rectangle" /> in which to draw the parent control's background. This rectangle should be inside the child control’s bounds.</param>
 244         <param name="childControl">
 245           <attribution license="cc4" from="Microsoft" modified="false" />The control whose parent's background will be drawn.</param>
 246       </Docs>
 247       <AssemblyInfo>
 248         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 249       </AssemblyInfo>
 250     </Member>
 251     <Member MemberName="IsBackgroundPartiallyTransparent">
 252       <MemberSignature Language="C#" Value="public static bool IsBackgroundPartiallyTransparent (System.Windows.Forms.VisualStyles.GroupBoxState state);" />
 253       <MemberType>Method</MemberType>
 254       <ReturnValue>
 255         <ReturnType>System.Boolean</ReturnType>
 256       </ReturnValue>
 257       <Parameters>
 258         <Parameter Name="state" Type="System.Windows.Forms.VisualStyles.GroupBoxState" />
 259       </Parameters>
 260       <Docs>
 261         <remarks>To be added.</remarks>
 262         <since version=".NET 2.0" />
 263         <summary>
 264           <attribution license="cc4" from="Microsoft" modified="false" />
 265           <para>Indicates whether the background of the group box has any semitransparent or alpha-blended pieces.</para>
 266         </summary>
 267         <returns>
 268           <attribution license="cc4" from="Microsoft" modified="false" />
 269           <para>true if the background of the group box has semitransparent or alpha-blended pieces; otherwise, false.</para>
 270         </returns>
 271         <param name="state">
 272           <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.VisualStyles.GroupBoxState" /> values that specifies the visual state of the group box.</param>
 273       </Docs>
 274       <AssemblyInfo>
 275         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 276       </AssemblyInfo>
 277     </Member>
 278     <Member MemberName="RenderMatchingApplicationState">
 279       <MemberSignature Language="C#" Value="public static bool RenderMatchingApplicationState { set; get; }" />
 280       <MemberType>Property</MemberType>
 281       <ReturnValue>
 282         <ReturnType>System.Boolean</ReturnType>
 283       </ReturnValue>
 284       <Docs>
 285         <value>To be added.</value>
 286         <since version=".NET 2.0" />
 287         <remarks>
 288           <attribution license="cc4" from="Microsoft" modified="false" />
 289           <para>If <see cref="P:System.Windows.Forms.GroupBoxRenderer.RenderMatchingApplicationState" /> is true, the <see cref="T:System.Windows.Forms.GroupBoxRenderer" /> uses the setting from <see cref="P:System.Windows.Forms.Application.RenderWithVisualStyles" /> to determine the rendering style. If <see cref="P:System.Windows.Forms.GroupBoxRenderer.RenderMatchingApplicationState" /> is false, the renderer will always render using visual styles.</para>
 290         </remarks>
 291         <summary>
 292           <attribution license="cc4" from="Microsoft" modified="false" />
 293           <para>Gets or sets a value indicating whether the renderer uses the application state to determine rendering style.</para>
 294         </summary>
 295       </Docs>
 296       <AssemblyInfo>
 297         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 298       </AssemblyInfo>
 299     </Member>
 300   </Members>
 301 </Type>