ToolTipText プロパティ (HeaderBase)

ユーザーがヘッダーの上にマウスを置いたときに表示するツールヒントを指定します。

シンタックス

Visual Basic

'宣言
 
Public Property ToolTipText As String

C#

public string ToolTipText {get; set;}

解説

ユーザーがヘッダーの上にマウスを置いたときに表示するツールヒントを指定します。このプロパティが null または空の文字列に設定されている場合、ツールヒントは表示されません。

使用例

Visual Basic

Imports Infragistics.Shared
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinGrid


    Private Sub Button1_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles button1.Click

        ' Add a summary.
        Dim summary As SummarySettings = _
            Me.ultraGrid1.DisplayLayout.Bands(0).Summaries.Add("sum", _
            SummaryType.Sum, _
            Me.ultraGrid1.DisplayLayout.Bands(0).Columns(0), _
            SummaryPosition.UseSummaryPositionColumn)

        ' Set the tooltip on the summary settings object.
        summary.ToolTipText = String.Format("Sum of column {0}.", summary.SourceColumn.Header.Caption)

        ' Tooltip can be set on individual summary value objects as well, in case  you
        ' want to display a different tooltip based on the calculated value. A good place
        ' to set such summary value specific tool tips is in SummaryValueChanged event.
        Me.ultraGrid1.Rows.SummaryValues("sum").ToolTipText = String.Format("Sum of column {0}.", summary.SourceColumn.Header.Caption)

        ' Set tool tips on headers.
        Dim col As UltraGridColumn
        For Each col In Me.ultraGrid1.DisplayLayout.Bands(0).Columns
            col.Header.ToolTipText = String.Format("Sample tool tip for {0} column.", col.Header.Caption)
        Next

        ' Set tool tips on rows.
        Dim row As UltraGridRow
        For Each row In Me.ultraGrid1.Rows
            row.ToolTipText = String.Format("Sample tool tip for {0} index row.", row.Index)

            ' Tool tip can be set on individual cells as well.
            row.Cells(0).ToolTipText = "Sample cell tool tip."
        Next
    End Sub

C#

using Infragistics.Shared;
using Infragistics.Win;
using Infragistics.Win.UltraWinGrid;
using System.Diagnostics;


		private void button1_Click(object sender, System.EventArgs e)
		{
			// Add a summary.
			SummarySettings summary =
				this.ultraGrid1.DisplayLayout.Bands[0].Summaries.Add( "sum",
				SummaryType.Sum, 
				this.ultraGrid1.DisplayLayout.Bands[0].Columns[0], 
				SummaryPosition.UseSummaryPositionColumn );

			// Set the tooltip on the summary settings object.
			summary.ToolTipText = string.Format( "Sum of column {0}.", summary.SourceColumn.Header.Caption );

			// Tooltip can be set on individual summary value objects as well, in case  you
			// want to display a different tooltip based on the calculated value. A good place
			// to set such summary value specific tool tips is in SummaryValueChanged event.
			this.ultraGrid1.Rows.SummaryValues[ "sum" ].ToolTipText = string.Format( "Sum of column {0}.", summary.SourceColumn.Header.Caption );

			// Set tool tips on headers.
			foreach ( UltraGridColumn col in this.ultraGrid1.DisplayLayout.Bands[0].Columns )
			{
				col.Header.ToolTipText = string.Format( "Sample tool tip for {0} column.", col.Header.Caption );
			}

			// Set tool tips on rows.
			foreach ( UltraGridRow row in this.ultraGrid1.Rows )
			{
				row.ToolTipText = string.Format( "Sample tool tip for {0} index row.", row.Index );

				// Tool tip can be set on individual cells as well.
				row.Cells[0].ToolTipText = "Sample cell tool tip.";
			}
		}