金蝶K3 BOS插件开发手册.pdf

1、K/3 BOS插件开发手册 K/3 BOS 插件开发手册 （版本：V12.2） 金蝶软件（中国）有限公司 K/3产品部 K/3 BOS开发部 目录 概述1 COM.1 K3ClassEvents的对象模型 1 使用说明 1 K3ClassEvents的对象 2 ListEvents对象参考 . 3 DataSrv 属性 3 EnableListFillRowEvents 属性. 4 K3Lib 属性. 5 List 属性 6 ListEntrySort 属性 6 ListFilterString 属性 . 7 ListHeadSort 属性 7 MenuBar 属性. 7 MultiCheck

2、Mgr 属性. 8 RsId 属性 8 ShowMode 属性 . 9 ShowMsg 属性 9 DeleteBill 函数 9 GetDataFldByKey 函数 10 GetDataFld 函数. 11 GetCurrentSelRowInfo 函数 12 GetSelectedBillInfo 函数 . 13 LoadSelectedBill 函数 14 RefreshList函数 . 14 SenderMessage 函数 . 15 UpdateNormalFld 函数 16 UpdateNormalFldByKey 函数 16 RefreshMenu 函数 17 AfterBatc

3、hMultiCheck 事件 17 AfterBusinessCheck 事件 18 AfterBusinessCheckEx 事件 18 AfterCopyBillCreateData 事件. 19 AfterDeleteBill 事件 19 AfterMergeCopyBill事件 20 AfterMultiCheck 事件. 20 AfterMultiCheckEx 事件. 20 AfterSelList 事件. 21 AfterUnBusinessCheck 事件 21 AfterUnBusinessCheckEx 事件 . 22 AfterUnMultiCheck 事件 22 K/3

4、 BOS插件开发手册 AfterUnMultiCheckEx 事件 23 BeforeMultiCheck 事件 23 BeforeMultiCheckEx 事件 24 BeforePrintBill 事件 24 BeforeSenderMessage 事件 25 BeforRefreshToolBar 事件. 25 BusinessCheck 事件. 26 BusinessCheckEx 事件. 26 FinishMultiCheck 事件 . 26 FinishMultiCheckEx 事件 . 27 ListFillRow 事件 27 ListRowSelected 事件 29 Menu

5、BarClick 事件. 30 MenuBarInitialize 事件 30 MultiCheck 事件 . 30 MultiCheckEx 事件 . 31 PrintSuccessful事件 . 32 StartMultiCheck 事件 . 32 StartMultiCheckEx 事件. 33 UnBusinessCheck 事件 33 UnBusinessCheckEx 事件 33 UnMultiCheck 事件. 34 UnMultiCheckEx 事件 35 ReMultiCheck 事件. 35 ReMultiCheckEx 事件. 35 ReUnMultiCheck 事件 3

6、6 ReUnMultiCheckEx 事件 36 BaseClassEvent 对象参考 38 BrowseCtl 属性. 38 DataSrv 属性 38 EnableListFillRowEvents 属性. 38 InsertNewRowAndFillOption 属性. 40 K3Lib 属性. 40 ListActiveBar 属性 41 ListEntrySort 属性 41 ListFilterString 属性 . 41 ListHeadSort 属性 42 MenuBar 属性. 42 RsClassGroup 属性. 43 RsId 属性 43 GetActiveCtl 函

7、数 . 43 GetSelectedClassID 函数 44 GetSelectedClassType 函数 45 GetSelectedItemID 函数 . 45 iii K/3 BOS插件开发手册 GetSelectedItems 函数 46 IsSearchState 函数 47 PitchItemByID 函数 . 47 SelectClassGroupByID 函数 48 SenderMessage 函数 . 49 SetStatus函数. 50 RefreshClassGroups 方法 50 RefreshListByClassGroupID 方法 . 51 RefreshS

8、electedClassGroup 方法. 51 RefreshSelectedClassGroupList 方法 . 52 AfterGetData 事件 52 BeforePrintBill 事件 53 BeforeSenderMessage 事件 53 ClassGroupSelected 事件 54 DeleteBillSucessful事件. 54 ListFillRow 事件 55 ListRowSelected 事件 57 MenuBarClick 事件. 57 MenuBarInitialize 事件 57 RefreshList 事件 . 58 BillEvent对象参考 5

