api.docx

api.docx

《api.docx》由会员分享，可在线阅读，更多相关《api.docx（86页珍藏版）》请在冰豆网上搜索。

api

表单工具API1

选择函数窗口的帮助1

系统函数2

校验函数4

dataset控件7

dataset.Field控件7

属性11

方法16

Dataset事件23

dropdownlist控件24

属性24

事件33

Grid控件35

属性35

方法44

事件48

Tab控件50

方法50

事件53

Tree控件53

开发函数：

59

基本数据类型相关60

基本控件相关64

复杂控件相关67

数据库相关70

其它72

表单工具API

选择函数窗口的帮助

在写控件的事件代码时，可以弹出函数列表来选择输入。

本章来详细来说明一下这些函数，这些函数分为四类：

系统函数：

这是eform内置的一些最通用的函数，可以直接使用在比如按钮的点击事件中。

每个函数完成一个特定的操作或功能。

自定义函数：

这是指在eform表单设计器的自定义函数窗口中写的javascript函数。

每个表单很可能不一样，如果没有手工写javascript函数的话，则此分类下就是空的。

校验函数：

这是eform内置的用于校验数据输入是否合法的一组通用函数。

它一般用于改变事件（onchange）退出事件（onblur）中，也可以用于数据集的字段的数据验证事件中。

常常可以在一个事件（比如text1的onchange）中选上多个校验函数。

比如：

$valid（'不含汉字'）;$valid（'不含双引号'）;。

业务函数：

是指用户在集成eform时加上的，和自己的业务信息相关的一些功能函数。

下面开始详细说明一下这些函数：

系统函数

$eform（'提交数据成功后刷新上一窗口'）

描述：

表单保存好后，会提示保存成功，并刷新上一窗口中的表格中的数据，如果出错会提示错误信息。

$eform（'提交数据成功后提示'）

描述：

表单保存好后，会提示保存成功，如保存出错会提示错误信息。

$eform（'提交数据成功后退出'）

描述：

表单保存好后退出，如果保存不成功则提示错误信息。

$eform（'提交数据'）

描述：

表单保存好后不提示成功信息，如保存出错提示错误信息。

$eform（'打开窗口新增记录'）

描述：

打开新的窗口用于新增一条记录，窗口的url应先赋值给fcpubdata。

CardWinUrl全局变量。

$eform（'打开窗口修改记录'）

描述：

打开新的窗口用于修改一条记录，窗口的url应先赋值给fcpubdata。

CardWinUrl全局变量。

$eform（'第一页'）

描述：

显示主数据集的第一页数据.

$eform（'上一页'）

描述：

显示主数据集的上一页数据.

$eform（'下一页'）

描述：

显示主数据集的下一页数据.

$eform（'最后页'）

描述：

显示主数据集的最后页数据.

$eform（'新增'）

描述：

主数据集新增一行,会清空主数据集所绑定的所有控件.

$eform（'删除'）

描述：

主数据集删除一行,同时删除主数据集所保存的物理表中的一条记录,删除后记录上翻一页.

$eform（'表格第一页'）

描述：

显示grid数据集的第一页数据.

$eform（'表格上一页'）

描述：

显示grid数据集的上一页数据.

$eform（'表格下一页'）

描述：

显示grid数据集的下一页数据.

$eform（'表格最后页'）

描述：

显示grid数据集的最后页数据.

$eform（'增加行'）

描述:

在表格上增加一行,同时所对应的数据集也加一条记录。

$eform（'删除行'）

描述:

在表格上删除当前行,同时所对应的数据集也删除一条记录。

$eform（'删除行且删除记录'）

描述:

删除表格中的当前行,包括数据库中的此记录也删除掉,是物理删除,不是作beactive标记.

$eform（'删除表格多选行'）

描述:

删除表格中的选中的多行,包括数据库中的此记录也删除掉.它要求表格的多选列必须是第一列.

$eform（'表格选中多行'）

描述:

执行此函数会选中或不选中表格的当前行，选中是指在表格的首列打勾.此函数一般用于表格的双击事件中。

DjOpen（djsn,updataset,opentype,sModal,sVersion,sTitle）

输入参数：

djsn单据模版标识

updataset要传的对象

opentype打开表单的类别,可为:

默认/新增/修改/展现

sModal表示打开表单的窗口模式,值为当前窗口/有模式窗口/无模式窗口

sVersion表示是以测试方式打开还是直接打开生成的HTML文件,值为测试/直接

sTitle表示打开窗口的标题,如为空则系统给默认标题.

输出参数：

可自定义,当有模式或无模式打开表单时,返回值可以通过在打开的表单中给window.returnValue值,然后在第一个表单中接收后判断此值.

