爱招飞帮助手册
目录

数据控制控件

# Smart 控件使用(数据控制)

  该组内包含一些用于控制数据信息等的组件，如连接至TARS服务器，实现数据交互，微信推送等相关的功能。

# 1. TRFConnection 组件

  该组件用于建立与TARS服务端的连接。通常用于一些窗体内的临时连接。如果程序中多个窗体需要使用同一个连接设置，请使用Smart中的帐套设置。

# 1.1. 属性

属性 功能说明
Active 是否激活该组件
ConnectionDefName 连接的帐套（TARS连接设置）名称
ForceEncryption 是否开启加密连接
LoginOptions 连接选项设置
MD5Salt: MD5盐值，如在TARS中有设置则该处需与TARS中的设置相同
Password: TARS连接设置中使用的连接用户的密码
UserName: TARS连接设置中使用的连接的用户名
ModuleFileName 连接功能使用的模块名称
SecureKey 保证连接安全使用的安全码，此处需与TARS中设置的安全码一致
ServerAddr TARS服务器的IP地址
ServerPort TARS服务器的连接端口

# 2. TRFDataSet 组件

  该组件用于从数据库中获取数据形成数据集信息。数据集组件是数据感知组中组件的数据来源，也是数据图表等的数据来源。

# 2.1. 属性

属性 功能说明
Active 是否激活该组件
Connection 指定数据集连接的来源
SQL 生成数据集的构造SQL语句

# 2.1.1. Connection 属性

  指定数据集连接的来源。连接的来源有两种，一种来自TRFConnection组件，另一种来自于Smart的帐套设置。

  //连接来源可以来自同一窗体中的TRFConnection组件
  FThis.RFDataSet1.Connection := FThis.RFConnection1;
  //连接来源也可以来自Smart的帐套设置
  FThis.RFDataSet1.Connection := DM.DBConnection;
1
2
3
4

# 2.1.2. SQL 属性

  该属性是构造数据集使用的SQL语句。

  FThis.RFDataSet1.SQL.Text := 'SELECT * FROM Basic_Unit';
1

# 2.1.3. RecordCount 属性

  该属性用于显示当前数据集中包含的记录的数目。

  FThis.Label1.Text := '数据集中包含的记录数为：' + FThis.RFDataSet1.RecordCount.ToString;
1

# 2.2. 方法

# 2.2.1. Open 方法

  该方法用于在SQL属性中包含SQL语句时打开数据集。

  FThis.RFDataSet1.Open;
1

# 2.2.2. Edit 方法

  使数据集对应选择的记录处于编辑状态。

  FThis.RFDataSet1.Edit;
1

# 2.2.3. Append 方法

  使数据集处于新增记录的状态。

  FThis.RFDataSet1.Append;
1

# 2.2.4. FieldByName 方法

  获取数据集中的字段的方法。

  //为数据集中当前指向的记录中的字段赋值，需要注意数据类型要一致
  FThis.DataSetMaster.FieldByName('FBillID').AsInteger := 23020001;
  FThis.DataSetMaster.FieldByName('FCreateDate').AsDateTime := Now();
1
2
3

# 2.2.5. Next 方法

  将数据集指向下一条记录。

  FThis.RFDataSet1.Next;
1

# 2.2.6. EmptyDataSet 方法

  清空数据集中的内容。

# 2.2.7. ApplyUpdates 方法

  将当前数据集的更改信息保存至数据库中。

  FThis.RFDataSet1.ApplyUpdates(-1);
1

# 3. TRFStoredProc 组件

  该组件用于执行数据库中的存储过程。

  该组件用于执行数据库中的存储过程。按照要求将存储过程的名称及参数信息获取输入，可执行相应的存储过程。

# 3.1. 属性

名称 说明
Active 数据集是否开启
Aggregrates 为数据集定义的客户端汇总的集合
AggregratesActive 是否自动计算汇总值
AutoCalcFields 确定何时触发OnCalcFields事件以及何时计算查找字段值
Connection 指定控件使用的连接控件
Filter 设置过滤条件
Filtered 是否开启过滤器
Params 设置存储过程使用的参数
StoredProcName 指定在服务器端调用的存储过程的名称

# 3.1.1. ExecProc

