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

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="DataGridViewButtonColumn" FullName="System.Windows.Forms.DataGridViewButtonColumn">
   3   <TypeSignature Language="C#" Value="public class DataGridViewButtonColumn : System.Windows.Forms.DataGridViewColumn" />
   4   <AssemblyInfo>
   5     <AssemblyName>System.Windows.Forms</AssemblyName>
   6     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   7   </AssemblyInfo>
   8   <Base>
   9     <BaseTypeName>System.Windows.Forms.DataGridViewColumn</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.DataGridViewButtonColumn" /> class is a specialized type of the <see cref="T:System.Windows.Forms.DataGridViewColumn" /> class used to logically host cells that respond to simple user input. A <see cref="T:System.Windows.Forms.DataGridViewButtonColumn" /> has an associated <see cref="T:System.Windows.Forms.DataGridViewButtonCell" /> in every <see cref="T:System.Windows.Forms.DataGridViewRow" /> that intersects it. Each cell supplies a user interface (UI) that is similar to a <see cref="T:System.Windows.Forms.Button" /> control.</para>
  17       <para>To display the same button text for every cell, set the <see cref="P:System.Windows.Forms.DataGridViewButtonColumn.UseColumnTextForButtonValue" /> property to true and set the <see cref="P:System.Windows.Forms.DataGridViewButtonColumn.Text" /> property to the desired button text. </para>
  18       <para>The default sort mode for this column type is <see cref="F:System.Windows.Forms.DataGridViewColumnSortMode.NotSortable" />.</para>
  19       <para>To respond to user button clicks, handle the <see cref="E:System.Windows.Forms.DataGridView.CellClick" /> or <see cref="E:System.Windows.Forms.DataGridView.CellContentClick" /> event. In the event handler, you can use the <see cref="P:System.Windows.Forms.DataGridViewCellEventArgs.ColumnIndex" /> property to determine whether the click occurred in the button column. You can use the <see cref="P:System.Windows.Forms.DataGridViewCellEventArgs.RowIndex" /> property to determine whether the click occurred in a button cell and not on the column header. </para>
  20       <block subset="none" type="note">
  21         <para>When visual styles are enabled, the buttons in a button column are painted using a <see cref="T:System.Windows.Forms.ButtonRenderer" />, and cell styles specified through properties such as <see cref="P:System.Windows.Forms.DataGridViewButtonColumn.DefaultCellStyle" /> have no effect. </para>
  22       </block>
  23     </remarks>
  24     <summary>
  25       <attribution license="cc4" from="Microsoft" modified="false" />
  26       <para>Hosts a collection of <see cref="T:System.Windows.Forms.DataGridViewButtonCell" /> objects.</para>
  27     </summary>
  28   </Docs>
  29   <Members>
  30     <Member MemberName=".ctor">
  31       <MemberSignature Language="C#" Value="public DataGridViewButtonColumn ();" />
  32       <MemberType>Constructor</MemberType>
  33       <Parameters />
  34       <Docs>
  35         <since version=".NET 2.0" />
  36         <remarks>
  37           <attribution license="cc4" from="Microsoft" modified="false" />
  38           <para>This constructor initializes the column by setting the following properties. </para>
  39           <list type="table">
  40             <listheader>
  41               <item>
  42                 <term>
  43                   <para>Property </para>
  44                 </term>
  45                 <description>
  46                   <para>Value </para>
  47                 </description>
  48               </item>
  49             </listheader>
  50             <item>
  51               <term>
  52                 <para>
  53                   <see cref="P:System.Windows.Forms.DataGridViewButtonColumn.CellTemplate" /> </para>
  54               </term>
  55               <description>
  56                 <para>A new <see cref="T:System.Windows.Forms.DataGridViewButtonCell" />.</para>
  57               </description>
  58             </item>
  59             <item>
  60               <term>
  61                 <para>The <see cref="P:System.Windows.Forms.DataGridViewCellStyle.Alignment" /> property of the <see cref="T:System.Windows.Forms.DataGridViewCellStyle" /> object returned by the <see cref="P:System.Windows.Forms.DataGridViewButtonColumn.DefaultCellStyle" /> property.</para>
  62               </term>
  63               <description>
  64                 <para>
  65                   <see cref="F:System.Windows.Forms.DataGridViewContentAlignment.MiddleCenter" />
  66                 </para>
  67               </description>
  68             </item>
  69           </list>
  70         </remarks>
  71         <summary>
  72           <attribution license="cc4" from="Microsoft" modified="false" />
  73           <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.DataGridViewButtonColumn" /> class to the default state.</para>
  74         </summary>
  75       </Docs>
  76       <AssemblyInfo>
  77         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  78       </AssemblyInfo>
  79     </Member>
  80     <Member MemberName="CellTemplate">
  81       <MemberSignature Language="C#" Value="public override System.Windows.Forms.DataGridViewCell CellTemplate { set; get; }" />
  82       <MemberType>Property</MemberType>
  83       <ReturnValue>
  84         <ReturnType>System.Windows.Forms.DataGridViewCell</ReturnType>
  85       </ReturnValue>
  86       <Docs>
  87         <value>To be added.</value>
  88         <since version=".NET 2.0" />
  89         <remarks>
  90           <attribution license="cc4" from="Microsoft" modified="false" />
  91           <para>The constructor for the <see cref="T:System.Windows.Forms.DataGridViewButtonColumn" /> class initializes this property to a newly created <see cref="T:System.Windows.Forms.DataGridViewButtonCell" />.</para>
  92           <block subset="none" type="note">
  93             <para>Changing the properties of the cell template will not immediately affect the user interface (UI) of the column's existing cells. These changes are only apparent after the column is regenerated (for example, by sorting the column or through a call to the <see cref="M:System.Windows.Forms.DataGridView.InvalidateColumn(System.Int32)" /> method).</para>
  94           </block>
  95         </remarks>
  96         <summary>
  97           <attribution license="cc4" from="Microsoft" modified="false" />
  98           <para>Gets or sets the template used to create new cells.</para>
  99         </summary>
 100       </Docs>
 101       <AssemblyInfo>
 102         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 103       </AssemblyInfo>
 104       <Attributes>
 105         <Attribute>
 106           <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
 107         </Attribute>
 108         <Attribute>
 109           <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
 110         </Attribute>
 111       </Attributes>
 112     </Member>
 113     <Member MemberName="Clone">
 114       <MemberSignature Language="C#" Value="public override object Clone ();" />
 115       <MemberType>Method</MemberType>
 116       <ReturnValue>
 117         <ReturnType>System.Object</ReturnType>
 118       </ReturnValue>
 119       <Parameters />
 120       <Docs>
 121         <since version=".NET 2.0" />
 122         <remarks>
 123           <attribution license="cc4" from="Microsoft" modified="false" />
 124           <para>Use this method to duplicate a column of button cells. </para>
 125         </remarks>
 126         <summary>
 127           <attribution license="cc4" from="Microsoft" modified="false" />
 128           <para>Creates an exact copy of this column.</para>
 129         </summary>
 130         <returns>
 131           <attribution license="cc4" from="Microsoft" modified="false" />
 132           <para>An <see cref="T:System.Object" /> that represents the cloned <see cref="T:System.Windows.Forms.DataGridViewButtonColumn" />.</para>
 133         </returns>
 134       </Docs>
 135       <AssemblyInfo>
 136         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 137       </AssemblyInfo>
 138     </Member>
 139     <Member MemberName="DefaultCellStyle">
 140       <MemberSignature Language="C#" Value="public override System.Windows.Forms.DataGridViewCellStyle DefaultCellStyle { set; get; }" />
 141       <MemberType>Property</MemberType>
 142       <ReturnValue>
 143         <ReturnType>System.Windows.Forms.DataGridViewCellStyle</ReturnType>
 144       </ReturnValue>
 145       <Docs>
 146         <value>To be added.</value>
 147         <since version=".NET 2.0" />
 148         <remarks>
 149           <attribution license="cc4" from="Microsoft" modified="false" />
 150           <para>The default <see cref="T:System.Windows.Forms.DataGridViewCellStyle" /> returned by this property has an initial <see cref="P:System.Windows.Forms.DataGridViewCellStyle.Alignment" /> property value of <see cref="F:System.Windows.Forms.DataGridViewContentAlignment.MiddleCenter" />. This value overrides the value specified in the <see cref="P:System.Windows.Forms.DataGridView.DefaultCellStyle" /> property of the <see cref="T:System.Windows.Forms.DataGridView" /> control, but may be overridden by other cell style properties. For more information, see <format type="text/html"><a href="dbb75ed6-8804-4232-8382-f9920c2e380c">Cell Styles in the Windows Forms DataGridView Control</a></format>.</para>
 151           <block subset="none" type="note">
 152             <para>When visual styles are enabled, the buttons in a button column are painted using a <see cref="T:System.Windows.Forms.ButtonRenderer" /> and cell styles specified through properties such as <see cref="P:System.Windows.Forms.DataGridViewButtonColumn.DefaultCellStyle" /> have no effect. </para>
 153           </block>
 154         </remarks>
 155         <summary>
 156           <attribution license="cc4" from="Microsoft" modified="false" />
 157           <para>Gets or sets the column's default cell style.</para>
 158         </summary>
 159       </Docs>
 160       <AssemblyInfo>
 161         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 162       </AssemblyInfo>
 163       <Attributes>
 164         <Attribute>
 165           <AttributeName>System.ComponentModel.Browsable(true)</AttributeName>
 166         </Attribute>
 167       </Attributes>
 168     </Member>
 169     <Member MemberName="FlatStyle">
 170       <MemberSignature Language="C#" Value="public System.Windows.Forms.FlatStyle FlatStyle { set; get; }" />
 171       <MemberType>Property</MemberType>
 172       <ReturnValue>
 173         <ReturnType>System.Windows.Forms.FlatStyle</ReturnType>
 174       </ReturnValue>
 175       <Docs>
 176         <value>To be added.</value>
 177         <since version=".NET 2.0" />
 178         <remarks>
 179           <attribution license="cc4" from="Microsoft" modified="false" />
 180           <para>The <see cref="P:System.Windows.Forms.DataGridViewButtonColumn.FlatStyle" /> property specifies the appearance of the cells in the column. For more information, see the <see cref="T:System.Windows.Forms.FlatStyle" /> enumeration.</para>
 181           <para>Getting or setting this property gets or sets the <see cref="P:System.Windows.Forms.DataGridViewButtonCell.FlatStyle" /> property of the object returned by the <see cref="P:System.Windows.Forms.DataGridViewButtonColumn.CellTemplate" /> property. Setting this property also sets the <see cref="P:System.Windows.Forms.DataGridViewButtonCell.FlatStyle" /> property of every cell in the column and refreshes the column display. To override the specified value for individual cells, set the cell values after you set the column value.</para>
 182         </remarks>
 183         <summary>
 184           <attribution license="cc4" from="Microsoft" modified="false" />
 185           <para>Gets or sets the flat-style appearance of the button cells in the column.</para>
 186         </summary>
 187       </Docs>
 188       <AssemblyInfo>
 189         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 190       </AssemblyInfo>
 191       <Attributes>
 192         <Attribute>
 193           <AttributeName>System.ComponentModel.DefaultValue(System.Windows.Forms.FlatStyle.Standard)</AttributeName>
 194         </Attribute>
 195       </Attributes>
 196     </Member>
 197     <Member MemberName="Text">
 198       <MemberSignature Language="C#" Value="public string Text { set; get; }" />
 199       <MemberType>Property</MemberType>
 200       <ReturnValue>
 201         <ReturnType>System.String</ReturnType>
 202       </ReturnValue>
 203       <Docs>
 204         <value>To be added.</value>
 205         <since version=".NET 2.0" />
 206         <remarks>
 207           <attribution license="cc4" from="Microsoft" modified="false" />
 208           <para>Each <see cref="T:System.Windows.Forms.DataGridViewButtonCell" /> contained in the column that has as a <see cref="P:System.Windows.Forms.DataGridViewButtonCell.UseColumnTextForButtonValue" /> property value of true displays the <see cref="P:System.Windows.Forms.DataGridViewButtonColumn.Text" /> property value on the cell's button.</para>
 209           <para>If there is an associated <see cref="T:System.Windows.Forms.DataGridView" /> control, changing this property refreshes the column display.</para>
 210         </remarks>
 211         <summary>
 212           <attribution license="cc4" from="Microsoft" modified="false" />
 213           <para>Gets or sets the default text displayed on the button cell.</para>
 214         </summary>
 215       </Docs>
 216       <AssemblyInfo>
 217         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 218       </AssemblyInfo>
 219       <Attributes>
 220         <Attribute>
 221           <AttributeName>System.ComponentModel.DefaultValue(null)</AttributeName>
 222         </Attribute>
 223       </Attributes>
 224     </Member>
 225     <Member MemberName="ToString">
 226       <MemberSignature Language="C#" Value="public override string ToString ();" />
 227       <MemberType>Method</MemberType>
 228       <ReturnValue>
 229         <ReturnType>System.String</ReturnType>
 230       </ReturnValue>
 231       <Parameters />
 232       <Docs>
 233         <summary>To be added.</summary>
 234         <returns>To be added.</returns>
 235         <remarks>To be added.</remarks>
 236         <since version=".NET 2.0" />
 237       </Docs>
 238       <AssemblyInfo>
 239         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 240       </AssemblyInfo>
 241     </Member>
 242     <Member MemberName="UseColumnTextForButtonValue">
 243       <MemberSignature Language="C#" Value="public bool UseColumnTextForButtonValue { set; get; }" />
 244       <MemberType>Property</MemberType>
 245       <ReturnValue>
 246         <ReturnType>System.Boolean</ReturnType>
 247       </ReturnValue>
 248       <Docs>
 249         <value>To be added.</value>
 250         <since version=".NET 2.0" />
 251         <remarks>
 252           <attribution license="cc4" from="Microsoft" modified="false" />
 253           <para>By default, the <see cref="P:System.Windows.Forms.DataGridViewCell.FormattedValue" /> of a button cell is displayed as the text on the button. The <see cref="P:System.Windows.Forms.DataGridViewButtonColumn.UseColumnTextForButtonValue" /> property allows you to either set the button text for each cell, or to use the <see cref="P:System.Windows.Forms.DataGridViewButtonColumn.Text" /> property value for all of the button cells. </para>
 254           <para>Getting or setting this property gets or sets the <see cref="P:System.Windows.Forms.DataGridViewButtonCell.UseColumnTextForButtonValue" /> property of the object returned by the <see cref="P:System.Windows.Forms.DataGridViewButtonColumn.CellTemplate" /> property. Setting this property also sets the <see cref="P:System.Windows.Forms.DataGridViewButtonCell.UseColumnTextForButtonValue" /> property of every cell in the column and refreshes the column display. To override the specified value for individual cells, set the cell values after you set the column value.</para>
 255         </remarks>
 256         <summary>
 257           <attribution license="cc4" from="Microsoft" modified="false" />
 258           <para>Gets or sets a value indicating whether the <see cref="P:System.Windows.Forms.DataGridViewButtonColumn.Text" /> property value is displayed as the button text for cells in this column.</para>
 259         </summary>
 260       </Docs>
 261       <AssemblyInfo>
 262         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 263       </AssemblyInfo>
 264       <Attributes>
 265         <Attribute>
 266           <AttributeName>System.ComponentModel.DefaultValue(false)</AttributeName>
 267         </Attribute>
 268       </Attributes>
 269     </Member>
 270   </Members>
 271   <Attributes>
 272     <Attribute>
 273       <AttributeName>System.Drawing.ToolboxBitmap("")</AttributeName>
 274     </Attribute>
 275   </Attributes>
 276 </Type>