Xceed Grid for .NET

How to bring a grid element into view

Xceed admin — Tue, 22 Dec 2009 15:45:21 GMT

Each element in the grid can be brought to view using the BringIntoView method. This method will ensure that the grid element is brought into view no matter its state or its parent state. For example, if the grid element is in a collapsed group, the group will be expanded and the grid scrolled (if necessary) so that the grid element is made visible. The FirstVisibleRow and FirstVisibleColumn properties allow you to change the first/last visible row or column. Setting these properties will automatically bring the newly affected row or column into view. When setting the CurrentCell, CurrentColumn or CurrentRow properties as well as when calling the MoveCurrentCell, MoveCurrentRow and MoveCurrentColumn methods, the BringIntoView method must be called if you want to bring the new current object into view.

The following examples demonstrates how to bring various grid elements into view. Keep in mind that although the examples mostly use rows located within the grid's DataRows, any other type of row, located in any section of the grid or group (i.e., FixedHeaderRows, FooterRows, etc.) can be brought into view in the same manner.

VB.NET

GridControl1.Groups( GridControl1.Groups.Count - 1 ).BringIntoView()

GridControl1.FirstVisibleRow = GridControl1.DataRows( GridControl1.DataRows.Count - 1 )
GridControl1.FirstVisibleColumn = GridControl1.Columns( GridControl1.Columns.Count - 1 )

GridControl1.CurrentCell = GridControl1.DataRows( GridControl1.DataRows.Count - 1 ).Cells( GridControl1.Columns.Count - 1 )

GridControl1.CurrentCell.BringIntoView()

GridControl1.CurrentColumn = GridControl1.Columns( gridControl1.Columns.Count - 1 )
GridControl1.CurrentColumn.BringIntoView()

GridControl1.CurrentRow = GridControl1.DataRows( gridControl1.DataRows.Count - 1 )
GridControl1.CurrentRow.BringIntoView()

C#

gridControl1.Groups[ gridControl1.Groups.Count - 1 ].BringIntoView();

gridControl1.FirstVisibleRow = gridControl1.DataRows[ gridControl1.DataRows.Count - 1 ];
gridControl1.FirstVisibleColumn = gridControl1.Columns[ gridControl1.Columns.Count - 1 ];

gridControl1.CurrentCell = gridControl1.DataRows[ gridControl1.DataRows.Count - 1 ].Cells[ gridControl1.Columns.Count - 1 ];

gridControl1.CurrentCell.BringIntoView();

gridControl1.CurrentColumn = gridControl1.Columns[ gridControl1.Columns.Count - 1 ];
gridControl1.CurrentColumn.BringIntoView();

gridControl1.CurrentRow = gridControl1.DataRows[ gridControl1.DataRows.Count - 1 ];
gridControl1.CurrentRow.BringIntoView();

Highlighting the current cell

Xceed admin — Wed, 28 Jan 2009 19:36:36 GMT

You can use the CurrentCellChanged event and change the background color of the current cell; however, if you are using a Vista style, you will need to also override the UIStyle for this to works, since when choosing a style like AERO, it automatically sets many properties.

private void Form1_Load( object sender, EventArgs e )
{
gridControl1.CurrentCellChanged += new EventHandler( gridControl1_CurrentCellChanged );

//For a Vista theme
gridControl1.SelectionVisualStyle.OverrideUIStyle = true;
gridControl1.SelectionVisualStyle.BackColor = Color.FromArgb( 40, gridControl1.SelectionBackColor );
}

private DataCell previousCell;

void gridControl1_CurrentCellChanged( object sender, EventArgs e )
{
if( previousCell != null )
{
previousCell.BackColor = gridControl1.DataRowTemplate.BackColor;
}
if( gridControl1.CurrentCell.GetType() == typeof( DataCell ) )
{
gridControl1.CurrentCell.BackColor = Color.DeepPink;
}
previousCell = gridControl1.CurrentCell as DataCell;
}

Is it possible to provide custom sorting criteria?

Xceed admin — Fri, 10 Oct 2008 14:35:20 GMT

Any class that implements the IComparer interface can be used by Xceed Grid for .NET to custom sort columns. To assign a data comparer to a column, the column's DataComparer property must be set. This data comparer will then be used when sorting the column to which it was assigned. For example:

gridControl1.Columns[ "ShipAddress" ].DataComparer = new AddressComparer();

An example of a class that implements the IComparer interface is available below (see attachments).

The AddressComparer class will first sort addresses which begin with numeric values by street name and then civic number. The remainder of the addresses in the regular alphabetical fashion.

The current cell's ValueChanged event is not raised.

Xceed admin — Fri, 10 Oct 2008 14:34:39 GMT

The reason why the current cell's ValueChanged event is not raised is because you only subscribed to the ValueChanged event of the cell which was current at the time when the grid was loaded.

What you will need to do is to subscribe to the ValueChanged event of each cell in the grid (via the DataRowTemplate) and in the method that will handle the ValueChanged event (currentCell_ValueChanged) check to see if the sender is the current cell.

For example:

//If you are setting the DataSource property then this will need to be done between
// calls to the grid's BeginInit and EndInit methods.
gridControl1.BeginInit();

gridControl1.DataSource = dataSet11.Tables[ 0 ];

foreach( Xceed.Grid.DataCell cell in gridControl1.DataRowTemplate.Cells )
{
cell.ValueChanged += new EventHandler( this.currentCell_ValueChanged );
}

gridControl1.EndInit();

In the currentCell_ValueChanged method, you can then check if the cell whose value was changed is the current cell and if so do the appropriate processing.

private void currentCell_ValueChanged( object sender, EventArgs e )
{
    if( ( ( Xceed.Grid.DataCell )sender ).IsCurrent )
    {
        //your code
    }
}

How do I subscribe to the events of each cell?

Xceed admin — Fri, 10 Oct 2008 14:32:40 GMT

Subscribing to the desired events for each cell in the DataRowTemplate will, once the grid is populated, also subscribe each cell in the grid to the same events. However, in order to do this, the grid's DataSource must be set between calls to the BeginInit and EndInit methods.

When binding the grid to a data source by setting the DataSource and DataMember properties or calling the SetDataBinding method during calls to BeginInit and EndInit, the column definitions (not their values) are still read from the data source. This allows you to subscribe each cell in the DataRowTemplate to the desired events. For example:

VB.NET

GridControl1.BeginInit()

GridControl1.DataSource = DataSet11
GridControl1.DataMember = "Orders"

Dim cell As DataCell
For Each cell in GridControl1.DataRowTemplate.Cells
AddHandler cell.ValidationError, AddressOf Me.cell_ValidationError
Next cell

GridControl1.EndInit()

C#

gridControl1.BeginInit();

gridControl1.DataSource = dataSet11;
gridControl1.DataMember = "Orders";

foreach( DataCell cell in gridControl1.DataRowTemplate.Cells )
{
cell.ValidationError += new ValidationErrorEventHandler( this.cell_ValidationError );
}

