Rosi ComponentsUnits Class Hierarchy Classes, Interfaces, Objects and Records Types Variables Constants Functions and Procedures Identifiers |
Class TrStringGridEd
Unit
rStringGridEd
Declaration
type TrStringGridEd = class(TStringGrid)
Description
enhanced StringGrid component which introduce Columns property for setting and storing of properties for each column
Hierarchy
- TStringGrid
- TrStringGridEd
Overview
Methods
Properties
Description
Methods
 |
function IsValidData(ACol, ARow: Longint): TrStringGridEdDataState; |
return state of data in cell - empty, ok, invalid, outoflimit
|
 |
function GetDataType(ACol, ARow: Longint): TrStringGridEdDataType; |
return type of data in cell - text, int, double, datetime
|
 |
function GetDataAlignment(ACol, ARow: Longint): TAlignment; |
return alignment of data in cell
|
 |
function CellInSelectedRange(ACol, ARow: Longint): Boolean; |
return whether cell is inside of range select
|
 |
procedure ClearSelRange; |
clear content of selected range
|
 |
function CopySelRange: string; |
copy selected range to clipboard
|
 |
procedure PasteSelRange(CanExpandGrid: Boolean; const PasteData: string = ''); |
paste values from clipboard to cells starting by selected cell
|
 |
function CopyEntireTable(IncludingFixedRows: Boolean = true; IncludingFixedColumns: Boolean = true): string; |
copy entire table to clipboard, returns clipboard text
|
 |
procedure PasteEntireTable(CanExpandGrid: Boolean; const PasteData: string = ''); |
paste values from clipboard to grid from cell 0,0
|
 |
procedure ClearEntireTable(IncludingFixedCells: Boolean = false); |
clear all cells
|
 |
procedure SaveToFile(const FileName: string); |
store entire table to file
|
 |
procedure LoadFromFile(const FileName: string); |
load entire table from file
|
 |
procedure SetColumnAutoFit(ColIdx: Longint); |
set column width according data width
|
 |
procedure SetColumnsAutoFit; |
set all columns width according data width
|
 |
procedure FinishEditing; |
hide editor and finish editing
|
 |
procedure ResetChangeLog; |
reset list of changed Rows and Cells
|
 |
function ActiveCellText: string; |
return content of active cell
|
 |
function IsRowEmpty(ARow: Longint; SkipFixedCol: Boolean = true; ColumnGroup: integer = 0): Boolean; |
return true if all cells in row is empty
|
 |
procedure SelectFirstCell; |
move cursor to first selectable cell
|
 |
procedure MoveRowEx(FromIndex, ToIndex: Longint); |
move row to new position
|
 |
procedure InsertRowEx(RowIndex: Longint; Activate: Boolean = true); |
insert new empty row to define index position
|
 |
procedure DeleteRowEx(RowIndex: Longint); |
delete whole row
|
 |
procedure MoveColumnEx(FromIndex, ToIndex: Longint); |
move column to new position
|
 |
procedure InsertColumnEx(ColIndex: Longint; Activate: Boolean = true); |
insert new empty column to define index position
|
 |
procedure DeleteColumnEx(ColIndex: Longint); |
delete whole column
|
 |
procedure SortData(ColIndex: integer; Desc: Boolean = false; ResetSelection: boolean = false); |
sort data/rows according selected column
|
Properties
 |
property StringCells[ACol,ARow:Longint]: string read GetStringCells write SetStringCells; |
read and set cells as string value
|
 |
property NumCells[ACol,ARow:Longint]: double read GetNumCells write SetNumCells; |
read and set cells as double value
|
 |
property IntCells[ACol,ARow:Longint]: integer read GetIntCells write SetIntCells; |
read and set cells as integer value
|
 |
property SelectedRange: TGridRect read GetSelectedRange write SetSelectedRange; |
return selection range coordinates
|
 |
property ChangedRows: TStrings read FChangedRows; |
store list of Row index which was modified
|
 |
property ChangedCells: TStrings read FChangedCells; |
store list of cells coordinates which was modified; format: ColIdx;RowIdx
|
 |
property OptionsEx: TOptionsEx read FOptionsEx write SetOptionsEx default[]; |
list of new options
|
 |
property ColCount: Longint read GetColCount write SetColCount default 5; |
define number of columns, columns collection is updated automatically
|
 |
property Columns: TrStringGridEdColumns read FColumns write FColumns; |
columns collection, for detail see TrStringGridEdColumns
|
 |
property InnerMargin: integer read FInnerMargin write SetInnerMargin default 0; |
define inner space between cell border and text in cell
|
 |
property TitleRowHeight: integer read FTitleRowHeight write SetTitleRowHeight default 0; |
Defines number of lines in title row
|
 |
property AutoRowHeight: Boolean read FAutoRowHeight write SetAutoRowHeight default false; |
define whether row of column is set automatically, can be used with textwrap property of some column
|
 |
property AutoAddNewRow: Boolean read FAutoAddNewRow write SetAutoAddNewRow default false; |
define whether new row is automatically added if last row is edited
|
 |
property ChangedCellsBkColor: TColor read FChangedCellsBkColor write SetChangedCellsBkColor default clInfoBk; |
define background color of changed cells (used if dgColorChangedCells is set to true)
|
 |
property OnGetHintText: TGetHintText read FGetHintText write FGetHintText; |
event for user defined setting of hint string
|
 |
property OnMouseWheelUp: TNotifyEvent read FOnMouseWheelUp write FOnMouseWheelUp; |
|
 |
property OnMouseWheelDown: TNotifyEvent read FOnMouseWheelDown write FOnMouseWheelDown; |
|
 |
property OnCellClick: TFixedCellClickEvent read FOnCellClick write FOnCellClick; |
event for user defined action after user click to any non fixed cell
|
 |
property OnEllipsisClicked: TrStringGridEdCellEvent read FOnEllipsisClicked write FOnEllipsisClicked; |
event for user defined action after click to ellipsis button
|
 |
property OnPicklistDropdown: TrStringGridEdDropdownEvent read FOnPicklistDropdown write FOnPicklistDropdown; |
event for user defined setting of values after click on drop down button
|
 |
property OnGetCellParams: TGetCellParamsEvent read FOnGetCellParams write FOnGetCellParams; |
event for user defined setting of individual cell params - font, color
|
 |
property OnGetDataType: TGetDataTypeEvent read FOnGetDataType write FOnGetDataType; |
event for user defined setting of datatype for individual cell
|
 |
property OnGetNumFormat: TGetNumFormat read FOnGetNumFormat write FOnGetNumFormat; |
event for user defined setting of numformat for individual cell
|
 |
property OnGetEditStyle: TGetEditStyleEvent read FOnGetEditStyle write FOnGetEditStyle; |
event for user defined setting of editstyle for individual cell
|
 |
property OnCanEdit: TCanEditEvent read FOnCanEdit write FOnCanEdit; |
event for user defined setting whether individual cell can be edited
|
 |
property OnFinishCellEditing: TrStringGridEdCellEvent read FOnFinishCellEditing write FOnFinishCellEditing; |
event for user defined action after editing of cell is finished
|
 |
property OnEditorKeyPress: TKeyPressEvent read FOnEditorKeyPress write FOnEditorKeyPress; |
event for user defined action after press of key in editor
|
 |
property OnColumnRestoreDefault: TOnColumnRestoreDefault read FOnColumnRestoreDefault write FOnColumnRestoreDefault; |
event for user defined action for setting of default values
|
Generated by PasDoc 0.13.0 on 2016-02-19 08:14:10
|