Class TCustomRowOrColumn

DescriptionHierarchyFieldsMethodsProperties

Unit

RbwDataGrid4

Declaration

type TCustomRowOrColumn = class(TCollectionItem)

Description

TCustomRowOrColumn is the abstract ancestor of TRbwColumn4 and TRbwRow.

Hierarchy

Overview

Fields

Private FAutoAdjustRowHeights: boolean;
Private FButtonCaption: string;
Private FButtonFont: TFont;
Private FButtonUsed: boolean;
Private FButtonWidth: integer;
Private FCaptionAlignment: TAlignment;
Private FCellAlignment: TAlignment;
Private FCheckMax: boolean;
Private FCheckMin: boolean;
Private FFormat: TRbwColumnFormat4;
Private FLimitToList: Boolean;
Private FMax: extended;
Private FMaxLength: Integer;
Private FMin: extended;
Private FParentButtonFont: boolean;
Private FPickList: TStrings;
Private FWordWrapCaptions: boolean;
Private FWordWrapCells: boolean;
Private FComboUsed: boolean;

Methods

Private Procedure CheckCell(const ACol, ARow : integer);
Private function GetButtonFont: TFont;
Private procedure SetAutoAdjustRowHeights(const Value: boolean);
Private procedure SetButtonCaption(const Value: string);
Private procedure SetButtonFont(const Value: TFont);
Private procedure SetButtonUsed(const Value: boolean);
Private procedure SetButtonWidth(const Value: integer);
Private procedure SetCaptionAlignment(const Value: TAlignment);
Private procedure SetCellAlignment(const Value: TAlignment);
Private procedure SetCheckMax(const Value: boolean);
Private procedure SetCheckMin(const Value: boolean);
Private procedure SetComboUsed(const Value: boolean);
Private procedure SetFormat(const Value: TRbwColumnFormat4);
Private procedure SetMax(const Value: extended);
Private procedure SetMin(const Value: extended);
Private procedure SetParentButtonFont(const Value: boolean);
Private procedure SetPickList(const Value: TStrings);
Private procedure SetWordWrapCaptions(const Value: boolean);
Private procedure SetWordWrapCells(const Value: boolean);
Private function GetCaseSensitivePicklist: boolean;
Private procedure SetCaseSensitivePicklist(const Value: boolean);
Protected procedure CheckRange; virtual; abstract;
Protected function CollectionItemPosition: integer; virtual; abstract;
Protected function GetGrid: TCustomRbwDataGrid; virtual; abstract;
Protected function SelectedRowOrColumn: integer; virtual; abstract;
Protected procedure SetGridRowOrColumnCount(const Value: integer); virtual; abstract;
Public procedure CheckACell(const ACol, ARow: integer; LocalCheckMax, LocalCheckMin: Boolean; LocalMax, LocalMin: extended);
Public constructor Create(Collection: TCollection); override;
Public destructor Destroy; override;
Public procedure Assign(Source: TPersistent); override;

Properties

Public property Grid: TCustomRbwDataGrid read GetGrid;
Published property AutoAdjustRowHeights: boolean read FAutoAdjustRowHeights write SetAutoAdjustRowHeights;
Published property ButtonCaption: string read FButtonCaption write SetButtonCaption;
Published property ButtonFont: TFont read GetButtonFont write SetButtonFont;
Published property ButtonUsed: boolean read FButtonUsed write SetButtonUsed;
Published property ButtonWidth: integer read FButtonWidth write SetButtonWidth;
Published property CaptionAlignment: TAlignment read FCaptionAlignment write SetCaptionAlignment default taCenter;
Published property CellAlignment: TAlignment read FCellAlignment write SetCellAlignment default taLeftJustify;
Published property CheckMax : boolean read FCheckMax write SetCheckMax;
Published property CheckMin : boolean read FCheckMin write SetCheckMin;
Published property ComboUsed: boolean read FComboUsed write SetComboUsed;
Published property Format: TRbwColumnFormat4 read FFormat write SetFormat;
Published property LimitToList: Boolean read FLimitToList write FLimitToList;
Published property Max : extended read FMax write SetMax;
Published property MaxLength: Integer read FMaxLength write FMaxLength;
Published property Min : extended read Fmin write SetMin;
Published property ParentButtonFont: boolean read FParentButtonFont write SetParentButtonFont default True;
Published property PickList: TStrings read FPickList write SetPickList;
Published property WordWrapCaptions: boolean read FWordWrapCaptions write SetWordWrapCaptions;
Published property WordWrapCells: boolean read FWordWrapCells write SetWordWrapCells;
Published property CaseSensitivePicklist: boolean read GetCaseSensitivePicklist write SetCaseSensitivePicklist;

Description

Fields

Private FAutoAdjustRowHeights: boolean;

See AutoAdjustRowHeights.

Private FButtonCaption: string;

See ButtonCaption.

Private FButtonFont: TFont;

See ButtonFont.

Private FButtonUsed: boolean;

See ButtonUsed.

Private FButtonWidth: integer;

See ButtonWidth.

Private FCaptionAlignment: TAlignment;

See CaptionAlignment.

Private FCellAlignment: TAlignment;

See CellAlignment.

Private FCheckMax: boolean;

See CheckMax.

Private FCheckMin: boolean;

See CheckMin.

Private FFormat: TRbwColumnFormat4;

See Format.

Private FLimitToList: Boolean;

See LimitToList.

Private FMax: extended;

See Max.

Private FMaxLength: Integer;

See MaxLength.

Private FMin: extended;

See Min.

Private FParentButtonFont: boolean;

See ParentButtonFont.

Private FPickList: TStrings;

See PickList.

Private FWordWrapCaptions: boolean;

See WordWrapCaptions.

Private FWordWrapCells: boolean;

See WordWrapCells.

Private FComboUsed: boolean;

See ComboUsed.

Methods

Private Procedure CheckCell(const ACol, ARow : integer);

CheckCell checks that the contents of a cell specified by ACol and ARow match the constraints on the cell as specified in Format, CheckMax, CheckMin, Max, Min, and MaxLength.

Private function GetButtonFont: TFont;

GetButtonFont returns either Grid.Font or FButtonFont as appropriate. See ButtonFont.

Private procedure SetAutoAdjustRowHeights(const Value: boolean);

See AutoAdjustRowHeights.

Private procedure SetButtonCaption(const Value: string);

See ButtonCaption.

Private procedure SetButtonFont(const Value: TFont);

See ButtonFont.

Private procedure SetButtonUsed(const Value: boolean);

See ButtonUsed.

Private procedure SetButtonWidth(const Value: integer);

See ButtonWidth.

Private procedure SetCaptionAlignment(const Value: TAlignment);

See CaptionAlignment.

Private procedure SetCellAlignment(const Value: TAlignment);

See CellAlignment.

Private procedure SetCheckMax(const Value: boolean);

See CheckMax.

Private procedure SetCheckMin(const Value: boolean);

See CheckMin.

Private procedure SetComboUsed(const Value: boolean);

See ComboUsed.

Private procedure SetFormat(const Value: TRbwColumnFormat4);

See Format.

Private procedure SetMax(const Value: extended);

See Max.

Private procedure SetMin(const Value: extended);

See Min.

Private procedure SetParentButtonFont(const Value: boolean);

See ParentButtonFont.

Private procedure SetPickList(const Value: TStrings);

See PickList.

Private procedure SetWordWrapCaptions(const Value: boolean);

See WordWrapCaptions.

Private procedure SetWordWrapCells(const Value: boolean);

See WordWrapCells.

Private function GetCaseSensitivePicklist: boolean;
 
Private procedure SetCaseSensitivePicklist(const Value: boolean);
 
Protected procedure CheckRange; virtual; abstract;

CheckRange checks that all the cells in the TCustomRowOrColumn have values that are between Max and Min

Protected function CollectionItemPosition: integer; virtual; abstract;

CollectionItemPosition is the position of CollectionItemPosition in its TCollection.

Protected function GetGrid: TCustomRbwDataGrid; virtual; abstract;

See Grid.

Protected function SelectedRowOrColumn: integer; virtual; abstract;

SelectedRowOrColumn returns the selected row or column of Grid.

Protected procedure SetGridRowOrColumnCount(const Value: integer); virtual; abstract;

SetGridRowOrColumnCount sets the format of the TCustomRowOrColumn).

Public procedure CheckACell(const ACol, ARow: integer; LocalCheckMax, LocalCheckMin: Boolean; LocalMax, LocalMin: extended);
 
Public constructor Create(Collection: TCollection); override;

Create creates an instance of TCustomRowOrColumn.

Public destructor Destroy; override;

Destroy destroys TCustomRowOrColumn. Do not call Destroy. Call Free instead.

Public procedure Assign(Source: TPersistent); override;

if Source is a TCustomRowOrColumn, Assign copies it to the current instance of TCustomRowOrColumn.

Properties

Public property Grid: TCustomRbwDataGrid read GetGrid;

Grid is the TCustomRBWDataGrid that owns TCustomRowOrColumn.

Published property AutoAdjustRowHeights: boolean read FAutoAdjustRowHeights write SetAutoAdjustRowHeights;

AutoAdjustRowHeights specifies whether the height of the row should be adjusted.

Published property ButtonCaption: string read FButtonCaption write SetButtonCaption;

ButtonCaption is the caption displayed on the button.

Published property ButtonFont: TFont read GetButtonFont write SetButtonFont;

ButtonFont is the font on the button.

Published property ButtonUsed: boolean read FButtonUsed write SetButtonUsed;

ButtonUsed specifies whether or not a button is used in the current column or row.

Published property ButtonWidth: integer read FButtonWidth write SetButtonWidth;

ButtonWidth ButtonWidth is the width of the button.

Published property CaptionAlignment: TAlignment read FCaptionAlignment write SetCaptionAlignment default taCenter;

In the cells that are captions of a column or row, CaptionAlignment specifies the alignment of the text in those cells.

Published property CellAlignment: TAlignment read FCellAlignment write SetCellAlignment default taLeftJustify;

In the cells that are NOT captions of a column or row, CellAlignment specifies the alignment of the text in those cells.

Published property CheckMax : boolean read FCheckMax write SetCheckMax;

CheckMax specifies whether the maximum value that can be entered in a cell is Max. CheckMax is only used if Format is rcf4Integer or rcf4Real.

Published property CheckMin : boolean read FCheckMin write SetCheckMin;

CheckMin specifies whether the minimum value that can be entered in a cell is Min. CheckMin is only used if Format is rcf4Integer or rcf4Real.

Published property ComboUsed: boolean read FComboUsed write SetComboUsed;

ComboUsed specifies whether or not a combobox is used in the current column or row.

Published property Format: TRbwColumnFormat4 read FFormat write SetFormat;

Format is the format of a column or row.

Published property LimitToList: Boolean read FLimitToList write FLimitToList;

LimitToList specifies whether or not a user can type a value in a combobox that is not in PickList. LimitToList is only used if ComboUsed is True.

Published property Max : extended read FMax write SetMax;

Max is the maximum value that can be entered in a cell. Max is only used if Format is rcf4Integer or rcf4Real and CheckMax is True.

Published property MaxLength: Integer read FMaxLength write FMaxLength;

MaxLength is the maximum length of a string that can be entered in a cell; MaxLength is only used if Format is rcf4String.

Published property Min : extended read Fmin write SetMin;

Min is the minimum value that can be entered in a cell. Min is only used if Format is rcf4Integer or rcf4Real and CheckMin is True.

Published property ParentButtonFont: boolean read FParentButtonFont write SetParentButtonFont default True;

if ParentButtonFont is True, the button will always have the same font as Grid. If ParentButtonFont is False the button can have a font that is different from the grid.

Published property PickList: TStrings read FPickList write SetPickList;

PickList contains the list of items in the combobox.

Published property WordWrapCaptions: boolean read FWordWrapCaptions write SetWordWrapCaptions;

WordWrapCaptions determines whether or not word-wrapping will be applied to the text of cells that are captions.

Published property WordWrapCells: boolean read FWordWrapCells write SetWordWrapCells;

WordWrapCells determines whether or not word-wrapping will be applied to the text of cells that are NOT captions.

Published property CaseSensitivePicklist: boolean read GetCaseSensitivePicklist write SetCaseSensitivePicklist;
 
Generated by PasDoc 0.12.1 on 2013-05-13 15:41:59