gridControl1.EndInit();

How do I resize the grid and columns when the data is modified?

Xceed admin — Fri, 10 Oct 2008 14:30:04 GMT

Yes. In order to do so, you will need to subscribe to each of the columns' editors (by default a GridTextBox) TextChanged event in order to resize when a character is added or removed to or from a cell.

As for the resizing the grid, you would need to do the following to resize it so that all the columns are displayed:

int totalColWidth = 0;

foreach( Xceed.Grid.Column col in gridControl1.Columns )
{
totalColWidth = totalColWidth + col.Width;
}

gridControl1.Width = totalColWidth + gridControl1.RowSelectorPane.Width + gridControl1.ClientRectangle.Width - gridControl1.DisplayRectangle.Width;

A that demonstrates the required implementation is available for download (see attachments).

Does the Xceed FTP Library support SSH?

Xceed admin — Fri, 10 Oct 2008 14:00:19 GMT

Unfortunately, the Xceed FTP Library does not support SSH. Xceed Ftp for .NET does however support SSL and TLS.

How do I maintain the current row when the grid is sorted?

Xceed admin — Thu, 09 Oct 2008 19:12:49 GMT

It is possible to maintain the current row, however you will need to provide the implementation yourself. What you will need to do is the following:

1- Create a global member with a Xceed.Grid.Row datatype that will contain the current row.

2- Create a boolean global member that will act as a flag to determine when the current row has been changed.

3- Handle the grid's CurrentRowChanged event to set the new current row if it has changed.

4- Handle the grid's Sorted event to bring the current row into view.

Unable to change or assign borders.

Xceed admin — Thu, 09 Oct 2008 17:45:02 GMT

The row.Borders can not be changed since it is a read-only property. However, you can derive from the row you want and then override the Border property.

Don't forget to override the OnPaintBorders to paint what you want in your borders.

It is true that row.Borders.Bottom = ... will affect a copy of the returned Borders.

How can I make the InsertionRow insert its datarow programmatically?

Xceed admin — Thu, 09 Oct 2008 17:42:19 GMT

With version 1.0 of Xceed Grid for .NET it is not possible to make the InsertionRow insert its datarow programmatically.

As of version 1.1, the BeginEdit and EndEdit methods have been moved to the CellRow class rather than only the DataRow class meaning that you will only need to call the EndEdit method on the InsertionRow to commit the row.

How do I restrict the length and case of a cell's data?

Xceed admin — Thu, 09 Oct 2008 17:41:37 GMT

You can use the default TextEditor, which uses the WinTextBox underneath.

