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;