Project FastScript 1.6
FastScript 1.6

Packages:
FS

FastScript is scripting library. It is intended for programmers who want to add scripting ability to their projects. FastScript is written on 100% Object Pascal and can be installed in Delphi 4-7, C++Builder 4-6 and Kylix 1-3. Unique feature of FastScript is ability to use many languages (PascalScript, C++Script, JScript, BasicScript), so you can write scripts on your favourite language.

FastScript features are:

- Multi-language architecture allows you to use many languages (at this moment - PascalScript, C++Script, JScript, BasicScript). It is possible to add any procedural language (language definition is stored in XML format).
- Standard language features: variables, constants, procedures, functions (nested allowed) with var/const/default parameters, all standard operators and statements (includind case, try/finally/except, with), types (int, float, bool, char, string, multi-dimensional array, enum, variant), classes (with methods, events, properties, index and default properties).
- Strict type checking.
- Access to any object inside your application. Standard libraries to access to base classes, controls, forms and DB. Easily expandable library architecture.
- Small footprint - 90-150Kb depending on modules used.

Missing features are:

- No type definition (records, classes) inside script; no records, no pointers, no sets (but you can use 'IN' operator - "a in ['a'..'c','d']"), no
shortstrings, no dynamic arrays, no GOTO statement.
- C++Script: no octal constants; no 'break' in the SWITCH operator (SWITCH works like Pascal CASE); '++' and '--' operators allowed only after the variable, i.e. '++i' is not allowed; '--', '++' and '=' operators doesn't return a value, i.e. 'if(i++)' is not allowed; identifiers are case-insensitive; NULL constant is Pascal Null   - use nil instead of NULL.


Scope
Published

Accessibility
Read Only


Scope


Scope
Published


Example Add a method
Add a method

Example of adding an external method to a script.

procedure TForm1.DelphiFunc(s: String; i: Integer);
begin
  ShowMessage(s + ', ' + IntToStr(i));
end;

function TForm1.CallMethod(Instance: TObject; ClassType: TClass;
  const MethodName: String; var Params: Variant): Variant;
begin
  { dispatch the method call }
  if MethodName = 'DELPHIFUNC' then
    DelphiFunc(Params[0], Params[1]);
end;

procedure TForm1.Button1Click(Sender: TObject);
begin
  { clear all items }
  fsScript1.Clear;
  { script text }
  fsScript1.Lines := Memo1.Lines;
  { frGlobalUnit contains standard types and functions }
  fsScript1.Parent := fsGlobalUnit;
  { make DelphiFunc procedure visible to a script }
  fsScript1.AddMethod('procedure DelphiFunc(s: String; i: Integer)', CallMethod);

  { compile the script }
  if fsScript1.Compile then
    fsScript1.Execute else   { execute if compilation was succesfull }
    ShowMessage(fsScript1.ErrorMsg); { show an error message }
end;


Example Add an event
Add an event

type
  { analogue of TNotifyEvent }
  TfsNotifyEvent = class(TfsCustomEvent)
  public
    procedure DoEvent(Sender: TObject);
    function GetMethod: Pointer; override;
  end;

  { analogue of TKeyPressEvent = procedure(Sender: TObject; var Key: Char) }
  TfsKeyPressEvent = class(TfsCustomEvent)
  public
    procedure DoEvent(Sender: TObject; var Key: Char);
    function GetMethod: Pointer; override;
  end;

{ TfsNotifyEvent }

procedure TfsNotifyEvent.DoEvent(Sender: TObject);
begin
  { CallHandler is an internal method }
  CallHandler([Sender]);
end;

function TfsNotifyEvent.GetMethod: Pointer;
begin
  Result := @TfsNotifyEvent.DoEvent;
end;

{ TfsKeyPressEvent }

procedure TfsKeyPressEvent.DoEvent(Sender: TObject; var Key: Char);
begin
  CallHandler([Sender, Key]);
  { get var parameter }
  Key := String(Handler.Params[1].Value)[1];
end;

function TfsKeyPressEvent.GetMethod: Pointer;
begin
  Result := @TfsKeyPressEvent.DoEvent;
end;


Example fsPosToPoint example
fsPosToPoint example

Shows how to convert plain text position to the line/column position.

var
  Prog: TfsScript;
  pt: TPoint;

  Prog.Lines := Memo1.Lines;
  if not Prog.Compile then
  begin
    pt := fsPosToPoint(Prog.ErrorPos);
    ShowMessage('Error at ' + IntToStr(pt.X) + '/' + IntToStr(pt.Y) + ': ' + Prog.ErrorMsg)
  end;


Example GenerateXMLContents example
GenerateXMLContents example

Generates a tree of installed functions.

procedure FillFunctionsTree;
var
  FXML: TfsXMLDocument;

  procedure AddFunctions(xi: TfsXMLItem; Root: TTreeNode);
  var
    i: Integer;
    Node: TTreeNode;
    s: String;
  begin
    s := xi.Prop['text'];
    Node := TreeView1.Items.AddChild(Root, s);
    if Root = nil then
      Node.Text := 'Functions';

    for i := 0 to xi.Count - 1 do
      AddFunctions(xi[i], Node);
  end;

begin
  FXML := TfsXMLDocument.Create;
  GenerateXMLContents(frGlobalUnit, FXML.Root);

  TreeView1.Items.BeginUpdate;
  TreeView1.Items.Clear;
  AddFunctions(FXML.Root.FindItem('Functions'), nil);

  TreeView1.FullExpand;
  TreeView1.Items.EndUpdate;
  FXML.Free;
end;


Example Implement a class method
Implement a class method

This example shows how to add a public method to a class.

var
  Prog: TfsScript;
begin
  ...
  { add new class inherited from TObject }
  with Prog.AddClass(TList, 'TObject') do
  begin
    { add public methods }
    AddMethod('function Add(Item: TObject): Integer', CallMethod);
    AddMethod('procedure Clear', CallMethod);
  end;
  ...
end;

function TForm1.CallMethod(Instance: TObject; ClassType: TClass;
  const MethodName: String; var Params: Variant): Variant;
begin
  Result := 0;

  if MethodName = 'ADD' then
  { convert Variant parameter to Pointer type and pass it to Add method }
    TList(Instance).Add(Pointer(Integer(Params[0])))
  else if MethodName = 'CLEAR' then
    TList(Instance).Clear
end;


Example Implement a class public property
Implement a class public property

We need to implement all public properties of a class that we want to use in a script. All published properties are added automatically.

var
  Prog: TfsScript;
begin
  ...
  with Prog.AddClass(TStrings, 'TPersistent') do
  begin
    { property CommaText: String }
    AddProperty('CommaText', 'string', GetProp, SetProp);
    { property Count: Integer readonly }
    AddProperty('Count', 'Integer', GetProp, nil);
    { index property Objects[Index: Integer]: TObject }
    AddIndexProperty('Objects', 'Integer', 'TObject', CallMethod);
    { default property Strings[Index: Integer]: String }
    AddDefaultProperty('Strings', 'Integer', 'string', CallMethod);
  end;
  ...
end;

function TForm1.CallMethod(Instance: TObject; ClassType: TClass;
  const MethodName: String; var Params: Variant): Variant;
begin
  Result := 0;

  if MethodName = 'OBJECTS.GET' then
    Result := Integer(TStrings(Instance).Objects[Params[0]])
  else if MethodName = 'OBJECTS.SET' then
    TStrings(Instance).Objects[Params[0]] := TObject(Integer(Params[1]))
  else if MethodName = 'STRINGS.GET' then
    Result := TStrings(Instance).Strings[Params[0]]
  else if MethodName = 'STRINGS.SET' then
    TStrings(Instance).Strings[Params[0]] := Params[1]
end;

function TForm1.GetProp(Instance: TObject; ClassType: TClass;
  const PropName: String): Variant;
begin
  Result := 0;

  if PropName = 'COMMATEXT' then
    Result := TStrings(Instance).CommaText
  else if PropName = 'COUNT' then
    Result := TStrings(Instance).Count
end;

procedure TForm1.SetProp(Instance: TObject; ClassType: TClass;
  const PropName: String; Value: Variant);
begin
  if PropName = 'COMMATEXT' then
    TStrings(Instance).CommaText := Value
end;


Example Save compilation results
Save compilation results

var
  S: TStream;

S := TMemoryStream.Create;
fsScript1.Lines.Text := '....'; // script text
fsScript1.GetILCode(S); // compile the script and get compiled code

...

S.Position := 0;
fsScript1.SetILCode(S); // set precompiled code
fsScript1.Execute; // run it


Example TfsScript example
TfsScript example

This is a simplest way of use scripts.

procedure TForm1.Button1Click(Sender: TObject);
begin
  { clear all items }
  fsScript1.Clear;
  { script text }
  fsScript1.Lines := Memo1.Lines;
  { frGlobalUnit contains standard types and functions }
  fsScript1.Parent := fsGlobalUnit;

  { compile the script }
  if fsScript1.Compile then
    fsScript1.Execute else   { execute if compilation was succesfull }
    ShowMessage(fsScript1.ErrorMsg); { show an error message }
end;


Example Variables example
Variables example

This example show how to access a script variable from the Delphi.

