Jo Shields a575963da9 Imported Upstream version 3.6.0
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
2014-08-13 10:39:27 +01:00

364 lines
24 KiB
XML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="utf-8"?>
<Type Name="CheckBoxRenderer" FullName="System.Windows.Forms.CheckBoxRenderer">
<TypeSignature Language="C#" Value="public sealed class CheckBoxRenderer" />
<AssemblyInfo>
<AssemblyName>System.Windows.Forms</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Windows.Forms.CheckBoxRenderer" /> class provides a set of static methods that can be used to render a check box control. Rendering a control refers to drawing the user interface of a control. To draw a check box, use one of the <see cref="Overload:System.Windows.Forms.CheckBoxRenderer.DrawCheckBox" /> methods. These methods provide a variety of options, such as drawing text or an image with the check box.</para>
<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.CheckBoxRenderer.DrawCheckBox" /> will draw the check box with the current visual style. Otherwise, <see cref="Overload:System.Windows.Forms.CheckBoxRenderer.DrawCheckBox" /> will draw the check 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>
<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.CheckBox" /> class. For more information, see <format type="text/html"><a href="a5b178ba-610e-46c4-a6c0-509c0886a744">Rendering Controls with Visual Styles</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides methods used to render a check box control with or without visual styles. This class cannot be inherited.</para>
</summary>
</Docs>
<Members>
<Member MemberName="DrawCheckBox">
<MemberSignature Language="C#" Value="public static void DrawCheckBox (System.Drawing.Graphics g, System.Drawing.Point glyphLocation, System.Windows.Forms.VisualStyles.CheckBoxState state);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="g" Type="System.Drawing.Graphics" />
<Parameter Name="glyphLocation" Type="System.Drawing.Point" />
<Parameter Name="state" Type="System.Windows.Forms.VisualStyles.CheckBoxState" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If visual styles are enabled in the operating system and visual styles are applied to the current application, this method will draw the check box with the current visual style. Otherwise, it will draw the check box with the classic Windows style.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Draws a check box control in the specified state and location.</para>
</summary>
<param name="g">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Graphics" /> used to draw the check box.</param>
<param name="glyphLocation">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Point" /> to draw the check box glyph at.</param>
<param name="state">
<attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.VisualStyles.CheckBoxState" /> values that specifies the visual state of the check box.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="DrawCheckBox">
<MemberSignature Language="C#" Value="public static void DrawCheckBox (System.Drawing.Graphics g, System.Drawing.Point glyphLocation, System.Drawing.Rectangle textBounds, string checkBoxText, System.Drawing.Font font, bool focused, System.Windows.Forms.VisualStyles.CheckBoxState state);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="g" Type="System.Drawing.Graphics" />
<Parameter Name="glyphLocation" Type="System.Drawing.Point" />
<Parameter Name="textBounds" Type="System.Drawing.Rectangle" />
<Parameter Name="checkBoxText" Type="System.String" />
<Parameter Name="font" Type="System.Drawing.Font" />
<Parameter Name="focused" Type="System.Boolean" />
<Parameter Name="state" Type="System.Windows.Forms.VisualStyles.CheckBoxState" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If visual styles are enabled in the operating system and visual styles are applied to the current application, this method will draw the check box with the current visual style. Otherwise, it will draw the check box with the classic Windows style.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Draws a check box control in the specified state and location, with the specified text, and with an optional focus rectangle.</para>
</summary>
<param name="g">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Graphics" /> used to draw the check box.</param>
<param name="glyphLocation">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Point" /> to draw the check box glyph at.</param>
<param name="textBounds">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Rectangle" /> to draw <paramref name="checkBoxText" /> in.</param>
<param name="checkBoxText">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.String" /> to draw with the check box.</param>
<param name="font">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Font" /> to apply to <paramref name="checkBoxText" />.</param>
<param name="focused">
<attribution license="cc4" from="Microsoft" modified="false" />true to draw a focus rectangle; otherwise, false.</param>
<param name="state">
<attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.VisualStyles.CheckBoxState" /> values that specifies the visual state of the check box.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="DrawCheckBox">
<MemberSignature Language="C#" Value="public static void DrawCheckBox (System.Drawing.Graphics g, System.Drawing.Point glyphLocation, System.Drawing.Rectangle textBounds, string checkBoxText, System.Drawing.Font font, System.Windows.Forms.TextFormatFlags flags, bool focused, System.Windows.Forms.VisualStyles.CheckBoxState state);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="g" Type="System.Drawing.Graphics" />
<Parameter Name="glyphLocation" Type="System.Drawing.Point" />
<Parameter Name="textBounds" Type="System.Drawing.Rectangle" />
<Parameter Name="checkBoxText" Type="System.String" />
<Parameter Name="font" Type="System.Drawing.Font" />
<Parameter Name="flags" Type="System.Windows.Forms.TextFormatFlags" />
<Parameter Name="focused" Type="System.Boolean" />
<Parameter Name="state" Type="System.Windows.Forms.VisualStyles.CheckBoxState" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If visual styles are enabled in the operating system and visual styles are applied to the current application, this method will draw the check box with the current visual style. Otherwise, it will draw the check box with the classic Windows style.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Draws a check box control in the specified state and location, with the specified text and text formatting, and with an optional focus rectangle.</para>
</summary>
<param name="g">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Graphics" /> used to draw the check box.</param>
<param name="glyphLocation">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Point" /> to draw the check box glyph at.</param>
<param name="textBounds">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Rectangle" /> to draw <paramref name="checkBoxText" /> in.</param>
<param name="checkBoxText">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.String" /> to draw with the check box.</param>
<param name="font">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Font" /> to apply to <paramref name="checkBoxText" />.</param>
<param name="flags">
<attribution license="cc4" from="Microsoft" modified="false" />A bitwise combination of the <see cref="T:System.Windows.Forms.TextFormatFlags" /> values.</param>
<param name="focused">
<attribution license="cc4" from="Microsoft" modified="false" />true to draw a focus rectangle; otherwise, false.</param>
<param name="state">
<attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.VisualStyles.CheckBoxState" /> values that specifies the visual state of the check box.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="DrawCheckBox">
<MemberSignature Language="C#" Value="public static void DrawCheckBox (System.Drawing.Graphics g, System.Drawing.Point glyphLocation, System.Drawing.Rectangle textBounds, string checkBoxText, System.Drawing.Font font, System.Drawing.Image image, System.Drawing.Rectangle imageBounds, bool focused, System.Windows.Forms.VisualStyles.CheckBoxState state);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="g" Type="System.Drawing.Graphics" />
<Parameter Name="glyphLocation" Type="System.Drawing.Point" />
<Parameter Name="textBounds" Type="System.Drawing.Rectangle" />
<Parameter Name="checkBoxText" Type="System.String" />
<Parameter Name="font" Type="System.Drawing.Font" />
<Parameter Name="image" Type="System.Drawing.Image" />
<Parameter Name="imageBounds" Type="System.Drawing.Rectangle" />
<Parameter Name="focused" Type="System.Boolean" />
<Parameter Name="state" Type="System.Windows.Forms.VisualStyles.CheckBoxState" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If visual styles are enabled in the operating system and visual styles are applied to the current application, this method will draw the check box with the current visual style. Otherwise, it will draw the check box with the classic Windows style.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Draws a check box control in the specified state and location, with the specified text and image, and with an optional focus rectangle.</para>
</summary>
<param name="g">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Graphics" /> used to draw the check box.</param>
<param name="glyphLocation">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Point" /> to draw the check box glyph at.</param>
<param name="textBounds">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Rectangle" /> to draw <paramref name="checkBoxText" /> in.</param>
<param name="checkBoxText">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.String" /> to draw with the check box.</param>
<param name="font">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Font" /> to apply to <paramref name="checkBoxText" />.</param>
<param name="image">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Image" /> to draw with the check box.</param>
<param name="imageBounds">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Rectangle" /> that represents the dimensions of <paramref name="image" />.</param>
<param name="focused">
<attribution license="cc4" from="Microsoft" modified="false" />true to draw a focus rectangle; otherwise, false.</param>
<param name="state">
<attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.VisualStyles.CheckBoxState" /> values that specifies the visual state of the check box.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="DrawCheckBox">
<MemberSignature Language="C#" Value="public static void DrawCheckBox (System.Drawing.Graphics g, System.Drawing.Point glyphLocation, System.Drawing.Rectangle textBounds, string checkBoxText, System.Drawing.Font font, System.Windows.Forms.TextFormatFlags flags, System.Drawing.Image image, System.Drawing.Rectangle imageBounds, bool focused, System.Windows.Forms.VisualStyles.CheckBoxState state);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="g" Type="System.Drawing.Graphics" />
<Parameter Name="glyphLocation" Type="System.Drawing.Point" />
<Parameter Name="textBounds" Type="System.Drawing.Rectangle" />
<Parameter Name="checkBoxText" Type="System.String" />
<Parameter Name="font" Type="System.Drawing.Font" />
<Parameter Name="flags" Type="System.Windows.Forms.TextFormatFlags" />
<Parameter Name="image" Type="System.Drawing.Image" />
<Parameter Name="imageBounds" Type="System.Drawing.Rectangle" />
<Parameter Name="focused" Type="System.Boolean" />
<Parameter Name="state" Type="System.Windows.Forms.VisualStyles.CheckBoxState" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If visual styles are enabled in the operating system and visual styles are applied to the current application, this method will draw the check box with the current visual style. Otherwise, it will draw the check box with the classic Windows style.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Draws a check box control in the specified state and location; with the specified text, text formatting, and image; and with an optional focus rectangle.</para>
</summary>
<param name="g">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Graphics" /> used to draw the check box.</param>
<param name="glyphLocation">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Point" /> to draw the check box glyph at.</param>
<param name="textBounds">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Rectangle" /> to draw <paramref name="checkBoxText" /> in.</param>
<param name="checkBoxText">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.String" /> to draw with the check box.</param>
<param name="font">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Font" /> to apply to <paramref name="checkBoxText" />.</param>
<param name="flags">
<attribution license="cc4" from="Microsoft" modified="false" />A bitwise combination of the <see cref="T:System.Windows.Forms.TextFormatFlags" /> values.</param>
<param name="image">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Image" /> to draw with the check box.</param>
<param name="imageBounds">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Rectangle" /> that represents the dimensions of <paramref name="image" />.</param>
<param name="focused">
<attribution license="cc4" from="Microsoft" modified="false" />true to draw a focus rectangle; otherwise, false.</param>
<param name="state">
<attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.VisualStyles.CheckBoxState" /> values that specifies the visual state of the check box.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="DrawParentBackground">
<MemberSignature Language="C#" Value="public static void DrawParentBackground (System.Drawing.Graphics g, System.Drawing.Rectangle bounds, System.Windows.Forms.Control childControl);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="g" Type="System.Drawing.Graphics" />
<Parameter Name="bounds" Type="System.Drawing.Rectangle" />
<Parameter Name="childControl" Type="System.Windows.Forms.Control" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Draws the background of a control's parent in the specified area.</para>
</summary>
<param name="g">
<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>
<param name="bounds">
<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 controls bounds.</param>
<param name="childControl">
<attribution license="cc4" from="Microsoft" modified="false" />The control whose parent's background will be drawn.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetGlyphSize">
<MemberSignature Language="C#" Value="public static System.Drawing.Size GetGlyphSize (System.Drawing.Graphics g, System.Windows.Forms.VisualStyles.CheckBoxState state);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Drawing.Size</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="g" Type="System.Drawing.Graphics" />
<Parameter Name="state" Type="System.Windows.Forms.VisualStyles.CheckBoxState" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The size of the check box glyph is determined by the current visual style of the operating system.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns the size of the check box glyph.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.Drawing.Size" /> that represents the size of the check box glyph.</para>
</returns>
<param name="g">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Graphics" /> this operation will use.</param>
<param name="state">
<attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.VisualStyles.CheckBoxState" /> values that specifies the visual state of the check box.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="IsBackgroundPartiallyTransparent">
<MemberSignature Language="C#" Value="public static bool IsBackgroundPartiallyTransparent (System.Windows.Forms.VisualStyles.CheckBoxState state);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="state" Type="System.Windows.Forms.VisualStyles.CheckBoxState" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates whether the background of the check box has semitransparent or alpha-blended pieces.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the background of the check box has semitransparent or alpha-blended pieces; otherwise, false.</para>
</returns>
<param name="state">
<attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.VisualStyles.CheckBoxState" /> values that specifies the visual state of the check box.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="RenderMatchingApplicationState">
<MemberSignature Language="C#" Value="public static bool RenderMatchingApplicationState { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If the <see cref="P:System.Windows.Forms.CheckBoxRenderer.RenderMatchingApplicationState" /> property is true, the <see cref="T:System.Windows.Forms.CheckBoxRenderer" /> uses the setting from the <see cref="P:System.Windows.Forms.Application.RenderWithVisualStyles" /> property to determine the rendering style. If <see cref="P:System.Windows.Forms.CheckBoxRenderer.RenderMatchingApplicationState" /> is false, the renderer will always render using visual styles.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a value indicating whether the renderer uses the application state to determine rendering style.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>