CwebView类参考手册
刘学亮 2007-04-20
说明:
在js_WebView函数库中,实现四个类,从而实现了在IE端罗列Lotus视图(文件夹)、虚拟文件夹,SQL数据表(视图)的功能;全面取代了js_GotoView2、DocList函数库提供的功能;
在js_WebView的使用要依赖于以下函数库:js_Stirng、js_GetDbUrl、js_Ajax、js_HtmlSelect
使用实例请参考:http://192.168.5.134/smworkoa/cmisoa.nsf/Test_View?OpenForm
以下对js_WebView中的类进行属性、事件、接口方面的详细说明:
CWebView
属性:
l ViewName [R]视图名称,如果视图不是主库的,包含视图所在数据库
l ClassName [R]类名称,值固定为:CWebView
l Filter [R/W]视图过滤条件,如:房屋号,=,101 && 房屋坐落,instr,五一大街
l Columns [R/W]当前视图显示的各列的名称,以分号隔开各个列名
l CurPage [R/W]当前页
l PageSize [R/W]页面大小(默认每页20条记录, -1表示每页显示无数条记录)
l SelectboxType [R/W]视图列表选择框的类型: 0=无选择框; 1=复选框; 2=单选框
l NoRecordPrompt [R/W]当视图没有数据库时的提示信息,默认为:没有记录
l NoRecord [R]当前视图是否有记录
l Direction [R/W] 记录的显示方式: 1=由前往后排列; 2=由后往前排列
l StartPoint [R/W] 当前显示记录的第一条记录的在视图中序号
l NextPoint [R/W] 下一页的起始点
l CurRecrodID [R] 当前记录的ID(发生OnMouseOver事件后便成为当前记录)
l SearchbarDoc [R/W] 搜索栏所在document(如果没有搜索栏, 则不必设置该属性)
事件:
l OnClick
列表记录被点击时发生该事件,该事件的默认响应操作是调用OpenNotesDoc()函数
打开文档
如果要接办这个事件,请给OnClick赋值,如:
Var oView = New CWebView(“vw_Rooms”, document.frames.ViewFrame)
oView.OnClick = ShowRecordID
//其中:ShowRecordID是自定义的函数, 接收到一个参数:当前记录ID
Function ShowRecordID( sRecordID )
{ alert( sRecordID ); }
l OnInitialize
该事件在列表进行初始化时触发,发生在第一次调用ListRecord时,按照下面的方法接办该事件:
oView.OnInitialize = FunctionName;
FunctionName是自定义的函数名,接收到一个参数:oView; 如果FunctionName不返回true,则ListRecord函数中断执行。
l OnQueryList
每次调用ListRecord时触发该事件,按照如下方法接办该事件:
oView.OnQueryList = FunctionName;
FunctionName是自定义的函数名,接收到一个参数:oView; 如果FunctionName不返回true,则ListRecord函数中断执行。
l OnListed
当ListRecord执行完毕之后,视图列表加载完毕时,触发该事件,按照如下方法接办该事件:
oView.OnQueryList = FunctionName;
FunctionName是自定义的函数名,接收到一个参数:oView
方法:
l ListRecord()
功能:获取列表数据,罗列记录
参数:无
返回:成功返回true;失败返回false
l Refresh()
功能:刷新列表数据
l GetAllRecordIDs (bNoPathInID)
功能:获取当前列表的所有记录的ID
参数:
bNoPathInID : true = 返回的ID不包含路径信息;False = 返回的路径包含路径信息
返回:放回当前列表的所有记录的ID,以分号隔开各个ID
l GetSelectedRecordID (bNoPathInID)
功能:获取当前被选中的的记录的ID
参数:
bNoPathInID : true = 返回的ID不包含路径信息;False = 返回的路径包含路径信息
返回:放回当前列表选中的记录的ID,以分号隔开各个ID
l SelectAllRecord (bSelected)
功能:使当前列表的所有记录被选中或不被选中
参数:
bSelected::true :选中所有记录;False:不选中所有记录
返回:操作成功返回true;否则返回false
l HideRecord (sRecordID, bNoPathInID)
功能:在列表中隐藏指定的记录
参数:
sRecordID:指定要隐藏哪些记录
bNoPathInID: sRecordID中是否包含路径信息,true:不包含;False:包含
返回:操作成功返回true;否则返回false
l GetColumnIndexByName ( sColumnName )
功能:通过列名称来获取列的序号
参数:
sColumnName:要获取序号的列的名称
返回:返回列序号;失败返回-1
l GetColumnNameByIndex( iColIndex)
功能:通过列序号来获取列的名称
参数:
iColIndex:要获取名称的列的序号(第一列的序号是1)
返回:返回列名称;失败返回false;
l GetRecordByIndex ( iIndex )
功能:通过记录的序号获取记录对象
参数:
iIndex:记录在列表中的序号(第一条记录的序号为1)
返回:返回一个CWebRecord对象
l GetRecordByID( sRecordID, bNoPathInID )
功能:通过记录ID来获取记录对象
参数:
sRecordID: 记录ID
bNoPathInID: sRecordID中是否包含路径信息,true:不包含;False:包含
返回:返回一个CWebRecord对象
l GetFirstRecord()
功能:获取列表的第一条记录,返回CWebRecord对象
参数:无
返回:返回一个CWebRecord对象
l GetNextRecord( oCurRecord )
功能:获取列表的下一条记录,返回CWebRecord对象
参数:
oCurRecord: 当前记录对象
返回:返回一个CWebRecord对象
l GetPrevRecord(oCurRecord )
功能:获取列表的上一条记录,返回CWebRecord对象
参数:
oCurRecord: 当前记录对象
返回:返回一个CWebRecord对象
l GetLastRecord()
功能:获取列表的最后一条记录,返回CWebRecord对象
参数:无
返回:返回一个CWebRecord对象
l Search (sFilter, bSearchInCurResult)
功能:搜索列表
参数:
sFilter:搜索过滤条件
bSearchInCurResult:是否在搜索结果中继续搜索
返回:成功返回true;失败返回false
l ClearSearchResult()
功能:清除搜索结果
参数:无
返回:成功返回true;失败返回false
l GetFilterOnSearchbar()
功能:获取在搜索栏上的当前过滤条件
参数:无
返回:返回字符串,一个视图过滤条件
l ShowSearchDialog()
功能:显示高级搜索对话框
参数:无
返回:无
l GotoFirstPage()
功能:视图翻页,第一页
参数:无
返回:成功返回true;失败返回false
l GotoNextPage()
功能:视图翻页,下一页
参数:无
返回:成功返回true;失败返回false
l GotoPrevPage()
功能:视图翻页,前一页
参数:无
返回:成功返回true;失败返回false
l GotoLastPage()
功能:视图翻页,最后页
参数:无
返回:成功返回true;失败返回false
CWebFolder
该类继承CWebView,所以具备CWebView的所有属性,事件,方法。
该类有以下专有的属性:
l FolderID : 虚拟文件夹的ID
l ClassName:值固定为CWebFolder
CWebTable
属性:
l Table [R]SQL数据表(视图)的名称
l ClassName [R]类名称,值固定为:CWebTable
l Primkey [R/W]表的主键名,默认为Code
l ShowPrimKey [R/W]显示列表时是否显示主键
l Columns [R/W]当前视图显示的各列的名称,以分号隔开各个列名
l CurPage [R/W]当前页
l PageSize [R/W]页面大小(默认每页20条记录, -1表示每页显示无数条记录)
l RecordCount [R] Table的所有记录的数目
l PageCount [R] Table所有记录的页数
l SelectboxType [R/W]视图列表选择框的类型: 0=无选择框; 1=复选框; 2=单选框
l NoRecordPrompt [R/W]当视图没有数据库时的提示信息,默认为:没有记录
l NoRecord [R]当前视图是否有记录
l SQL [R/W] 列表显示的查询语句
l CurRecrodID [R] 当前记录的ID(发生OnMouseOver事件后便成为当前记录)
l SearchbarDoc [R/W] 搜索栏所在document(如果没有搜索栏, 则不必设置该属性)
事件:
跟CWebView类的事件相同
方法:
跟CWebView类的接口方法相同
CWebRecord
表示列表中的一条记录
属性:
l ParentView 所在视图对象(一个CWebView或者CWebFolder或者CWebTable对象)
l RecordID 记录ID
方法:
l GetColumnValueByName ( sColumnName )
功能:通过列名获取记录的某列的值
参数:
sColumnName:列名
返回:字符串
l GetColumnValueByIndex ( iIndex )
功能:通过列序号获取记录的某列的值
参数:
iIndex:列序号,第一列的序号为1
返回:字符串
l ReplaceColumnValue ( iColIndex, sColValue)
功能:设置指定列的值
参数:
iColIndex:列序号,第一列的序号为1
sColValue:要设置为的列值
返回:操作成功返回true;否则返回false
l SetSelectedState ( bSelected )
功能:设置本记录的选中状态
参数:
bSelected:true:设为选中状态;false:设为非选中状态
返回:操作成功返回true;否则返回false
l GetSelectedState ()
功能:获取本记录的选中状态
参数:无
返回: true:记录被选中; false:记录没有选中
l GetIndex()
功能:获取本记录在列表中的序号
参数:无
返回: 整形数据
l GetColumnIndexByName ( sColumnName )
功能:通过列名称来获取列的序号
参数:
sColumnName:要获取序号的列的名称
返回:返回列序号;失败返回-1
l GetColumnNameByIndex( iColIndex)
功能:通过列序号来获取列的名称
参数:
iColIndex:要获取名称的列的序号(第一列的序号是1)
返回:返回列名称;失败返回false;