9、9 AccessoryTypeID 属性. 59 BillCtl 属性. 59 BillEntrys 属性 59 BillHeads 属性 60 BillHeight 属性60 BillName 属性 . 60 BillStatus 属性 61 BillWidth 属性. 61 CancelPrintControl属性 . 62 ClassType 属性 . 62 ClassTypeEntry 属性 62 ClassTypeKey 属性. 63 Data 属性 63 DataSrv 属性 63 EntryPrimaryKey 属性 64 FID 属性 64 InsertNewRowAndFil

10、lOption 属性. 65 IsDoAction 属性 . 65 IsDoActionData 属性 . 65 K3Lib 属性. 66 LayerCount 属性. 66 LayerNames 属性 66 MenuBar 属性. 67 iv K/3 BOS插件开发手册 MultiCheckMgr 属性. 67 ObjectID 属性. 68 ObjectType 属性. 68 OriginalFieldValue属性 68 PrimaryKey 属性. 69 ReSaveSuccess 属性 69 rsBillID 属性 69 ShowType 属性. 70 Ta b l e I n f

11、o 属性 70 TableName 属性. 70 Ta s k I D 属性 71 ShowMsg 属性71 BatchToDoActions函数 71 DeleteEntryData 函数 72 GetActiveCtl 函数 . 73 GetActiveField 函数 74 GetCommonControl函数 . 74 GetDataFld 函数. 75 GetDataFldbyKey 函数 76 GetFieldInfoByKey 函数 77 GetDynamicCtlByKey函数 . 78 GetFieldValue 函数. 78 GetToolIndex 函数 . 79 Get

12、Variable函数 . 80 InsertNewRowAndFill 函数 . 81 IsChange 函数81 IsFileNeedFilter 函数 . 82 LockBill 函数 . 83 RefreshBill 函数 83 SenderMessage 函数 . 83 SetDecimal 函数. 84 SetFieldSumValue函数 85 SetFieldValue 函数 . 85 SetSumDecimal 函数 . 86 SetText 函数 . 87 SetTypeFloatMax 函数. 88 SetTypeFloatMin 函数 88 ShowHideField 函

13、数. 89 ShowHideGrid 函数 89 Sum 函数 90 UpdateLookFld 函数 90 UpdateNormalFld 函数 91 DoAction 方法. 91 IsDoActionByKey 方法. 92 v K/3 BOS插件开发手册 LockCell 方法 92 RemoveRow 方法 93 SaveBill 方法. 93 SetActiveTab方法 . 94 SetBillFormCaption 方法 . 94 SetCaption 方法 . 95 SetGridMaxRows方法 95 SetStatus 方法96 SetActiveCell 方法 96

14、SetBillWindowState方法. 97 SetRowsPerRequest 方法 . 97 SetStateStampPicture方法 98 SetStatusBarInfo方法 98 SetVariable函数 99 SizeBillControl方法 100 AddNewRow 事件 100 AfterBusinessCheck 事件 100 AfterBusinessCheckEx 事件 101 AfterCopyBill 事件 101 AfterDeleteRow 事件 . 101 AfterDoAction 事件 102 AfterFillRow 事件 103 After

15、FirstNewBill 事件 103 AfterInputBillSetSumData 事件 103 AfterLoadBill 事件 104 AfterLoadBillSetSumData 事件. 104 AfterLoadDynamicCtl事件. 104 AfterMergeCopyBill 事件 . 105 AfterMultiCheck 事件. 105 AfterMultiCheckEx 事件. 106 AfterNewBill 事件 . 106 AfterNewEmptyData 事件. 106 AfterSave 事件 . 107 AfterSelBill 事件 107 Aft

16、erSelBillBeforeFillData 事件 . 107 AfterStockQuery 事件. 107 AfterUnBusinessCheck 事件 108 AfterUnBusinessCheckEx 事件 . 108 AfterUnMultiCheck 事件 108 AfterUnMultiCheckEx 事件 109 BeforeDeleteRow事件 . 109 BeforeDoAction 事件 . 110 BeforeLoadBill 事件 111 BeforeMultiCheck 事件 111 vi K/3 BOS插件开发手册 BeforeMultiCheckEx 事