begin
  { clear all items }
  fsScript1.Clear;
  { script text }
  fsScript1.Lines := Memo1.Lines;
  { frGlobalUnit contains standard types and functions }
  fsScript1.Parent := fsGlobalUnit;

  { compile the script }
  if fsScript1.Compile then
  begin
  { execute if compilation was succesfull }
    fsScript1.Execute;
  { access to 'i' script variable }
    ShowMessage(IntToStr(fsScript1.Variables['i']));
  { another way }
    ShowMessage(IntToStr(fsScript1.Find('i').Value));
  end
  else
    ShowMessage(fsScript1.ErrorMsg); { show an error message }
end;


Package FS

Units:
fs_iADORTTI 	fs_iBDERTTI 	fs_iChartRTTI
fs_iClassesRTTI 	fs_iDBCtrlsRTTI 	fs_iDBRTTI
fs_iDialogsRTTI 	fs_iExtCtrlsRTTI 	fs_iFormsRTTI
fs_iGraphicsRTTI 	fs_iIBXRTTI 	fs_iInterpreter
fs_iSysRTTI 	fs_iTools 	fs_XML


Unit fs_iADORTTI

FS

Objects:

TfsADORTTI

Contains ADO classes, methods and constants.


TfsADORTTI Properties.
TfsADORTTI properties

TfsADORTTI      Alphabetically      Legend

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TfsADORTTI Properties.
TfsADORTTI properties

TfsADORTTI      By Object      Legend

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TfsADORTTI Methods.
TfsADORTTI methods

TfsADORTTI      Alphabetically      Legend

Derived from TComponent

BeforeDestruction

Create

Destroy

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

RemoveComponent

RemoveFreeNotification

SafeCallException

UpdateAction

Derived from TPersistent

Assign


TfsADORTTI Methods.
TfsADORTTI methods

TfsADORTTI      By Object      Legend

Assign

BeforeDestruction

Create

Destroy

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

RemoveComponent

RemoveFreeNotification

SafeCallException

UpdateAction


TfsADORTTI Events.
TfsADORTTI events

TfsADORTTI      Alphabetically      Legend


TfsADORTTI Events.
TfsADORTTI events

TfsADORTTI      By Object      Legend


TfsADORTTI

Hierarchy      Properties      Methods

Unit
fs_iADORTTI

type TfsADORTTI = class (TComponent);

Description
Use this component if you want to get access to ADO stuff in your application.
This component allows you to access the following classes inside a script:

TADOConnection
TParameter
TParameters
property TParameters.Items
TCustomADODataSet
TADOTable
TADOQuery
procedure TADOQuery.ExecSQL
TADOStoredProc
procedure TADOStoredProc.ExecProc
type TDataType

You have access to all published properties of these classes + access to some public properties and methods.

Note This is a "fake" component. It is needed only for automatic inclusion of the "fs_iADORTTI" unit to the "uses" clause.


TfsADORTTI Hierarchy.
Hierarchy

TObject
|
TPersistent
|
TComponent
|
TfsADORTTI


Unit fs_iBDERTTI

FS

Objects:

TfsBDERTTI

Contains BDE classes, methods and constants.


TfsBDERTTI Properties.
TfsBDERTTI properties

TfsBDERTTI      Alphabetically      Legend

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TfsBDERTTI Properties.
TfsBDERTTI properties

TfsBDERTTI      By Object      Legend

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TfsBDERTTI Methods.
TfsBDERTTI methods

TfsBDERTTI      Alphabetically      Legend

Derived from TComponent

BeforeDestruction

Create

Destroy

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

RemoveComponent

RemoveFreeNotification

SafeCallException

UpdateAction

Derived from TPersistent

Assign


TfsBDERTTI Methods.
TfsBDERTTI methods

TfsBDERTTI      By Object      Legend

Assign

BeforeDestruction

Create

Destroy

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

RemoveComponent

RemoveFreeNotification

SafeCallException

UpdateAction


TfsBDERTTI Events.
TfsBDERTTI events

TfsBDERTTI      Alphabetically      Legend


TfsBDERTTI Events.
TfsBDERTTI events

TfsBDERTTI      By Object      Legend


TfsBDERTTI

Hierarchy      Properties      Methods

Unit
fs_iBDERTTI

type TfsBDERTTI = class (TComponent);

Description
Use this component if you want to get access to BDE stuff in your application.
This component allows you to access the following classes inside a script:

TSession
TDatabase
TBDEDataSet
TDBDataSet
TTable
procedure TTable.CreateTable
procedure TTable.DeleteTable
procedure TTable.EmptyTable
function TTable.FindKey(const KeyValues: array): Boolean
procedure TTable.FindNearest(const KeyValues: array)
procedure TTable.RenameTable(const NewTableName: string)
TQuery
procedure TQuery.ExecSQL
function TQuery.ParamByName(const Value: string): TParam
procedure TQuery.Prepare
property TQuery.ParamCount
TStoredProc
procedure TStoredProc.ExecProc
function TStoredProc.ParamByName(const Value: string): TParam
procedure TStoredProc.Prepare
property TStoredProc.ParamCount
type TTableType
type TParamBindMode

You have access to all published properties of these classes + access to some public properties and methods.

Note This is a "fake" component. It is needed only for automatic inclusion of the "fs_iBDERTTI" unit to the "uses" clause.


TfsBDERTTI Hierarchy.
Hierarchy

TObject
|
TPersistent
|
TComponent
|
TfsBDERTTI


Unit fs_iChartRTTI

FS

Objects:

TfsChartRTTI

Contains TeeChart classes and types.


TfsChartRTTI Properties.
TfsChartRTTI properties

TfsChartRTTI      Alphabetically      Legend

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TfsChartRTTI Properties.
TfsChartRTTI properties

TfsChartRTTI      By Object      Legend

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TfsChartRTTI Methods.
TfsChartRTTI methods

TfsChartRTTI      Alphabetically      Legend

Derived from TComponent

BeforeDestruction

Create

Destroy

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

RemoveComponent

RemoveFreeNotification

SafeCallException

UpdateAction

Derived from TPersistent

Assign


TfsChartRTTI Methods.
TfsChartRTTI methods

TfsChartRTTI      By Object      Legend

Assign

BeforeDestruction

Create

Destroy

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

RemoveComponent

RemoveFreeNotification

SafeCallException

UpdateAction


TfsChartRTTI Events.
TfsChartRTTI events

TfsChartRTTI      Alphabetically      Legend


TfsChartRTTI Events.
TfsChartRTTI events

TfsChartRTTI      By Object      Legend


TfsChartRTTI

Hierarchy      Properties      Methods

Unit
fs_iChartRTTI

type TfsChartRTTI = class (TComponent);

Description
Use this component if you want to get access to TeeChart stuff in your application.
This component allows you to access the following classes inside a script:

TChartValueList
TChartAxisTitle
TChartAxis
TCustomChartLegend
TChartLegend
TSeriesMarks
TChartGradient
TChartWall
TChartBrush
TChartTitle
TChartSeries
procedure TChartSeries.Clear
procedure TChartSeries.Add(const AValue: Double; const ALabel: String; AColor: TColor)

TSeriesPointer
TCustomSeries
TLineSeries
TPointSeries
TAreaSeries
TCustomBarSeries
TBarSeries
THorizBarSeries
TCircledSeries
TPieSeries
TFastLineSeries
TCustomChart
TChart

type TChartValue
type TLegendStyle
type TLegendAlignment
type TLegendTextStyle
type TChartListOrder
type TGradientDirection
type TSeriesMarksStyle
type TAxisLabelStyle
type THorizAxis
type TVertAxis
type TTeeBackImageMode
type TPanningMode
type TSeriesPointerStyle
type TMultiArea
type TMultiBar
type TBarStyle

You have access to all published properties of these classes + access to some public properties and methods.

Note This is a "fake" component. It is needed only for automatic inclusion of the "fs_iChartRTTI" unit to the "uses" clause.


TfsChartRTTI Hierarchy.
Hierarchy

TObject
|
TPersistent
|
TComponent
|
TfsChartRTTI


Unit fs_iClassesRTTI

FS

Objects:

TfsClassesRTTI

Contains Classes.pas classes, methods and constants.


TfsClassesRTTI Properties.
TfsClassesRTTI properties

TfsClassesRTTI      Alphabetically      Legend

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TfsClassesRTTI Properties.
TfsClassesRTTI properties

TfsClassesRTTI      By Object      Legend

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TfsClassesRTTI Methods.
TfsClassesRTTI methods

TfsClassesRTTI      Alphabetically      Legend

Derived from TComponent

BeforeDestruction

Create

Destroy

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

RemoveComponent

RemoveFreeNotification

SafeCallException

UpdateAction

Derived from TPersistent

Assign


TfsClassesRTTI Methods.
TfsClassesRTTI methods

TfsClassesRTTI      By Object      Legend

Assign

BeforeDestruction

Create

Destroy

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

RemoveComponent

RemoveFreeNotification

SafeCallException

UpdateAction


TfsClassesRTTI Events.
TfsClassesRTTI events

TfsClassesRTTI      Alphabetically      Legend


TfsClassesRTTI Events.
TfsClassesRTTI events

TfsClassesRTTI      By Object      Legend


TfsClassesRTTI

Hierarchy      Properties      Methods

Unit
fs_iClassesRTTI

