K3BOS插件开发手册

K/3 BOS 插件开发手册

（版本：V12.3）

金蝶软件（中国）有限公司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

MultiCheckMgr 属性.........................................................................................................................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

AfterBatchMultiCheck 事件.............................................................................................................17

AfterBusinessCheck 事件..............................................................................................................18

AfterBusinessCheckEx 事件..........................................................................................................18

AfterCopyBillCreateData 事件.......................................................................................................19

AfterDeleteBill 事件........................................................................................................................19

AfterMergeCopyBill 事件.................................................................................................................20

AfterMultiCheck 事件.....................................................................................................................20

AfterMultiCheckEx 事件.................................................................................................................20

AfterSelList 事件.............................................................................................................................21

AfterUnBusinessCheck 事件..........................................................................................................21

AfterUnBusinessCheckEx 事件.....................................................................................................22

AfterUnMultiCheck 事件................................................................................................................22

AfterUnMultiCheckEx 事件............................................................................................................23 BeforeMultiCheck 事件..................................................................................................................23 BeforeMultiCheckEx 事件..............................................................................................................24 BeforePrintBill 事件........................................................................................................................24 BeforeSenderMessage 事件..........................................................................................................25 BeforRefreshToolBar 事件.............................................................................................................25 BusinessCheck 事件.......................................................................................................................26 BusinessCheckEx 事件...................................................................................................................26 FinishMultiCheck 事件...................................................................................................................26 FinishMultiCheckEx 事件...............................................................................................................27 ListFillRow 事件..............................................................................................................................27 ListRowSelected 事件....................................................................................................................29 MenuBarClick 事件.........................................................................................................................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 事件....................................................................................................................36 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 函数...........................................................................................................................43 GetSelectedClassID 函数..............................................................................................................44 GetSelectedClassType 函数..........................................................................................................45 GetSelectedItemID 函数...............................................................................................................45

GetSelectedItems 函数..................................................................................................................46 IsSearchState 函数........................................................................................................................47 PitchItemByID 函数.......................................................................................................................47 SelectClassGroupByID 函数..........................................................................................................48 SenderMessage 函数.....................................................................................................................49 SetStatus函数..................................................................................................................................50 RefreshClassGroups 方法..............................................................................................................50 RefreshListByClassGroupID 方法.................................................................................................51 RefreshSelectedClassGroup 方法.................................................................................................51 RefreshSelectedClassGroupList 方法...........................................................................................52 AfterGetData 事件..........................................................................................................................52 BeforePrintBill 事件........................................................................................................................53 BeforeSenderMessage 事件..........................................................................................................53 ClassGroupSelected 事件..............................................................................................................54 DeleteBillSucessful 事件..................................................................................................................54 ListFillRow 事件..............................................................................................................................55 ListRowSelected 事件....................................................................................................................57 MenuBarClick 事件.........................................................................................................................57 MenuBarInitialize 事件..................................................................................................................57 RefreshList 事件.............................................................................................................................58 BillEvent 对象参考.....................................................................................................................................59

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 InsertNewRowAndFillOption 属性..................................................................................................65 IsDoAction 属性.............................................................................................................................65 IsDoActionData 属性.....................................................................................................................65

K3Lib 属性.......................................................................................................................................66 LayerCount 属性.............................................................................................................................66 LayerNames 属性.............................................................................................................................66 MenuBar 属性.................................................................................................................................67

MultiCheckMgr 属性.......................................................................................................................67 ObjectID 属性.................................................................................................................................68 ObjectType 属性.............................................................................................................................68 OriginalFieldValue 属性...................................................................................................................68 PrimaryKey 属性.............................................................................................................................69 ReSaveSuccess 属性......................................................................................................................69 rsBillID 属性....................................................................................................................................69 ShowType 属性...............................................................................................................................70 TableInfo 属性................................................................................................................................70 TableName 属性.............................................................................................................................70 TaskID 属性....................................................................................................................................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 GetVariable 函数..............................................................................................................................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 函数.......................................................................................................................89 ShowHideGrid 函数........................................................................................................................89 Sum 函数........................................................................................................................................90 UpdateLookFld 函数......................................................................................................................90

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 OnBarItemClick事件...................................................................................................................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 属性..................................................................................................................203 TableInfo 属性..............................................................................................................................203 TableName 属性...........................................................................................................................203 BillEvent 对象参考...................................................................................................................................205

