TValueListEditor class

In unit ValEdit

A visual grid control for editing Key-Value pairs.

Declaration

pascal

TValueListEditor = class(TCustomStringGrid)

Inheritance

Description

TValueListEditor is a TCustomStringGrid descendant which implements a grid-style editor control for Key-Value pairs. TValueListEditor displays a two column grid where the first column is read-only, and lists the key names. The second column is for editing the associated values for the key names.

TValueListEditor provides properties with the Keys and Values displayed in the rows and columns for the control. The Cells property allows access using the familiar column and row number mechanism used in grid controls. The Strings property allows access to the strings used for the Key and Value in a row.

Since version 2.2.0, Keys will no longer allow the name/value separator used in the Strings property to be entered as a value in the Key column. When entered, focus is moved to the Value column. If pasted into the Key column, the value is silently discarded.

The ItemProps property is used to configure the cell editors used for the Keys and Values. This includes setting the editor style, edit mask, maximum length for the value, a list of selectable pick list values, and a read-only flag. Descriptive text for the Key name can also be stored in the ItemProps.

Features and behavior for the control can be specified using the Options, DisplayOptions, and KeyOptions properties.

TValueListEditor implements methods used to perform editing actions in the control, including:

Clear
DeleteRow
DeleteColRow
FindRow
InsertRow
InsertRowWithValues
Sort

Properties

`Modified`	public	Indicates if changes have been made to items in the control.
`Keys`	public	Provides indexed access to Key names in the control.
`Values`	public	Provides indexed access to Values stored in the control.
`ItemProps`	public	Provides indexed access to item definitions in the control.
`Align`	published	Specifies the placement of the control on its Parent control.
`AlternateColor`	published	Color used for the background in alternate rows in the grid.
`Anchors`	published	The set of anchor definitions for this control.
`AutoAdvance`	published	Direction used when automatically moving the selection to the next selectable cell.
`AutoEdit`	published	Indicates if edit mode is automatically entered when a cell is selected.
`BiDiMode`	published	Indicates whether text controls use in bi-directional reading.
`BorderSpacing`	published	Determines the inner and outer border spacing for this control.
`BorderStyle`	published	Indicates the border style displayed around the control.
`Color`	published	The background color for the control.
`Constraints`	published	Contains the minimum and maximum Width and Height for the control.
`DefaultColWidth`	published	Default width used for grid columns.
`DefaultDrawing`	published	Indicates if the default drawing mechanism is used to draw the background and text for cells.
`DefaultRowHeight`	published	Default row height for newly created grid rows.
`DragCursor`	published	The cursor shape shown during a drag operation.
`DragKind`	published	Indicates the action performed for a drag operation: drag-and-drop or drag-and-dock.
`DragMode`	published	Determines how a drag operation is started for the control.
`Enabled`	published	Determines whether the control responds to mouse or keyboard input.
`ExtendedSelect`	published	Controls whether extending the current cell selection(s) on the control is enabled.
`FixedColor`	published	The color used for the fixed cells in the grid.
`FixedCols`	published	The number of fixed columns on the control.
`Flat`	published	Indicates if cells are displayed using a Flat appearance.
`Font`	published	The font to be used for text display in this control.
`GridLineWidth`	published	Width (thickness) for grid lines drawn on the control.
`HeaderHotZones`	published	Contains the grid zones which are hot-lighted (hovered) on the control.
`HeaderPushZones`	published	Contains the grid zones which are drawn in a "pushed" state on the control.
`MouseWheelOption`	published	Sets the mouse wheel behavior for the grid control.
`ParentBiDiMode`	published	Indicates whether the BiDiMode settings in the Parent control are used.
`ParentColor`	published	Uses the Color from the Parent control, when enabled.
`ParentFont`	published	Indicates if the Font from the Parent control is used in the control.
`ParentShowHint`	published	If True, the value of ShowHint for the control will be the same as the one from the Parent. Default is True.
`PopupMenu`	published	A context-sensitive menu that pops up when the right mouse button is clicked over this control.
`RowCount`	published	Gets the number of rows for the control.
`ScrollBars`	published	Scrollbars displayed for the grid control.
`ShowHint`	published	Enables Hint display for the control.
`TabOrder`	published	Indicates the navigation order for the control when the user presses the Tab or Shift+Tab key.
`TabStop`	published	Allows the user to navigate to / from the control by pressing the Tab or Shift+Tab keys.
`TitleFont`	published	The font used for text in a column title.
`TitleImageList`	published	The list with images displayed in column titles.
`TitleStyle`	published	The drawing style used for the fixed column titles.
`UseXORFeatures`	published	When True, the dotted focus rectangle is painted using an XOR raster operation.
`Visible`	published	Allows the control, and all of its children, to be displayed or hidden.
`VisibleColCount`	published	The number of visible columns in the grid control.
`VisibleRowCount`	published	The number of visible rows in the grid control.
`DisplayOptions`	published	Enables or disables display features and behaviors in the control.
`DoubleBuffered`	published	When enabled, it reduces flicker when the control is painted.
`DropDownRows`	published	Number of rows displayed for an item with a PickList editor style.
`KeyOptions`	published	Controls actions that can be performed for Keys in the control.
`Options`	published	Specifies the options enabled for the Key-Value grid.
`Strings`	published	Stores the keys, values, and item definitions in the control.
`TitleCaptions`	published	Title captions used for columns in the control.

