Column

Qualified name: delphifmx.Column

class Column

Bases: Control

Methods

AbsoluteToLocal	Converts the screen coordinates of a specified point on the screen to client coordinates.
BringToFront	Puts the control in front of all other controls in its parent control.
CanEdit	Returns True if the column can show a value editor or False otherwise.
CanFocus	Indicates whether a control can receive focus.
Changed	This method is called when the column changes, and it notifies the model about those changes.
DefaultDrawCell	Draws the default cell background.
EditingCancelled	This virtual method is called from the EditingDone method if the parameter is False and some changes are made.
EditingDone	Called when the user finishes using the specified column editor (InplaceEdit) on a cell.
EditorModified	This method should be performed in the cell editor to notify the grid about changes.
LocalToAbsolute	Translates a given point from client area coordinates to global screen coordinates.
PostEditorValue	Sends the MM_POST_EDITOR_VALUE message to the presentation.
PrepareForPaint	Prepares the current control for painting.
RectPlaceIntoBounds	Stretches and aligns the Source rectangle, preserving its rectangle proportions, to best fit into the Bounds rectangle.
RefreshEditor	Changes the value of the column editor (InplaceEdit) to the specified value, and returns True on success or False otherwise.
Repaint	Forces the control to repaint its image on the screen.
ResetFocus	Removes the focus from a control of from any children of the control.
SendToBack	Puts a windowed control behind all other windowed controls, or puts a non-windowed control behind all other non-windowed controls.
SetBounds	Sets the Left, Top, Width, and Height properties all at once.
SetFocus	Gives the input focus to the control.
UpdateCell	Embarcadero Technologies does not currently have any additional information.
ValidChar	Returns True if the specified character is a valid character for a cell of this column or False otherwise.
ValueIsEmpty	Determines that the specified value should not be displayed in the cell and stored in the caches.
ValueToString	Draws the value of the column cell.

Attributes