type TfsClassesRTTI = class (TComponent);

Description
Use this component if you want to get access to Classes.pas stuff in your application.
This component allows you to access the following classes inside a script:

TObject
constructor TObject.Create
procedure TObject.Free

TPersistent
procedure TPersistent.Assign(Source: TPersistent)

TList
function TList.Add(Item: TObject): Integer
procedure TList.Clear
procedure TList.Delete(Index: Integer)
function TList.IndexOf(Item: TObject): Integer
procedure TList.Insert(Index: Integer; Item: TObject)
function TList.Remove(Item: TObject): Integer
property TList.Count
property TList.Items

TStrings
function TStrings.Add(const S: string): Integer
function TStrings.AddObject(const S: string; AObject: TObject): Integer
procedure TStrings.Clear
procedure TStrings.Delete(Index: Integer)
function TStrings.IndexOf(const S: string): Integer
function TStrings.IndexOfName(const Name: string): Integer
function TStrings.IndexOfObject(AObject: TObject): Integer
procedure TStrings.Insert(Index: Integer; const S: string)
procedure TStrings.InsertObject(Index: Integer; const S: string; AObject: TObject)
procedure TStrings.LoadFromFile(const FileName: string)
procedure TStrings.LoadFromStream(Stream: TStream)
procedure TStrings.SaveToFile(const FileName: string)
procedure TStrings.SaveToStream(Stream: TStream)
property TStrings.CommaText
property TStrings.Count
property TStrings.Names
property TStrings.Objects
property TStrings.Values
property TStrings.Strings
property TStrings.Text

TStringList
function TStringList.Find(s: String; var Index: Integer): Boolean
procedure TStringList.Sort
property TStringList.Duplicates
property TStringList.Sorted

TStream
function TStream.Read(Buffer: string; Count: Longint): Longint
function TStream.Write(Buffer: string; Count: Longint): Longint
function TStream.Seek(Offset: Longint; Origin: Word): Longint
function TStream.CopyFrom(Source: TStream; Count: Longint): Longint
property TStream.Position
property TStream.Size

TFileStream
constructor TFileStream.Create(Filename: String; Mode: Word)

TMemoryStream
procedure TMemoryStream.Clear
procedure TMemoryStream.LoadFromStream(Stream: TStream)
procedure TMemoryStream.LoadFromFile(Filename: String)
procedure TMemoryStream.SaveToStream(Stream: TStream)
procedure TMemoryStream.SaveToFile(Filename: String)

TComponent
constructor TComponent.Create(AOwner: TComponent)
property TComponent.Owner

TfsXMLItem
constructor TfsXMLItem.Create
procedure TfsXMLItem.AddItem(Item: TfsXMLItem)
procedure TfsXMLItem.Clear
procedure TfsXMLItem.InsertItem(Index: Integer; Item: TfsXMLItem)
function TfsXMLItem.Add: TfsXMLItem
function TfsXMLItem.Find(const Name: String): Integer
function TfsXMLItem.FindItem(const Name: String): TfsXMLItem
function TfsXMLItem.Prop(const Name: String): String
function TfsXMLItem.Root: TfsXMLItem
property TfsXMLItem.Data
property TfsXMLItem.Count
property TfsXMLItem.Items
property TfsXMLItem.Name
property TfsXMLItem.Parent
property TfsXMLItem.Text

TfsXMLDocument
constructor TfsXMLDocument.Create
procedure TfsXMLDocument.SaveToStream(Stream: TStream)
procedure TfsXMLDocument.LoadFromStream(Stream: TStream)
procedure TfsXMLDocument.SaveToFile(const FileName: String)
procedure TfsXMLDocument.LoadFromFile(const FileName: String)
property TfsXMLDocument.Root

const fmCreate
const fmOpenRead
const fmOpenWrite
const fmOpenReadWrite
const fmShareExclusive
const fmShareDenyWrite
const fmShareDenyNone
const soFromBeginning
const soFromCurrent
const soFromEnd
type TDuplicates

You have access to all published properties of these classes + access to some public properties and methods.

Note This is a "fake" component. It is needed only for automatic inclusion of the "fs_iClassesRTTI" unit to the "uses" clause.


TfsClassesRTTI Hierarchy.
Hierarchy

TObject
|
TPersistent
|
TComponent
|
TfsClassesRTTI


Unit fs_iDBCtrlsRTTI

FS

Objects:

TfsDBCtrlsRTTI

Contains DBCtrls.pas classes, methods and constants.


TfsDBCtrlsRTTI Properties.
TfsDBCtrlsRTTI properties

TfsDBCtrlsRTTI      Alphabetically      Legend

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TfsDBCtrlsRTTI Properties.
TfsDBCtrlsRTTI properties

TfsDBCtrlsRTTI      By Object      Legend

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TfsDBCtrlsRTTI Methods.
TfsDBCtrlsRTTI methods

TfsDBCtrlsRTTI      Alphabetically      Legend

Derived from TComponent

BeforeDestruction

Create

Destroy

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

RemoveComponent

RemoveFreeNotification

SafeCallException

UpdateAction

Derived from TPersistent

Assign


TfsDBCtrlsRTTI Methods.
TfsDBCtrlsRTTI methods

TfsDBCtrlsRTTI      By Object      Legend

Assign

BeforeDestruction

Create

Destroy

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

RemoveComponent

RemoveFreeNotification

SafeCallException

UpdateAction


TfsDBCtrlsRTTI Events.
TfsDBCtrlsRTTI events

TfsDBCtrlsRTTI      Alphabetically      Legend


TfsDBCtrlsRTTI Events.
TfsDBCtrlsRTTI events

TfsDBCtrlsRTTI      By Object      Legend


TfsDBCtrlsRTTI

Hierarchy      Properties      Methods

Unit
fs_iDBCtrlsRTTI

type TfsDBCtrlsRTTI = class (TComponent);

Description
Use this component if you want to get access to DBCtrls.pas stuff in your application.
This component allows you to access the following classes inside a script:

TDBEdit
TDBText
TDBCheckBox
property TDBCheckBox.Checked
TDBComboBox
property TDBComboBox.Text
TDBListBox
TDBRadioGroup
property TDBRadioGroup.ItemIndex
property TDBRadioGroup.Value
TDBMemo
TDBImage
TDBNavigator
TDBLookupControl
property TDBLookupControl.KeyValue
TDBLookupListBox
property TDBLookupListBox.SelectedItem
TDBLookupComboBox
property TDBLookupComboBox.Text
TColumnTitle
TColumn
TDBGridColumns
function TDBGridColumns.Add: TColumn
property TDBGridColumns.Items
TDBGrid

type TButtonSet
type TColumnButtonStyle
type TDBGridOptions

You have access to all published properties of these classes + access to some public properties and methods.

Note This is a "fake" component. It is needed only for automatic inclusion of the "fs_iDBCtrlsRTTI" unit to the "uses" clause.


TfsDBCtrlsRTTI Hierarchy.
Hierarchy

TObject
|
TPersistent
|
TComponent
|
TfsDBCtrlsRTTI


Unit fs_iDBRTTI

FS

Objects:

TfsDBRTTI

Contains DB.pas classes, methods and constants.


TfsDBRTTI Properties.
TfsDBRTTI properties

TfsDBRTTI      Alphabetically      Legend

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TfsDBRTTI Properties.
TfsDBRTTI properties

TfsDBRTTI      By Object      Legend

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TfsDBRTTI Methods.
TfsDBRTTI methods

TfsDBRTTI      Alphabetically      Legend

Derived from TComponent

BeforeDestruction

Create

Destroy

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

RemoveComponent

RemoveFreeNotification

SafeCallException

UpdateAction

Derived from TPersistent

Assign


TfsDBRTTI Methods.
TfsDBRTTI methods

TfsDBRTTI      By Object      Legend

Assign

BeforeDestruction

Create

Destroy

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

RemoveComponent

RemoveFreeNotification

SafeCallException

UpdateAction


TfsDBRTTI Events.
TfsDBRTTI events

TfsDBRTTI      Alphabetically      Legend


TfsDBRTTI Events.
TfsDBRTTI events

TfsDBRTTI      By Object      Legend


TfsDBRTTI

Hierarchy      Properties      Methods

Unit
fs_iDBRTTI

type TfsDBRTTI = class (TComponent);

Description
Use this component if you want to get access to DB.pas stuff in your application.
This component allows you to access the following classes inside a script:

TField
property TField.AsString
property TField.AsVariant
property TField.DataType
property TField.DisplayName
property TField.DisplayText
property TField.IsNull
property TField.Size
property TField.Value

TFields
property TFields.Fields

TStringField
TNumericField
TIntegerField
TSmallIntField
TWordField
TAutoIncField
TFloatField
TCurrencyField
TBooleanField
TDateTimeField
TDateField
TTimeField
TBinaryField
TBytesField
TVarBytesField
TBCDField

TBlobField
procedure TBlobField.LoadFromFile(const FileName: String)
procedure TBlobField.LoadFromStream(Stream: TStream)
procedure TBlobField.SaveToFile(const FileName: String)
procedure TBlobField.SaveToStream(Stream: TStream)

TMemoField
TGraphicField
TFieldDef
TFieldDefs
property TFieldDefs.Items

TDataSource
type TBookmark