Methods

`WSRegisterClass`	protected	Registers the class type for the widget set.
`SetFixedCols`	protected	Sets the value for the FixedCols property.
`ShowColumnTitles`	protected	Assigns and displays the column titles for the Key and Value columns.
`AdjustRowCount`	protected	Sets the number of visible rows for the control.
`ColRowExchanged`	protected	Exchanges row values at the specified positions.
`ColRowDeleted`	protected	Performs actions needed when a row is deleted in the control.
`DefineCellsProperty`	protected	Not used in the current implementation.
`InvalidateCachedRow`	protected	Resets the last edited row number for the control.
`GetAutoFillColumnInfo`	protected	Gets the display priority for an auto-fill column.
`GetEditText`	protected	Gets the value used in the editor for the specified cell.
`GetCells`	protected	Gets the value in Cells at the specified row and column numbers.
`GetDefaultEditor`	protected	Gets the editor control for the specified column number.
`GetRowCount`	protected	Gets the value for the RowCount property.
`KeyDown`	protected	Provides support for special keys used in the control.
`KeyPress`	protected	Handles special key presses for the control.
`LoadContent`	protected	Loads configuration and content from the specified XML configuration file.
`ResetDefaultColWidths`	protected	Resets grid columns to their default widths.
`SaveContent`	protected	Saves configuration and content in the control to the specified XML configuration file.
`SetCells`	protected	Sets the value in the Cells property at the specified position.
`SetColCount`	protected	Sets the value for the ColCount property.
`SetEditText`	protected	Sets the cell value at the specified position.
`SetFixedRows`	protected	Sets the value in the FixedRows property.
`SetRowCount`	protected	Sets the value in the RowCount property.
`Sort`	protected	Sorts column values in the control.
`TitlesChanged`	protected	Event handler signalled when TitleCaptions is changed.
`ValidateEntry`	protected	Validates data entered in a cell in the control.
`Create`	public	Constructor for the class instance.
`Destroy`	public	Destructor for the class instance.
`Clear`	public	Removes the content in the control.
`DeleteColRow`	public	Deletes the column or row at the specified position.
`DeleteRow`	public	Deletes the row at the specified position.
`DeleteCol`	public	Prevents column deletion in control.
`FindRow`	public	Locates the row with the specified Key name.
`InsertColRow`	public	Inserts a column or a row at the specified position.
`InsertRow`	public	Inserts a row at the specified position.
`InsertRowWithValues`	public	Inserts a row with the specified values at the specified position.
`ExchangeColRow`	public	Swaps the columns or rows at the specified positions.
`IsEmptyRow`	public	Indicates if the specified row is empty.
`LoadFromCSVStream`	public	Loads the content for the control from the comma-separated values in the specified stream.
`MoveColRow`	public	Moves the specified column or row to the new position.
`RestoreCurrentRow`	public	Restores pre-editing values in the current row.

Events

