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

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="DataGridViewCellToolTipTextNeededEventArgs" FullName="System.Windows.Forms.DataGridViewCellToolTipTextNeededEventArgs">
   3   <TypeSignature Language="C#" Value="public class DataGridViewCellToolTipTextNeededEventArgs : System.Windows.Forms.DataGridViewCellEventArgs" />
   4   <AssemblyInfo>
   5     <AssemblyName>System.Windows.Forms</AssemblyName>
   6     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   7   </AssemblyInfo>
   8   <Base>
   9     <BaseTypeName>System.Windows.Forms.DataGridViewCellEventArgs</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="E:System.Windows.Forms.DataGridView.CellToolTipTextNeeded" /> event occurs only when the <see cref="T:System.Windows.Forms.DataGridView" /> control <see cref="P:System.Windows.Forms.DataGridView.DataSource" /> property is set or its <see cref="P:System.Windows.Forms.DataGridView.VirtualMode" /> property is true.</para>
  17       <para>When you handle the <see cref="E:System.Windows.Forms.DataGridView.CellToolTipTextNeeded" /> event, the ToolTip text you specify in the handler is shown whenever the mouse pointer is over a cell and the control <see cref="P:System.Windows.Forms.DataGridView.ShowCellToolTips" /> property value is true. The <see cref="E:System.Windows.Forms.DataGridView.CellToolTipTextNeeded" /> event is useful when you want to display ToolTips determined by the current state or value of a cell. </para>
  18       <para>The <see cref="E:System.Windows.Forms.DataGridView.CellToolTipTextNeeded" /> event also occurs whenever the value of the <see cref="P:System.Windows.Forms.DataGridViewCell.ToolTipText" /> property is retrieved, either programmatically or when the mouse pointer enters a cell. </para>
  19       <para>You can use the <see cref="P:System.Windows.Forms.DataGridViewCellEventArgs.ColumnIndex" /> and <see cref="P:System.Windows.Forms.DataGridViewCellEventArgs.RowIndex" /> properties to determine the state or value of a cell, and use this information to set the <see cref="P:System.Windows.Forms.DataGridViewCellToolTipTextNeededEventArgs.ToolTipText" /> property. This property is initialized with the value of the cell <see cref="P:System.Windows.Forms.DataGridViewCell.ToolTipText" /> property, which the event value overrides.</para>
  20       <para>Handle the <see cref="E:System.Windows.Forms.DataGridView.CellToolTipTextNeeded" /> event when working with large amounts of data to avoid the performance penalties of setting the cell <see cref="P:System.Windows.Forms.DataGridViewCell.ToolTipText" /> value for multiple cells. For more information, see <format type="text/html"><a href="8321a8a6-6340-4fd1-b475-fa090b905aaf">Best Practices for Scaling the Windows Forms DataGridView Control</a></format>.</para>
  21       <para>For more information about handling events, see <format type="text/html"><a href="01e4f1bc-e55e-413f-98c7-6588493e5f67">Consuming Events</a></format>.</para>
  22     </remarks>
  23     <summary>
  24       <attribution license="cc4" from="Microsoft" modified="false" />
  25       <para>Provides data for the <see cref="E:System.Windows.Forms.DataGridView.CellToolTipTextNeeded" /> event. </para>
  26     </summary>
  27   </Docs>
  28   <Members>
  29     <Member MemberName="ToolTipText">
  30       <MemberSignature Language="C#" Value="public string ToolTipText { set; get; }" />
  31       <MemberType>Property</MemberType>
  32       <ReturnValue>
  33         <ReturnType>System.String</ReturnType>
  34       </ReturnValue>
  35       <Docs>
  36         <value>To be added.</value>
  37         <since version=".NET 2.0" />
  38         <remarks>
  39           <attribution license="cc4" from="Microsoft" modified="false" />
  40           <para>This property initially contains the value of the <see cref="P:System.Windows.Forms.DataGridViewCell.ToolTipText" /> property if it has been set for a cell. </para>
  41         </remarks>
  42         <summary>
  43           <attribution license="cc4" from="Microsoft" modified="false" />
  44           <para>Gets or sets the ToolTip text.</para>
  45         </summary>
  46       </Docs>
  47       <AssemblyInfo>
  48         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  49       </AssemblyInfo>
  50     </Member>
  51   </Members>
  52 </Type>