TDataSet
procedure TDataSet.Open
procedure TDataSet.Close
procedure TDataSet.First
procedure TDataSet.Last
procedure TDataSet.Next
procedure TDataSet.Prior
procedure TDataSet.Cancel
procedure TDataSet.Delete
procedure TDataSet.Post
procedure TDataSet.Append
procedure TDataSet.Insert
procedure TDataSet.Edit
function TDataSet.FieldByName(const FieldName: string): TField
procedure TDataSet.GetFieldNames(List: TStrings)
function TDataSet.FindFirst: Boolean
function TDataSet.FindLast: Boolean
function TDataSet.FindNext: Boolean
function TDataSet.FindPrior: Boolean
procedure TDataSet.FreeBookmark(Bookmark: TBookmark)
function TDataSet.GetBookmark: TBookmark
procedure TDataSet.GotoBookmark(Bookmark: TBookmark)
function TDataSet.Locate(const KeyFields: string; const KeyValues: Variant; Options: TLocateOptions): Boolean
function TDataSet.IsEmpty: Boolean
property TDataSet.Bof
property TDataSet.Eof
property TDataSet.FieldCount
property TDataSet.FieldDefs
property TDataSet.Fields
property TDataSet.Filter
property TDataSet.Filtered
property TDataSet.FilterOptions
property TDataSet.Active

TParam
procedure TParam.Clear
property TParam.Bound
property TParam.IsNull
property TParam.Text

TParams
function TParams.ParamByName(const Value: string): TParam
function TParams.FindParam(const Value: string): TParam
property TParams.Items

type TFieldType
type TBlobStreamMode
type TLocateOptions
type TFilterOptions
type TParamType

You have access to all published properties of these classes + access to some public properties and methods.

Note This is a "fake" component. It is needed only for automatic inclusion of the "fs_iDBRTTI" unit to the "uses" clause.


TfsDBRTTI Hierarchy.
Hierarchy

TObject
|
TPersistent
|
TComponent
|
TfsDBRTTI


Unit fs_iDialogsRTTI

FS

Objects:

TfsDialogsRTTI

Contains Dialogs.pas classes, methods and constants.


TfsDialogsRTTI Properties.
TfsDialogsRTTI properties

TfsDialogsRTTI      Alphabetically      Legend

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TfsDialogsRTTI Properties.
TfsDialogsRTTI properties

TfsDialogsRTTI      By Object      Legend

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TfsDialogsRTTI Methods.
TfsDialogsRTTI methods

TfsDialogsRTTI      Alphabetically      Legend

Derived from TComponent

BeforeDestruction

Create

Destroy

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

RemoveComponent

RemoveFreeNotification

SafeCallException

UpdateAction

Derived from TPersistent

Assign


TfsDialogsRTTI Methods.
TfsDialogsRTTI methods

TfsDialogsRTTI      By Object      Legend

Assign

BeforeDestruction

Create

Destroy

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

RemoveComponent

RemoveFreeNotification

SafeCallException

UpdateAction


TfsDialogsRTTI Events.
TfsDialogsRTTI events

TfsDialogsRTTI      Alphabetically      Legend


TfsDialogsRTTI Events.
TfsDialogsRTTI events

TfsDialogsRTTI      By Object      Legend


TfsDialogsRTTI

Hierarchy      Properties      Methods

Unit
fs_iDialogsRTTI

type TfsDialogsRTTI = class (TComponent);

Description
Use this component if you want to get access to Dialogs.pas stuff in your application.
This component allows you to access the following classes inside a script:

TCommonDialog
function TCommonDialog.Execute: Boolean
TOpenDialog
TSaveDialog
TColorDialog
TFontDialog
TPrintDialog
TPrinterSetupDialog

type TOpenOptions
type TFileEditStyle
type TColorDialogOptions
type TFontDialogOptions
type TFontDialogDevice
type TPrintRange
type TPrintDialogOptions

You have access to all published properties of these classes + access to some public properties and methods.

Note This is a "fake" component. It is needed only for automatic inclusion of the "fs_iDialogsRTTI" unit to the "uses" clause.


TfsDialogsRTTI Hierarchy.
Hierarchy

TObject
|
TPersistent
|
TComponent
|
TfsDialogsRTTI


Unit fs_iExtCtrlsRTTI

FS

Objects:

TfsExtCtrlsRTTI

Contains ExtCtrls.pas classes, methods and constants.


TfsExtCtrlsRTTI Properties.
TfsExtCtrlsRTTI properties

TfsExtCtrlsRTTI      Alphabetically      Legend

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TfsExtCtrlsRTTI Properties.
TfsExtCtrlsRTTI properties

TfsExtCtrlsRTTI      By Object      Legend

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TfsExtCtrlsRTTI Methods.
TfsExtCtrlsRTTI methods

TfsExtCtrlsRTTI      Alphabetically      Legend

Derived from TComponent

BeforeDestruction

Create

Destroy

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

RemoveComponent

RemoveFreeNotification

SafeCallException

UpdateAction

Derived from TPersistent

Assign


TfsExtCtrlsRTTI Methods.
TfsExtCtrlsRTTI methods

TfsExtCtrlsRTTI      By Object      Legend

Assign

BeforeDestruction

Create

Destroy

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

RemoveComponent

RemoveFreeNotification

SafeCallException

UpdateAction


TfsExtCtrlsRTTI Events.
TfsExtCtrlsRTTI events

TfsExtCtrlsRTTI      Alphabetically      Legend


TfsExtCtrlsRTTI Events.
TfsExtCtrlsRTTI events

TfsExtCtrlsRTTI      By Object      Legend


TfsExtCtrlsRTTI

Hierarchy      Properties      Methods

Unit
fs_iExtCtrlsRTTI

type TfsExtCtrlsRTTI = class (TComponent);

Description
Use this component if you want to get access to ExtCtrls.pas stuff in your application.
This component allows you to access the following classes inside a script:

TShape

TPaintBox
event TPaintBox.OnPaint

TImage
TBevel

TTimer
event TTimer.OnTimer

TPanel
TSplitter
TBitBtn
TSpeedButton

TCheckListBox
property TCheckListBox.Checked

TTabControl
TTabSheet

TPageControl
procedure TPageControl.SelectNextPage(GoForward: Boolean)
property TPageControl.PageCount
property TPageControl.Pages

TStatusPanel

TStatusPanels
function TStatusPanels.Add: TStatusPanel
property TStatusPanels.Items

TStatusBar

TTreeNode
procedure TTreeNode.Delete
function TTreeNode.EditText: Boolean
property TTreeNode.Count
property TTreeNode.Data
property TTreeNode.ImageIndex
property TTreeNode.SelectedIndex
property TTreeNode.StateIndex
property TTreeNode.Text

TTreeNodes
function TTreeNodes.Add(Node: TTreeNode; const S: string): TTreeNode
function TTreeNodes.AddChild(Node: TTreeNode; const S: string): TTreeNode
procedure TTreeNodes.BeginUpdate
procedure TTreeNodes.Clear
procedure TTreeNodes.Delete(Node: TTreeNode)
procedure TTreeNodes.EndUpdate
property TTreeNodes.Count
property TTreeNodes.Item

TTreeView
procedure TTreeView.FullCollapse
procedure TTreeView.FullExpand
property TTreeView.Selected
property TTreeView.TopItem

TTrackBar
TProgressBar
TListColumn

TListColumns
function TListColumns.Add: TListColumn
property TListColumns.Items

TListItem
procedure TListItem.Delete
function TListItem.EditCaption: Boolean
property TListItem.Caption
property TListItem.Checked
property TListItem.Data
property TListItem.ImageIndex
property TListItem.Selected
property TListItem.StateIndex
property TListItem.SubItems

TListItems
function TListItems.Add: TListItem
procedure TListItems.BeginUpdate
procedure TListItems.Clear
procedure TListItems.Delete(Index: Integer)
procedure TListItems.EndUpdate
property TListItems.Count
property TListItems.Item

TIconOptions
TListView
TToolButton
TToolBar
TMonthCalColors
TDateTimePicker
TMonthCalendar

type TShapeType
type TBevelStyle
type TBevelShape
type TResizeStyle
type TButtonLayout
type TButtonState
type TButtonStyle
type TBitBtnKind
type TNumGlyphs
type TTabPosition
type TTabStyle
type TStatusPanelStyle
type TStatusPanelBevel
type TSortType
type TTrackBarOrientation
type TTickMark
type TTickStyle
type TProgressBarOrientation
type TIconArrangement
type TListArrangement
type TViewStyle
type TToolButtonStyle
type TDateTimeKind
type TDTDateMode
type TDTDateFormat
type TDTCalAlignment
type TCalDayOfWeek

You have access to all published properties of these classes + access to some public properties and methods.

Note This is a "fake" component. It is needed only for automatic inclusion of the "fs_iExtCtrlsRTTI" unit to the "uses" clause.


TfsExtCtrlsRTTI Hierarchy.
Hierarchy

TObject
|
TPersistent
|
TComponent
|
TfsExtCtrlsRTTI


Unit fs_iFormsRTTI

FS

Objects:

TfsFormsRTTI

Contains StdCtrls.pas and Forms.pas classes, methods and constants.


TfsFormsRTTI Properties.
TfsFormsRTTI properties

