Documentation Index
Fetch the complete documentation index at: https://mintlify.com/Steema/TeeGrid-VCL-FMX-Samples/llms.txt
Use this file to discover all available pages before exploring further.
Overview
The TFormat unit provides framework-agnostic formatting classes for defining visual styles in TeeGrid. These classes work identically across VCL, FireMonkey, and Lazarus frameworks.
Unit: Tee.Format.pas
Class Hierarchy
TPersistent
└── TPersistentChange
├── TBrush
├── TFont
├── TStroke
├── TFormat
│ ├── TVisibleFormat
│ └── TTextFormat
├── TGradient
├── TPicture
└── TCoordinate
TPersistentChange
Base class for all format classes with change notification.
Constructor
Constructor Create(const AChanged: TNotifyEvent);
AChanged: Event handler called when properties change
Properties
OnChange
property OnChange: TNotifyEvent read IChanged write IChanged;
TColor Type
type
TColor = TAlphaColor; // FMX/Modern Delphi
// or
TColor = Graphics.TColor; // VCL/Lazarus
TColorHelper
Helper record for color manipulation.
From
class function From(const AColor: TColor; const AOpacity: Single): TColor; static;
AColor: Base colorAOpacity: Opacity (0.0 - 1.0)
Example:
var
SemiTransparent: TColor;
begin
SemiTransparent := TColorHelper.From(clRed, 0.5); // 50% transparent red
end;
Opacity
class function Opacity(const AColor: TColor): Byte; static;
Split
class function Split(const AColor: TColor; out AOpacity: Single): TColor; static;
TBrush
Defines fill properties for shapes and backgrounds.
Properties
Color
property Color: TColor read FColor write SetColor;
Gradient
property Gradient: TGradient read GetGradient write SetGradient;
Brush.Gradient.Visible := True;
Brush.Gradient.Direction := TGradientDirection.Vertical;
Brush.Gradient.Colors[0].Color := clWhite;
Brush.Gradient.Colors[1].Color := clBlue;
Picture
property Picture: TPicture read GetPicture write SetPicture;
Visible
property Visible: Boolean read FVisible write SetVisible;
Methods
InitColor
procedure InitColor(const AColor: TColor);
Usage Example
var
Brush: TBrush;
begin
Brush := TBrush.Create(nil);
try
Brush.Color := clLightBlue;
Brush.Visible := True;
// Use with painter
Painter.SetBrush(Brush);
Painter.Fill(RectF(0, 0, 100, 50));
finally
Brush.Free;
end;
end;
TStroke
Defines outline/border properties.
Properties
Color
property Color: TColor read GetColor write SetColor;
Size
property Size: Single read FSize write SetSize;
Style
property Style: TStrokeStyle read FStyle write SetStyle;
Solid: Continuous lineDash: Dashed lineDot: Dotted lineDashDot: Dash-dot patternDashDotDot: Dash-dot-dot patternCustom: Custom pattern
EndStyle
property EndStyle: TStrokeEnd read FEnd write SetEnd;
Flat: Square end at endpoint (default)Round: Rounded endSquare: Square end extending beyond endpoint
JoinStyle
property JoinStyle: TStrokeJoin read FJoin write SetJoin;
Mitter: Sharp corner (default)Round: Rounded cornerBevel: Beveled corner
Visible
property Visible: Boolean read FVisible write SetVisible;
Constructors
Create
Constructor Create(const AChanged: TNotifyEvent);
CreateColor
Constructor CreateColor(const AChanged: TNotifyEvent; const AColor: TColor);
Usage Example
var
Stroke: TStroke;
begin
Stroke := TStroke.Create(nil);
try
Stroke.Color := clBlack;
Stroke.Size := 2;
Stroke.Style := TStrokeStyle.Dash;
Stroke.Visible := True;
Painter.SetStroke(Stroke);
Painter.Draw(RectF(0, 0, 100, 50));
finally
Stroke.Free;
end;
end;
THiddenStroke
TStroke with default Visible = False.
type
THiddenStroke = class(TStroke)
published
property Visible default False;
end;
TFont
Defines text font properties.
Properties
Name
property Name: String read FName write SetName;
Size
property Size: Single read FSize write SetSize;
Style
property Style: TFontStyles read FStyle write SetStyle;
fsBold: Bold textfsItalic: Italic textfsUnderline: Underlined textfsStrikeOut: Strikethrough text
Example:
Font.Style := [fsBold, fsItalic];
Color
property Color: TColor read GetColor write SetColor;
Brush
property Brush: TBrush read FBrush write SetBrush;
Class Variables
class var
DefaultSize: Single;
DefaultName: String;
Usage Example
var
Font: TFont;
begin
Font := TFont.Create(nil);
try
Font.Name := 'Segoe UI';
Font.Size := 12;
Font.Style := [fsBold];
Font.Color := clNavy;
Painter.SetFont(Font);
Painter.TextOut(RectF(0, 0, 100, 30), 'Bold Text');
finally
Font.Free;
end;
end;
TGradient
Defines gradient fill properties.
Properties
Direction
property Direction: TGradientDirection read FDirection write SetDirection;
Vertical: Top to bottomHorizontal: Left to rightDiagonal: Top-left to bottom-rightBackDiagonal: Top-right to bottom-leftRadial: Center outward
Colors
property Colors: TGradientColors read FColors write SetColors;
Gradient.Colors.Clear;
Gradient.Colors.Add(clWhite, 0.0); // Start color
Gradient.Colors.Add(clBlue, 0.5); // Middle color
Gradient.Colors.Add(clNavy, 1.0); // End color
Angle
property Angle: TAngle read FAngle write SetAngle;
Inverted
property Inverted: Boolean read FInverted write SetInverted;
Visible
property Visible: Boolean read FVisible write SetVisible;
Methods
InitColors
procedure InitColors(const AColor0, AColor1: TColor);
Usage Example
var
Brush: TBrush;
begin
Brush := TBrush.Create(nil);
try
Brush.Gradient.Visible := True;
Brush.Gradient.Direction := TGradientDirection.Vertical;
Brush.Gradient.InitColors(clWhite, clBlue);
Painter.SetBrush(Brush);
Painter.Fill(RectF(0, 0, 200, 100));
finally
Brush.Free;
end;
end;
TPicture
Defines image/bitmap properties.
Properties
Stretch
Controls whether picture is stretched to fill bounds.
Methods
LoadFromFile
procedure LoadFromFile(const AFileName: String);
SetGraphic
procedure SetGraphic(const AObject: TObject);
Clear
Clears the picture.
Usage Example
var
Brush: TBrush;
begin
Brush := TBrush.Create(nil);
try
Brush.Picture.LoadFromFile('background.png');
Brush.Picture.Stretch := True;
Painter.SetBrush(Brush);
Painter.Fill(RectF(0, 0, 300, 200));
finally
Brush.Free;
end;
end;
Properties
Brush
property Brush: TBrush read FBrush write SetBrush;
Stroke
property Stroke: TStroke read FStroke write SetStroke;
Methods
ShouldPaint
function ShouldPaint: Boolean;
True if either brush or stroke is visible.
Usage Example
var
Format: TFormat;
begin
Format := TFormat.Create(nil);
try
// Setup fill
Format.Brush.Color := clYellow;
Format.Brush.Visible := True;
// Setup border
Format.Stroke.Color := clBlack;
Format.Stroke.Size := 2;
Format.Stroke.Visible := True;
// Paint
Painter.Paint(Format, RectF(0, 0, 100, 50));
finally
Format.Free;
end;
end;
TTextFormat
Extends TFormat with font properties.
Properties
Font
property Font: TFont read FFont write SetFont;
Inherited
Brush: Background fillStroke: Border outline
Usage Example
var
Format: TTextFormat;
begin
Format := TTextFormat.Create(nil);
try
// Background
Format.Brush.Color := clWhite;
// Border
Format.Stroke.Color := clGray;
Format.Stroke.Visible := True;
// Font
Format.Font.Name := 'Arial';
Format.Font.Size := 10;
Format.Font.Color := clBlack;
// Use in column
Column.Format := Format;
finally
Format.Free;
end;
end;
Properties
Visible
property Visible: Boolean read FVisible write SetVisible;
Methods
Show / Hide
procedure Show;
procedure Hide;
TCoordinate
Defines a coordinate value in pixels or percentage.
Properties
Value
property Value: Single read FValue write SetValue;
Units
property Units: TSizeUnits read FUnits write SetUnits;
TSizeUnits.Pixels: Absolute pixelsTSizeUnits.Percent: Percentage of container
Automatic
property Automatic: Boolean read FAutomatic write SetAutomatic;
Pixels (Read-Only)
property Pixels: Single read IPixels;
Prepare.
Methods
Prepare
procedure Prepare(const ATotal: Single);
ATotal: Total size for percentage calculation
Calculate
function Calculate(const ATotal: Single): Single;
Usage Example
var
Margin: TCoordinate;
begin
Margin := TCoordinate.Create(nil);
try
// 5% margin
Margin.Units := TSizeUnits.Percent;
Margin.Value := 5;
Margin.Prepare(200); // Container width = 200
ShowMessage('Margin: ' + FloatToStr(Margin.Pixels)); // 10 pixels
finally
Margin.Free;
end;
end;
Common Patterns
function CreateHeaderFormat: TTextFormat;
begin
Result := TTextFormat.Create(nil);
Result.Brush.Color := clNavy;
Result.Font.Color := clWhite;
Result.Font.Style := [fsBold];
Result.Stroke.Color := clGray;
Result.Stroke.Visible := True;
end;
function CreateAlternateRowFormat: TFormat;
begin
Result := TFormat.Create(nil);
Result.Brush.Color := $00F5F5F5; // Light gray
Result.Brush.Visible := True;
end;
type
TMyGrid = class
private
FHeaderFormat: TTextFormat;
FRowFormat: TFormat;
public
constructor Create;
destructor Destroy; override;
end;
constructor TMyGrid.Create;
begin
inherited;
FHeaderFormat := CreateHeaderFormat;
FRowFormat := CreateAlternateRowFormat;
end;
destructor TMyGrid.Destroy;
begin
FHeaderFormat.Free;
FRowFormat.Free;
inherited;
end;
See Also