procedure ExecProc; 
function ExecProc(const AProcName: String): LongInt; 
function ExecProc(const AProcName: String; const AParams: array of Variant): LongInt;
function ExecProc(const AProcName: String; const AParams: array of Variant;  const ATypes: array of TFieldType): LongInt;
1
2
3
4

  执行存储过程。

//1
RFStoredProc1.StoredProcName := 'myproc';
RFStoredProc1.Prepare;
RFStoredProc1.ParamByName('inval').Value := 100;
RFStoredProc1.ExecProc;
ShowMessage(RFStoredProc1.ParamByName('outval').AsString);

//2
RFStoredProc1.ExecProc('myproc');

//3
RFStoredProc1.ExecProc('myproc;2', [100, 'qweqwe']);

//4
RFStoredProc1.ExecProc('myproc', [100, 'qweqwe'], [ftInteger, ftWideString]);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# 4. TRFScript 组件

  该组件用于执行脚本，可作为配置使用，提高程序的灵活性。

# 4.1. 属性

属性 功能说明
Cooection 设置连接方式，可选方式有TRFConnection组件/帐套设置
Script 需要运行的脚本

# 5. TRFFileTransfer 组件

  该组件用于与TARS服务器进行文件传输。

# 5.1. 属性

属性 功能说明
Connection 设置连接方式，可选方式有TRFConnection组件/帐套设置

# 5.2. 事件

事件 何时触发
OnDeleteDone 当TARS云端文件删除完成后触发该事件
OnDownloadDone 当文件下载完成后触发该事件
OnDownloadProgress 当正在下载文件时触发该事件，可用于展示文件下载进度
OnUploadDone 当文件上传完成后触发该事件
OnUploadProgress 当文件正在上传时触发该事件

# 5.3. 方法

# 5.3.1. Upload 方法

function Upload(ALocalFileName: String; ARemoteFilPath: String; 
  ARemoteFileName: String): Boolean;
1
2

  该方法可将本地文件上传到TARS服务器。

  • ALocalFileName： 本地文件(需在Smart程序目录下)地址。
  • ARemoteFilePath： TARS服务器上传地址所在目录。
  • ARemoteFileName： TARS服务器上传文件的地址。

  文件上传示例代码如下：

procedure TMyHandler.Button1Click;
//点击按钮以上传文件
begin
  FThis.RFFileTransfer1.Connection := DM.DBConnection;
  if FThis.RFFileTransfer1.Upload('icon.ico','upload','icon.ico') then
  ShowMessage('文件上传成功！');
end;
1
2
3
4
5
6
7

# 5.3.2. Download 方法

function Download(ARemoteFileName: String; ALocalNewFileName: String): Boolean;
1

  从TARS服务器指定的文件目录中将指定文件下载到本地。

  • ARemoteFileName： TARS文件服务器指定的文件地址。
  • ALocalNewFileName： 下载到本地的文件地址。

  文件下载示例代码如下：

procedure TMyHandler.Button1Click;
//点击按钮以下载文件
begin
  FThis.RFFileTransfer1.Connection := DM.DBConnection;
  if FThis.RFFileTransfer1.Download('upload\icon.ico','icon.ico') then
  ShowMessage('文件下载成功！');
end;
1
2
3
4
5
6
7

# 5.3.3. Delete 方法

function Delete(ARemoteFileName: String): Boolean;
1

  删除TARS文件服务器中指定的文件。

  • ARemoteFileName： TARS文件服务器指定的文件地址。

  文件删除示例代码如下：

procedure TMyHandler.Button1Click;
//点击按钮以删除文件
begin
  FThis.RFFileTransfer1.Connection := DM.DBConnection;
  if FThis.RFFileTransfer1.Delete('upload\icon.ico') then
  ShowMessage('文件删除成功！');
end;
1
2
3
4
5
6
7

# 5.3.4. FileMD5 方法

function FileMD5(ARemoteFileName: String): String;
1

  返回位于TARS服务器中的文件的MD5校验值。可用于检测文件是否被恶意修改。

  • ARemoteFileName： TARS文件服务器指定的文件地址。

  获取文件校验值的示例代码如下：

