Move Method, SftTreeColumns Object


	SftTreeColumns.Move Method	Softel vdm, Inc.

Moves a column to a new position.

Syntax

		VB.NET	object.Move(ByVal FromDisplayColumn As Short, ByVal ToDisplayColumn As Short)
		VB	object.Move(ByVal FromDisplayColumn As Integer, ByVal ToDisplayColumn As Integer)
		C#.NET	void object.Move(short FromDisplayColumn, short ToDisplayColumn);
		VC++	HRESULT object->Move(short FromDisplayColumn, short ToDisplayColumn);
		C	HRESULT object->raw_Move(short FromDisplayColumn, short ToDisplayColumn);
		Delphi	procedure object.Move(FromDisplayColumn : Smallint, ToDisplayColumn : Smallint);

object

A SftTreeColumns object.

FromDisplayColumn

The zero-based column number to be moved.

ToDisplayColumn

The zero-based column number of the position where the column is to be inserted. If ToDisplayColumn is -1, the column will be moved to the end and become the last column.

Comments

The Move method moves a column to a new position.

The Move method moves the entire column, including all attributes and contents.

While most other methods, events and properties use real column numbers, the Move method requires the use of display column numbers. The first displayed column number can be retrieved using the ColumnsObj.FirstDisplayColumn property. The last displayed column number is described by the ColumnsObj.LastDisplayColumn property. The ColumnsObj.Count property returns the number of columns defined.

Even hidden columns (Column.Width is 0) can be moved using the Move method.