TfsFormsRTTI      Alphabetically      Legend

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TfsFormsRTTI Properties.
TfsFormsRTTI properties

TfsFormsRTTI      By Object      Legend

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TfsFormsRTTI Methods.
TfsFormsRTTI methods

TfsFormsRTTI      Alphabetically      Legend

Derived from TComponent

BeforeDestruction

Create

Destroy

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

RemoveComponent

RemoveFreeNotification

SafeCallException

UpdateAction

Derived from TPersistent

Assign


TfsFormsRTTI Methods.
TfsFormsRTTI methods

TfsFormsRTTI      By Object      Legend

Assign

BeforeDestruction

Create

Destroy

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

RemoveComponent

RemoveFreeNotification

SafeCallException

UpdateAction


TfsFormsRTTI Events.
TfsFormsRTTI events

TfsFormsRTTI      Alphabetically      Legend


TfsFormsRTTI Events.
TfsFormsRTTI events

TfsFormsRTTI      By Object      Legend


TfsFormsRTTI

Hierarchy      Properties      Methods

Unit
fs_iFormsRTTI

type TfsFormsRTTI = class (TComponent);

Description
Use this component if you want to get access to StdCtrls.pas and Forms.pas stuff in your application.
This component allows you to access the following classes inside a script:

TControl
property TControl.Parent
procedure TControl.Hide
procedure TControl.Show
procedure TControl.SetBounds(ALeft, ATop, AWidth, AHeight: Integer)
event TControl.OnCanResize
event TControl.OnClick
event TControl.OnDblClick
event TControl.OnMouseDown
event TControl.OnMouseMove
event TControl.OnMouseUp
event TControl.OnResize

TWinControl
procedure TWinControl.SetFocus
event TWinControl.OnEnter
event TWinControl.OnExit
event TWinControl.OnKeyDown
event TWinControl.OnKeyPress
event TWinControl.OnKeyUp

TCustomControl
TGraphicControl
TGroupBox
TLabel
TEdit
TMemo

TCustomComboBox
property TCustomComboBox.DroppedDown
property TCustomComboBox.ItemIndex

TComboBox
TButton
TCheckBox
TRadioButton

TCustomListBox
property TCustomListBox.ItemIndex
property TCustomListBox.SelCount
property TCustomListBox.Selected

TListBox
TControlScrollBar
TScrollingWinControl
TScrollBox

TCustomForm
procedure TCustomForm.Close
procedure TCustomForm.Hide
procedure TCustomForm.Show
function TCustomForm.ShowModal: Integer
event TCustomForm.OnActivate
event TCustomForm.OnClose
event TCustomForm.OnCloseQuery
event TCustomForm.OnCreate
event TCustomForm.OnDestroy
event TCustomForm.OnDeactivate
event TCustomForm.OnHide
event TCustomForm.OnPaint
event TCustomForm.OnShow
property TCustomForm.ModalResult

TForm

type TModalResult
type TCursor
type TShiftState
type TAlignment
type TAlign
type TMouseButton
type TAnchors
type TBevelCut
type TTextLayout
type TEditCharCase
type TScrollStyle
type TComboBoxStyle
type TCheckBoxState
type TListBoxStyle
type TFormBorderStyle
type TWindowState
type TFormStyle
type TBorderIcons
type TPosition
type TCloseAction

You have access to all published properties of these classes + access to some public properties and methods.

Note This is a "fake" component. It is needed only for automatic inclusion of the "fs_iFormsRTTI" unit to the "uses" clause.


TfsFormsRTTI Hierarchy.
Hierarchy

TObject
|
TPersistent
|
TComponent
|
TfsFormsRTTI


Unit fs_iGraphicsRTTI

FS

Objects:

TfsGraphicsRTTI

Contains Graphics.pas classes, methods and constants.


TfsGraphicsRTTI Properties.
TfsGraphicsRTTI properties

TfsGraphicsRTTI      Alphabetically      Legend

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TfsGraphicsRTTI Properties.
TfsGraphicsRTTI properties

TfsGraphicsRTTI      By Object      Legend

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TfsGraphicsRTTI Methods.
TfsGraphicsRTTI methods

TfsGraphicsRTTI      Alphabetically      Legend

Derived from TComponent

BeforeDestruction

Create

Destroy

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

RemoveComponent

RemoveFreeNotification

SafeCallException

UpdateAction

Derived from TPersistent

Assign


TfsGraphicsRTTI Methods.
TfsGraphicsRTTI methods

TfsGraphicsRTTI      By Object      Legend

Assign

BeforeDestruction

Create

Destroy

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

RemoveComponent

RemoveFreeNotification

SafeCallException

UpdateAction


TfsGraphicsRTTI Events.
TfsGraphicsRTTI events

TfsGraphicsRTTI      Alphabetically      Legend


TfsGraphicsRTTI Events.
TfsGraphicsRTTI events

TfsGraphicsRTTI      By Object      Legend


TfsGraphicsRTTI

Hierarchy      Properties      Methods

Unit
fs_iGraphicsRTTI

type TfsGraphicsRTTI = class (TComponent);

Description
Use this component if you want to get access to Graphics.pas stuff in your application.
This component allows you to access the following classes inside a script:

TFont
TPen
TBrush
TCanvas
procedure TCanvas.Draw(X, Y: Integer; Graphic: TGraphic)
procedure TCanvas.Ellipse(X1, Y1, X2, Y2: Integer)
procedure TCanvas.LineTo(X, Y: Integer)
procedure TCanvas.MoveTo(X, Y: Integer)
procedure TCanvas.Rectangle(X1, Y1, X2, Y2: Integer)
procedure TCanvas.RoundRect(X1, Y1, X2, Y2, X3, Y3: Integer)
procedure TCanvas.StretchDraw(X1, Y1, X2, Y2: Integer; Graphic: TGraphic)
function TCanvas.TextHeight(const Text: string): Integer
procedure TCanvas.TextOut(X, Y: Integer; const Text: string)
function TCanvas.TextWidth(const Text: string): Integer
property TCanvas.Pixels

TGraphic
procedure TGraphic.LoadFromFile(const Filename: string)
procedure TGraphic.SaveToFile(const Filename: string)
property TGraphic.Height
property TGraphic.Width

TMetafile
TMetafileCanvas
TBitmap
property TBitmap.Canvas

type TFontStyles
type TFontPitch
type TPenStyle
type TPenMode
type TBrushStyle

You have access to all published properties of these classes + access to some public properties and methods.

Note This is a "fake" component. It is needed only for automatic inclusion of the "fs_iGraphicsRTTI" unit to the "uses" clause.


TfsGraphicsRTTI Hierarchy.
Hierarchy

TObject
|
TPersistent
|
TComponent
|
TfsGraphicsRTTI


Unit fs_iIBXRTTI

FS

Objects:

TfsIBXRTTI

Contains IBX classes, methods and constants.


TfsIBXRTTI Properties.
TfsIBXRTTI properties

TfsIBXRTTI      Alphabetically      Legend

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TfsIBXRTTI Properties.
TfsIBXRTTI properties

TfsIBXRTTI      By Object      Legend

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TfsIBXRTTI Methods.
TfsIBXRTTI methods

TfsIBXRTTI      Alphabetically      Legend

Derived from TComponent

BeforeDestruction

Create

Destroy

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

RemoveComponent

RemoveFreeNotification

SafeCallException

UpdateAction

Derived from TPersistent

Assign


TfsIBXRTTI Methods.
TfsIBXRTTI methods

TfsIBXRTTI      By Object      Legend

Assign

BeforeDestruction

Create

Destroy

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

RemoveComponent

RemoveFreeNotification

SafeCallException

UpdateAction


TfsIBXRTTI Events.
TfsIBXRTTI events

TfsIBXRTTI      Alphabetically      Legend


TfsIBXRTTI Events.
TfsIBXRTTI events

TfsIBXRTTI      By Object      Legend


TfsIBXRTTI

Hierarchy      Properties      Methods

Unit
fs_iIBXRTTI

type TfsIBXRTTI = class (TComponent);

Description
Use this component if you want to get access to IBX stuff in your application.
This component allows you to access the following classes inside a script:

TIBDataBase
TIBTransaction
TIBCustomDataSet
TIBTable
TIBQuery
procedure TIBQuery.ExecSQL
TIBStoredProc
procedure TIBStoredProc.ExecProc

You have access to all published properties of these classes + access to some public properties and methods.

Note This is a "fake" component. It is needed only for automatic inclusion of the "fs_iIBXRTTI" unit to the "uses" clause.


TfsIBXRTTI Hierarchy.
Hierarchy

TObject
|
TPersistent
|
TComponent
|
TfsIBXRTTI


Unit fs_iInterpreter

FS

Objects:

TfsClassVariable 	TfsCustomVariable 	TfsScript

Functions and procedures:

fsGlobalUnit

Data Types:

TfsCallMethodEvent 	TfsGetUnitEvent 	TfsGetValueEvent
TfsRunLineEvent 	TfsSetValueEvent 	TfsVarType

Contains main scripting classes.


TfsClassVariable Properties.
TfsClassVariable properties

TfsClassVariable      Alphabetically      Legend

Derived from TfsCustomVariable

Name

Typ

TypeName

Value


TfsClassVariable Properties.
TfsClassVariable properties