procedure TMyHandler.Button1Click;
//点击按钮以获取文件校验码
begin
  FThis.RFFileTransfer1.Connection := DM.DBConnection;
  FThis.Label1.Caption := FThis.RFFileTransfer1.FileMD5('upload\icon.ico');
end;
1
2
3
4
5
6

# 5.3.5. CreateDir 方法

function CreateDir(AFilePath: String): Boolean;
1

  在TARS服务器中创建文件目录。

  • AFilePath： 创建的文件夹的目录路径，如果该目录的上级目录不存在则会同时新建此目录。

  创建文件目录的示例代码如下：

procedure TMyHandler.Button1Click;
//点击按钮新增目录
begin
  FThis.RFFileTransfer1.Connection := DM.DBConnection;
  if FThis.RFFileTransfer1.CreateDir('upload\downloads') then
  ShowMessage('新增目录成功！');
end;
1
2
3
4
5
6
7

# 5.3.6. MoveFile 方法

function MoveFile(ARemoteFileName: String; ANewFileName: String): Boolean;
1

  将TARS服务器中的文件移动至新的目录中。

  • ARemoteFileName： TARS文件服务器指定的文件地址。
  • ANewFileName： TARS文件服务器指定的移动文件地址。

  移动文件的示例代码如下：

procedure TMyHandler.Button1Click;
//点击移动文件
begin
  FThis.RFFileTransfer1.Connection := DM.DBConnection;
  if FThis.RFFileTransfer1.MoveFile('upload\icon.ico','icon.ico') then
  ShowMessage('文件移动成功！');
end;
1
2
3
4
5
6
7

# 5.3.7. CopyFile 方法

function CopyFile(ARemoteFileName: String; ANewFileName: String): Boolean;
1

  将TARS服务器中的文件复制到新的目录中。

  • ARemoteFileName： TARS文件服务器指定的文件地址。
  • ANewFileName： TARS文件服务器指定的复制文件地址。

  移动文件的示例代码如下：

procedure TMyHandler.Button1Click;
//点击复制文件
begin
  FThis.RFFileTransfer1.Connection := DM.DBConnection;
  if FThis.RFFileTransfer1.CopyFile('icon.ico','upload\icon.ico') then
  ShowMessage('文件复制成功！');
end;
1
2
3
4
5
6
7

# 5.3.8. RenameFile 方法

function RenameFile(ARemoteFileName: String; ANewFileName: String): Boolean;
1

  将TARS服务器中的文件进行重新命名。

  • ARemoteFileName： TARS文件服务器指定的文件地址。
  • ANewFileName： TARS文件服务器指定的新命名的文件地址。

  重命名文件的示例代码如下：

procedure TMyHandler.Button1Click;
//点击重命名文件
begin
  FThis.RFFileTransfer1.Connection := DM.DBConnection;
  if FThis.RFFileTransfer1.RenameFile('upload\icon.ico','upload\icon111.ico') then
  ShowMessage('文件重命名成功！');
end;
1
2
3
4
5
6
7

# 5.3.9. FileExists 方法

function FileExists(ARemoteFileName: String): Boolean;
1

  检验TARS服务器中指定目录的文件是否存在。

  • ARemoteFileName： TARS文件服务器指定的文件地址。

  检验文件是否存在的示例代码如下：

procedure TMyHandler.Button1Click;
//点击以检验文件是否存在
begin
  FThis.RFFileTransfer1.Connection := DM.DBConnection;
  if FThis.RFFileTransfer1.FileExists('upload\icon.ico') then
  ShowMessage('icon.ico文件存在于upload目录中！');
end;
1
2
3
4
5
6
7

# 6. TRFSMSSender 组件

  该组件可用于对接短信平台实现在TARS上使用短信发送的功能。具体使用方法可参考短信发送。

# 6.1. 属性

属性 功能说明
AccessKeyId 短信服务提供商的AccessKeyId
AcessKeySecret 短信服务提供商的AccessKeySecret
Connection 指定连接的来源
PhoneNumbers 接收短信的手机号码，如有多个号码请用;分隔
Provider 短信服务提供商选择，有阿里云和阿里大于可选
SigName 短信签名显示
TemplateCode 短信模板名称
TemplateParam 短信模板参数

  以上参数的详细说明请参考阿里云短信服务文档 (opens new window)。

