Grid (PRIM_GRID)

Data in table format

Ancestors - Control (PRIM_CTRL)Object (PRIM_OBJT)

Details

The Grid component is used to display data in a spreadsheet style.

Each Column in the list is based on a repository field.

Data in the list is managed using the typical LANSA list commands such as ADD_ENTRY, GET_ENTRY and SELECTLIST etc.

Example

This example shows a simple grid with 3 columns. The Surname and Givename columns are input capable.

     Function Options(*DIRECT)
     Begin_Com Role(*EXTENDS #PRIM_FORM) Caption('Explorer Sample') Clientheight(432) Clientwidth(767) Height(471) Left(165) Top(224) Width(783) Layoutmanager(#TableLayout1) 

        Define_Com Class(#PRIM_TBLO) Name(#TableLayout1)
        Define_Com Class(#PRIM_TBLO.Column) Name(#Column1) Displayposition(1) Parent(#TableLayout1)
        Define_Com Class(#PRIM_TBLO.Row) Name(#Row1) Displayposition(1) Parent(#TableLayout1)
        Define_Com Class(#PRIM_TBLO.Item) Name(#LayoutItem1) Column(#Column1) Manage(#Grid) Parent(#TableLayout1) Row(#Row1) 
        Define_Com Class(#PRIM_GRID) Name(#Grid) Captionnoblanklines(True) Columnscroll(False) Componentversion(1) Displayposition(1) Height(432) Left(0) Parent(#COM_OWNER) Showselection(True) Showselectionhilight(False) Showsortarrow(True) Tabposition(1) Top(0) Width(767) Columnbuttonheight(22) Rowheight(22) Tabbingstyle(ThroughGrid)
        Define_Com Class(#PRIM_GDCL) Name(#GridColumn1) Displayposition(1) Parent(#Grid) Source(#EMPNO)
        Define_Com Class(#PRIM_GDCL) Name(#GridColumn2) Displayposition(2) Parent(#Grid) Source(#SURNAME) Readonly(False)
        Define_Com Class(#PRIM_GDCL) Name(#GridColumn3) Displayposition(3) Parent(#Grid) Source(#GIVENAME) Readonly(False) 
  
        Evtroutine Handling(#Com_owner.Createinstance) 

           Select Fields(*all) From_File(pslmst) 

              Add_Entry To_List(#Grid) 

          Endselect 

        Endroutine 

     End_Com

Properties

Name	Description
AnchorCell	AnchorCell is the cell where selection starts
Appearance	Appearance sets the appearance of the list or grid
BusyUpdates	BusyUpdates specifies how the control updates itself Inherited from Control (PRIM_CTRL)
BusyUpdatesOfParent	BusyUpdatesOfParent specifies whether the parent controls updates Inherited from Control (PRIM_CTRL)
CanFocus	CanFocus returns a value indicating whether the control can receive keyboard focus Inherited from Control (PRIM_CTRL)
CaptionNoBlankLines	CaptionNoBlankLines suppresses the display of blank lines in column headers
Cell	Reference to a specific cell in the list
ColumnButtonHeight	Specifies the height of the buttons shown at the top of the list
ColumnButtonPress	ColumnButtonPress enables or disables column buttons
ColumnButtons	Show the column headers
ColumnEllipses	Show ellipses for truncated text
ColumnResize	Specifies whether the column can be manually resized
Columns	Collection of columns defined for the list
ColumnScroll	ColumnScroll controls horizontal scrolling
ComponentClassName	ComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT)
ComponentMembers	ComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT)
ComponentPatternName	ComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT)
ComponentTag	Generic space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT)
ComponentType	ComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT)
ComponentTypeName	ComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT)
ComponentVersion	Variant of the control being used
CurrentItem	The last item in the list touched either in the UI or via a list related command
Cursor	Cursor sets the cursor image Inherited from Control (PRIM_CTRL)
DisplayPosition	DisplayPosition determines the order in which components are shown Inherited from Control (PRIM_CTRL)
DragColumns	Allow columns to be reordered
DragStyle	DragStyle determines how a component can be dragged Inherited from Control (PRIM_CTRL)
Enabled	Enable activates/deactivates the component Inherited from Control (PRIM_CTRL)
EnterKeyStyle	EnterKeyStyle determines what happens when Enter key is pressed in a grid
Entries	The number of entries in the underlying data list
EscapeKeyStyle	EscapeKeyStyle determines what happens when Escape key is pressed in a grid
FixedPosition	Fix the control position so that it does not move if the parent is scrolled Inherited from Control (PRIM_CTRL)
Focus	Focus tells whether the component has focus Inherited from Control (PRIM_CTRL)
FocusCell	FocusCell is the cell where selection starts
FocusedStyle	Reference to a style to be applied when the control is focus Inherited from Control (PRIM_CTRL)
FocusedStyles	Collection of styles to be applied when the control is focus Inherited from Control (PRIM_CTRL)
FocusItem	Reference to the focus item in the list
FrozenColumns	FrozenColumns sets number of unmovable columns on the left
Handle	Returns the Windows handle in desktop applications Inherited from Control (PRIM_CTRL)
Height	The height of the control in pixels Inherited from Control (PRIM_CTRL)
Hint	Caption displayed when the mouse hovers over the control Inherited from Control (PRIM_CTRL)
HintPopup	HintPopup allows a PopupPanel instance to be used instead of the default hint text box Inherited from Control (PRIM_CTRL)
HintShow	Enabled or disable the appearance of hints Inherited from Control (PRIM_CTRL)
HintShowOfParent	Delegate hints appearance to the parent control Inherited from Control (PRIM_CTRL)
HintTitle	HintTitle defines the text shown at the top of the hint window in emphasized text Inherited from Control (PRIM_CTRL)
IsAnimating	IsAnimating indicates that a control is currently being animated Inherited from Control (PRIM_CTRL)
IsRealized	True if the control is currently realized Inherited from Control (PRIM_CTRL)
Items	Collection of items in the component
Left	Position of the control relative to the left boundary of its parent Inherited from Control (PRIM_CTRL)
Modified	Modified indicates that the contents of the component have changed Inherited from Control (PRIM_CTRL)
ModifiedRules	Controls when the Modified property is set to True
MouseOver	MouseOver determines whether the mouse is directly over a control Inherited from Control (PRIM_CTRL)
MouseOverPart	True if the cursor is within the bounds of a child component
MouseOverStyle	MouseOverStyle defines the style to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL)
MouseOverStyles	MouseOverStyles is a collection of styles to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL)
Name	Name identifies the component Inherited from Object (PRIM_OBJT)
NotificationStyle	NotificationStyle controls how events are triggered
Opacity	Opacity denotes the appearance of a control in terms of its interaction with its background Inherited from Control (PRIM_CTRL)
Owner	Owner owns this component Inherited from Object (PRIM_OBJT)
Parent	Reference to the control in which this control is visually positioned Inherited from Control (PRIM_CTRL)
Popup	Popup allows a PopupPanel instance to be used instead of the typical right click popup menu Inherited from Control (PRIM_CTRL)
PopupMenu	Reference to a PopupMenu to be shown on a right click Inherited from Control (PRIM_CTRL)
Rotation	Rotation allows a control to rotate a number of degrees about a given origin Inherited from Control (PRIM_CTRL)
RotationOriginLeft	RotationOriginLeft defines the left coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL)
RotationOriginTop	RotationOriginTop defines the top coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL)
RowButtons	Show or hide the row buttons on the left of the grid
RowButtonWidth	Width of the row buttons in pixels
RowHeight	Height of the row in pixels
RowResize	Allow the user to resize rows
RowSizing	Specifies how rows can be resized
ScaleHeight	ScaleHeight is the percentage of the height to use in the visual appearance of a control Inherited from Control (PRIM_CTRL)
ScaleOriginLeft	ScaleOriginLeft defines the left coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL)
ScaleOriginTop	ScaleOriginTop defines the top coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL)
ScaleWidth	ScaleWidth is the percentage of the width to use in the visual appearance of a control Inherited from Control (PRIM_CTRL)
ScreenLeft	ScreenLeft sets the distance from the left of the screen Inherited from Control (PRIM_CTRL)
ScreenTop	ScreenTop sets the distance from the top of the screen Inherited from Control (PRIM_CTRL)
ScrollLeft	Left position of a horizontally scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL)
ScrollTop	Top position of a vertically scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL)
SelectedColumnCount	The number of currently selected column
SelectedRowCount	The number of currently selected rows
SelectionStyle	Specifies the rules for item selection within the list
ShowButtonSelection	ShowButtonSelection controls the appearance of column header button when grid cells are selected
ShowItemHint	Show or hide hints for grid items
ShowLines	ShowLines controls whether grid lines are visible
ShowSelection	Show selection when the control does not have focus
ShowSelectionHilight	Highlight selected items when the control does not have focus
ShowSortArrow	ShowSortArrow shows or hides the arrow indicating sort direction
SkewLeft	SkewLeft defines the angle at which to skew the control horizontally Inherited from Control (PRIM_CTRL)
SkewOriginLeft	SkewOriginLeft defines the left coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL)
SkewOriginTop	SkewOriginTop defines the top coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL)
SkewTop	SkewTop defines the angle at which to skew the control vertically Inherited from Control (PRIM_CTRL)
SplitStyle	Defines how the grid can be split in to independent scrollable panes
Style	Style defines the style to be applied to a control Inherited from Control (PRIM_CTRL)
Styles	Collection of styles to be applied to the control Inherited from Control (PRIM_CTRL)
TabbingStyle	TabbingStyle controls how the TAB key works in a grid
TabPosition	TabPosition sets the order of focus when the Tab key is used Inherited from Control (PRIM_CTRL)
TabStop	Set to false to stop focus being given to the control via the Tab key Inherited from Control (PRIM_CTRL)
ThemeDrawStyle	Name of the Theme DrawStyle to be applied to the control Inherited from Control (PRIM_CTRL)
Top	Position of the control relative to the top boundary of its parent Inherited from Control (PRIM_CTRL)
TouchMove	Determines how the control will respond to touch move processing Inherited from Control (PRIM_CTRL)
TouchRotate	Determines how the control will respond to touch rotation Inherited from Control (PRIM_CTRL)
TouchScale	Determines how the control will respond to touch scaling Inherited from Control (PRIM_CTRL)
TouchScroll	Specifies how the control will respond to touch input for scrolling
TouchSize	Determines whether a control can be resized Inherited from Control (PRIM_CTRL)
ValueAt	Value at the specified location
ViewPopupMenu	ViewpopupMenu specifies the popup menu for the view area
Visible	Show or hide the control Inherited from Control (PRIM_CTRL)
VisualStyle	VisualStyle sets the appearance Inherited from Control (PRIM_CTRL)
VisualStyleOfParent	Adopt the Visual style from the parent control Inherited from Control (PRIM_CTRL)
Width	Width of the component in pixels Inherited from Control (PRIM_CTRL)

