![]() | Type | Description | ||
| Item as HITEM | A long value that indicates the handle of the item being formatted | |||
| ColIndex as Long | A long expression that indicates the column's index being formatted | |||
| Value as Variant | A Variant value that should be converted. |
Use the FormatColumn event to display a string different than the CellValue property. The FormatColumn event is fired only if the FireFormatColumn property of the Column is True. The FormatColumn event lets the user to provide the cell's caption before it is displayed on the control's list. For instance, the FormatColumn event is useful when the column cells contains prices( numbers ), and you want to display that column formatted as currency, like $50 instead 50. Also, you can use the FormatColumn event to display item's index in the column, or to display the result of some operations based on the cells in the item ( totals, currency conversion and so on ).
The following VB samples use the FormatCurrency function, to display a number as a currency. The FormatCurrency VB function returns an expression formatted as a currency value using the currency symbol defined in the system control panel.
Private Sub Grid1_FormatColumn(ByVal Item As EXGRIDLibCtl.HITEM, ByVal ColIndex As Long, Value As Variant)
On Error Resume Next
With Grid1
Value = FormatCurrency(Value)
End With
End Sub
The following VB sample formats a column that contains date values. The FormatDateTime function is a VB function that returns an expression formatted as a date or time:
Private Sub Grid1_FormatColumn(ByVal Item As EXGRIDLibCtl.HITEM, ByVal ColIndex As Long, Value As Variant)
On Error Resume Next
With Grid1
Value = FormatDateTime(Value, vbLongDate)
End With
End Sub
The following VB sample computes fields 1 + 2:
Private Sub Grid1_FormatColumn(ByVal Item As EXGRIDLibCtl.HITEM, ByVal ColIndex As Long, Value As Variant)
' Adds the first two columns, or concaternates the strings
On Error Resume Next
With Grid1.Items
Value = .CellValue(Item) + .CellValue(Item, 1)
End With
End Sub
The following C++ sample displays a date column using a format like "Saturday, March 10, 2004":
void OnFormatColumnGrid1(long Item, long ColIndex, VARIANT FAR* Value)
{
COleDateTime date( *Value );
COleVariant vtNewValue( date.Format( _T("%A, %B %d, %Y") ) );
VariantCopy( Value, vtNewValue );
}
The following VB.NET sample displays a date column using LongDate format:
Private Sub AxGrid1_FormatColumn(ByVal sender As Object, ByVal e As AxEXGRIDLib._IGridEvents_FormatColumnEvent) Handles AxGrid1.FormatColumn
e.value = DateTime.Parse(e.value).ToLongDateString()
End Sub
The following C# sample displays a date column using LongDate format:
private void axGrid1_FormatColumn(object sender, AxEXGRIDLib._IGridEvents_FormatColumnEvent e)
{
e.value = DateTime.Parse(e.value.ToString()).ToLongDateString();
}
The following VFP sample displays the item's index using the FormatColumn event:
*** ActiveX Control Event *** LPARAMETERS item, colindex, value with thisform.Grid1.Items .DefaultItem = item value = .ItemToIndex(0) endwith
before running the sample please make sure that the :
application.AutoYield = .f.
is called during the Form.Init event.