TBAString¶

A string attribute

Declaration¶

TBAString = class(TBoldAttribute)

Hierarchy¶

TObject
TBoldMemoryManagedObject
TBoldFlaggedObject
TBoldSubscribableObject
TBoldElement
TBoldDomainElement
TBoldMember
TBoldAttribute
TBAString
Direct subclasses
TBAMLString
TBAMLSubString
TBATrimmedString

Description¶

This attribute type is used to store strings.

Methods¶

Name	Summary	Notes
Assign		override
AssignContentValue		protected, override
AssignValue		override
CanSetValue
CompareToAs		override
FreeContent		protected, override
GetStringRepresentation		protected, override
MaySetValue	Override to affect the result of CanSetValue .	protected, virtual
ProxyClass		protected, override
ProxyInterface		override
SetEmptyValue		override
SetStringRepresentation		protected, override
ValidateString		override

Assign¶

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

AssignContentValue¶

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

AssignValue¶

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

CanSetValue¶

function CanSetValue(NewValue: string; 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.

CompareToAs¶

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

This will compare the TBAString to any string value with the following result codes:

self.AsString < BoldElement.AsString returns -1
self.AsString = BoldElement.AsString returns 0
self.AsString > BoldElement.AsString returns 1

The CompType will decide how the strings will be compared:

ctDefault, ctAsAnsiText: AnsiCompareText
ctAsAnsiString: AnsiCompareStr
ctAsString: CompareStr
ctAsText: CompareText

FreeContent¶

procedure FreeContent; override; See also Ancestor Method

GetStringRepresentation¶

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

MaySetValue¶

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

A subclass of TBAString 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

SetEmptyValue¶

procedure SetEmptyValue; override; See also Ancestor Method

SetStringRepresentation¶

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

ValidateString¶

function ValidateString(Value: string; Representation: TBoldRepresentation): Boolean; override; See also Ancestor 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.