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

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="DataGridViewTextBoxColumn" FullName="System.Windows.Forms.DataGridViewTextBoxColumn">
   3   <TypeSignature Language="C#" Value="public class DataGridViewTextBoxColumn : 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.DataGridViewTextBoxColumn" /> class is a specialized type of <see cref="T:System.Windows.Forms.DataGridViewColumn" /> class used to logically host cells that enable displaying and editing of text strings. A <see cref="T:System.Windows.Forms.DataGridViewTextBoxColumn" /> has an associated <see cref="T:System.Windows.Forms.DataGridViewTextBoxCell" /> object in every <see cref="T:System.Windows.Forms.DataGridViewRow" /> that intersects it. When a <see cref="T:System.Windows.Forms.DataGridViewTextBoxCell" /> becomes activated, it supplies a <see cref="T:System.Windows.Forms.DataGridViewTextBoxEditingControl" /> control to handle user input.</para>
  17       <para>The sort mode for this column type defaults to <see cref="F:System.Windows.Forms.DataGridViewColumnSortMode.Automatic" />.</para>
  18     </remarks>
  19     <summary>
  20       <attribution license="cc4" from="Microsoft" modified="false" />
  21       <para>Hosts a collection of <see cref="T:System.Windows.Forms.DataGridViewTextBoxCell" /> cells.</para>
  22     </summary>
  23   </Docs>
  24   <Members>
  25     <Member MemberName=".ctor">
  26       <MemberSignature Language="C#" Value="public DataGridViewTextBoxColumn ();" />
  27       <MemberType>Constructor</MemberType>
  28       <Parameters />
  29       <Docs>
  30         <since version=".NET 2.0" />
  31         <remarks>
  32           <attribution license="cc4" from="Microsoft" modified="false" />
  33           <para>This constructor initializes the column by setting the following properties. </para>
  34           <list type="table">
  35             <listheader>
  36               <item>
  37                 <term>
  38                   <para>Property </para>
  39                 </term>
  40                 <description>
  41                   <para>Value </para>
  42                 </description>
  43               </item>
  44             </listheader>
  45             <item>
  46               <term>
  47                 <para>
  48                   <see cref="P:System.Windows.Forms.DataGridViewTextBoxColumn.CellTemplate" /> </para>
  49               </term>
  50               <description>
  51                 <para>A newly created <see cref="T:System.Windows.Forms.DataGridViewTextBoxCell" />. </para>
  52               </description>
  53             </item>
  54             <item>
  55               <term>
  56                 <para>
  57                   <see cref="P:System.Windows.Forms.DataGridViewTextBoxColumn.SortMode" />
  58                 </para>
  59               </term>
  60               <description>
  61                 <para>
  62                   <see cref="F:System.Windows.Forms.DataGridViewColumnSortMode.Automatic" /> </para>
  63               </description>
  64             </item>
  65           </list>
  66         </remarks>
  67         <summary>
  68           <attribution license="cc4" from="Microsoft" modified="false" />
  69           <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.DataGridViewTextBoxColumn" /> class to the default state.</para>
  70         </summary>
  71       </Docs>
  72       <AssemblyInfo>
  73         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  74       </AssemblyInfo>
  75     </Member>
  76     <Member MemberName="CellTemplate">
  77       <MemberSignature Language="C#" Value="public override System.Windows.Forms.DataGridViewCell CellTemplate { set; get; }" />
  78       <MemberType>Property</MemberType>
  79       <ReturnValue>
  80         <ReturnType>System.Windows.Forms.DataGridViewCell</ReturnType>
  81       </ReturnValue>
  82       <Docs>
  83         <value>To be added.</value>
  84         <since version=".NET 2.0" />
  85         <remarks>
  86           <attribution license="cc4" from="Microsoft" modified="false" />
  87           <para>The constructor for the <see cref="T:System.Windows.Forms.DataGridViewTextBoxColumn" /> class initializes this property to a newly created <see cref="T:System.Windows.Forms.DataGridViewTextBoxCell" />.</para>
  88           <block subset="none" type="note">
  89             <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>
  90           </block>
  91         </remarks>
  92         <summary>
  93           <attribution license="cc4" from="Microsoft" modified="false" />
  94           <para>Gets or sets the template used to model cell appearance.</para>
  95         </summary>
  96       </Docs>
  97       <AssemblyInfo>
  98         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  99       </AssemblyInfo>
 100       <Attributes>
 101         <Attribute>
 102           <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
 103         </Attribute>
 104         <Attribute>
 105           <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
 106         </Attribute>
 107       </Attributes>
 108     </Member>
 109     <Member MemberName="MaxInputLength">
 110       <MemberSignature Language="C#" Value="public int MaxInputLength { set; get; }" />
 111       <MemberType>Property</MemberType>
 112       <ReturnValue>
 113         <ReturnType>System.Int32</ReturnType>
 114       </ReturnValue>
 115       <Docs>
 116         <value>To be added.</value>
 117         <since version=".NET 2.0" />
 118         <remarks>
 119           <attribution license="cc4" from="Microsoft" modified="false" />
 120           <para>The <see cref="P:System.Windows.Forms.DataGridViewTextBoxColumn.MaxInputLength" /> property does not affect the length of text entered programmatically through the cell's value or through cell formatting. It affects only what the user can input and edit.</para>
 121           <para>Getting or setting this property gets or sets the <see cref="P:System.Windows.Forms.DataGridViewTextBoxCell.MaxInputLength" /> property of the object returned by the <see cref="P:System.Windows.Forms.DataGridViewTextBoxColumn.CellTemplate" /> property. Setting this property also sets the <see cref="P:System.Windows.Forms.DataGridViewTextBoxCell.MaxInputLength" /> property of every cell in the column. To override the specified value for individual cells, set the cell values after you set the column value.</para>
 122         </remarks>
 123         <summary>
 124           <attribution license="cc4" from="Microsoft" modified="false" />
 125           <para>Gets or sets the maximum number of characters that can be entered into the text box.</para>
 126         </summary>
 127       </Docs>
 128       <AssemblyInfo>
 129         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 130       </AssemblyInfo>
 131       <Attributes>
 132         <Attribute>
 133           <AttributeName>System.ComponentModel.DefaultValue(32767)</AttributeName>
 134         </Attribute>
 135       </Attributes>
 136     </Member>
 137     <Member MemberName="SortMode">
 138       <MemberSignature Language="C#" Value="public System.Windows.Forms.DataGridViewColumnSortMode SortMode { set; get; }" />
 139       <MemberType>Property</MemberType>
 140       <ReturnValue>
 141         <ReturnType>System.Windows.Forms.DataGridViewColumnSortMode</ReturnType>
 142       </ReturnValue>
 143       <Docs>
 144         <value>To be added.</value>
 145         <since version=".NET 2.0" />
 146         <remarks>
 147           <attribution license="cc4" from="Microsoft" modified="false" />
 148           <para>When a <see cref="T:System.Windows.Forms.DataGridView" /> control is sorted using a column with a <see cref="P:System.Windows.Forms.DataGridViewTextBoxColumn.SortMode" /> property value of <see cref="F:System.Windows.Forms.DataGridViewColumnSortMode.Automatic" />, a sorting glyph is automatically displayed in the column header.</para>
 149           <para>When the control is sorted using a column with a <see cref="P:System.Windows.Forms.DataGridViewTextBoxColumn.SortMode" /> property value of <see cref="F:System.Windows.Forms.DataGridViewColumnSortMode.Programmatic" />, you must display the sorting glyph yourself through the <see cref="P:System.Windows.Forms.DataGridViewColumnHeaderCell.SortGlyphDirection" /> property.</para>
 150           <para>The default sort mode of a <see cref="T:System.Windows.Forms.DataGridViewTextBoxColumn" /> is <see cref="F:System.Windows.Forms.DataGridViewColumnSortMode.Automatic" />. The default sort mode for other column types is <see cref="F:System.Windows.Forms.DataGridViewColumnSortMode.NotSortable" />.</para>
 151           <para>The <see cref="P:System.Windows.Forms.DataGridViewTextBoxColumn.SortMode" /> value does not prevent you from sorting a column programmatically, although other restrictions may apply. For more information, see the <see cref="Overload:System.Windows.Forms.DataGridView.Sort" /> method.</para>
 152           <para>A <see cref="P:System.Windows.Forms.DataGridViewTextBoxColumn.SortMode" /> property value of <see cref="F:System.Windows.Forms.DataGridViewColumnSortMode.NotSortable" /> will not prevent the <see cref="E:System.Windows.Forms.DataGridView.ColumnHeaderMouseClick" /> event from occurring, but it will prevent the header from changing its appearance when it is clicked.</para>
 153         </remarks>
 154         <summary>
 155           <attribution license="cc4" from="Microsoft" modified="false" />
 156           <para>Gets or sets the sort mode for the column.</para>
 157         </summary>
 158       </Docs>
 159       <AssemblyInfo>
 160         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 161       </AssemblyInfo>
 162       <Attributes>
 163         <Attribute>
 164           <AttributeName>System.ComponentModel.DefaultValue(System.Windows.Forms.DataGridViewColumnSortMode.Automatic)</AttributeName>
 165         </Attribute>
 166       </Attributes>
 167     </Member>
 168     <Member MemberName="ToString">
 169       <MemberSignature Language="C#" Value="public override string ToString ();" />
 170       <MemberType>Method</MemberType>
 171       <ReturnValue>
 172         <ReturnType>System.String</ReturnType>
 173       </ReturnValue>
 174       <Parameters />
 175       <Docs>
 176         <summary>To be added.</summary>
 177         <returns>To be added.</returns>
 178         <remarks>To be added.</remarks>
 179         <since version=".NET 2.0" />
 180       </Docs>
 181       <AssemblyInfo>
 182         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 183       </AssemblyInfo>
 184     </Member>
 185   </Members>
 186   <Attributes>
 187     <Attribute>
 188       <AttributeName>System.Drawing.ToolboxBitmap("")</AttributeName>
 189     </Attribute>
 190   </Attributes>
 191 </Type>