AbsoluteClipRect	Specifies the absolute rectangle of the control after all its parent controls clip it.
AbsoluteEnabled	Specifies whether the control is absolutely enabled.
AbsoluteHeight	Specifies the absolute height of the control.
AbsoluteMatrix	Specifies the absolute transformation matrix of the control.
AbsoluteOpacity	Specifies the absolute opacity of the control.
AbsoluteRect	Specifies the absolute rectangle that bounds the control.
AbsoluteScale	Specifies the absolute scale of the control.
AbsoluteWidth	Specifies the absolute width of the control.
Action	Specifies the action associated with the control.
ActionClient	Specifies whether the component object has an associated action.
Align	Specifies the alignment options (top, left, client, and so on) of this control.
Anchors	Specifies how the control is anchored to its parent.
ApplyingEffect	A flag that signals when a control is in the process of applying an effect.
AutoCapture	Specifies whether the control captures mouse events.
AxisAlignedRect	A TRectF defined by the width and height of the control.
BoundsRect	Specifies the bounding rectangle of the control.
CanParentFocus	Specifies whether the parent of this control should be evaluated to receive focus.
Canvas	Provides the drawing surface of the control.
Children	Stores an array of children attached to this parent component.
ChildrenCount	Read-only property that specifies the number of children in the children list.
ChildrenRect	Specifies the bigger rectangle area occupied by parent and children controls.
ClassName	Returns the TObject.ClassName
ClipChildren	Specifies if children of the control should be clipped to the control's on-screen region.
ClipParent	Specifies whether the current control has clipped its parent.
ClipRect	Specifies the bound rectangle to be clipped.
ComObject	Specifies the interface reference implemented by the component.
ComponentCount	Returns the owned component count
ComponentIndex	Indicates the position of the component in its owner's Components property array.
ComponentState	Describes the current state of the component, indicating when a component needs to avoid certain actions.
ComponentStyle	Governs the behavior of the component.
Components	Returns an iterator over the owned components
Controls	Returns an iterator over contained controls
ControlsCount	Returns the count of contained controls
Cursor	Image to use to represent the mouse pointer when it passes into the region covered by the control.
Data	Stores a Tvalue, which is a data structure that can store different kinds of data types.
DefaultSize	Embarcadero Technologies does not currently have any additional information.
DefaultTextSettings	Default text settings.
DesignInfo	Contains information used by the Form designer.
DisableDisappear	Embarcadero Technologies does not currently have any additional information.
DisableFocusEffect	Specifies whether the control has the focus effect disabled.
DragMode	Specifies how the control initiates drag-and-drop operations.
EditorState	Specifies the current state of the cell editor.
EffectiveVisible	Indicates whether this column is visible (True) or not (False).
EnableDragHighlight	Specifies whether the control is highlighted when the dragged object is over it.
Enabled	Specifies whether the control responds to mouse, keyboard, and timer events.
FixedSize	Embarcadero Technologies does not currently have any additional information.
HasAfterPaintEffect	Specifies whether the control has an effect that is applied after the control is painted.
HasClipParent	Control that is a direct child of this control and has clipped this control.
HasDisablePaintEffect	Specifies whether the control's effect is painted.
HasEffect	Specifies whether the control has an applied effect.
Header	Specifies the string in the header cell of the column.
HeaderSettings	HeaderSettings:
Height	Height specifies the vertical size of the control (in dp).
Hint	Specifies the text string that appears when the user moves the mouse over a control.
HitTest	Enables the control to capture mouse events.
HorzAlign	Embarcadero Technologies does not currently have any additional information.
HorzAlignModified	Embarcadero Technologies does not currently have any additional information.
InEditMode	Determines what column is in edit mode.
InPaintTo	Specifies whether the control is currently being painted.
Index	Specifies the index of the child object in the children array attached to this object.
InheritedCursor	Image used to represent the mouse pointer when it passes into the region covered by the control.
InvertAbsoluteMatrix	Specifies the inverse matrix of AbsoluteMatrix.
IsDragOver	Specifies whether a dragged object is over the area of the current control.
IsFocused	Determines whether the control has input focus.
IsInflated	Whether the current style of this control has been actually applied to the control.
IsMouseOver	Specifies whether the mouse cursor is over the control.
IsVisible	Specifies whether the control is visible.
Layout	The current text layout that is used to draw text in cells.
LocalRect	Specifies the local rectangle for painting the control.
Locked	Specifies whether the control is locked at design time.
Margins	Aligns the component to the margins points of other components.
Model	The reference to the data model of the parent control.
Name	Specifies the name of the component as referenced in code.
Observers	Indicates the TObservers object added to the TComponent.
OnGesture	Callable[[Object, GestureEventInfo, bool], None]:
Opacity	Specifies the control opacity.
OriginalIndex	Embarcadero Technologies does not currently have any additional information.
Owner	Returns the Component Owner
Padding	The padding of any cells in this column
Parent	Returns/Sets the Control Visibility
ParentControl	Specifies the parent control of this control.
ParentedRect	Specifies the bounding rectangle of the control within its parent.
ParentedVisible	Specifies whether all the control's parents are visible.
PopupMenu	Specifies the context (pop-up) menu object.
Position	Returns an access to the position of the control inside its parent
PresentedControl	The reference to the control using this column and the data model.
Pressed	Indicates whether the control is currently pressed.
PressedPosition	A point that indicates where exactly on the control the click occured.
ReadOnly	Specifies whether the cells in this column can be edited or not.
Root	Specifies the root parent of this object.
Scene	Specifies the current scene in which the control is drawn.
ShowHint	Specifies whether the Hint can be shown.
Size	Specifies the vertical and horizontal size (Size.Height and Size.Width) of the control (in pixels).
Stored	Specifies whether this object is stored in the .XFM file.
StyleName	Specifies the style name for this FMX component.
TabOrder	Indicates the position of the control in its parent's tab order.
TabStop	Embarcadero Technologies does not currently have any additional information.
Tag	Stores a NativeInt integral value as a part of a component.
TagFloat	Custom property that stores any floating-point value.
TagObject	Custom property that stores any object value.
TagString	Custom property that stores any string value.
Touch	Specifies the touch manager component associated with the control.
TouchTargetExpansion	Set of optional pixel values you can specify to expand the touch target of a FireMonkey styled control.
UpdateRect	Specifies the rectangle area of the control that needs to be updated.
VCLComObject	Represents information used internally by components that support COM.
Visible	Returns/Sets the Control Visibility
Width	Specifies the horizontal size of the control (in pixels).