17、件 112 BeforePrintBill 事件 112 BeforeSave 事件. 113 BeforeSelBills 事件. 113 BeforeSelBillShowFilter 事件. 114 BeforeSenderMessage 事件 115 BeforeSetMutilSelData 事件. 115 BeforeSetMutilSelData2事件 116 BeforeVerify 事件 . 116 BeforeWindowExit事件 116 BeforLoadBillFillData 事件. 117 BeginEdit 事件 117 BusinessCheck 事件. 1

18、17 BusinessCheckEx 事件. 118 Change 事件 . 118 CommandClick 事件 119 EntryFieldChanged事件. 119 FinishMultiCheck 事件 . 119 FinishMultiCheckEx 事件 . 120 GetFocus 事件 120 HeadCtlClick 事件. 121 LostFocus 事件 . 121 MenuBarClick 事件. 122 MenuBarInitialize 事件 122 MultiCheck 事件 . 122 MultiCheckEx 事件 . 123 ReMultiCheck 事

19、件. 124 ReMultiCheckEx 事件. 124 ReUnMultiCheck 事件 125 ReUnMultiCheckEx 事件 125 SaveBillFailed 事件. 125 SaveBillSuccess事件 126 SSTabClick 事件. 126 StartMultiCheck 事件 . 126 StartMultiCheckEx 事件. 127 UnBusinessCheck 事件 128 UnBusinessCheckEx 事件 128 UnMultiCheck 事件. 128 UnMultiCheckEx 事件 129 Verify 事件 130 K3Li

20、b对象参考. 131 Account 属性 131 Net 属性 132 User 属性 132 vii K/3 BOS插件开发手册 BatchPushOldBills 函数 . 132 CreateK3Object 函数 . 136 GetData 函数 137 GetK3Language 函数. 138 LoadKDString 函数. 139 UpdateData 方法 141 GetStockQty 函数. 141 LookUpClass函数 . 142 LoadBill 方法. 144 LoadList方法. 144 LoadOldList方法 . 145 Account对象参考.

21、147 AccountID 属性 147 AccountName 属性 147 SetupType 属性 147 Net对象参考 149 BeginMutex 函数 149 CommitMutex 函数 149 QueryFunc 函数 . 150 QuerySubSys 函数 . 150 User对象参考. 151 UserID 属性 151 UserName 属性 151 MenuBar对象参考 . 152 MenuBar 对象结构图. 152 ActiveBand 属性. 153 BOSBands 属性 153 BOSTools 属性 154 Refresh 方法 . 154 BOSBa

22、nds对象参考. 155 Count 属性 155 Item 属性 155 Add 函数 . 155 Remove 方法 156 RemoveAll 方法 156 BOSBand对象参考 157 BandName 属性 . 157 BandType 属性 . 157 BOSTools 属性 157 Caption 属性 . 157 CurrentTool 属性 158 DockingArea 属性 158 DockingOffset 属性 158 DockLine 属性 159 viii K/3 BOS插件开发手册 Flags 属性 . 159 Visible 属性 . 159 Wrappab

23、le 属性 160 Refresh 方法 . 160 BOSTools对象参考 161 Count 属性 161 Item 属性 161 Add 函数 . 161 GetFreeToolID 函数 162 InsertAfter 方法 162 InsertBefore 方法. 163 Remove 方法 163 RemoveAll 方法 164 BOSTool对象参考 165 Alignment 属性. 165 BeginGroup属性. 165 Caption 属性 . 165 CaptionPosition 属性 166 Checked 属性 166 Default 属性 166 Desc

24、ription 属性. 167 Enabled 属性 167 ShortcutKey 属性 . 167 Style 属性 170 SubBand 属性. 170 Ta g 属性 170 ToolID 属性. 170 ToolName 属性 . 171 ToolPicture 属性 . 171 TooltipText 属性 . 171 Visible 属性 . 171 PasteToolFace 方法 171 SetPicture 方法. 172 BillHeadsBillHeadBillEntrysBillEntryBOSFieldsBOSField对象参考 174 MenuBar 对象结构图