TfsClassVariable      By Object      Legend

Name

Typ

TypeName

Value


TfsClassVariable Methods.
TfsClassVariable methods

TfsClassVariable      Alphabetically      Legend

In TfsClassVariable

AddConstructor

AddDefaultProperty

AddEvent

AddIndexProperty

AddMethod

AddProperty

Create


TfsClassVariable Methods.
TfsClassVariable methods

TfsClassVariable      By Object      Legend

AddConstructor

AddDefaultProperty

AddEvent

AddIndexProperty

AddMethod

AddProperty

Create


TfsClassVariable Events.
TfsClassVariable events

TfsClassVariable      Alphabetically      Legend


TfsClassVariable Events.
TfsClassVariable events

TfsClassVariable      By Object      Legend


TfsClassVariable

Hierarchy      Properties      Methods

Unit
fs_iInterpreter

type TfsClassVariable = class (TfsCustomVariable)

Description
Represents the class with methods and properties.


TfsClassVariable.AddConstructor

TfsClassVariable

procedure AddConstructor(Syntax: String; CallEvent: TfsCallMethodEvent);

Description
Adds a contructor. Example:

AddConstructor('constructor Create(AOwner: TComponent)', MyCallEvent)


TfsClassVariable.AddDefaultProperty

TfsClassVariable      See Also

procedure AddDefaultProperty(const Name, Params, Typ: String; CallEvent: TfsCallMethodEvent; AReadOnly: Boolean = False);

Description
Adds a default property. Example:

AddDefaultProperty('Cell', 'Integer,Integer', 'String', MyCallEvent)

will describe real property Cell[Index1, Index2: Integer]: String

Note In the CallEvent you'll get the MethodName parameter 'CELL.GET' and 'CELL.SET' instead of 'CELL'


TfsClassVariable.AddEvent

TfsClassVariable

procedure AddEvent(const Name: String; AEvent: TfsEventClass);

Description
Adds an event. Example:

AddEvent('OnClick', TfsNotifyEvent)

There is some predefined events available in fs_iEvents unit:
  TfsNotifyEvent
  TfsMouseEvent
  TfsMouseMoveEvent
  TfsKeyEvent
  TfsKeyPressEvent
  TfsCloseEvent
  TfsCloseQueryEvent
  TfsCanResizeEvent

See the example how to add a new event type.


TfsClassVariable.AddIndexProperty

TfsClassVariable      See Also

procedure AddIndexProperty(const Name, Params, Typ: String; CallEvent: TfsCallMethodEvent; AReadOnly: Boolean = False);

Description
Adds an indexed property. Example and behavior are the same as for AddDefaultProperty method.


TfsClassVariable.AddMethod

TfsClassVariable      See Also

procedure AddMethod(const Syntax: String; CallEvent: TfsCallMethodEvent);

Description
Adds a method. Example:

AddMethod('function IsVisible: Boolean', MyCallEvent)


TfsClassVariable.AddProperty

TfsClassVariable      See Also

procedure AddProperty(const Name, Typ: String; GetEvent: TfsGetValueEvent; SetEvent: TfsSetValueEvent = nil);

Description
Adds a property. Example:

AddProperty('Font', 'TFont', MyGetEvent, MySetEvent)


TfsClassVariable.Create

TfsClassVariable      See Also

constructor Create(AClass: TClass; const Ancestor: String);

Description
Creates a class variable. You don't need to do it directly - use TfsScript.AddClass method instead.


TfsClassVariable Hierarchy.
Hierarchy

TfsItemList
|
TfsCustomVariable
|
TfsClassVariable


TfsCustomVariable Properties.
TfsCustomVariable properties

TfsCustomVariable      Alphabetically      Legend

In TfsCustomVariable

Name

Typ

TypeName

Value


TfsCustomVariable Properties.
TfsCustomVariable properties

TfsCustomVariable      By Object      Legend

Name

Typ

TypeName

Value


TfsCustomVariable Methods.
TfsCustomVariable methods

TfsCustomVariable      Alphabetically      Legend


TfsCustomVariable Methods.
TfsCustomVariable methods

TfsCustomVariable      By Object      Legend


TfsCustomVariable Events.
TfsCustomVariable events

TfsCustomVariable      Alphabetically      Legend


TfsCustomVariable Events.
TfsCustomVariable events

TfsCustomVariable      By Object      Legend


TfsCustomVariable

Hierarchy      Properties

Unit
fs_iInterpreter

type TfsCustomVariable = class(TfsItemList)

Description
This is a base class for all script objects.


TfsCustomVariable.Name

TfsCustomVariable

property Name : String;

Description

Name of the item.


TfsCustomVariable.Typ

TfsCustomVariable

property Typ : TfsVarType;

Description

Type of the item.

List of types:
TfsVarType = (fvtInt, fvtBool, fvtFloat, fvtChar, fvtString, fvtClass, fvtArray, fvtVariant, fvtEnum);


TfsCustomVariable.TypeName

TfsCustomVariable

property TypeName : String;

Description

Type name of the item.


TfsCustomVariable.Value

TfsCustomVariable

property Value : Variant;

Description

Value of the item.


TfsCustomVariable Hierarchy.
Hierarchy

TfsItemList
|
TfsCustomVariable


TfsScript Properties.
TfsScript properties

TfsScript      Alphabetically      Legend

In TfsScript

AddedBy

ErrorMsg

ErrorPos

Lines

SyntaxType

Variables

Derived from TComponent

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

Name

Owner

Tag

VCLComObject


TfsScript Properties.
TfsScript properties

TfsScript      By Object      Legend

AddedBy

ComObject

ComponentCount

ComponentIndex

Components

ComponentState

ComponentStyle

DesignInfo

ErrorMsg

ErrorPos

Lines

Name

Owner

SyntaxType

Tag

Variables

VCLComObject


TfsScript Methods.
TfsScript methods

TfsScript      Alphabetically      Legend

In TfsScript

AddClass

AddComponent

AddConst

AddEnum

AddEnumSet

AddForm

AddMethod

AddObject

AddType

AddVariable

CallFunction

CallFunction1

Clear

Compile

Evaluate

Execute

Find

FindClass

FindLocal

GetILCode

IsExecutableLine

RemoveItems

Run

SetILCode

Terminate

Derived from TComponent

BeforeDestruction

Create

Destroy

DestroyComponents

Destroying

ExecuteAction

FindComponent

FreeNotification

FreeOnRelease

GetNamePath

GetParentComponent

HasParent

InsertComponent

RemoveComponent

RemoveFreeNotification

SafeCallException

UpdateAction

Derived from TPersistent

Assign


TfsScript Methods.
TfsScript methods

TfsScript      By Object      Legend

AddClass

AddComponent

AddConst

AddEnum

AddEnumSet

AddForm

AddMethod

AddObject

AddType

AddVariable

Assign

BeforeDestruction

CallFunction

CallFunction1

Clear

Compile

Create

Destroy

DestroyComponents

Destroying

Evaluate

Execute

ExecuteAction

Find

FindClass

FindComponent

FindLocal

FreeNotification

FreeOnRelease

GetILCode

GetNamePath

GetParentComponent

HasParent

InsertComponent

IsExecutableLine

RemoveComponent

RemoveFreeNotification

RemoveItems

Run

SafeCallException

SetILCode

Terminate

UpdateAction


TfsScript Events.
TfsScript events

TfsScript      Alphabetically      Legend

In TfsScript

OnGetUnit

OnRunLine


TfsScript Events.
TfsScript events

TfsScript      By Object      Legend

OnGetUnit

OnRunLine


TfsScript

Hierarchy      Properties      Methods      Events

Unit
fs_iInterpreter

type TfsScript = class (TComponent);

Description
The main scripting component. Contains methods Compile and Execute for compilation and execution of script; Addxxx methods for adding new variable/constant/class/function to a script.


TfsScript.AddedBy

TfsScript

property AddedBy : TObject;

Description

This property affects methods Addxxx. If you want to add some types, classes or variables that should be removed after use, set the AddedBy property to some value (Self, for example) and call Addxxx methods. When you need to remove added items, call RemoveItems method.

Example (fs_iClassesRTTI.pas):

  with fsGlobalUnit do
  begin
    AddedBy := Self;
    with AddClass(TObject, '') do
    begin
      AddConstructor('constructor Create', CallMethod);
      AddMethod('procedure Free', CallMethod);
    end;
    ...
    AddedBy := nil;
  end;


TfsScript.ErrorMsg

TfsScript      See Also

property ErrorMsg : String;

Description

Contains an error message if compilation was unsuccessful. Error position is contained in the ErrorPos property.


TfsScript.ErrorPos

TfsScript      See Also

property ErrorPos : String;

Description

Contains an error position if compilation was unsuccessful. Error message is contained in the ErrorMsg property.

Note To convert the error position to a line/column format, use frPosToPoint function.


TfsScript.Lines

TfsScript

property Lines : TStrings;

Description

Place script code here. Example:

fsScript1.Lines.Text := 'begin i := 0 end.';


TfsScript.SyntaxType

TfsScript

property SyntaxType : String;

Description

Name of the script language. By default, this property has a 'PascalScript' value. Change this value before you call Compile method.


TfsScript.Variables

TfsScript      See Also

property Variables : Variant;

Description

