SftBox/OCX 4.5

SftBoxColumns.DisplayPosition Property

Softel vdm, Inc.

Returns the display position given a real column number.

Syntax       

Get

VB.NET

DispColIndex = object.DisplayPosition(ByVal ColNum As Short)  As Short

VB

DispColIndex = object.DisplayPosition(ByVal ColNum As Integer)  As Integer

C#.NET

short DispColIndex = object.get_DisplayPosition(short ColNum);

VC++

short DispColIndex = object->DisplayPosition[short ColNum];
short DispColIndex = object->GetDisplayPosition(short ColNum);

C

HRESULT object->get_DisplayPosition(short ColNum, short* DispColIndex);

Delphi

DispColIndex := object.DisplayPosition[ColNum : Smallint]   : Smallint;

object

A SftBoxColumns object.

ColNum

Specifies the real column number of the requested displayed column.

DispColIndex

Returns the display position given a real column number.

Comments

The DisplayPosition property returns the display position given a real column number.

As a user reorders columns, this is completely transparent to the application.  An application still references cells and columns by the "real" column number, 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 drag & drop, the (real) column numbers used by an application may need to be translated into the actual display column number, which is the column number as it appears to the user.

The Columns.Move method can be used to reorder columns under program control.


Feedback / comments / error reports for this topic
© 2008 - Softel vdm, Inc. - www.softelvdm.com