NumXL
VBA SDK Getting Started
StartingwithNumXL1.62(DEWDROP),theinstallerincludesanewcomponent:NumXLVBASDK.This componentispackagedwithinanewExceladdincalledNumXLVBA.Theinstallersimplycopiesthe filesintotheinstallationdirectory,butdoesnotregisteritwithExcel.Theaddinisintendedsolelytobe usedbyVBAdevelopers.
Overview
TheNumXLVBASDKisbasicallyalibraryofalldatatypes(e.g.enumeration)andfunctionAPI declarationsforNumXLSDK.
Key Benefits
UnlikedeclaringAPIinyourprojectapproach(whichwouldrequirethatyoufurnishthefullpath name),theaddinapproachallowsthedevelopertoonlyreferencetheSDKonce. SupportforExcelversions97through2013,boththe32bitand64bitversion. Securely,digitallysignedbySpiderFinancialandfullycompliantwithExcelsmacrossecurity model.
Prerequisites
1. MSExcelinstallationonWindows 2. ValidNumXLinstallationandactivelicense
Hello World!
1. LetslaunchtheVisualBasiceditorandopenourproject:
2. FromtheToolsmenu,clickontheReferencesitem.
NumXLVBASDKGettingStarted
SpiderFinancialCorp,2013
3. TheReferenceboxpopsup:
4. ClickontheBrowsebuttonandnavigatetotheNumXLinstallationdirectory. a. IfyouinstalledNumXLforeveryone,thedefaultinstallationwillbe: i. (64bit)c:\programfiles\NumXL ii. (32bit)c:\programfiles(x86) b. IfyouinstalledNumXLonlyforyou,theinstallationdirectoryis:c:\users\<your name>\AppData\Roaming\NumXL Note:TheAppDatafolderisinitiallyhidden,soyoullhavetoenableviewhiddenfiles andfoldersfromthefolderoptionsinWindowsExplorer.
NumXLVBASDKGettingStarted
SpiderFinancialCorp,2013
5. SelectNumXLVBA.xla(forExcel972003)orNumXLVBA.xlam(forExcel2007now).ClickOK andthelibraryisaddedtothereferences(i.e.checked):
6. ClickOKandexamineyourVBAprojectexplorer.TheNumXLSDKisaddedandanewfolder entitledReferencesisadded.
7. Whenyouredone,youcanstartusingNumXLSDKinyourproject.
NumXLVBASDKGettingStarted
SpiderFinancialCorp,2013
Example:
NumXLVBASDKGettingStarted
SpiderFinancialCorp,2013
Documentation
1. Online(www.spiderfinancial.com/sdk) 2. ObjectBrowserinVisualBasiceditor Toviewfunctionsanddatatypes,opentheobjectexplorer(orhitF2):
Selectanyfunctionordatatypeformoredescriptionoryoucanviewthefunctionsfulldescription onlineatwww.spiderfinancial.com/sdk.
NumXLVBASDKGettingStarted
SpiderFinancialCorp,2013
Deployment
Insum,aVBAormacrodeveloperwriteshis/hercodeonceanddeploysitfortheendusersmachines regardlessoftheirdifferentExcelinstallations. Youcansaveyourfile/spreadsheetanywhere.
Macros Security
1. SaveyourworkinamacrosenabledExcelspreadsheetfile. 2. In,changethemacrossecuritysettingstoallowyourcodetorun.
3. Why?Although,allNumXLVBAaddinsaredigitallysigned,yourVBAcode/macrosarenot. 4. Dontlikethat?Requestacodesigningcertificatefromatrustedpublisher(e.g.VeriSign, Comodo,etc.),installitandsignyourVBAcode.
FAQ
Q1:IseetwoaddinsfilesinNumXL:NumXLVBA.xlaandNumXLVBA.xlam,whichoneshouldI
reference?
A:ForExcel972003,youdneedtoreferenceNumXLVBA.xla.ForlaterExcels(e.g.20072013),you
needtouseNumXLVBA.xlam.
Q2:Iamrunning64bitversionofExcel,WhatdoIneedtodo?
A:Nothingspecial,theVBASDKdetectstheplatformyouarerunningandusetheproperAPI
declarationtoworkwithyourspreadsheet.
Q3:HowcanIdeploymyNumXLVBAenabledspreadsheettootherusers?
A:Simplycopyyourspreadsheettoyourendusermachine.Havingsaidthat,yourendusermusthave
aworkingNumXLinstallationandvalidlicensekey. NumXLVBASDKGettingStarted 6 SpiderFinancialCorp,2013
Q4:MyenduserdoesnotwishtoenableNumXLand/orNumXLtoolbar,CanIstilldeploymyNumXL
VBAenabledspreadsheettothoseusers?
A:Yes,butyourspreadsheetmustinitializetheSDK(i.e.NDK_INIT)asuponopen,andshutdown(i.e.
NDK_SHUTDOWN)tocleanupandreleaseanyresourcesbeforeclose.
Q5:IhaveaproblemorquestionaboutNumXLVBA,whodoIcall? A:NumXL,NumXLSDK,andNumXLVBAarefullysupportedbyourhelpdeskataspartofourpremier
supportagreement.
NumXLVBASDKGettingStarted
SpiderFinancialCorp,2013