# 6.2. 方法

# 6.2.1. Execute 方法

  执行短信发送的操作。

if FThis.RFSMSSender1.Execute then
    Showmessage('短信下发成功！');
1
2

# 7. TRFWechatMP 组件

  该组件可实现与微信公众平台对接实现微信公众号模板消息推送的功能。

# 7.1. 属性

属性 功能说明
AccountName 微信公众号的名称，在TARS中有相关设置
Connection 设置连接方式，可选方式有TRFConnection组件/帐套设置

# 7.2. 方法

# 7.2.1. SendCustomMessage

function SendCustomMessage(const AOpenID, AContent: string): Boolean;
1

  发送文本消息。

  • 示例
Begin
    //调用方式
	FThis.RFWeChatMP1.SendCustomMessage('oxCHX6X4rjxj-TEStyhPmkNILNp9A','你好!');
End;
1
2
3
4

# 7.2.2. SendTemplateMessage

function SendTemplateMessage(const AJsonContent: string): Boolean;
1

  发送模板消息。

部分 说明
AccountName 微信公众号
AJsonContent Json格式化字符串，格式请参考https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Template_Message_Interface.html (opens new window)
  • 示例
Begin
    //调用方式
	FThis.RFWeChatMP1.SendTemplateMessage('JsonContent');
End;
1
2
3
4

# 8. TFDConnection 组件

  TFDConnection 组件是数据库的连接组件，可作为数据集组件TFDQuery的连接源使用。

# 8.1. 属性

属性 说明
Connected 是否连接到数据库
Params 连接参数的相关设置

# 8.1.1. Connected

property Connected: Boolean;
1

  该属性用于确认组件是否需要发起数据库的连接。为True时与数据库进行连接，为False时断开连接。

# 8.1.2. Params

property Params: TFDConnectionDefParams
1

  设定连接参数。

  点击右侧的配置按钮，打开参数配置的对话框，设置连接串的参数。不同数据库的连接设置有所差异。

MSSQL

MSSQL的连接参数设置如下。

DriverID=MSSQL
Pooled=False
Database=Smart
User_Name=sa
Password=123456
Server=.
MARS=Yes
VariantFormat=String
ExtendedMetadata=False
MetaCaseIns=False
MetaCaseInsCat=Choose
1
2
3
4
5
6
7
8
9
10
11
参数名称 示例取值 描述
DriverID MSSQL 数据库的驱动类型，可以选择 MSSQL
Pooled False 是否使用连接池
DataBase Smart 连接的数据库名称
User_Name sa 数据库连接的用户名
Password 123456 数据库连接的密码
Server . 连接的数据库服务器的名称
MARS Yes 设置数据库是否使用连接复用
VariantFormat String 控制 SQL_VARIANT 数据类型表示
ExtendedMetadata False 设置查询结果集的扩展描述
MetaCaseIns False 设置元数据是否区分大小写
MetaCaseInsCat Choose 设置 SQL Server 目录名称区分大小写，Choose自动监测目录名称区分大小写

MySQL

MySQL 的连接参数设置如下。

DriverID=MySQL
Pooled=False
Database=isoface
User_Name=root
Password=123456
Server=192.168.0.201
Port=3306
Compress=True
UseSSL=False
ResultMode=Store
TinyIntFormat=Boolean
1
2
3
4
5
6
7
8
9
10
11
参数名称 示例取值 描述
DriverID MSSQL 数据库的驱动类型，可以选择 MySQL
Pooled False 是否使用连接池
DataBase isoface MySQL数据库的名称
User_Name root MySQL数据库的用户名称
Password 123456 MySQL数据库的用户登录密码
Server 192.168.0.201 MySQL数据库的服务器地址
Port 3306 MySQL数据库的端口号
Compress True 是否启用数据压缩功能
UseSSL False 是否启用SSL
ResultMode Store 对客户端的结果集的获取
TinyIntFormat Boolean 设置 TinyInt(1)数据类型表示

MsAcc

MsAcc 的连接参数设置如下。

