CwebView類參考手冊(cè)
劉學(xué)亮 2007-04-20
說(shuō)明：
在js_WebView函數(shù)庫(kù)中，實(shí)現(xiàn)四個(gè)類，從而實(shí)現(xiàn)了在IE端羅列Lotus視圖（文件夾）、虛擬文件夾，SQL數(shù)據(jù)表（視圖）的功能；全面取代了js_GotoView2、DocList函數(shù)庫(kù)提供的功能；
在js_WebView的使用要依賴于以下函數(shù)庫(kù)：js_Stirng、js_GetDbUrl、js_Ajax、js_HtmlSelect
使用實(shí)例請(qǐng)參考：http://192.168.5.134/smworkoa/cmisoa.nsf/Test_View?OpenForm
以下對(duì)js_WebView中的類進(jìn)行屬性、事件、接口方面的詳細(xì)說(shuō)明：
CWebView
屬性：
l ViewName [R]視圖名稱，如果視圖不是主庫(kù)的，包含視圖所在數(shù)據(jù)庫(kù)
l ClassName [R]類名稱，值固定為：CWebView
l Filter [R/W]視圖過(guò)濾條件，如：房屋號(hào),=,101 && 房屋坐落,instr,五一大街
l Columns [R/W]當(dāng)前視圖顯示的各列的名稱，以分號(hào)隔開(kāi)各個(gè)列名
l CurPage [R/W]當(dāng)前頁(yè)
l PageSize [R/W]頁(yè)面大小（默認(rèn)每頁(yè)20條記錄， -1表示每頁(yè)顯示無(wú)數(shù)條記錄）
l SelectboxType [R/W]視圖列表選擇框的類型: 0=無(wú)選擇框; 1=復(fù)選框; 2=單選框
l NoRecordPrompt [R/W]當(dāng)視圖沒(méi)有數(shù)據(jù)庫(kù)時(shí)的提示信息，默認(rèn)為：沒(méi)有記錄
l NoRecord [R]當(dāng)前視圖是否有記錄
l Direction [R/W] 記錄的顯示方式： 1=由前往后排列; 2=由后往前排列
l StartPoint [R/W] 當(dāng)前顯示記錄的第一條記錄的在視圖中序號(hào)
l NextPoint [R/W] 下一頁(yè)的起始點(diǎn)
l CurRecrodID [R] 當(dāng)前記錄的ID(發(fā)生OnMouseOver事件后便成為當(dāng)前記錄)
l SearchbarDoc [R/W] 搜索欄所在document(如果沒(méi)有搜索欄, 則不必設(shè)置該屬性)
事件：
l OnClick
列表記錄被點(diǎn)擊時(shí)發(fā)生該事件，該事件的默認(rèn)響應(yīng)操作是調(diào)用OpenNotesDoc（）函數(shù)
打開(kāi)文檔
如果要接辦這個(gè)事件，請(qǐng)給OnClick賦值，如：
Var oView = New CWebView(“vw_Rooms”, document.frames.ViewFrame)
oView.OnClick = ShowRecordID
//其中：ShowRecordID是自定義的函數(shù), 接收到一個(gè)參數(shù)：當(dāng)前記錄ID
Function ShowRecordID( sRecordID )
{ alert( sRecordID ); }
l OnInitialize
該事件在列表進(jìn)行初始化時(shí)觸發(fā)，發(fā)生在第一次調(diào)用ListRecord時(shí)，按照下面的方法接辦該事件：
oView.OnInitialize = FunctionName;
FunctionName是自定義的函數(shù)名，接收到一個(gè)參數(shù)：oView； 如果FunctionName不返回true，則ListRecord函數(shù)中斷執(zhí)行。
l OnQueryList
每次調(diào)用ListRecord時(shí)觸發(fā)該事件，按照如下方法接辦該事件：
oView.OnQueryList = FunctionName;
FunctionName是自定義的函數(shù)名，接收到一個(gè)參數(shù)：oView； 如果FunctionName不返回true，則ListRecord函數(shù)中斷執(zhí)行。
l OnListed
當(dāng)ListRecord執(zhí)行完畢之后，視圖列表加載完畢時(shí)，觸發(fā)該事件，按照如下方法接辦該事件：
oView.OnQueryList = FunctionName;
FunctionName是自定義的函數(shù)名，接收到一個(gè)參數(shù)：oView
方法：
l ListRecord（）
功能：獲取列表數(shù)據(jù)，羅列記錄
參數(shù)：無(wú)
返回：成功返回true；失敗返回false
l Refresh（）
功能：刷新列表數(shù)據(jù)
l GetAllRecordIDs (bNoPathInID)
功能：獲取當(dāng)前列表的所有記錄的ID
參數(shù)：
bNoPathInID : true = 返回的ID不包含路徑信息；False = 返回的路徑包含路徑信息
返回：放回當(dāng)前列表的所有記錄的ID，以分號(hào)隔開(kāi)各個(gè)ID
l GetSelectedRecordID (bNoPathInID)
功能：獲取當(dāng)前被選中的的記錄的ID
參數(shù)：
bNoPathInID : true = 返回的ID不包含路徑信息；False = 返回的路徑包含路徑信息
返回：放回當(dāng)前列表選中的記錄的ID，以分號(hào)隔開(kāi)各個(gè)ID
l SelectAllRecord (bSelected)
功能：使當(dāng)前列表的所有記錄被選中或不被選中
參數(shù)：
bSelected:：true ：選中所有記錄；False：不選中所有記錄
返回：操作成功返回true；否則返回false
l HideRecord (sRecordID, bNoPathInID)
功能：在列表中隱藏指定的記錄
參數(shù)：
sRecordID：指定要隱藏哪些記錄
bNoPathInID： sRecordID中是否包含路徑信息，true：不包含；False：包含
返回：操作成功返回true；否則返回false
l GetColumnIndexByName ( sColumnName )
功能：通過(guò)列名稱來(lái)獲取列的序號(hào)
參數(shù)：
sColumnName：要獲取序號(hào)的列的名稱
返回：返回列序號(hào)；失敗返回－1
l GetColumnNameByIndex（ iColIndex）
功能：通過(guò)列序號(hào)來(lái)獲取列的名稱
參數(shù)：
iColIndex：要獲取名稱的列的序號(hào)(第一列的序號(hào)是1)
返回：返回列名稱；失敗返回false；
l GetRecordByIndex ( iIndex )
功能：通過(guò)記錄的序號(hào)獲取記錄對(duì)象
參數(shù)：
iIndex：記錄在列表中的序號(hào)（第一條記錄的序號(hào)為1）
返回：返回一個(gè)CWebRecord對(duì)象
l GetRecordByID( sRecordID, bNoPathInID )
功能：通過(guò)記錄ID來(lái)獲取記錄對(duì)象
參數(shù)：
sRecordID： 記錄ID
bNoPathInID： sRecordID中是否包含路徑信息，true：不包含；False：包含
返回：返回一個(gè)CWebRecord對(duì)象
l GetFirstRecord()
功能：獲取列表的第一條記錄，返回CWebRecord對(duì)象
參數(shù)：無(wú)
返回：返回一個(gè)CWebRecord對(duì)象
l GetNextRecord( oCurRecord )
功能：獲取列表的下一條記錄，返回CWebRecord對(duì)象
參數(shù)：
oCurRecord： 當(dāng)前記錄對(duì)象
返回：返回一個(gè)CWebRecord對(duì)象
l GetPrevRecord(oCurRecord )
功能：獲取列表的上一條記錄，返回CWebRecord對(duì)象
參數(shù)：
oCurRecord： 當(dāng)前記錄對(duì)象
返回：返回一個(gè)CWebRecord對(duì)象
l GetLastRecord()
功能：獲取列表的最后一條記錄，返回CWebRecord對(duì)象
參數(shù)：無(wú)
返回：返回一個(gè)CWebRecord對(duì)象
l Search (sFilter, bSearchInCurResult)
功能：搜索列表
參數(shù)：
sFilter：搜索過(guò)濾條件
bSearchInCurResult：是否在搜索結(jié)果中繼續(xù)搜索
返回：成功返回true；失敗返回false
l ClearSearchResult()
功能：清除搜索結(jié)果
參數(shù)：無(wú)
返回：成功返回true；失敗返回false
l GetFilterOnSearchbar()
功能：獲取在搜索欄上的當(dāng)前過(guò)濾條件
參數(shù)：無(wú)
返回：返回字符串，一個(gè)視圖過(guò)濾條件
l ShowSearchDialog()
功能：顯示高級(jí)搜索對(duì)話框
參數(shù)：無(wú)
返回：無(wú)
l GotoFirstPage()
功能：視圖翻頁(yè)，第一頁(yè)
參數(shù)：無(wú)
返回：成功返回true；失敗返回false
l GotoNextPage()
功能：視圖翻頁(yè)，下一頁(yè)
參數(shù)：無(wú)
返回：成功返回true；失敗返回false
l GotoPrevPage()
功能：視圖翻頁(yè)，前一頁(yè)
參數(shù)：無(wú)
返回：成功返回true；失敗返回false
l GotoLastPage()
功能：視圖翻頁(yè)，最后頁(yè)
參數(shù)：無(wú)
返回：成功返回true；失敗返回false
CWebFolder
該類繼承CWebView，所以具備CWebView的所有屬性，事件，方法。
該類有以下專有的屬性：
l FolderID ： 虛擬文件夾的ID
l ClassName：值固定為CWebFolder
CWebTable
屬性：
l Table [R]SQL數(shù)據(jù)表（視圖）的名稱
l ClassName [R]類名稱，值固定為：CWebTable
l Primkey [R/W]表的主鍵名，默認(rèn)為Code
l ShowPrimKey [R/W]顯示列表時(shí)是否顯示主鍵
l Columns [R/W]當(dāng)前視圖顯示的各列的名稱，以分號(hào)隔開(kāi)各個(gè)列名
l CurPage [R/W]當(dāng)前頁(yè)
l PageSize [R/W]頁(yè)面大小（默認(rèn)每頁(yè)20條記錄， -1表示每頁(yè)顯示無(wú)數(shù)條記錄）
l RecordCount [R] Table的所有記錄的數(shù)目
l PageCount [R] Table所有記錄的頁(yè)數(shù)
l SelectboxType [R/W]視圖列表選擇框的類型: 0=無(wú)選擇框; 1=復(fù)選框; 2=單選框
l NoRecordPrompt [R/W]當(dāng)視圖沒(méi)有數(shù)據(jù)庫(kù)時(shí)的提示信息，默認(rèn)為：沒(méi)有記錄
l NoRecord [R]當(dāng)前視圖是否有記錄
l SQL [R/W] 列表顯示的查詢語(yǔ)句
l CurRecrodID [R] 當(dāng)前記錄的ID(發(fā)生OnMouseOver事件后便成為當(dāng)前記錄)
l SearchbarDoc [R/W] 搜索欄所在document(如果沒(méi)有搜索欄, 則不必設(shè)置該屬性)
事件：
跟CWebView類的事件相同
方法：
跟CWebView類的接口方法相同
CWebRecord
表示列表中的一條記錄
屬性：
l ParentView 所在視圖對(duì)象（一個(gè)CWebView或者CWebFolder或者CWebTable對(duì)象）
l RecordID 記錄ID
方法：
l GetColumnValueByName ( sColumnName )
功能：通過(guò)列名獲取記錄的某列的值
參數(shù)：
sColumnName：列名
返回：字符串
l GetColumnValueByIndex ( iIndex )
功能：通過(guò)列序號(hào)獲取記錄的某列的值
參數(shù)：
iIndex：列序號(hào)，第一列的序號(hào)為1
返回：字符串
l ReplaceColumnValue ( iColIndex, sColValue)
功能：設(shè)置指定列的值
參數(shù)：
iColIndex：列序號(hào)，第一列的序號(hào)為1
sColValue：要設(shè)置為的列值
返回：操作成功返回true；否則返回false
l SetSelectedState ( bSelected )
功能：設(shè)置本記錄的選中狀態(tài)
參數(shù)：
bSelected：true：設(shè)為選中狀態(tài)；false：設(shè)為非選中狀態(tài)
返回：操作成功返回true；否則返回false
l GetSelectedState ()
功能：獲取本記錄的選中狀態(tài)
參數(shù)：無(wú)
返回： true：記錄被選中； false：記錄沒(méi)有選中
l GetIndex（）
功能：獲取本記錄在列表中的序號(hào)
參數(shù)：無(wú)
返回： 整形數(shù)據(jù)
l GetColumnIndexByName ( sColumnName )
功能：通過(guò)列名稱來(lái)獲取列的序號(hào)
參數(shù)：
sColumnName：要獲取序號(hào)的列的名稱
返回：返回列序號(hào)；失敗返回－1
l GetColumnNameByIndex（ iColIndex）
功能：通過(guò)列序號(hào)來(lái)獲取列的名稱
參數(shù)：
iColIndex：要獲取名稱的列的序號(hào)(第一列的序號(hào)是1)
返回：返回列名稱；失敗返回false；