SftTree/NET 2.0 - Tree Control for Windows Forms

PositionToIndex Method, ColumnsClass Class

Translates a column display position into the real column index.

Class: ColumnsClass
Namespace: Softelvdm.SftTreeNET
Assembly: Softelvdm.SftTreeNET

Syntax

public int PositionToIndex( int DisplayPosition );

Public Function PositionToIndex( ByVal DisplayPosition As Integer ) As Integer

Parameters

DisplayPosition

The column display position.

Return Value

The real column index.

Comments

Translates a column display position into the real column index.

The real column index and the column display position are numbers in the range 0 through ColumnsClass.Count-1.

As a user reorders columns, this is completely transparent to the application. An application still references cells and columns by the "real" column index, which is the original column number that the cell or column had before columns were reordered by the user. While columns appear in a new order after dragging a column to a new position, the application references cells and columns by their real column number which never changes.

If a user reorders columns using column reordering, the column's display position, which is the column number as it appears to the user, may need to be translated into the real column number as used by an application.

The ColumnClass.Position property can be used to reorder columns under program control.

See Also ColumnsClass Class | Classes | SftTree/NET 2.0