SelectZlSql（sql,sMultiSel,sHideField,likevalue,ogrid）

输入参数：

sqlsql语句,通过它控制要列出的内容

sMultiSel是否允许多选,值为是/否,缺省为否

sHideField以,分隔的隐藏字段列表

likevalue用来做模糊查找的参数,可空

ogrid如在表格控件上用此功能,则此参数应为所在的表格对象

$eform（'选择日期'）

描述:

显示下拉的日期输入窗口供用户选择输入日期到指定的编辑框中,

$eform（'关闭窗口'）

关闭窗口

$eform（'刷新条件格式'）

描述:

默认时条件格式只在刚进入表单时才有效一次,执行此命令将重新应用一次条件格式。

$eform（'刷新权限控制'）

描述:

默认时权限控制只在刚进入表单时才有效一次,执行此命令将重新应用一次权限控制。

校验函数

$valid（'整数'）;

描述：

$valid（checkType,alertMsg）校验控件的值是否是合法整数，适用于text、textarea、dropdownlist等控件的属性改变或失去焦点事件。

输入参数：

checkType：

为校验类型，整数、小数、日期、QQ、Email、身份证号等；alertMsg：

为可选参数，验证不通过时的提示信息。

$valid（'小数'）;

描述：

$valid（checkType,alertMsg）校验控件的值是否是合法小数，适用于text、textarea、dropdownlist等控件的属性改变或失去焦点事件。

输入参数：

checkType：

为校验类型，整数、小数、日期、QQ、Email、身份证号等；alertMsg：

为可选参数，验证不通过时的提示信息。

$valid（'日期'）;

描述：

$valid（checkType,alertMsg）校验控件的值是否是合法日期，适用于text、textarea、dropdownlist等控件的属性改变或失去焦点事件。

输入参数：

checkType：

为校验类型，整数、小数、日期、QQ、Email、身份证号等；alertMsg：

为可选参数，验证不通过时的提示信息。

$valid（'QQ'）;

描述：

$valid（checkType,alertMsg）校验控件的值是否是合法QQ，适用于text、textarea、dropdownlist等控件的属性改变或失去焦点事件。

输入参数：

checkType：

为校验类型，整数、小数、日期、QQ、Email、身份证号等；alertMsg：

为可选参数，验证不通过时的提示信息。

$valid（'身份证号'）;

描述：

$valid（checkType,alertMsg）校验控件的值是否是合法身份证号，适用于text、textarea、dropdownlist等控件的属性改变或失去焦点事件。

输入参数：

checkType：

为校验类型，整数、小数、日期、QQ、Email、身份证号等；alertMsg：

为可选参数，验证不通过时的提示信息。

$valid（'Email'）;

描述：

$valid（checkType,alertMsg）校验控件的值是否是合法Email地址，适用于text、textarea、dropdownlist等控件的属性改变或失去焦点事件。

输入参数：

checkType：

为校验类型，整数、小数、日期、QQ、Email、身份证号等；alertMsg：

为可选参数，验证不通过时的提示信息。

$valid（'电话号码'）;

描述：

$valid（checkType,alertMsg）校验控件的值是否是合法电话号码，适用于text、textarea、dropdownlist等控件的属性改变或失去焦点事件。

输入参数：

checkType：

为校验类型，整数、小数、日期、QQ、Email、身份证号等；alertMsg：

为可选参数，验证不通过时的提示信息。

$valid（'手机'）;

描述：

$valid（checkType,alertMsg）校验控件的值是否是合法手机，适用于text、textarea、dropdownlist等控件的属性改变或失去焦点事件。

输入参数：

checkType：

为校验类型，整数、小数、日期、QQ、Email、身份证号等；alertMsg：

为可选参数，验证不通过时的提示信息。

$valid（'邮政编号'）;

描述：

$valid（checkType,alertMsg）校验控件的值是否是合法邮政编号，适用于text、textarea、dropdownlist等控件的属性改变或失去焦点事件。

输入参数：

checkType：

为校验类型，整数、小数、日期、QQ、Email、身份证号等；alertMsg：

为可选参数，验证不通过时的提示信息。

$valid（'正数'）;

描述：

$valid（checkType,alertMsg）校验控件的值是否是合法正数，适用于text、textarea、dropdownlist等控件的属性改变或失去焦点事件。

输入参数：

checkType：

为校验类型，整数、小数、日期、QQ、Email、身份证号等；alertMsg：

为可选参数，验证不通过时的提示信息。

$valid（'正整数'）;

描述：