DriverID=MSAcc
Pooled=False
Database=D:\IsoFace\LocalData.mdb
User_Name=Admin
Password=
StringFormat=Choose
1
2
3
4
5
6
参数名称 示例取值 描述
DriverID MsAcc 数据库的驱动类型，可以选择 MsAcc
Pooled False 是否使用连接池
DataBase D:\IsoFace\LocalData.mdb 数据库文件的路径
User_Name Admin 数据库文件的登录用户名称
Password 数据库文件的登录用户的密码，如果未设定密码，此项留空
StringFormat Choose 定义如何表示字符串值

# 9. TFDQuery 组件

  该组件为数据集组件，用于存放查询的结果。此控件用于获取具有返回数据集的SQL查询语句。

# 9.1. 属性

名称 说明
Active 是否激活数据集
CachedUpdates 是否对更新进行缓存
Connection 设置连接使用的控件
Filter 设置过滤条件
Filtered 是否开启过滤器
SQL 设置数据库查询内容的SQL
RecordCount 数据集中的记录数量
Eof 是否处于表末尾
Bof 是否处于表开头

# 9.2. 方法

# 9.2.1. Close

procedure Close;
1

  该方法用于关闭数据集。

FThis.FDQuery1.Close;
1

# 9.2.2. Open

procedure Open;
1

  该方法用于打开数据集。

FThis.FDQuery1.Open;
1

# 9.2.3. FieldByName

function FieldByName(AFieldName: String): TFiled
1

  设置字段信息。比如读取，赋值等方式。

//PasScript
FThis.FDQuery1.FieldByName('id').AsString := '1';
1
2

# 9.2.4. First

procedure First;
1

  将数据集指针指向表的第一条记录。

# 9.2.5. Last

procedure Last;
1

  将数据集指针指向表的最后一条记录。

# 10. TFDMenTable 组件

  该组件实现内存中的数据集功能。可以实现与数据库进行数据交换。

# 10.1. 属性

名称 说明
Active 数据集是否开启
ActiveStoredUsage 存储Active属性的方式
Adapter 指定数据适配器
Aggregrates 为数据集定义的客户端汇总的集合
AggregratesActive 是否自动计算汇总值
AutoCalcFields 确定何时触发OnCalcFields事件以及何时计算查找字段值
CacheUpdates 指定数据集是否将对数据的更改记录而无需立即将其应用于数据库
Constraints 指定编辑数据时必须满足的记录级约束
ConstraintsEnabled 是否启用约束检查
Data 表示数据集中的数据，允许将数据集中的数据复制至另外一个数据集中
Filter 设置过滤条件
Filtered 是否开启过滤器

# 10.1.1. Data

property Data: IFDDataSetReference;
1

  Data属性表示数据集的内部内存数据存储。 使用此属性，应用程序可以将一个FireDAC数据集的当前结构和数据复制到另一个FireDAC数据集。

  该属性值是对IFDDataSet接口的引用。 它是引用计数的，应用程序不需要显式释放它。 如果应用程序使用变量或字段保留接口引用，则必须在关闭数据集之前释放该引用。

  数据集必须处于非活动状态才能设置此属性值，否则会引发异常。 设置后，该数据集：

  • 具有原始数据集的结构，但不包括索引，IndexDefs，过滤器等。
  • 具有原始数据集数据的副本，包括所有行版本和状态（插入，删除，更新，未更改）。
  • 如果原始数据集有未应用的更改，则CachedUpdates等于True。
  • 数据集处于开启状态。
//PasScript
FThis.FDQuery1.SQL.Text := 'select * from orders; select * from customers';

FThis.FDQuery1.Open;
FThis.FDQuery1.FetchAll;
// assign orders records to FDMemTable1
FThis.FDMemTable1.Data := FThis.FDQuery1.Data;

FThis.FDQuery1.NextRecordSet;
FThis.FDQuery1.FetchAll;
// assign customers records to FDMemTable2
FThis.FDMemTable2.Data := FThis.FDQuery1.Data;
1
2
3
4
5
6
7
8
9
10
11
12

# 10.2. 方法

  因其为内存表中的数据集，其大部分方法的使用方式与TUgFDQuery相似。

# 10.2.1. FieldByName

function FieldByName(AFieldName: String): TFiled
1

  设置字段信息。比如读取，赋值等方式。

//PasScript
FThis.FDQuery1.FieldByName('id').AsString := '1';
1
2

# 10.2.2. First