AbsoluteToLocal()

Converts the screen coordinates of a specified point on the screen to client coordinates.

Action

Specifies the action associated with the control. Action allows an application to centralize the response to user commands. When a control is associated with an action, the action determines the appropriate properties and events of the control (such as whether the control is enabled or how it responds to an OnClick event). If an object of the descendant from the TFmxObject class does not support actions, and when this object tries to assign a value to the Action property, the setter method for Action calls GetActionLinkClass that should return nil. In this case, attempting to set a value to the Action property raises the following exception:

StrEActionNoSuported = ‘Class %s does not support the action’

Type:

BasicAction

BringToFront()

Puts the control in front of all other controls in its parent control.

CanEdit()

Returns True if the column can show a value editor or False otherwise.

CanFocus()

Indicates whether a control can receive focus.

Changed()

This method is called when the column changes, and it notifies the model about those changes.

Controls

Returns an iterator over contained controls

ControlsCount

Returns the count of contained controls

DefaultDrawCell(Canvas: Canvas, Bounds: RectF, Row: int, Value: Value, State: GridDrawStates) → None

Draws the default cell background. DefaultDrawCell receives the following parameters:

Canvas is the canvas where DefaultDrawCell paints the cell background. Bounds indicates the cell boundaries. Row is the row number. Value is the cell value. State is the drawing state of the cell. DrawCell calls DefaultDrawCell if Model.DefaultDrawing is True.

DefaultTextSettings

Default text settings.

Type:

TextSettings

EditingCancelled()

This virtual method is called from the EditingDone method if the parameter is False and some changes are made. You can override this method in the heir, but you do not have to call it manually. This method is used to interact with the LiveBinding.

EditingDone(InplaceEdit: Object, Value: Value, Accept: bool) → bool

Called when the user finishes using the specified column editor (InplaceEdit) on a cell. Value contains the value defined with the column editor. If Accept is True, EditingDone changes the value of the cell to Value and returns True on success or False otherwise. If Accept is False, EditingDone always returns True.

EditorModified()

This method should be performed in the cell editor to notify the grid about changes.

EditorState

Specifies the current state of the cell editor.

Type:

Column.TEditorState

EffectiveVisible

Indicates whether this column is visible (True) or not (False).

Type:

bool

Enabled

Specifies whether the control responds to mouse, keyboard, and timer events. Use Enabled to change the availability of the control to the user. To disable a control, set Enabled to False. Some disabled controls appear dimmed (for example: buttons, check boxes, labels), while others (container controls) simply lose their functionality without changing their appearance. If Enabled is set to False, the control ignores mouse, keyboard, and timer events. To re-enable a control, set Enabled to True. This property applies to all TControl descendants.

Type:

bool

Header

Specifies the string in the header cell of the column.

Type:

str

HeaderSettings

HeaderSettings:

HorzAlign

Embarcadero Technologies does not currently have any additional information.

Type:

TextAlign

HorzAlignModified

Embarcadero Technologies does not currently have any additional information.

Type:

bool

InEditMode

Determines what column is in edit mode. This property is left for compatibility.

Type:

bool

IsFocused

Determines whether the control has input focus.

Layout

The current text layout that is used to draw text in cells.

Type:

TextLayout

LocalToAbsolute()

Translates a given point from client area coordinates to global screen coordinates.

Locked

Specifies whether the control is locked at design time. A locked control prohibits to move the control at design time, all the other properties can be modified at design time. To lock the control, set Locked to True. By default, Locked is False, and the control can be modified at design time.

Type:

bool

Margins