[C#]
gridControl1.Columns[ 0 ].CellEditorManager = new TextEditor( ">&&&&" );

You can also assign the viewer in the same way :

gridControl1.Columns[ 0 ].CellViewerManager = new TextViewer( ">&&&&" );

[VB.NET]
gridControl1.Columns( 0 ).CellEditorManager = new TextEditor( ">&&&&" )

You can also assign the viewer in the same way :

gridControl1.Columns( 0 ).CellViewerManager = new TextViewer( ">&&&&" )

How do I change the format of the text displayed in a cell?

Xceed admin — Thu, 09 Oct 2008 17:40:47 GMT

You can change the format of text displayed in a cell (or in an entire column) by creating a class that implements the IFormatProvider interface and assigning your custom class to the FormatProvider and FormatSpecifier properties of the desired cell or column.

For more information regarding the implementation of the IFormatProvider interface, go to the "Customizing Format Strings" topic of the .NET

How do I create my own stylesheet?

Xceed admin — Thu, 09 Oct 2008 17:40:00 GMT

You can create your own stylesheets by using StyleSheet class.

Just create an instance of the class and set the properties to the colors, etc.. you want. Once that is done, call the grid's ApplyStylesheet method with your stylesheet.

Dim styleSheet As New StyleSheet()

styleSheet.DataRows.Add(New VisualGridElementStyle())
styleSheet.DataRows.Add(New VisualGridElementStyle())

styleSheet.DataRows(0).BackColor = Color.Pink
styleSheet.DataRows(1).BackColor = Color.Green

' Don't forget to call the grid's ApplyStyleSheet
' method so that the new styles are reflected
' in the grid.
GridControl1.ApplyStyleSheet(styleSheet)

For more information, you can refer to theDataRowTemplate Stylestopic in the help file.

Alternating the color of datarows.

Xceed admin — Thu, 09 Oct 2008 17:39:38 GMT

You can use the DataRowTemplateStyles property or a StyleSheet to alternate the appearance of the DataRows.

Using the DataRowTemplatesStyles

gridControl1.DataRowTemplateStyles.Add( new VisualGridElementStyle() );

gridControl1.DataRowTemplateStyles.Add( new VisualGridElementStyle() );

gridControl1.DataRowTemplateStyles[ 0 ].BackColor = Color.Blue;

gridControl1.DataRowTemplateStyles[ 1 ].BackColor = Color.Red;

Using the StyleSheet

Dim styleSheet As New StyleSheet()

styleSheet.DataRows.Add(New VisualGridElementStyle())
styleSheet.DataRows.Add(New VisualGridElementStyle())

styleSheet.DataRows(0).BackColor = Color.Pink
styleSheet.DataRows(1).BackColor = Color.Green

' Don't forget to call the grid's ApplyStyleSheet
' method so that the new styles are reflected
' in the grid.
GridControl1.ApplyStyleSheet(styleSheet)

For more information, you can refer to theDataRowTemplate Stylestopic in the help file

Drag and drop operations onto the grid do not work.

Xceed admin — Thu, 09 Oct 2008 17:39:15 GMT

In order for the DragXYZ events to be raised when the item is dragged over a cell, each cell's AllowDrop property must be set to true.

If you only want to insert new rows when the item is dropped into the sections of the grid that do not contain rows, then you only need to set the grid's AllowDrop property to true.

If you want to be able to drop items anywhere on the grid, then each cell's AllowDropandthe grid's AllowDrop property must be set to true.

How to synchronize the scrolling of two grids

Xceed admin — Thu, 09 Oct 2008 17:30:08 GMT

You can synchronize the scrolling of two grid's using the FirstVisibleRowChanged and FirstVisibleColumnChanged events.

The following example demonstrates how to scroll the second grid ( gridControl2 ) in sync with the first grid (gridControl1). If you want to sync the scrolling of the first grid when the second grid is scrolled, then you will also need to handle the FirstVisibleRowChanged and FirstVisibleColumnChanged events of the second grid.

VB.NET

AddHandler GridControl1.FirstVisibleRowChanged, AddressOf Me.GridControl1_FirstVisibleRowChanged
AddHandler GridControl1.FirstVisibleColumnChanged, AddressOf Me.GridControl1_FirstVisibleColumnChanged

Private Sub GridControl1_FirstVisibleRowChanged(ByVal sender As Object, ByVal e As System.EventArgs)
GridControl2.FirstVisibleRow = gridControl2.DataRows( CType( GridControl1.FirstVisibleRow, Xceed.Grid.DataRow ).Index)
End Sub

Private Sub GridControl1_FirstVisibleColumnChanged(ByVal sender As Object, ByVal e As System.EventArgs)
If Not GridControl1.FirstVisibleColumn Is Nothing And Not GridControl2.FirstVisibleColumn Is Nothing Then
GridControl2.FirstVisibleColumn = GridControl2.Columns( GridControl1.FirstVisibleColumn.Index )
End If
End Sub

C#

gridControl1.FirstVisibleRowChanged += new EventHandler( this.gridControl1_FirstVisibleRowChanged );
gridControl1.FirstVisibleColumnChanged += new EventHandler( this.gridControl1_FirstVisibleColumnChanged );

private void gridControl1_FirstVisibleRowChanged(object sender, System.EventArgs e)
{
gridControl2.FirstVisibleRow = gridControl2.DataRows[ ( ( Xceed.Grid.DataRow )ridControl1.FirstVisibleRow ).Index ];
}

private void gridControl1_FirstVisibleColumnChanged(object sender, System.EventArgs e)
{
if( gridControl1.FirstVisibleColumn != null && gridControl2.FirstVisibleColumn != null )
gridControl2.FirstVisibleColumn = gridControl2.Columns[ gridControl1.FirstVisibleColumn.Index ];
}

How to fix (freeze) columns

Xceed admin — Thu, 09 Oct 2008 17:27:07 GMT

The following code demonstrates how to fix 2 columns programmatically.

VB.NET

Dim grid As New GridControl()

grid.Dock = DockStyle.Fill
Me.Controls.Add( grid )

grid.DataSource = dataSet11
grid.DataMember = "Orders"

grid.Columns( "OrderID" ).Fixed = True
grid.Columns( "EmployeeID" ).Fixed = True

C#

GridControl grid = new GridControl();

grid.Dock = DockStyle.Fill;
this.Controls.Add( grid );

grid.DataSource = dataSet11;
grid.DataMember = "Orders";

grid.Columns[ "OrderID" ].Fixed = true;
grid.Columns[ "EmployeeID" ].Fixed = true;

How to select a row(s) in code

Xceed admin — Thu, 09 Oct 2008 17:26:39 GMT

To select one or more rows in code, you can add (or remove) rows from grid's SelectedRows property. Any row can be selected and added to the grid's collection of SelectedRows as long as its CanBeSelected property is set to true. Keep in mind that the current row is not the same thing as the selected row and that the current row might not be part of the grid's selected rows.

VB.NET

GridControl1.SelectedRows.Add( GridControl1.DataRows( 0 ) )

Dim row As New TextRow( "This is my text row" )

row.CanBeSelected = True

GridControl1.FixedFooterRows.Add( row )
GridControl1.SelectedRows.Add( row )

C#

gridControl1.SelectedRows.Add( gridControl1.DataRows[ 0 ] );

TextRow row = new TextRow( "This is my text row" );

row.CanBeSelected = true;

gridControl1.FixedFooterRows.Add( row );
gridControl1.SelectedRows.Add( row );

How to change the height of rows

Xceed admin — Thu, 09 Oct 2008 17:19:00 GMT

The height of each row in the grid can be changed in various ways:

You can change the height of each row individually using the row's Height property.
You can change the height of each DataRow using the Height property of the grid's DataRowTemplate.
You can retrieve the height necessary to display all the content of the row or just one line of content using the GetFittedHeight method.
You can adjust the height of a row to fit its editors using the FitHeightToEditors property.
You can change the way the height of the row is adjusted using the AutoHeightMode property.

If you want to change the height of a specific row in the grid to a predetermined value, you simply need to set that row's Height property. If you want to set the height of all the DataRows in the grid, you can set the Height property of the DataRowTemplate to the desired value. The same goes with the AutoHeightMode and FitHeightToEditors property as well as the GetFittedHeight method.

To change the height of a specific row (using the various methods mentioned above) you can use the following code:

VB.NET

GridControl1.FixedHeaderRows[ 0 ].Height = 16
GridControl1.FixedFooterRows[ 1 ].AutoHeightMode = AutoHeightMode.AllContent

GridControl1.Groups[ 0 ].HeaderRows[ 0 ].Height = gridControl1.FixedHeaderRows[ 0 ].GetFittedHeight( AutoHeightMode.AllContent )
GridControl1.DataRows[ 0 ].FitHeightToEditors = True

C#

gridControl1.FixedHeaderRows[ 0 ].Height = 16;
gridControl1.FixedFooterRows[ 1 ].AutoHeightMode = AutoHeightMode.AllContent;

gridControl1.Groups[ 0 ].HeaderRows[ 0 ].Height = gridControl1.FixedHeaderRows[ 0 ].GetFittedHeight( AutoHeightMode.AllContent );
gridControl1.DataRows[ 0 ].FitHeightToEditors = true;

To change the height of every DataRow in the grid, the most efficient way is to use the DataRowTemplate. Of course you can use any one of the properties or methods mentioned above! For example:

VB.NET

GridControl1.DataRowTemplate.Height = 16

C#

gridControl1.DataRowTemplate.Height = 16;

If the DataRowTemplate changes while the DataSource property is set, the changes will not automatically be reflected in the grid. In order for the modifications to be applied, the data source must be reassigned to the DataSource property. If you want to set various properties of the DataRowTemplate when you populate your grid (set the DataSource property), then this will need to be done between calls to the grid's BeginInit and EndInit methods.

VB.NET

GridControl1.BeginInit()
GridControl1.DataSource = DataSet11.Tables( 0 )
GridControl1.DataRowTemplate.FitHeightToEditors = True
GridControl1.EndInit()

C#

gridControl1.BeginInit();
gridControl1.DataSource = dataSet11.Tables[ 0 ];
gridControl1.DataRowTemplate.FitHeightToEditors = true;
gridControl1.EndInit();

How to copy and paste rows to and from a grid

Xceed admin — Thu, 09 Oct 2008 17:15:57 GMT

The grid does not provide built-in functionality to copy and paste or drag and drop rows to and from another application such as Excel, however it is quite easy for you to implement (a sample is provided below). In order to copy rows from a grid you need to:

Handle the keyboard shortcuts (Ctrl-C, Ctrl-V, etc.).
You need to create a DataObject that will contain a compatible DataFormat. For example plain text, CSV or HTML data formats are all supported by Excel.
Once you have your DataObject, you can place it in the ClipBoard using the ClipBoard class's SetDataObject method.

You can then paste your result into Excel or any other application that supports the data formats you provided. In order to paste rows into a grid you need to:

Retrieve the DataObject in the ClipBoard using the DataObject's GetData method. You can decide which data format you want to use. The easiest one to use with the grid is plain text (DataFormats.PlainText).
Once you have your DataObject, you will need to parse it and retrieve the data.
Once you have retrieved your data, add the new rows to the grid.

How to drag and drop rows to and from a grid

Xceed admin — Thu, 09 Oct 2008 17:15:45 GMT

Handle each cell's MouseDown, MouseUp and MouseMove events.
In the MouseMove event, once you have determined that the mouse has moved while the mouse button was pressed, you need to create a DataObject that will contain a compatible DataFormat. For example plain text, CSV or HTML data formats are all supported by Excel.
Once you have your DataObject, call the grid's DoDragDrop method.

You can then drag your rows into Excel or any other application that supports the data formats you provided. In order to drop rows onto a grid you need to:

Handle each cell's DragOver and DragDrop events.
You must set the AllowDrop property of each cell as well as the AllowDrop property of the grid to true.
Retrieve the DataObject being dropped using the DataObject's GetData method. You can decide which data format you want to use. The easiest one to use with the grid is plain text (DataFormats.PlainText).
Once you have your DataObject, you will need to parse it and retrieve the data.
Once you have retrieved your data, add the new rows to the grid.

How to display a description rather than an ID

Xceed admin — Thu, 09 Oct 2008 17:15:34 GMT

In order to display a description rather than an ID, you will need to use the ComboBoxViewer and the ComboBoxEditor. This is done by binding the ComboBoxViewer and ComboBoxEditor to the table that contains the ID's descriptions and to set its DisplayFormat and ValueMember properties.

The following example demonstrates how to display a description (rather than an ID) using the ComboBoxViewer and ComboBoxEditor.

VB.NET

Dim viewer As New Xceed.Grid.Viewers.ComboBoxViewer( northwindDataSet, "Products", "ProductID", "%ProductName%" )
Dim editor As New Xceed.Grid.Editors.ComboBoxEditor( northwindDataSet, "Products", "ProductID", "%ProductName%" )

GridControl1.Columns( "ProductID" ).CellEditorManager = editor
GridControl1.Columns( "ProductID" ).CellViewerManager = viewer

C#

Xceed.Grid.Viewers.ComboBoxViewer viewer = new Xceed.Grid.Viewers.ComboBoxViewer( northwindDataSet, "Products", "ProductID", "%ProductName%" );
Xceed.Grid.Editors.ComboBoxEditor editor = new Xceed.Grid.Editors.ComboBoxEditor( northwindDataSet, "Products", "ProductID", "%ProductName%" );

gridControl1.Columns[ "ProductID" ].CellEditorManager = editor;
gridControl1.Columns[ "ProductID" ].CellViewerManager = viewer;

How to delete a row when the Delete key is pressed

Xceed admin — Thu, 09 Oct 2008 17:15:05 GMT

Any row can be deleted from the grid using the row's Remove method, however rows will not be automatically deleted when the delete key is pressed. In order to delete rows from the grid when the delete key is pressed, you need to handle the KeyDown event of the DataRowTemplate (for each DataRow in the grid) and the KeyDown event of any other row that you want to allow your end-users to delete. In the event handler, you can then check if the key that was pressed is the delete key and then remove the row from the grid.

In the following example, we check to see if it was the delete key that was pressed. If it was, we check to make sure that the row is a DataRow and then we delete the row. The validation to check if the row is a DataRow is not necessary; Any type of row can be deleted using the Remove method.

VB.NET

If e.KeyData = Keys.Delete Then
If TypeOf sender Is Xceed.Grid.DataRow Then
CType(sender, Xceed.Grid.DataRow).Remove()
End If
End If

C#

if( e.KeyData == Keys.Delete )
{
if( sender is Xceed.Grid.DataRow )
{
( ( Xceed.Grid.DataRow )sender ).Remove();
}
}

How to print page numbers

Xceed admin — Thu, 09 Oct 2008 17:12:28 GMT

By default, the grid is not printed with page numbers. In order to include page numbers when printing, you will need to create a class that derives from the GridPrintDocument class and override the OnPrintPage method (to be able to custom print the header or footer in this case, or other items if desired).

The following example demonstrates the minimum implementation required in order to print page numbers when printing the grid.

VB.NET

Imports Xceed.Grid

Public Class CustomGridPrintDocument
Inherits GridPrintDocument

Private m_grid As GridControl

Public Sub New(ByVal grid As GridControl)
MyBase.New(grid)
m_grid = grid
End Sub

Protected Overrides Sub OnPrintPage(ByVal e As System.Drawing.Printing.PrintPageEventArgs)
      Dim gc As GraphicsContainer = e.Graphics.BeginContainer()

      Try
         MyBase.OnPrintPage( e )
      Finally
         e.Graphics.EndContainer(gc)
      End Try

      ' Print added text boxes (header and footers)
      If Not e.Cancel And Me.IsCurrentPrintingPageSelected Then
        Dim brush As New System.Drawing.SolidBrush(Color.Black)

        e.Graphics.DrawString("Page number " +  Me.CurrentPageNumber.ToString(), m_grid.Font, brush, New RectangleF(e.MarginBounds.X, e.MarginBounds.Y - 20, e.MarginBounds.Width, e.MarginBounds.Height))
        brush.Dispose()
      End If
End Sub
End Class

C#

using Xceed.Grid;

public class CustomGridPrintDocument : GridPrintDocument
{
private GridControl m_grid;

public CustomGridPrintDocument( GridControl grid )
    :base( grid )
{
    m_grid = grid;
}

protected override void OnPrintPage( System.Drawing.Printing.PrintPageEventArgs e )
{
    GraphicsContainer gc = e.Graphics.BeginContainer();

    try
    {
      base.OnPrintPage( e );
    }
    finally
    {
      e.Graphics.EndContainer( gc );
    }

    // Print page number
    if( !e.Cancel )
    {
      using( System.Drawing.SolidBrush brush = new System.Drawing.SolidBrush( Color.Black ) )
      {
        e.Graphics.DrawString("Page number " + this.CurrentPageNumber.ToString(), m_grid.Font, brush, new RectangleF( e.MarginBounds.X, e.MarginBounds.Y - 20, e.MarginBounds.Width, e.MarginBounds.Height ) );
      }
    }
}
}

To use the custom GridPrintDocument, the following code must be used:

VB.NET

Dim printDocument As New CustomGridPrintDocument(GridControl1)
printDocument.Print()

C#

CustomGridPrintDocument printDocument = new CustomGridPrintDocument( gridControl1 );
printDocument.Print();

Keep in mind that if you call the grid's Print or PrintPreview methods, the grid will always be printed with the default print document.

How to print a range of pages

Xceed admin — Thu, 09 Oct 2008 17:12:16 GMT

If you use the grid's Print method, the entire grid will be printed unless you create a GridPrintDocument object, set its properties and call its Print method instead. By setting the GridPrintDocument's PrinterSettings.FromPage and .ToPage to define the range of pages to print. If you want to decide on a page-by-page basis, you must handle the QueryPrintPage event where you can set the IsPageSelected boolean to decide if that page should be printed.

VB.NET

Dim printDocument As New GridPrintDocument(GridControl1)

printDocument.PrinterSettings.PrintRange = Drawing.Printing.PrintRange.SomePages
printDocument.PrinterSettings.FromPage = 2
printDocument.PrinterSettings.ToPage = 5

printDocument.Print()

C#

GridPrintDocument printDocument = New GridPrintDocument(GridControl1);

printDocument.PrinterSettings.PrintRange = Drawing.Printing.PrintRange.SomePages;
printDocument.PrinterSettings.FromPage = 2;
printDocument.PrinterSettings.ToPage = 5;

printDocument.Print();

How to print the grid in landscape orientation

Xceed admin — Thu, 09 Oct 2008 17:12:05 GMT

By default, the grid will always be printed in portrait orientation. In order to print the grid in landscape orientation, you need to create a new instance of the GridPrintDocument class and set the DefaultPageSettings.Landscape property to true.

VB.NET

Dim print As New GridPrintDocument(GridControl1)

print.DefaultPageSettings.Landscape = True
print.Print()

C#

GridPrintDocument print = new GridPrintDocument( gridControl1 );

print.DefaultPageSettings.Landscape = true;
print.Print();

Keep in mind that if you call the grid's Print or PrintPreview methods, the grid will always be printed with the default print document (and therefore in portrait orientation).

How to select the printer and page settings

Xceed admin — Thu, 09 Oct 2008 17:11:55 GMT

In order to allow you users to select the printer and page settings you must use the PageSetupDialog component provided by Microsoft and create a new instance of the GridPrintDocument class. The following example demonstrates how to allow your users to select the printer and page settings when printing the grid. It assumes that you have a PageSetupDialog component on your form.

VB.NET

' Allow the user to select the page settings and the printer
Dim oPrintDoc As New Xceed.Grid.GridPrintDocument(GridControl1)

PageSetupDialog1.PageSettings = oPrintDoc.DefaultPageSettings

If PageSetupDialog1.ShowDialog() = DialogResult.OK Then
    oPrintDoc.DefaultPageSettings = PageSetupDialog1.PageSettings

    Dim x As New PrintDialog()
    x.Document = PageSetupDialog1.Document

    If x.ShowDialog() = DialogResult.OK Then
         oPrintDoc.PrinterSettings = x.PrinterSettings
         oPrintDoc.Print()
    End If
End If

C#

// Allow the user to select the page settings and the printer
Xceed.Grid.GridPrintDocument oPrintDoc = new Xceed.Grid.GridPrintDocument( gridControl1 );

pageSetupDialog1.PageSettings = oPrintDoc.DefaultPageSettings;

if( pageSetupDialog1.ShowDialog() == DialogResult.OK )
{
oPrintDoc.DefaultPageSettings = PageSetupDialog1.PageSettings;

PrintDialog x = new PrintDialog();
x.Document = pageSetupDialog1.Document;

if( x.ShowDialog() == DialogResult.OK )
{
    oPrintDoc.PrinterSettings = x.PrinterSettings;
    oPrintDoc.Print();
}
}

Keep in mind that if you call the grid's Print or PrintPreview methods, the grid will always be printed with the default print document.

How to change the behavior of the Enter key

Xceed admin — Thu, 09 Oct 2008 17:03:00 GMT

By default, pressing Enter on a cell or row that is not being edited, will do nothing while pressing Enter on a cell or row that is being edited will commit the modifications. In order to change the default behavior of the Enter key, the grid's ProcessCmdKey method must be overridden.

The following examples demonstrates how to change the behavior of the Enter key so that when enter is pressed the focus will go to the next cell:

VB.NET

Protected Overrides Function ProcessCmdKey ( ByRef msg As Message, ByVal keyData As Keys ) As Boolean

' ProcessCmdKey is only used for the Enter and the Escape keys.
If keyData = Keys.Enter Then
    ' Move to the next cell on the right when the enter key is pressed
    Me.MoveCurrentCell( HorizontalDirection.Right )
    Me.CurrentCell.BringIntoView()
    Return True
End If

Return MyBase.ProcessCmdKey( msg,keyData )
End Function

C#

protected override System.Boolean ProcessCmdKey ( ref Message msg , Keys keyData)
{
// ProcessCmdKey is only used for the Enter and the Escape keys.
if( keyData == Keys.Enter )
{
    // Move to the next cell on the right when the enter key is pressed
    this.MoveCurrentCell( HorizontalDirection.Right );
    this.CurrentCell.BringIntoView();

    return true;
}

return base.ProcessCmdKey( ref msg,keyData );
}

How to stay in edit mode while navigating through the grid

Xceed admin — Thu, 09 Oct 2008 15:17:23 GMT

By default, when the Tab key is pressed and a cell is not being edited, the next control on the form will gain focus. If a cell is being edited, the cell that is being edited will exit edit mode and the next cell will gain focus. If you want to navigate through the grid using the Tab and arrow keys, but remain in edit mode, you will need to handle the grid's KeyPress event to handle the Tab and arrow keys and call the appropriate cell's EnterEdit method.

Sample applications that demonstrate how to navigate through the grid in edit mode are available for download (see attachments).

How to prevent a cell from leaving edit mode

Xceed admin — Thu, 09 Oct 2008 15:15:29 GMT

To prevent the cell from leaving edit mode, you will need to handle ValidationError event of each DataCell in the grid and set the CancelEdit event argument to false.

VB.NET

gridControl1.BeginInit()

gridControl1.DataSource = dataSet11
gridControl1.DataMember = "Orders"

Dim cell As DataCell

For Each cell in gridControl1.DataRowTemplate.Cells
AddHandler cell.ValidationError, AddressOf Me.cell_ValidationError
Next cell

gridControl1.EndInit()

Private Sub cell_ValidationError( ByVal sender As Object, ByVal e As CellValidationErrorEventArgs )
' code to prevent the cell from exiting edit mode
e.CancelEdit = False
End Sub

C#

gridControl1.BeginInit();

gridControl1.DataSource = dataSet11;
gridControl1.DataMember = "Orders";

foreach( DataCell cell in gridControl1.DataRowTemplate.Cells )
{
cell.ValidationError += new CellValidationErrorEventHandler( this.cell_ValidationError );
}

gridControl1.EndInit();

private void cell_ValidationError( object sender, CellValidationErrorEventArgs e )
{
// code to prevent the cell from exiting edit mode
e.CancelEdit = false;
}

How to change the width of columns

Xceed admin — Thu, 09 Oct 2008 15:13:47 GMT

The width of a column can be changed using either the Width property or the GetFittedWidth method. You can also retrieve the value necessary to display the entire contents of a cell using its GetFittedWidth method.

VB.NET

GridControl1.Columns( "ShipCountry" ).Width = 40

C#

gridControl1.Columns[ "ShipCountry" ].Width = 40;

If you want to change the width of each column in the grid, you will need to do a "for each" to iterate through each one of the grid's columns. A common use would be to set the width of each column to its fitted width (the width necessary to display the entire content of the column) using the GetFittedWidth method. For example:

VB.NET

Dim column As Column

For Each column in GridControl1.Columns
column.Width = column.GetFittedWidth()
Next column

C#

foreach( Column column in gridControl1.Columns )
{
column.Width = column.GetFittedWidth();
}

To make sure that the width of the columns stays to their fitted widths even if, for example, the length of one of the column's cell's value changes, you will need to call the GetFittedWidth method in each cell's ValueChanged event. For example:

VB.NET

Dim cell As DataCell

For Each cell in GridControl1.DataRowTemplate.Cells
AddHandler cell.ValueChanged, AddressOf Me.cell_ValueChanged
Next cell

Private Sub cell_ValueChanged( ByVal sender As Object, ByVal e As EventArgs )
Dim parentColumn As Column = CType( sender, DataCell ).ParentColum
parentColumn.Width = parentColumn.GetFittedWidth()
End Sub

C#

foreach( DataCell cell in gridControl1.DataRowTemplate.Cells )
{
cell.ValueChanged += new EventHandler( this.cell_ValueChanged );
}

private void cell_ValueChanged( object sender, EventArgs e )
{
Column parentColumn = ( ( DataCell )sender ).ParentColumn;
parentColumn.Width = parentColumn.GetFittedWidth();
}

How to create multiple column headers

Xceed admin — Thu, 09 Oct 2008 15:13:34 GMT

The grid does support having more than one ColumnManagerRow in its headers, however it does not support (directly) having grouped column headers as demonstrated in the image below:

In order to simulate column grouping you must create a custom row (that derives from the Row class and not from the ColumnManagerRow class) and use it in your grid.

The following code (class) demonstrates the minimum implementation required to simulate column grouping:

VB.NET

Imports System
Imports Xceed.Grid
Imports System.Drawing

Public Class CustomColumnManagerRow
Inherits Row

Protected Sub New( ByVal template As CustomColumnManagerRow )
    MyBase.New( template )
End Sub

Public Sub New( ByVal selector As RowSelector )
    MyBase.New( selector )
End Sub

Public Sub New( ByVal columns As Integer )
    MyBase.New()
    m_columns = columns
End Sub

Protected Overrides Function CreateInstance() As Xceed.Grid.Row
    Return New CustomColumnManagerRow( Me )
End Sub

Protected Overrides Sub PaintForeground( ByVal e As GridPaintEventArgs )
    Dim width As Integer = 0
    Dim lastColumn As Integer = 0
    Dim j As Integer

    For j = 0 To Me.ParentGrid.Columns.Count \ m_columns - 1

      Dim i As Integer
      For i = 0 To m_columns - 1
        width += Me.ParentGrid.Columns( lastColumn ).Width
        lastColumn = lastColumn + 1
      Next i

      e.Graphics.DrawLine( Me.ParentGrid.GridLinePen, e.DisplayRectangle.X + width - 1, 0, e.DisplayRectangle.X + width - 1, Me.Height )
    Next j
End Sub

Protected Overrides ReadOnly Property DefaultHeight As Integer
    Get
      Return 16
    End Get
End Property

Protected Overrides Readonly Property DefaultCanBeCurrent As Boolean
    Get
      Return False
    End Get
End Property

Public Overrides ReadOnly Property IsBackColorAmbient As Boolean
    Get
      Return False
    End Get
End Property

Protected Overrides ReadOnly Property DefaultBackColor As System.Drawing.Color
    Get
      Return SystemColors.Control
    End Get
End Property

Private m_columns As Integer = 0
End Class

C#

using System;
using Xceed.Grid;
using System.Drawing;

namespace Xceed.Grid
{
public class CustomColumnManagerRow : Row
{
    protected CustomColumnManagerRow( CustomColumnManagerRow template )
      :base( template ){}

    public CustomColumnManagerRow( RowSelector selector )
      :base( selector ){}

    public CustomColumnManagerRow( int columns )
      :base()
    {
      m_columns = columns;
    }

    protected override Xceed.Grid.Row CreateInstance()
    {
      return new CustomColumnManagerRow( this );
    }

    protected override void PaintForeground( GridPaintEventArgs e )
    {
      int width = 0;
      int lastColumn = 0;

      for( int j = 0; j < this.ParentGrid.Columns.Count / m_columns; j++ )
      {
        for( int i = 0; i < m_columns; i++ )
        {
          width += this.ParentGrid.Columns[ lastColumn ].Width;
          lastColumn++;
        }

        e.Graphics.DrawLine( this.ParentGrid.GridLinePen, e.DisplayRectangle.X + width - 1, 0, e.DisplayRectangle.X + width - 1, this.Height );
      }
    }

    protected override

How to change a column's DateTime format

Xceed admin — Thu, 09 Oct 2008 15:13:13 GMT

In order to change the DateTime format of an entire column or a specific cell, you must set the column's/cell's FormatProvider property to the desired format and the FormatSpecifier property to the appropriate format provider. By default, the DateTime format will be the system's format. Therefore, if the system short date is yyyy/mm/dd, if you set the FormatSpecifier property to "d", without setting the FormatProvider property, the result will be a short date with the system format.

If you want to change the way in which short dates are displayed (or any other date format), then you will need to create an instance of the DateTimeFormatInfo class, change its ShortDatePattern property to the desired short date format and assign the DateTimeFormatInfo object to the column's/cell's FormatProvider property.

VB.NET

Dim format As New System.Globalization.DateTimeFormatInfo()
format.ShortDatePattern = "yyyy/mm/dd"

GridControl1.Columns( "OrderDate" ).FormatSpecifier = "d"
GridControl1.Columns( "OrderDate" ).FormatProvider = format

C#

System.Globalization.DateTimeFormatInfo format = new System.Globalization.DateTimeFormatInfo();
format.ShortDatePattern = "yyyy/mm/dd";

gridControl1.Columns[ "OrderDate" ].FormatSpecifier = "d";
gridControl1.Columns[ "OrderDate" ].FormatProvider = format;

If you want to change the DateTime format for a specific cell, you can set the cell's FormatProvider and FormatSpecifier properties rather than the column's:

VB.NET

Dim format As New System.Globalization.DateTimeFormatInfo()
format.ShortDatePattern = "yyyy/mm/dd"

GridControl1.DataRows( 0 ).Cells( "OrderDate" ).FormatSpecifier = "d"
GridControl1.DataRows( 0 ).Cells( "OrderDate" ).FormatProvider = format

C#

System.Globalization.DateTimeFormatInfo format = new System.Globalization.DateTimeFormatInfo();
format.ShortDatePattern = "yyyy/mm/dd";

gridControl1.DataRows[ 0 ].Cells[ "OrderDate" ].FormatSpecifier = "d";
gridControl1.DataRows[ 0 ].Cells[ "OrderDate" ].FormatProvider = format;

Of course, if you create an instance of a column or cell, you can also set its FormatSpecifier and FormatProvider properties.

VB.NET

Dim format As New System.Globalization.DateTimeFormatInfo()
format.ShortDatePattern = "yyyy/mm/dd"

Dim column As New Column( "MyColumn", GetType( String ) )
column.FormatSpecifier = "d"
column.FormatProvider = form

C#

System.Globalization.DateTimeFormatInfo format = new System.Globalization.DateTimeFormatInfo();
format.ShortDatePattern = "yyyy/mm/dd";

Column column = new Column( "MyColumn", typeof( string ) );
column.FormatSpecifier = "d";
column.FormatProvider = format;

How to format data using mask (#) characters

Xceed admin — Thu, 09 Oct 2008 15:13:02 GMT

In order to format data using mask (#) characters for an entire column or a specific cell, you must use the TextViewer and TextEditor. Simply setting the column or cell's FormatSpecifier property will not function. You can also change the format of text displayed in a cell (or in an entire column) by creating a class that implements the IFormatProvider interface and assigning your custom class to the FormatProvider and FormatSpecifier properties of the desired cell or column.

For more information regarding the implementation of the IFormatProvider interface, go to the "Customizing Format Strings" topic of the .NET Framework's documentation.

VB.NET

GridControl1.Columns( "Phone" ).CellEditorManager = New Xceed.Grid.Editors.TextEditor( "( ### ) ###-####" )
GridControl1.Columns( "Phone" ).CellViewerManager = New Xceed.Grid.Viewers.TextViewer( "( ### ) ###-####" )

C#

gridControl1.Columns[ "Phone" ].CellEditorManager = new Xceed.Grid.Editors.TextEditor( "( ### ) ###-####" );
gridControl1.Columns[ "Phone" ].CellViewerManager = new Xceed.Grid.Viewers.TextViewer( "( ### ) ###-####" );

How to display a button in a cell

Xceed admin — Thu, 09 Oct 2008 15:12:49 GMT

The grid does not provide a button cell editor or viewer nor is it possible to simulate a proper working button using the ControlViewer or CustomEditor classes. It is possible however to create a button in a cell by creating your own custom cell and overriding the PaintForeground method to draw the button.

This also requires the you create your own custom cell row so that you can return the appropriate cell type in the row's CreateCell method in the case where the data type of the column/cell is a button.

How to display tooltips

Xceed admin — Thu, 09 Oct 2008 15:02:39 GMT

The grid does not directly support tooltips, however you can use the Microsoft ToolTip component in order to display tooltips. In order to display tooltips in the grid, the SetToolTip method of the ToolTip component must be called with the desired text.

VB.NET

GridControl1.BeginInit()

GridControl1.DataSource = DataSet11
GridControl1.DataMember = "Orders"

' Subscribe to the MouseEnter event for each cell in the grid's DataRowTemplate.
' so that the content of each cell will be displayed when the mouse
' enters the cell

Dim cell As DataCell
For Each cell In GridControl1.DataRowTemplate.Cells
AddHandler cell.MouseEnter, AddressOf Me.ShowTip
Next

GridControl1.EndInit()

Private Sub ShowTip( ByVal sender As Object, ByVal e As EventArgs )
ToolTip1.SetToolTip(GridControl1, CType(sender, DataCell).Value.ToString())
End Sub

C#

gridControl1.BeginInit();

gridControl1.DataSource = dataSet11;
gridControl1.DataMember = "Orders";

// Subscribe to the MouseEnter event for each cell in the grid's DataRowTemplate.
// so that the content of each cell will be displayed when the mouse
// enters the cell
foreach( DataCell cell in gridControl1.DataRowTemplate.Cells )
{
cell.MouseEnter += new EventHandler( this.ShowTip );
}

gridControl1.EndInit();

private void ShowTip( object sender, EventArgs e )
{
toolTip1.SetToolTip(gridControl1, ( ( DataCell )sender ).Value.ToString() );
}

How to hide or remove grid lines

Xceed admin — Thu, 09 Oct 2008 15:01:23 GMT

There are 2 ways to hide or remove the grid lines: Your first (and easiest) option is to set the GridLineColor and GridLineBackColor properties to Color.Transparent. Your second option is to create a class the derives from the DataCell class and override the Borders property to remove the grid lines completely.

The following example demonstrates how to hide the grid lines by setting the grid's GridLineColor and GridLineBackColor properties to Color.Transparent:

VB.NET

GridControl1.GridLineColor = Color.Transparent
GridControl1.GridLineBackColor = Color.Transparent

C#

gridControl1.GridLineColor = Color.Transparent;
gridControl1.GridLineBackColor = Color.Transparent;

The next example demonstrates how to derive from the DataCell class to override the Borders property and remove the grid lines completely. Keep in mind that you also need to create a class that derives from the DataRow class that will contain your custom cells.

VB.NET

Public Class CustomDataCell
Inherits DataCell

Protected Sub New ( ByVal template As CustomDataCell )
MyBase.New( template )
End Sub

Public Sub New( ByVal parentColumn As Column )
MyBase.New( parentColumn )
End Sub

Protected Overrides Function CreateInstance() As Cell
Return New CustomDataCell( Me )
End Function

Public Overrides ReadOnly Property Borders As Borders
Get
    Return Borders.Empty
End Get
End Property
End Class

Public Class CustomDataRow
Inherits Xceed.Grid.DataRow

Public Sub New()
MyBase.New()
End Sub

Protected Sub New( ByVal template As CustomDataRow )
MyBase.New( template )
End Sub

Protected Overrides Function CreateCell( ByVal parentColumn As Column ) As Cell
Return New CustomDataCell( parentColumn )
End Function

Protected Overrides Function CreateInstance() As Row
Return New CustomDataRow( Me )
End Function
End Class

C#

public class CustomDataCell : DataCell
{
protected CustomDataCell( CustomDataCell template )
    : base( template ){}

public CustomDataCell( Column parentColumn )
    : base( parentColumn ){}

protected override Cell CreateInstance()
{
    return new CustomDataCell( this );
}

public override Borders Borders
{
    get{ return Borders.Empty; }
}
}

public class CustomDataRow : Xceed.Grid.DataRow
{
public CustomDataRow()
    : base(){}

protected CustomDataRow( CustomDataRow template )
    : base( template ){}

protected override Cell CreateCell( Column parentColumn )
{
    return new CustomDataCell( parentColumn );
}

protected override Row CreateInstance()
{
    return new CustomDataRow( this );
}
}

In order to use your new DataRow and DataCell, you must assign a new instance of your custom DataRow class to the DataRowTemplate property of the grid:

VB.NET

GridControl1.DataRowTemplate = New CustomDataRow()

C#

gridControl1.DataRowTemplate = new CustomDataRow();

Custom grouping and sorting

Xceed admin — Wed, 08 Oct 2008 19:55:36 GMT

This example demonstrates how to create a custom group description by deriving from the DataGridGroupDescription class and overriding the GroupNameFromItem method. The custom group description will group items according to the first letter in the value received as a parameter.

The implementation for the custom sort comparer assigned to the group description's SortComparer property is provided below.

VB.NET

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Xceed.Wpf.DataGrid
Imports System.Collections
Imports System.Globalization;

Namespace Xceed.Wpf.Documentation
Public Class AlphabeticalGroupDescription
         Inherits DataGridGroupDescription

    Public Sub New()
      MyBase.New()
    End Sub

    Public Sub New(ByVal propertyName As String)
     MyBase.New(propertyName)
    End Sub

    Public Overrides Function GroupNameFromItem(ByVal item As Object, _
                                                ByVal level As Integer, _
                                                ByVal culture As CultureInfo) As Object
      Dim value As Object = MyBase.GroupNameFromItem(item, level, culture)
      Try
        Dim content As String = Convert.ToString(value)
        value = content.ToUpper().Substring(0, 1)
      Catch e1 As InvalidCastException
      End Try

      Return value
    End Function
End Class
End Namespace

C#

using System;
using System.Collections.Generic;
using System.Text;
using Xceed.Wpf.DataGrid;
using System.Collections;

namespace Xceed.Wpf.Documentation
{
public class AlphabeticalGroupDescription : DataGridGroupDescription
{
    public AlphabeticalGroupDescription()
      : base()
    {
    }

    public AlphabeticalGroupDescription( string propertyName )
      : base( propertyName )
    {
    }

    public override object GroupNameFromItem( object item, int level,
                                              System.Globalization.CultureInfo culture )
    {
      object value = base.GroupNameFromItem( item, level, culture );
      try
      {
        string content = Convert.ToString( value );

Programmatically toggling group expansion

Xceed admin — Wed, 08 Oct 2008 19:55:24 GMT

The following example demonstrates how to handle the PreviewMouseLeftButtonDown event on the GroupHeaderControl objects contained in the headers of the child groups to toggle the expansion state of child groups using the ToggleGroupExpansion method. The group whose state is to be toggled will be retrieved using the GetParentGroupFromItem method.

The following code provides the implementation of the PreviewMouseLeftButtonDown event in which we will retrieve the item represented by the GroupHeaderControl (GroupHeaderFooterItem) using the GetItemFromContainer method, which will then be used to retrieve the parent group (GetParentGroupFromItem) whose state is to be toggled.

VB.NET

Private Sub HeaderDown( ByVal sender As Object, ByVal e As MouseButtonEventArgs )
Dim headerControl As GroupHeaderControl = TryCast( sender, GroupHeaderControl );
If headerControl Is Nothing Then
    Return
End If

Dim context As DataGridContext = DataGridControl.GetDataGridContext( headerControl )
Dim item As Object = context.GetItemFromContainer( headerControl ) )

If Not item Is Nothing Then
    Dim group As CollectionViewGroup = context.GetParentGroupFromItem( item )
    If Not group Is Nothing
      context.ToggleGroupExpansion( group )
    End If
End If
End Sub

C#

How can I rename a file before it is added to the zip file?

Xceed admin — Fri, 05 Sep 2008 18:32:31 GMT

You can use the CopyTo method to rename the destination file.

The AbstractFile passed as a parameter is the destination file, therefore if you call CopyTo on a file called one.txt and copy it to two.txt, the contents of the file will be the same but the name of the file will have changed.

If you want to rename the file on disk permanently, then you will need to create a reference to a DiskFile object and change the Name propert

LastAccessDateTime is not modified.

Xceed admin — Fri, 05 Sep 2008 18:27:14 GMT

This is a known issue when using the Framework's System.IO.File.SetLastAccessDate method which is called when setting the LastAccessDateTime property.

In somes cases, antivirus software such as Norton Anti-Virus, accesses the file and causes the access time to be updated.

Varied results when encrypting the same string with the same key.

Xceed admin — Fri, 05 Sep 2008 18:26:52 GMT

The reason why you get different results with the same key, same string, is because of the PadingMethod property.

Rijndael will encrypt 16 bytes of data at a time. Lets say your data is 40 bytes. The first 32 bytes will be encrypted with the same result. But, your final 8 bytes will be padded with an extra 8 (a resulting 16 bytes). These padded 8 bytes will always be different, unless you set the PaddingMethod Property to epmRFC1423 (see the help file under PaddingMethod Property). Your final result will now be of 48 bytes. 16 + 16 + 8 + 8 final 8 being your padded result.

If you use the Chained Blocks encryption mode and you provide a different initialization vector each time (recommended), then the entire resulting encrypted string will be different.

How do I change the user without disconnecting?

Xceed admin — Fri, 05 Sep 2008 18:26:06 GMT

As long as the FTP server supports the REIN command, you can use the ChangeUser method to change user without disconnecting.

If the FTP server does not support the REIN command, then it is not possible to change the user without disconnecting.

Note : It is not possible to use the SendCommand method to send the USER and PASS commands since these commands return intermediate replies (in the 300s) which are not supported by the SendCommand method.

How can I improve the performance of my grid?

Xceed admin — Fri, 05 Sep 2008 18:24:49 GMT

The following is a list of things you should take into consideration if you do not want to diminish the performance of your grid:

1- Do not use a GridLineStyle other than Solid. Using another GridLineStyle can substantially reduce performance (by about 30% according to our test results).

2- Do not use a background image.

3- Subscribe only to the necessary events and do not put code that is long to execute in the event handlers. This applies especially to the Cell.ValueChanged event.

4- If the grid is bound, the size of the dataset can greatly influence performance. The new general philosophy in .NET is to work "disconnected" with small datasets.

5- Use AutoHeightMode.None rather than Minimum or AllContent.

FormatException when setting the FormatSpecifier property to "d"

Xceed admin — Fri, 05 Sep 2008 18:23:22 GMT

Xceed Grid for .NET uses the built-in formatting of the .NET Framework. "d" is for Decimal and, according to Microsoft documentation (you can search for "standard numeric format strings"), it only supports integral types. That's why you cannot apply it to a "double" data type.

Does Xceed Grid for .NET function in ASP.NET / Web Matrix?

Xceed admin — Fri, 05 Sep 2008 18:22:10 GMT

Xceed Grid for .NET is a Windows Form control. It will not function in ASP.NET / Web Matrix.

Does the grid support card views?

Xceed admin — Fri, 05 Sep 2008 18:20:53 GMT

Xceed Grid for .NET does not support card views; however they are supported by Xceed DataGrid for WPF.

An internal error has occurred in the Grid Designer.

Xceed admin — Fri, 05 Sep 2008 18:19:55 GMT

This error usually occurs when the Copy Local property of the Xceed.Grid reference is set to true. Setting it to false should correct the issue.

This error can also occur in the designer if you compiled a custom DLL from the Blueprint edition of the grid. Unfortunately, if you compile a custom DLL from the Blueprint edition, the designer will not functio

I'm using AddNew(), but it seems to only place the new DataRow at the end of the grid. I need the ability to insert a new DataRow between two existing DataRows. Is it possible?

Xceed admin — Fri, 05 Sep 2008 18:14:25 GMT

It is not possible to insert datarow's into a grid other than by using AddNew.

As a workaround to simulate insertion, create an invisible column that contains an index and sort by that column. When AddNew is called, place the desired number in the cell corresponding to the invisible column and the datarow will appear to be inserted.