procedure Open;
1

  跳转至第一条记录。

# 10.2.3. Prior

procedure Prior;
1

  跳转至前一条记录。

# 10.2.4. Next

procedure Next;
1

  跳转至后一条记录。

# 10.2.5. Last

procedure Last;
1

  跳转至最后一条记录。

# 10.2.6. Edit

procedure Edit;
1

  编辑当前指向的记录。

# 10.2.7. Cancel

procedure Cancel;
1

  取消对当前记录的修改。

# 10.2.8. Post

procedure Post;
1

  提交数据。

# 10.2.9. Insert

procedure Insert;
1

  插入记录。

# 10.2.10. Append

procedure Append;
1

  添加记录。

# 10.2.11. Delete

procedure Delete;
1

  删除记录。

# 10.2.12. Refresh

procedure Refresh;
1

  刷新记录。

# 11. TFDStoredProc

  使用TFDStoredProc执行服务器端存储过程，浏览结果集，并编辑结果集记录。

# 11.1. 属性

名称 说明
Active 数据集是否开启
ActiveStoredUsage 存储Active属性的方式
Adapter 指定数据适配器
Aggregrates 为数据集定义的客户端汇总的集合
AggregratesActive 是否自动计算汇总值
AutoCalcFields 确定何时触发OnCalcFields事件以及何时计算查找字段值
CacheUpdates 指定数据集是否将对数据的更改记录而无需立即将其应用于数据库
Constraints 指定编辑数据时必须满足的记录级约束
ConstraintsEnabled 是否启用约束检查
Data 表示数据集中的数据，允许将数据集中的数据复制至另外一个数据集中
Filter 设置过滤条件
Filtered 是否开启过滤器
Params 设置存储过程使用的参数
SchemaAdapter 获取或设置对模式适配器的引用作为“集中式缓存更新”日志
StoredProcName 指定在服务器端调用的存储过程的名称
Transaction 指定事务连接使用的控件

# 11.2. 方法

# 11.2.1. ExecProc

procedure ExecProc;
1

  执行存储过程。

//PasScript
//1
FThis.FDStoredProc1.StoredProcName := 'myproc';
FThis.FDStoredProc1.Prepare;
FThis.FDStoredProc1.ParamByName('inval').Value := 100;
FThis.FDStoredProc1.ExecProc;
ShowMessage(FThis.FDStoredProc1.ParamByName('outval').AsString);

//2
FThis.FDStoredProc1.ExecProc('myproc');

//3
FThis.FDStoredProc1.ExecProc('myproc;2', [100, 'qweqwe']);

//4
FThis.FDStoredProc1.ExecProc('myproc', [100, 'qweqwe'], [ftInteger, ftWideString]);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# 12. TFDPhysMSSQLDriverLink 组件

  此组件作为MSSQL的连接驱动组件，用于辅助 TFDConnection 组件连接至MSSQL组件使用。详情请参考 TFDConnection.Params。

# 13. TFDPhysMySQLDriverLink 组件

  此组件作为MySQL的连接驱动组件，用于辅助 TFDConnection 组件连接至MySQL组件使用。详情请参考 TFDConnection.Params。

# 14. TFDPhysSQLiteDriverLink 组件

  此组件作为SQLite的连接驱动组件，用于辅助 TFDConnection 组件连接至SQLite组件使用。详情请参考 TFDConnection.Params。

# 15. TFDPhysMsAccessDriverLink 组件

  此组件作为Access的连接驱动组件，用于辅助 TFDConnection 组件连接至Access组件使用。详情请参考 TFDConnection.Params。

# 16. TFDPhysPgDriverLink 组件

  此组件作为PostgreSQL的连接驱动组件，用于辅助 TFDConnection 组件连接至PostgreSQL组件使用。详情请参考 TFDConnection.Params。

# 17. TDataSource 组件

  DataSource组件用来为数据感知组中的组件提供数据来源。

# 17.1. 属性

属性 功能说明
AutoEdit 设置控件是否进行自动编辑
DataSet 设定使用的数据集名称
Enabled 是否启用该组件
专业工控控件
数据表格控件

← 数据表格控件→

Copyright © 2021-2025 爱招飞IsoFace | ALL Rights Reserved