Aligns the component to the margins points of other components. The Margins of a control are the distances (in pixels) from each edge (top, left, bottom, right) to another control within the same Parent or to the edge of its Parent. The Margins add space to the outer side of the control. It only applies for controls that do not use TAlignLayout None and the components are located to each other. If a margin is not 0, no other control will come closer to the control than the specified distance. If the distance from a Parent edge to the corresponding control edge is smaller than the specified Margins for that edge, the control is repositioned and resized, if necessary, to maintain the specified distance. If the Margins control has zero values, RAD Studio uses the default values (Left=4, Top=4, Right=4, Bottom=4). You can also set your own Margins values. It only applies to the IDE control’s guidelines, when you are dragging control. But if you use Align=Client (for example), it will use the specified values in Margins. The following image shows how Padding and Margins properties affect alignment, position, and size of controls.

Type:

Bounds

Model

The reference to the data model of the parent control. Model is set when changing the parent control. If a current column does not belong to the TPresentedControl, or the model of PresentedControl does not belong to the TGridModel, then this property contains nil.

Type:

GridModel

Opacity

Specifies the control opacity. Set Opacity to customize the transparency of the current control. Opacity takes values between 0 and 1. If Opacity is 1, the control is completely opaque; if it is 0, the control is completely transparent. The values over 1 are treated as 1, and the ones under 0 are treated as 0. Opacity applies to the control’s children.

Type:

float

OriginalIndex

Embarcadero Technologies does not currently have any additional information.

Type:

int

Padding

The padding of any cells in this column

Type:

Bounds

PopupMenu

Specifies the context (pop-up) menu object. Use PopupMenu to set the context menu of the current control. The pop-up window is displayed when ShowContextMenu is called.

Type:

CustomPopupMenu

Position

Returns an access to the position of the control inside its parent

PostEditorValue(InplaceEdit: Object, Value: Value) → bool

Sends the MM_POST_EDITOR_VALUE message to the presentation. This method is used in LiveBinding.

PrepareForPaint()

Prepares the current control for painting.

PresentedControl

The reference to the control using this column and the data model.

Type:

PresentedControl

ReadOnly

Specifies whether the cells in this column can be edited or not. Set ReadOnly to True to specify that the content of the cells can only be read.

Type:

bool

RectPlaceIntoBounds(Source: RectF, Bounds: RectF) → RectF

Stretches and aligns the Source rectangle, preserving its rectangle proportions, to best fit into the Bounds rectangle. RectPlaceIntoBounds calls PlaceInto to best fit the Source rectangle, preserving its rectangle proportions, into the Bounds rectangle. RectPlaceIntoBounds uses the default alignment parameters of the current column to align the stretched rectangle in the Bounds rectangle. RectPlaceIntoBounds returns Source if any of the Bounds rectangle dimensions is zero.

RefreshEditor(InplaceEdit: Object, Value: Value) → bool

Changes the value of the column editor (InplaceEdit) to the specified value, and returns True on success or False otherwise. This function may return False, for example, if the target column is read-only and the editor does not support read-only values, which prevents the editor from working.

Repaint()

Forces the control to repaint its image on the screen.

ResetFocus()

Removes the focus from a control of from any children of the control.

SendToBack()

Puts a windowed control behind all other windowed controls, or puts a non-windowed control behind all other non-windowed controls.

SetBounds(Left, Top, Width, Height)

Sets the Left, Top, Width, and Height properties all at once.

SetFocus()

Gives the input focus to the control.

UpdateCell(ARow: int) → None

Embarcadero Technologies does not currently have any additional information.

ValidChar(KeyChar: unicodechr(str)) → bool

Returns True if the specified character is a valid character for a cell of this column or False otherwise. For example, if the column contains numeric values, only digits, sign symbols (+ and -) and digit separators (, and .) would be considered valid.

ValueIsEmpty(Value: Value) → bool

Determines that the specified value should not be displayed in the cell and stored in the caches.

ValueToString(Value: Value) → str

Draws the value of the column cell. Each column type defines its own implementation of this method to convert TValue into string value.

Visible

Returns/Sets the Control Visibility

Width

Specifies the horizontal size of the control (in pixels). Use the Width property to read or change the width of the control.

Type:

float