This property allows you to access to a script variable.


TfsScript.AddClass

TfsScript      See Also

function AddClass(AClass: TClass; const Ancestor: String): TfsClassVariable;

Description
Adds a class to a script. Example:

with AddClass(TComponent, 'TPersistent') do
begin
... add public properties and methods ...
end


TfsScript.AddComponent

TfsScript

procedure AddComponent(Form: TComponent)

Description
Same as AddForm, used for compatibility with C++Builder.


TfsScript.AddConst

TfsScript

procedure AddConst(const Name, Typ: String; Value: Variant);

Description
Adds a constant to a script. Example:

AddConst('pi', 'Double', 3.14159)


TfsScript.AddEnum

TfsScript

procedure AddEnum(const Typ, Names: String);

Description
Adds an enumeration type to a script. Example:

AddEnum('TFontPitch', 'fpDefault, fpFixed, fpVariable')


TfsScript.AddEnumSet

TfsScript

procedure AddEnumSet(const Typ, Names: String);

Description
Adds an set type to a script. Example:

AddEnumSet('TFontStyles', 'fsBold, fsItalic, fsUnderline')


TfsScript.AddForm

TfsScript

procedure AddForm(Form: TComponent)

Description
Adds a form or datamodule with all its child components.

Note Note for C++Builder users: AddForm has a name conflict, use AddComponent instead.


TfsScript.AddMethod

TfsScript      See Also

procedure AddMethod(const Syntax: String; CallEvent: TfsCallMethodEvent; const Category: String = ''; const Description: String = '');

Description
Adds an external procedure/function to a script. Example:

AddMethod('function IsVisible: Boolean', MyCallEvent)


TfsScript.AddObject

TfsScript

procedure AddObject(const Name: String; Obj: TObject);

Description
Adds an external object to a script. Example:

AddObject('Memo1', Memo1)


TfsScript.AddType

TfsScript

procedure AddType(const TypeName: String; ParentType: TfsVarType);

Description
Adds a type to a script. Example:

AddType('TDateTime', fvtExtended)

List of types:
TfsVarType = (fvtInt, fvtBool, fvtFloat, fvtChar, fvtString, fvtClass, fvtArray, fvtVariant, fvtEnum);


TfsScript.AddVariable

TfsScript

procedure AddVariable(const Name, Typ: String; Value: Variant);

Description
Adds an external variable to a script. Example:

AddVariable('n', 'Variant', 0)


TfsScript.CallFunction

TfsScript

function CallFunction(const Name: String; const Params: Variant): Variant;

Description
Calls a script procedure or function that accepts const parameters. Example:

val := CallFunction('ScriptFunc1', VarArrayOf([2003, 3]))

If procedure/function accepts var parameters, use TfsScript.CallFunction1 instead.


TfsScript.CallFunction1

TfsScript

function CallFunction1(const Name: String; var Params: Variant): Variant;

Description
Calls a script procedure or function that accepts var parameters. Example:

var
  v: Variant;
v := VarArrayOf([2003, 3]);
val := CallFunction1('ScriptFunc1', v);


TfsScript.Clear

TfsScript

procedure Clear; override;

Description
Clears the TfsScript items.


TfsScript.Compile

TfsScript

function Compile: Boolean;

Description
Compiles the source code. Source code must be placed in TfsScript.Lines property before you call Compile method. Example:

        Lines.Text := 'begin i := 0 end.';
        SyntaxType := 'PascalScript';
        Compile;

There must be valid language definition for the selected language. At this moment you can specify 'PascalScript' and 'C++Script' as a language name.


TfsScript.Evaluate

TfsScript

function Evaluate(const Expression: String): Variant;

Description
Evaluates an expression. This function is useful for debugging purposes. Example:

ShowMessage(Evaluate('i + 1'));


TfsScript.Execute

TfsScript

procedure Execute;

Description
Executes a previously compiled script.


TfsScript.Find

TfsScript      See Also

function Find(const Name: String): TfsCustomVariable;

Description
Returns a variable/constant/class/function with given Name.


TfsScript.FindClass

TfsScript      See Also

function FindClass(const Name: String): TfsClassVariable;

Description
Returns a class variable with given Name.


TfsScript.FindLocal

TfsScript

function FindLocal(const Name: String): TfsCustomVariable;

Description
Same as Find method, but it finds a local item.


TfsScript.GetILCode

TfsScript      Example

function GetILCode(Stream: TStream): Boolean;

Description
Compiles the script and saves the compilation results in the stream. You can execute it later by calling SetILCode method.


TfsScript.IsExecutableLine

TfsScript

function IsExecutableLine(LineN: Integer; const UnitName: String = ''): Boolean;

Description
Returns True if given line contains executable code.


TfsScript.RemoveItems

TfsScript      See Also

procedure RemoveItems(Owner: TObject);

Description
Removes unused items. See AddedBy property for details.


TfsScript.Run

TfsScript

function Run: Boolean;

Description
Compiles and runs the script. Same as
  if Compile then Execute;


TfsScript.SetILCode

TfsScript      Example

function SetILCode(Stream: TStream): Boolean;

Description
Restores the compilation results previously generated by GetILCode method.


TfsScript.Terminate

TfsScript

procedure Terminate;

Description
Terminates the script execution.


TfsScript.OnGetUnit

TfsScript

property OnGetUnit: TfsGetUnitEvent read FOnGetUnit write FOnGetUnit;

Description
This event is fired for each used unit. It is useable if you store units in a database.


TfsScript.OnRunLine

TfsScript      See Also

property OnRunLine: TfsRunLineEvent read FOnRunLine write FOnRunLine;

Description
This event is fired each time when new line of script code is executed. It is useable for debugging purposes. Assign nil to this event if you don't want a step-by-step execution.


TfsScript Hierarchy.
Hierarchy

TObject
|
TPersistent
|
TComponent
|
TfsScript


fsGlobalUnit
function fsGlobalUnit

Unit

fs_iInterpreter

function fsGlobalUnit: TfsScript;

Description
fsGlobalUnit creates and returns an instance of TfsScript that contains base types such as Integer, Boolean, information about available classes, constants, types and system procedures. Always set TfsScript.Parent := fsGlobalUnit if you want to use that information.


TfsCallMethodEvent

Unit

fs_iInterpreter

type TfsCallMethodEvent = function(Instance: TObject; ClassType: TClass; const MethodName: String; var Params: Variant): Variant of object;


TfsGetUnitEvent

Unit

fs_iInterpreter

type TfsGetUnitEvent = procedure(Sender: TfsScript; const UnitName: String; var UnitText: String) of object;


TfsGetValueEvent

Unit

fs_iInterpreter

type TfsGetValueEvent = function(Instance: TObject; ClassType: TClass; const PropName: String): Variant of object;


TfsRunLineEvent

Unit

fs_iInterpreter

type TfsRunLineEvent = procedure(Sender: TfsScript; const UnitName, SourcePos: String) of object;


TfsSetValueEvent

Unit

fs_iInterpreter

type TfsSetValueEvent = procedure(Instance: TObject; ClassType: TClass; const PropName: String; Value: Variant) of object;


TfsVarType

Unit

fs_iInterpreter

type TfsVarType = (fvtInt, fvtBool, fvtFloat, fvtChar, fvtString, fvtClass, fvtArray, fvtVariant, fvtEnum);


Unit fs_iSysRTTI

FS

Contains the standard functions that can be called inside a script:

function IntToStr(i: Integer): String
function FloatToStr(e: Extended): String
function DateToStr(e: Extended): String
function TimeToStr(e: Extended): String
function DateTimeToStr(e: Extended): String

function StrToInt(s: String): Integer
function StrToFloat(s: String): Extended
function StrToDate(s: String): Extended
function StrToTime(s: String): Extended
function StrToDateTime(s: String): Extended

function Format(Fmt: String; Args: array): String
function FormatFloat(Fmt: String; Value: Extended): String
function FormatDateTime(Fmt: String; DateTime: TDateTime): String
function FormatMaskText(EditMask: string; Value: string): string

function EncodeDate(Year, Month, Day: Word): TDateTime
procedure DecodeDate(Date: TDateTime; var Year, Month, Day: Word)
function EncodeTime(Hour, Min, Sec, MSec: Word): TDateTime
procedure DecodeTime(Time: TDateTime; var Hour, Min, Sec, MSec: Word)
function Date: TDateTime
function Time: TDateTime
function Now: TDateTime
function DayOfWeek(aDate: DateTime): Integer
function IsLeapYear(Year: Word): Boolean
function DaysInMonth(nYear, nMonth: Integer): Integer

function Length(s: String): Integer
function Copy(s: String; from, count: Integer): String
function Pos(substr, s: String): Integer
procedure Delete(var s: String; from, count: Integer): String
procedure Insert(s: String; var s2: String; pos: Integer): String
function Uppercase(s: String): String
function Lowercase(s: String): String
function Trim(s: String): String
function NameCase(s: String): String
function CompareText(s, s1: String): Integer
function Chr(i: Integer): Char
function Ord(ch: Char): Integer
procedure SetLength(var S: String; L: Integer)

