Core Function GUIDataGrid

From Sputnik Wiki
Jump to: navigation, search
GUIDataGrid( <datagrid> )

Contents

Description

Properties & Functions specifically for DataGrid

Parameters

datagrid

The DataGrid GUI object to use.

Functions

GetSelectedCells

Return array of all cells selected by user

Allow all one type

HotKeySet('{F1}', 'ShowSelectedCells($arg);');
// Triggered by hotkey F1 this will print the cell locations that are selected
Function ShowSelectedCells($arg)
{
	$SelectedCells = GUIDataGrid($GS, "GetSelectedCells");
	if($SelectedCells)
	{
		println("Selected Cells Below");
		foreach($SelectedCells as $cell)
		{
			List( $ColumnID, $RowID ) = $cell;
			println("User has selected cell at ColumnID ' $ColumnID' RowID '$RowID'");
		}
		println("Selected Cells Above");
	}
	else
	{
		println("No Cells are selected");
	}
}

GetSelectedColumns

Return array of all columns selected by user

Allow all one type

HotKeySet('{F2}', 'ShowSelectedColumns($arg);');
// Triggered by hotkey F2 this will print the columns that are selected
Function ShowSelectedColumns($arg)
{
	$SelectedColumns = GUIDataGrid($GS, "GetSelectedColumns");
	if($SelectedColumns)
	{
		println("Selected Columns Below");
		foreach($SelectedColumns as $ColumnID)
		{
			println("User has selected ColumnID '$ColumnID'");
		}
		println("Selected Columns Above");
	}
	else
	{
		println("No Columns are selected");
	}
}

GetSelectedRows

Return array of all rows selected by user

Allow all one type

HotKeySet('{F3}', 'ShowSelectedRows($arg);');
// Triggered by hotkey F3 this will print the rows that are selected
Function ShowSelectedRows($arg)
{
	$SelectedRows = GUIDataGrid($GS, "GetSelectedRows");
	if($SelectedRows)
	{
		println("Selected Rows Below");
		foreach($SelectedRows as $RowID)
		{
			println("User has selected RowID '$RowID'");
		}
		println("Selected Rows Above");
	}
	else
	{
		println("No Rows are selected");
	}
}

SelectionMode

Change the selection mode

Allow all one type

GUIDataGrid($GS, "SelectionMode", @CellSelect);

Allow all two types

GUIDataGrid($GS, "SelectionMode", @CellSelect | @RowHeaderSelect);

Allow all types

GUIDataGrid($GS, 	"SelectionMode", 
			@CellSelect | 
			@FullColumnSelect | 
			@FullRowSelect | 
			@RowHeaderSelect | 
			@ColumnHeaderSelect);

Possible types are:

@CellSelect
@FullColumnSelect
@FullRowSelect
@RowHeaderSelect
@ColumnHeaderSelect

GetValue

Get a value at a given Column, Row

$k = 0;
For($j = 0; $j < $RowCount; $j++)
{
	For($i = 0; $i < $ColumnCount; $i++)
	{
		$Data = GUIDataGrid($GS, "GetValue", $i, $j);
		println("Col '$i' ROW '$j' DATA '$Data'");
		$k++;
	}
}

SetValue

Set a value at a given Column, Row

$k = 0;
For($j = 0; $j < $RowCount; $j++)
{
	For($i = 0; $i < $ColumnCount; $i++)
	{
		GUIDataGrid($GS, "SetValue", $i, $j, "Meows $i, $j"); 
		$k++;
	}
}

Clear

Delete all rows and columns

GUIDataGrid($GS, "Clear");

AddColumn

Add a column to the end

GUIDataGrid($GS, "AddColumn", "Four");

InsertColumn

Add a column at a given location

GUIDataGrid($GS, "InsertColumn", 0, "Zero");

DelColumn

Delete a column by name

GUIDataGrid($GS, "DelColumn", "Two");

DelColumnAt

Delete a column at a given location

GUIDataGrid($GS, "DelColumnAt", 0);

ClearColumns

Delete all columns

GUIDataGrid($GS, "ClearColumns");

GetColumns

Get array of all Column names

$Columns = GUIDataGrid($GS, "GetColumns");

Columns

Get Column count

$ColumnCount = GUIDataGrid($GS, "Columns");

SetColumns

Set the columns to all names in array

GUIDataGrid($GS, "SetColumns", array("One", "Two", "Three"));

AddRow

Add a Row to the end (Array UBound must be equal to number of columns)

GUIDataGrid($GS, "AddRow", array(1, 2, 3));

InsertRow

Insert a Row at a given location (Array UBound must be equal to number of columns)

GUIDataGrid($GS, "InsertRow", 4, array("ONE", "TWO", "THREE"));

DelRow

Delete a given Row at a given location

GUIDataGrid($GS, "DelRow", 0);

ClearRows

Delete all rows

GUIDataGrid($GS, "ClearRows");

Rows

Get Row count

$RowCount = GUIDataGrid($GS, "Rows");

Example

Go see GUICreate( "DataGrid" ) for example.

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox