TBAInteger¶

An integer attribute

Declaration¶

TBAInteger = class(TBANumeric)

Hierarchy¶

TObject
TBoldMemoryManagedObject
TBoldFlaggedObject
TBoldSubscribableObject
TBoldElement
TBoldDomainElement
TBoldMember
TBoldAttribute
TBANumeric
TBAInteger
Direct subclasses
TBASmallInt
TBAWord

Description¶

This attribute type is used to store integer values (-2147483648..2147483647) (Low(integer)..High(integer)). It is also the base type of all the other bold attribute types that represent values from the integer range.

Properties¶

Name	Summary	Notes
AsInteger	The actual integer value

AsInteger¶

property AsInteger: integer;

This is the native delphi representation of the integer value.

Methods¶

Name	Summary	Notes
Assign		override
AssignContentValue		protected, override
AssignValue		override
CanSetValue
CheckRange	Ensure the value is within the legal range	virtual
CheckRangeWithBounds		protected
CompareToAs		override
GetAsFloat		protected, override
GetAsInteger		protected, virtual
GetAsVariant		override
GetStringRepresentation		protected, override
MaySetValue	Override to affect the result of CanSetValue .	protected, virtual
ProxyClass		protected, override
ProxyInterface		override
SetAsInteger		protected, override
SetAsVariant		override
SetStringRepresentation		protected, override
ValidateCharacter		override
ValidateString		override

Assign¶

procedure Assign(Source: TBoldElement); override; See also Ancestor Method

This will copy the integer value from another integer value

AssignContentValue¶

procedure AssignContentValue(Source: IBoldValue); override; See also Ancestor Method

AssignValue¶

procedure AssignValue(Source: IBoldValue); override; See also Ancestor Method

CanSetValue¶

function CanSetValue(Value: integer; Subscriber: TBoldSubscriber): Boolean;

Use this function to test if it is allowed to set the attribute to a specific value.

If a subscriber is sent to the function, this subscriber will be notified if the conditions have changed (so that an illegal value is now legal). It is OK to send a nilpointer instead.

CheckRange¶

function CheckRange(Value: integer): Boolean; virtual;

Note

CheckRange

will return true if the value is within (Low(integer)..High(integer)).

CheckRangeWithBounds¶

function CheckRangeWithBounds(Value, Min, Max: integer): boolean;

CompareToAs¶

function CompareToAs(CompType: TBoldCompareType; BoldElement: TBoldElement): Integer; override; See also Ancestor Method

This will compare the TBAInteger to any numeric value with the following result codes:

self.AsInteger < TBAInteger(BoldElement).AsInteger returns -1
self.AsInteger = TBAInteger(BoldElement).AsInteger returns 0
self.AsInteger > TBAInteger(BoldElement).AsInteger returns 1

GetAsFloat¶

function GetAsFloat: Double; override; See also Ancestor Method

GetAsInteger¶

function GetAsInteger: integer; virtual;

GetAsVariant¶

function GetAsVariant: Variant; override; See also Ancestor Method

GetStringRepresentation¶

function GetStringRepresentation(Representation: TBoldRepresentation): string; override; See also Ancestor Method

MaySetValue¶

function MaySetValue(NewValue: integer; Subscriber: TBoldSubscriber): Boolean; virtual;

A subclass of TBAInteger may override this method to prohibit setting the attribute to a specific value. If the result value is false, the setting will be aborted. If it is true, there may still be other reasons why the changing of the value is not allowed.

ProxyClass¶

function ProxyClass: TBoldMember_ProxyClass; override; See also Ancestor Method

ProxyInterface¶

function ProxyInterface(const IId: TGUID; Mode: TBoldDomainElementProxyMode; out Obj): Boolean; override; See also Ancestor Method

SetAsInteger¶

procedure SetAsInteger(Value: integer); override; See also Ancestor Method

SetAsVariant¶

procedure SetAsVariant(const Value: Variant); override; See also Ancestor Method

SetStringRepresentation¶

procedure SetStringRepresentation(Representation: TBoldRepresentation; Value: string); override; See also Ancestor Method

ValidateCharacter¶

function ValidateCharacter(C: AnsiChar; Representation: TBoldRepresentation): Boolean; override; See also Ancestor Method

Returns True if C is one of '0'..'9', '-' or '+'

ValidateString¶

function ValidateString(Value: string; Representation: TBoldRepresentation): Boolean; override; See also Ancestor Method

Returns true if the string can be converted to an integer, and if the result is a valid value for the current subclass (subclasses mey restrict the valid range by overriding the CheckRange method)

Generated from the Bold 4.0 help (Help/BfD.chm) by Tools/chm2mkdocs.py; member lists reflect Bold 4.0, see the source for members added since.