function Round(e: Extended): Integer
function Trunc(e: Extended): Integer
function Int(e: Extended): Integer
function Frac(X: Extended): Extended
function Sqrt(e: Extended): Extended
function Abs(e: Extended): Extended
function Sin(e: Extended): Extended
function Cos(e: Extended): Extended
function ArcTan(X: Extended): Extended
function Tan(X: Extended): Extended
function Exp(X: Extended): Extended
function Ln(X: Extended): Extended
function Pi: Extended

procedure Inc(var i: Integer; incr: Integer = 1)
procedure Dec(var i: Integer; decr: Integer = 1)
procedure RaiseException(Param: String)
procedure ShowMessage(Msg: Variant)
procedure Randomize
function Random: Extended
function ValidInt(cInt: String): Boolean
function ValidFloat(cFlt: String): Boolean
function ValidDate(cDate: String): Boolean

Note This unit is always included, you don't need to use it directly.


Unit fs_iTools

FS

Contains set of helper methods.

Functions and procedures:

fsGetLanguageList 	fsPosToPoint 	GenerateXMLContents


fsGetLanguageList
procedure fsGetLanguageList

Unit

fs_iTools

procedure fsGetLanguageList(List: TStrings);

Description
Returns the list of languages supported.


fsPosToPoint
function fsPosToPoint

Example

Unit

fs_iTools

function fsPosToPoint(ErrorPos: String): TPoint;

Description
Converts an error position to the line/column position.


GenerateXMLContents
procedure GenerateXMLContents

Example

Unit

fs_iTools

procedure GenerateXMLContents(Prog: TfsScript; Item: TfsXMLItem);

Description
Generates a XML document containing an information about functions, types and classes available to the TfsScript.


Unit fs_XML

FS

This unit contains classes and methods intended for work with XML files.

Objects:

TfsXMLDocument 	TfsXMLItem

Functions and procedures:

StrToXML 	ValueToXML 	XMLToStr


TfsXMLDocument Properties.
TfsXMLDocument properties

TfsXMLDocument      Alphabetically      Legend

In TfsXMLDocument

AutoIndent

Root


TfsXMLDocument Properties.
TfsXMLDocument properties

TfsXMLDocument      By Object      Legend

AutoIndent

Root


TfsXMLDocument Methods.
TfsXMLDocument methods

TfsXMLDocument      Alphabetically      Legend

In TfsXMLDocument

Clear

LoadFromFile

LoadFromStream

SaveToFile

SaveToStream


TfsXMLDocument Methods.
TfsXMLDocument methods

TfsXMLDocument      By Object      Legend

Clear

LoadFromFile

LoadFromStream

SaveToFile

SaveToStream


TfsXMLDocument Events.
TfsXMLDocument events

TfsXMLDocument      Alphabetically      Legend


TfsXMLDocument Events.
TfsXMLDocument events

TfsXMLDocument      By Object      Legend


TfsXMLDocument

Hierarchy      Properties      Methods

TfsXMLDocument contains methods and properties for working with XML files and in-memory structures.

Unit
fs_XML

type TfsXMLDocument = class(TObject)

Description
Use TfsXMLDocument if you want to work with XML format. This class contains methods for loading XML file (LoadFromStream, LoadFromFile), saving (SaveToStream, SaveToFile) and XML in-memory structure (Root).


TfsXMLDocument.AutoIndent

TfsXMLDocument

property AutoIndent : Boolean;

Description

If this property is set to True, output XML file will contain CR+LF characters and space indents (for more readability). Default value is False.


TfsXMLDocument.Root

TfsXMLDocument

property Root : TfsXMLItem;

Description

Root node of the XML in-memory structure.


TfsXMLDocument.Clear

TfsXMLDocument

procedure Clear;

Description
Clears and frees all XML contents.


TfsXMLDocument.LoadFromFile

TfsXMLDocument

procedure LoadFromFile(const FileName: String);

Description
Loads an XML document from file.

Note The file must contain a header (<?xml version="1.0"?>).


TfsXMLDocument.LoadFromStream

TfsXMLDocument

procedure LoadFromStream(Stream: TStream);

Description
Loads an XML document from stream.

Note The stream must contain a header (<?xml version="1.0"?>).


TfsXMLDocument.SaveToFile

TfsXMLDocument

procedure SaveToFile(const FileName: String);

Description
Saves the XML document to a file. If AutoIndent property is set to True, output file will be more readable, but have bigger size.


TfsXMLDocument.SaveToStream

TfsXMLDocument

procedure SaveToStream(Stream: TStream);

Description
Saves the XML document to a stream. If AutoIndent property is set to True, output file will be more readable, but have bigger size.


TfsXMLDocument Hierarchy.
Hierarchy

TObject
|
TfsXMLDocument


TfsXMLItem Properties.
TfsXMLItem properties

TfsXMLItem      Alphabetically      Legend

In TfsXMLItem

Count

Data

Items

Name

Parent

Prop

Text


TfsXMLItem Properties.
TfsXMLItem properties

TfsXMLItem      By Object      Legend

Count

Data

Items

Name

Parent

Prop

Text


TfsXMLItem Methods.
TfsXMLItem methods

TfsXMLItem      Alphabetically      Legend

In TfsXMLItem

Add

AddItem

Clear

Find

FindItem

IndexOf

InsertItem

Root


TfsXMLItem Methods.
TfsXMLItem methods

TfsXMLItem      By Object      Legend

Add

AddItem

Clear

Find

FindItem

IndexOf

InsertItem

Root


TfsXMLItem Events.
TfsXMLItem events

TfsXMLItem      Alphabetically      Legend


TfsXMLItem Events.
TfsXMLItem events

TfsXMLItem      By Object      Legend


TfsXMLItem

Hierarchy      Properties      Methods

Unit
fs_XML

type TfsXMLItem = class(TObject)

Description
TfsXMLItem represents one XML item. XML item has a Name (name of the item) and Text (properties of the item) properties that describes an item. For example, on-disk XML item <item name="item1"> will have Name = 'item' and Text = 'name="item1"' when loaded. XML item also has subitems (Items property).


TfsXMLItem.Count

TfsXMLItem

property Count : Integer;

Description

Number of subitems of the XML item.


TfsXMLItem.Data

TfsXMLItem

property Data : Pointer;

Description

Additional data attached to the XML item.


TfsXMLItem.Items

TfsXMLItem

property Items : TfsXMLItem;

Description

List of subitems of the XML item.


TfsXMLItem.Name

TfsXMLItem

property Name : String;

Description

Name of the XML item.


TfsXMLItem.Parent

TfsXMLItem

property Parent : TfsXMLItem;

Description

Parent item of the XML item.


TfsXMLItem.Prop

TfsXMLItem

property Prop : String;

Description

Helper to access particular property of the XML item. All properties are stored in the TfsXMLItem.Text property. For example, on-disk XML item <item name="item1" color="clBlack"> will be represented as TfsXMLItem with Name = 'item' and Text = 'name="item1" color="clBlack"'. To get or set value of the 'color' property, call TfsXMLItem.Prop['color'] := somevalue, or somevalue := TfsXMLItem.Prop['color'].


TfsXMLItem.Text

TfsXMLItem

property Text : String;

Description

Text property contains all properties of the XML item.Text property. For example, on-disk XML item <item name="item1" color="clBlack"> will be represented as TfsXMLItem with Name = 'item' and Text = 'name="item1" color="clBlack"'.


TfsXMLItem.Add

TfsXMLItem

function Add: TfsXMLItem;

Description
Creates and adds a child item to the TfsXMLItem.


TfsXMLItem.AddItem

TfsXMLItem

procedure AddItem(Item: TfsXMLItem);

Description
Adds a child item to the TfsXMLItem.


TfsXMLItem.Clear

TfsXMLItem

procedure Clear;

Description
Deletes all child items of the XML item.


TfsXMLItem.Find

TfsXMLItem

function Find(const Name: String): Integer;

Description
Finds a child item with given Name. Returns the index of item found, or -1 if no items found.


TfsXMLItem.FindItem

TfsXMLItem

function FindItem(const Name: String): TfsXMLItem;

Description
Finds a child item with given Name. Returns the child item found, or nil if no items found.


TfsXMLItem.IndexOf

TfsXMLItem

function IndexOf(Item: TfsXMLItem): Integer;

Description
Return the index of a child item or -1 if no items found.


TfsXMLItem.InsertItem

TfsXMLItem

procedure InsertItem(Index: Integer; Item: TfsXMLItem);

Description
Insert a child item before the item with specified index.


TfsXMLItem.Root

TfsXMLItem

function Root: TfsXMLItem;

Description
Returns the root item of the XML document.


TfsXMLItem Hierarchy.
Hierarchy

TObject
|
TfsXMLItem


StrToXML
function StrToXML

Unit

fs_XML

function StrToXML(const s: String): String;

Description
Converts the string to the XML-compatible string. This function converts string characters ", <, >, CR, LF, & to its decimal presentation.

Note Characters < and > are converted to &#60; &#62; instead of &lt; &gt;


ValueToXML
function ValueToXML

Unit

fs_XML

function ValueToXML(const Value: Variant): String;

Description
Converts the value to the XML-compatible string.


XMLToStr
function XMLToStr

Unit

fs_XML

function XMLToStr(const s: String): String;

Description
Converts the XML string that may contain control characters like &#13; to the normal string.

Note Characters < and > are represented as &#60; &#62; instead of &lt; &gt;