$valid（checkType,alertMsg）校验控件的值是否是合法正整数，适用于text、textarea、dropdownlist等控件的属性改变或失去焦点事件。

输入参数：

checkType：

为校验类型，整数、小数、日期、QQ、Email、身份证号等；alertMsg：

为可选参数，验证不通过时的提示信息。

$valid（'负数'）;

描述：

$valid（checkType,alertMsg）校验控件的值是否是合法负数，适用于text、textarea、dropdownlist等控件的属性改变或失去焦点事件。

输入参数：

checkType：

为校验类型，整数、小数、日期、QQ、Email、身份证号等；alertMsg：

为可选参数，验证不通过时的提示信息。

$valid（'负整数'）;

描述：

$valid（checkType,alertMsg）校验控件的值是否是合法负整数，适用于text、textarea、dropdownlist等控件的属性改变或失去焦点事件。

输入参数：

checkType：

为校验类型，整数、小数、日期、QQ、Email、身份证号等；alertMsg：

为可选参数，验证不通过时的提示信息。

$valid（'零或正数'）;

描述：

$valid（checkType,alertMsg）校验控件的值是否是合法零或正数，适用于text、textarea、dropdownlist等控件的属性改变或失去焦点事件。

输入参数：

checkType：

为校验类型，整数、小数、日期、QQ、Email、身份证号等；alertMsg：

为可选参数，验证不通过时的提示信息。

$valid（'零或负数'）;

描述：

$valid（checkType,alertMsg）校验控件的值是否是合法零或负数，适用于text、textarea、dropdownlist等控件的属性改变或失去焦点事件。

输入参数：

checkType：

为校验类型，整数、小数、日期、QQ、Email、身份证号等；alertMsg：

为可选参数，验证不通过时的提示信息。

$valid（'零或正整数'）;

描述：

$valid（checkType,alertMsg）校验控件的值是否是合法零或正整数，适用于text、textarea、dropdownlist等控件的属性改变或失去焦点事件。

输入参数：

checkType：

为校验类型，整数、小数、日期、QQ、Email、身份证号等；alertMsg：

为可选参数，验证不通过时的提示信息。

$valid（'零或负整数'）;

描述：

$valid（checkType,alertMsg）校验控件的值是否是合法零或负整数，适用于text、textarea、dropdownlist等控件的属性改变或失去焦点事件。

输入参数：

checkType：

为校验类型，整数、小数、日期、QQ、Email、身份证号等；alertMsg：

为可选参数，验证不通过时的提示信息。

$valid（'字母、数字或_'）;

描述：

$valid（checkType,alertMsg）校验控件的值只能是字母、数字或_，适用于text、textarea、dropdownlist等控件的属性改变或失去焦点事件。

输入参数：

checkType：

为校验类型，整数、小数、日期、QQ、Email、身份证号等；alertMsg：

为可选参数，验证不通过时的提示信息。

$valid（'不含汉字'）;

描述：

$valid（checkType,alertMsg）校验控件的值是否含有汉字，适用于text、textarea、dropdownlist等控件的属性改变或失去焦点事件。

输入参数：

checkType：

为校验类型，整数、小数、日期、QQ、Email、身份证号等；alertMsg：

为可选参数，验证不通过时的提示信息。

$valid（'不含双引号'）;

描述：

$valid（checkType,alertMsg）校验控件的值是否含有双引号，适用于text、textarea、dropdownlist等控件的属性改变或失去焦点事件。

输入参数：

checkType：

为校验类型，整数、小数、日期、QQ、Email、身份证号等；alertMsg：

为可选参数，验证不通过时的提示信息。

$valid（'不含单引号'）;

描述：

$valid（checkType,alertMsg）校验控件的值是否含有单引号，适用于text、textarea、dropdownlist等控件的属性改变或失去焦点事件。

输入参数：

checkType：

为校验类型，整数、小数、日期、QQ、Email、身份证号等；alertMsg：

为可选参数，验证不通过时的提示信息。

$valid（'不能为空'）;

描述：

$valid（checkType,alertMsg）校验控件的值是否为空，适用于text、textarea、dropdownlist等控件的属性改变或失去焦点事件。

输入参数：

checkType：

为校验类型，整数、小数、日期、QQ、Email、身份证号等；alertMsg：

为可选参数，验证不通过时的提示信息。

$valid（'字段值不重复'）;

描述：

$valid（checkType,alertMsg）校验数据集的字段的值是否重复，只有在数据集的数据验证事件（Valid）中才有效。

输入参数：

checkType：

为校验类型，整数、小数、日期、QQ、Email、身份证号等；alertMsg：

为可选参数，验证不通过时的提示信息。