25、. 174 BillHeads对象参考. 175 Count 属性 175 Item 属性 176 BillHead对象参考 177 BOSFields 属性. 177 BillEntrys对象参考. 178 Count 属性 178 Item 属性 179 BillEntry对象参考 180 ix K/3 BOS插件开发手册 BOSFields 属性. 180 EntryHeight 属性 180 EntryIndex 属性 . 180 EntryLeft 属性 180 EntryTop 属性. 180 EntryType 属性. 181 EntryWidth 属性. 181 KeyFiel

26、d 属性 181 Layer 属性. 181 MaxRows 属性 182 TableName 属性. 182 Visible 属性 . 182 AddRow 方法 182 RemoveRow 方法 183 BOSFields对象参考 . 184 Count 属性 184 Item 属性 184 BOSField对象参考 . 185 Caption 属性 . 185 FieldHeight 属性. 185 FieldLeft 属性 . 185 FieldLock 属性 185 FieldName 属性 186 FieldTop 属性 186 FieldWidth 属性 186 Filter 属

27、性 186 FKey 属性 186 FontBold 属性 . 187 FontItalic 属性 187 FontName 属性 187 FontSize 属性 187 FrameBorder 属性 188 FrameBorderColor 属性. 188 LabelColor 属性 188 LabelWidth 属性. 188 Layer 属性. 188 MustInput 属性. 189 NeedSave 属性. 189 Note 属性 189 Number 属性 189 Page 属性 189 Row 属性. 190 TableName 属性. 190 Text 属性. 190 x K

28、/3 BOS插件开发手册 TextColor 属性 190 Value 属性. 190 Visible 属性 . 191 SetFieldSumValue方法 191 .Net.192 基础配置 . 192 开发环境 192 使用说明 192 引用 192 插件跟踪 192 K3ClassEvents的对象模型 193 K3ClassEvents的对象 193 ListEvents对象参考 . 194 事件声明 194 AfterCopyBillCreateData 事件. 195 OnBarInitialize 事件. 195 AfterShowBill 事件. 195 OnBarItemC

29、lick 事件. 196 ShowBill函数 . 196 AspxGetSelectList 函数 197 AddBarItem函数 . 197 AddBarItemLink函数 198 SetBarItemProperty函数 199 AddBarItemLink函数 199 RemoveBarItem函数 200 RemoveBarItemLink函数 200 BillName 属性 . 201 ClassType 属性 . 201 ClassTypeEntry 属性 201 ClassTypeKey 属性. 202 PrimaryKey 属性. 202 EntryPrimaryKey

30、属性 203 Ta b l e I n f o 属性 203 TableName 属性. 203 BillEvent对象参考 205 事件声明 205 OnBarInitialize 事件. 206 OnBarItemClick 事件. 207 AfterNewBill 事件 . 207 BeforLoadBillFillData 事件. 207 AfterLoadBill 事件. 207 AfterShowBill 事件 . 208 AfterConfirm 事件. 208 AfterF7Select 事件. 208 xi K/3 BOS插件开发手册 Change 事件 . 209 Befo

31、reSave 事件. 209 AfterSave 事件 . 209 AddBarItem函数 . 210 AddBarItemLink函数 211 GetBarItemProperty函数 211 SetBarItemProperty函数 212 AddBarItemLink函数 212 RemoveBarItem函数 213 RemoveBarItemLink函数 213 Alter函数 . 214 Confirm函数 . 214 GetFieldValue函数 215 GetRequest函数 . 216 LockBillEntry 函数 216 PUBLIC FUNCTION LOCKB