事件声明........................................................................................................................................205 OnBarInitialize事件.................................................................................................................206 OnBarItemClick事件...................................................................................................................207 AfterNewBill 事件.........................................................................................................................207 BeforLoadBillFillData事件.....................................................................................................207 AfterLoadBill事件.....................................................................................................................207 AfterShowBill 事件.......................................................................................................................208 AfterConfirm事件.....................................................................................................................208 AfterF7Select事件.....................................................................................................................208

Change 事件.................................................................................................................................209 BeforeSave 事件...........................................................................................................................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 LOCKBILLENTRY(BYVAL 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 TableInfo 属性..............................................................................................................................224 TableName 属性...........................................................................................................................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

EntryTop 属性...............................................................................................................................229 EntryType 属性.............................................................................................................................230 EntryWidth 属性...........................................................................................................................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 FontBold 属性...............................................................................................................................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 属性.....................................................................................................................................238 Visible 属性...................................................................................................................................239

用户场景......................................................................................................................................240

需求.........................................................................................................................................................240 总体需求.............................................................................................................................................240 需求分解.............................................................................................................................................241

详细需求.............................................................................................................................................242 单据信息........................................................................................................................................242 单据流程........................................................................................................................................244 多级审核........................................................................................................................................245 凭证功能........................................................................................................................................245 设计和实现..............................................................................................................................................246 单据数据结构设计.............................................................................................................................246 单据头............................................................................................................................................246 单据体............................................................................................................................................248 字段的过滤条件.................................................................................................................................251 BOS IDE中设置过滤条件.............................................................................................................251 通过SQL更新字段的过滤条件.....................................................................................................253 Action设置..........................................................................................................................................254 自动生成Action..............................................................................................................................254 手动添加Action..............................................................................................................................257 单据流程.............................................................................................................................................259 【销售订单】下推生成【产品入库通知单】.............................................................................259 练习一下........................................................................................................................................263 多级审核.............................................................................................................................................265 多级审核设置................................................................................................................................265 凭证功能.............................................................................................................................................266 设置凭证数据来源........................................................................................................................266 操作管理........................................................................................................................................267 插件开发.............................................................................................................................................270 部署.........................................................................................................................................................271 发布到主控台.....................................................................................................................................271 制作部署文件.....................................................................................................................................273

概述

为了实现客户个性化的需求和保持K/3 BOS 架构的开放性，K/3 BOS 提供了插件编程，有效的扩展了K/3 BOS 平台，K/3 BOS 插件编程是通过K3ClassEvents 对象代理实现的。

K/3 BOS 提供了基于COM 和.Net 两套插件模型。

COM

K/3 BOS 提供ListEvents 、BaseClassEvent 、BillEvent 三个重要的客户端接口对象及其他的辅助对象。

K3ClassEvents 的对象模型

使用说明

关于Kingdee Foundation Objects 1.0 对象

本文中所有涉及到的 KFO 对象，如KFO.Dictionary 、KFO.Vector ，他们的结构、使用方法、描述等详细内容，请参考《KFO 组件使用参考》。

关于Microsoft ActiveX Data Objects Library 对象

本文中所有涉及到的 ADODB 对象，如ADODB.Recordset ，版本必需不低于2.6；他们的结构、使用方法、描述等详细内容，请参考http://msdn.microsoft.com/ 相关内容。

K3ClassEvents 的对象

上面的对象结构图囊括了K3ClassEvents 组件中所使用到的所有对象。需要注意的是： 以下对象：

K3Lib （Net、User、Account） MenuBar

BOSBand（以及它的集合对象 BOSBands） BOSTool （以及它的集合对象 BOSTools） BillHead （以及它的集合对象 BillHeads） BillEntry （以及它的集合对象 BillEntrys）

本文来源：https://www.bwwdw.com/article/j457.html