dataset控件

dataset.Field控件

属性

DataType属性

字段数据类型

语法：

object.Field（'FieldName'）.DataType

示例：

[JavaScript]

functionDataType_test（）{

alert（imgdataset1.Field（'djbh'）.DataType）

}

DefaultValue属性

默认值。

语法：

object.Field['FieldName'].DefaultValue

示例

[JavaScript]

functionDefautValue_test（）{

   alert（imgdataset1.Field（'FieldName）.DefaultValue）

}

DisplayFormat属性

显示格式带，逗号表示千分位。

语法object.Field（'FieldName'）.DisplayFormat

示例

[JavaScript]

functionDisplayFormat_test（）{

   alert（imgdataset1.Field（'FieldName'）.DisplayFormat）

}

DisplayLabel属性

字段中文名。

语法

Scripting:

object.Field（'FieldName'）.DisplayLabel

示例

[JavaScript]

functionDisplayLabel_test（）{

   alert（imgdataset1.Field['djbh'].DisplayLabel）

}

DotLength属性

字段小数位数。

语法

Scripting:

object.Field（'FieldName'）.DotLength

示例

[JavaScript]

functionDotLength_test（）{

   alert（imgdataset1.Field（'djbh'）.DotLength）

}

Empty属性

判断数据集的字段对象为空、不为空情况。

语法

Scripting:

object.Field（'FieldName'）.Empty=Boolean

返回值：

boolean

设置

描写

是

表示不能为空

否

表示能为空

没有默认值，返回值是字符型。

示例

[JavaScript]

functionEmpty_test（）{

   if（imgdataset1.field（'djbh'）.Empty=='是'）{

      alert（'不能为空'）

   }

}

FieldName属性

字段名

 语法

Scripting:

object.Field（'FieldName'）.FieldName

示例

[JavaScript]

functionFieldName_test（）{

   alert（imgdataset1.Field（'djbh'）.FieldName）

}

Type属性

设置数据集的字段对象的类型

语法

Scripting:

object.Field（'FieldName'）.Type=Boolean

可能值boolean

设置

描写

是

表示不能为空

否

表示能为空

该特性可读/写，没有默认值。

示例

[JavaScript]

functionType_test（）{

alert（imgdataset1.Field（'djbh'）.Type）

}

primaryKey属性

如该值为‘是’，表示此字段设置为主键字段。

 语法

Scripting:

object.Field（'FieldName'）.primaryKey

示例

functionisKey_test（）{

alert（imgdataset1.Field（'FieldName'）.primaryKey）

}

Length属性

字段长度。

语法

[JavaScript]

functionLength_test（）{

alert（imgdataset1.Field（'djbh'）.Length）

}

Value属性

字段值。

 语法

Scripting:

object.Field（'FieldName'）.Value

示例

[JavaScript]

functionValue_test（）{

alert（imgdataset1.Field（'djbh'）.Value）

}

事件

onSetText事件

回写数据

语法

HTML:

备注

将数据回写到字段（fset）上发生。

onValid事件

数据验证。

 语法

 HTML:

备注

将数据回写到字段（fset）上发生，它在onSetText事件之前发生。

属性

opensql属性

要打开的SQL语句。

语法

Scripting:

object.opensql=[sSql]

 返回值sSql

设置

描写

sSql

标准的SQL语句

该特性可读/写，输入参数是字符类型。

 示例

[JavaScript]

functionopensql_test（）{

imgdataset1.opensql="select*fromfunctionopensql_test（）{

   imgdataset1.opensql="select*fromdwwherebeactive='是'"

}

oDom属性

返回整个数据集中的数据的dom对象。

语法

Scripting:

object.oDom=[dom]

返回值oDom

设置

描写

oDom

[object]

该特性属于只读，没有默认值，返回类型是一个标准的XMLDOM对象。

示例

[JavaScript]

functionoDom_test（）{

alert（imgdataset1.oDom）

}

xml属性

读取数据集的所有数据。

 语法

Scripting:

object.xml

可能值sxml该特性属于只读，默认值为:

，返回是字符类型。

为一个XML字符串。

示例

[JavaScript]

functionxml_test（）{

varsxml=imgdataset1.xml;

}

bAdd属性

增加标记。

语法

Scripting:

object.bAdd=[boolean]

返回值boolean

设置

描写

true

数据集处于增加状态

false

数据集不处于增加状态

bEdit属性

修改标记。

 语法

Scripting:

object.bEdit=[boolean]

 返回值boolean

设置

描写

true

数据集处于修改状态

false

数据集不处于修改状态

该特性可读/写，没有默认值，返回是布尔类型。

示例