32、ILLENTRY(BYV AL LPAGE AS LONG, _216 LockCell函数 . 217 LockWebTabItem函数 218 SaveBill函数 . 218 SetFieldValue函数 219 ShowBill函数 . 220 ShowF7Select函数 221 BillName 属性 . 221 ClassType 属性 . 222 ClassTypeEntry 属性 222 ClassTypeKey 属性. 223 PrimaryKey 属性. 223 EntryPrimaryKey 属性 223 Ta b l e I n f o 属性 224 TableNa

33、me 属性. 224 CurBillID 属性 224 BillHeads对象参考. 226 Count 属性 226 Item 属性 226 BillHead对象参考 227 BOSFields 属性. 227 BillEntrys对象参考. 228 Count 属性 228 Item 属性 228 BillEntry对象参考 229 BOSFields 属性. 229 EntryHeight 属性 229 EntryIndex 属性 . 229 EntryLeft 属性 229 xii K/3 BOS插件开发手册 EntryTop 属性. 229 EntryType 属性. 230 Ent

34、ryWidth 属性. 230 KeyField 属性 230 Layer 属性. 230 TableName 属性. 231 Visible 属性 . 231 BOSFields对象参考 . 232 Count 属性 232 Item 属性 232 BOSField对象参考 . 233 Caption 属性 . 233 FieldHeight 属性. 233 FieldLeft 属性 . 233 FieldLock 属性 233 FieldName 属性 234 FieldTop 属性 234 FieldWidth 属性 234 Filter 属性 234 FKey 属性 234 FontB

35、old 属性 . 235 FontItalic 属性 235 FontName 属性 235 FontSize 属性 235 FrameBorder 属性 236 FrameBorderColor 属性. 236 LabelColor 属性 236 LabelWidth 属性. 236 Layer 属性. 236 MustInput 属性. 237 NeedSave 属性. 237 Note 属性 237 Number 属性 237 Page 属性 237 Row 属性. 238 TableName 属性. 238 Text 属性. 238 TextColor 属性 238 Value 属性.

36、 238 Visible 属性 . 239 用户场景240 需求 . 240 总体需求. 240 需求分解. 241 xiii K/3 BOS插件开发手册 xiv 详细需求. 242 单据信息 242 单据流程 244 多级审核 245 凭证功能 245 设计和实现 246 单据数据结构设计 . 246 单据头 246 单据体 248 字段的过滤条件 . 251 BOS IDE 中设置过滤条件 251 通过 SQL 更新字段的过滤条件 . 253 Action设置 . 254 自动生成 Action. 254 手动添加 Action. 257 单据流程. 259 【销售订单】下推生成【产品入库

37、通知单】 . 259 练习一下 263 多级审核. 265 多级审核设置 265 凭证功能. 266 设置凭证数据来源 266 操作管理 267 插件开发. 270 部署 . 271 发布到主控台. 271 制作部署文件. 273 K/3 BOS插件开发手册 概述 为了实现客户个性化的需求和保持 K/3 BOS架构的开放性，K/3 BOS提供了插件编程，有效的扩展了 K/3 BOS平台，K/3 BOS插件编程是通过 K3ClassEvents对象代理实现的。 K/3 BOS 提供了基于 COM 和.Net两套插件模型。 COM K/3 BOS 提供 ListEvents、BaseClassEv

38、ent、BillEvent三个重要的客户端接口对象及其他的辅助 对象。 K3ClassEvents 的对象模型 使用说明 关于 Kingdee Foundation Objects 1.0 对象 本文中所有涉及到的 KFO 对象，如 KFO.Dictionary 、KFO.Vector ，他们的结构、使用方法、 描述等详细内容，请参考KFO组件使用参考 。 关于 Microsoft ActiveX Data Objects Library 对象 本文中所有涉及到的 ADODB 对象， 如 ADODB.Recordset ， 版本必需不低于 2.6； 他们的结构、 使用方法、描述等详细内容，请参

39、考 http:/ 相关内容。 第 1 页 K/3 BOS插件开发手册 K3ClassEvents的对象 上面的对象结构图囊括了 K3ClassEvents组件中所使用到的所有对象。需要注意的是： 以下对象： K3Lib （Net、User、Account） MenuBar BOSBand（以及它的集合对象 BOSBands） BOSTool（以及它的集合对象 BOSTools） BillHead（以及它的集合对象 BillHeads） BillEntry（以及它的集合对象 BillEntrys） BOSField（以及它的集合对象 BOSFields） 属于辅助对象，不能使用 New 关键字创

40、建。 以下对象： ListEvents BaseClassEvent BillEvent 属于金蝶 K/3 BOS 的客户端接口对象。我们主要使用这 3个对象完成插件的开发。 第 2 页 K/3 BOS插件开发手册 ListEvents对象参考 ListEvents对象属于金蝶 K/3 BOS 的客户端接口对象，用来获得金蝶 K/3 BOS 的客户端的序时簿对 象的属性、方法和事件。 ListEvents对象共包含 11 个属性、8 个函数和 23 个事件。 DataSrv 属性 序时簿客户端的数据服务对象 语法 Object.DataSrv 部分 描述 Object ListEvents对象

41、的一个实例。 返回值类型 Object 注释 返回序时簿客户端数据服务对象， 包括了单据的模板信息 ClassType、 ClassTypeEntry、 Ta b l e I n f o、 Filter等 KFO.Dictionary 对象和 ClassTypeID、SQLSelect、SQLFrom、SQLSelectDetail 等值。 示例一 获取当前单据的 ID： DataSrv.ClassTypeID 获取当前单据的 Caption： DataSrv.ClassType(“FName“) 示例二 获取序时簿的 SQL语句： DataSrv.SQLSelectDetail & “ Wh

42、ere “ & DataSrv.Filter(“FilterString“) 示例三 获取字段（Key 通过参数 sField指定）的模板的数据： Private Function GetFieldInfo(ByVal sField As String) As KFO.Dictionary Dim dctTableInfo As KFO.Dictionary Dim sKey As String 第 3 页 K/3 BOS插件开发手册 Set dctTableInfo = m_ListInterface.DataSrv.TableInfo If dctTableInfo(“Map“).Look

43、up(sField) Then sKey = dctTableInfo(“Map“)( sField) Set GetFieldInfo = dctTableInfo(sKey) Else Set GetFieldInfo = Nothing End If End Function EnableListFillRowEvents 属性 是允许否触发插件的序时簿 FillRow 事件。 语法 Object. EnableListFillRowEvents 部分 描述 Object ListEvents对象的一个实例。 返回值类型 Boolean 注释 是允许否触发插件的序时簿 FillRow 事

44、件。默认为 False，即不触发。只有当此值为 True 且发生序 时簿行填充时，才会触发插件的序时簿 FillRow 事件。 示例 根据填充的字段的值，实现：a、将 1、2、3对应成星期一、星期二、星期三；b、将 6、7对应的 行背景设为绿色，其余为白色： Public Sub Show(ByVal oListInterface As Object) ListEvents 接口实现 注意: 此方法必须存在, 请勿修改 Set m_ListInterface = oListInterface 设置 EnableListFillRowEvents 属性，允许激发 ListFillRow 事件 m

45、_ListInterface.EnableListFillRowEvents = True End Sub Private Sub m_ListInterface_ListFillRow(ByVal lRow As Long, ByVal RowData As Object, ByVal HeadDict As KFO.IDictionary, CellData As String, BackColor As Long, ContinueRaise As Boolean) 第 4 页 K/3 BOS插件开发手册 If HeadDict(“FKey“) = “FText“ Then Select

46、 Case CellData Case “1”: CellData = “星期一“ BackColor = vbWhite Case “2”: CellData = “星期二“ BackColor = vbWhite Case “3”: CellData = “星期三“ BackColor = vbWhite Case “4”: CellData = “星期四“ BackColor = vbWhite Case “5”: CellData = “星期五“ BackColor = vbWhite Case “6”: CellData = “星期六“ BackColor = vbGreen Cas

47、e “7”: CellData = “星期日“ BackColor = vbGreen Case Else BackColor = vbWhite End Select End If ContinueRaise = True End Sub K3Lib 属性 K3Lib对象 语法 Object.K3Lib 部分 描述 Object ListEvents对象的一个实例。 返回值类型 K3ClassEvents.K3Lib 第 5 页 K/3 BOS插件开发手册 注释 只读属性。返回 K3Lib对象，主要用来访问金蝶 K/3的一些属性，及执行金蝶 K/3 的一些标准操作。 详细请参考“K3Lib

48、对象参考” 。 List 属性 序时簿对象 语法 Object.List 部分 描述 Object ListEvents对象的一个实例。 返回值类型 Object 注释 返回序时簿对象，包括 DataSrv、 Parent、rsID等对象,以及一些隐含的方法和函数，如刷新序时簿。 示例 在插件中刷新序时簿： Call m_ListInterface.List.RefreshList(False) ListEntrySort 属性 返回或设置序时簿单据体字段排序。 语法 Object.ListEntrySort 部分 描述 Object ListEvents对象的一个实例。 返回值类型 String 注释 可以通过该属性返回当前序时簿显示前过滤界面中设置的单据体字段排序，或者设置当前单据体字段 的排序（设置后需要调用序时簿刷新方法才可以看到设置结果） 。 第 6 页