10.函数
分类 | 函数名 | 用途 |
---|---|---|
初始函数 | Build | 创建Treelist |
Load | 加载数据 | |
Refresh | 刷新数据 | |
基本函数 | GetRows | 取得行数 |
GetCols | 取得列数 | |
SetProp(用途1) | 动态更改 Properties 属性 | |
GetProp(用途1) | 取得 Properties 属性内容 | |
SetProp(用途2) | 设置打印配置属性 | |
GetProp(用途2) | 取得打印配置属性 | |
GetUserProps | 取得 Properties 中的全部自定义属性名 | |
SetColProp | 动态更改列属性 | |
GetColProp | 取得列的属性内容 | |
GetColUserProps | 取得某列的全部自定义属性名 | |
SetGroupProp | 动态更改分组(Group)属性 | |
GetGroupProp | 取得分组(Group)的属性内容 | |
GetDroplistProp | 取得某下拉树列表的属性 | |
SetDroplistProp | 更改下拉内容属性 | |
AddDroplist | 增加下拉字典资源 | |
GetAsTree | 取得当前是否以树展现 | |
SetAsTree | 切换到以树或列表展现 | |
GetHandle | 取得Treelist或下拉的句柄 | |
OpenFreeformBar | 打开freeform工具条 | |
CloseFreeformBar | 关闭freeform工具条 | |
OpenEditFreeformDialog | 打开用于输入的freeform对话框 | |
单元格数据 | GetCellData | 取得某单元格的数据 |
SetCellData | 设置某单元格的数据 | |
GetCellText | 取得某单元格的显示内容 | |
SetCellText | 设置某单元格的显示内容 | |
SetCellDataText | 同时设定某单元格的 key-value对 | |
GetDropCellData | 取得某单元格对应到下拉树列表选中行中某列的数据 | |
SetRowCellData | 设置整行的单元格数据 | |
SetColCellData | 设置整列的单元格数据 | |
GetRadioCol | 取得某行某个GroupID的单选框(RadioButton)的选中列 | |
GetDroplistIndex | 取得某下拉List的当前选中行顺序号 | |
SetDroplistIndex | 选中下拉List中的某行 | |
GetEditText | 取得当前输入框中的文字 | |
SetEditText | 设置当前输入框中的文字 | |
GetAutoId | 取得某字段唯一的值 | |
单元格属性 | GetCellEditAble | 取得某单元EditAble |
SetCellEditAble | 单独设置某单元格EditAble | |
GetCellBackColor | 取得某单元的背景色 | |
SetCellBackColor | 单独指定某单元的背景色 | |
GetCellTextColor | 取得某单元的文字色 | |
SetCellTextColor | 单独指定某单元的文字色 | |
GetCellAlign | 取得某单元的文字水平对齐 | |
SetCellAlign | 单独指定某单元的文字水平对齐 | |
GetCellVAlign | 取得某单元的文字垂直对齐 | |
SetCellVAlign | 单独指定某单元的文字垂直对齐 | |
GetCellFontIndex | 取得某单元的字体序号 | |
SetCellFontIndex | 单独指定某单元的字体序号 | |
GetCellHyperLink | 取得某单元是否超链接 | |
SetCellHyperLink | 单独指定某单元是否为超链接 | |
GetCellTip | 取得某单元的Tip | |
SetCellTip | 单独指定某单元的Tip | |
GetCellLeftImage GetCellRightImage | 取得某单元的左侧/右侧小图标 | |
SetCellLeftImage SetCellRightImage | 单独指定某单元的左侧/右侧小图标 | |
SetCellProp | 设置某单元格的自定义属性 | |
GetCellProp | 取得某单元格的自定义属性的值 | |
GetCellProps | 取得某单元格的所有自定义属性 | |
单元格合并 | MergeSame(用途1) | 合并某行给定范围内相同内容的单元格 |
MergeSame(用途2) | 合并某列给定范围内相同内容的单元格 | |
MergeSame(用途3) | 多个列按大类、小类方式, 跨行合并相同内容的单元格 | |
Merge | 合并指定范围内的单元格 | |
DeMerge | 解除单元格的合并 | |
GetCellStatus | 取得某单元格的状态 | |
GetMainCell | 取得某单元格所在的合并区域中的主单元格(即左上角单元格) | |
GetMergedCells | 取得覆盖了某个单元格的合并范围 | |
CopyCellDataByMerge | 将主单元格的数据复制给被合并的各个单元格 | |
树相关 | IsTreeNodeRow | 是否树节点行 |
GetTreeLevel(用途一) | 取得某行在树中的层次级别,从0开始计数 | |
GetParentRow | 取得某行的父节点所在行 | |
GetChildRow | 取得某行的第一个儿子 | |
GetChildRows | 取得某行的所有儿子 | |
GetNextSibling | 取得某行的下一个/前一个同级(即同辈、兄弟)的行 | |
SetTreeImage | 更改树的图标 | |
GetTreeImage | 取得树的图标的URL | |
Expand(用法1) | 展开树节点 | |
Expand(用法2) | 展开树的前 n 层节点 | |
Collapse | 收拢树节点 | |
IsExpand | 树节点是否已展开 | |
DeleteChild | 删除所有子孙 | |
IsLazyloadRow | 某行是否Lazyload行 | |
RebuildTreeCombine | 重新整理 TreeCombine 的父节点的 Checkbox | |
RebuildPid | 重新整理 treeformat=byPid 的单列多层树的树杈树叶 | |
ClearLazyload | 强制设定某Lazyload行没有子孙 | |
当前行 / 当前单元格 | GetCurrentRow (方式一) | 取得当前选中的行 |
GetCurrentRow (方式二) | 取得当前选中的行 | |
GetCurrentRows | 取得当前选中行的数量 | |
IsRowSelected | 某行是否被选中 | |
GetCurrentCell | 取得当前选中的单元格 | |
SelectRow | 选定当前行 | |
SelectCell | 将焦点切换到某单元格 | |
CloseDropdown | 收起当前正处于下拉状态的树列表 | |
CloseEdit | 结束当前单元格的输入状态 | |
LockCurrent | 锁定当前行,使之无法被切换 | |
UnlockCurrent | 解除锁定当前行 | |
行列增删 | InsertRows (语法一) | 插入行 |
InsertRows (语法二) | 插入行 | |
InsertCol | 插入列 | |
DeleteRows (方式一) | 删除行 | |
DeleteRows (方式二) | 删除行 | |
DeleteCurrentRow | 删除当前行 | |
CopyCurrentRow | 复制当前行 | |
PasteCurrentRow | 粘帖到当前行 | |
PasteNewRow | 粘帖到新增行 | |
MoveCol | 移动某列的位置 | |
MoveRow | 移动某行的位置 | |
行列属性 | GetNextValidRow | 遍历行 |
GetNextValidCol | 遍历列 | |
GetNextVisibleCol | 遍历可视列 | |
IsTotalRow | 是否合计行 | |
IsSubTotalRow | 是否小计行 | |
GetTreeLevel(用途二) | 取得某小计行的分类层次级别,从1开始计数 | |
GetRowKey | 取得某行的Key(即键值) | |
GetRowEditAble | 某行是否能修改 | |
GetColEditAble | 某列是否能修改 | |
SetRowEditAble | 置某行能否修改 | |
SetColEditAble | 置某列能否修改 | |
GetColName | 取得列名 | |
GetColTitle | 取得列标题 | |
SetRowDeleteAble | 单独指定某行是否允许被删除(仅限于右键菜单) | |
GetRowDeleteAble | 取得某行是否允许删除 | |
GetRowBackColor | 取得某行被单独指定的背景色 | |
SetRowBackColor | 单独指定某行的背景色 | |
GetRowTextColor | 取得某行被单独指定的文字色 | |
SetRowTextColor | 单独指定某行的文字色 | |
GetRowEnable | 某行是否Enable | |
SetRowEnable | 置某行为Enable或disable | |
IsRowHide | 某行是否隐藏 | |
HideRow | 隐藏某行 | |
IsColHide | 某列是否隐藏 | |
HideCol | 隐藏某列 | |
GetColCheckState | 取得isCheckboxOnly列标题处的CheckBox的状态 | |
SetColCheckState | 设置isCheckboxOnly列标题处的CheckBox的状态 | |
GetColGroup | 取得某列所属的分组(Group) | |
行列操作 | EnsureVisible | 保证让某个单元格或某行在屏幕中可见 |
Find | 条件搜索 | |
FindAll | 条件搜索 | |
FindByKey | 按键值搜索 | |
GetUnique | 取得某列(或多列)的唯一的值的数组 | |
Filter | 过滤 | |
ApplyFilter | 对某个下拉执行过滤 | |
EnableDrag | 使2个Treelist之间能够拖拉行 | |
DisableDrag | 终止2个Treelist之间的行拖拉 | |
Copy | 将某单元格/某行/某区块内容复制进内存剪切板 | |
ScrollToRow | 窗口滚动到某行 | |
GetScrollRow | 取得窗口首个可见行 | |
提交 | Validate | 验证 |
GetChangedXML | 取得修改过的内容, 包括增、删、改 | |
GetRowChanged | 取得某行或整表的修改状态 | |
SetAsNewRow | 修改某行的“新增行”状态(和GetRowChanged的 "N" 相关) | |
GetCellChanged | 取得某单元格是否被修改过 | |
SetCellChanged | 强制更改某单元格的修改状态 | |
SetColCellChanged | 强制更改某列所有单元格的修改状态 | |
ResetChanged | 合并修改内容,清除行和单元格的修改标记,以避免重复提交. | |
GetDeleteRows | 取得被删除的总行数 | |
GetDeleteKey | 取得被删除的行中某行的Key | |
UnDelete | 恢复被删除的行 | |
Undo/Redo | EnableUndo | 开启Undo功能 |
IsUndoEnabled | Undo功能是否已开启 | |
Undo | 执行Undo | |
Redo | 执行Redo | |
SaveUndo | 将当前状态保存到 Undo 缓存 | |
UndoAble | 当前是否有Undo可操作 | |
RedoAble | 当前是否有Redo可操作 | |
ResetUndo | 清空Undo缓存以重置Undo | |
其它 | GetCustom | 取得当前Treelist的定制信息 |
SetCustom | 设置Treelist定制信息 | |
AddMenu | 增加自定义的弹出菜单项 | |
EnableMenu | 配置内置的右键菜单项,使之能显示 | |
DisableMenu | 配置内置的右键菜单项,使之不显示 | |
GetExpress | 取得表达式(Expresses) | |
SetExpress | 设置表达式(Expresses) | |
ReCalc | 重新新建表达式、合计小计 | |
GetRedrawAble | 是否能够重画 | |
SetRedrawAble | 设置让Treelist能够重画或不能重画 | |
PrintPreview | 打印预览 | |
直接打印 | ||
Import | 从 Excel 文件导入数据 | |
Export | 取得XML格式的全部数据 | |
OpenImportDialog | 打开从 Excel 导入数据的对话框 | |
OpenExportDialog | 打开转换输出对话框、或直接转换输出 | |
SetExportFilename | 指定转换输出的文件名 | |
OpenDeleteRowsDialog | 打开删除行对话框 | |
AddHotKey | 增设快捷键 |
Load | 加载数据,数据格式可以为XML、JSON、TXT(TSV)、TSV-Ex | ![]() |
参数1 | 数据所在的URL(相对或绝对), 或直接的XML/JSON/TSV/TSV-Ex数据大串; | |
参数2 | 可选, 格式为 Mode=[?];FillMode=[?];insertAt=[?];asNewRow=[?];Node=[?];GroupSep=[?];FadeInStep=[?];LoadUserProp=[?];Para1=[?];method=[?], 其含义分别为: mode - 同步/异步模式,如果等于"asynch", 表示异步(多线程)加载,异步加载能改善服务器端响应时间过久而导致的界面滞涩. FillMode - 数据填充方式, 默认为空(表示先彻底清除原有数据),也可以为如下之一: replaceByOrder - 不增删行,仅逐行替换数据; replaceByKey - 不增删行,仅按相同Key的行替换数据; insert - 不清理原有的数据,新数据添加到表中; insertNewKey 或 insertNewRow - 不替换,仅插入新的 key 的行(即 key 在树列表中不存在的行); 注:replaceByOrder 或 replaceByKey 时,数据的列可以少于树列表的列,未包含在数据中的列不会被替换. insertAt - 当fillmode = insert 或 insertNewKey 时,用来指定插入位置(行号, 前插), -1表示从末尾添加: asNewRow - 可以为true/false, 默认false,用于标记加载的行的"N"(新增行标记),用于提交: Node - 指定XML数据内所在节点名. GroupSep - 用于当XML/JSON数据中的节点名采用分组表头Group的id时,下属各列的数据分隔符,默认是斜杠("/"); FadeInStep - 屏幕展现时的淡入淡出效果,0至255,数字越小效果越明显,0表示关闭此效果,默认采用<Properties>中的同名属性. LoadUserProp - true/false, 是否把XML中的附加属性作为单元格的自定义属性一起加载,以便让GetCellProp( )函数能存取。考虑到对性能的影响,默认是false的. XML自定义附加属性例如下图的 jtc2="2331": ![]() method - http的发送方法,为Get / PostEncodeURI / Post,默认是Get. 如果为PostEncodeURI,则自动将URL中问号(?)后面的部分移到http body中,并对文字作EncodeURI转码处理; 如果是Post,则不作转码处理. Para1 - 可以为data/URL, 表示声明上面的“参数1”是纯数据串还是一个URL,一般用于TSV格式的数据,因为TSV格式的数据有时候很难自动判断到底是数据还是URL。如果不声明,系统优先判断为URL . 备注1:如果是异步加载,那么在本Load( )函数后面不应该再执行针对本Treelist的其它函数,应该在“Load”事件中作后续处理,否则异步将失去意义(非常重要); 备注2:replaceByOrder 和 replaceByKey 不是很常用,加载的数据的列是原Treelist列的子集,用于增量刷新部分列; 备注3:TSV格式数据不支持Node、FillMode、insertAt选项; | |
返回值 | 1 - 成功; 空串 - 失败(将自动弹出失败页面) | |
备注 | 建议该URL能返回 SoapLike 格式的异常包 | |
示例 | AF.func("load", "../datacenter/dataprov.aspx?id=11800102"); AF.func("load", "../datacenter/dataprov.aspx?id=11800102 \r\n fillmode=replaceByOrder"); AF.func("load", '{"Record": [{"Country":"Austria","OrderID":"10258","CustomerID":"ERNSH"}, {"Country":"Austria","OrderID":"10233","CustomerID":"GROSH"}]}'); |
Refresh | 刷新数据 | ![]() |
参数 | 可选, true/false(默认),true表示如果数据有改动,能弹出对话框询问用户是否刷新. | |
返回值 | (无) |
GetRows | 取得行数 | ![]() |
参数 | (无) | |
返回值 | 数值 | |
示例 | var rows = AF.func("getRows", ""); |
GetCols | 取得列数 | ![]() |
参数 | (无) | |
返回值 | 数值 |
GetProp(用途1) | 取得XML文档中 Properties 的属性内容 | ![]() |
参数1 | 属性名, 包括Properties中的自定义属性 | |
参数2 | 可选,用于 "Sort" 属性,true/false。true表示在指定静态排序情况下,按硕正静态排序格式输出;false表示输出当前真实的排序,默认是 false | |
返回值 | 内容 |
GetProp(用途2) | 取得打印配置属性, 即 PrintPage 节点下的全部内容 | ![]() |
参数 | 固定的串,为 Print 或 PrintPage | |
返回值 | XML串 | |
备注 | 1.打印属性稍复杂,需要您对XML规范中的 PrintPage 节点进行分析; 2.返回的XML串内容不多,因为默认的设置就不出现在XML中了; |
GetUserProps | 取得 Properties 中的全部自定义属性名 | ![]() |
参数 | (无) | |
返回值 | 属性名,多个属性名之间以逗号分隔 |
GetColProp | 取得XML文档中某 Col 的属性内容、或者自定义属性的内容 | ![]() |
参数1 | 列名或列号,建议用列名 | |
参数2 | 属性名 | |
返回值 | 内容 | |
备注 | 1.若要获取列标题文字,请用“Title”属性; 2.如果属性是 "isHide", 返回值只是1或0,如果要判断 absHide 或 absShow, 属性应该用 "isAbsHide" 或 "isAbsShow" |
GetColUserProps | 取得某列的全部自定义属性名 | ![]() |
参数 | 列名或列号,建议用列名 | |
返回值 | 自定义属性名,如果有多个自定义属性,则以逗号分隔 |
GetGroupProp | 取得XML文档中某 Group 的属性内容 | ![]() |
参数1 | Group 的 ID | |
参数2 | 属性名, 只能是 title(或name)、headerFontIndex(或fontIndex)、textColor(或color)、Align 这几种 | |
返回值 | 内容 |
GetDroplistProp | 取得某下拉树列表的属性 | ![]() |
参数1 | Droplist的ID, 也可以是某列的列名 | |
参数2 | 属性名, 例如 dataURL, RefreshDelay, treelist, dataCol, displayCol 等XML中定义的属性 | |
返回值 | 内容 |
GetAsTree | 取得当前是否以树展现 | ![]() |
参数 | (无) | |
返回值 | 1/0 - 是/否 |
SetAsTree | 切换到以树或列表展现 | ![]() |
参数 | true - 树, false - 列表 | |
返回值 | 1/0 - 成功/失败 |
CloseFreeformBar | 关闭freeform工具条 | ![]() ![]() |
参数 | 可选,0/tBar/topBar - 顶部工具条; 1/bBar/bottomBar - 底部工具条。 默认值是:如果当前只开启了一个工具条,那么默认的就是这个工具条,否则默认值是topBar | |
返回值 | (无) |
OpenEditFreeformDialog | 打开用于输入的freeform对话框 | ![]() |
参数 | 行号 | |
返回值 | (无) | |
备注 | 即回车或双击时打开的对话框,请参见 Properties 中的 editFreeformId 属性 |
GetCellText | 取得某单元格的显示内容 | ![]() ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
返回值 | 串 | |
备注 | 显示内容是指有下拉、或显示掩码的列,或者是通过 SetCellDataText 函数设置了 key-value对的内容,有别于真实数据(data)的显示串,说白了就是你在屏幕上看到的文字 |
SetCellText | 设置某单元格的显示内容 | ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
参数3 | 内容串 | |
返回值 | 1 - 成功; 空串 - 失败 | |
备注 | 常用于和Droplist绑定的EditWithButton, 否则和SetCellData( )同义. |
SetCellDataText | 同时设定某单元格的 key-value对,包括值、和显示的内容 | ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
参数3 | 值串 | |
参数4 | 内容串 | |
返回值 | 1 - 成功; 空串 - 失败 | |
备注 | 1.普通的列都可以拥有简易的 key-value对字典,不管是否下拉; 2.如果 edittype 为 droplist, 此 key-value对 将自动加入下拉字典. |
GetRadioCol | 取得某行某个GroupID的单选框(RadioButton)的选中列 | ![]() |
参数1 | 行号 | |
参数2 | GroupID号,如果只有一个分组,则可忽略 | |
返回值 | 选中的列名 | |
备注 | 没有SetRadioCol函数的,因为直接执行SetCellData置选中列的值为1即可. |
GetDroplistIndex | 取得某下拉List的当前选中行顺序号 | ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
返回值 | 本单元格中的下拉列表的当前选中行, 从0开始计数 | |
备注 | 一般用于非排序的下拉List |
SetDroplistIndex | 选中下拉List中的某行 | ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
参数3 | 本单元格中的下拉列表中的顺序号, 从0开始计数 | |
返回值 | 1 / 0 - 成功 / 失败 | |
备注 | 一般用于非排序的下拉List |
GetEditText | 取得当前输入框中的文字 | ![]() |
参数 | (无) | |
返回值 | 串 | |
备注 | 通常用在事件中,因为你很难把握当前输入框是否正打开着 |
SetEditText | 设置当前输入框中的文字 | ![]() |
参数 | 串 | |
返回值 | (无) | |
备注 | 通常用在事件中,因为你很难把握当前输入框是否正打开着 |
GetCellEditAble | 取得某单元EditAble | ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
返回值 | 1或0, 空串表示失败 |
SetCellEditAble | 单独设置某单元格的EditAble,其等级高于行列的EditAble规定,但低于 Properties 中的EditAble规定. | ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
参数3 | 1/0,或true/false、yes/no | |
返回值 | (无) |
GetCellBackColor | 取得某单元被单独指定的、或根据DisplayMask计算出来的背景色 | ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
返回值 | 颜色串 |
SetCellBackColor | 单独指定某单元的背景色 | ![]() ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
参数3 | 颜色串,空串表示解除背景色 | |
返回值 | (无) |
GetCellTextColor | 取得某单元被单独指定的、或根据DisplayMask计算出来的文字色 | ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
返回值 | 颜色串 |
SetCellTextColor | 单独指定某单元的文字色 | ![]() ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
参数3 | 颜色串,空串表示解除文字色 | |
返回值 | (无) |
GetCellAlign | 取得某单元被单独指定的文字对齐,如果尚未被指定,则返回该列的默认对齐 | ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
返回值 | left / center / right |
SetCellAlign | 单独指定某单元的文字水平对齐 | ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
参数3 | left / center / right | |
返回值 | (无) |
GetCellVAlign | 取得某单元的文字垂直对齐 | ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
返回值 | top / middle / bottom |
SetCellVAlign | 单独指定某单元的文字垂直对齐 | ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
参数3 | top / middle / bottom | |
返回值 | (无) |
GetCellFontIndex | 取得某单元被单独指定的字体、或默认的字体(如果没有被单独指定),也可以写成GetCellFont | ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
返回值 | 序号,即 <Fonts> 下的字体顺序号 |
SetCellFontIndex | 单独指定某单元的字体序号,其等级高于默认字体,也可以写成SetCellFont | ![]() ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
参数3 | 序号,即 <Fonts> 下的字体顺序号,-1表示解除字体 | |
返回值 | (无) |
GetCellHyperLink | 取得某单元是否超链接 | ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
返回值 | 1/0 |
SetCellHyperLink | 单独指定某单元是否为超链接,其等级高于 <Col> 的isHyperLink规定 | ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
参数3 | true/false | |
返回值 | (无) |
GetCellTip | 取得某单元的Tip, Tip的含义为: 鼠标划过时,浮现的黄色文字注释 | ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
返回值 | 串 |
SetCellTip | 单独指定某单元的Tip, Tip的含义为: 鼠标划过时,浮现的黄色文字注释 | ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
参数3 | 串 | |
返回值 | (无) |
GetCellLeftImage GetCellRightImage | 取得某单元的左侧/右侧小图标 | ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
返回值 | 图标的URL |
SetCellLeftImage SetCellRightImage | 单独指定某单元的左侧/右侧小图标,优先级高于displayMask指定的图标 | ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
参数3 | 图标的URL | |
返回值 | (无) |
SetCellProp | 设置某单元格的自定义属性和它的值,每个单元格允许有多个这样的名-值对,其目的是方便程序员的编程设计,Treelist控件不对其语义作任何解析 | ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
参数3 | 属性名,任意串 | |
参数4 | 该属性的值,任意串 | |
返回值 | (无) |
GetCellProp | 取得某单元格的自定义属性的值,每个单元格允许有多个这样的名-值对,其目的是方便程序员的编程设计,Treelist控件不对其语义作任何解析 | ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
参数3 | 属性名,任意串 | |
返回值 | 串,为该属性的值 |
GetCellProps | 取得某单元格的所有自定义属性 | ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
返回值 | 串,以逗号分隔的属性名 |
Merge | 合并指定范围内的单元格 | ![]() |
参数1 | 开始行号 | |
参数2 | 开始列名或列号,建议采用列名 | |
参数3 | 结束行号 | |
参数4 | 结束列名或列号,建议采用列名 | |
返回值 | (无) | |
备注 | 1.参数之间也可以用逗号分隔; 2.以树展现时,合并无效; 3.合并只改变外观,并不影响各自单元格的数据; | |
示例 | AF.func("merge", "0 \r\n id \r\n 10 \r\n city"); |
GetCellStatus | 取得某单元格的状态 | ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
返回值 | A - 普通单元格; H - 被合并; M - 被合并,但位于合并区的左上角,是有效的主单元格; 空串 - 该单元格不存在 | |
备注 | 以树展现时,合并功能无效 |
GetMainCell | 取得某单元格所在的合并区域中的主单元格(即左上角单元格) | ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
返回值 | 诸如"10,3"格式的串,表示“行号,列号”。如果本单元格没有被合并,则返回它自己 | |
备注 | 以树展现时,合并功能无效 |
GetMergedCells | 取得覆盖了某个单元格的合并范围 | ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
返回值 | 诸如"10,3,20,3"格式的串,表示“开始行号,开始列号,结束行号,结束列号” | |
备注 | 以树展现时,合并功能无效 |
CopyCellDataByMerge | 将主单元格的数据复制给被合并的各个单元格, 换句话说:所有被合并的单元格的数据,从各自的主单元格(即左上角单元格)中去复制 | ![]() |
参数1 | 可选,开始行号 | |
参数2 | 可选,开始列名或列号,建议采用列名 | |
参数3 | 可选,结束行号 | |
参数4 | 可选,结束列名或列号,建议采用列名 | |
返回值 | (无) | |
备注 | 该函数一般用于提交前,因为用户如果修改了主单元格,被合并的单元格数据并不会自动跟着变 |
IsTreeNodeRow | 是否树节点行(即树杈行) | ![]() |
参数 | 行号 | |
返回值 | 1/0 - 是/否 |
GetTreeLevel(用途一) | 取得某行在树中的层次级别,从0开始计数 | ![]() |
参数 | 行号 | |
返回值 | 大于等于0的数字 |
GetParentRow | 取得某行的父节点所在行 | ![]() |
参数 | 行号 | |
返回值 | 行号, -1表示失败,原因有:行号无效、已经是顶级、当前不是以树展现 |
GetChildRow | 取得某行的第一个儿子 | ![]() |
参数 | 行号 | |
返回值 | 行号, -1表示失败,原因有:行号无效、已经是末级、当前不是以树展现 |
GetChildRows | 取得某行的所有儿子 (不包括孙子) | ![]() |
参数 | 行号 | |
返回值 | 以逗号分隔的行号, 空串表示该行没有儿子 |
GetNextSibling | 取得某行的下一个或前一个同级(即同辈、兄弟)的行 | ![]() |
参数 | 行号 | |
参数 | 可选, true/false, 表示下一个兄弟/前一个兄弟, 默认是 true | |
返回值 | 行号, -1表示失败,原因有:行号无效、已经是同辈中最后的一个(父亲的小儿子)、当前不是以树展现 |
SetTreeImage | 更改树的图标, 也可写成 SetTreeIcon | ![]() |
参数1 | 行号 | |
参数2 | 图片文件URL,合拢时的图标 | |
参数3 | 可选,图片文件URL,展开时的图标 | |
返回值 | (无) | |
备注 | 仅对单列多层树有效 |
GetTreeImage | 取得树的图标, 也可写成 GetTreeIcon | ![]() |
参数 | 行号 | |
返回值 | URL,如果有不止一个图片(合拢和展开),则以回车分隔 | |
备注 | 仅对单列多层树有效 |
Expand(用法2) | 展开树的前 n 层节点 | ![]() |
参数 | 固定的"Level" + 数字,表示展开前 n 层,例如"Level1"、"Level2" | |
返回值 | (无) | |
示例 | AF.func("expand", "Level1"); //展开第一层 |
Collapse | 收拢树节点 | ![]() |
参数 | 可选,行号,如果为空或为 -1,表示收拢所有节点 | |
返回值 | (无) |
IsExpand | 树节点是否已展开 | ![]() |
参数 | 行号 | |
返回值 | 1/0 - 是/否 |
DeleteChild | 删除某行下的所有子孙行 | ![]() |
参数1 | 行号 | |
参数2 | 可选, 格式为 cacheKey=[true/false], 选项的含义为: cacheKey(或 isCacheKey) - 是否将删除行的Key存入删除缓冲区(用于提交),默认是true | |
返回值 | 被删除的总行数 |
IsLazyloadRow | 某行是否Lazyload行 | ![]() |
参数 | 行号 | |
返回值 | 1/0 - 是/否 | |
备注 | 用于单列多层树、以Lazyload方式加载数据的场景 |
RebuildTreeCombine | 重新整理 TreeCombine 的父节点的 Checkbox | ![]() |
参数 | (无) | |
返回值 | (无) | |
备注 | 用于 TreeCombine 包含了 "auto" 的树 |
RebuildPid | 重新整理 treeformat=byPid 的单列多层树的树杈树叶 | ![]() |
参数 | (无) | |
返回值 | 1/0 - 成功/失败,失败原因为非byPid树 | |
备注 | 用于 pid 和 id 字段被手工修改后、需要重新整理树的排列的情况 |
ClearLazyload | 强制设定某Lazyload行没有子孙 | ![]() |
参数 | 行号 | |
返回值 | (无) | |
备注 | 用于单列多层树、以Lazyload方式加载数据的场景 |
GetCurrentRow (方式一) | 取得当前选中的行 | ![]() |
参数 | (无) | |
返回值 | 行号,空串表示没有当前行;如果有多行,行号之间以逗号分隔 |
GetCurrentRow (方式二) | 取得当前选中的行 | ![]() |
参数 | 顺序号,从0开始,依次取得第几个选中行,直到返回空串 | |
返回值 | 行号,空串表示没有当前行 |
GetCurrentRows | 取得当前选中行的数量 | ![]() |
参数 | (无) | |
返回值 | 数量 |
IsRowSelected | 某行是否被选中 | ![]() |
参数 | 行号 | |
返回值 | 1/0 - 是/否 |
SelectRow | 选定当前行 | ![]() |
参数1 | 行号 | |
参数2 | 可选,true/false - 允许动画方式定位/禁止动画, 默认false | |
返回值 | (无) | |
备注 | 1.在可多选(curselmode = rows)的情况下,可以有多个参数,分别表示其它各个选中行; 2.如果行号无效,原当前行将失去当前标记; 3.本函数同时也让控件获得了焦点 (即SetFocus) |
SelectCell | 选定当前行、并让某个单元格立即进入编辑状态 | ![]() ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
参数3 | 可选,true/false - 允许动画方式定位/禁止动画, 默认false | |
返回值 | (无) | |
备注 | 1.如果行列号无效,原当前行将失去当前标记; 2.本函数同时也让控件获得了焦点 (即SetFocus) |
CloseDropdown | 收起当前正处于下拉状态的树列表 | ![]() |
参数 | (无) | |
返回值 | 已成功收起的行号、列名,以逗号分隔。空串表示当前没有处于下拉状态的树列表. |
CloseEdit | 结束当前单元格的输入状态 | ![]() |
参数 | 可选,true/false - 将输入框中的内容存入单元格/忽略输入框中的内容, 默认true | |
返回值 | 已成功关闭的行号、列名,以逗号分隔。空串表示当前不在输入状态. |
UnlockCurrent | 解除锁定当前行 | ![]() |
参数 | (无) | |
返回值 | (无) |
InsertCol | 插入列 | ![]() ![]() |
参数1 | 插入处列号(从0开始,-1表示从末尾添加) | |
参数2 | 列的参数,例如"name=price;title=项目名称;width=100",列属性可参考《Treelist XML文档规范》之Cols\col; | |
返回值 | 新增列的列号,空串表示失败 |
PasteCurrentRow | 将操作系统剪帖板内容粘帖到当前行 | ![]() |
参数 | (无) | |
返回值 | (无) | |
备注 | 如果有多个当前行(多选),那么所有选中行内容都将被粘帖 |
PasteNewRow | 将操作系统剪帖板内容粘帖到新增行 | ![]() |
参数 | (无) | |
返回值 | (无) |
MoveCol | 移动某列的位置 | ![]() ![]() |
参数1 | 列名或列号,建议采用列名 | |
参数2 | 目标列的列名或列号,建议采用列名 | |
参数3 | 可选, true/false(或1/0、yes/no),分别表示前插/后插,默认前插 | |
返回值 | 新的位置, -1失败 |
MoveRow | 移动某行的位置 | ![]() |
参数1 | 行号 | |
参数2 | 目标行的行号 | |
参数3 | 可选, true/false(或1/0、yes/no),分别表示前插/后插,默认前插 | |
返回值 | 新的位置, -1失败 |
GetNextValidRow | 遍历行,用于需要自动跨越隐藏行、树杈行(多列多层树)、小计行、合计行的情形 | ![]() ![]() |
参数1 | 开始行, 如果是从头遍历,参数应该为空串或“-1” | |
参数2 | 可选, 1 / -1 表示 正向/反向遍历, 默认是1 | |
返回值 | 行号,空串表示遍历完毕 |
GetNextValidCol | 遍历列,用于需要自动跨越多列多层树的首列的情形 | ![]() ![]() |
参数 | 开始列的列名, 如果是从头遍历,参数应该为空串 | |
返回值 | 列名,空串表示遍历完毕 | |
示例 | for(var col=AF.func("GetNextValidCol", ""); col!=""; col=AF.func("GetNextValidCol", col)) { ... } |
GetNextVisibleCol | 遍历可视列,用于需要自动跨越隐藏列、树的首列的情形 | ![]() |
参数 | 开始列的列名, 如果是从头遍历,参数应该为空串 | |
返回值 | 列名,空串表示遍历完毕 | |
示例 | for(var col=AF.func("GetNextVisibleCol", ""); col!=""; col=AF.func("GetNextVisibleCol", col)) { ... } |
IsTotalRow | 是否合计行,通常合计行只有一行,且位于最后 | ![]() |
参数 | 行号(从0开始计数) | |
返回值 | 1 - 是,0 - 否 |
IsSubTotalRow | 是否小计行 | ![]() |
参数 | 行号 | |
返回值 | 1 - 是,0 - 否 |
GetTreeLevel(用途二) | 取得某小计行的分类层次级别,从1开始计数 | ![]() |
参数 | 行号 | |
返回值 | 如果此行不是小计行,返回0,否则返回大于0的数字,其含义是分类的层次,最外层是1 |
GetRowKey | 取得某行的Key(即键值) | ![]() |
参数1 | 行号 | |
参数2 | 可选,复合主键的分隔符,默认逗号(,) | |
参数3 | 可选, 0或1, 1表示取被修改前的原始内容, 默认是0 | |
返回值 | Key串 |
GetRowEditAble | 某行是否能修改 | ![]() |
参数 | 行号 | |
返回值 | 1 - 是,0 - 否 |
GetColEditAble | 某列是否能修改 | ![]() |
参数 | 列名 | |
返回值 | 1 - 是,0 - 否 |
SetRowEditAble | 置某行能否修改 | ![]() |
参数1 | 行号 | |
参数2 | true/false(或1/0、yes/no) | |
返回值 | (无) | |
备注 | 通常是 <Properties> 中的 editable 为 true 的情况下, 本函数才有意义 |
SetColEditAble | 置某列能否修改 | ![]() |
参数1 | 列名 | |
参数2 | true/false(或1/0、yes/no) | |
返回值 | (无) | |
备注 | 通常是 <Properties> 中的 editable 为 true 的情况下, 本函数才有意义 |
GetColName | 取得列名 | ![]() |
参数 | 列号 | |
返回值 | 串, 空串表示列号已经超出范围了 |
GetColTitle | 取得列标题 | ![]() ![]() |
参数 | 列号,或列名 | |
返回值 | 串 |
SetRowDeleteAble | 单独指定某行是否允许被删除(仅限于右键菜单) | ![]() |
参数1 | 行号 | |
参数2 | true/false | |
返回值 | (无) |
GetRowDeleteAble | 取得某行是否允许删除 | ![]() |
参数 | 行号 | |
返回值 | 1 / 0 - 允许/不允许 |
GetRowBackColor | 取得某行被单独指定的背景色 | ![]() |
参数 | 行号 | |
返回值 | 颜色串,空串表示该行尚未被单独指定背景色 |
SetRowBackColor | 单独指定某行的背景色 | ![]() |
参数1 | 行号 | |
参数2 | 颜色串,空串表示解除背景色 | |
返回值 | (无) |
GetRowTextColor | 取得某行被单独指定的文字色 | ![]() |
参数 | 行号 | |
返回值 | 颜色串,空串表示该行尚未被单独指定文字色 |
SetRowTextColor | 单独指定某行的文字色 | ![]() |
参数1 | 行号 | |
参数2 | 颜色串,空串表示解除文字色 | |
返回值 | (无) |
GetRowEnable | 某行是否Enable,disable的行以灰色(或删除线)显示、不可编辑、不触发Clicked和DblClicked事件、不可拖拽 | ![]() ![]() |
参数 | 行号 | |
返回值 | 1/0/空串 - 是/否/无效行号 |
SetRowEnable | 置某行为Enable或disable,disable的行以灰色(或删除线)显示、不可编辑、不触发Clicked事件 | ![]() ![]() |
参数1 | 行号 | |
参数2 | true/false(或1/0、yes/no) - 表示enable/disable | |
返回值 | (无) |
IsRowHide | 或GetRowHide,某行是否隐藏 | ![]() |
参数 | 行号 | |
返回值 | 1/0/空串 - 隐藏/显示/无效行号 |
HideRow | 隐藏某行 | ![]() |
参数1 | 行号 | |
参数2 | true/false - 隐藏/显示 | |
返回值 | (无) |
IsColHide | 或GetColHide,某列是否隐藏,等同GetColProp(colname, "isHide") | ![]() |
参数 | 列名 | |
返回值 | 1/0/空串 - 隐藏/显示/无效列名 |
HideCol | 隐藏某列,等同SetColProp(colname, "isHide", 1/0) | ![]() |
参数1 | 列名 | |
参数2 | true/false - 隐藏/显示 | |
返回值 | (无) |
GetColCheckState | 取得isCheckboxOnly列标题处的CheckBox的状态 | ![]() |
参数 | 列名或列号,建议采用列名 | |
返回值 | 1/0 - 已选中/未选中 |
SetColCheckState | 设置isCheckboxOnly列标题处的CheckBox的状态 | ![]() |
参数1 | 列名或列号,建议采用列名 | |
参数2 | 1/0 - 已选中/未选中 | |
返回值 | (无) | |
备注 | 仅修改选中状态,并不改动数据. 如果要修改整列的数据,请执行 SetColCellData 函数 |
GetColGroup | 取得某列所属的分组(Group) | ![]() |
参数1 | 列名或列号,建议采用列名 | |
参数2 | top/all - 仅返回顶层分组名/返回所有分组名,默认是 top | |
返回值 | 所属Group的名称,如果有多层分组,则以逗号分隔 |
EnsureVisible | 保证让某个单元格或某行在屏幕中可见 | ![]() |
参数1 | 行号 | |
参数2 | 可选, 列名, 如果为空表示仅定位行 | |
参数3 | 可选,true/false - 允许动画方式定位/禁止动画, 默认false | |
返回值 | (无) |
Find | 按表达式查找,并返回首个符合条件的行号 | ![]() |
参数1 | 表达式(可参见“公共内容\表达式”) | |
参数2 | 可选, 格式为startRow=[行号];content=[asData/asDisplay];isReverse=[?], 其含义为: startRow - 开始的行号,默认是0; content - 为 asData 或 asDispplay,默认是asData, 表示搜索的内容是值还是显示的文字(例如下拉的值和显示文字是不一样的); isReverse - 为 true/false, 表示正向搜索 / 逆向搜索,默认是false; | |
返回值 | 行号,-1表示未能找到匹配的行 |
FindAll | 按表达式查找,并返回符合条件的所有行号 | ![]() |
参数1 | 表达式(可参见“公共内容\表达式”) | |
参数2 | 可选, 格式为 content=[asData/asDisplay], 其含义为: content - 为 asData 或 asDispplay,默认是asData, 表示搜索的内容是值还是显示的文字(例如下拉的值和显示文字是不一样的). | |
返回值 | 从小到大排列的行号串,行号之间以逗号分隔,空串表示未能找到匹配的行 | |
示例 | var s=AF.func("findAll", "price<20 and if(len(ProcId)==0, 1, 0)"); |
FindByKey | 按键值搜索 | ![]() |
参数1 | 键值 | |
参数2 | 可选,表示复合主键之间的分隔符,默认是逗号 | |
返回值 | 行号,-1表示未找到 |
Filter | 对已加载的数据进行过滤,只显示满足条件的行 | ![]() ![]() |
参数1 | 表达式(可参见“公共内容\表达式”) | |
参数2 | 可选,格式为 droplistCol=[?]; content=[asData/asDisplay], 其含义为: droplistCol - , 列名,表示仅对该列的下拉TreeList的内容进行过滤; content - 为 asData 或 asDispplay,默认是asData, 表示搜索的内容是值还是显示的文字(例如下拉的值和显示文字是不一样的). | |
返回值 | 1 - 成功,0 - 失败,失败原因通常为表达式书写错误 | |
示例 | AF.func("Filter", "price<20 and if(len(ProcId)==0, 1, 0)"); |
ApplyFilter | 对某个下拉列执行过滤,通常用于EditChanged事件中,对多个关联下拉、下拉过滤采用了表达式的某个下拉强制过滤 | ![]() |
参数1 | 基准的行号,例如在EditChanged事件中,行号就是 p1 参数 | |
参数2 | 下拉列的列名 | |
返回值 | 无 | |
示例 | AF.func("ApplyFilter", p1 + "\r\n cityId"); |
EnableDrag | 使2个Treelist之间能够用鼠标拖拉(Drag)行 | ![]() ![]() |
参数 | 另一个TreeList的句柄(句柄可通过GetHandle()取得) | |
返回值 | 1 - 成功 |
DisableDrag | 终止2个Treelist之间的行拖拉 | ![]() |
参数 | 另一个TreeList的句柄(句柄可通过GetHandle()取得) | |
返回值 | 1 - 成功 |
ScrollToRow | 窗口滚动到某行 | ![]() |
参数 | 行号, 表示滚动到的首个可见行 | |
返回值 | (无) | |
备注 | 请参见函数 GetScrollRow |
GetScrollRow | 取得窗口首个可见行 | ![]() |
参数 | (无) | |
返回值 | 行号 | |
备注 | 请参见函数 ScrollToRow |
GetChangedXML | 调用Validate( )验证,并生成用于提交的XML/JSON大串, XML/JSON格式规范请参见 "XML提交格式规范". | ![]() ![]() |
参数 | 可选, 可以有如下的选项,相互以分号分隔: level - 级别号,可以是0(默认)、1、2、3,其含义分别为: 0 - 级别0,生成当前全部、最新内容(不包括修改前的原始内容); 1 - 级别1,仅生成被修改过的单元格的内容(包括原始内容); 2 - 级别2,在级别1的基础上,增加被修改过单元的整行内容; 3 - 级别3,内容包含所有行、所有列、修改前后的内容; isIgnoreChange - true/false, 仅用于Level=0. true表示不管内容是否被修改过,始终生成XML; false表示除非内容被修改过,否则返回空串. 默认是false; returnFormat - 本函数返回串的格式, xml/json, 默认是xml; startRow - 开始行,默认是0; endRow - 结束行,默认是-1,-1表示最后行; DateFormat - 日期的格式,默认是'%Y.%m.%d',可参见公共内容中now( )函数的参数; DateTimeFormat - 日期时间的格式,默认是'%Y.%m.%d %H:%M:%S',可参见公共内容中now( )函数;的参数 isValidateKey - 是否需要在客户端校验Key(如key重复),默认是True; isExecuteValidations - 是否自动执行XML描述文件的 <Validations> 中的验证,默认是true. isNeedDeleteDetail - 删除行的XML节点, 除了Key以外, 是否还需要包含该行的全部原始内容,默认是False,用于级别1、2、3; includeCol / excludeCol - 仅包含某些列/不包含某些列,二者可选其一,表示列的范围. 列名之间以逗号分隔。默认是空串,表示提交所有列; absIncludeCol - 始终包含某些列,不管其列数据有没有被修改过,并且在删除行的XML节点中也包含这些列的内容. 仅用于Level=1; 备注1:这个“范围”是指提交、验证的范围,以及限定NMD中“M”的识别范围. 备注2:Key以及Key的验证和这个“范围”无关. CompKeySep - 复合主键的分隔符,默认逗号分隔; | |
返回值 | XML/JSON大串 - 成功; 空串 - 内容尚未被修改; 0 - 失败(原因为未通过客户端验证, 如notNull、isUnique) | |
备注 | 1.XML描述文件的 <Properties> 中必须定义Key; 2.如果包含了开始行和结束行参数,生成的XML中将不包括被删除行的信息 | |
示例 | //取得级别为0、复合主键无分隔符的XML提交串,且不校验Key是否重复 AF.func("GetChangedXML", "level=0; CompKeySep=;isValidateKey=false"); //取得级别为1、不校验Key重复、仅包含3个字段的XML提交串 AF.func("GetChangedXML", "level=1; isValidateKey=false; includeCol=id,price,custid"); |
GetCellChanged | 取得某单元格是否被修改过 | ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
返回值 | M - 被修改过,空串:未改过 |
SetCellChanged | 强制更改某单元格的修改状态 | ![]() |
参数1 | 行号 | |
参数2 | 列名或列号,建议采用列名 | |
参数3 | M - 将原始缓存数据修改成和当前不一样的内容; 空串 - 用当前内容替换原始缓存数据, 即清除修改状态 | |
返回值 | (无) |
SetColCellChanged | 强制更改所有行、某列的单元格的修改状态 | ![]() |
参数1 | 列名或列号,建议采用列名 | |
参数2 | M - 将原始缓存数据修改成和当前不一样的内容; 空串 - 用当前内容替换原始缓存数据, 即清除修改状态 | |
返回值 | (无) |
GetDeleteRows | 或 GetDeletedRows,取得被删除的总行数. | ![]() |
参数 | (无) | |
返回值 | 被删除的总行数 | |
备注 | 删除区并不缓存新插入的行. |
GetDeleteKey | 或 GetDeletedKey,取得被删除的行中某行的Key. | ![]() |
参数 | 序号,空串表示取得所有被删行的Key | |
返回值 | Key值,如果是多个行,则以逗号分隔 | |
备注 | 删除区并不缓存新插入的行. |
UnDelete | 恢复被删除的行 | ![]() |
参数 | 以逗号分隔的Key值,空串表示恢复所有被删行 | |
返回值 | 恢复的总行数 | |
备注 | 1.被恢复的行将位于表格末尾处; 2.删除区并不缓存新插入的行. |
EnableUndo | 启用Undo/Redo功能 | ![]() ![]() |
参数 | (无) | |
返回值 | 1/0 - 成功/失败 |
IsUndoEnabled | Undo/Redo功能是否已启用 | ![]() |
参数 | (无) | |
返回值 | 1/0 - 是/否 |
Undo | 执行Undo操作 | ![]() ![]() |
参数 | (无) | |
返回值 | (无) |
Redo | 执行Redo操作 | ![]() ![]() |
参数 | (无) | |
返回值 | (无) |
SaveUndo | 将当前状态保存到 Undo 缓存, | ![]() |
参数 | (无) | |
返回值 | (无) | |
备注 | 凡是涉及到对树列表的更改数据的交互操作, 系统都是自动保存Undo状态的, 但调用API函数更改数据时 (例如 SetCellData) 是不自动保存Undo状态. 本函数通常用于 js 更改数据前, |
UndoAble | 当前是否有Undo可操作 | ![]() ![]() |
参数 | (无) | |
返回值 | 1/0 - 是/否 |
RedoAble | 当前是否有Redo可操作 | ![]() ![]() |
参数 | (无) | |
返回值 | 1/0 - 是/否 |
ResetUndo | 清空Undo缓存,相当于重置Undo | ![]() |
参数 | (无) | |
返回值 | (无) |
GetCustom | 取得当前Treelist的外观状态XML串用于上传,使操作者可定制外观 | ![]() ![]() |
参数 | (无) | |
返回值 | XML串 |
SetCustom | 应用原先已保存(上传)的外观状态XML串, 通常需要在 Build( ) 后立即执行 | ![]() ![]() |
参数 | XML串 | |
返回值 | (无) |
AddMenu | 增加自定义的弹出菜单项 | ![]() ![]() |
参数1 | 串、XML串,或URL,内容的格式规范请参考Treelist的帮助文档“13.自定义菜单” | |
参数2 | 可选,格式为LocateAt=[top/bottom], 表示自定义菜单在弹出时位于顶部还是底部,默认是bottom | |
返回值 | (无) | |
备注 | 只能在OnEvent(id, "MenuBeforePopup", ...)事件中执行。 |
GetExpress | 取得当前表达式(Expresses)节点的完整XML串 | ![]() |
参数 | (无) | |
返回值 | XML串 | |
示例 | var s = AF.func("GetExpress", ""); alert(AF.func("toJson", s)); //可以用全局函数 toJson 转换成 JSON 串 |
ReCalc | 重新计算整表的计算关系,如表达式(Expresses)、合计小计 | ![]() |
参数 | (无) | |
返回值 | (无) |
GetRedrawAble | 是否能够重画 | ![]() |
参数 | (无) | |
返回值 | 1 / 0 - 能 / 不能 |
SetRedrawAble | 设置让Treelist能够重画或不能重画。为了提高性能,消除不必要的重画,在需要连续对Treelist作改动性操作(比如改数据、改属性)前关闭重画,操作完成后再开启重画. | ![]() |
参数 | true/false - 能 / 不能 | |
返回值 | (无) |
PrintPreview | 打印预览 | ![]() |
参数 | (无) | |
返回值 | (无) |
直接打印 | ![]() | |
参数 | 可选,格式为 isOpenSysDialog=[?]; 其含义和用法如下: isOpenSysDialog - true/false - 弹出操作系统的打印对话框/不弹出对话框,默认是true; | |
返回值 | (无) |
OpenDeleteRowsDialog | 打开删除行对话框 | ![]() |
参数 | (无) | |
返回值 | (无) |