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

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="DataGridViewTopLeftHeaderCell" FullName="System.Windows.Forms.DataGridViewTopLeftHeaderCell">
   3   <TypeSignature Language="C#" Value="public class DataGridViewTopLeftHeaderCell : System.Windows.Forms.DataGridViewColumnHeaderCell" />
   4   <AssemblyInfo>
   5     <AssemblyName>System.Windows.Forms</AssemblyName>
   6     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   7   </AssemblyInfo>
   8   <Base>
   9     <BaseTypeName>System.Windows.Forms.DataGridViewColumnHeaderCell</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>Clicking on the top left header cell selects all of the cells in the <see cref="T:System.Windows.Forms.DataGridView" />.</para>
  17     </remarks>
  18     <summary>
  19       <attribution license="cc4" from="Microsoft" modified="false" />
  20       <para>Represents the cell in the top left corner of the <see cref="T:System.Windows.Forms.DataGridView" /> that sits above the row headers and to the left of the column headers.</para>
  21     </summary>
  22   </Docs>
  23   <Members>
  24     <Member MemberName=".ctor">
  25       <MemberSignature Language="C#" Value="public DataGridViewTopLeftHeaderCell ();" />
  26       <MemberType>Constructor</MemberType>
  27       <Parameters />
  28       <Docs>
  29         <remarks>To be added.</remarks>
  30         <since version=".NET 2.0" />
  31         <summary>
  32           <attribution license="cc4" from="Microsoft" modified="false" />
  33           <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.DataGridViewTopLeftHeaderCell" /> class.</para>
  34         </summary>
  35       </Docs>
  36       <AssemblyInfo>
  37         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  38       </AssemblyInfo>
  39     </Member>
  40     <Member MemberName="CreateAccessibilityInstance">
  41       <MemberSignature Language="C#" Value="protected override System.Windows.Forms.AccessibleObject CreateAccessibilityInstance ();" />
  42       <MemberType>Method</MemberType>
  43       <ReturnValue>
  44         <ReturnType>System.Windows.Forms.AccessibleObject</ReturnType>
  45       </ReturnValue>
  46       <Parameters />
  47       <Docs>
  48         <since version=".NET 2.0" />
  49         <remarks>
  50           <attribution license="cc4" from="Microsoft" modified="false" />
  51           <para>If you do not explicitly call the <see cref="M:System.Windows.Forms.DataGridViewTopLeftHeaderCell.CreateAccessibilityInstance" /> method, it will be called when the <see cref="P:System.Windows.Forms.DataGridViewCell.AccessibilityObject" /> property is referenced.</para>
  52           <block subset="none" type="note">
  53             <para>To get or set <see cref="P:System.Windows.Forms.DataGridViewCell.AccessibilityObject" />, you must add a reference to the Accessibility assembly installed with the .NET Framework.</para>
  54           </block>
  55         </remarks>
  56         <summary>
  57           <attribution license="cc4" from="Microsoft" modified="false" />
  58           <para>Creates a new accessible object for the <see cref="T:System.Windows.Forms.DataGridViewTopLeftHeaderCell" />. </para>
  59         </summary>
  60         <returns>
  61           <attribution license="cc4" from="Microsoft" modified="false" />
  62           <para>A new <see cref="T:System.Windows.Forms.DataGridViewTopLeftHeaderCell.DataGridViewTopLeftHeaderCellAccessibleObject" /> for the <see cref="T:System.Windows.Forms.DataGridViewTopLeftHeaderCell" />. </para>
  63         </returns>
  64       </Docs>
  65       <AssemblyInfo>
  66         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  67       </AssemblyInfo>
  68     </Member>
  69     <Member MemberName="GetContentBounds">
  70       <MemberSignature Language="C#" Value="protected override System.Drawing.Rectangle GetContentBounds (System.Drawing.Graphics graphics, System.Windows.Forms.DataGridViewCellStyle cellStyle, int rowIndex);" />
  71       <MemberType>Method</MemberType>
  72       <ReturnValue>
  73         <ReturnType>System.Drawing.Rectangle</ReturnType>
  74       </ReturnValue>
  75       <Parameters>
  76         <Parameter Name="graphics" Type="System.Drawing.Graphics" />
  77         <Parameter Name="cellStyle" Type="System.Windows.Forms.DataGridViewCellStyle" />
  78         <Parameter Name="rowIndex" Type="System.Int32" />
  79       </Parameters>
  80       <Docs>
  81         <since version=".NET 2.0" />
  82         <remarks>
  83           <attribution license="cc4" from="Microsoft" modified="false" />
  84           <para>The size of the cell's contents is computed dynamically when this method is called. </para>
  85           <para>This method is called internally when the <see cref="P:System.Windows.Forms.DataGridViewCell.ContentBounds" /> property is read.</para>
  86         </remarks>
  87         <summary>
  88           <attribution license="cc4" from="Microsoft" modified="false" />
  89           <para>Returns the bounding rectangle that encloses the cell's content area, which is calculated using the specified <see cref="T:System.Drawing.Graphics" /> object and cell style.</para>
  90         </summary>
  91         <returns>
  92           <attribution license="cc4" from="Microsoft" modified="false" />
  93           <para>The <see cref="T:System.Drawing.Rectangle" /> that bounds the cell's contents.</para>
  94         </returns>
  95         <param name="graphics">
  96           <attribution license="cc4" from="Microsoft" modified="false" />The graphics context for the cell.</param>
  97         <param name="cellStyle">
  98           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.DataGridViewCellStyle" /> to be applied to the cell.</param>
  99         <param name="rowIndex">
 100           <attribution license="cc4" from="Microsoft" modified="false" />The index of the cell's parent row.</param>
 101       </Docs>
 102       <AssemblyInfo>
 103         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 104       </AssemblyInfo>
 105     </Member>
 106     <Member MemberName="GetErrorIconBounds">
 107       <MemberSignature Language="C#" Value="protected override System.Drawing.Rectangle GetErrorIconBounds (System.Drawing.Graphics graphics, System.Windows.Forms.DataGridViewCellStyle cellStyle, int rowIndex);" />
 108       <MemberType>Method</MemberType>
 109       <ReturnValue>
 110         <ReturnType>System.Drawing.Rectangle</ReturnType>
 111       </ReturnValue>
 112       <Parameters>
 113         <Parameter Name="graphics" Type="System.Drawing.Graphics" />
 114         <Parameter Name="cellStyle" Type="System.Windows.Forms.DataGridViewCellStyle" />
 115         <Parameter Name="rowIndex" Type="System.Int32" />
 116       </Parameters>
 117       <Docs>
 118         <since version=".NET 2.0" />
 119         <remarks>
 120           <attribution license="cc4" from="Microsoft" modified="false" />
 121           <para>The size of the cell's error icon area is computed dynamically when this method is called. </para>
 122           <para>This method is called internally when the <see cref="P:System.Windows.Forms.DataGridViewCell.ErrorIconBounds" /> property is read.</para>
 123         </remarks>
 124         <summary>
 125           <attribution license="cc4" from="Microsoft" modified="false" />
 126           <para>Returns the bounding rectangle that encloses the cell's error icon, if one is displayed.</para>
 127         </summary>
 128         <returns>
 129           <attribution license="cc4" from="Microsoft" modified="false" />
 130           <para>The <see cref="T:System.Drawing.Rectangle" /> that bounds the cell's error icon, if one is displayed; otherwise, <see cref="F:System.Drawing.Rectangle.Empty" />.</para>
 131         </returns>
 132         <param name="graphics">
 133           <attribution license="cc4" from="Microsoft" modified="false" />The graphics context for the cell.</param>
 134         <param name="cellStyle">
 135           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.DataGridViewCellStyle" /> to be applied to the cell.</param>
 136         <param name="rowIndex">
 137           <attribution license="cc4" from="Microsoft" modified="false" />The index of the cell's parent row.</param>
 138       </Docs>
 139       <AssemblyInfo>
 140         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 141       </AssemblyInfo>
 142     </Member>
 143     <Member MemberName="GetPreferredSize">
 144       <MemberSignature Language="C#" Value="protected override System.Drawing.Size GetPreferredSize (System.Drawing.Graphics graphics, System.Windows.Forms.DataGridViewCellStyle cellStyle, int rowIndex, System.Drawing.Size constraintSize);" />
 145       <MemberType>Method</MemberType>
 146       <ReturnValue>
 147         <ReturnType>System.Drawing.Size</ReturnType>
 148       </ReturnValue>
 149       <Parameters>
 150         <Parameter Name="graphics" Type="System.Drawing.Graphics" />
 151         <Parameter Name="cellStyle" Type="System.Windows.Forms.DataGridViewCellStyle" />
 152         <Parameter Name="rowIndex" Type="System.Int32" />
 153         <Parameter Name="constraintSize" Type="System.Drawing.Size" />
 154       </Parameters>
 155       <Docs>
 156         <since version=".NET 2.0" />
 157         <remarks>
 158           <attribution license="cc4" from="Microsoft" modified="false" />
 159           <para>This method relies on the <see cref="M:System.Windows.Forms.DataGridViewCell.GetFormattedValue(System.Object,System.Int32,System.Windows.Forms.DataGridViewCellStyle@,System.ComponentModel.TypeConverter,System.ComponentModel.TypeConverter,System.Windows.Forms.DataGridViewDataErrorContexts)" /> method.</para>
 160         </remarks>
 161         <summary>
 162           <attribution license="cc4" from="Microsoft" modified="false" />
 163           <para>Calculates the preferred size, in pixels, of the cell.</para>
 164         </summary>
 165         <returns>
 166           <attribution license="cc4" from="Microsoft" modified="false" />
 167           <para>A <see cref="T:System.Drawing.Size" /> that represents the preferred size, in pixels, of the cell.</para>
 168         </returns>
 169         <param name="graphics">
 170           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Graphics" /> used to draw the cell.</param>
 171         <param name="cellStyle">
 172           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.DataGridViewCellStyle" /> that represents the style of the cell.</param>
 173         <param name="rowIndex">
 174           <attribution license="cc4" from="Microsoft" modified="false" />The zero-based row index of the cell.</param>
 175         <param name="constraintSize">
 176           <attribution license="cc4" from="Microsoft" modified="false" />The cell's maximum allowable size.</param>
 177       </Docs>
 178       <AssemblyInfo>
 179         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 180       </AssemblyInfo>
 181     </Member>
 182     <Member MemberName="Paint">
 183       <MemberSignature Language="C#" Value="protected override void Paint (System.Drawing.Graphics graphics, System.Drawing.Rectangle clipBounds, System.Drawing.Rectangle cellBounds, int rowIndex, System.Windows.Forms.DataGridViewElementStates cellState, object value, object formattedValue, string errorText, System.Windows.Forms.DataGridViewCellStyle cellStyle, System.Windows.Forms.DataGridViewAdvancedBorderStyle advancedBorderStyle, System.Windows.Forms.DataGridViewPaintParts paintParts);" />
 184       <MemberType>Method</MemberType>
 185       <ReturnValue>
 186         <ReturnType>System.Void</ReturnType>
 187       </ReturnValue>
 188       <Parameters>
 189         <Parameter Name="graphics" Type="System.Drawing.Graphics" />
 190         <Parameter Name="clipBounds" Type="System.Drawing.Rectangle" />
 191         <Parameter Name="cellBounds" Type="System.Drawing.Rectangle" />
 192         <Parameter Name="rowIndex" Type="System.Int32" />
 193         <Parameter Name="cellState" Type="System.Windows.Forms.DataGridViewElementStates" />
 194         <Parameter Name="value" Type="System.Object" />
 195         <Parameter Name="formattedValue" Type="System.Object" />
 196         <Parameter Name="errorText" Type="System.String" />
 197         <Parameter Name="cellStyle" Type="System.Windows.Forms.DataGridViewCellStyle" />
 198         <Parameter Name="advancedBorderStyle" Type="System.Windows.Forms.DataGridViewAdvancedBorderStyle" />
 199         <Parameter Name="paintParts" Type="System.Windows.Forms.DataGridViewPaintParts" />
 200       </Parameters>
 201       <Docs>
 202         <remarks>To be added.</remarks>
 203         <since version=".NET 2.0" />
 204         <summary>
 205           <attribution license="cc4" from="Microsoft" modified="false" />
 206           <para>Paints the current <see cref="T:System.Windows.Forms.DataGridViewTopLeftHeaderCell" />.</para>
 207         </summary>
 208         <param name="graphics">
 209           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Graphics" /> used to paint the <see cref="T:System.Windows.Forms.DataGridViewCell" />.</param>
 210         <param name="clipBounds">
 211           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Drawing.Rectangle" /> that represents the area of the <see cref="T:System.Windows.Forms.DataGridView" /> that needs to be repainted.</param>
 212         <param name="cellBounds">
 213           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Drawing.Rectangle" /> that contains the bounds of the <see cref="T:System.Windows.Forms.DataGridViewCell" /> that is being painted.</param>
 214         <param name="rowIndex">
 215           <attribution license="cc4" from="Microsoft" modified="false" />The row index of the cell that is being painted.</param>
 216         <param name="cellState">
 217           <attribution license="cc4" from="Microsoft" modified="false" />A bitwise combination of <see cref="T:System.Windows.Forms.DataGridViewElementStates" /> values that specifies the state of the cell.</param>
 218         <param name="value">
 219           <attribution license="cc4" from="Microsoft" modified="false" />The data of the <see cref="T:System.Windows.Forms.DataGridViewCell" /> that is being painted.</param>
 220         <param name="formattedValue">
 221           <attribution license="cc4" from="Microsoft" modified="false" />The formatted data of the <see cref="T:System.Windows.Forms.DataGridViewCell" /> that is being painted.</param>
 222         <param name="errorText">
 223           <attribution license="cc4" from="Microsoft" modified="false" />An error message that is associated with the cell.</param>
 224         <param name="cellStyle">
 225           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.DataGridViewCellStyle" /> that contains formatting and style information about the cell.</param>
 226         <param name="advancedBorderStyle">
 227           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Windows.Forms.DataGridViewAdvancedBorderStyle" /> that contains border styles for the cell that is being painted.</param>
 228         <param name="paintParts">
 229           <attribution license="cc4" from="Microsoft" modified="false" />A bitwise combination of the <see cref="T:System.Windows.Forms.DataGridViewPaintParts" /> values that specifies which parts of the cell need to be painted.</param>
 230       </Docs>
 231       <AssemblyInfo>
 232         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 233       </AssemblyInfo>
 234     </Member>
 235     <Member MemberName="PaintBorder">
 236       <MemberSignature Language="C#" Value="protected override void PaintBorder (System.Drawing.Graphics graphics, System.Drawing.Rectangle clipBounds, System.Drawing.Rectangle bounds, System.Windows.Forms.DataGridViewCellStyle cellStyle, System.Windows.Forms.DataGridViewAdvancedBorderStyle advancedBorderStyle);" />
 237       <MemberType>Method</MemberType>
 238       <ReturnValue>
 239         <ReturnType>System.Void</ReturnType>
 240       </ReturnValue>
 241       <Parameters>
 242         <Parameter Name="graphics" Type="System.Drawing.Graphics" />
 243         <Parameter Name="clipBounds" Type="System.Drawing.Rectangle" />
 244         <Parameter Name="bounds" Type="System.Drawing.Rectangle" />
 245         <Parameter Name="cellStyle" Type="System.Windows.Forms.DataGridViewCellStyle" />
 246         <Parameter Name="advancedBorderStyle" Type="System.Windows.Forms.DataGridViewAdvancedBorderStyle" />
 247       </Parameters>
 248       <Docs>
 249         <param name="graphics">To be added.</param>
 250         <param name="clipBounds">To be added.</param>
 251         <param name="bounds">To be added.</param>
 252         <param name="cellStyle">To be added.</param>
 253         <param name="advancedBorderStyle">To be added.</param>
 254         <summary>To be added.</summary>
 255         <remarks>To be added.</remarks>
 256         <since version=".NET 2.0" />
 257       </Docs>
 258       <AssemblyInfo>
 259         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 260       </AssemblyInfo>
 261     </Member>
 262     <Member MemberName="ToString">
 263       <MemberSignature Language="C#" Value="public override string ToString ();" />
 264       <MemberType>Method</MemberType>
 265       <ReturnValue>
 266         <ReturnType>System.String</ReturnType>
 267       </ReturnValue>
 268       <Parameters />
 269       <Docs>
 270         <remarks>To be added.</remarks>
 271         <since version=".NET 2.0" />
 272         <summary>
 273           <attribution license="cc4" from="Microsoft" modified="false" />
 274           <para>Returns the string representation of the cell.</para>
 275         </summary>
 276         <returns>
 277           <attribution license="cc4" from="Microsoft" modified="false" />
 278           <para>A string that represents the current cell.</para>
 279         </returns>
 280       </Docs>
 281       <AssemblyInfo>
 282         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 283       </AssemblyInfo>
 284     </Member>
 285   </Members>
 286 </Type>