mcs/class/Managed.Windows.Forms/Documentation/en/System.Windows.Forms/MeasureItemEventArgs.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="MeasureItemEventArgs" FullName="System.Windows.Forms.MeasureItemEventArgs">
   3   <TypeSignature Language="C#" Value="public class MeasureItemEventArgs : EventArgs" />
   4   <AssemblyInfo>
   5     <AssemblyName>System.Windows.Forms</AssemblyName>
   6     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   7     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   8   </AssemblyInfo>
   9   <Base>
  10     <BaseTypeName>System.EventArgs</BaseTypeName>
  11   </Base>
  12   <Interfaces />
  13   <Docs>
  14     <remarks>
  15       <attribution license="cc4" from="Microsoft" modified="false" />
  16       <para>This event is sent when the OwnerDraw property of <see cref="T:System.Windows.Forms.ListBox" />, <see cref="T:System.Windows.Forms.ComboBox" />, <see cref="T:System.Windows.Forms.CheckedListBox" />, or <see cref="T:System.Windows.Forms.MenuItem" /> is set to true. It is used to tell the drawing function how to size an item.</para>
  17       <para>For information about the event model, see <format type="text/html"><a href="D98FD58B-FA4F-4598-8378-ADDF4355A115">[&lt;topic://cpconEventsDelegates&gt;]</a></format>.</para>
  18     </remarks>
  19     <summary>
  20       <attribution license="cc4" from="Microsoft" modified="false" />
  21       <para>Provides data for the MeasureItem event of the <see cref="T:System.Windows.Forms.ListBox" />, <see cref="T:System.Windows.Forms.ComboBox" />, <see cref="T:System.Windows.Forms.CheckedListBox" />, and <see cref="T:System.Windows.Forms.MenuItem" /> controls.</para>
  22     </summary>
  23   </Docs>
  24   <Members>
  25     <Member MemberName=".ctor">
  26       <MemberSignature Language="C#" Value="public MeasureItemEventArgs (System.Drawing.Graphics graphics, int index);" />
  27       <MemberType>Constructor</MemberType>
  28       <Parameters>
  29         <Parameter Name="graphics" Type="System.Drawing.Graphics" />
  30         <Parameter Name="index" Type="System.Int32" />
  31       </Parameters>
  32       <Docs>
  33         <remarks>To be added.</remarks>
  34         <summary>
  35           <attribution license="cc4" from="Microsoft" modified="false" />
  36           <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.MeasureItemEventArgs" /> class.</para>
  37         </summary>
  38         <param name="graphics">
  39           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Graphics" /> object being written to. </param>
  40         <param name="index">
  41           <attribution license="cc4" from="Microsoft" modified="false" />The index of the item for which you need the height or width. </param>
  42       </Docs>
  43       <AssemblyInfo>
  44         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  45         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  46       </AssemblyInfo>
  47     </Member>
  48     <Member MemberName=".ctor">
  49       <MemberSignature Language="C#" Value="public MeasureItemEventArgs (System.Drawing.Graphics graphics, int index, int itemHeight);" />
  50       <MemberType>Constructor</MemberType>
  51       <Parameters>
  52         <Parameter Name="graphics" Type="System.Drawing.Graphics" />
  53         <Parameter Name="index" Type="System.Int32" />
  54         <Parameter Name="itemHeight" Type="System.Int32" />
  55       </Parameters>
  56       <Docs>
  57         <remarks>To be added.</remarks>
  58         <summary>
  59           <attribution license="cc4" from="Microsoft" modified="false" />
  60           <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.MeasureItemEventArgs" /> class providing a parameter for the item height.</para>
  61         </summary>
  62         <param name="graphics">
  63           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Graphics" /> object being written to. </param>
  64         <param name="index">
  65           <attribution license="cc4" from="Microsoft" modified="false" />The index of the item for which you need the height or width. </param>
  66         <param name="itemHeight">
  67           <attribution license="cc4" from="Microsoft" modified="false" />The height of the item to measure relative to the <paramref name="graphics" /> object. </param>
  68       </Docs>
  69       <AssemblyInfo>
  70         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  71         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  72       </AssemblyInfo>
  73     </Member>
  74     <Member MemberName="Graphics">
  75       <MemberSignature Language="C#" Value="public System.Drawing.Graphics Graphics { get; }" />
  76       <MemberType>Property</MemberType>
  77       <ReturnValue>
  78         <ReturnType>System.Drawing.Graphics</ReturnType>
  79       </ReturnValue>
  80       <Docs>
  81         <value>To be added.</value>
  82         <remarks>
  83           <attribution license="cc4" from="Microsoft" modified="false" />
  84           <para>You use a <see cref="T:System.Drawing.Graphics" /> object to determine the scale to use when setting the <see cref="P:System.Windows.Forms.MeasureItemEventArgs.ItemHeight" /> and <see cref="P:System.Windows.Forms.MeasureItemEventArgs.ItemWidth" />. Different types of graphics objects can have different scales, such as the difference in measurement scale between a monitor screen and a printer.</para>
  85         </remarks>
  86         <summary>
  87           <attribution license="cc4" from="Microsoft" modified="false" />
  88           <para>Gets the <see cref="T:System.Drawing.Graphics" /> object to measure against.</para>
  89         </summary>
  90       </Docs>
  91       <AssemblyInfo>
  92         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  93         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  94       </AssemblyInfo>
  95     </Member>
  96     <Member MemberName="Index">
  97       <MemberSignature Language="C#" Value="public int Index { get; }" />
  98       <MemberType>Property</MemberType>
  99       <ReturnValue>
 100         <ReturnType>System.Int32</ReturnType>
 101       </ReturnValue>
 102       <Docs>
 103         <value>To be added.</value>
 104         <remarks>To be added.</remarks>
 105         <summary>
 106           <attribution license="cc4" from="Microsoft" modified="false" />
 107           <para>Gets the index of the item for which the height and width is needed.</para>
 108         </summary>
 109       </Docs>
 110       <AssemblyInfo>
 111         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 112         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 113       </AssemblyInfo>
 114     </Member>
 115     <Member MemberName="ItemHeight">
 116       <MemberSignature Language="C#" Value="public int ItemHeight { set; get; }" />
 117       <MemberType>Property</MemberType>
 118       <ReturnValue>
 119         <ReturnType>System.Int32</ReturnType>
 120       </ReturnValue>
 121       <Docs>
 122         <value>To be added.</value>
 123         <remarks>To be added.</remarks>
 124         <summary>
 125           <attribution license="cc4" from="Microsoft" modified="false" />
 126           <para>Gets or sets the height of the item specified by the <see cref="P:System.Windows.Forms.MeasureItemEventArgs.Index" />.</para>
 127         </summary>
 128       </Docs>
 129       <AssemblyInfo>
 130         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 131         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 132       </AssemblyInfo>
 133     </Member>
 134     <Member MemberName="ItemWidth">
 135       <MemberSignature Language="C#" Value="public int ItemWidth { set; get; }" />
 136       <MemberType>Property</MemberType>
 137       <ReturnValue>
 138         <ReturnType>System.Int32</ReturnType>
 139       </ReturnValue>
 140       <Docs>
 141         <value>To be added.</value>
 142         <remarks>
 143           <attribution license="cc4" from="Microsoft" modified="false" />
 144           <para>This member is only used by <see cref="T:System.Windows.Forms.MenuItem" />. You use this property to ensure the menu is at least as wide as the widest menu item in the menu list.</para>
 145         </remarks>
 146         <summary>
 147           <attribution license="cc4" from="Microsoft" modified="false" />
 148           <para>Gets or sets the width of the item specified by the <see cref="P:System.Windows.Forms.MeasureItemEventArgs.Index" />.</para>
 149         </summary>
 150       </Docs>
 151       <AssemblyInfo>
 152         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 153         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 154       </AssemblyInfo>
 155     </Member>
 156   </Members>
 157 </Type>