Events

Name	Description
AnimationEnded	Fired when an animation is ended Inherited from Control (PRIM_CTRL) Cancelled
Changed	Changed is a change in the component
CreateInstance	CreateInstance is signalled when an instance of a component is created Inherited from Control (PRIM_CTRL)
DestroyInstance	DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Control (PRIM_CTRL)
DoubleClick	Fired when the user double clicks Origin, Handled
DragDrop	Fired on mouse up to signify the end of a drag process Inherited from Control (PRIM_CTRL) PosX, PosY, Source, Payload, AggregatedSource, Origin, Handled, DragResult
DragOver	Fired during the drag and drop process when the cursor moves over the control Inherited from Control (PRIM_CTRL) PosX, PosY, Source, Payload, DragState, AcceptDrop, DragCursor, ShowDropHilight, AggregatedSource, Origin, Handled
EditorChanged	Fired when the user changes a value in an editable cell Value
EndDrag	Fired when the drag and drop process has completed Inherited from Control (PRIM_CTRL) Source, Payload, DragResult, AggregatedSource, Origin, Handled
Enter	Fired when the Enter key is pressed KeyCode, Char, IsAltDown, IsControlDown, IsShiftDown, Handled
GotFocus	Fired when the control receives the focus
Initialize	Fired after a component has been realized for the first time Inherited from Control (PRIM_CTRL)
ItemChanged	ItemChanged happens when an item is changed
ItemChangedAccept	ItemChangedAccept event is triggered when an item is about to be changed Accept, Reason, Continue, Value
ItemGotFocus	Fired when an item receives the focus
ItemGotFocusAccept	ItemGotFocusAccept is fired when the item gets focus Accept, Reason
ItemGotSelection	Fired when an item in the list becomes selected
ItemGotSelectionAccept	Fired when an item in the list is about to become selected Accept, Reason
ItemHintText	Fired when the hint is about to be shown Caption, Cell
ItemLostFocus	Fired when the item loses focus
ItemLostFocusAccept	Fired when an item in the list is about to lose focus Accept, Reason
ItemLostSelection	ItemLostSelection happens when another item is selected
ItemLostSelectionAccept	Fired when an item in the list is about to lose selection Accept, Reason
ItemMouseEnter	The mouse has entered the bounds of the item
ItemMouseHover	The mouse is hovering over the item
ItemMouseLeave	The mouse has left the bounds of the item
KeyPress	Fired when a key is pressed on the keyboard KeyCode, Char, IsAltDown, IsControlDown, IsShiftDown, Handled
LostFocus	LostFocus happens when a component is no longer active
MouseEnter	The mouse has entered the bounds of the control Inherited from Control (PRIM_CTRL)
MouseHover	The mouse has hovered over the control Inherited from Control (PRIM_CTRL) Origin, Handled
MouseLeave	The mouse has left the bounds of the control Inherited from Control (PRIM_CTRL)
PrompterAccept	Fired when a value is selected in a prompter Form, ApplyValue, FocusAction, ReshowPrompter
PrompterActivate	Fired when the prompter image is clicked Form, Continue
PrompterDeactivate	Fired when the prompter is closed Form
StartDrag	Fired when the user starts a drag and drop process Inherited from Control (PRIM_CTRL) Source, Payload, Continue, DragList, AggregatedSource, Origin, Handled
TouchChange	Fired repeatedly between the TouchStart and TouchEnd boundaries to provide details of the touch events Inherited from Control (PRIM_CTRL) MoveLeft, MoveTop, ScaleWidth, ScaleHeight, Rotation, Continue
TouchEnd	Fired when the user stops touching the screen Inherited from Control (PRIM_CTRL)
TouchStart	Fired when the user first makes physical contact with the screen Inherited from Control (PRIM_CTRL) Origin, TouchMove, TouchRotate, TouchScale, TouchSize
ViewDoubleClick	Fired when the user double clicks in a part of the list not occupied by a list item

Methods

Name	Description
FadeIn	Animate from invisible to visible Inherited from Control (PRIM_CTRL) Duration, Delay
FadeOut	Animate from visible to invisible Inherited from Control (PRIM_CTRL) Duration, Delay, Visible
MoveFrom	Move a control from the specified position to the current position Inherited from Control (PRIM_CTRL) Left, Top, Duration, Delay
MoveTo	Animate a move from the specified number of pixels Inherited from Control (PRIM_CTRL) Left, Top, Duration, Delay
Realize	Creates the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL)
Scale	Animate a change of scale Inherited from Control (PRIM_CTRL) ScaleWidth, ScaleHeight, Duration, Delay
SetFocus	Sets the control to be the focus control Inherited from Control (PRIM_CTRL)
SetValueAt	Set the value at the specified position Result, Row, Column, Value
ShowMessages	LANSA Internal Use Inherited from Control (PRIM_CTRL)
SizeTo	Changes and animates control size changing Inherited from Control (PRIM_CTRL) Width, Height, Duration, Delay
StartSplit	Show the defined splitters
Unrealize	Destroys the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL)
UpdateDisplay	UpdateDisplay updates the display immediately Inherited from Control (PRIM_CTRL)

Content

Space Tools