`OnBeforeSelection`	published	Event handler signalled before changing the Selection in the grid control.
`OnButtonClick`	published	Event handler signalled when a button-style cell Editor control is clicked.
`OnChangeBounds`	published	Event handler signalled when the Bounds for the control have been changed.
`OnCheckboxToggled`	published	Event handler signalled when the value for a check box cell is toggled.
`OnClick`	published	Notification handler for mouse clicks.
`OnColRowDeleted`	published	Event handler signalled when a grid column or row is deleted.
`OnColRowExchanged`	published	Event handler signalled when a column or row has been exchanged with another.
`OnColRowInserted`	published	Event handler signalled when a column or row is inserted into the grid.
`OnColRowMoved`	published	Event handler signalled when a column or row in the grid is moved.
`OnCompareCells`	published	Event handler signalled to compare the content in cells
`OnContextPopup`	published	Invoked when a context-sensitive pop-up menu is requested.
`OnDragDrop`	published	Event handler signalled when an object is dropped onto the control.
`OnDragOver`	published	Event handler signalled when a control is dragged over the control instance.
`OnDblClick`	published	Event handler signalled when a mouse double click occurs in the control.
`OnDrawCell`	published	Event handler signalled to draw a cell in the grid control.
`OnEditButtonClick`	published	Deprecated.
`OnEditingDone`	published	Event handler signalled when editing is completed for the control.
`OnEndDock`	published	Event handler signalled for the end of a drag-dock operation.
`OnEndDrag`	published	Event handler signalled for the end of a drag-drop operation.
`OnEnter`	published	Event handler signalled when the control receives focus.
`OnExit`	published	Event handler signalled when the control loses focus.
`OnGetEditMask`	published	Event handler signalled to get the edit mask used for a grid cell.
`OnGetEditText`	published	Event handler signalled to get the value for a cell editor in the grid.
`OnHeaderClick`	published	Event handler signalled when the fixed header for a column or row is clicked.
`OnHeaderSized`	published	Event handler signalled when a column or row header has been resized.
`OnHeaderSizing`	published	Event handler signalled when a column or row header sizing action is started.
`OnKeyDown`	published	Event handler signalled for key down keyboard events.
`OnKeyPress`	published	Event handler signalled for character data entered by the user.
`OnKeyUp`	published	Event handler signalled when a key up event has occurred for the control.
`OnMouseDown`	published	Event handler signalled when a mouse down event is handled for the control.
`OnMouseEnter`	published	Event handler signalled when the mouse pointer has entered the control.
`OnMouseLeave`	published	Event handler signalled when the mouse pointer has left the control.
`OnMouseMove`	published	Event handler signalled when the mouse pointer is moved in the control.
`OnMouseUp`	published	Event handler signalled when a mouse up event is handled for the control.
`OnMouseWheel`	published	Event handler for mouse wheel turned.
`OnMouseWheelDown`	published	Event handler signalled for a downward movement of the mouse wheel.
`OnMouseWheelUp`	published	Event handler signalled for an upward movement of the mouse wheel.
`OnMouseWheelHorz`	published	Event handler signalled for a horizontal movement of the mouse wheel.
`OnMouseWheelLeft`	published	Event handler signalled for a leftward movement of the mouse wheel.
`OnMouseWheelRight`	published	Event handler signalled for a rightward movement of the mouse wheel.
`OnPickListSelect`	published	Event handler signalled when an item is selected from a pick list-style Editor control.
`OnPrepareCanvas`	published	Event handler signalled to prepare the Canvas to draw the grid.
`OnResize`	published	Notification handler for a resize of the control.
`OnSelectEditor`	published	Event handler signalled to select an Editor control for the current grid cell.
`OnSelection`	published	Event handler signalled when an area is selected in the grid control.
`OnSelectCell`	published	Event handler signalled when a grid cell is selected.
`OnSetEditText`	published	Event handler signalled when the text in the cell Editor is assigned.
`OnShowHint`	published	Event handler signalled when a hint window is displayed for the control.
`OnStartDock`	published	Event handler for the start of a docking operation.
`OnStartDrag`	published	Event handler signalled for the start of a dragging operation.
`OnTopLeftChanged`	published	Event handler signalled when the top left cell in the visible area of the control is changed.
`OnUserCheckboxBitmap`	published	Event handler signalled to get the user-defined bitmap used for a check box cell.
`OnUTF8KeyPress`	published	Handler for a character entered by the user.
`OnValidateEntry`	published	Event handler signalled to perform validation for a cell value.
`OnGetPickList`	published	Event handler signalled to load values for the PickList in an item.
`OnStringsChange`	published	Event handler signalled when values in the Strings property are changed.
`OnStringsChanging`	published	Event handler signalled prior to updating the Strings property.
`OnValidate`	published	Not used in the current implementation.