Нет описания
Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.

office-vsdoc.js 558KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464
  1. /* Version: 16.0.7524.3000 */
  2. /*
  3. Copyright (c) Microsoft Corporation. All rights reserved.
  4. */
  5. /*
  6. Your use of this file is governed by the Microsoft Services Agreement http://go.microsoft.com/fwlink/?LinkId=266419.
  7. */
  8. /// <reference path="outlook-win32.debug.js" />
  9. Office._ExcelMask = 0x1;
  10. Office._WordMask = 0x2;
  11. Office._ProjectMask = 0x4;
  12. Office._OutlookMask = 0x8;
  13. Office._PowerPointMask = 0x10;
  14. Office._OutlookComposeMask = 0x20;
  15. Office._AccessWebAppMask = 0x40;
  16. {
  17. Office._extractedCallback = function (originalArgs, totalArgsCount, optionalArgsCount) {
  18. var optionalArgs = Array.prototype.slice.call(originalArgs, totalArgsCount - optionalArgsCount);
  19. var callback = function(){};
  20. for (var i = Math.min(optionalArgs.length, optionalArgsCount) - 1; i >= 0; i--) {
  21. if (typeof optionalArgs[i] == "function") {
  22. callback = optionalArgs[i];
  23. break;
  24. }
  25. }
  26. return callback;
  27. }
  28. Office._BindingDataChangedEvents = function (eventType) {
  29. this.binding = new Office._Binding(bindingType);
  30. this.type = eventType;
  31. this.startColumn = {};
  32. this.startRow = {};
  33. }
  34. Office._DocumentEventArgs = function (eventType) {
  35. Office._processContents(this, {
  36. type: {
  37. annotate: {
  38. /// <field type="Office.EventType"></field>
  39. type: undefined
  40. },
  41. value: eventType
  42. }
  43. });
  44. if (eventType == "activeViewChanged") {
  45. Office._processItem(
  46. this,
  47. {
  48. annotate: {
  49. /// <field type="Office.ActiveView"></field>
  50. activeView: undefined
  51. }
  52. },
  53. "activeView"
  54. );
  55. }
  56. }
  57. Office._DialogEventArgs = function (eventType) {
  58. Office._processContents(this, {
  59. type: {
  60. annotate: {
  61. /// <field type="Office.EventType"></field>
  62. type: undefined
  63. },
  64. value: eventType
  65. }
  66. });
  67. if (eventType == "dialogMessageReceived") {
  68. Office._processItem(
  69. this,
  70. {
  71. annotate: {
  72. /// <field type="string"></field>
  73. message: undefined
  74. }
  75. },
  76. "message"
  77. );
  78. } else if (eventType == "dialogEventReceived") {
  79. Office._processItem(
  80. this,
  81. {
  82. annotate: {
  83. /// <field type="Integer"></field>
  84. error: undefined
  85. }
  86. },
  87. "error"
  88. );
  89. }
  90. }
  91. Office._CustomXmlNodeEvents = function (eventType) {
  92. this.type = eventType;
  93. this.inUndoRedo = {};
  94. if (eventType == 'nodeDeleted') {
  95. this.oldNode = new Office._CustomXmlNode();
  96. this.oldNextSibling = new Office._CustomXmlNode();
  97. }
  98. if (eventType == 'nodeInserted') {
  99. this.newNode = new Office._CustomXmlNode();
  100. }
  101. if (eventType == 'nodeReplaced') {
  102. this.oldNode = new Office._CustomXmlNode();
  103. this.newNode = new Office._CustomXmlNode();
  104. }
  105. }
  106. Office._Error = function () {
  107. this.id = {};
  108. this.message = {};
  109. this.name = {};
  110. }
  111. Office._CustomXmlNode = function () {
  112. this.baseName = {};
  113. this.namespaceUri = {};
  114. this.nodeType = {};
  115. this.getNodesAsync = function (xPath, callback) {
  116. ///<summary> Gets the nodes associated with the xPath expression. </summary>
  117. ///<param name="xPath" type="string">The xPath expression</param>
  118. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  119. var result = new Office._AsyncResult("getNodesAsync");
  120. callback(result);
  121. };
  122. this.getNodeValueAsync = function (callback) {
  123. ///<summary> Gets the node value. </summary>
  124. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  125. var result = new Office._AsyncResult("getNodeValueAsync");
  126. callback(result);
  127. };
  128. this.getXmlAsync = function (callback) {
  129. ///<summary> Gets the node's XML. </summary>
  130. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  131. var result = new Office._AsyncResult("getXmlAsync");
  132. callback(result);
  133. };
  134. this.setNodeValueAsync = function (value, callback) {
  135. ///<summary> Sets the node value. </summary>
  136. ///<param name="value" type="string">The value to be set on the node</param>
  137. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  138. var result = new Office._AsyncResult("setNodeValueAsync");
  139. callback(result);
  140. };
  141. this.setXmlAsync = function (xml, callback) {
  142. ///<summary> Sets the node XML. </summary>
  143. ///<param name="xml" type="string">The XML to be set on the node</param>
  144. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  145. var result = new Office._AsyncResult("setXmlAsync");
  146. callback(result);
  147. };
  148. }
  149. Office._context_document_customXmlParts_customXmlPrefixMappings = function () {
  150. this.addNamespaceAsync = function (prefix, nsUri, callback) {
  151. ///<summary>Adds a namespace. </summary>
  152. //////<param name="prefix" type="string">The namespace prefix</param>
  153. //////<param name="nsUri" type="string">The namespace URI</param>
  154. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  155. var result = new Office._AsyncResult("addNamespaceAsync");
  156. callback(result);
  157. };
  158. this.getNamespaceAsync = function (prefix, callback) {
  159. ///<summary> Gets a namespace with the specified prefix </summary>
  160. ///<param name="prefix" type="string">The namespace prefix</param>
  161. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  162. var result = new Office._AsyncResult("getNamespaceAsync");
  163. callback(result);
  164. };
  165. this.getPrefixAsync = function (nsUri, callback) {
  166. ///<summary> Gets a prefix for the specified URI </summary>
  167. ///<param name="nsUri" type="string">The namespace URI</param>
  168. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  169. var result = new Office._AsyncResult("getPrefixAsync");
  170. callback(result);
  171. };
  172. }
  173. Office._CustomXmlPart = function () {
  174. this.builtIn = {};
  175. this.id = {};
  176. this.namespaceManager = new Office._context_document_customXmlParts_customXmlPrefixMappings();
  177. this.deleteAsync = function (callback) {
  178. ///<summary> Deletes the Custom XML Part. </summary>
  179. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  180. var result = new Office._AsyncResult("deleteAsync");
  181. callback(result);
  182. };
  183. this.getNodesAsync = function (xPath, callback) {
  184. ///<summary> Gets the nodes associated with the xPath expression. </summary>
  185. ///<param name="xPath" type="string">The xPath expression</param>
  186. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  187. var result = new Office._AsyncResult("getNodesAsync");
  188. callback(result);
  189. };
  190. this.getXmlAsync = function (callback) {
  191. ///<summary> Gets the XML for the Custom XML Part. </summary>
  192. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  193. var result = new Office._AsyncResult("getXmlAsync");
  194. callback(result);
  195. };
  196. this.addHandlerAsync = function (eventType, handler, callback) {
  197. ///<summary> Adds an event handler to the object using the specified event type. </summary>
  198. ///<param name="eventType" type="Office.EventType">The event type. For CustomXmlPartNode it can be 'nodeDeleted', 'nodeInserted' or 'nodeReplaced' </param>
  199. ///<param name="handler" type="function">The name of the handler </param>
  200. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  201. var events = new Office._CustomXmlNodeEvents(eventType);
  202. handler(events);
  203. var result = new Office._AsyncResult("addHandlerAsync");
  204. callback(result);
  205. };
  206. this.removeHandlerAsync = function (eventType, options, callback) {
  207. ///<summary> Removes an event handler from the object using the specified event type. </summary>
  208. ///<param name="eventType" type="Office.EventType">The event type. For CustomXmlPartNode it can be 'nodeDeleted', 'nodeInserted' or 'nodeReplaced' </param>
  209. ///<param name="options" type="Object" optional="true">
  210. /// Syntax example: {handler:eventHandler}
  211. /// &#10; handler: Indicates a specific handler to be removed, if not specified all handlers are removed
  212. /// &#10; asyncContext: Object keeping state for the callback
  213. ///</param>
  214. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  215. ///
  216. Office._extractedCallback(arguments, 3, 2)(new Office._AsyncResult("removeHandlerAsync"));
  217. }
  218. }
  219. Office._Binding = function (bindingType) {
  220. ///<field type="String" name="id">Id of the Binding</field>};
  221. this.id = {};
  222. this.type = {};
  223. this.document = {};
  224. this.setDataAsync = function (data, options, callback) {
  225. ///<summary> Writes the specified data into the current selection.</summary>
  226. ///<param name="data" type="Object">The data to be set. Either a string or value, 2d array or TableData object</param>
  227. ///<param name="options" type="Object" optional="true">
  228. /// Syntax example: {coercionType:Office.CoercionType.Matrix} or {coercionType: 'matrix'}
  229. /// &#10; coercionType: Explicitly sets the shape of the data object. Use Office.CoercionType or text value. If not supplied is inferred from the data type.
  230. /// &#10; startRow: Used in partial set for table/matrix. Indicates the start row.
  231. /// &#10; startColumn: Used in partial set for table/matrix. Indicates the start column.
  232. /// &#10; asyncContext: Object keeping state for the callback
  233. ///</param>
  234. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  235. Office._extractedCallback(arguments, 3, 2)(new Office._AsyncResult("setDataAsync"));
  236. };
  237. this.getDataAsync = function (options, callback) {
  238. ///<summary> Returns the current selection.</summary>
  239. ///<param name="options" type="Object" optional="true">
  240. /// Syntax example: {coercionType: 'matrix,'valueFormat: 'formatted', filterType:'all'}
  241. /// &#10; coercionType: The expected shape of the selection. If not specified returns the bindingType shape. Use Office.CoercionType or text value.
  242. /// &#10; valueFormat: Get data with or without format. Use Office.ValueFormat or text value.
  243. /// &#10; startRow: Used in partial get for table/matrix. Indicates the start row.
  244. /// &#10; startColumn: Used in partial get for table/matrix. Indicates the start column.
  245. /// &#10; rowCount: Used in partial get for table/matrix. Indicates the number of rows from the start row.
  246. /// &#10; columnCount: Used in partial get for table/matrix. Indicates the number of columns from the start column.
  247. /// &#10; filterType: Get the visible or all the data. Useful when filtering data. Use Office.FilterType or text value.
  248. /// &#10; asyncContext: Object keeping state for the callback
  249. ///</param>
  250. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  251. if (arguments.length == 1) {
  252. callback = options;
  253. }
  254. var result = new Office._AsyncResult("getDataAsync", options.coercionType);
  255. callback(result);
  256. };
  257. this.addHandlerAsync = function (eventType, handler, callback) {
  258. ///<summary> Adds an event handler to the object using the specified event type. </summary>
  259. ///<param name="eventType" type="Office.EventType">The event type. For binding it can be 'bindingDataChanged' and 'bindingSelectionChanged' </param>
  260. ///<param name="handler" type="function">The name of the handler </param>
  261. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  262. var events = new Office._BindingDataChangedEvents(eventType);
  263. handler(events);
  264. var result = new Office._AsyncResult("addHandlerAsync");
  265. callback(result);
  266. };
  267. this.removeHandlerAsync = function (eventType, options, callback) {
  268. ///<summary> Removes an event handler from the object using the specified event type. </summary>
  269. ///<param name="eventType" type="Office.EventType">The event type. For binding can be 'bindingDataChanged' and 'bindingSelectionChanged' </param>
  270. ///<param name="options" type="Object" optional="true">
  271. /// Syntax example: {handler:eventHandler}
  272. /// &#10; handler: Indicates a specific handler to be removed, if not specified all handlers are removed
  273. /// &#10; asyncContext: Object keeping state for the callback
  274. ///</param>
  275. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  276. var events = new Office._BindingDataChangedEvents(eventType);
  277. handler(events);
  278. Office._extractedCallback(arguments, 3, 2)(new Office._AsyncResult("removeHandlerAsync"));
  279. };
  280. if ((bindingType == undefined) || (bindingType == Office.BindingType.Matrix) || (bindingType == Office.BindingType.Table)) {
  281. this.columnCount = {};
  282. this.rowCount = {};
  283. }
  284. if ((bindingType == undefined) || (bindingType == Office.BindingType.Table)) {
  285. Office._processContents(this, {
  286. hasHeaders: {
  287. value: {}
  288. },
  289. addRowsAsync: {
  290. value: function (data, callback) {
  291. ///<summary> Adds the specified rows to the table </summary>
  292. ///<param name="data" type="Object"> A 2D array with the rows to add </param>
  293. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  294. }
  295. },
  296. addColumnsAsync: {
  297. value: function (tableData, callback) {
  298. ///<summary> Adds the specified columns to the table </summary>
  299. ///<param name="tableData" type="Object"> A TableData object with the headers and rows </param>
  300. ///<param name="callback" type="function" optional="true">The optional callback method</param>};
  301. }
  302. },
  303. deleteAllDataValuesAsync: {
  304. value: function (callback) {
  305. ///<summary> Clears the table</summary>
  306. ///<param name="callback" type="function" optional="true">The optional callback method</param>};
  307. }
  308. },
  309. formattingSpecific: {
  310. metaOnly: true,
  311. conditions: {
  312. hosts: ["excel"],
  313. },
  314. contents: {
  315. clearFormatsAsync: {
  316. conditions: {
  317. reqs: ["method TableBinding.clearFormatsAsync"]
  318. },
  319. value: function (options, callback) {
  320. ///<summary> Clears formatting on the bound table. </summary>
  321. ///<param name="options" type="Object" optional="true">
  322. /// Syntax example: {asyncContext:context}
  323. /// &#10; asyncContext: Object keeping state for the callback
  324. ///</param>
  325. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  326. Office._extractedCallback(arguments, 2, 2)(new Office._AsyncResult("clearFormatsAsync"));
  327. }
  328. },
  329. getFormatsAsync: {
  330. conditions: {
  331. reqs: ["method TableBinding.getFormatsAsync"]
  332. },
  333. value: function (cellReference, formats, options, callback) {
  334. ///<summary> Gets the formatting on specified items in the table. </summary>
  335. ///<param name="cellReference" type="Object" optional="true">An object literal containing name-value pairs that specify the range of cells to get formatting from.</param>
  336. ///<param name="formats" type="Array" optional="true">An array specifying the format properties to get.</param>
  337. ///<param name="options" type="Object" optional="true">
  338. /// Syntax example: {asyncContext:context}
  339. /// &#10; asyncContext: Object keeping state for the callback
  340. ///</param>
  341. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  342. Office._extractedCallback(arguments, 4, 4)(new Office._AsyncResult("getFormatsAsync"));
  343. }
  344. },
  345. setFormatsAsync: {
  346. conditions: {
  347. reqs: ["method TableBinding.setFormatsAsync"]
  348. },
  349. value: function (formatsInfo, options, callback) {
  350. ///<summary> Sets formatting on specified items and data in the table. </summary>
  351. ///<param name="formatsInfo" type="Array" elementType="Array" optional="true">
  352. /// Array elements are themselves three-element arrays:
  353. /// [target, type, formats]
  354. /// &#10; target: The identifier of the item to format. String.
  355. /// &#10; type: The kind of item to format. String.
  356. /// &#10; formats: An object literal containing a list of property name-value pairs that define the formatting to apply.
  357. ///</param>
  358. ///<param name="options" type="Object" optional="true">
  359. /// Syntax example: {asyncContext:context}
  360. /// &#10; asyncContext: Object keeping state for the callback
  361. ///</param>
  362. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  363. Office._extractedCallback(arguments, 3, 3)(new Office._AsyncResult("setFormatsAsync"));
  364. }
  365. },
  366. setTableOptionsAsync: {
  367. conditions: {
  368. reqs: ["method TableBinding.setTableOptionsAsync"]
  369. },
  370. value: function (tableOptions, options, callback) {
  371. ///<summary> Updates table formatting options on the bound table. </summary>
  372. ///<param name="tableOptions" type="Object">An object literal containing a list of property name-value pairs that define the table options to apply.</param>
  373. ///<param name="options" type="Object" optional="true">
  374. /// Syntax example: {asyncContext:context}
  375. /// &#10; asyncContext: Object keeping state for the callback
  376. ///</param>
  377. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  378. Office._extractedCallback(arguments, 3, 2)(new Office._AsyncResult("setTableOptionsAsync"));
  379. }
  380. }
  381. }
  382. }
  383. });
  384. }
  385. }
  386. Office._TableData = function () {
  387. this.headers = new Array(new Array());
  388. this.rows = new Array(new Array());
  389. }
  390. Office._File = function () {
  391. this.size = {};
  392. this.sliceCount = {};
  393. this.getSliceAsync = function (sliceIndex, callback) {
  394. ///<summary> Gets the specified slice. </summary>
  395. ///<param name="sliceIndex" type="Integer">The index of the slice to be retrieved </param>
  396. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  397. var result = new Office._AsyncResult("getSliceAsync");
  398. callback(result);
  399. };
  400. this.closeAsync = function (callback) {
  401. ///<summary> Closes the File. </summary>
  402. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  403. };
  404. }
  405. Office._Slice = function () {
  406. this.data = {};
  407. this.index = {};
  408. this.size = {};
  409. }
  410. Office._Dialog = function () {
  411. this.data = {};
  412. this.close = function () {
  413. ///<summary> Allows the add-in to close its dialog box. </summary>
  414. };
  415. this.addEventHandler = function (eventType, handler) {
  416. ///<summary> Registers an event handler. </summary>
  417. ///<param name="eventType" type="Office.EventType"> The two supported events are: DialogMessageReceived or DialogEventReceived </param>
  418. ///<param name="handler" type="function" optional="true"> The name of the handler </param>
  419. handler(new Office._DialogEventArgs(eventType));
  420. };
  421. }
  422. Office._AsyncResult = function (method, bindingType) {
  423. this.asyncContext = {};
  424. this.error = new Office._Error();
  425. this.status = {};
  426. if ((method == "addfromSelectionAsync") || (method == "addFromNamedItemAsync") || (method == "getByIdAsync") || (method == "addFromPromptAsync")) {
  427. this.value = new Office._Binding(bindingType);
  428. } else if ((method == "getDataAsync") || (method == "getSelectedDataAsync")) {
  429. if (bindingType == "table")
  430. this.value = new Office._TableData();
  431. else if (bindingType == "matrix")
  432. this.value = new Array(new Array);
  433. else
  434. this.value = {};
  435. } else if (method == "getAllAsync") {
  436. this.value = new Array(new Office._Binding(bindingType));
  437. } else if (method == "getByNamespaceAsync") {
  438. this.value = new Array(new Office._CustomXmlPart());
  439. } else if (method == "getNodesAsync") {
  440. this.value = new Array(new Office._CustomXmlNode());
  441. } else if ((method == "XMLgetByIdAsync") || (method == "addAsync")) {
  442. this.value = new Office._CustomXmlPart();
  443. } else if (method == "refreshAsync") {
  444. this.value = new Office._context_document_settings();
  445. } else if (method == "getFileAsync") {
  446. this.value = new Office._File();
  447. } else if (method == "getSliceAsync") {
  448. this.value = new Office._Slice();
  449. } else if (method == "getActiveViewAsync") {
  450. Office._processItem(this,
  451. {
  452. annotate: {
  453. ///<field type="String">The presentation's current view.</field>
  454. value: undefined
  455. }
  456. },
  457. "value"
  458. );
  459. } else if (method == "getFilePropertiesAsync") {
  460. this.value = new Office._FileProperties();
  461. } else if (method == "displayDialogAsync") {
  462. this.value = new Office._Dialog();
  463. }else {
  464. this.value = {};
  465. }
  466. }
  467. Office._FileProperties = function () {
  468. ///<field type="String" name="url">File's URL</field>
  469. this.url = "";
  470. }
  471. Office._context_document_settings = function () {
  472. this.get = function (settingName) {
  473. ///<summary>Retrieves the setting with the specified name.</summary>
  474. ///<param name="settingName" type="string">The name of the setting </param>
  475. };
  476. this.remove = function (settingName) {
  477. ///<summary>Removes the setting with the specified name.</summary>
  478. ///<param name="settingName" type="string">The name of the setting </param>
  479. ///
  480. };
  481. this.saveAsync = function (options, callback) {
  482. ///<summary>Saves all settings.</summary>
  483. ///<param name="options" type="Object" optional="true">
  484. /// Syntax example: {overwriteIfStale:false}
  485. /// &#10; overwriteIfStale: Indicates whether the setting will be replaced if stale.
  486. /// &#10; asyncContext: Object keeping state for the callback
  487. ///</param>
  488. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  489. ///
  490. Office._extractedCallback(arguments, 2, 2)(new Office._AsyncResult("saveAsync", coercionType));
  491. };
  492. this.set = function (settingName, value) {
  493. ///<summary>Sets a value for the setting with the specified name.</summary>
  494. ///<param name="settingName" type="string">The name of the setting</param>
  495. ///<param name="value" type="object">The value for the setting</param>
  496. };
  497. };
  498. Office._context_document_bindings = function () {
  499. this.document = {};
  500. if (Office._AccessWebAppMask & Office._appContext) {
  501. this.addFromSelectionAsync = function (bindingType, options, callback) {
  502. ///<summary>Create a binding based on what the user's current selection.</summary>
  503. ///<param name="bindingType" type="Office.BindingType">The Office BindingType for the data</param>
  504. ///<param name="options" type="Object" optional="true">
  505. /// addFromSelectionAsyncOptions- e.g. {id: "BindingID"}
  506. /// &#10; id: Identifier.
  507. /// &#10; asyncContext: Object keeping state for the callback
  508. /// &#10; columns: The string[] of the columns involved in the binding
  509. /// &#10; sampleData: A TableData that gives sample table in the Dialog.TableData.Headers is [][] of string.
  510. ///</param>
  511. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  512. if (arguments.length == 2) { callback = options; };
  513. var result = new Office._AsyncResult("addfromSelectionAsync", bindingType);
  514. callback(result);
  515. }
  516. } else {
  517. this.addFromSelectionAsync = function (bindingType, options, callback) {
  518. ///<summary>Create a binding based on what the user's current selection.</summary>
  519. ///<param name="bindingType" type="Office.BindingType">The Office BindingType for the data</param>
  520. ///<param name="options" type="Object" optional="true">
  521. /// addFromSelectionAsyncOptions- e.g. {id: "BindingID"}
  522. /// &#10; id: Identifier.
  523. /// &#10; asyncContext: Object keeping state for the callback
  524. ///</param>
  525. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  526. if (arguments.length == 2) { callback = options; };
  527. var result = new Office._AsyncResult("addfromSelectionAsync", bindingType);
  528. callback(result);
  529. }
  530. }
  531. if (Office._AccessWebAppMask & Office._appContext) {
  532. this.addFromNamedItemAsync = function (itemName, bindingType, options, callback) {
  533. ///<summary>Creates a binding against a named object in the document</summary>
  534. ///<param name="itemName" type="String">Name of the bindable object in the document. For Example 'MyExpenses' table in Excel." </param>
  535. ///<param name="bindingType" type="Office.BindingType">The Office BindingType for the data</param>
  536. ///<param name="options" type="Object" optional="true">
  537. /// Syntax example: {id: "BindingID"}
  538. /// &#10; id: Name of the binding, autogenerated if not supplied.
  539. /// &#10; asyncContext: Object keeping state for the callback
  540. /// &#10; columns: The string[] of the columns involved in the binding
  541. ///</param>
  542. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  543. if (arguments.length == 3) { callback = options; };
  544. var result = new Office._AsyncResult("addFromNamedItemAsync", bindingType);
  545. callback(result);
  546. }
  547. } else {
  548. this.addFromNamedItemAsync = function (itemName, bindingType, options, callback) {
  549. ///<summary>Creates a binding against a named object in the document</summary>
  550. ///<param name="itemName" type="String">Name of the bindable object in the document. For Example 'MyExpenses' table in Excel." </param>
  551. ///<param name="bindingType" type="Office.BindingType">The Office BindingType for the data</param>
  552. ///<param name="options" type="Object" optional="true">
  553. /// Syntax example: {id: "BindingID"}
  554. /// &#10; id: Name of the binding, autogenerated if not supplied.
  555. /// &#10; asyncContext: Object keeping state for the callback
  556. ///</param>
  557. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  558. if (arguments.length == 3) { callback = options; };
  559. var result = new Office._AsyncResult("addFromNamedItemAsync", bindingType);
  560. callback(result);
  561. }
  562. }
  563. this.getByIdAsync = function (id, callback) {
  564. ///<summary>Retrieves a binding based on its Name</summary>
  565. ///<param name="id" type="String">The binding id</param>
  566. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  567. var result = new Office._AsyncResult("getByIdAsync")
  568. callback(result);
  569. }
  570. this.getAllAsync = function (callback) {
  571. ///<summary>Gets an array with all the binding objects in the document.</summary>
  572. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  573. var result = new Office._AsyncResult("getAllAsync")
  574. callback(result);
  575. };
  576. this.releaseByIdAsync = function (id, callback) {
  577. ///<summary>Removes the binding from the document</summary>
  578. ///<param name="id" type="String">The binding id</param>
  579. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  580. var result = new Office._AsyncResult("releaseByIdAsync")
  581. callback(result);
  582. };
  583. if (Office._AccessWebAppMask & Office._appContext) {
  584. this.addFromPromptAsync = function (bindingType, options, callback) {
  585. ///<summary>(Access only with sample data) Create a binding by prompting the user to make a selection on the document.</summary>
  586. ///<param name="bindingType" type="Office.BindingType">The Office BindingType for the data</param>
  587. ///<param name="options" type="Object" optional="true">
  588. /// addFromPromptAsyncOptions- e.g. {promptText: "Please select data", id: "mySales"}
  589. /// &#10; promptText: Greet your users with a friendly word.
  590. /// &#10; asyncContext: Object keeping state for the callback
  591. /// &#10; id: Identifier.
  592. /// &#10; sampleData: A TableData that gives sample table in the Dialog.TableData.Headers is [][] of string.
  593. ///</param>
  594. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  595. if (arguments.length == 2) { callback = options; };
  596. var result = new Office._AsyncResult("addFromPromptAsync", bindingType)
  597. callback(result);
  598. }
  599. } else if (Office._ExcelMask & Office._appContext) {
  600. this.addFromPromptAsync = function (bindingType, options, callback) {
  601. ///<summary>(Excel only) Create a binding by prompting the user to make a selection on the document.</summary>
  602. ///<param name="bindingType" type="Office.BindingType">The Office BindingType for the data</param>
  603. ///<param name="options" type="Object" optional="true">
  604. /// addFromPromptAsyncOptions- e.g. {promptText: "Please select data", id: "mySales"}
  605. /// &#10; promptText: Greet your users with a friendly word.
  606. /// &#10; asyncContext: Object keeping state for the callback
  607. /// &#10; id: Identifier.
  608. ///</param>
  609. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  610. if (arguments.length == 2) { callback = options; };
  611. var result = new Office._AsyncResult("addFromPromptAsync", bindingType)
  612. callback(result);
  613. }
  614. }
  615. };
  616. Office._context_ui = {
  617. displayDialogAsync: {
  618. value: function (startAddress, options, callback) {
  619. ///<summary> Displays a dialog box in an Office host. </summary>
  620. ///<param name="startAddress" type="string"> Accepts the initial HTTPS(TLS) URL that opens in the dialog box. </param>
  621. ///<param name="options" type="Object" optional="true">
  622. /// Syntax example: {width:80}
  623. /// &#10; width: Defines the width of the dialog box as a percentage of the current display.
  624. /// &#10; height: Defines the height of the dialog box as a percentage of the current display.
  625. /// &#10; displayInIFrame: false (defult): The dialog will be displayed as a new browser window
  626. /// &#10; true: The dialog will be displayed as a floating overlay with an IFrame.
  627. ///</param>
  628. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  629. ///
  630. if (arguments.length == 2) { callback = options; };
  631. var result = new Office._AsyncResult("displayDialogAsync");
  632. callback(result);
  633. }
  634. },
  635. messageParent: {
  636. value: function (messageObject) {
  637. ///<summary> Delivers a message from the dialog box to its parent/opener page. The page calling this API must be on the same domain as the parent. </summary>
  638. ///<param name="messageObject" type="string"> Accepts a message from the dialog box to deliver to the add-in.</param>
  639. }
  640. }
  641. }
  642. Office._context_document = {
  643. mode: {
  644. annotate: {
  645. //Gets the document mode
  646. mode: undefined
  647. }
  648. },
  649. url: {
  650. annotate: {
  651. //Gets the document URL
  652. url: undefined
  653. }
  654. },
  655. addHandlerAsync: {
  656. value: function (eventType, handler, callback) {
  657. ///<summary> Adds an event handler for the specified event type. </summary>
  658. ///<param name="eventType" type="Office.EventType">The event type. For document can be 'DocumentSelectionChanged' </param>
  659. ///<param name="handler" type="function">The name of the handler </param>
  660. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  661. var result = new Office._AsyncResult("addHandlerAsync");
  662. callback(result);
  663. handler(new Office._DocumentEventArgs(eventType));
  664. }
  665. },
  666. removeHandlerAsync: {
  667. value: function (eventType, handler, callback) {
  668. ///<summary> Removes an event handler for the specified event type. </summary>
  669. ///<param name="eventType" type="Office.EventType">The event type. For document can be 'DocumentSelectionChanged' </param>
  670. ///<param name="handler" type="function" optional="true">The name of the handler. If not specified all handlers are removed </param>
  671. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  672. ///
  673. var result = new Office._AsyncResult("removeHandlerAsync", coercionType);
  674. callback(result);
  675. }
  676. },
  677. settings: {
  678. conditions: {
  679. hosts: ["word", "excel", "ppt", "accesswebapp"],
  680. reqs: [
  681. "set Settings GE 1.1",
  682. "method Settings.get",
  683. "method Settings.remove",
  684. "method Settings.saveAsync",
  685. "method Settings.set"
  686. ]
  687. },
  688. value: new Office._context_document_settings()
  689. },
  690. refreshableSettings: {
  691. name: "settings",
  692. conditions: {
  693. hosts: ["excel", "ppt", "accesswebapp"],
  694. reqs: []
  695. },
  696. partialConditions: true,
  697. contents: {
  698. addHandlerAsync: {
  699. conditions: { reqs: ["method Settings.addHandlerAsync"] },
  700. value: function (eventType, handler, callback) {
  701. ///<summary> Adds an event handler for the object using the specified event type. </summary>
  702. ///<param name="eventType" type="Office.EventType">The event type. For settings can be 'settingsChanged' </param>
  703. ///<param name="handler" type="function">The name of the handler </param>
  704. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  705. var result = new Office._AsyncResult("addHandlerAsync", coercionType);
  706. callback(result);
  707. }
  708. },
  709. refreshAsync: {
  710. conditions: { reqs: ["method Settings.refreshAsync"] },
  711. value: function (callback) {
  712. ///<summary>Gets the latest version of the settings object.</summary>
  713. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  714. var result = new Office._AsyncResult("refreshAsync", coercionType);
  715. callback(result);
  716. }
  717. },
  718. removeHandlerAsync: {
  719. conditions: { reqs: ["method Settings.removeHandlerAsync"] },
  720. value: function (eventType, handler, callback) {
  721. ///<summary> Removes an event handler for the specified event type. </summary>
  722. ///<param name="eventType" type="Office.EventType">The event type. For settings can be 'settingsChanged' </param>
  723. ///<param name="handler" type="Object" optional="true">
  724. /// Syntax example: {handler:eventHandler}
  725. /// &#10; handler: Indicates a specific handler to be removed, if not specified all handlers are removed
  726. /// &#10; asyncContext: Object keeping state for the callback
  727. ///</param>
  728. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  729. var result = new Office._AsyncResult("removeHandlerAsync", coercionType);
  730. callback(result);
  731. }
  732. }
  733. }
  734. },
  735. setSelectedDataAsync: {
  736. conditions: {
  737. hosts: ["word", "excel", "ppt"],
  738. reqs: ["set Selection GE 1.1", "method Document.setSelectedDataAsync"]
  739. },
  740. value: function (data, options, callback) {
  741. ///<summary> Writes the specified data into the current selection.</summary>
  742. ///<param name="data" type="Object">The data to be set. Either a string or value, 2d array or TableData object</param>
  743. ///<param name="options" type="Object" optional="true">
  744. /// Syntax example: {coercionType:Office.CoercionType.Matrix} or {coercionType: 'matrix'}
  745. /// &#10; coercionType: Explicitly sets the shape of the data object. Use Office.CoercionType or text value. If not supplied is inferred from the data type.
  746. /// &#10; imageLeft: Used for image. Sets the left position of the image.
  747. /// &#10; imageTop: Used for image. Sets the top position of the image.
  748. /// &#10; imageWidth: Used for image. Sets the width of the image.
  749. /// &#10; imageHeight: Used for image. Sets the height of the image.
  750. /// &#10; asyncContext: Object keeping state for the callback
  751. ///</param>
  752. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  753. ///
  754. if (arguments.length == 2) { callback = options; };
  755. var result = new Office._AsyncResult("setSelectedDataAsync");
  756. callback(result);
  757. }
  758. },
  759. bindings: {
  760. conditions: {
  761. hosts: ["word", "excel", "accesswebapp"],
  762. reqs: [
  763. "set TextBindings GE 1.1",
  764. "set TableBindings GE 1.1",
  765. "set MatrixBindings GE 1.1",
  766. "method Bindings.addFromPromptAsync",
  767. "method Bindings.addFromNamedItemAsync",
  768. "method Bindings.addFromSelectionAsync",
  769. "method Bindings.getAllAsync",
  770. "method Bindings.getByIdAsync",
  771. "method Bindings.releaseByIdAsync",
  772. "method MatrixBinding.getDataAsync",
  773. "method MatrixBinding.setDataAsync",
  774. "method TableBinding.clearFormatsAsync",
  775. "method TableBinding.setFormatsAsync",
  776. "method TableBinding.setTableOptionsAsync",
  777. "method TableBinding.addColumnsAsync",
  778. "method TableBinding.addRowsAsync",
  779. "method TableBinding.deleteAllDataValuesAsync",
  780. "method TableBinding.getDataAsync",
  781. "method TableBinding.setDataAsync",
  782. "method TextBinding.getDataAsync",
  783. "method TextBinding.setDataAsync"
  784. ]
  785. },
  786. value: new Office._context_document_bindings()
  787. },
  788. getFileAsync: {
  789. conditions: {
  790. hosts: ["word", "ppt","excel"],
  791. reqs: ["set File GE 1.1", "method Document.getFileAsync", "method File.closeAsync", "method File.getSliceAsync"]
  792. },
  793. value: function (fileType, options, callback) {
  794. ///<summary>(Word and PowerPoint only) Gets the entire file in slices of up to 4MB.</summary>
  795. ///<param name="fileType" type="Office.FileType">The format in which the file will be returned</param>
  796. ///<param name="options" type="Object" optional="true">
  797. /// Syntax example: {sliceSize:1024}
  798. /// &#10; sliceSize: Specifies the desired slice size (in bytes) up to 4MB. If not specified a default slice size of 4MB will be used.
  799. ///</param>
  800. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  801. if (arguments.length == 2) { callback = options; };
  802. var result = new Office._AsyncResult("getFileAsync");
  803. callback(result);
  804. }
  805. },
  806. getSelectedDataAsync: {
  807. conditions: {
  808. hosts: ["excel", "word", "project", "ppt"],
  809. reqs: ["set Selection GE 1.1", "method Document.getSelectedDataAsync"]
  810. },
  811. value: function (coercionType, options, callback) {
  812. ///<summary> Returns the current selection.</summary>
  813. ///<param name="coercionType" type="Office.CoercionType">The expected shape of the selection.</param>
  814. ///<param name="options" type="Object" optional="true">
  815. /// Syntax example: {valueFormat: 'formatted', filterType:'all'}
  816. /// &#10; valueFormat: Get data with or without format. Use Office.ValueFormat or text value.
  817. /// &#10; filterType: Get the visible or all the data. Useful when filtering data. Use Office.FilterType or text value.
  818. /// &#10; asyncContext: Object keeping state for the callback
  819. ///</param>
  820. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  821. ///
  822. if (arguments.length == 2) { callback = options; };
  823. var result = new Office._AsyncResult("getSelectedDataAsync", coercionType);
  824. callback(result);
  825. }
  826. },
  827. customXmlParts: {
  828. conditions: {
  829. hosts: ["word"],
  830. reqs: [
  831. "set CustomXmlParts GE 1.1",
  832. "method CustomXmlNode.getNodesAsync",
  833. "method CustomXmlNode.getNodeValueAsync",
  834. "method CustomXmlNode.getXmlAsync",
  835. "method CustomXmlNode.setNodeValueAsync",
  836. "method CustomXmlNode.setXmlAsync",
  837. "method CustomXmlPart.addHandlerAsync",
  838. "method CustomXmlPart.deleteAsync",
  839. "method CustomXmlPart.getNodesAsync",
  840. "method CustomXmlPart.getXmlAsync",
  841. "method CustomXmlPart.removeHandlerAsync",
  842. "method CustomXmlPrefixMappings.addNamespaceAsync",
  843. "method CustomXmlPrefixMappings.getNamespaceAsync",
  844. "method CustomXmlPrefixMappings.getPrefixAsync"
  845. ]
  846. },
  847. partialConditions: true,
  848. contents: {
  849. addAsync: {
  850. conditions: {
  851. reqs: ["method CustomXmlParts.addAsync"]
  852. },
  853. value: function (xml, callback) {
  854. ///<summary>(Word Only) Asynchronously adds a new custom XML part to a file.</summary>
  855. ///<param name="xml" type="String">The XML to add to the newly created custom XML part.</param>
  856. ///<param name="callback" type="function" optional="true">A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.</param>
  857. var result = new Office._AsyncResult("addAsync");
  858. callback(result);
  859. }
  860. },
  861. getByIdAsync: {
  862. conditions: {
  863. reqs: ["method CustomXmlParts.getByIdAsync"]
  864. },
  865. value: function (id, callback) {
  866. ///<summary>(Word Only) Asynchronously gets the specified custom XML part by its id.</summary>
  867. ///<param name="id" type="String">The id of the custom XML part.</param>
  868. ///<param name="callback" type="function" optional="true">A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.</param>
  869. var result = new Office._AsyncResult("XMLgetByIdAsync");
  870. callback(result);
  871. }
  872. },
  873. getByNamespaceAsync: {
  874. conditions: {
  875. reqs: ["method CustomXmlParts.getByNamespaceAsync"]
  876. },
  877. value: function (ns, callback) {
  878. ///<summary>(Word Only) Asynchronously gets the specified custom XML part(s) by its namespace. </summary>
  879. ///<param name="ns" type="String"> The namespace to search.</param>
  880. ///<param name="callback" type="function" optional="true">A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.</param>
  881. var result = new Office._AsyncResult("getByNamespaceAsync");
  882. callback(result);
  883. }
  884. }
  885. }
  886. },
  887. getActiveViewAsync: {
  888. conditions: {
  889. hosts: ["ppt"],
  890. reqs: ["set ActiveView GE 1.1", "method Document.getActiveViewAsync"]
  891. },
  892. value: function(options, callback) {
  893. ///<summary>(PowerPoint only) Returns the current view of the presentation.</summary>
  894. ///<param name="options" type="Object" optional="true">
  895. /// Syntax example: {asyncContext:context}
  896. /// &#10; asyncContext: Object keeping state for the callback
  897. ///</param>
  898. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  899. Office._extractedCallback(arguments, 2, 2)(new Office._AsyncResult("getActiveViewAsync"));
  900. }
  901. },
  902. getFilePropertiesAsync: {
  903. conditions: {
  904. hosts: ["word", "ppt", "excel"],
  905. reqs: ["method Document.getFilePropertiesAsync"]
  906. },
  907. value: function(options, callback) {
  908. ///<summary>Gets file properties of the current document.</summary>
  909. ///<param name="options" type="Object" optional="true">
  910. /// Syntax example: {asyncContext:context}
  911. /// &#10; asyncContext: Object keeping state for the callback
  912. ///</param>
  913. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  914. Office._extractedCallback(arguments, 2, 2)(new Office._AsyncResult("getFilePropertiesAsync"));
  915. }
  916. },
  917. goToByIdAsync: {
  918. conditions: {
  919. hosts: ["excel", "ppt", "word"],
  920. reqs: ["method Document.goToByIdAsync"]
  921. },
  922. value: function(id, goToType, options, callback) {
  923. ///<summary>Goes to the specified object or location in the document.</summary>
  924. ///<param name="id" type="String or Number">The identifier of the object or location to go to.</param>
  925. ///<param name="goToType" type="Office.GoToType">The type of the location to go to.</param>
  926. ///<param name="options" type="Object" optional="true">
  927. /// Syntax example: {asyncContext:context}
  928. /// &#10; selectionMode: (Word only) Use Office.SelectionMode or text value.
  929. /// &#10; asyncContext: Object keeping state for the callback
  930. ///</param>
  931. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  932. Office._extractedCallback(arguments, 4, 2)(new Office._AsyncResult("goToByIdAsync"));
  933. }
  934. }
  935. }
  936. }
  937. Office._items = {
  938. context: {
  939. contents: {
  940. contentLanguage: {},
  941. displayLanguage: {},
  942. license: {
  943. contents: {
  944. value: {
  945. annotate: {
  946. //License summary.
  947. value: undefined
  948. }
  949. }
  950. }
  951. },
  952. document: {
  953. conditions: {
  954. hosts: ["not outlook; not outlookcompose"]
  955. },
  956. annotate: {
  957. // Office Document
  958. document: undefined
  959. },
  960. contents: Office._context_document
  961. },
  962. officeTheme: {
  963. conditions: {
  964. hosts: ["excel", "outlook", "powerpoint", "project", "word"]
  965. },
  966. annotate: {
  967. officeTheme: undefined
  968. },
  969. contents: {
  970. "bodyBackgroundColor": {},
  971. "bodyForegroundColor": {},
  972. "controlBackgroundColor": {},
  973. "controlForegroundColor": {}
  974. }
  975. },
  976. touchEnabled: {},
  977. commerceAllowed : {},
  978. requirements: {
  979. annotate: {
  980. // Checks whether a given requirement set is supported by the current host.
  981. requirements: undefined
  982. },
  983. contents: {
  984. isSetSupported: {
  985. value: function (name, minVersion) {
  986. ///<summary> Check if the specified requirement set is supported by the host Office application </summary>
  987. ///<param name="name" type="String"> Set name. e.g.: "MatrixBindings" </param>
  988. ///<param name="minVersion" type="Number"> The minimum required version </param>
  989. }
  990. },
  991. }
  992. },
  993. ui: {
  994. conditions: {
  995. reqs: ["set DialogAPI GE 1.1"]
  996. },
  997. annotate: {
  998. // Office UI
  999. ui: undefined
  1000. },
  1001. contents: Office._context_ui
  1002. }
  1003. }
  1004. },
  1005. initialize: {
  1006. value: function (reason) {
  1007. ///<summary> This method is called after the Office API was loaded.</summary>
  1008. ///<param name="reason" type="Office.InitializationReason" optional="true"> Indicates how the app was initialized</param>
  1009. }
  1010. },
  1011. useShortNamespace: {
  1012. value: function (useShortNamespace) {
  1013. ///<summary> Indicates if the large namespace for objects will be used or not.</summary>
  1014. ///<param name="useShortNamespace" type="boolean"> Indicates if 'true' that the short namespace will be used</param>
  1015. }
  1016. },
  1017. select: {
  1018. conditions: {
  1019. hosts: ["not outlook; not outlookcompose"]
  1020. },
  1021. value: function (expression, callback) {
  1022. ///<summary> Returns a promise of an object described in the expression. Callback is invoked only if method fails.</summary>
  1023. ///<param name="expression" type="string">The object to be retrieved. Example "bindings#BindingName", retrieves a binding promise for a binding named 'BindingName'</param>
  1024. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  1025. ///
  1026. var result = new Office._AsyncResult("select");
  1027. callback(result);
  1028. return (new Office._Binding());
  1029. }
  1030. },
  1031. TableData: {
  1032. conditions: {
  1033. hosts: ["word", "excel", "accesswebapp"],
  1034. reqs: ["set TableBindings GE 1.1"]
  1035. },
  1036. value: new Office._TableData()
  1037. }
  1038. };
  1039. /*Infrastructure***************************************************************/
  1040. Office._processItem = function (target, item, key, suppressConditionCheck) {
  1041. var conditionsFulfilled = suppressConditionCheck || Office._filterManager._checkCondition(item.conditions);
  1042. if (!(conditionsFulfilled || item.partialConditions)) {
  1043. return false;
  1044. }
  1045. suppressConditionCheck = suppressConditionCheck || conditionsFulfilled && item.partialConditions;
  1046. if (item.setup) {
  1047. item.setup();
  1048. }
  1049. if (item.metaOnly) {
  1050. return Office._processContents(target, item.contents, suppressConditionCheck);
  1051. }
  1052. key = item.name || key;
  1053. var areItemsAdded = false;
  1054. if (item.hasOwnProperty("value")) {
  1055. target[key] = item.value;
  1056. areItemsAdded = true;
  1057. } else if (typeof item.contents == "function") {
  1058. target[key] = item.contents();
  1059. areItemsAdded = true;
  1060. } else {
  1061. target[key] = target[key] || {};
  1062. if (Office._processContents(target[key], item.contents, suppressConditionCheck) || conditionsFulfilled) {
  1063. areItemsAdded = true;
  1064. } else {
  1065. delete target[key];
  1066. }
  1067. }
  1068. if (item.annotate) {
  1069. intellisense.annotate(target, item.annotate);
  1070. areItemsAdded = true;
  1071. }
  1072. return areItemsAdded;
  1073. }
  1074. Office._processContents = function (target, contents, suppressConditionCheck) {
  1075. if (typeof contents !== "object") {
  1076. return false;
  1077. }
  1078. var areItemsAdded = false;
  1079. for (var item in contents) {
  1080. areItemsAdded = Office._processItem(target, contents[item], item, suppressConditionCheck) || areItemsAdded;
  1081. }
  1082. return areItemsAdded;
  1083. }
  1084. Office._filterManager = (function () {
  1085. var filters = [];
  1086. return {
  1087. _checkCondition: function (condition) {
  1088. if (!condition)
  1089. return true;
  1090. var answer = true;
  1091. for (var i = 0; i < filters.length; i++) {
  1092. var filter = filters[i];
  1093. var conditionForThisFilter = condition[filter.identifier];
  1094. if (conditionForThisFilter && filter.isEnabled()) {
  1095. var thisFiltersAnswer = false;
  1096. for (var j = 0; j < conditionForThisFilter.length; j++) {
  1097. var productTerm = conditionForThisFilter[j].split(';');
  1098. var thisTermsAnswer = true;
  1099. for (var k = 0; k < productTerm.length; k++) {
  1100. var singleCondition = productTerm[k].toUpperCase().trim();
  1101. var invert = false;
  1102. if (singleCondition.indexOf("NOT") != -1) {
  1103. invert = true;
  1104. singleCondition = singleCondition.slice(singleCondition.indexOf(" ")).trim();
  1105. }
  1106. var result = filter.isConditionTrue(singleCondition, invert);
  1107. thisTermsAnswer = thisTermsAnswer && result;
  1108. }
  1109. thisFiltersAnswer = thisFiltersAnswer || thisTermsAnswer;
  1110. }
  1111. answer = answer && thisFiltersAnswer;
  1112. }
  1113. if (!answer)
  1114. break;
  1115. }
  1116. return answer;
  1117. },
  1118. _pushFilter: function (identifier, filteringDelegate, isEnabledDelegate) {
  1119. filters.push({
  1120. identifier: identifier,
  1121. isConditionTrue: filteringDelegate,
  1122. isEnabled: isEnabledDelegate
  1123. });
  1124. }
  1125. }
  1126. })();
  1127. Office._filterManager._pushFilter(
  1128. "hosts",
  1129. (function () {
  1130. var nameToMaskMapping = {
  1131. EXCEL: Office._ExcelMask,
  1132. WORD: Office._WordMask,
  1133. PROJECT: Office._ProjectMask,
  1134. OUTLOOK: Office._OutlookMask,
  1135. PPT: Office._PowerPointMask,
  1136. OUTLOOKCOMPOSE: Office._OutlookComposeMask,
  1137. ACCESSWEBAPP: Office._AccessWebAppMask
  1138. }
  1139. return function (condition, invert) {
  1140. var result = false;
  1141. if (nameToMaskMapping[condition] & Office._appContext) {
  1142. result = true;
  1143. }
  1144. return invert ? !result : result;
  1145. }
  1146. })(),
  1147. function () {
  1148. return typeof Office._appContext === "number";
  1149. }
  1150. );
  1151. Office._filterManager._pushFilter(
  1152. "reqs",
  1153. (function () {
  1154. function checkForMethod(methodName) {
  1155. return Office._methodContext && Office._methodContext[methodName];
  1156. }
  1157. function checkForSet(setDescriptor) {
  1158. setDescriptor = setDescriptor.split(" ");
  1159. var setName = setDescriptor[0].trim(),
  1160. setEntry = Office._setContext && setName in Office._setContext && (Office._setContext[setName] || "1.1");
  1161. if (!setEntry) {
  1162. return false;
  1163. }
  1164. if (setDescriptor.length === 1) {
  1165. return true;
  1166. } else {
  1167. var comparisonOperator = setDescriptor[1].trim(),
  1168. setVersion = setDescriptor[2].split("."),
  1169. setEntryVersion = setEntry.split("."),
  1170. difference = 0,
  1171. maxComponentCount = Math.max(setEntryVersion.length, setVersion.length);
  1172. for (var i = 0; i < maxComponentCount; i++) {
  1173. var leftInt = parseInt(setEntryVersion[i], 10) || 0,
  1174. rightInt = parseInt(setVersion[i], 10) || 0;
  1175. if (leftInt === rightInt) {
  1176. continue;
  1177. }
  1178. difference = leftInt - rightInt;
  1179. break;
  1180. }
  1181. switch (comparisonOperator) {
  1182. case "EQ":
  1183. return difference === 0;
  1184. case "GT":
  1185. return difference > 0;
  1186. case "LT":
  1187. return difference < 0;
  1188. case "GE":
  1189. return difference >= 0;
  1190. case "LE":
  1191. return difference <= 0;
  1192. default:
  1193. return false;
  1194. }
  1195. }
  1196. return false;
  1197. }
  1198. return function (condition, invert) {
  1199. var result = true;
  1200. var typeAgnosticCond = condition.slice(condition.indexOf(" ")).trim();
  1201. if (condition.indexOf("SET") === 0) {
  1202. result = checkForSet(typeAgnosticCond);
  1203. } else if (condition.indexOf("METHOD") === 0) {
  1204. result = checkForMethod(typeAgnosticCond);
  1205. }
  1206. return invert ? !result : result;
  1207. }
  1208. })(),
  1209. function () {
  1210. if (Office._showAll === false) {
  1211. return true;
  1212. }
  1213. return false;
  1214. }
  1215. )
  1216. Office._addEnumOnObject = function (enumName, enumObj, targetObj, conditions) {
  1217. Office._processItem(
  1218. targetObj,
  1219. {
  1220. conditions: conditions,
  1221. value: enumObj
  1222. },
  1223. enumName
  1224. );
  1225. }
  1226. /******************************************************************************/
  1227. // Setup Project
  1228. Office._processItem(Office, {
  1229. metaOnly: true,
  1230. conditions: {
  1231. hosts: ["project"]
  1232. },
  1233. contents: {
  1234. ProjectProjectFields: {
  1235. value: {
  1236. ///<field type="Number">CurrencySymbol</field>
  1237. CurrencySymbol: 1,
  1238. ///<field type="Number">CurrencySymbolPosition</field>
  1239. CurrencySymbolPosition: 2,
  1240. ///<field type="Number">DurationUnits</field>
  1241. DurationUnits: 3,
  1242. ///<field type="Number">GUID</field>
  1243. GUID: 4,
  1244. ///<field type="Number">Finish</field>
  1245. Finish: 5,
  1246. ///<field type="Number">Start</field>
  1247. Start: 6,
  1248. ///<field type="Number">ReadOnly</field>
  1249. ReadOnly: 7,
  1250. ///<field type="Number">VERSION</field>
  1251. VERSION: 8,
  1252. ///<field type="Number">WorkUnits</field>
  1253. WorkUnits: 9,
  1254. ///<field type="Number">ProjectServerUrl</field>
  1255. ProjectServerUrl: 10,
  1256. ///<field type="Number">WSSUrl</field>
  1257. WSSUrl: 11,
  1258. ///<field type="Number">WSSList</field>
  1259. WSSList: 12
  1260. }
  1261. },
  1262. ProjectViewTypes: {
  1263. value: {
  1264. ///<field type="Number">Gantt</field>
  1265. Gantt: 1,
  1266. ///<field type="Number">NetworkDiagram</field>
  1267. NetworkDiagram: 2,
  1268. ///<field type="Number">TaskDiagram</field>
  1269. TaskDiagram: 3,
  1270. ///<field type="Number">TaskForm</field>
  1271. TaskForm: 4,
  1272. ///<field type="Number">TaskSheet</field>
  1273. TaskSheet: 5,
  1274. ///<field type="Number">ResourceForm</field>
  1275. ResourceForm: 6,
  1276. ///<field type="Number">ResourceSheet</field>
  1277. ResourceSheet: 7,
  1278. ///<field type="Number">ResourceGraph</field>
  1279. ResourceGraph: 8,
  1280. ///<field type="Number">TeamPlanner</field>
  1281. TeamPlanner: 9,
  1282. ///<field type="Number">TaskDetails</field>
  1283. TaskDetails: 10,
  1284. ///<field type="Number">TaskNameForm</field>
  1285. TaskNameForm: 11,
  1286. ///<field type="Number">ResourceNames</field>
  1287. ResourceNames: 12,
  1288. ///<field type="Number">Calendar</field>
  1289. Calendar: 13,
  1290. ///<field type="Number">TaskUsage</field>
  1291. TaskUsage: 14,
  1292. ///<field type="Number">ResourceUsage</field>
  1293. ResourceUsage: 15,
  1294. ///<field type="Number">Timeline</field>
  1295. Timeline: 16,
  1296. ///<field type="Number">Drawing</field>
  1297. Drawing: 18,
  1298. ///<field type="Number">Resource Plan</field>
  1299. ResourcePlan: 19
  1300. }
  1301. },
  1302. ProjectTaskFields: {
  1303. value: {
  1304. ///<field type="Number">ActualCost</field>
  1305. ActualCost: 0,
  1306. ///<field type="Number">ActualDuration</field>
  1307. ActualDuration: 1,
  1308. ///<field type="Number">ActualFinish</field>
  1309. ActualFinish: 2,
  1310. ///<field type="Number">ActualOvertimeCost</field>
  1311. ActualOvertimeCost: 3,
  1312. ///<field type="Number">ActualOvertimeWork</field>
  1313. ActualOvertimeWork: 4,
  1314. ///<field type="Number">ActualStart</field>
  1315. ActualStart: 5,
  1316. ///<field type="Number">ActualWork</field>
  1317. ActualWork: 6,
  1318. ///<field type="Number">Text1</field>
  1319. Text1: 7,
  1320. ///<field type="Number">Text10</field>
  1321. Text10: 8,
  1322. ///<field type="Number">Finish10</field>
  1323. Finish10: 9,
  1324. ///<field type="Number">Start10</field>
  1325. Start10: 10,
  1326. ///<field type="Number">Text11</field>
  1327. Text11: 11,
  1328. ///<field type="Number">Text12</field>
  1329. Text12: 12,
  1330. ///<field type="Number">Text13</field>
  1331. Text13: 13,
  1332. ///<field type="Number">Text14</field>
  1333. Text14: 14,
  1334. ///<field type="Number">Text15</field>
  1335. Text15: 15,
  1336. ///<field type="Number">Text16</field>
  1337. Text16: 16,
  1338. ///<field type="Number">Text17</field>
  1339. Text17: 17,
  1340. ///<field type="Number">Text18</field>
  1341. Text18: 18,
  1342. ///<field type="Number">Text19</field>
  1343. Text19: 19,
  1344. ///<field type="Number">Finish1</field>
  1345. Finish1: 20,
  1346. ///<field type="Number">Start1</field>
  1347. Start1: 21,
  1348. ///<field type="Number">Text2</field>
  1349. Text2: 22,
  1350. ///<field type="Number">Text20</field>
  1351. Text20: 23,
  1352. ///<field type="Number">Text21</field>
  1353. Text21: 24,
  1354. ///<field type="Number">Text22</field>
  1355. Text22: 25,
  1356. ///<field type="Number">Text23</field>
  1357. Text23: 26,
  1358. ///<field type="Number">Text24</field>
  1359. Text24: 27,
  1360. ///<field type="Number">Text25</field>
  1361. Text25: 28,
  1362. ///<field type="Number">Text26</field>
  1363. Text26: 29,
  1364. ///<field type="Number">Text27</field>
  1365. Text27: 30,
  1366. ///<field type="Number">Text28</field>
  1367. Text28: 31,
  1368. ///<field type="Number">Text29</field>
  1369. Text29: 32,
  1370. ///<field type="Number">Finish2</field>
  1371. Finish2: 33,
  1372. ///<field type="Number">Start2</field>
  1373. Start2: 34,
  1374. ///<field type="Number">Text3</field>
  1375. Text3: 35,
  1376. ///<field type="Number">Text30</field>
  1377. Text30: 36,
  1378. ///<field type="Number">Finish3</field>
  1379. Finish3: 37,
  1380. ///<field type="Number">Start3</field>
  1381. Start3: 38,
  1382. ///<field type="Number">Text4</field>
  1383. Text4: 39,
  1384. ///<field type="Number">Finish4</field>
  1385. Finish4: 40,
  1386. ///<field type="Number">Start4</field>
  1387. Start4: 41,
  1388. ///<field type="Number">Text5</field>
  1389. Text5: 42,
  1390. ///<field type="Number">Finish5</field>
  1391. Finish5: 43,
  1392. ///<field type="Number">Start5</field>
  1393. Start5: 44,
  1394. ///<field type="Number">Text6</field>
  1395. Text6: 45,
  1396. ///<field type="Number">Finish6</field>
  1397. Finish6: 46,
  1398. ///<field type="Number">Start6</field>
  1399. Start6: 47,
  1400. ///<field type="Number">Text7</field>
  1401. Text7: 48,
  1402. ///<field type="Number">Finish7</field>
  1403. Finish7: 49,
  1404. ///<field type="Number">Start7</field>
  1405. Start7: 50,
  1406. ///<field type="Number">Text8</field>
  1407. Text8: 51,
  1408. ///<field type="Number">Finish8</field>
  1409. Finish8: 52,
  1410. ///<field type="Number">Start8</field>
  1411. Start8: 53,
  1412. ///<field type="Number">Text9</field>
  1413. Text9: 54,
  1414. ///<field type="Number">Finish9</field>
  1415. Finish9: 55,
  1416. ///<field type="Number">Start9</field>
  1417. Start9: 56,
  1418. ///<field type="Number">Baseline10BudgetCost</field>
  1419. Baseline10BudgetCost: 57,
  1420. ///<field type="Number">Baseline10BudgetWork</field>
  1421. Baseline10BudgetWork: 58,
  1422. ///<field type="Number">Baseline10Cost</field>
  1423. Baseline10Cost: 59,
  1424. ///<field type="Number">Baseline10Duration</field>
  1425. Baseline10Duration: 60,
  1426. ///<field type="Number">Baseline10Finish</field>
  1427. Baseline10Finish: 61,
  1428. ///<field type="Number">Baseline10FixedCost</field>
  1429. Baseline10FixedCost: 62,
  1430. ///<field type="Number">Baseline10FixedCostAccrual</field>
  1431. Baseline10FixedCostAccrual: 63,
  1432. ///<field type="Number">Baseline10Start</field>
  1433. Baseline10Start: 64,
  1434. ///<field type="Number">Baseline10Work</field>
  1435. Baseline10Work: 65,
  1436. ///<field type="Number">Baseline1BudgetCost</field>
  1437. Baseline1BudgetCost: 66,
  1438. ///<field type="Number">Baseline1BudgetWork</field>
  1439. Baseline1BudgetWork: 67,
  1440. ///<field type="Number">Baseline1Cost</field>
  1441. Baseline1Cost: 68,
  1442. ///<field type="Number">Baseline1Duration</field>
  1443. Baseline1Duration: 69,
  1444. ///<field type="Number">Baseline1Finish</field>
  1445. Baseline1Finish: 70,
  1446. ///<field type="Number">Baseline1FixedCost</field>
  1447. Baseline1FixedCost: 71,
  1448. ///<field type="Number">Baseline1FixedCostAccrual</field>
  1449. Baseline1FixedCostAccrual: 72,
  1450. ///<field type="Number">Baseline1Start</field>
  1451. Baseline1Start: 73,
  1452. ///<field type="Number">Baseline1Work</field>
  1453. Baseline1Work: 74,
  1454. ///<field type="Number">Baseline2BudgetCost</field>
  1455. Baseline2BudgetCost: 75,
  1456. ///<field type="Number">Baseline2BudgetWork</field>
  1457. Baseline2BudgetWork: 76,
  1458. ///<field type="Number">Baseline2Cost</field>
  1459. Baseline2Cost: 77,
  1460. ///<field type="Number">Baseline2Duration</field>
  1461. Baseline2Duration: 78,
  1462. ///<field type="Number">Baseline2Finish</field>
  1463. Baseline2Finish: 79,
  1464. ///<field type="Number">Baseline2FixedCost</field>
  1465. Baseline2FixedCost: 80,
  1466. ///<field type="Number">Baseline2FixedCostAccrual</field>
  1467. Baseline2FixedCostAccrual: 81,
  1468. ///<field type="Number">Baseline2Start</field>
  1469. Baseline2Start: 82,
  1470. ///<field type="Number">Baseline2Work</field>
  1471. Baseline2Work: 83,
  1472. ///<field type="Number">Baseline3BudgetCost</field>
  1473. Baseline3BudgetCost: 84,
  1474. ///<field type="Number">Baseline3BudgetWork</field>
  1475. Baseline3BudgetWork: 85,
  1476. ///<field type="Number">Baseline3Cost</field>
  1477. Baseline3Cost: 86,
  1478. ///<field type="Number">Baseline3Duration</field>
  1479. Baseline3Duration: 87,
  1480. ///<field type="Number">Baseline3Finish</field>
  1481. Baseline3Finish: 88,
  1482. ///<field type="Number">Baseline3FixedCost</field>
  1483. Baseline3FixedCost: 89,
  1484. ///<field type="Number">Baseline3FixedCostAccrual</field>
  1485. Baseline3FixedCostAccrual: 90,
  1486. ///<field type="Number">Basline3Start</field>
  1487. Basline3Start: 91,
  1488. ///<field type="Number">Baseline3Work</field>
  1489. Baseline3Work: 92,
  1490. ///<field type="Number">Baseline4BudgetCost</field>
  1491. Baseline4BudgetCost: 93,
  1492. ///<field type="Number">Baseline4BudgetWork</field>
  1493. Baseline4BudgetWork: 94,
  1494. ///<field type="Number">Baseline4Cost</field>
  1495. Baseline4Cost: 95,
  1496. ///<field type="Number">Baseline4Duration</field>
  1497. Baseline4Duration: 96,
  1498. ///<field type="Number">Baseline4Finish</field>
  1499. Baseline4Finish: 97,
  1500. ///<field type="Number">Baseline4FixedCost</field>
  1501. Baseline4FixedCost: 98,
  1502. ///<field type="Number">Baseline4FixedCostAccrual</field>
  1503. Baseline4FixedCostAccrual: 99,
  1504. ///<field type="Number">Baseline4Start</field>
  1505. Baseline4Start: 100,
  1506. ///<field type="Number">Baseline4Work</field>
  1507. Baseline4Work: 101,
  1508. ///<field type="Number">Baseline5BudgetCost</field>
  1509. Baseline5BudgetCost: 102,
  1510. ///<field type="Number">Baseline5BudgetWork</field>
  1511. Baseline5BudgetWork: 103,
  1512. ///<field type="Number">Baseline5Cost</field>
  1513. Baseline5Cost: 104,
  1514. ///<field type="Number">Baseline5Duration</field>
  1515. Baseline5Duration: 105,
  1516. ///<field type="Number">Baseline5Finish</field>
  1517. Baseline5Finish: 106,
  1518. ///<field type="Number">Baseline5FixedCost</field>
  1519. Baseline5FixedCost: 107,
  1520. ///<field type="Number">Baseline5FixedCostAccrual</field>
  1521. Baseline5FixedCostAccrual: 108,
  1522. ///<field type="Number">Baseline5Start</field>
  1523. Baseline5Start: 109,
  1524. ///<field type="Number">Baseline5Work</field>
  1525. Baseline5Work: 110,
  1526. ///<field type="Number">Baseline6BudgetCost</field>
  1527. Baseline6BudgetCost: 111,
  1528. ///<field type="Number">Baseline6BudgetWork</field>
  1529. Baseline6BudgetWork: 112,
  1530. ///<field type="Number">Baseline6Cost</field>
  1531. Baseline6Cost: 113,
  1532. ///<field type="Number">Baseline6Duration</field>
  1533. Baseline6Duration: 114,
  1534. ///<field type="Number">Baseline6Finish</field>
  1535. Baseline6Finish: 115,
  1536. ///<field type="Number">Baseline6FixedCost</field>
  1537. Baseline6FixedCost: 116,
  1538. ///<field type="Number">Baseline6FixedCostAccrual</field>
  1539. Baseline6FixedCostAccrual: 117,
  1540. ///<field type="Number">Baseline6Start</field>
  1541. Baseline6Start: 118,
  1542. ///<field type="Number">Baseline6Work</field>
  1543. Baseline6Work: 119,
  1544. ///<field type="Number">Baseline7BudgetCost</field>
  1545. Baseline7BudgetCost: 120,
  1546. ///<field type="Number">Baseline7BudgetWork</field>
  1547. Baseline7BudgetWork: 121,
  1548. ///<field type="Number">Baseline7Cost</field>
  1549. Baseline7Cost: 122,
  1550. ///<field type="Number">Baseline7Duration</field>
  1551. Baseline7Duration: 123,
  1552. ///<field type="Number">Baseline7Finish</field>
  1553. Baseline7Finish: 124,
  1554. ///<field type="Number">Baseline7FixedCost</field>
  1555. Baseline7FixedCost: 125,
  1556. ///<field type="Number">Baseline7FixedCostAccrual</field>
  1557. Baseline7FixedCostAccrual: 126,
  1558. ///<field type="Number">Baseline7Start</field>
  1559. Baseline7Start: 127,
  1560. ///<field type="Number">Baseline7Work</field>
  1561. Baseline7Work: 128,
  1562. ///<field type="Number">Baseline8BudgetCost</field>
  1563. Baseline8BudgetCost: 129,
  1564. ///<field type="Number">Baseline8BudgetWork</field>
  1565. Baseline8BudgetWork: 130,
  1566. ///<field type="Number">Baseline8Cost</field>
  1567. Baseline8Cost: 131,
  1568. ///<field type="Number">Baseline8Duration</field>
  1569. Baseline8Duration: 132,
  1570. ///<field type="Number">Baseline8Finish</field>
  1571. Baseline8Finish: 133,
  1572. ///<field type="Number">Baseline8FixedCost</field>
  1573. Baseline8FixedCost: 134,
  1574. ///<field type="Number">Baseline8FixedCostAccrual</field>
  1575. Baseline8FixedCostAccrual: 135,
  1576. ///<field type="Number">Baseline8Start</field>
  1577. Baseline8Start: 136,
  1578. ///<field type="Number">Baseline8Work</field>
  1579. Baseline8Work: 137,
  1580. ///<field type="Number">Baseline9BudgetCost</field>
  1581. Baseline9BudgetCost: 138,
  1582. ///<field type="Number">Baseline9BudgetWork</field>
  1583. Baseline9BudgetWork: 139,
  1584. ///<field type="Number">Baseline9Cost</field>
  1585. Baseline9Cost: 140,
  1586. ///<field type="Number">Baseline9Duration</field>
  1587. Baseline9Duration: 141,
  1588. ///<field type="Number">Baseline9Finish</field>
  1589. Baseline9Finish: 142,
  1590. ///<field type="Number">Baseline9FixedCost</field>
  1591. Baseline9FixedCost: 143,
  1592. ///<field type="Number">Baseline9FixedCostAccrual</field>
  1593. Baseline9FixedCostAccrual: 144,
  1594. ///<field type="Number">Baseline9Start</field>
  1595. Baseline9Start: 145,
  1596. ///<field type="Number">Baseline9Work</field>
  1597. Baseline9Work: 146,
  1598. ///<field type="Number">BaselineBudgetCost</field>
  1599. BaselineBudgetCost: 147,
  1600. ///<field type="Number">BaselineBudgetWork</field>
  1601. BaselineBudgetWork: 148,
  1602. ///<field type="Number">BaselineCost</field>
  1603. BaselineCost: 149,
  1604. ///<field type="Number">BaselineDuration</field>
  1605. BaselineDuration: 150,
  1606. ///<field type="Number">BaselineFinish</field>
  1607. BaselineFinish: 151,
  1608. ///<field type="Number">BaselineFixedCost</field>
  1609. BaselineFixedCost: 152,
  1610. ///<field type="Number">BaselineFixedCostAccrual</field>
  1611. BaselineFixedCostAccrual: 153,
  1612. ///<field type="Number">BaselineStart</field>
  1613. BaselineStart: 154,
  1614. ///<field type="Number">BaselineWork</field>
  1615. BaselineWork: 155,
  1616. ///<field type="Number">BudgetCost</field>
  1617. BudgetCost: 156,
  1618. ///<field type="Number">BudgetFixedCost</field>
  1619. BudgetFixedCost: 157,
  1620. ///<field type="Number">BudgetFixedWork</field>
  1621. BudgetFixedWork: 158,
  1622. ///<field type="Number">BudgetWork</field>
  1623. BudgetWork: 159,
  1624. ///<field type="Number">TaskCalendarGUID</field>
  1625. TaskCalendarGUID: 160,
  1626. ///<field type="Number">ConstraintDate</field>
  1627. ConstraintDate: 161,
  1628. ///<field type="Number">ConstraintType</field>
  1629. ConstraintType: 162,
  1630. ///<field type="Number">Cost1</field>
  1631. Cost1: 163,
  1632. ///<field type="Number">Cost10</field>
  1633. Cost10: 164,
  1634. ///<field type="Number">Cost2</field>
  1635. Cost2: 165,
  1636. ///<field type="Number">Cost3</field>
  1637. Cost3: 166,
  1638. ///<field type="Number">Cost4</field>
  1639. Cost4: 167,
  1640. ///<field type="Number">Cost5</field>
  1641. Cost5: 168,
  1642. ///<field type="Number">Cost6</field>
  1643. Cost6: 169,
  1644. ///<field type="Number">Cost7</field>
  1645. Cost7: 170,
  1646. ///<field type="Number">Cost8</field>
  1647. Cost8: 171,
  1648. ///<field type="Number">Cost9</field>
  1649. Cost9: 172,
  1650. ///<field type="Number">Date1</field>
  1651. Date1: 173,
  1652. ///<field type="Number">Date10</field>
  1653. Date10: 174,
  1654. ///<field type="Number">Date2</field>
  1655. Date2: 175,
  1656. ///<field type="Number">Date3</field>
  1657. Date3: 176,
  1658. ///<field type="Number">Date4</field>
  1659. Date4: 177,
  1660. ///<field type="Number">Date5</field>
  1661. Date5: 178,
  1662. ///<field type="Number">Date6</field>
  1663. Date6: 179,
  1664. ///<field type="Number">Date7</field>
  1665. Date7: 180,
  1666. ///<field type="Number">Date8</field>
  1667. Date8: 181,
  1668. ///<field type="Number">Date9</field>
  1669. Date9: 182,
  1670. ///<field type="Number">Deadline</field>
  1671. Deadline: 183,
  1672. ///<field type="Number">Duration1</field>
  1673. Duration1: 184,
  1674. ///<field type="Number">Duration10</field>
  1675. Duration10: 185,
  1676. ///<field type="Number">Duration2</field>
  1677. Duration2: 186,
  1678. ///<field type="Number">Duration3</field>
  1679. Duration3: 187,
  1680. ///<field type="Number">Duration4</field>
  1681. Duration4: 188,
  1682. ///<field type="Number">Duration5</field>
  1683. Duration5: 189,
  1684. ///<field type="Number">Duration6</field>
  1685. Duration6: 190,
  1686. ///<field type="Number">Duration7</field>
  1687. Duration7: 191,
  1688. ///<field type="Number">Duration8</field>
  1689. Duration8: 192,
  1690. ///<field type="Number">Duration9</field>
  1691. Duration9: 193,
  1692. ///<field type="Number">Duration</field>
  1693. Duration: 194,
  1694. ///<field type="Number">EarnedValueMethod</field>
  1695. EarnedValueMethod: 195,
  1696. ///<field type="Number">FinishSlack</field>
  1697. FinishSlack: 196,
  1698. ///<field type="Number">FixedCost</field>
  1699. FixedCost: 197,
  1700. ///<field type="Number">FixedCostAccrual</field>
  1701. FixedCostAccrual: 198,
  1702. ///<field type="Number">Flag10</field>
  1703. Flag10: 199,
  1704. ///<field type="Number">Flag1</field>
  1705. Flag1: 200,
  1706. ///<field type="Number">Flag11</field>
  1707. Flag11: 201,
  1708. ///<field type="Number">Flag12</field>
  1709. Flag12: 202,
  1710. ///<field type="Number">Flag13</field>
  1711. Flag13: 203,
  1712. ///<field type="Number">Flag14</field>
  1713. Flag14: 204,
  1714. ///<field type="Number">Flag15</field>
  1715. Flag15: 205,
  1716. ///<field type="Number">Flag16</field>
  1717. Flag16: 206,
  1718. ///<field type="Number">Flag17</field>
  1719. Flag17: 207,
  1720. ///<field type="Number">Flag18</field>
  1721. Flag18: 208,
  1722. ///<field type="Number">Flag19</field>
  1723. Flag19: 209,
  1724. ///<field type="Number">Flag2</field>
  1725. Flag2: 210,
  1726. ///<field type="Number">Flag20</field>
  1727. Flag20: 211,
  1728. ///<field type="Number">Flag3</field>
  1729. Flag3: 212,
  1730. ///<field type="Number">Flag4</field>
  1731. Flag4: 213,
  1732. ///<field type="Number">Flag5</field>
  1733. Flag5: 214,
  1734. ///<field type="Number">Flag6</field>
  1735. Flag6: 215,
  1736. ///<field type="Number">Flag7</field>
  1737. Flag7: 216,
  1738. ///<field type="Number">Flag8</field>
  1739. Flag8: 217,
  1740. ///<field type="Number">Flag9</field>
  1741. Flag9: 218,
  1742. ///<field type="Number">FreeSlack</field>
  1743. FreeSlack: 219,
  1744. ///<field type="Number">HasRollupSubTasks</field>
  1745. HasRollupSubTasks: 220,
  1746. ///<field type="Number">ID</field>
  1747. ID: 221,
  1748. ///<field type="Number">Name</field>
  1749. Name: 222,
  1750. ///<field type="Number">Notes</field>
  1751. Notes: 223,
  1752. ///<field type="Number">Number1</field>
  1753. Number1: 224,
  1754. ///<field type="Number">Number10</field>
  1755. Number10: 225,
  1756. ///<field type="Number">Number11</field>
  1757. Number11: 226,
  1758. ///<field type="Number">Number12</field>
  1759. Number12: 227,
  1760. ///<field type="Number">Number13</field>
  1761. Number13: 228,
  1762. ///<field type="Number">Number14</field>
  1763. Number14: 229,
  1764. ///<field type="Number">Number15</field>
  1765. Number15: 230,
  1766. ///<field type="Number">Number16</field>
  1767. Number16: 231,
  1768. ///<field type="Number">Number17</field>
  1769. Number17: 232,
  1770. ///<field type="Number">Number18</field>
  1771. Number18: 233,
  1772. ///<field type="Number">Number19</field>
  1773. Number19: 234,
  1774. ///<field type="Number">Number2</field>
  1775. Number2: 235,
  1776. ///<field type="Number">Number20</field>
  1777. Number20: 236,
  1778. ///<field type="Number">Number3</field>
  1779. Number3: 237,
  1780. ///<field type="Number">Number4</field>
  1781. Number4: 238,
  1782. ///<field type="Number">Number5</field>
  1783. Number5: 239,
  1784. ///<field type="Number">Number6</field>
  1785. Number6: 240,
  1786. ///<field type="Number">Number7</field>
  1787. Number7: 241,
  1788. ///<field type="Number">Number8</field>
  1789. Number8: 242,
  1790. ///<field type="Number">Number9</field>
  1791. Number9: 243,
  1792. ///<field type="Number">ScheduledDuration</field>
  1793. ScheduledDuration: 244,
  1794. ///<field type="Number">ScheduledFinish</field>
  1795. ScheduledFinish: 245,
  1796. ///<field type="Number">ScheduledStart</field>
  1797. ScheduledStart: 246,
  1798. ///<field type="Number">OutlineLevel</field>
  1799. OutlineLevel: 247,
  1800. ///<field type="Number">OvertimeCost</field>
  1801. OvertimeCost: 248,
  1802. ///<field type="Number">OvertimeWork</field>
  1803. OvertimeWork: 249,
  1804. ///<field type="Number">PercentComplete</field>
  1805. PercentComplete: 250,
  1806. ///<field type="Number">PercentWorkComplete</field>
  1807. PercentWorkComplete: 251,
  1808. ///<field type="Number">Predecessors</field>
  1809. Predecessors: 252,
  1810. ///<field type="Number">PreleveledFinish</field>
  1811. PreleveledFinish: 253,
  1812. ///<field type="Number">PreleveledStart</field>
  1813. PreleveledStart: 254,
  1814. ///<field type="Number">Priority</field>
  1815. Priority: 255,
  1816. ///<field type="Number">Active</field>
  1817. Active: 256,
  1818. ///<field type="Number">Critical</field>
  1819. Critical: 257,
  1820. ///<field type="Number">Milestone</field>
  1821. Milestone: 258,
  1822. ///<field type="Number">Overallocated</field>
  1823. Overallocated: 259,
  1824. ///<field type="Number">IsRollup</field>
  1825. IsRollup: 260,
  1826. ///<field type="Number">Summary</field>
  1827. Summary: 261,
  1828. ///<field type="Number">RegularWork</field>
  1829. RegularWork: 262,
  1830. ///<field type="Number">RemainingCost</field>
  1831. RemainingCost: 263,
  1832. ///<field type="Number">RemainingDuration</field>
  1833. RemainingDuration: 264,
  1834. ///<field type="Number">RemainingOvertimeCost</field>
  1835. RemainingOvertimeCost: 265,
  1836. ///<field type="Number">RemainingWork</field>
  1837. RemainingWork: 266,
  1838. ///<field type="Number">ResourceNames</field>
  1839. ResourceNames: 267,
  1840. ///<field type="Number">ResourceNames</field>
  1841. ResourceNames: 268,
  1842. ///<field type="Number">Cost</field>
  1843. Cost: 269,
  1844. ///<field type="Number">Finish</field>
  1845. Finish: 270,
  1846. ///<field type="Number">Start</field>
  1847. Start: 271,
  1848. ///<field type="Number">Work</field>
  1849. Work: 272,
  1850. ///<field type="Number">StartSlack</field>
  1851. StartSlack: 273,
  1852. ///<field type="Number">Status</field>
  1853. Status: 274,
  1854. ///<field type="Number">Successors</field>
  1855. Successors: 275,
  1856. ///<field type="Number">StatusManager</field>
  1857. StatusManager: 276,
  1858. ///<field type="Number">TotalSlack</field>
  1859. TotalSlack: 277,
  1860. ///<field type="Number">TaskGUID</field>
  1861. TaskGUID: 278,
  1862. ///<field type="Number">Type</field>
  1863. Type: 279,
  1864. ///<field type="Number">WBS</field>
  1865. WBS: 280,
  1866. ///<field type="Number">WBSPREDECESSORS</field>
  1867. WBSPREDECESSORS: 281,
  1868. ///<field type="Number">WBSSUCCESSORS</field>
  1869. WBSSUCCESSORS: 282,
  1870. ///<field type="Number">WSSID</field>
  1871. WSSID: 283
  1872. }
  1873. },
  1874. ProjectResourceFields: {
  1875. value: {
  1876. ///<field type="Number">Accrual</field>
  1877. Accrual: 0,
  1878. ///<field type="Number">ActualCost</field>
  1879. ActualCost: 1,
  1880. ///<field type="Number">ActualOvertimeCost</field>
  1881. ActualOvertimeCost: 2,
  1882. ///<field type="Number">ActualOvertimeWork</field>
  1883. ActualOvertimeWork: 3,
  1884. ///<field type="Number">ActualOvertimeWorkProtected</field>
  1885. ActualOvertimeWorkProtected: 4,
  1886. ///<field type="Number">ActualWork</field>
  1887. ActualWork: 5,
  1888. ///<field type="Number">ActualWorkProtected</field>
  1889. ActualWorkProtected: 6,
  1890. ///<field type="Number">BaseCalendar</field>
  1891. BaseCalendar: 7,
  1892. ///<field type="Number">Baseline10BudgetCost</field>
  1893. Baseline10BudgetCost: 8,
  1894. ///<field type="Number">Baseline10BudgetWork</field>
  1895. Baseline10BudgetWork: 9,
  1896. ///<field type="Number">Baseline10Cost</field>
  1897. Baseline10Cost: 10,
  1898. ///<field type="Number">Baseline10Work</field>
  1899. Baseline10Work: 11,
  1900. ///<field type="Number">Baseline1BudgetCost</field>
  1901. Baseline1BudgetCost: 12,
  1902. ///<field type="Number">Baseline1BudgetWork</field>
  1903. Baseline1BudgetWork: 13,
  1904. ///<field type="Number">Baseline1Cost</field>
  1905. Baseline1Cost: 14,
  1906. ///<field type="Number">Baseline1Work</field>
  1907. Baseline1Work: 15,
  1908. ///<field type="Number">Baseline2BudgetCost</field>
  1909. Baseline2BudgetCost: 16,
  1910. ///<field type="Number">Baseline2BudgetWork</field>
  1911. Baseline2BudgetWork: 17,
  1912. ///<field type="Number">Baseline2Cost</field>
  1913. Baseline2Cost: 18,
  1914. ///<field type="Number">Baseline2Work</field>
  1915. Baseline2Work: 19,
  1916. ///<field type="Number">Baseline3BudgetCost</field>
  1917. Baseline3BudgetCost: 20,
  1918. ///<field type="Number">Baseline3BudgetWork</field>
  1919. Baseline3BudgetWork: 21,
  1920. ///<field type="Number">Baseline3Cost</field>
  1921. Baseline3Cost: 22,
  1922. ///<field type="Number">Baseline3Work</field>
  1923. Baseline3Work: 23,
  1924. ///<field type="Number">Baseline4BudgetCost</field>
  1925. Baseline4BudgetCost: 24,
  1926. ///<field type="Number">Baseline4BudgetWork</field>
  1927. Baseline4BudgetWork: 25,
  1928. ///<field type="Number">Baseline4Cost</field>
  1929. Baseline4Cost: 26,
  1930. ///<field type="Number">Baseline4Work</field>
  1931. Baseline4Work: 27,
  1932. ///<field type="Number">Baseline5BudgetCost</field>
  1933. Baseline5BudgetCost: 28,
  1934. ///<field type="Number">Baseline5BudgetWork</field>
  1935. Baseline5BudgetWork: 29,
  1936. ///<field type="Number">Baseline5Cost</field>
  1937. Baseline5Cost: 30,
  1938. ///<field type="Number">Baseline5Work</field>
  1939. Baseline5Work: 31,
  1940. ///<field type="Number">Baseline6BudgetCost</field>
  1941. Baseline6BudgetCost: 32,
  1942. ///<field type="Number">Baseline6BudgetWork</field>
  1943. Baseline6BudgetWork: 33,
  1944. ///<field type="Number">Baseline6Cost</field>
  1945. Baseline6Cost: 34,
  1946. ///<field type="Number">Baseline6Work</field>
  1947. Baseline6Work: 35,
  1948. ///<field type="Number">Baseline7BudgetCost</field>
  1949. Baseline7BudgetCost: 36,
  1950. ///<field type="Number">Baseline7BudgetWork</field>
  1951. Baseline7BudgetWork: 37,
  1952. ///<field type="Number">Baseline7Cost</field>
  1953. Baseline7Cost: 38,
  1954. ///<field type="Number">Baseline7Work</field>
  1955. Baseline7Work: 39,
  1956. ///<field type="Number">Baseline8BudgetCost</field>
  1957. Baseline8BudgetCost: 40,
  1958. ///<field type="Number">Baseline8BudgetWork</field>
  1959. Baseline8BudgetWork: 41,
  1960. ///<field type="Number">Baseline8Cost</field>
  1961. Baseline8Cost: 42,
  1962. ///<field type="Number">Baseline8Work</field>
  1963. Baseline8Work: 43,
  1964. ///<field type="Number">Baseline9BudgetCost</field>
  1965. Baseline9BudgetCost: 44,
  1966. ///<field type="Number">Baseline9BudgetWork</field>
  1967. Baseline9BudgetWork: 45,
  1968. ///<field type="Number">Baseline9Cost</field>
  1969. Baseline9Cost: 46,
  1970. ///<field type="Number">Baseline9Work</field>
  1971. Baseline9Work: 47,
  1972. ///<field type="Number">BaselineBudgetCost</field>
  1973. BaselineBudgetCost: 48,
  1974. ///<field type="Number">BaselineBudgetWork</field>
  1975. BaselineBudgetWork: 49,
  1976. ///<field type="Number">BaselineCost</field>
  1977. BaselineCost: 50,
  1978. ///<field type="Number">BaselineWork</field>
  1979. BaselineWork: 51,
  1980. ///<field type="Number">BudgetCost</field>
  1981. BudgetCost: 52,
  1982. ///<field type="Number">BudgetWork</field>
  1983. BudgetWork: 53,
  1984. ///<field type="Number">ResourceCalendarGUID</field>
  1985. ResourceCalendarGUID: 54,
  1986. ///<field type="Number">Code</field>
  1987. Code: 55,
  1988. ///<field type="Number">Cost1</field>
  1989. Cost1: 56,
  1990. ///<field type="Number">Cost10</field>
  1991. Cost10: 57,
  1992. ///<field type="Number">Cost2</field>
  1993. Cost2: 58,
  1994. ///<field type="Number">Cost3</field>
  1995. Cost3: 59,
  1996. ///<field type="Number">Cost4</field>
  1997. Cost4: 60,
  1998. ///<field type="Number">Cost5</field>
  1999. Cost5: 61,
  2000. ///<field type="Number">Cost6</field>
  2001. Cost6: 62,
  2002. ///<field type="Number">Cost7</field>
  2003. Cost7: 63,
  2004. ///<field type="Number">Cost8</field>
  2005. Cost8: 64,
  2006. ///<field type="Number">Cost9</field>
  2007. Cost9: 65,
  2008. ///<field type="Number">ResourceCreationDate</field>
  2009. ResourceCreationDate: 66,
  2010. ///<field type="Number">Date1</field>
  2011. Date1: 67,
  2012. ///<field type="Number">Date10</field>
  2013. Date10: 68,
  2014. ///<field type="Number">Date2</field>
  2015. Date2: 69,
  2016. ///<field type="Number">Date3</field>
  2017. Date3: 70,
  2018. ///<field type="Number">Date4</field>
  2019. Date4: 71,
  2020. ///<field type="Number">Date5</field>
  2021. Date5: 72,
  2022. ///<field type="Number">Date6</field>
  2023. Date6: 73,
  2024. ///<field type="Number">Date7</field>
  2025. Date7: 74,
  2026. ///<field type="Number">Date8</field>
  2027. Date8: 75,
  2028. ///<field type="Number">Date9</field>
  2029. Date9: 76,
  2030. ///<field type="Number">Duration1</field>
  2031. Duration1: 77,
  2032. ///<field type="Number">Duration10</field>
  2033. Duration10: 78,
  2034. ///<field type="Number">Duration2</field>
  2035. Duration2: 79,
  2036. ///<field type="Number">Duration3</field>
  2037. Duration3: 80,
  2038. ///<field type="Number">Duration4</field>
  2039. Duration4: 81,
  2040. ///<field type="Number">Duration5</field>
  2041. Duration5: 82,
  2042. ///<field type="Number">Duration6</field>
  2043. Duration6: 83,
  2044. ///<field type="Number">Duration7</field>
  2045. Duration7: 84,
  2046. ///<field type="Number">Duration8</field>
  2047. Duration8: 85,
  2048. ///<field type="Number">Duration9</field>
  2049. Duration9: 86,
  2050. ///<field type="Number">Email</field>
  2051. Email: 87,
  2052. ///<field type="Number">End</field>
  2053. End: 88,
  2054. ///<field type="Number">Finish1</field>
  2055. Finish1: 89,
  2056. ///<field type="Number">Finish10</field>
  2057. Finish10: 90,
  2058. ///<field type="Number">Finish2</field>
  2059. Finish2: 91,
  2060. ///<field type="Number">Finish3</field>
  2061. Finish3: 92,
  2062. ///<field type="Number">Finish4</field>
  2063. Finish4: 93,
  2064. ///<field type="Number">Finish5</field>
  2065. Finish5: 94,
  2066. ///<field type="Number">Finish6</field>
  2067. Finish6: 95,
  2068. ///<field type="Number">Finish7</field>
  2069. Finish7: 96,
  2070. ///<field type="Number">Finish8</field>
  2071. Finish8: 97,
  2072. ///<field type="Number">Finish9</field>
  2073. Finish9: 98,
  2074. ///<field type="Number">Flag10</field>
  2075. Flag10: 99,
  2076. ///<field type="Number">Flag1</field>
  2077. Flag1: 100,
  2078. ///<field type="Number">Flag11</field>
  2079. Flag11: 101,
  2080. ///<field type="Number">Flag12</field>
  2081. Flag12: 102,
  2082. ///<field type="Number">Flag13</field>
  2083. Flag13: 103,
  2084. ///<field type="Number">Flag14</field>
  2085. Flag14: 104,
  2086. ///<field type="Number">Flag15</field>
  2087. Flag15: 105,
  2088. ///<field type="Number">Flag16</field>
  2089. Flag16: 106,
  2090. ///<field type="Number">Flag17</field>
  2091. Flag17: 107,
  2092. ///<field type="Number">Flag18</field>
  2093. Flag18: 108,
  2094. ///<field type="Number">Flag19</field>
  2095. Flag19: 109,
  2096. ///<field type="Number">Flag2</field>
  2097. Flag2: 110,
  2098. ///<field type="Number">Flag20</field>
  2099. Flag20: 111,
  2100. ///<field type="Number">Flag3</field>
  2101. Flag3: 112,
  2102. ///<field type="Number">Flag4</field>
  2103. Flag4: 113,
  2104. ///<field type="Number">Flag5</field>
  2105. Flag5: 114,
  2106. ///<field type="Number">Flag6</field>
  2107. Flag6: 115,
  2108. ///<field type="Number">Flag7</field>
  2109. Flag7: 116,
  2110. ///<field type="Number">Flag8</field>
  2111. Flag8: 117,
  2112. ///<field type="Number">Flag9</field>
  2113. Flag9: 118,
  2114. ///<field type="Number">Group</field>
  2115. Group: 119,
  2116. ///<field type="Number">Units</field>
  2117. Units: 120,
  2118. ///<field type="Number">Name</field>
  2119. Name: 121,
  2120. ///<field type="Number">Notes</field>
  2121. Notes: 122,
  2122. ///<field type="Number">Number1</field>
  2123. Number1: 123,
  2124. ///<field type="Number">Number10</field>
  2125. Number10: 124,
  2126. ///<field type="Number">Number11</field>
  2127. Number11: 125,
  2128. ///<field type="Number">Number12</field>
  2129. Number12: 126,
  2130. ///<field type="Number">Number13</field>
  2131. Number13: 127,
  2132. ///<field type="Number">Number14</field>
  2133. Number14: 128,
  2134. ///<field type="Number">Number15</field>
  2135. Number15: 129,
  2136. ///<field type="Number">Number16</field>
  2137. Number16: 130,
  2138. ///<field type="Number">Number17</field>
  2139. Number17: 131,
  2140. ///<field type="Number">Number18</field>
  2141. Number18: 132,
  2142. ///<field type="Number">Number19</field>
  2143. Number19: 133,
  2144. ///<field type="Number">Number2</field>
  2145. Number2: 134,
  2146. ///<field type="Number">Number20</field>
  2147. Number20: 135,
  2148. ///<field type="Number">Number3</field>
  2149. Number3: 136,
  2150. ///<field type="Number">Number4</field>
  2151. Number4: 137,
  2152. ///<field type="Number">Number5</field>
  2153. Number5: 138,
  2154. ///<field type="Number">Number6</field>
  2155. Number6: 139,
  2156. ///<field type="Number">Number7</field>
  2157. Number7: 140,
  2158. ///<field type="Number">Number8</field>
  2159. Number8: 141,
  2160. ///<field type="Number">Number9</field>
  2161. Number9: 142,
  2162. ///<field type="Number">OvertimeCost</field>
  2163. OvertimeCost: 143,
  2164. ///<field type="Number">OvertimeRate</field>
  2165. OvertimeRate: 144,
  2166. ///<field type="Number">OvertimeWork</field>
  2167. OvertimeWork: 145,
  2168. ///<field type="Number">PercentWorkComplete</field>
  2169. PercentWorkComplete: 146,
  2170. ///<field type="Number">CostPerUse</field>
  2171. CostPerUse: 147,
  2172. ///<field type="Number">Generic</field>
  2173. Generic: 148,
  2174. ///<field type="Number">OverAllocated</field>
  2175. OverAllocated: 149,
  2176. ///<field type="Number">RegularWork</field>
  2177. RegularWork: 150,
  2178. ///<field type="Number">RemainingCost</field>
  2179. RemainingCost: 151,
  2180. ///<field type="Number">RemainingOvertimeCost</field>
  2181. RemainingOvertimeCost: 152,
  2182. ///<field type="Number">RemainingOvertimeWork</field>
  2183. RemainingOvertimeWork: 153,
  2184. ///<field type="Number">RemainingWork</field>
  2185. RemainingWork: 154,
  2186. ///<field type="Number">ResourceGUID</field>
  2187. ResourceGUID: 155,
  2188. ///<field type="Number">Cost</field>
  2189. Cost: 156,
  2190. ///<field type="Number">Work</field>
  2191. Work: 157,
  2192. ///<field type="Number">Start</field>
  2193. Start: 158,
  2194. ///<field type="Number">Start1</field>
  2195. Start1: 159,
  2196. ///<field type="Number">Start10</field>
  2197. Start10: 160,
  2198. ///<field type="Number">Start2</field>
  2199. Start2: 161,
  2200. ///<field type="Number">Start3</field>
  2201. Start3: 162,
  2202. ///<field type="Number">Start4</field>
  2203. Start4: 163,
  2204. ///<field type="Number">Start5</field>
  2205. Start5: 164,
  2206. ///<field type="Number">Start6</field>
  2207. Start6: 165,
  2208. ///<field type="Number">Start7</field>
  2209. Start7: 166,
  2210. ///<field type="Number">Start8</field>
  2211. Start8: 167,
  2212. ///<field type="Number">Start9</field>
  2213. Start9: 168,
  2214. ///<field type="Number">StandardRate</field>
  2215. StandardRate: 169,
  2216. ///<field type="Number">Text1</field>
  2217. Text1: 170,
  2218. ///<field type="Number">Text10</field>
  2219. Text10: 171,
  2220. ///<field type="Number">Text11</field>
  2221. Text11: 172,
  2222. ///<field type="Number">Text12</field>
  2223. Text12: 173,
  2224. ///<field type="Number">Text13</field>
  2225. Text13: 174,
  2226. ///<field type="Number">Text14</field>
  2227. Text14: 175,
  2228. ///<field type="Number">Text15</field>
  2229. Text15: 176,
  2230. ///<field type="Number">Text16</field>
  2231. Text16: 177,
  2232. ///<field type="Number">Text17</field>
  2233. Text17: 178,
  2234. ///<field type="Number">Text18</field>
  2235. Text18: 179,
  2236. ///<field type="Number">Text19</field>
  2237. Text19: 180,
  2238. ///<field type="Number">Text2</field>
  2239. Text2: 181,
  2240. ///<field type="Number">Text20</field>
  2241. Text20: 182,
  2242. ///<field type="Number">Text21</field>
  2243. Text21: 183,
  2244. ///<field type="Number">Text22</field>
  2245. Text22: 184,
  2246. ///<field type="Number">Text23</field>
  2247. Text23: 185,
  2248. ///<field type="Number">Text24</field>
  2249. Text24: 186,
  2250. ///<field type="Number">Text25</field>
  2251. Text25: 187,
  2252. ///<field type="Number">Text26</field>
  2253. Text26: 188,
  2254. ///<field type="Number">Text27</field>
  2255. Text27: 189,
  2256. ///<field type="Number">Text28</field>
  2257. Text28: 190,
  2258. ///<field type="Number">Text29</field>
  2259. Text29: 191,
  2260. ///<field type="Number">Text3</field>
  2261. Text3: 192,
  2262. ///<field type="Number">Text30</field>
  2263. Text30: 193,
  2264. ///<field type="Number">Text4</field>
  2265. Text4: 194,
  2266. ///<field type="Number">Text5</field>
  2267. Text5: 195,
  2268. ///<field type="Number">Text6</field>
  2269. Text6: 196,
  2270. ///<field type="Number">Text7</field>
  2271. Text7: 197,
  2272. ///<field type="Number">Text8</field>
  2273. Text8: 198,
  2274. ///<field type="Number">Text9</field>
  2275. Text9: 199
  2276. }
  2277. },
  2278. context: {
  2279. contents: {
  2280. document: {
  2281. contents: {
  2282. getSelectedTaskAsync: {
  2283. conditions: { reqs: ["method Document.getSelectedTaskAsync"] },
  2284. value: function (callback) {
  2285. ///<summary> (Project only) Get the current selected Task's Id.</summary>
  2286. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  2287. }
  2288. },
  2289. getTaskByIndexAsync: {
  2290. conditions: { reqs: ["method Document.getTaskByIndexAsync"] },
  2291. value: function (taskIndex, callback) {
  2292. ///<summary> (Project only) Get the Task's Id for provided task index.</summary>
  2293. ///<param name="taskIndex" type="Object">Task index in task container</param>
  2294. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  2295. }
  2296. },
  2297. getTaskAsync: {
  2298. conditions: { reqs: ["method Document.getTaskAsync"] },
  2299. value: function (taskId, callback) {
  2300. ///<summary> (Project only) Get the Task Name, WSS Task Id, and ResourceNames for given taskId .</summary>
  2301. ///<param name="taskId" type="Object">Either a string or value of the Task Id.</param>
  2302. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  2303. }
  2304. },
  2305. getTaskFieldAsync: {
  2306. conditions: { reqs: ["method Document.getTaskFieldAsync"] },
  2307. value: function (taskId, taskField, callback) {
  2308. ///<summary> (Project only) Get task field for provided task Id. (Ex. StartDate).</summary>
  2309. ///<param name="taskId" type="Object">Either a string or value of the Task Id.</param>
  2310. ///<param name="taskField" type="Office.ProjectTaskFields">Task Fields.</param>
  2311. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  2312. }
  2313. },
  2314. getSelectedResourceAsync: {
  2315. conditions: { reqs: ["method Document.getSelectedResourceAsync"] },
  2316. value: function (callback) {
  2317. ///<summary> (Project only) Get the current selected Resource's Id.</summary>
  2318. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  2319. }
  2320. },
  2321. getResourceByIndexAsync: {
  2322. conditions: { reqs: ["method Document.getResourceByIndexAsync"] },
  2323. value: function (resourceIndex, callback) {
  2324. ///<summary> (Project only) Get the Resource's Id for provided resource index.</summary>
  2325. ///<param name="resourceIndex" type="Object">Resource index in resource container</param>
  2326. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  2327. }
  2328. },
  2329. getResourceFieldAsync: {
  2330. conditions: { reqs: ["method Document.getResourceFieldAsync"] },
  2331. value: function (resourceId, resourceField, callback) {
  2332. ///<summary> (Project only) Get resource field for provided resource Id. (Ex.ResourceName)</summary>
  2333. ///<param name="resourceId" type="Object">Either a string or value of the Resource Id.</param>
  2334. ///<param name="resourceField" type="Office.ProjectResourceFields">Resource Fields.</param>
  2335. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  2336. }
  2337. },
  2338. getProjectFieldAsync: {
  2339. conditions: { reqs: ["method Document.getProjectFieldAsync"] },
  2340. value: function (projectField, callback) {
  2341. ///<summary> (Project only) Get Project field (Ex. ProjectWebAccessURL).</summary>
  2342. ///<param name="projectField" type="Office.ProjectProjectFields">Project level fields.</param>
  2343. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  2344. }
  2345. },
  2346. getSelectedViewAsync: {
  2347. conditions: { reqs: ["method Document.getSelectedViewAsync"] },
  2348. value: function (callback) {
  2349. ///<summary> (Project only) Get the current selected View Type (Ex. Gantt) and View Name.</summary>
  2350. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  2351. }
  2352. },
  2353. getWSSURLAsync: {
  2354. conditions: { reqs: ["method Document.getWSSURLAsync"] },
  2355. value: function (callback) {
  2356. ///<summary> (Project only) Get the WSS Url and list name for the Tasks List, the MPP is synced too.</summary>
  2357. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  2358. }
  2359. },
  2360. setTaskFieldAsync: {
  2361. conditions: { reqs: ["method Document.setTaskFieldAsync"] },
  2362. value: function (taskId, fieldId, fieldValue, callback) {
  2363. ///<summary> (Project only) Set Taskfield (Ex. TaskName).</summary>
  2364. ///<param name="taskId" type="Object">Either a string or value of the Task Id.</param>
  2365. ///<param name="taskField" type="Office.ProjectTaskFields">Task Field.</param>
  2366. ///<param name="fieldValue" type="Object">Either a string, number boolean or object for the data that you want to set.</param>
  2367. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  2368. }
  2369. },
  2370. setResourceFieldAsync: {
  2371. conditions: { reqs: ["method Document.setResourceFieldAsync"] },
  2372. value: function (resourceId, fieldId, fieldValue, callback) {
  2373. ///<summary> (Project only) Set Resource field (Ex. ResourceName).</summary>
  2374. ///<param name="resourceId" type="Object">Either a string or value of the Resource Id.</param>
  2375. ///<param name="resourceField" type="Office.ProjectResourceFields">Resource Field.</param>
  2376. ///<param name="fieldValue" type="Object">Either a string, number boolean or object for the data that you want to set.</param>
  2377. ///<param name="callback" type="function" optional="true">The optional callback method</param>
  2378. }
  2379. }
  2380. }
  2381. }
  2382. }
  2383. }
  2384. }
  2385. });
  2386. // Setup outlook
  2387. Office._processItem(Office, {
  2388. metaOnly: true,
  2389. conditions: {
  2390. hosts: ["outlook", "outlookcompose"],
  2391. reqs: ["set Mailbox GE 1.1"]
  2392. },
  2393. contents: {
  2394. MailboxEnums: {
  2395. value: new Office._MailboxEnums()
  2396. },
  2397. context: {
  2398. contents: {
  2399. mailbox: {
  2400. value: new Office._context_mailbox()
  2401. },
  2402. roamingSettings: {
  2403. value: new Office._settings()
  2404. }
  2405. }
  2406. },
  2407. cast: {
  2408. value: {
  2409. item: new Office._cast_item()
  2410. }
  2411. }
  2412. }
  2413. })
  2414. // Setup CustomXMLParts
  2415. Office._addEnumOnObject("CustomXmlNodeType",
  2416. {
  2417. ///<field type="String">Element</field>
  2418. Element: "element",
  2419. ///<field type="String">Attribute</field>
  2420. Attribute: "attribute",
  2421. ///<field type="String">String/field>
  2422. Text: "text",
  2423. ///<field type="String">CData</field>
  2424. Cdata: "cdata",
  2425. ///<field type="String">ProcessingInstruction</field>
  2426. ProcessingInstruction: "processingInstruction",
  2427. ///<field type="String">NodeComment</field>
  2428. NodeComment: "nodeComment",
  2429. ///<field type="String">NodeDocument</field>
  2430. NodeDocument: "nodeDocument"
  2431. },
  2432. Office,
  2433. {
  2434. hosts: ["word"]
  2435. }
  2436. );
  2437. // Other enumerations on Office
  2438. Office._addEnumOnObject("AsyncResultStatus",
  2439. {
  2440. ///<field type="String">Operation failed, check error object</field>
  2441. Failed: "failed",
  2442. ///<field type="String">Operation succeeded</field>
  2443. Succeeded: "succeeded"
  2444. },
  2445. Office,
  2446. {
  2447. hosts: ["not outlook; not outlookcompose"]
  2448. }
  2449. );
  2450. Office._processItem(Office,
  2451. {
  2452. contents: {
  2453. Text: {
  2454. conditions: {
  2455. hosts: ["excel", "word"],
  2456. reqs: ["set TextBindings GE 1.1"]
  2457. },
  2458. annotate: {
  2459. ///<field type="String">Text based Binding</field>
  2460. Text: undefined
  2461. },
  2462. value: "text"
  2463. },
  2464. Matrix: {
  2465. conditions: {
  2466. hosts: ["excel", "word"],
  2467. reqs: ["set MatrixBindings GE 1.1"]
  2468. },
  2469. annotate: {
  2470. ///<field type="String">Matrix based Binding</field>
  2471. Matrix: undefined
  2472. },
  2473. value: "matrix"
  2474. },
  2475. Table: {
  2476. conditions: {
  2477. hosts: ["excel", "word", "accesswebapp"],
  2478. reqs: ["set TableBindings GE 1.1"]
  2479. },
  2480. annotate: {
  2481. ///<field type="String">Table based Binding</field>
  2482. Table: undefined
  2483. },
  2484. value: "table"
  2485. }
  2486. }
  2487. },
  2488. "BindingType"
  2489. );
  2490. Office._processItem(Office,
  2491. {
  2492. contents: {
  2493. Table: {
  2494. conditions: {
  2495. hosts: ["word", "excel", "accesswebapp"],
  2496. reqs: ["set TableCoercion GE 1.1"]
  2497. },
  2498. annotate: {
  2499. ///<field type="String">Coerce as Table</field>
  2500. Table: undefined
  2501. },
  2502. value: "table"
  2503. },
  2504. Text: {
  2505. conditions: {
  2506. hosts: ["excel", "ppt", "project", "word"],
  2507. reqs: ["set TextCoercion GE 1.1"]
  2508. },
  2509. annotate: {
  2510. ///<field type="String">Coerce as Text</field>
  2511. Text: undefined
  2512. },
  2513. value: "text"
  2514. },
  2515. Matrix: {
  2516. conditions: {
  2517. hosts: ["excel", "word"],
  2518. reqs: ["set MatrixCoercion GE 1.1"]
  2519. },
  2520. annotate: {
  2521. ///<field type="String">Coerce as Matrix</field>
  2522. Matrix: undefined
  2523. },
  2524. value: "matrix"
  2525. },
  2526. Html: {
  2527. conditions: {
  2528. hosts: ["word"],
  2529. reqs: ["set HtmlCoercion GE 1.1"]
  2530. },
  2531. annotate: {
  2532. ///<field type="String">Coerce as HTML</field>
  2533. Html: undefined
  2534. },
  2535. value: "html"
  2536. },
  2537. Ooxml: {
  2538. conditions: {
  2539. hosts: ["word"],
  2540. reqs: ["set OoxmlCoercion GE 1.1"]
  2541. },
  2542. annotate: {
  2543. ///<field type="String">Coerce as Office Open XML</field>
  2544. Ooxml: undefined
  2545. },
  2546. value: "ooxml"
  2547. },
  2548. SlideRange: {
  2549. conditions: {
  2550. hosts: ["ppt"]
  2551. },
  2552. annotate: {
  2553. ///<field type="String">Coerce as JSON object containing an array of the ids, titles, and indexes of the selected slides.</field>
  2554. SlideRange: undefined
  2555. },
  2556. value: "slideRange"
  2557. }
  2558. }
  2559. },
  2560. "CoercionType"
  2561. );
  2562. Office._addEnumOnObject("DocumentMode",
  2563. {
  2564. ///<field type="String">Document in Read Only Mode</field>
  2565. ReadOnly: "readOnly",
  2566. ///<field type="String">Document in Read/Write Mode</field>
  2567. ReadWrite: "readWrite"
  2568. },
  2569. Office,
  2570. {
  2571. hosts: ["word", "excel", "accesswebapp"]
  2572. }
  2573. );
  2574. Office._addEnumOnObject("EventType",
  2575. {
  2576. ///<field type="String">Triggers when a document level selection happens</field>
  2577. DocumentSelectionChanged: "documentSelectionChanged",
  2578. ///<field type="String"> Triggers when a binding level selection happens</field>
  2579. BindingSelectionChanged: "bindingSelectionChanged",
  2580. ///<field type="String">Triggers when a binding level data change happens</field>
  2581. BindingDataChanged: "bindingDataChanged",
  2582. ///<field type="String">Triggers when settings change in a co-Auth session.</field>
  2583. SettingsChanged: "settingsChanged",
  2584. ///<field type="String">Triggers when a customXmlPart node was deleted</field>
  2585. DataNodeDeleted: "nodeDeleted",
  2586. ///<field type="String">Triggers when a customXmlPart node was inserted</field>
  2587. DataNodeInserted: "nodeInserted",
  2588. ///<field type="String">Triggers when a customXmlPart node was replaced</field>
  2589. DataNodeReplaced: "nodeReplaced",
  2590. ///<field type="String">Triggers when a Task selection happens in Project.</field>
  2591. TaskSelectionChanged: "taskSelectionChanged",
  2592. ///<field type="String"> Triggers when a Resource selection happens in Project.</field>
  2593. ResourceSelectionChanged: "resourceSelectionChanged",
  2594. ///<field type="String">Triggers when a View selection happens in Project.</field>
  2595. ViewSelectionChanged: "viewSelectionChanged"
  2596. },
  2597. Office,
  2598. {
  2599. hosts: ["not outlook; not outlookcompose"]
  2600. }
  2601. );
  2602. // EventType augmentations
  2603. Office._processContents(Office.EventType, {
  2604. ActiveViewChanged: {
  2605. conditions: {
  2606. hosts: ["ppt"]
  2607. },
  2608. annotate: {
  2609. ///<field type="String">Occurs when the user changes the current view of the document.</field>
  2610. ActiveViewChanged: undefined
  2611. },
  2612. value: "activeViewChanged"
  2613. }
  2614. });
  2615. Office._processItem(Office,
  2616. {
  2617. conditions: { hosts: ["not outlook; not outlookcompose; not accesswebapp"] },
  2618. contents: {
  2619. Compressed: {
  2620. conditions: {
  2621. hosts: ["ppt", "word"],
  2622. reqs: ["set CompressedFile GE 1.1"]
  2623. },
  2624. annotate: {
  2625. ///<field type="String">Returns the file as a byte array </field>
  2626. Compressed: undefined
  2627. },
  2628. value: "compressed"
  2629. },
  2630. Pdf: {
  2631. conditions: {
  2632. hosts: ["ppt", "word"],
  2633. reqs: ["set PdfFile GE 1.1"]
  2634. },
  2635. annotate: {
  2636. ///<field type="String">Returns the file in PDF format as a byte array</field>
  2637. Pdf: undefined
  2638. },
  2639. value: "pdf"
  2640. },
  2641. Text: {
  2642. conditions: {
  2643. hosts: ["word"],
  2644. reqs: ["set TextFile GE 1.1"]
  2645. },
  2646. annotate: {
  2647. ///<field type="String">Returns the file as plain text</field>
  2648. Text: undefined
  2649. },
  2650. value: "text"
  2651. }
  2652. }
  2653. },
  2654. "FileType"
  2655. );
  2656. Office._addEnumOnObject("FilterType",
  2657. {
  2658. ///<field type="String">Returns all items</field>
  2659. All: "all",
  2660. ///<field type="String">Returns only visible items</field>
  2661. OnlyVisible: "onlyVisible"
  2662. },
  2663. Office,
  2664. {
  2665. hosts: ["not outlook; not outlookcompose; not accesswebapp"]
  2666. }
  2667. );
  2668. Office._addEnumOnObject("InitializationReason",
  2669. {
  2670. ///<field type="String">Indicates the app was just inserted in the document /field>
  2671. Inserted: "inserted",
  2672. ///<field type="String">Indicated if the extension already existed in the document</field>
  2673. DocumentOpened: "documentOpened"
  2674. },
  2675. Office,
  2676. {
  2677. hosts: ["not outlook; not outlookcompose"]
  2678. }
  2679. );
  2680. Office._addEnumOnObject("ValueFormat",
  2681. {
  2682. ///<field type="String">Returns items with format</field>
  2683. Formatted: "formatted",
  2684. ///<field type="String">Returns items without format</field>
  2685. Unformatted: "unformatted"
  2686. },
  2687. Office,
  2688. {
  2689. hosts: ["not outlook; not outlookcompose"]
  2690. }
  2691. );
  2692. Office._processContents(Office, {
  2693. GoToType: {
  2694. contents: {
  2695. Binding: {
  2696. conditions: {
  2697. hosts: ["excel", "word"]
  2698. },
  2699. annotate: {
  2700. ///<field type="String">Goes to a binding object using the specified binding id.</field>
  2701. Binding: undefined
  2702. },
  2703. value: "binding"
  2704. },
  2705. NamedItem: {
  2706. conditions: {
  2707. hosts: ["excel"]
  2708. },
  2709. annotate: {
  2710. /// <field type="String">
  2711. /// Goes to a named item using that item's name.
  2712. /// &#10; In Excel, you can use any structured reference for a named range or table: "Worksheet2!Table1"
  2713. /// </field>
  2714. NamedItem: undefined
  2715. },
  2716. value: "namedItem"
  2717. },
  2718. Slide: {
  2719. conditions: {
  2720. hosts: ["ppt"]
  2721. },
  2722. annotate: {
  2723. ///<field type="String">Goes to a slide using the specified id.</field>
  2724. Slide: undefined
  2725. },
  2726. value: "slide"
  2727. },
  2728. Index: {
  2729. conditions: {
  2730. hosts: ["ppt"]
  2731. },
  2732. annotate: {
  2733. ///<field type="String">Goes to the specified index by slide number or enum Office.Index</field>
  2734. Index: undefined
  2735. },
  2736. value: "index"
  2737. }
  2738. }
  2739. }
  2740. });
  2741. Office._addEnumOnObject("Index",
  2742. {
  2743. First: "first",
  2744. Last: "last",
  2745. Next: "next",
  2746. Previous: "previous"
  2747. },
  2748. Office,
  2749. {
  2750. hosts: ["ppt"]
  2751. }
  2752. );
  2753. Office._addEnumOnObject("SelectionMode",
  2754. {
  2755. Default: "default",
  2756. Selected: "selected",
  2757. None: "none"
  2758. },
  2759. Office,
  2760. {
  2761. hosts: ["word"]
  2762. }
  2763. );
  2764. if (!!intellisense) {
  2765. intellisense.addEventListener('statementcompletion', function (event) {
  2766. if (event.targetName === "this" || event.target === undefined || event.target === window) return;
  2767. event.items = event.items.filter(function (item) {
  2768. return !(item.name && item.name.charAt(0) === "_");
  2769. });
  2770. });
  2771. }
  2772. Office._processContents(Office, Office._items);
  2773. document.addEventListener("DOMContentLoaded", function () {
  2774. Office.initialize();
  2775. });
  2776. var __extends = this.__extends || function (d, b) {
  2777. for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p];
  2778. function __() { this.constructor = d; }
  2779. __.prototype = b.prototype;
  2780. d.prototype = new __();
  2781. };
  2782. var OfficeExtension;
  2783. (function (OfficeExtension) {
  2784. var ClientObject = (function () {
  2785. function ClientObject() {
  2786. /// <field name="isNullObject" type="Boolean">Returns a boolean value for whether the corresponding object is a null object. You must call "context.sync()" before reading the isNullObject property.</field>
  2787. }
  2788. return ClientObject;
  2789. })();
  2790. OfficeExtension.ClientObject = ClientObject;
  2791. })(OfficeExtension || (OfficeExtension = {__proto__: null}));
  2792. var OfficeExtension;
  2793. (function (OfficeExtension) {
  2794. var ClientRequestContext = (function () {
  2795. function ClientRequestContext(url) {
  2796. /// <summary>
  2797. /// An abstract RequestContext object that facilitates requests to the host Office application. The "Excel.run" and "Word.run" methods provide a request context.
  2798. /// </summary>
  2799. /// <field name="trackedObjects" type="OfficeExtension.TrackedObjects"> Collection of objects that are tracked for automatic adjustments based on surrounding changes in the document. </field>
  2800. /// <field name="requestHeaders" type="Object">Request headers.</field>
  2801. this.requestHeaders = {
  2802. __proto__: null,
  2803. };
  2804. }
  2805. ClientRequestContext.prototype.load = function (object, option) {
  2806. /// <summary>
  2807. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  2808. /// </summary>
  2809. /// <param name="object" type="OfficeExtension.ClientObject" />
  2810. /// <param name="option" type="string|string[]|{select?, expand?, top?, skip?}" />
  2811. };
  2812. ClientRequestContext.prototype.trace = function (message) {
  2813. /// <summary>
  2814. /// Adds a trace message to the queue. If the promise returned by "context.sync()" is rejected due to an error, this adds a ".traceMessages" array to the OfficeExtension.Error object, containing all trace messages that were executed. These messages can help you monitor the program execution sequence and detect the cause of the error.
  2815. /// </summary>
  2816. /// <param name="message" type="String" />
  2817. };
  2818. ClientRequestContext.prototype.sync = function (passThroughValue) {
  2819. /// <summary>
  2820. /// Synchronizes the state between JavaScript proxy objects and the Office document, by executing instructions queued on the request context and retrieving properties of loaded Office objects for use in your code.ÿThis method returns a promise, which is resolved when the synchronization is complete.
  2821. /// </summary>
  2822. /// <param name="passThroughValue" optional="true" />
  2823. return new OfficeExtension.Promise();
  2824. };
  2825. ClientRequestContext.prototype.__proto__ = null;
  2826. return ClientRequestContext;
  2827. })();
  2828. OfficeExtension.ClientRequestContext = ClientRequestContext;
  2829. })(OfficeExtension || (OfficeExtension = {__proto__: null}));
  2830. var OfficeExtension;
  2831. (function (OfficeExtension) {
  2832. var ClientResult = (function () {
  2833. function ClientResult() {
  2834. /// <summary>
  2835. /// Contains the result for methods that return primitive types. The object's value property is retrieved from the document after "context.sync()" is invoked.
  2836. /// </summary>
  2837. /// <field name="value">
  2838. /// The value of the result that is retrieved from the document after "context.sync()" is invoked.
  2839. /// </field>
  2840. }
  2841. ClientResult.prototype.__proto__ = null;
  2842. return ClientResult;
  2843. })();
  2844. OfficeExtension.ClientResult = ClientResult;
  2845. })(OfficeExtension || (OfficeExtension = {__proto__: null}));
  2846. var OfficeExtension;
  2847. (function (OfficeExtension) {
  2848. var Error = (function () {
  2849. function Error() {
  2850. /// <summary>
  2851. /// The error object returned by "context.sync()", if a promise is rejected due to an error while processing the request.
  2852. /// </summary>
  2853. /// <field name="name" type="String">
  2854. /// Error name: "OfficeExtension.Error"
  2855. /// </field>
  2856. /// <field name="message" type="String">
  2857. /// The error message passed through from the host Office application.
  2858. /// </field>
  2859. /// <field name="stack" type="String">
  2860. /// Stack trace, if applicable.
  2861. /// </field>
  2862. /// <field name="code" type="String">
  2863. /// Error code string, such as "InvalidArgument".
  2864. /// </field>
  2865. /// <field name="traceMessages" type="Array" elementType="string">
  2866. /// Trace messages (if any) that were added via a "context.trace()" invocation before calling "context.sync()". If there was an error, this contains all trace messages that were executed before the error occurred. These messages can help you monitor the program execution sequence and detect the case of the error.
  2867. /// </field>
  2868. /// <field name="debugInfo">
  2869. /// Debug info, if applicable. The ".errorLocation" property can describe the object and method or property that caused the error.
  2870. /// </field>
  2871. this.debugInfo = {
  2872. __proto__: null,
  2873. /// <field name="errorLocation" type="string" optional="true">
  2874. /// If applicable, will return the object type and the name of the method or property that caused the error.
  2875. /// </field>
  2876. errorLocation: ""
  2877. };
  2878. }
  2879. Error.prototype.__proto__ = null;
  2880. return Error;
  2881. })();
  2882. OfficeExtension.Error = Error;
  2883. })(OfficeExtension || (OfficeExtension = {__proto__: null}));
  2884. var OfficeExtension;
  2885. (function (OfficeExtension) {
  2886. var ErrorCodes = (function () {
  2887. function ErrorCodes() {
  2888. }
  2889. ErrorCodes.__proto__ = null;
  2890. ErrorCodes.accessDenied = "";
  2891. ErrorCodes.generalException = "";
  2892. ErrorCodes.activityLimitReached = "";
  2893. return ErrorCodes;
  2894. })();
  2895. })(OfficeExtension || (OfficeExtension = {__proto__: null}));
  2896. var OfficeExtension;
  2897. (function (OfficeExtension) {
  2898. var Promise = (function () {
  2899. /// <summary>
  2900. /// Creates a promise that resolves when all of the child promises resolve.
  2901. /// </summary>
  2902. Promise.all = function (promises) { return [new OfficeExtension.Promise()]; };
  2903. /// <summary>
  2904. /// Creates a promise that is resolved.
  2905. /// </summary>
  2906. Promise.resolve = function (value) { return new OfficeExtension.Promise(); };
  2907. /// <summary>
  2908. /// Creates a promise that is rejected.
  2909. /// </summary>
  2910. Promise.reject = function (error) { return new OfficeExtension.Promise(); };
  2911. /// <summary>
  2912. /// A Promise object that represents a deferred interaction with the host Office application. The publically-consumable OfficeExtension.Promise is available starting in ExcelApi 1.2 and WordApi 1.2. Promises can be chained via ".then", and errors can be caught via ".catch". Remember to always use a ".catch" on the outer promise, and to return intermediary promises so as not to break the promise chain. When a "native" Promise implementation is available, OfficeExtension.Promise will switch to use the native Promise instead.
  2913. /// </summary>
  2914. Promise.prototype.then = function (onFulfilled, onRejected) {
  2915. /// <summary>
  2916. /// This method will be called once the previous promise has been resolved.
  2917. /// Both the onFulfilled on onRejected callbacks are optional.
  2918. /// If either or both are omitted, the next onFulfilled/onRejected in the chain will be called called.
  2919. /// Returns a new promise for the value or error that was returned from onFulfilled/onRejected.
  2920. /// </summary>
  2921. /// <param name="onFulfilled" type="Function" optional="true"></param>
  2922. /// <param name="onRejected" type="Function" optional="true"></param>
  2923. /// <returns type="OfficeExtension.Promise"></returns>
  2924. onRejected(new Error());
  2925. }
  2926. Promise.prototype.catch = function (onRejected) {
  2927. /// <summary>
  2928. /// Catches failures or exceptions from actions within the promise, or from an unhandled exception earlier in the call stack.
  2929. /// </summary>
  2930. /// <param name="onRejected" type="Function" optional="true">function to be called if or when the promise rejects.</param>
  2931. /// <returns type="OfficeExtension.Promise"></returns>
  2932. onRejected(new Error());
  2933. }
  2934. Promise.prototype.__proto__ = null;
  2935. })
  2936. OfficeExtension.Promise = Promise;
  2937. })(OfficeExtension || (OfficeExtension = {__proto__: null}));
  2938. var OfficeExtension;
  2939. (function (OfficeExtension) {
  2940. var TrackedObjects = (function () {
  2941. function TrackedObjects() {
  2942. /// <summary>
  2943. /// Collection of tracked objects, contained within a request context. See "context.trackedObjects" for more information.
  2944. /// </summary>
  2945. }
  2946. TrackedObjects.prototype.add = function (object) {
  2947. /// <summary>
  2948. /// Track a new object for automatic adjustment based on surrounding changes in the document. Only some object types require this. If you are using an object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
  2949. /// </summary>
  2950. /// <param name="object" type="OfficeExtension.ClientObject|OfficeExtension.ClientObject[]"></param>
  2951. };
  2952. TrackedObjects.prototype.remove = function (object) {
  2953. /// <summary>
  2954. /// Release the memory associated with an object that was previously added to this collection. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
  2955. /// </summary>
  2956. /// <param name="object" type="OfficeExtension.ClientObject|OfficeExtension.ClientObject[]"></param>
  2957. };
  2958. TrackedObjects.prototype.__proto__ = null;
  2959. return TrackedObjects;
  2960. })();
  2961. OfficeExtension.TrackedObjects = TrackedObjects;
  2962. })(OfficeExtension || (OfficeExtension = {__proto__: null}));
  2963. (function (OfficeExtension) {
  2964. var EventHandlers = (function () {
  2965. function EventHandlers() { }
  2966. EventHandlers.prototype.add = function (handler) {
  2967. return new EventHandlerResult(null, null, handler);
  2968. };
  2969. EventHandlers.prototype.remove = function (handler) { };
  2970. EventHandlers.prototype.removeAll = function () { };
  2971. EventHandlers.prototype.__proto__ = null;
  2972. return EventHandlers;
  2973. }());
  2974. OfficeExtension.EventHandlers = EventHandlers;
  2975. var EventHandlerResult = (function () {
  2976. function EventHandlerResult() { }
  2977. EventHandlerResult.prototype.remove = function () { };
  2978. EventHandlerResult.prototype.__proto__ = null;
  2979. return EventHandlerResult;
  2980. }());
  2981. OfficeExtension.EventHandlerResult = EventHandlerResult;
  2982. })(OfficeExtension || (OfficeExtension = {__proto__: null}));
  2983. OfficeExtension.__proto__ = null;
  2984. var Excel;
  2985. (function (Excel) {
  2986. var _V1Api = (function(_super) {
  2987. __extends(_V1Api, _super);
  2988. function _V1Api() {
  2989. /// <summary> [Api set: ExcelApi 1.3] </summary>
  2990. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  2991. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  2992. }
  2993. _V1Api.prototype.load = function(option) {
  2994. /// <summary>
  2995. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  2996. /// </summary>
  2997. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  2998. /// <returns type="Excel._V1Api"/>
  2999. }
  3000. _V1Api.prototype.bindingAddColumns = function(input) {
  3001. /// <returns type="OfficeExtension.ClientResult&lt;any&gt;"></returns>
  3002. var result = new OfficeExtension.ClientResult();
  3003. result.__proto__ = null;
  3004. result.value = {};
  3005. return result;
  3006. }
  3007. _V1Api.prototype.bindingAddFromNamedItem = function(input) {
  3008. /// <returns type="OfficeExtension.ClientResult&lt;any&gt;"></returns>
  3009. var result = new OfficeExtension.ClientResult();
  3010. result.__proto__ = null;
  3011. result.value = {};
  3012. return result;
  3013. }
  3014. _V1Api.prototype.bindingAddFromPrompt = function(input) {
  3015. /// <returns type="OfficeExtension.ClientResult&lt;any&gt;"></returns>
  3016. var result = new OfficeExtension.ClientResult();
  3017. result.__proto__ = null;
  3018. result.value = {};
  3019. return result;
  3020. }
  3021. _V1Api.prototype.bindingAddFromSelection = function(input) {
  3022. /// <returns type="OfficeExtension.ClientResult&lt;any&gt;"></returns>
  3023. var result = new OfficeExtension.ClientResult();
  3024. result.__proto__ = null;
  3025. result.value = {};
  3026. return result;
  3027. }
  3028. _V1Api.prototype.bindingAddRows = function(input) {
  3029. /// <returns type="OfficeExtension.ClientResult&lt;any&gt;"></returns>
  3030. var result = new OfficeExtension.ClientResult();
  3031. result.__proto__ = null;
  3032. result.value = {};
  3033. return result;
  3034. }
  3035. _V1Api.prototype.bindingClearFormats = function(input) {
  3036. /// <returns type="OfficeExtension.ClientResult&lt;any&gt;"></returns>
  3037. var result = new OfficeExtension.ClientResult();
  3038. result.__proto__ = null;
  3039. result.value = {};
  3040. return result;
  3041. }
  3042. _V1Api.prototype.bindingDeleteAllDataValues = function(input) {
  3043. /// <returns type="OfficeExtension.ClientResult&lt;any&gt;"></returns>
  3044. var result = new OfficeExtension.ClientResult();
  3045. result.__proto__ = null;
  3046. result.value = {};
  3047. return result;
  3048. }
  3049. _V1Api.prototype.bindingGetAll = function() {
  3050. /// <returns type="OfficeExtension.ClientResult&lt;any&gt;"></returns>
  3051. var result = new OfficeExtension.ClientResult();
  3052. result.__proto__ = null;
  3053. result.value = {};
  3054. return result;
  3055. }
  3056. _V1Api.prototype.bindingGetById = function(input) {
  3057. /// <returns type="OfficeExtension.ClientResult&lt;any&gt;"></returns>
  3058. var result = new OfficeExtension.ClientResult();
  3059. result.__proto__ = null;
  3060. result.value = {};
  3061. return result;
  3062. }
  3063. _V1Api.prototype.bindingGetData = function(input) {
  3064. /// <returns type="OfficeExtension.ClientResult&lt;any&gt;"></returns>
  3065. var result = new OfficeExtension.ClientResult();
  3066. result.__proto__ = null;
  3067. result.value = {};
  3068. return result;
  3069. }
  3070. _V1Api.prototype.bindingReleaseById = function(input) {
  3071. /// <returns type="OfficeExtension.ClientResult&lt;any&gt;"></returns>
  3072. var result = new OfficeExtension.ClientResult();
  3073. result.__proto__ = null;
  3074. result.value = {};
  3075. return result;
  3076. }
  3077. _V1Api.prototype.bindingSetData = function(input) {
  3078. /// <returns type="OfficeExtension.ClientResult&lt;any&gt;"></returns>
  3079. var result = new OfficeExtension.ClientResult();
  3080. result.__proto__ = null;
  3081. result.value = {};
  3082. return result;
  3083. }
  3084. _V1Api.prototype.bindingSetFormats = function(input) {
  3085. /// <returns type="OfficeExtension.ClientResult&lt;any&gt;"></returns>
  3086. var result = new OfficeExtension.ClientResult();
  3087. result.__proto__ = null;
  3088. result.value = {};
  3089. return result;
  3090. }
  3091. _V1Api.prototype.bindingSetTableOptions = function(input) {
  3092. /// <returns type="OfficeExtension.ClientResult&lt;any&gt;"></returns>
  3093. var result = new OfficeExtension.ClientResult();
  3094. result.__proto__ = null;
  3095. result.value = {};
  3096. return result;
  3097. }
  3098. _V1Api.prototype.getSelectedData = function(input) {
  3099. /// <returns type="OfficeExtension.ClientResult&lt;any&gt;"></returns>
  3100. var result = new OfficeExtension.ClientResult();
  3101. result.__proto__ = null;
  3102. result.value = {};
  3103. return result;
  3104. }
  3105. _V1Api.prototype.gotoById = function(input) {
  3106. /// <returns type="OfficeExtension.ClientResult&lt;any&gt;"></returns>
  3107. var result = new OfficeExtension.ClientResult();
  3108. result.__proto__ = null;
  3109. result.value = {};
  3110. return result;
  3111. }
  3112. _V1Api.prototype.setSelectedData = function(input) {
  3113. /// <returns type="OfficeExtension.ClientResult&lt;any&gt;"></returns>
  3114. var result = new OfficeExtension.ClientResult();
  3115. result.__proto__ = null;
  3116. result.value = {};
  3117. return result;
  3118. }
  3119. return _V1Api;
  3120. })(OfficeExtension.ClientObject);
  3121. Excel._V1Api = _V1Api;
  3122. })(Excel || (Excel = {__proto__: null}));
  3123. var Excel;
  3124. (function (Excel) {
  3125. var Application = (function(_super) {
  3126. __extends(Application, _super);
  3127. function Application() {
  3128. /// <summary> Represents the Excel application that manages the workbook. [Api set: ExcelApi 1.1] </summary>
  3129. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  3130. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  3131. /// <field name="calculationMode" type="String">Returns the calculation mode used in the workbook. See Excel.CalculationMode for details. Read-only. [Api set: ExcelApi 1.1]</field>
  3132. }
  3133. Application.prototype.load = function(option) {
  3134. /// <summary>
  3135. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  3136. /// </summary>
  3137. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  3138. /// <returns type="Excel.Application"/>
  3139. }
  3140. Application.prototype.calculate = function(calculationType) {
  3141. /// <summary>
  3142. /// Recalculate all currently opened workbooks in Excel. [Api set: ExcelApi 1.1]
  3143. /// </summary>
  3144. /// <param name="calculationType" type="String">Specifies the calculation type to use. See Excel.CalculationType for details.</param>
  3145. /// <returns ></returns>
  3146. }
  3147. return Application;
  3148. })(OfficeExtension.ClientObject);
  3149. Excel.Application = Application;
  3150. })(Excel || (Excel = {__proto__: null}));
  3151. var Excel;
  3152. (function (Excel) {
  3153. var Binding = (function(_super) {
  3154. __extends(Binding, _super);
  3155. function Binding() {
  3156. /// <summary> Represents an Office.js binding that is defined in the workbook. [Api set: ExcelApi 1.1] </summary>
  3157. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  3158. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  3159. /// <field name="id" type="String">Represents binding identifier. Read-only. [Api set: ExcelApi 1.1]</field>
  3160. /// <field name="type" type="String">Returns the type of the binding. See Excel.BindingType for details. Read-only. [Api set: ExcelApi 1.1]</field>
  3161. /// <field name="onDataChanged" type="OfficeExtension.EventHandlers">Occurs when data or formatting within the binding is changed. [Api set: ExcelApi 1.2]</field>
  3162. /// <field name="onSelectionChanged" type="OfficeExtension.EventHandlers">Occurs when the selection is changed within the binding. [Api set: ExcelApi 1.2]</field>
  3163. }
  3164. Binding.prototype.load = function(option) {
  3165. /// <summary>
  3166. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  3167. /// </summary>
  3168. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  3169. /// <returns type="Excel.Binding"/>
  3170. }
  3171. Binding.prototype.delete = function() {
  3172. /// <summary>
  3173. /// Deletes the binding. [Api set: ExcelApi 1.3]
  3174. /// </summary>
  3175. /// <returns ></returns>
  3176. }
  3177. Binding.prototype.getRange = function() {
  3178. /// <summary>
  3179. /// Returns the range represented by the binding. Will throw an error if binding is not of the correct type. [Api set: ExcelApi 1.1]
  3180. /// </summary>
  3181. /// <returns type="Excel.Range"></returns>
  3182. }
  3183. Binding.prototype.getTable = function() {
  3184. /// <summary>
  3185. /// Returns the table represented by the binding. Will throw an error if binding is not of the correct type. [Api set: ExcelApi 1.1]
  3186. /// </summary>
  3187. /// <returns type="Excel.Table"></returns>
  3188. }
  3189. Binding.prototype.getText = function() {
  3190. /// <summary>
  3191. /// Returns the text represented by the binding. Will throw an error if binding is not of the correct type. [Api set: ExcelApi 1.1]
  3192. /// </summary>
  3193. /// <returns type="OfficeExtension.ClientResult&lt;string&gt;"></returns>
  3194. var result = new OfficeExtension.ClientResult();
  3195. result.__proto__ = null;
  3196. result.value = '';
  3197. return result;
  3198. }
  3199. Binding.prototype.onDataChanged = {
  3200. __proto__: null,
  3201. add: function (handler) {
  3202. /// <param name="handler" type="function(eventArgs: Excel.Interfaces.BindingDataChangedEventArgs)">Handler for the event. EventArgs: Provides information about the binding that raised the DataChanged event. </param>
  3203. /// <returns type="OfficeExtension.EventHandlerResult"></returns>
  3204. var eventInfo = new Excel.Interfaces.BindingDataChangedEventArgs();
  3205. eventInfo.__proto__ = null;
  3206. handler(eventInfo);
  3207. },
  3208. remove: function (handler) {
  3209. /// <param name="handler" type="function(eventArgs: Excel.Interfaces.BindingDataChangedEventArgs)">Handler for the event.</param>
  3210. return;
  3211. },
  3212. removeAll: function () {
  3213. return;
  3214. }
  3215. };
  3216. Binding.prototype.onSelectionChanged = {
  3217. __proto__: null,
  3218. add: function (handler) {
  3219. /// <param name="handler" type="function(eventArgs: Excel.Interfaces.BindingSelectionChangedEventArgs)">Handler for the event. EventArgs: Provides information about the binding that raised the SelectionChanged event. </param>
  3220. /// <returns type="OfficeExtension.EventHandlerResult"></returns>
  3221. var eventInfo = new Excel.Interfaces.BindingSelectionChangedEventArgs();
  3222. eventInfo.__proto__ = null;
  3223. handler(eventInfo);
  3224. },
  3225. remove: function (handler) {
  3226. /// <param name="handler" type="function(eventArgs: Excel.Interfaces.BindingSelectionChangedEventArgs)">Handler for the event.</param>
  3227. return;
  3228. },
  3229. removeAll: function () {
  3230. return;
  3231. }
  3232. };
  3233. return Binding;
  3234. })(OfficeExtension.ClientObject);
  3235. Excel.Binding = Binding;
  3236. })(Excel || (Excel = {__proto__: null}));
  3237. var Excel;
  3238. (function (Excel) {
  3239. var BindingCollection = (function(_super) {
  3240. __extends(BindingCollection, _super);
  3241. function BindingCollection() {
  3242. /// <summary> Represents the collection of all the binding objects that are part of the workbook. [Api set: ExcelApi 1.1] </summary>
  3243. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  3244. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  3245. /// <field name="count" type="Number">Returns the number of bindings in the collection. Read-only. [Api set: ExcelApi 1.1]</field>
  3246. /// <field name="items" type="Array" elementType="Excel.Binding">Gets the loaded child items in this collection.</field>
  3247. }
  3248. BindingCollection.prototype.load = function(option) {
  3249. /// <summary>
  3250. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  3251. /// </summary>
  3252. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  3253. /// <returns type="Excel.BindingCollection"/>
  3254. }
  3255. BindingCollection.prototype.add = function(range, bindingType, id) {
  3256. /// <summary>
  3257. /// Add a new binding to a particular Range. [Api set: ExcelApi 1.3]
  3258. /// </summary>
  3259. /// <param name="range" >Range to bind the binding to. May be an Excel Range object, or a string. If string, must contain the full address, including the sheet name</param>
  3260. /// <param name="bindingType" type="String">Type of binding. See Excel.BindingType.</param>
  3261. /// <param name="id" type="String">Name of binding.</param>
  3262. /// <returns type="Excel.Binding"></returns>
  3263. }
  3264. BindingCollection.prototype.addFromNamedItem = function(name, bindingType, id) {
  3265. /// <summary>
  3266. /// Add a new binding based on a named item in the workbook. [Api set: ExcelApi 1.3]
  3267. /// </summary>
  3268. /// <param name="name" type="String">Name from which to create binding.</param>
  3269. /// <param name="bindingType" type="String">Type of binding. See Excel.BindingType.</param>
  3270. /// <param name="id" type="String">Name of binding.</param>
  3271. /// <returns type="Excel.Binding"></returns>
  3272. }
  3273. BindingCollection.prototype.addFromSelection = function(bindingType, id) {
  3274. /// <summary>
  3275. /// Add a new binding based on the current selection. [Api set: ExcelApi 1.3]
  3276. /// </summary>
  3277. /// <param name="bindingType" type="String">Type of binding. See Excel.BindingType.</param>
  3278. /// <param name="id" type="String">Name of binding.</param>
  3279. /// <returns type="Excel.Binding"></returns>
  3280. }
  3281. BindingCollection.prototype.getItem = function(id) {
  3282. /// <summary>
  3283. /// Gets a binding object by ID. [Api set: ExcelApi 1.1]
  3284. /// </summary>
  3285. /// <param name="id" type="String">Id of the binding object to be retrieved.</param>
  3286. /// <returns type="Excel.Binding"></returns>
  3287. }
  3288. BindingCollection.prototype.getItemAt = function(index) {
  3289. /// <summary>
  3290. /// Gets a binding object based on its position in the items array. [Api set: ExcelApi 1.1]
  3291. /// </summary>
  3292. /// <param name="index" type="Number">Index value of the object to be retrieved. Zero-indexed.</param>
  3293. /// <returns type="Excel.Binding"></returns>
  3294. }
  3295. return BindingCollection;
  3296. })(OfficeExtension.ClientObject);
  3297. Excel.BindingCollection = BindingCollection;
  3298. })(Excel || (Excel = {__proto__: null}));
  3299. var Excel;
  3300. (function (Excel) {
  3301. var Interfaces;
  3302. (function (Interfaces) {
  3303. var BindingDataChangedEventArgs = (function() {
  3304. function BindingDataChangedEventArgs() {
  3305. /// <summary> Provides information about the binding that raised the DataChanged event. [Api set: ExcelApi 1.2] </summary>
  3306. /// <field name="binding" type="Excel.Binding">Gets the Binding object that represents the binding that raised the DataChanged event. [Api set: ExcelApi 1.2]</field>
  3307. }
  3308. return BindingDataChangedEventArgs;
  3309. })();
  3310. Interfaces.BindingDataChangedEventArgs.__proto__ = null;
  3311. Interfaces.BindingDataChangedEventArgs = BindingDataChangedEventArgs;
  3312. })(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
  3313. })(Excel || (Excel = {__proto__: null}));
  3314. var Excel;
  3315. (function (Excel) {
  3316. var Interfaces;
  3317. (function (Interfaces) {
  3318. var BindingSelectionChangedEventArgs = (function() {
  3319. function BindingSelectionChangedEventArgs() {
  3320. /// <summary> Provides information about the binding that raised the SelectionChanged event. [Api set: ExcelApi 1.2] </summary>
  3321. /// <field name="binding" type="Excel.Binding">Gets the Binding object that represents the binding that raised the SelectionChanged event. [Api set: ExcelApi 1.2]</field>
  3322. /// <field name="columnCount" type="Number">Gets the number of columns selected. [Api set: ExcelApi 1.2]</field>
  3323. /// <field name="rowCount" type="Number">Gets the number of rows selected. [Api set: ExcelApi 1.2]</field>
  3324. /// <field name="startColumn" type="Number">Gets the index of the first column of the selection (zero-based). [Api set: ExcelApi 1.2]</field>
  3325. /// <field name="startRow" type="Number">Gets the index of the first row of the selection (zero-based). [Api set: ExcelApi 1.2]</field>
  3326. }
  3327. return BindingSelectionChangedEventArgs;
  3328. })();
  3329. Interfaces.BindingSelectionChangedEventArgs.__proto__ = null;
  3330. Interfaces.BindingSelectionChangedEventArgs = BindingSelectionChangedEventArgs;
  3331. })(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
  3332. })(Excel || (Excel = {__proto__: null}));
  3333. var Excel;
  3334. (function (Excel) {
  3335. /// <summary> [Api set: ExcelApi 1.1] </summary>
  3336. var BindingType = {
  3337. __proto__: null,
  3338. "range": "range",
  3339. "table": "table",
  3340. "text": "text",
  3341. }
  3342. Excel.BindingType = BindingType;
  3343. })(Excel || (Excel = {__proto__: null}));
  3344. var Excel;
  3345. (function (Excel) {
  3346. /// <summary> [Api set: ExcelApi 1.1] </summary>
  3347. var BorderIndex = {
  3348. __proto__: null,
  3349. "edgeTop": "edgeTop",
  3350. "edgeBottom": "edgeBottom",
  3351. "edgeLeft": "edgeLeft",
  3352. "edgeRight": "edgeRight",
  3353. "insideVertical": "insideVertical",
  3354. "insideHorizontal": "insideHorizontal",
  3355. "diagonalDown": "diagonalDown",
  3356. "diagonalUp": "diagonalUp",
  3357. }
  3358. Excel.BorderIndex = BorderIndex;
  3359. })(Excel || (Excel = {__proto__: null}));
  3360. var Excel;
  3361. (function (Excel) {
  3362. /// <summary> [Api set: ExcelApi 1.1] </summary>
  3363. var BorderLineStyle = {
  3364. __proto__: null,
  3365. "none": "none",
  3366. "continuous": "continuous",
  3367. "dash": "dash",
  3368. "dashDot": "dashDot",
  3369. "dashDotDot": "dashDotDot",
  3370. "dot": "dot",
  3371. "double": "double",
  3372. "slantDashDot": "slantDashDot",
  3373. }
  3374. Excel.BorderLineStyle = BorderLineStyle;
  3375. })(Excel || (Excel = {__proto__: null}));
  3376. var Excel;
  3377. (function (Excel) {
  3378. /// <summary> [Api set: ExcelApi 1.1] </summary>
  3379. var BorderWeight = {
  3380. __proto__: null,
  3381. "hairline": "hairline",
  3382. "thin": "thin",
  3383. "medium": "medium",
  3384. "thick": "thick",
  3385. }
  3386. Excel.BorderWeight = BorderWeight;
  3387. })(Excel || (Excel = {__proto__: null}));
  3388. var Excel;
  3389. (function (Excel) {
  3390. /// <summary> [Api set: ExcelApi 1.1] </summary>
  3391. var CalculationMode = {
  3392. __proto__: null,
  3393. "automatic": "automatic",
  3394. "automaticExceptTables": "automaticExceptTables",
  3395. "manual": "manual",
  3396. }
  3397. Excel.CalculationMode = CalculationMode;
  3398. })(Excel || (Excel = {__proto__: null}));
  3399. var Excel;
  3400. (function (Excel) {
  3401. /// <summary> [Api set: ExcelApi 1.1] </summary>
  3402. var CalculationType = {
  3403. __proto__: null,
  3404. "recalculate": "recalculate",
  3405. "full": "full",
  3406. "fullRebuild": "fullRebuild",
  3407. }
  3408. Excel.CalculationType = CalculationType;
  3409. })(Excel || (Excel = {__proto__: null}));
  3410. var Excel;
  3411. (function (Excel) {
  3412. var Chart = (function(_super) {
  3413. __extends(Chart, _super);
  3414. function Chart() {
  3415. /// <summary> Represents a chart object in a workbook. [Api set: ExcelApi 1.1] </summary>
  3416. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  3417. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  3418. /// <field name="axes" type="Excel.ChartAxes">Represents chart axes. Read-only. [Api set: ExcelApi 1.1]</field>
  3419. /// <field name="dataLabels" type="Excel.ChartDataLabels">Represents the datalabels on the chart. Read-only. [Api set: ExcelApi 1.1]</field>
  3420. /// <field name="format" type="Excel.ChartAreaFormat">Encapsulates the format properties for the chart area. Read-only. [Api set: ExcelApi 1.1]</field>
  3421. /// <field name="height" type="Number">Represents the height, in points, of the chart object. [Api set: ExcelApi 1.1]</field>
  3422. /// <field name="left" type="Number">The distance, in points, from the left side of the chart to the worksheet origin. [Api set: ExcelApi 1.1]</field>
  3423. /// <field name="legend" type="Excel.ChartLegend">Represents the legend for the chart. Read-only. [Api set: ExcelApi 1.1]</field>
  3424. /// <field name="name" type="String">Represents the name of a chart object. [Api set: ExcelApi 1.1]</field>
  3425. /// <field name="series" type="Excel.ChartSeriesCollection">Represents either a single series or collection of series in the chart. Read-only. [Api set: ExcelApi 1.1]</field>
  3426. /// <field name="title" type="Excel.ChartTitle">Represents the title of the specified chart, including the text, visibility, position and formating of the title. Read-only. [Api set: ExcelApi 1.1]</field>
  3427. /// <field name="top" type="Number">Represents the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart). [Api set: ExcelApi 1.1]</field>
  3428. /// <field name="width" type="Number">Represents the width, in points, of the chart object. [Api set: ExcelApi 1.1]</field>
  3429. /// <field name="worksheet" type="Excel.Worksheet">The worksheet containing the current chart. Read-only. [Api set: ExcelApi 1.2]</field>
  3430. }
  3431. Chart.prototype.load = function(option) {
  3432. /// <summary>
  3433. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  3434. /// </summary>
  3435. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  3436. /// <returns type="Excel.Chart"/>
  3437. }
  3438. Chart.prototype.delete = function() {
  3439. /// <summary>
  3440. /// Deletes the chart object. [Api set: ExcelApi 1.1]
  3441. /// </summary>
  3442. /// <returns ></returns>
  3443. }
  3444. Chart.prototype.getImage = function(width, height, fittingMode) {
  3445. /// <summary>
  3446. /// Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. The aspect ratio is preserved as part of the resizing. [Api set: ExcelApi 1.2]
  3447. /// </summary>
  3448. /// <param name="height" type="Number" optional="true">(Optional) The desired height of the resulting image.</param>
  3449. /// <param name="width" type="Number" optional="true">(Optional) The desired width of the resulting image.</param>
  3450. /// <param name="fittingMode" type="String" optional="true">(Optional) The method used to scale the chart to the specified to the specified dimensions (if both height and width are set).&quot;</param>
  3451. /// <returns type="OfficeExtension.ClientResult&lt;string&gt;"></returns>
  3452. var result = new OfficeExtension.ClientResult();
  3453. result.__proto__ = null;
  3454. result.value = '';
  3455. return result;
  3456. }
  3457. Chart.prototype.setData = function(sourceData, seriesBy) {
  3458. /// <summary>
  3459. /// Resets the source data for the chart. [Api set: ExcelApi 1.1]
  3460. /// </summary>
  3461. /// <param name="sourceData" >The Range object corresponding to the source data.</param>
  3462. /// <param name="seriesBy" type="String" optional="true">Specifies the way columns or rows are used as data series on the chart. Can be one of the following: Auto (default), Rows, Columns. See Excel.ChartSeriesBy for details.</param>
  3463. /// <returns ></returns>
  3464. }
  3465. Chart.prototype.setPosition = function(startCell, endCell) {
  3466. /// <summary>
  3467. /// Positions the chart relative to cells on the worksheet. [Api set: ExcelApi 1.1]
  3468. /// </summary>
  3469. /// <param name="startCell" >The start cell. This is where the chart will be moved to. The start cell is the top-left or top-right cell, depending on the user&apos;s right-to-left display settings.</param>
  3470. /// <param name="endCell" optional="true">(Optional) The end cell. If specified, the chart&apos;s width and height will be set to fully cover up this cell/range.</param>
  3471. /// <returns ></returns>
  3472. }
  3473. return Chart;
  3474. })(OfficeExtension.ClientObject);
  3475. Excel.Chart = Chart;
  3476. })(Excel || (Excel = {__proto__: null}));
  3477. var Excel;
  3478. (function (Excel) {
  3479. var ChartAreaFormat = (function(_super) {
  3480. __extends(ChartAreaFormat, _super);
  3481. function ChartAreaFormat() {
  3482. /// <summary> Encapsulates the format properties for the overall chart area. [Api set: ExcelApi 1.1] </summary>
  3483. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  3484. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  3485. /// <field name="fill" type="Excel.ChartFill">Represents the fill format of an object, which includes background formatting information. Read-only. [Api set: ExcelApi 1.1]</field>
  3486. /// <field name="font" type="Excel.ChartFont">Represents the font attributes (font name, font size, color, etc.) for the current object. Read-only. [Api set: ExcelApi 1.1]</field>
  3487. }
  3488. ChartAreaFormat.prototype.load = function(option) {
  3489. /// <summary>
  3490. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  3491. /// </summary>
  3492. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  3493. /// <returns type="Excel.ChartAreaFormat"/>
  3494. }
  3495. return ChartAreaFormat;
  3496. })(OfficeExtension.ClientObject);
  3497. Excel.ChartAreaFormat = ChartAreaFormat;
  3498. })(Excel || (Excel = {__proto__: null}));
  3499. var Excel;
  3500. (function (Excel) {
  3501. var ChartAxes = (function(_super) {
  3502. __extends(ChartAxes, _super);
  3503. function ChartAxes() {
  3504. /// <summary> Represents the chart axes. [Api set: ExcelApi 1.1] </summary>
  3505. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  3506. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  3507. /// <field name="categoryAxis" type="Excel.ChartAxis">Represents the category axis in a chart. Read-only. [Api set: ExcelApi 1.1]</field>
  3508. /// <field name="seriesAxis" type="Excel.ChartAxis">Represents the series axis of a 3-dimensional chart. Read-only. [Api set: ExcelApi 1.1]</field>
  3509. /// <field name="valueAxis" type="Excel.ChartAxis">Represents the value axis in an axis. Read-only. [Api set: ExcelApi 1.1]</field>
  3510. }
  3511. ChartAxes.prototype.load = function(option) {
  3512. /// <summary>
  3513. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  3514. /// </summary>
  3515. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  3516. /// <returns type="Excel.ChartAxes"/>
  3517. }
  3518. return ChartAxes;
  3519. })(OfficeExtension.ClientObject);
  3520. Excel.ChartAxes = ChartAxes;
  3521. })(Excel || (Excel = {__proto__: null}));
  3522. var Excel;
  3523. (function (Excel) {
  3524. var ChartAxis = (function(_super) {
  3525. __extends(ChartAxis, _super);
  3526. function ChartAxis() {
  3527. /// <summary> Represents a single axis in a chart. [Api set: ExcelApi 1.1] </summary>
  3528. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  3529. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  3530. /// <field name="format" type="Excel.ChartAxisFormat">Represents the formatting of a chart object, which includes line and font formatting. Read-only. [Api set: ExcelApi 1.1]</field>
  3531. /// <field name="majorGridlines" type="Excel.ChartGridlines">Returns a gridlines object that represents the major gridlines for the specified axis. Read-only. [Api set: ExcelApi 1.1]</field>
  3532. /// <field name="majorUnit" >Represents the interval between two major tick marks. Can be set to a numeric value or an empty string. The returned value is always a number. [Api set: ExcelApi 1.1]</field>
  3533. /// <field name="maximum" >Represents the maximum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number. [Api set: ExcelApi 1.1]</field>
  3534. /// <field name="minimum" >Represents the minimum value on the value axis. Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number. [Api set: ExcelApi 1.1]</field>
  3535. /// <field name="minorGridlines" type="Excel.ChartGridlines">Returns a Gridlines object that represents the minor gridlines for the specified axis. Read-only. [Api set: ExcelApi 1.1]</field>
  3536. /// <field name="minorUnit" >Represents the interval between two minor tick marks. &quot;Can be set to a numeric value or an empty string (for automatic axis values). The returned value is always a number. [Api set: ExcelApi 1.1]</field>
  3537. /// <field name="title" type="Excel.ChartAxisTitle">Represents the axis title. Read-only. [Api set: ExcelApi 1.1]</field>
  3538. }
  3539. ChartAxis.prototype.load = function(option) {
  3540. /// <summary>
  3541. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  3542. /// </summary>
  3543. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  3544. /// <returns type="Excel.ChartAxis"/>
  3545. }
  3546. return ChartAxis;
  3547. })(OfficeExtension.ClientObject);
  3548. Excel.ChartAxis = ChartAxis;
  3549. })(Excel || (Excel = {__proto__: null}));
  3550. var Excel;
  3551. (function (Excel) {
  3552. var ChartAxisFormat = (function(_super) {
  3553. __extends(ChartAxisFormat, _super);
  3554. function ChartAxisFormat() {
  3555. /// <summary> Encapsulates the format properties for the chart axis. [Api set: ExcelApi 1.1] </summary>
  3556. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  3557. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  3558. /// <field name="font" type="Excel.ChartFont">Represents the font attributes (font name, font size, color, etc.) for a chart axis element. Read-only. [Api set: ExcelApi 1.1]</field>
  3559. /// <field name="line" type="Excel.ChartLineFormat">Represents chart line formatting. Read-only. [Api set: ExcelApi 1.1]</field>
  3560. }
  3561. ChartAxisFormat.prototype.load = function(option) {
  3562. /// <summary>
  3563. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  3564. /// </summary>
  3565. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  3566. /// <returns type="Excel.ChartAxisFormat"/>
  3567. }
  3568. return ChartAxisFormat;
  3569. })(OfficeExtension.ClientObject);
  3570. Excel.ChartAxisFormat = ChartAxisFormat;
  3571. })(Excel || (Excel = {__proto__: null}));
  3572. var Excel;
  3573. (function (Excel) {
  3574. var ChartAxisTitle = (function(_super) {
  3575. __extends(ChartAxisTitle, _super);
  3576. function ChartAxisTitle() {
  3577. /// <summary> Represents the title of a chart axis. [Api set: ExcelApi 1.1] </summary>
  3578. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  3579. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  3580. /// <field name="format" type="Excel.ChartAxisTitleFormat">Represents the formatting of chart axis title. Read-only. [Api set: ExcelApi 1.1]</field>
  3581. /// <field name="text" type="String">Represents the axis title. [Api set: ExcelApi 1.1]</field>
  3582. /// <field name="visible" type="Boolean">A boolean that specifies the visibility of an axis title. [Api set: ExcelApi 1.1]</field>
  3583. }
  3584. ChartAxisTitle.prototype.load = function(option) {
  3585. /// <summary>
  3586. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  3587. /// </summary>
  3588. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  3589. /// <returns type="Excel.ChartAxisTitle"/>
  3590. }
  3591. return ChartAxisTitle;
  3592. })(OfficeExtension.ClientObject);
  3593. Excel.ChartAxisTitle = ChartAxisTitle;
  3594. })(Excel || (Excel = {__proto__: null}));
  3595. var Excel;
  3596. (function (Excel) {
  3597. var ChartAxisTitleFormat = (function(_super) {
  3598. __extends(ChartAxisTitleFormat, _super);
  3599. function ChartAxisTitleFormat() {
  3600. /// <summary> Represents the chart axis title formatting. [Api set: ExcelApi 1.1] </summary>
  3601. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  3602. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  3603. /// <field name="font" type="Excel.ChartFont">Represents the font attributes, such as font name, font size, color, etc. of chart axis title object. Read-only. [Api set: ExcelApi 1.1]</field>
  3604. }
  3605. ChartAxisTitleFormat.prototype.load = function(option) {
  3606. /// <summary>
  3607. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  3608. /// </summary>
  3609. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  3610. /// <returns type="Excel.ChartAxisTitleFormat"/>
  3611. }
  3612. return ChartAxisTitleFormat;
  3613. })(OfficeExtension.ClientObject);
  3614. Excel.ChartAxisTitleFormat = ChartAxisTitleFormat;
  3615. })(Excel || (Excel = {__proto__: null}));
  3616. var Excel;
  3617. (function (Excel) {
  3618. var ChartCollection = (function(_super) {
  3619. __extends(ChartCollection, _super);
  3620. function ChartCollection() {
  3621. /// <summary> A collection of all the chart objects on a worksheet. [Api set: ExcelApi 1.1] </summary>
  3622. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  3623. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  3624. /// <field name="count" type="Number">Returns the number of charts in the worksheet. Read-only. [Api set: ExcelApi 1.1]</field>
  3625. /// <field name="items" type="Array" elementType="Excel.Chart">Gets the loaded child items in this collection.</field>
  3626. }
  3627. ChartCollection.prototype.load = function(option) {
  3628. /// <summary>
  3629. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  3630. /// </summary>
  3631. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  3632. /// <returns type="Excel.ChartCollection"/>
  3633. }
  3634. ChartCollection.prototype.add = function(type, sourceData, seriesBy) {
  3635. /// <summary>
  3636. /// Creates a new chart. [Api set: ExcelApi 1.1]
  3637. /// </summary>
  3638. /// <param name="type" type="String">Represents the type of a chart. See Excel.ChartType for details.</param>
  3639. /// <param name="sourceData" >The Range object corresponding to the source data.</param>
  3640. /// <param name="seriesBy" type="String" optional="true">Specifies the way columns or rows are used as data series on the chart. See Excel.ChartSeriesBy for details.</param>
  3641. /// <returns type="Excel.Chart"></returns>
  3642. }
  3643. ChartCollection.prototype.getItem = function(name) {
  3644. /// <summary>
  3645. /// Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned. [Api set: ExcelApi 1.1]
  3646. /// </summary>
  3647. /// <param name="name" type="String">Name of the chart to be retrieved.</param>
  3648. /// <returns type="Excel.Chart"></returns>
  3649. }
  3650. ChartCollection.prototype.getItemAt = function(index) {
  3651. /// <summary>
  3652. /// Gets a chart based on its position in the collection. [Api set: ExcelApi 1.1]
  3653. /// </summary>
  3654. /// <param name="index" type="Number">Index value of the object to be retrieved. Zero-indexed.</param>
  3655. /// <returns type="Excel.Chart"></returns>
  3656. }
  3657. return ChartCollection;
  3658. })(OfficeExtension.ClientObject);
  3659. Excel.ChartCollection = ChartCollection;
  3660. })(Excel || (Excel = {__proto__: null}));
  3661. var Excel;
  3662. (function (Excel) {
  3663. var ChartDataLabelFormat = (function(_super) {
  3664. __extends(ChartDataLabelFormat, _super);
  3665. function ChartDataLabelFormat() {
  3666. /// <summary> Encapsulates the format properties for the chart data labels. [Api set: ExcelApi 1.1] </summary>
  3667. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  3668. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  3669. /// <field name="fill" type="Excel.ChartFill">Represents the fill format of the current chart data label. Read-only. [Api set: ExcelApi 1.1]</field>
  3670. /// <field name="font" type="Excel.ChartFont">Represents the font attributes (font name, font size, color, etc.) for a chart data label. Read-only. [Api set: ExcelApi 1.1]</field>
  3671. }
  3672. ChartDataLabelFormat.prototype.load = function(option) {
  3673. /// <summary>
  3674. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  3675. /// </summary>
  3676. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  3677. /// <returns type="Excel.ChartDataLabelFormat"/>
  3678. }
  3679. return ChartDataLabelFormat;
  3680. })(OfficeExtension.ClientObject);
  3681. Excel.ChartDataLabelFormat = ChartDataLabelFormat;
  3682. })(Excel || (Excel = {__proto__: null}));
  3683. var Excel;
  3684. (function (Excel) {
  3685. /// <summary> [Api set: ExcelApi 1.1] </summary>
  3686. var ChartDataLabelPosition = {
  3687. __proto__: null,
  3688. "invalid": "invalid",
  3689. "none": "none",
  3690. "center": "center",
  3691. "insideEnd": "insideEnd",
  3692. "insideBase": "insideBase",
  3693. "outsideEnd": "outsideEnd",
  3694. "left": "left",
  3695. "right": "right",
  3696. "top": "top",
  3697. "bottom": "bottom",
  3698. "bestFit": "bestFit",
  3699. "callout": "callout",
  3700. }
  3701. Excel.ChartDataLabelPosition = ChartDataLabelPosition;
  3702. })(Excel || (Excel = {__proto__: null}));
  3703. var Excel;
  3704. (function (Excel) {
  3705. var ChartDataLabels = (function(_super) {
  3706. __extends(ChartDataLabels, _super);
  3707. function ChartDataLabels() {
  3708. /// <summary> Represents a collection of all the data labels on a chart point. [Api set: ExcelApi 1.1] </summary>
  3709. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  3710. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  3711. /// <field name="format" type="Excel.ChartDataLabelFormat">Represents the format of chart data labels, which includes fill and font formatting. Read-only. [Api set: ExcelApi 1.1]</field>
  3712. /// <field name="position" type="String">DataLabelPosition value that represents the position of the data label. See Excel.ChartDataLabelPosition for details. [Api set: ExcelApi 1.1]</field>
  3713. /// <field name="separator" type="String">String representing the separator used for the data labels on a chart. [Api set: ExcelApi 1.1]</field>
  3714. /// <field name="showBubbleSize" type="Boolean">Boolean value representing if the data label bubble size is visible or not. [Api set: ExcelApi 1.1]</field>
  3715. /// <field name="showCategoryName" type="Boolean">Boolean value representing if the data label category name is visible or not. [Api set: ExcelApi 1.1]</field>
  3716. /// <field name="showLegendKey" type="Boolean">Boolean value representing if the data label legend key is visible or not. [Api set: ExcelApi 1.1]</field>
  3717. /// <field name="showPercentage" type="Boolean">Boolean value representing if the data label percentage is visible or not. [Api set: ExcelApi 1.1]</field>
  3718. /// <field name="showSeriesName" type="Boolean">Boolean value representing if the data label series name is visible or not. [Api set: ExcelApi 1.1]</field>
  3719. /// <field name="showValue" type="Boolean">Boolean value representing if the data label value is visible or not. [Api set: ExcelApi 1.1]</field>
  3720. }
  3721. ChartDataLabels.prototype.load = function(option) {
  3722. /// <summary>
  3723. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  3724. /// </summary>
  3725. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  3726. /// <returns type="Excel.ChartDataLabels"/>
  3727. }
  3728. return ChartDataLabels;
  3729. })(OfficeExtension.ClientObject);
  3730. Excel.ChartDataLabels = ChartDataLabels;
  3731. })(Excel || (Excel = {__proto__: null}));
  3732. var Excel;
  3733. (function (Excel) {
  3734. var ChartFill = (function(_super) {
  3735. __extends(ChartFill, _super);
  3736. function ChartFill() {
  3737. /// <summary> Represents the fill formatting for a chart element. [Api set: ExcelApi 1.1] </summary>
  3738. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  3739. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  3740. }
  3741. ChartFill.prototype.load = function(option) {
  3742. /// <summary>
  3743. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  3744. /// </summary>
  3745. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  3746. /// <returns type="Excel.ChartFill"/>
  3747. }
  3748. ChartFill.prototype.clear = function() {
  3749. /// <summary>
  3750. /// Clear the fill color of a chart element. [Api set: ExcelApi 1.1]
  3751. /// </summary>
  3752. /// <returns ></returns>
  3753. }
  3754. ChartFill.prototype.setSolidColor = function(color) {
  3755. /// <summary>
  3756. /// Sets the fill formatting of a chart element to a uniform color. [Api set: ExcelApi 1.1]
  3757. /// </summary>
  3758. /// <param name="color" type="String">HTML color code representing the color of the border line, of the form #RRGGBB (e.g. &quot;FFA500&quot;) or as a named HTML color (e.g. &quot;orange&quot;).</param>
  3759. /// <returns ></returns>
  3760. }
  3761. return ChartFill;
  3762. })(OfficeExtension.ClientObject);
  3763. Excel.ChartFill = ChartFill;
  3764. })(Excel || (Excel = {__proto__: null}));
  3765. var Excel;
  3766. (function (Excel) {
  3767. var ChartFont = (function(_super) {
  3768. __extends(ChartFont, _super);
  3769. function ChartFont() {
  3770. /// <summary> This object represents the font attributes (font name, font size, color, etc.) for a chart object. [Api set: ExcelApi 1.1] </summary>
  3771. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  3772. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  3773. /// <field name="bold" type="Boolean">Represents the bold status of font. [Api set: ExcelApi 1.1]</field>
  3774. /// <field name="color" type="String">HTML color code representation of the text color. E.g. #FF0000 represents Red. [Api set: ExcelApi 1.1]</field>
  3775. /// <field name="italic" type="Boolean">Represents the italic status of the font. [Api set: ExcelApi 1.1]</field>
  3776. /// <field name="name" type="String">Font name (e.g. &quot;Calibri&quot;) [Api set: ExcelApi 1.1]</field>
  3777. /// <field name="size" type="Number">Size of the font (e.g. 11) [Api set: ExcelApi 1.1]</field>
  3778. /// <field name="underline" type="String">Type of underline applied to the font. See Excel.ChartUnderlineStyle for details. [Api set: ExcelApi 1.1]</field>
  3779. }
  3780. ChartFont.prototype.load = function(option) {
  3781. /// <summary>
  3782. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  3783. /// </summary>
  3784. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  3785. /// <returns type="Excel.ChartFont"/>
  3786. }
  3787. return ChartFont;
  3788. })(OfficeExtension.ClientObject);
  3789. Excel.ChartFont = ChartFont;
  3790. })(Excel || (Excel = {__proto__: null}));
  3791. var Excel;
  3792. (function (Excel) {
  3793. var ChartGridlines = (function(_super) {
  3794. __extends(ChartGridlines, _super);
  3795. function ChartGridlines() {
  3796. /// <summary> Represents major or minor gridlines on a chart axis. [Api set: ExcelApi 1.1] </summary>
  3797. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  3798. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  3799. /// <field name="format" type="Excel.ChartGridlinesFormat">Represents the formatting of chart gridlines. Read-only. [Api set: ExcelApi 1.1]</field>
  3800. /// <field name="visible" type="Boolean">Boolean value representing if the axis gridlines are visible or not. [Api set: ExcelApi 1.1]</field>
  3801. }
  3802. ChartGridlines.prototype.load = function(option) {
  3803. /// <summary>
  3804. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  3805. /// </summary>
  3806. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  3807. /// <returns type="Excel.ChartGridlines"/>
  3808. }
  3809. return ChartGridlines;
  3810. })(OfficeExtension.ClientObject);
  3811. Excel.ChartGridlines = ChartGridlines;
  3812. })(Excel || (Excel = {__proto__: null}));
  3813. var Excel;
  3814. (function (Excel) {
  3815. var ChartGridlinesFormat = (function(_super) {
  3816. __extends(ChartGridlinesFormat, _super);
  3817. function ChartGridlinesFormat() {
  3818. /// <summary> Encapsulates the format properties for chart gridlines. [Api set: ExcelApi 1.1] </summary>
  3819. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  3820. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  3821. /// <field name="line" type="Excel.ChartLineFormat">Represents chart line formatting. Read-only. [Api set: ExcelApi 1.1]</field>
  3822. }
  3823. ChartGridlinesFormat.prototype.load = function(option) {
  3824. /// <summary>
  3825. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  3826. /// </summary>
  3827. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  3828. /// <returns type="Excel.ChartGridlinesFormat"/>
  3829. }
  3830. return ChartGridlinesFormat;
  3831. })(OfficeExtension.ClientObject);
  3832. Excel.ChartGridlinesFormat = ChartGridlinesFormat;
  3833. })(Excel || (Excel = {__proto__: null}));
  3834. var Excel;
  3835. (function (Excel) {
  3836. var ChartLegend = (function(_super) {
  3837. __extends(ChartLegend, _super);
  3838. function ChartLegend() {
  3839. /// <summary> Represents the legend in a chart. [Api set: ExcelApi 1.1] </summary>
  3840. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  3841. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  3842. /// <field name="format" type="Excel.ChartLegendFormat">Represents the formatting of a chart legend, which includes fill and font formatting. Read-only. [Api set: ExcelApi 1.1]</field>
  3843. /// <field name="overlay" type="Boolean">Boolean value for whether the chart legend should overlap with the main body of the chart. [Api set: ExcelApi 1.1]</field>
  3844. /// <field name="position" type="String">Represents the position of the legend on the chart. See Excel.ChartLegendPosition for details. [Api set: ExcelApi 1.1]</field>
  3845. /// <field name="visible" type="Boolean">A boolean value the represents the visibility of a ChartLegend object. [Api set: ExcelApi 1.1]</field>
  3846. }
  3847. ChartLegend.prototype.load = function(option) {
  3848. /// <summary>
  3849. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  3850. /// </summary>
  3851. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  3852. /// <returns type="Excel.ChartLegend"/>
  3853. }
  3854. return ChartLegend;
  3855. })(OfficeExtension.ClientObject);
  3856. Excel.ChartLegend = ChartLegend;
  3857. })(Excel || (Excel = {__proto__: null}));
  3858. var Excel;
  3859. (function (Excel) {
  3860. var ChartLegendFormat = (function(_super) {
  3861. __extends(ChartLegendFormat, _super);
  3862. function ChartLegendFormat() {
  3863. /// <summary> Encapsulates the format properties of a chart legend. [Api set: ExcelApi 1.1] </summary>
  3864. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  3865. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  3866. /// <field name="fill" type="Excel.ChartFill">Represents the fill format of an object, which includes background formating information. Read-only. [Api set: ExcelApi 1.1]</field>
  3867. /// <field name="font" type="Excel.ChartFont">Represents the font attributes such as font name, font size, color, etc. of a chart legend. Read-only. [Api set: ExcelApi 1.1]</field>
  3868. }
  3869. ChartLegendFormat.prototype.load = function(option) {
  3870. /// <summary>
  3871. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  3872. /// </summary>
  3873. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  3874. /// <returns type="Excel.ChartLegendFormat"/>
  3875. }
  3876. return ChartLegendFormat;
  3877. })(OfficeExtension.ClientObject);
  3878. Excel.ChartLegendFormat = ChartLegendFormat;
  3879. })(Excel || (Excel = {__proto__: null}));
  3880. var Excel;
  3881. (function (Excel) {
  3882. /// <summary> [Api set: ExcelApi 1.1] </summary>
  3883. var ChartLegendPosition = {
  3884. __proto__: null,
  3885. "invalid": "invalid",
  3886. "top": "top",
  3887. "bottom": "bottom",
  3888. "left": "left",
  3889. "right": "right",
  3890. "corner": "corner",
  3891. "custom": "custom",
  3892. }
  3893. Excel.ChartLegendPosition = ChartLegendPosition;
  3894. })(Excel || (Excel = {__proto__: null}));
  3895. var Excel;
  3896. (function (Excel) {
  3897. var ChartLineFormat = (function(_super) {
  3898. __extends(ChartLineFormat, _super);
  3899. function ChartLineFormat() {
  3900. /// <summary> Enapsulates the formatting options for line elements. [Api set: ExcelApi 1.1] </summary>
  3901. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  3902. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  3903. /// <field name="color" type="String">HTML color code representing the color of lines in the chart. [Api set: ExcelApi 1.1]</field>
  3904. }
  3905. ChartLineFormat.prototype.load = function(option) {
  3906. /// <summary>
  3907. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  3908. /// </summary>
  3909. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  3910. /// <returns type="Excel.ChartLineFormat"/>
  3911. }
  3912. ChartLineFormat.prototype.clear = function() {
  3913. /// <summary>
  3914. /// Clear the line format of a chart element. [Api set: ExcelApi 1.1]
  3915. /// </summary>
  3916. /// <returns ></returns>
  3917. }
  3918. return ChartLineFormat;
  3919. })(OfficeExtension.ClientObject);
  3920. Excel.ChartLineFormat = ChartLineFormat;
  3921. })(Excel || (Excel = {__proto__: null}));
  3922. var Excel;
  3923. (function (Excel) {
  3924. var ChartPoint = (function(_super) {
  3925. __extends(ChartPoint, _super);
  3926. function ChartPoint() {
  3927. /// <summary> Represents a point of a series in a chart. [Api set: ExcelApi 1.1] </summary>
  3928. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  3929. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  3930. /// <field name="format" type="Excel.ChartPointFormat">Encapsulates the format properties chart point. Read-only. [Api set: ExcelApi 1.1]</field>
  3931. /// <field name="value" >Returns the value of a chart point. Read-only. [Api set: ExcelApi 1.1]</field>
  3932. }
  3933. ChartPoint.prototype.load = function(option) {
  3934. /// <summary>
  3935. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  3936. /// </summary>
  3937. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  3938. /// <returns type="Excel.ChartPoint"/>
  3939. }
  3940. return ChartPoint;
  3941. })(OfficeExtension.ClientObject);
  3942. Excel.ChartPoint = ChartPoint;
  3943. })(Excel || (Excel = {__proto__: null}));
  3944. var Excel;
  3945. (function (Excel) {
  3946. var ChartPointFormat = (function(_super) {
  3947. __extends(ChartPointFormat, _super);
  3948. function ChartPointFormat() {
  3949. /// <summary> Represents formatting object for chart points. [Api set: ExcelApi 1.1] </summary>
  3950. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  3951. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  3952. /// <field name="fill" type="Excel.ChartFill">Represents the fill format of a chart, which includes background formating information. Read-only. [Api set: ExcelApi 1.1]</field>
  3953. }
  3954. ChartPointFormat.prototype.load = function(option) {
  3955. /// <summary>
  3956. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  3957. /// </summary>
  3958. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  3959. /// <returns type="Excel.ChartPointFormat"/>
  3960. }
  3961. return ChartPointFormat;
  3962. })(OfficeExtension.ClientObject);
  3963. Excel.ChartPointFormat = ChartPointFormat;
  3964. })(Excel || (Excel = {__proto__: null}));
  3965. var Excel;
  3966. (function (Excel) {
  3967. var ChartPointsCollection = (function(_super) {
  3968. __extends(ChartPointsCollection, _super);
  3969. function ChartPointsCollection() {
  3970. /// <summary> A collection of all the chart points within a series inside a chart. [Api set: ExcelApi 1.1] </summary>
  3971. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  3972. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  3973. /// <field name="count" type="Number">Returns the number of chart points in the collection. Read-only. [Api set: ExcelApi 1.1]</field>
  3974. /// <field name="items" type="Array" elementType="Excel.ChartPoint">Gets the loaded child items in this collection.</field>
  3975. }
  3976. ChartPointsCollection.prototype.load = function(option) {
  3977. /// <summary>
  3978. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  3979. /// </summary>
  3980. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  3981. /// <returns type="Excel.ChartPointsCollection"/>
  3982. }
  3983. ChartPointsCollection.prototype.getItemAt = function(index) {
  3984. /// <summary>
  3985. /// Retrieve a point based on its position within the series. [Api set: ExcelApi 1.1]
  3986. /// </summary>
  3987. /// <param name="index" type="Number">Index value of the object to be retrieved. Zero-indexed.</param>
  3988. /// <returns type="Excel.ChartPoint"></returns>
  3989. }
  3990. return ChartPointsCollection;
  3991. })(OfficeExtension.ClientObject);
  3992. Excel.ChartPointsCollection = ChartPointsCollection;
  3993. })(Excel || (Excel = {__proto__: null}));
  3994. var Excel;
  3995. (function (Excel) {
  3996. var ChartSeries = (function(_super) {
  3997. __extends(ChartSeries, _super);
  3998. function ChartSeries() {
  3999. /// <summary> Represents a series in a chart. [Api set: ExcelApi 1.1] </summary>
  4000. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  4001. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  4002. /// <field name="format" type="Excel.ChartSeriesFormat">Represents the formatting of a chart series, which includes fill and line formatting. Read-only. [Api set: ExcelApi 1.1]</field>
  4003. /// <field name="name" type="String">Represents the name of a series in a chart. [Api set: ExcelApi 1.1]</field>
  4004. /// <field name="points" type="Excel.ChartPointsCollection">Represents a collection of all points in the series. Read-only. [Api set: ExcelApi 1.1]</field>
  4005. }
  4006. ChartSeries.prototype.load = function(option) {
  4007. /// <summary>
  4008. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  4009. /// </summary>
  4010. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  4011. /// <returns type="Excel.ChartSeries"/>
  4012. }
  4013. return ChartSeries;
  4014. })(OfficeExtension.ClientObject);
  4015. Excel.ChartSeries = ChartSeries;
  4016. })(Excel || (Excel = {__proto__: null}));
  4017. var Excel;
  4018. (function (Excel) {
  4019. /// <summary> Specifies whether the series are by rows or by columns. On Desktop, the &quot;auto&quot; option will inspect the source data shape to automatically guess whether the data is by rows or columns; on Excel Online, &quot;auto&quot; will simply default to &quot;columns&quot;. [Api set: ExcelApi 1.1] </summary>
  4020. var ChartSeriesBy = {
  4021. __proto__: null,
  4022. "auto": "auto",
  4023. "columns": "columns",
  4024. "rows": "rows",
  4025. }
  4026. Excel.ChartSeriesBy = ChartSeriesBy;
  4027. })(Excel || (Excel = {__proto__: null}));
  4028. var Excel;
  4029. (function (Excel) {
  4030. var ChartSeriesCollection = (function(_super) {
  4031. __extends(ChartSeriesCollection, _super);
  4032. function ChartSeriesCollection() {
  4033. /// <summary> Represents a collection of chart series. [Api set: ExcelApi 1.1] </summary>
  4034. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  4035. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  4036. /// <field name="count" type="Number">Returns the number of series in the collection. Read-only. [Api set: ExcelApi 1.1]</field>
  4037. /// <field name="items" type="Array" elementType="Excel.ChartSeries">Gets the loaded child items in this collection.</field>
  4038. }
  4039. ChartSeriesCollection.prototype.load = function(option) {
  4040. /// <summary>
  4041. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  4042. /// </summary>
  4043. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  4044. /// <returns type="Excel.ChartSeriesCollection"/>
  4045. }
  4046. ChartSeriesCollection.prototype.getItemAt = function(index) {
  4047. /// <summary>
  4048. /// Retrieves a series based on its position in the collection [Api set: ExcelApi 1.1]
  4049. /// </summary>
  4050. /// <param name="index" type="Number">Index value of the object to be retrieved. Zero-indexed.</param>
  4051. /// <returns type="Excel.ChartSeries"></returns>
  4052. }
  4053. return ChartSeriesCollection;
  4054. })(OfficeExtension.ClientObject);
  4055. Excel.ChartSeriesCollection = ChartSeriesCollection;
  4056. })(Excel || (Excel = {__proto__: null}));
  4057. var Excel;
  4058. (function (Excel) {
  4059. var ChartSeriesFormat = (function(_super) {
  4060. __extends(ChartSeriesFormat, _super);
  4061. function ChartSeriesFormat() {
  4062. /// <summary> encapsulates the format properties for the chart series [Api set: ExcelApi 1.1] </summary>
  4063. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  4064. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  4065. /// <field name="fill" type="Excel.ChartFill">Represents the fill format of a chart series, which includes background formating information. Read-only. [Api set: ExcelApi 1.1]</field>
  4066. /// <field name="line" type="Excel.ChartLineFormat">Represents line formatting. Read-only. [Api set: ExcelApi 1.1]</field>
  4067. }
  4068. ChartSeriesFormat.prototype.load = function(option) {
  4069. /// <summary>
  4070. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  4071. /// </summary>
  4072. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  4073. /// <returns type="Excel.ChartSeriesFormat"/>
  4074. }
  4075. return ChartSeriesFormat;
  4076. })(OfficeExtension.ClientObject);
  4077. Excel.ChartSeriesFormat = ChartSeriesFormat;
  4078. })(Excel || (Excel = {__proto__: null}));
  4079. var Excel;
  4080. (function (Excel) {
  4081. var ChartTitle = (function(_super) {
  4082. __extends(ChartTitle, _super);
  4083. function ChartTitle() {
  4084. /// <summary> Represents a chart title object of a chart. [Api set: ExcelApi 1.1] </summary>
  4085. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  4086. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  4087. /// <field name="format" type="Excel.ChartTitleFormat">Represents the formatting of a chart title, which includes fill and font formatting. Read-only. [Api set: ExcelApi 1.1]</field>
  4088. /// <field name="overlay" type="Boolean">Boolean value representing if the chart title will overlay the chart or not. [Api set: ExcelApi 1.1]</field>
  4089. /// <field name="text" type="String">Represents the title text of a chart. [Api set: ExcelApi 1.1]</field>
  4090. /// <field name="visible" type="Boolean">A boolean value the represents the visibility of a chart title object. [Api set: ExcelApi 1.1]</field>
  4091. }
  4092. ChartTitle.prototype.load = function(option) {
  4093. /// <summary>
  4094. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  4095. /// </summary>
  4096. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  4097. /// <returns type="Excel.ChartTitle"/>
  4098. }
  4099. return ChartTitle;
  4100. })(OfficeExtension.ClientObject);
  4101. Excel.ChartTitle = ChartTitle;
  4102. })(Excel || (Excel = {__proto__: null}));
  4103. var Excel;
  4104. (function (Excel) {
  4105. var ChartTitleFormat = (function(_super) {
  4106. __extends(ChartTitleFormat, _super);
  4107. function ChartTitleFormat() {
  4108. /// <summary> Provides access to the office art formatting for chart title. [Api set: ExcelApi 1.1] </summary>
  4109. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  4110. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  4111. /// <field name="fill" type="Excel.ChartFill">Represents the fill format of an object, which includes background formating information. Read-only. [Api set: ExcelApi 1.1]</field>
  4112. /// <field name="font" type="Excel.ChartFont">Represents the font attributes (font name, font size, color, etc.) for an object. Read-only. [Api set: ExcelApi 1.1]</field>
  4113. }
  4114. ChartTitleFormat.prototype.load = function(option) {
  4115. /// <summary>
  4116. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  4117. /// </summary>
  4118. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  4119. /// <returns type="Excel.ChartTitleFormat"/>
  4120. }
  4121. return ChartTitleFormat;
  4122. })(OfficeExtension.ClientObject);
  4123. Excel.ChartTitleFormat = ChartTitleFormat;
  4124. })(Excel || (Excel = {__proto__: null}));
  4125. var Excel;
  4126. (function (Excel) {
  4127. /// <summary> [Api set: ExcelApi 1.1] </summary>
  4128. var ChartType = {
  4129. __proto__: null,
  4130. "invalid": "invalid",
  4131. "columnClustered": "columnClustered",
  4132. "columnStacked": "columnStacked",
  4133. "columnStacked100": "columnStacked100",
  4134. "_3DColumnClustered": "_3DColumnClustered",
  4135. "_3DColumnStacked": "_3DColumnStacked",
  4136. "_3DColumnStacked100": "_3DColumnStacked100",
  4137. "barClustered": "barClustered",
  4138. "barStacked": "barStacked",
  4139. "barStacked100": "barStacked100",
  4140. "_3DBarClustered": "_3DBarClustered",
  4141. "_3DBarStacked": "_3DBarStacked",
  4142. "_3DBarStacked100": "_3DBarStacked100",
  4143. "lineStacked": "lineStacked",
  4144. "lineStacked100": "lineStacked100",
  4145. "lineMarkers": "lineMarkers",
  4146. "lineMarkersStacked": "lineMarkersStacked",
  4147. "lineMarkersStacked100": "lineMarkersStacked100",
  4148. "pieOfPie": "pieOfPie",
  4149. "pieExploded": "pieExploded",
  4150. "_3DPieExploded": "_3DPieExploded",
  4151. "barOfPie": "barOfPie",
  4152. "xyscatterSmooth": "xyscatterSmooth",
  4153. "xyscatterSmoothNoMarkers": "xyscatterSmoothNoMarkers",
  4154. "xyscatterLines": "xyscatterLines",
  4155. "xyscatterLinesNoMarkers": "xyscatterLinesNoMarkers",
  4156. "areaStacked": "areaStacked",
  4157. "areaStacked100": "areaStacked100",
  4158. "_3DAreaStacked": "_3DAreaStacked",
  4159. "_3DAreaStacked100": "_3DAreaStacked100",
  4160. "doughnutExploded": "doughnutExploded",
  4161. "radarMarkers": "radarMarkers",
  4162. "radarFilled": "radarFilled",
  4163. "surface": "surface",
  4164. "surfaceWireframe": "surfaceWireframe",
  4165. "surfaceTopView": "surfaceTopView",
  4166. "surfaceTopViewWireframe": "surfaceTopViewWireframe",
  4167. "bubble": "bubble",
  4168. "bubble3DEffect": "bubble3DEffect",
  4169. "stockHLC": "stockHLC",
  4170. "stockOHLC": "stockOHLC",
  4171. "stockVHLC": "stockVHLC",
  4172. "stockVOHLC": "stockVOHLC",
  4173. "cylinderColClustered": "cylinderColClustered",
  4174. "cylinderColStacked": "cylinderColStacked",
  4175. "cylinderColStacked100": "cylinderColStacked100",
  4176. "cylinderBarClustered": "cylinderBarClustered",
  4177. "cylinderBarStacked": "cylinderBarStacked",
  4178. "cylinderBarStacked100": "cylinderBarStacked100",
  4179. "cylinderCol": "cylinderCol",
  4180. "coneColClustered": "coneColClustered",
  4181. "coneColStacked": "coneColStacked",
  4182. "coneColStacked100": "coneColStacked100",
  4183. "coneBarClustered": "coneBarClustered",
  4184. "coneBarStacked": "coneBarStacked",
  4185. "coneBarStacked100": "coneBarStacked100",
  4186. "coneCol": "coneCol",
  4187. "pyramidColClustered": "pyramidColClustered",
  4188. "pyramidColStacked": "pyramidColStacked",
  4189. "pyramidColStacked100": "pyramidColStacked100",
  4190. "pyramidBarClustered": "pyramidBarClustered",
  4191. "pyramidBarStacked": "pyramidBarStacked",
  4192. "pyramidBarStacked100": "pyramidBarStacked100",
  4193. "pyramidCol": "pyramidCol",
  4194. "_3DColumn": "_3DColumn",
  4195. "line": "line",
  4196. "_3DLine": "_3DLine",
  4197. "_3DPie": "_3DPie",
  4198. "pie": "pie",
  4199. "xyscatter": "xyscatter",
  4200. "_3DArea": "_3DArea",
  4201. "area": "area",
  4202. "doughnut": "doughnut",
  4203. "radar": "radar",
  4204. }
  4205. Excel.ChartType = ChartType;
  4206. })(Excel || (Excel = {__proto__: null}));
  4207. var Excel;
  4208. (function (Excel) {
  4209. /// <summary> [Api set: ExcelApi 1.1] </summary>
  4210. var ChartUnderlineStyle = {
  4211. __proto__: null,
  4212. "none": "none",
  4213. "single": "single",
  4214. }
  4215. Excel.ChartUnderlineStyle = ChartUnderlineStyle;
  4216. })(Excel || (Excel = {__proto__: null}));
  4217. var Excel;
  4218. (function (Excel) {
  4219. /// <summary> [Api set: ExcelApi 1.1] </summary>
  4220. var ClearApplyTo = {
  4221. __proto__: null,
  4222. "all": "all",
  4223. "formats": "formats",
  4224. "contents": "contents",
  4225. }
  4226. Excel.ClearApplyTo = ClearApplyTo;
  4227. })(Excel || (Excel = {__proto__: null}));
  4228. var Excel;
  4229. (function (Excel) {
  4230. /// <summary> [Api set: ExcelApi 1.1] </summary>
  4231. var DeleteShiftDirection = {
  4232. __proto__: null,
  4233. "up": "up",
  4234. "left": "left",
  4235. }
  4236. Excel.DeleteShiftDirection = DeleteShiftDirection;
  4237. })(Excel || (Excel = {__proto__: null}));
  4238. var Excel;
  4239. (function (Excel) {
  4240. /// <summary> [Api set: ExcelApi 1.2] </summary>
  4241. var DynamicFilterCriteria = {
  4242. __proto__: null,
  4243. "unknown": "unknown",
  4244. "aboveAverage": "aboveAverage",
  4245. "allDatesInPeriodApril": "allDatesInPeriodApril",
  4246. "allDatesInPeriodAugust": "allDatesInPeriodAugust",
  4247. "allDatesInPeriodDecember": "allDatesInPeriodDecember",
  4248. "allDatesInPeriodFebruray": "allDatesInPeriodFebruray",
  4249. "allDatesInPeriodJanuary": "allDatesInPeriodJanuary",
  4250. "allDatesInPeriodJuly": "allDatesInPeriodJuly",
  4251. "allDatesInPeriodJune": "allDatesInPeriodJune",
  4252. "allDatesInPeriodMarch": "allDatesInPeriodMarch",
  4253. "allDatesInPeriodMay": "allDatesInPeriodMay",
  4254. "allDatesInPeriodNovember": "allDatesInPeriodNovember",
  4255. "allDatesInPeriodOctober": "allDatesInPeriodOctober",
  4256. "allDatesInPeriodQuarter1": "allDatesInPeriodQuarter1",
  4257. "allDatesInPeriodQuarter2": "allDatesInPeriodQuarter2",
  4258. "allDatesInPeriodQuarter3": "allDatesInPeriodQuarter3",
  4259. "allDatesInPeriodQuarter4": "allDatesInPeriodQuarter4",
  4260. "allDatesInPeriodSeptember": "allDatesInPeriodSeptember",
  4261. "belowAverage": "belowAverage",
  4262. "lastMonth": "lastMonth",
  4263. "lastQuarter": "lastQuarter",
  4264. "lastWeek": "lastWeek",
  4265. "lastYear": "lastYear",
  4266. "nextMonth": "nextMonth",
  4267. "nextQuarter": "nextQuarter",
  4268. "nextWeek": "nextWeek",
  4269. "nextYear": "nextYear",
  4270. "thisMonth": "thisMonth",
  4271. "thisQuarter": "thisQuarter",
  4272. "thisWeek": "thisWeek",
  4273. "thisYear": "thisYear",
  4274. "today": "today",
  4275. "tomorrow": "tomorrow",
  4276. "yearToDate": "yearToDate",
  4277. "yesterday": "yesterday",
  4278. }
  4279. Excel.DynamicFilterCriteria = DynamicFilterCriteria;
  4280. })(Excel || (Excel = {__proto__: null}));
  4281. var Excel;
  4282. (function (Excel) {
  4283. var Filter = (function(_super) {
  4284. __extends(Filter, _super);
  4285. function Filter() {
  4286. /// <summary> Manages the filtering of a table&apos;s column. [Api set: ExcelApi 1.2] </summary>
  4287. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  4288. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  4289. /// <field name="criteria" type="Excel.Interfaces.FilterCriteria">The currently applied filter on the given column. [Api set: ExcelApi 1.2]</field>
  4290. }
  4291. Filter.prototype.load = function(option) {
  4292. /// <summary>
  4293. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  4294. /// </summary>
  4295. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  4296. /// <returns type="Excel.Filter"/>
  4297. }
  4298. Filter.prototype.apply = function(criteria) {
  4299. /// <summary>
  4300. /// Apply the given filter criteria on the given column. [Api set: ExcelApi 1.2]
  4301. /// </summary>
  4302. /// <param name="criteria" type="Excel.Interfaces.FilterCriteria">The criteria to apply.</param>
  4303. /// <returns ></returns>
  4304. }
  4305. Filter.prototype.applyBottomItemsFilter = function(count) {
  4306. /// <summary>
  4307. /// Apply a &quot;Bottom Item&quot; filter to the column for the given number of elements. [Api set: ExcelApi 1.2]
  4308. /// </summary>
  4309. /// <param name="count" type="Number">The number of elements from the bottom to show.</param>
  4310. /// <returns ></returns>
  4311. }
  4312. Filter.prototype.applyBottomPercentFilter = function(percent) {
  4313. /// <summary>
  4314. /// Apply a &quot;Bottom Percent&quot; filter to the column for the given percentage of elements. [Api set: ExcelApi 1.2]
  4315. /// </summary>
  4316. /// <param name="percent" type="Number">The percentage of elements from the bottom to show.</param>
  4317. /// <returns ></returns>
  4318. }
  4319. Filter.prototype.applyCellColorFilter = function(color) {
  4320. /// <summary>
  4321. /// Apply a &quot;Cell Color&quot; filter to the column for the given color. [Api set: ExcelApi 1.2]
  4322. /// </summary>
  4323. /// <param name="color" type="String">The background color of the cells to show.</param>
  4324. /// <returns ></returns>
  4325. }
  4326. Filter.prototype.applyCustomFilter = function(criteria1, criteria2, oper) {
  4327. /// <summary>
  4328. /// Apply a &quot;Icon&quot; filter to the column for the given criteria strings. [Api set: ExcelApi 1.2]
  4329. /// </summary>
  4330. /// <param name="criteria1" type="String">The first criteria string.</param>
  4331. /// <param name="criteria2" type="String" optional="true">The second criteria string.</param>
  4332. /// <param name="oper" type="String" optional="true">The operator that describes how the two criteria are joined.</param>
  4333. /// <returns ></returns>
  4334. }
  4335. Filter.prototype.applyDynamicFilter = function(criteria) {
  4336. /// <summary>
  4337. /// Apply a &quot;Dynamic&quot; filter to the column. [Api set: ExcelApi 1.2]
  4338. /// </summary>
  4339. /// <param name="criteria" type="String">The dynamic criteria to apply.</param>
  4340. /// <returns ></returns>
  4341. }
  4342. Filter.prototype.applyFontColorFilter = function(color) {
  4343. /// <summary>
  4344. /// Apply a &quot;Font Color&quot; filter to the column for the given color. [Api set: ExcelApi 1.2]
  4345. /// </summary>
  4346. /// <param name="color" type="String">The font color of the cells to show.</param>
  4347. /// <returns ></returns>
  4348. }
  4349. Filter.prototype.applyIconFilter = function(icon) {
  4350. /// <summary>
  4351. /// Apply a &quot;Icon&quot; filter to the column for the given icon. [Api set: ExcelApi 1.2]
  4352. /// </summary>
  4353. /// <param name="icon" type="Excel.Interfaces.Icon">The icons of the cells to show.</param>
  4354. /// <returns ></returns>
  4355. }
  4356. Filter.prototype.applyTopItemsFilter = function(count) {
  4357. /// <summary>
  4358. /// Apply a &quot;Top Item&quot; filter to the column for the given number of elements. [Api set: ExcelApi 1.2]
  4359. /// </summary>
  4360. /// <param name="count" type="Number">The number of elements from the top to show.</param>
  4361. /// <returns ></returns>
  4362. }
  4363. Filter.prototype.applyTopPercentFilter = function(percent) {
  4364. /// <summary>
  4365. /// Apply a &quot;Top Percent&quot; filter to the column for the given percentage of elements. [Api set: ExcelApi 1.2]
  4366. /// </summary>
  4367. /// <param name="percent" type="Number">The percentage of elements from the top to show.</param>
  4368. /// <returns ></returns>
  4369. }
  4370. Filter.prototype.applyValuesFilter = function(values) {
  4371. /// <summary>
  4372. /// Apply a &quot;Values&quot; filter to the column for the given values. [Api set: ExcelApi 1.2]
  4373. /// </summary>
  4374. /// <param name="values" type="Array" >The list of values to show.</param>
  4375. /// <returns ></returns>
  4376. }
  4377. Filter.prototype.clear = function() {
  4378. /// <summary>
  4379. /// Clear the filter on the given column. [Api set: ExcelApi 1.2]
  4380. /// </summary>
  4381. /// <returns ></returns>
  4382. }
  4383. return Filter;
  4384. })(OfficeExtension.ClientObject);
  4385. Excel.Filter = Filter;
  4386. })(Excel || (Excel = {__proto__: null}));
  4387. var Excel;
  4388. (function (Excel) {
  4389. var Interfaces;
  4390. (function (Interfaces) {
  4391. var FilterCriteria = (function() {
  4392. function FilterCriteria() {
  4393. /// <summary> Represents the filtering criteria applied to a column. [Api set: ExcelApi 1.2] </summary>
  4394. /// <field name="color" type="String">The HTML color string used to filter cells. Used with &quot;cellColor&quot; and &quot;fontColor&quot; filtering. [Api set: ExcelApi 1.2]</field>
  4395. /// <field name="criterion1" type="String">The first criterion used to filter data. Used as an operator in the case of &quot;custom&quot; filtering. For example &quot;&gt;50&quot; for number greater than 50 or &quot;=*s&quot; for values ending in &quot;s&quot;. Used as a number in the case of top/bottom items/percents. E.g. &quot;5&quot; for the top 5 items if filterOn is set to &quot;topItems&quot; [Api set: ExcelApi 1.2]</field>
  4396. /// <field name="criterion2" type="String">The second criterion used to filter data. Only used as an operator in the case of &quot;custom&quot; filtering. [Api set: ExcelApi 1.2]</field>
  4397. /// <field name="dynamicCriteria" type="String">The dynamic criteria from the Excel.DynamicFilterCriteria set to apply on this column. Used with &quot;dynamic&quot; filtering. [Api set: ExcelApi 1.2]</field>
  4398. /// <field name="filterOn" type="String">The property used by the filter to determine whether the values should stay visible. [Api set: ExcelApi 1.2]</field>
  4399. /// <field name="icon" type="Excel.Interfaces.Icon">The icon used to filter cells. Used with &quot;icon&quot; filtering. [Api set: ExcelApi 1.2]</field>
  4400. /// <field name="operator" type="String">The operator used to combine criterion 1 and 2 when using &quot;custom&quot; filtering. [Api set: ExcelApi 1.2]</field>
  4401. /// <field name="values" type="Array" >The set of values to be used as part of &quot;values&quot; filtering. [Api set: ExcelApi 1.2]</field>
  4402. }
  4403. return FilterCriteria;
  4404. })();
  4405. Interfaces.FilterCriteria.__proto__ = null;
  4406. Interfaces.FilterCriteria = FilterCriteria;
  4407. })(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
  4408. })(Excel || (Excel = {__proto__: null}));
  4409. var Excel;
  4410. (function (Excel) {
  4411. var Interfaces;
  4412. (function (Interfaces) {
  4413. var FilterDatetime = (function() {
  4414. function FilterDatetime() {
  4415. /// <summary> Represents how to filter a date when filtering on values. [Api set: ExcelApi 1.2] </summary>
  4416. /// <field name="date" type="String">The date in ISO8601 format used to filter data. [Api set: ExcelApi 1.2]</field>
  4417. /// <field name="specificity" type="String">How specific the date should be used to keep data. For example, if the date is 2005-04-02 and the specifity is set to &quot;month&quot;, the filter operation will keep all rows with a date in the month of april 2009. [Api set: ExcelApi 1.2]</field>
  4418. }
  4419. return FilterDatetime;
  4420. })();
  4421. Interfaces.FilterDatetime.__proto__ = null;
  4422. Interfaces.FilterDatetime = FilterDatetime;
  4423. })(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
  4424. })(Excel || (Excel = {__proto__: null}));
  4425. var Excel;
  4426. (function (Excel) {
  4427. /// <summary> [Api set: ExcelApi 1.2] </summary>
  4428. var FilterDatetimeSpecificity = {
  4429. __proto__: null,
  4430. "year": "year",
  4431. "month": "month",
  4432. "day": "day",
  4433. "hour": "hour",
  4434. "minute": "minute",
  4435. "second": "second",
  4436. }
  4437. Excel.FilterDatetimeSpecificity = FilterDatetimeSpecificity;
  4438. })(Excel || (Excel = {__proto__: null}));
  4439. var Excel;
  4440. (function (Excel) {
  4441. /// <summary> [Api set: ExcelApi 1.2] </summary>
  4442. var FilterOn = {
  4443. __proto__: null,
  4444. "bottomItems": "bottomItems",
  4445. "bottomPercent": "bottomPercent",
  4446. "cellColor": "cellColor",
  4447. "dynamic": "dynamic",
  4448. "fontColor": "fontColor",
  4449. "values": "values",
  4450. "topItems": "topItems",
  4451. "topPercent": "topPercent",
  4452. "icon": "icon",
  4453. "custom": "custom",
  4454. }
  4455. Excel.FilterOn = FilterOn;
  4456. })(Excel || (Excel = {__proto__: null}));
  4457. var Excel;
  4458. (function (Excel) {
  4459. /// <summary> [Api set: ExcelApi 1.2] </summary>
  4460. var FilterOperator = {
  4461. __proto__: null,
  4462. "and": "and",
  4463. "or": "or",
  4464. }
  4465. Excel.FilterOperator = FilterOperator;
  4466. })(Excel || (Excel = {__proto__: null}));
  4467. var Excel;
  4468. (function (Excel) {
  4469. var FormatProtection = (function(_super) {
  4470. __extends(FormatProtection, _super);
  4471. function FormatProtection() {
  4472. /// <summary> Represents the format protection of a range object. [Api set: ExcelApi 1.2] </summary>
  4473. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  4474. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  4475. /// <field name="formulaHidden" type="Boolean">Indicates if Excel hides the formula for the cells in the range. A null value indicates that the entire range doesn&apos;t have uniform formula hidden setting. [Api set: ExcelApi 1.2]</field>
  4476. /// <field name="locked" type="Boolean">Indicates if Excel locks the cells in the object. A null value indicates that the entire range doesn&apos;t have uniform lock setting. [Api set: ExcelApi 1.2]</field>
  4477. }
  4478. FormatProtection.prototype.load = function(option) {
  4479. /// <summary>
  4480. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  4481. /// </summary>
  4482. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  4483. /// <returns type="Excel.FormatProtection"/>
  4484. }
  4485. return FormatProtection;
  4486. })(OfficeExtension.ClientObject);
  4487. Excel.FormatProtection = FormatProtection;
  4488. })(Excel || (Excel = {__proto__: null}));
  4489. var Excel;
  4490. (function (Excel) {
  4491. var FunctionResult = (function(_super) {
  4492. __extends(FunctionResult, _super);
  4493. function FunctionResult() {
  4494. /// <summary> An object containing the result of a function-evaluation operation [Api set: ExcelApi 1.2] </summary>
  4495. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  4496. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  4497. /// <field name="error" type="String">Error value (such as &quot;#DIV/0&quot;) representing the error. If the error string is not set, then the function succeeded, and its result is written to the Value field. The error is always in the English locale. [Api set: ExcelApi 1.2]</field>
  4498. /// <field name="value" >The value of function evaluation. The value field will be populated only if no error has occurred (i.e., the Error property is not set). [Api set: ExcelApi 1.2]</field>
  4499. }
  4500. FunctionResult.prototype.load = function(option) {
  4501. /// <summary>
  4502. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  4503. /// </summary>
  4504. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  4505. /// <returns type="Excel.FunctionResult"/>
  4506. }
  4507. return FunctionResult;
  4508. })(OfficeExtension.ClientObject);
  4509. Excel.FunctionResult = FunctionResult;
  4510. })(Excel || (Excel = {__proto__: null}));
  4511. var Excel;
  4512. (function (Excel) {
  4513. var Functions = (function(_super) {
  4514. __extends(Functions, _super);
  4515. function Functions() {
  4516. /// <summary> An object for evaluating Excel functions. [Api set: ExcelApi 1.2] </summary>
  4517. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  4518. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  4519. }
  4520. Functions.prototype.load = function(option) {
  4521. /// <summary>
  4522. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  4523. /// </summary>
  4524. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  4525. /// <returns type="Excel.Functions"/>
  4526. }
  4527. Functions.prototype.abs = function(number) {
  4528. /// <summary>
  4529. /// Returns the absolute value of a number, a number without its sign. [Api set: ExcelApi 1.2]
  4530. /// </summary>
  4531. /// <param name="number" >Is the real number for which you want the absolute value.</param>
  4532. /// <returns type="Excel.FunctionResult"></returns>
  4533. }
  4534. Functions.prototype.accrInt = function(issue, firstInterest, settlement, rate, par, frequency, basis, calcMethod) {
  4535. /// <summary>
  4536. /// Returns the accrued interest for a security that pays periodic interest. [Api set: ExcelApi 1.2]
  4537. /// </summary>
  4538. /// <param name="issue" >Is the security&apos;s issue date, expressed as a serial date number.</param>
  4539. /// <param name="firstInterest" >Is the security&apos;s first interest date, expressed as a serial date number.</param>
  4540. /// <param name="settlement" >Is the security&apos;s settlement date, expressed as a serial date number.</param>
  4541. /// <param name="rate" >Is the security&apos;s annual coupon rate.</param>
  4542. /// <param name="par" >Is the security&apos;s par value.</param>
  4543. /// <param name="frequency" >Is the number of coupon payments per year.</param>
  4544. /// <param name="basis" optional="true">Is the type of day count basis to use.</param>
  4545. /// <param name="calcMethod" optional="true">Is a logical value: to accrued interest from issue date = TRUE or omitted; to calculate from last coupon payment date = FALSE.</param>
  4546. /// <returns type="Excel.FunctionResult"></returns>
  4547. }
  4548. Functions.prototype.accrIntM = function(issue, settlement, rate, par, basis) {
  4549. /// <summary>
  4550. /// Returns the accrued interest for a security that pays interest at maturity. [Api set: ExcelApi 1.2]
  4551. /// </summary>
  4552. /// <param name="issue" >Is the security&apos;s issue date, expressed as a serial date number.</param>
  4553. /// <param name="settlement" >Is the security&apos;s maturity date, expressed as a serial date number.</param>
  4554. /// <param name="rate" >Is the security&apos;s annual coupon rate.</param>
  4555. /// <param name="par" >Is the security&apos;s par value.</param>
  4556. /// <param name="basis" optional="true">Is the type of day count basis to use.</param>
  4557. /// <returns type="Excel.FunctionResult"></returns>
  4558. }
  4559. Functions.prototype.acos = function(number) {
  4560. /// <summary>
  4561. /// Returns the arccosine of a number, in radians in the range 0 to Pi. The arccosine is the angle whose cosine is Number. [Api set: ExcelApi 1.2]
  4562. /// </summary>
  4563. /// <param name="number" >Is the cosine of the angle you want and must be from -1 to 1.</param>
  4564. /// <returns type="Excel.FunctionResult"></returns>
  4565. }
  4566. Functions.prototype.acosh = function(number) {
  4567. /// <summary>
  4568. /// Returns the inverse hyperbolic cosine of a number. [Api set: ExcelApi 1.2]
  4569. /// </summary>
  4570. /// <param name="number" >Is any real number equal to or greater than 1.</param>
  4571. /// <returns type="Excel.FunctionResult"></returns>
  4572. }
  4573. Functions.prototype.acot = function(number) {
  4574. /// <summary>
  4575. /// Returns the arccotangent of a number, in radians in the range 0 to Pi. [Api set: ExcelApi 1.2]
  4576. /// </summary>
  4577. /// <param name="number" >Is the cotangent of the angle you want.</param>
  4578. /// <returns type="Excel.FunctionResult"></returns>
  4579. }
  4580. Functions.prototype.acoth = function(number) {
  4581. /// <summary>
  4582. /// Returns the inverse hyperbolic cotangent of a number. [Api set: ExcelApi 1.2]
  4583. /// </summary>
  4584. /// <param name="number" >Is the hyperbolic cotangent of the angle that you want.</param>
  4585. /// <returns type="Excel.FunctionResult"></returns>
  4586. }
  4587. Functions.prototype.amorDegrc = function(cost, datePurchased, firstPeriod, salvage, period, rate, basis) {
  4588. /// <summary>
  4589. /// Returns the prorated linear depreciation of an asset for each accounting period. [Api set: ExcelApi 1.2]
  4590. /// </summary>
  4591. /// <param name="cost" >Is the cost of the asset.</param>
  4592. /// <param name="datePurchased" >Is the date the asset is purchased.</param>
  4593. /// <param name="firstPeriod" >Is the date of the end of the first period.</param>
  4594. /// <param name="salvage" >Is the salvage value at the end of life of the asset.</param>
  4595. /// <param name="period" >Is the period.</param>
  4596. /// <param name="rate" >Is the rate of depreciation.</param>
  4597. /// <param name="basis" optional="true">Year_basis : 0 for year of 360 days, 1 for actual, 3 for year of 365 days.</param>
  4598. /// <returns type="Excel.FunctionResult"></returns>
  4599. }
  4600. Functions.prototype.amorLinc = function(cost, datePurchased, firstPeriod, salvage, period, rate, basis) {
  4601. /// <summary>
  4602. /// Returns the prorated linear depreciation of an asset for each accounting period. [Api set: ExcelApi 1.2]
  4603. /// </summary>
  4604. /// <param name="cost" >Is the cost of the asset.</param>
  4605. /// <param name="datePurchased" >Is the date the asset is purchased.</param>
  4606. /// <param name="firstPeriod" >Is the date of the end of the first period.</param>
  4607. /// <param name="salvage" >Is the salvage value at the end of life of the asset.</param>
  4608. /// <param name="period" >Is the period.</param>
  4609. /// <param name="rate" >Is the rate of depreciation.</param>
  4610. /// <param name="basis" optional="true">Year_basis : 0 for year of 360 days, 1 for actual, 3 for year of 365 days.</param>
  4611. /// <returns type="Excel.FunctionResult"></returns>
  4612. }
  4613. Functions.prototype.and = function(values) {
  4614. /// <summary>
  4615. /// Checks whether all arguments are TRUE, and returns TRUE if all arguments are TRUE. [Api set: ExcelApi 1.2]
  4616. /// </summary>
  4617. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 conditions you want to test that can be either TRUE or FALSE and can be logical values, arrays, or references.</param>
  4618. /// <returns type="Excel.FunctionResult"></returns>
  4619. }
  4620. Functions.prototype.arabic = function(text) {
  4621. /// <summary>
  4622. /// Converts a Roman numeral to Arabic. [Api set: ExcelApi 1.2]
  4623. /// </summary>
  4624. /// <param name="text" >Is the Roman numeral you want to convert.</param>
  4625. /// <returns type="Excel.FunctionResult"></returns>
  4626. }
  4627. Functions.prototype.areas = function(reference) {
  4628. /// <summary>
  4629. /// Returns the number of areas in a reference. An area is a range of contiguous cells or a single cell. [Api set: ExcelApi 1.2]
  4630. /// </summary>
  4631. /// <param name="reference" >Is a reference to a cell or range of cells and can refer to multiple areas.</param>
  4632. /// <returns type="Excel.FunctionResult"></returns>
  4633. }
  4634. Functions.prototype.asc = function(text) {
  4635. /// <summary>
  4636. /// Changes full-width (double-byte) characters to half-width (single-byte) characters. Use with double-byte character sets (DBCS). [Api set: ExcelApi 1.2]
  4637. /// </summary>
  4638. /// <param name="text" >Is a text, or a reference to a cell containing a text.</param>
  4639. /// <returns type="Excel.FunctionResult"></returns>
  4640. }
  4641. Functions.prototype.asin = function(number) {
  4642. /// <summary>
  4643. /// Returns the arcsine of a number in radians, in the range -Pi/2 to Pi/2. [Api set: ExcelApi 1.2]
  4644. /// </summary>
  4645. /// <param name="number" >Is the sine of the angle you want and must be from -1 to 1.</param>
  4646. /// <returns type="Excel.FunctionResult"></returns>
  4647. }
  4648. Functions.prototype.asinh = function(number) {
  4649. /// <summary>
  4650. /// Returns the inverse hyperbolic sine of a number. [Api set: ExcelApi 1.2]
  4651. /// </summary>
  4652. /// <param name="number" >Is any real number equal to or greater than 1.</param>
  4653. /// <returns type="Excel.FunctionResult"></returns>
  4654. }
  4655. Functions.prototype.atan = function(number) {
  4656. /// <summary>
  4657. /// Returns the arctangent of a number in radians, in the range -Pi/2 to Pi/2. [Api set: ExcelApi 1.2]
  4658. /// </summary>
  4659. /// <param name="number" >Is the tangent of the angle you want.</param>
  4660. /// <returns type="Excel.FunctionResult"></returns>
  4661. }
  4662. Functions.prototype.atan2 = function(xNum, yNum) {
  4663. /// <summary>
  4664. /// Returns the arctangent of the specified x- and y- coordinates, in radians between -Pi and Pi, excluding -Pi. [Api set: ExcelApi 1.2]
  4665. /// </summary>
  4666. /// <param name="xNum" >Is the x-coordinate of the point.</param>
  4667. /// <param name="yNum" >Is the y-coordinate of the point.</param>
  4668. /// <returns type="Excel.FunctionResult"></returns>
  4669. }
  4670. Functions.prototype.atanh = function(number) {
  4671. /// <summary>
  4672. /// Returns the inverse hyperbolic tangent of a number. [Api set: ExcelApi 1.2]
  4673. /// </summary>
  4674. /// <param name="number" >Is any real number between -1 and 1 excluding -1 and 1.</param>
  4675. /// <returns type="Excel.FunctionResult"></returns>
  4676. }
  4677. Functions.prototype.aveDev = function(values) {
  4678. /// <summary>
  4679. /// Returns the average of the absolute deviations of data points from their mean. Arguments can be numbers or names, arrays, or references that contain numbers. [Api set: ExcelApi 1.2]
  4680. /// </summary>
  4681. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 arguments for which you want the average of the absolute deviations.</param>
  4682. /// <returns type="Excel.FunctionResult"></returns>
  4683. }
  4684. Functions.prototype.average = function(values) {
  4685. /// <summary>
  4686. /// Returns the average (arithmetic mean) of its arguments, which can be numbers or names, arrays, or references that contain numbers. [Api set: ExcelApi 1.2]
  4687. /// </summary>
  4688. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 numeric arguments for which you want the average.</param>
  4689. /// <returns type="Excel.FunctionResult"></returns>
  4690. }
  4691. Functions.prototype.averageA = function(values) {
  4692. /// <summary>
  4693. /// Returns the average (arithmetic mean) of its arguments, evaluating text and FALSE in arguments as 0; TRUE evaluates as 1. Arguments can be numbers, names, arrays, or references. [Api set: ExcelApi 1.2]
  4694. /// </summary>
  4695. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 arguments for which you want the average.</param>
  4696. /// <returns type="Excel.FunctionResult"></returns>
  4697. }
  4698. Functions.prototype.averageIf = function(range, criteria, averageRange) {
  4699. /// <summary>
  4700. /// Finds average(arithmetic mean) for the cells specified by a given condition or criteria. [Api set: ExcelApi 1.2]
  4701. /// </summary>
  4702. /// <param name="range" >Is the range of cells you want evaluated.</param>
  4703. /// <param name="criteria" >Is the condition or criteria in the form of a number, expression, or text that defines which cells will be used to find the average.</param>
  4704. /// <param name="averageRange" optional="true">Are the actual cells to be used to find the average. If omitted, the cells in range are used.</param>
  4705. /// <returns type="Excel.FunctionResult"></returns>
  4706. }
  4707. Functions.prototype.averageIfs = function(averageRange, values) {
  4708. /// <summary>
  4709. /// Finds average(arithmetic mean) for the cells specified by a given set of conditions or criteria. [Api set: ExcelApi 1.2]
  4710. /// </summary>
  4711. /// <param name="averageRange" >Are the actual cells to be used to find the average.</param>
  4712. /// <param name="values" type="Array" >List of parameters, where the first element of each pair is the Is the range of cells you want evaluated for the particular condition , and the second element is is the condition or criteria in the form of a number, expression, or text that defines which cells will be used to find the average.</param>
  4713. /// <returns type="Excel.FunctionResult"></returns>
  4714. }
  4715. Functions.prototype.bahtText = function(number) {
  4716. /// <summary>
  4717. /// Converts a number to text (baht). [Api set: ExcelApi 1.2]
  4718. /// </summary>
  4719. /// <param name="number" >Is a number that you want to convert.</param>
  4720. /// <returns type="Excel.FunctionResult"></returns>
  4721. }
  4722. Functions.prototype.base = function(number, radix, minLength) {
  4723. /// <summary>
  4724. /// Converts a number into a text representation with the given radix (base). [Api set: ExcelApi 1.2]
  4725. /// </summary>
  4726. /// <param name="number" >Is the number that you want to convert.</param>
  4727. /// <param name="radix" >Is the base Radix that you want to convert the number into.</param>
  4728. /// <param name="minLength" optional="true">Is the minimum length of the returned string. If omitted leading zeros are not added.</param>
  4729. /// <returns type="Excel.FunctionResult"></returns>
  4730. }
  4731. Functions.prototype.besselI = function(x, n) {
  4732. /// <summary>
  4733. /// Returns the modified Bessel function In(x). [Api set: ExcelApi 1.2]
  4734. /// </summary>
  4735. /// <param name="x" >Is the value at which to evaluate the function.</param>
  4736. /// <param name="n" >Is the order of the Bessel function.</param>
  4737. /// <returns type="Excel.FunctionResult"></returns>
  4738. }
  4739. Functions.prototype.besselJ = function(x, n) {
  4740. /// <summary>
  4741. /// Returns the Bessel function Jn(x). [Api set: ExcelApi 1.2]
  4742. /// </summary>
  4743. /// <param name="x" >Is the value at which to evaluate the function.</param>
  4744. /// <param name="n" >Is the order of the Bessel function.</param>
  4745. /// <returns type="Excel.FunctionResult"></returns>
  4746. }
  4747. Functions.prototype.besselK = function(x, n) {
  4748. /// <summary>
  4749. /// Returns the modified Bessel function Kn(x). [Api set: ExcelApi 1.2]
  4750. /// </summary>
  4751. /// <param name="x" >Is the value at which to evaluate the function.</param>
  4752. /// <param name="n" >Is the order of the function.</param>
  4753. /// <returns type="Excel.FunctionResult"></returns>
  4754. }
  4755. Functions.prototype.besselY = function(x, n) {
  4756. /// <summary>
  4757. /// Returns the Bessel function Yn(x). [Api set: ExcelApi 1.2]
  4758. /// </summary>
  4759. /// <param name="x" >Is the value at which to evaluate the function.</param>
  4760. /// <param name="n" >Is the order of the function.</param>
  4761. /// <returns type="Excel.FunctionResult"></returns>
  4762. }
  4763. Functions.prototype.beta_Dist = function(x, alpha, beta, cumulative, A, B) {
  4764. /// <summary>
  4765. /// Returns the beta probability distribution function. [Api set: ExcelApi 1.2]
  4766. /// </summary>
  4767. /// <param name="x" >Is the value between A and B at which to evaluate the function.</param>
  4768. /// <param name="alpha" >Is a parameter to the distribution and must be greater than 0.</param>
  4769. /// <param name="beta" >Is a parameter to the distribution and must be greater than 0.</param>
  4770. /// <param name="cumulative" >Is a logical value: for the cumulative distribution function, use TRUE; for the probability density function, use FALSE.</param>
  4771. /// <param name="A" optional="true">Is an optional lower bound to the interval of x. If omitted, A = 0.</param>
  4772. /// <param name="B" optional="true">Is an optional upper bound to the interval of x. If omitted, B = 1.</param>
  4773. /// <returns type="Excel.FunctionResult"></returns>
  4774. }
  4775. Functions.prototype.beta_Inv = function(probability, alpha, beta, A, B) {
  4776. /// <summary>
  4777. /// Returns the inverse of the cumulative beta probability density function (BETA.DIST). [Api set: ExcelApi 1.2]
  4778. /// </summary>
  4779. /// <param name="probability" >Is a probability associated with the beta distribution.</param>
  4780. /// <param name="alpha" >Is a parameter to the distribution and must be greater than 0.</param>
  4781. /// <param name="beta" >Is a parameter to the distribution and must be greater than 0.</param>
  4782. /// <param name="A" optional="true">Is an optional lower bound to the interval of x. If omitted, A = 0.</param>
  4783. /// <param name="B" optional="true">Is an optional upper bound to the interval of x. If omitted, B = 1.</param>
  4784. /// <returns type="Excel.FunctionResult"></returns>
  4785. }
  4786. Functions.prototype.bin2Dec = function(number) {
  4787. /// <summary>
  4788. /// Converts a binary number to decimal. [Api set: ExcelApi 1.2]
  4789. /// </summary>
  4790. /// <param name="number" >Is the binary number you want to convert.</param>
  4791. /// <returns type="Excel.FunctionResult"></returns>
  4792. }
  4793. Functions.prototype.bin2Hex = function(number, places) {
  4794. /// <summary>
  4795. /// Converts a binary number to hexadecimal. [Api set: ExcelApi 1.2]
  4796. /// </summary>
  4797. /// <param name="number" >Is the binary number you want to convert.</param>
  4798. /// <param name="places" optional="true">Is the number of characters to use.</param>
  4799. /// <returns type="Excel.FunctionResult"></returns>
  4800. }
  4801. Functions.prototype.bin2Oct = function(number, places) {
  4802. /// <summary>
  4803. /// Converts a binary number to octal. [Api set: ExcelApi 1.2]
  4804. /// </summary>
  4805. /// <param name="number" >Is the binary number you want to convert.</param>
  4806. /// <param name="places" optional="true">Is the number of characters to use.</param>
  4807. /// <returns type="Excel.FunctionResult"></returns>
  4808. }
  4809. Functions.prototype.binom_Dist = function(numberS, trials, probabilityS, cumulative) {
  4810. /// <summary>
  4811. /// Returns the individual term binomial distribution probability. [Api set: ExcelApi 1.2]
  4812. /// </summary>
  4813. /// <param name="numberS" >Is the number of successes in trials.</param>
  4814. /// <param name="trials" >Is the number of independent trials.</param>
  4815. /// <param name="probabilityS" >Is the probability of success on each trial.</param>
  4816. /// <param name="cumulative" >Is a logical value: for the cumulative distribution function, use TRUE; for the probability mass function, use FALSE.</param>
  4817. /// <returns type="Excel.FunctionResult"></returns>
  4818. }
  4819. Functions.prototype.binom_Dist_Range = function(trials, probabilityS, numberS, numberS2) {
  4820. /// <summary>
  4821. /// Returns the probability of a trial result using a binomial distribution. [Api set: ExcelApi 1.2]
  4822. /// </summary>
  4823. /// <param name="trials" >Is the number of independent trials.</param>
  4824. /// <param name="probabilityS" >Is the probability of success on each trial.</param>
  4825. /// <param name="numberS" >Is the number of successes in trials.</param>
  4826. /// <param name="numberS2" optional="true">If provided this function returns the probability that the number of successful trials shall lie between numberS and numberS2.</param>
  4827. /// <returns type="Excel.FunctionResult"></returns>
  4828. }
  4829. Functions.prototype.binom_Inv = function(trials, probabilityS, alpha) {
  4830. /// <summary>
  4831. /// Returns the smallest value for which the cumulative binomial distribution is greater than or equal to a criterion value. [Api set: ExcelApi 1.2]
  4832. /// </summary>
  4833. /// <param name="trials" >Is the number of Bernoulli trials.</param>
  4834. /// <param name="probabilityS" >Is the probability of success on each trial, a number between 0 and 1 inclusive.</param>
  4835. /// <param name="alpha" >Is the criterion value, a number between 0 and 1 inclusive.</param>
  4836. /// <returns type="Excel.FunctionResult"></returns>
  4837. }
  4838. Functions.prototype.bitand = function(number1, number2) {
  4839. /// <summary>
  4840. /// Returns a bitwise &apos;And&apos; of two numbers. [Api set: ExcelApi 1.2]
  4841. /// </summary>
  4842. /// <param name="number1" >Is the decimal representation of the binary number you want to evaluate.</param>
  4843. /// <param name="number2" >Is the decimal representation of the binary number you want to evaluate.</param>
  4844. /// <returns type="Excel.FunctionResult"></returns>
  4845. }
  4846. Functions.prototype.bitlshift = function(number, shiftAmount) {
  4847. /// <summary>
  4848. /// Returns a number shifted left by shift_amount bits. [Api set: ExcelApi 1.2]
  4849. /// </summary>
  4850. /// <param name="number" >Is the decimal representation of the binary number you want to evaluate.</param>
  4851. /// <param name="shiftAmount" >Is the number of bits that you want to shift Number left by.</param>
  4852. /// <returns type="Excel.FunctionResult"></returns>
  4853. }
  4854. Functions.prototype.bitor = function(number1, number2) {
  4855. /// <summary>
  4856. /// Returns a bitwise &apos;Or&apos; of two numbers. [Api set: ExcelApi 1.2]
  4857. /// </summary>
  4858. /// <param name="number1" >Is the decimal representation of the binary number you want to evaluate.</param>
  4859. /// <param name="number2" >Is the decimal representation of the binary number you want to evaluate.</param>
  4860. /// <returns type="Excel.FunctionResult"></returns>
  4861. }
  4862. Functions.prototype.bitrshift = function(number, shiftAmount) {
  4863. /// <summary>
  4864. /// Returns a number shifted right by shift_amount bits. [Api set: ExcelApi 1.2]
  4865. /// </summary>
  4866. /// <param name="number" >Is the decimal representation of the binary number you want to evaluate.</param>
  4867. /// <param name="shiftAmount" >Is the number of bits that you want to shift Number right by.</param>
  4868. /// <returns type="Excel.FunctionResult"></returns>
  4869. }
  4870. Functions.prototype.bitxor = function(number1, number2) {
  4871. /// <summary>
  4872. /// Returns a bitwise &apos;Exclusive Or&apos; of two numbers. [Api set: ExcelApi 1.2]
  4873. /// </summary>
  4874. /// <param name="number1" >Is the decimal representation of the binary number you want to evaluate.</param>
  4875. /// <param name="number2" >Is the decimal representation of the binary number you want to evaluate.</param>
  4876. /// <returns type="Excel.FunctionResult"></returns>
  4877. }
  4878. Functions.prototype.ceiling_Math = function(number, significance, mode) {
  4879. /// <summary>
  4880. /// Rounds a number up, to the nearest integer or to the nearest multiple of significance. [Api set: ExcelApi 1.2]
  4881. /// </summary>
  4882. /// <param name="number" >Is the value you want to round.</param>
  4883. /// <param name="significance" optional="true">Is the multiple to which you want to round.</param>
  4884. /// <param name="mode" optional="true">When given and nonzero this function will round away from zero.</param>
  4885. /// <returns type="Excel.FunctionResult"></returns>
  4886. }
  4887. Functions.prototype.ceiling_Precise = function(number, significance) {
  4888. /// <summary>
  4889. /// Rounds a number up, to the nearest integer or to the nearest multiple of significance. [Api set: ExcelApi 1.2]
  4890. /// </summary>
  4891. /// <param name="number" >Is the value you want to round.</param>
  4892. /// <param name="significance" optional="true">Is the multiple to which you want to round.</param>
  4893. /// <returns type="Excel.FunctionResult"></returns>
  4894. }
  4895. Functions.prototype.char = function(number) {
  4896. /// <summary>
  4897. /// Returns the character specified by the code number from the character set for your computer. [Api set: ExcelApi 1.2]
  4898. /// </summary>
  4899. /// <param name="number" >Is a number between 1 and 255 specifying which character you want.</param>
  4900. /// <returns type="Excel.FunctionResult"></returns>
  4901. }
  4902. Functions.prototype.chiSq_Dist = function(x, degFreedom, cumulative) {
  4903. /// <summary>
  4904. /// Returns the left-tailed probability of the chi-squared distribution. [Api set: ExcelApi 1.2]
  4905. /// </summary>
  4906. /// <param name="x" >Is the value at which you want to evaluate the distribution, a nonnegative number.</param>
  4907. /// <param name="degFreedom" >Is the number of degrees of freedom, a number between 1 and 10^10, excluding 10^10.</param>
  4908. /// <param name="cumulative" >Is a logical value for the function to return: the cumulative distribution function = TRUE; the probability density function = FALSE.</param>
  4909. /// <returns type="Excel.FunctionResult"></returns>
  4910. }
  4911. Functions.prototype.chiSq_Dist_RT = function(x, degFreedom) {
  4912. /// <summary>
  4913. /// Returns the right-tailed probability of the chi-squared distribution. [Api set: ExcelApi 1.2]
  4914. /// </summary>
  4915. /// <param name="x" >Is the value at which you want to evaluate the distribution, a nonnegative number.</param>
  4916. /// <param name="degFreedom" >Is the number of degrees of freedom, a number between 1 and 10^10, excluding 10^10.</param>
  4917. /// <returns type="Excel.FunctionResult"></returns>
  4918. }
  4919. Functions.prototype.chiSq_Inv = function(probability, degFreedom) {
  4920. /// <summary>
  4921. /// Returns the inverse of the left-tailed probability of the chi-squared distribution. [Api set: ExcelApi 1.2]
  4922. /// </summary>
  4923. /// <param name="probability" >Is a probability associated with the chi-squared distribution, a value between 0 and 1 inclusive.</param>
  4924. /// <param name="degFreedom" >Is the number of degrees of freedom, a number between 1 and 10^10, excluding 10^10.</param>
  4925. /// <returns type="Excel.FunctionResult"></returns>
  4926. }
  4927. Functions.prototype.chiSq_Inv_RT = function(probability, degFreedom) {
  4928. /// <summary>
  4929. /// Returns the inverse of the right-tailed probability of the chi-squared distribution. [Api set: ExcelApi 1.2]
  4930. /// </summary>
  4931. /// <param name="probability" >Is a probability associated with the chi-squared distribution, a value between 0 and 1 inclusive.</param>
  4932. /// <param name="degFreedom" >Is the number of degrees of freedom, a number between 1 and 10^10, excluding 10^10.</param>
  4933. /// <returns type="Excel.FunctionResult"></returns>
  4934. }
  4935. Functions.prototype.choose = function(indexNum, values) {
  4936. /// <summary>
  4937. /// Chooses a value or action to perform from a list of values, based on an index number. [Api set: ExcelApi 1.2]
  4938. /// </summary>
  4939. /// <param name="indexNum" >Specifies which value argument is selected. indexNum must be between 1 and 254, or a formula or a reference to a number between 1 and 254.</param>
  4940. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 254 numbers, cell references, defined names, formulas, functions, or text arguments from which CHOOSE selects.</param>
  4941. /// <returns type="Excel.FunctionResult"></returns>
  4942. }
  4943. Functions.prototype.clean = function(text) {
  4944. /// <summary>
  4945. /// Removes all nonprintable characters from text. [Api set: ExcelApi 1.2]
  4946. /// </summary>
  4947. /// <param name="text" >Is any worksheet information from which you want to remove nonprintable characters.</param>
  4948. /// <returns type="Excel.FunctionResult"></returns>
  4949. }
  4950. Functions.prototype.code = function(text) {
  4951. /// <summary>
  4952. /// Returns a numeric code for the first character in a text string, in the character set used by your computer. [Api set: ExcelApi 1.2]
  4953. /// </summary>
  4954. /// <param name="text" >Is the text for which you want the code of the first character.</param>
  4955. /// <returns type="Excel.FunctionResult"></returns>
  4956. }
  4957. Functions.prototype.columns = function(array) {
  4958. /// <summary>
  4959. /// Returns the number of columns in an array or reference. [Api set: ExcelApi 1.2]
  4960. /// </summary>
  4961. /// <param name="array" >Is an array or array formula, or a reference to a range of cells for which you want the number of columns.</param>
  4962. /// <returns type="Excel.FunctionResult"></returns>
  4963. }
  4964. Functions.prototype.combin = function(number, numberChosen) {
  4965. /// <summary>
  4966. /// Returns the number of combinations for a given number of items. [Api set: ExcelApi 1.2]
  4967. /// </summary>
  4968. /// <param name="number" >Is the total number of items.</param>
  4969. /// <param name="numberChosen" >Is the number of items in each combination.</param>
  4970. /// <returns type="Excel.FunctionResult"></returns>
  4971. }
  4972. Functions.prototype.combina = function(number, numberChosen) {
  4973. /// <summary>
  4974. /// Returns the number of combinations with repetitions for a given number of items. [Api set: ExcelApi 1.2]
  4975. /// </summary>
  4976. /// <param name="number" >Is the total number of items.</param>
  4977. /// <param name="numberChosen" >Is the number of items in each combination.</param>
  4978. /// <returns type="Excel.FunctionResult"></returns>
  4979. }
  4980. Functions.prototype.complex = function(realNum, iNum, suffix) {
  4981. /// <summary>
  4982. /// Converts real and imaginary coefficients into a complex number. [Api set: ExcelApi 1.2]
  4983. /// </summary>
  4984. /// <param name="realNum" >Is the real coefficient of the complex number.</param>
  4985. /// <param name="iNum" >Is the imaginary coefficient of the complex number.</param>
  4986. /// <param name="suffix" optional="true">Is the suffix for the imaginary component of the complex number.</param>
  4987. /// <returns type="Excel.FunctionResult"></returns>
  4988. }
  4989. Functions.prototype.concatenate = function(values) {
  4990. /// <summary>
  4991. /// Joins several text strings into one text string. [Api set: ExcelApi 1.2]
  4992. /// </summary>
  4993. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 text strings to be joined into a single text string and can be text strings, numbers, or single-cell references.</param>
  4994. /// <returns type="Excel.FunctionResult"></returns>
  4995. }
  4996. Functions.prototype.confidence_Norm = function(alpha, standardDev, size) {
  4997. /// <summary>
  4998. /// Returns the confidence interval for a population mean, using a normal distribution. [Api set: ExcelApi 1.2]
  4999. /// </summary>
  5000. /// <param name="alpha" >Is the significance level used to compute the confidence level, a number greater than 0 and less than 1.</param>
  5001. /// <param name="standardDev" >Is the population standard deviation for the data range and is assumed to be known. standardDev must be greater than 0.</param>
  5002. /// <param name="size" >Is the sample size.</param>
  5003. /// <returns type="Excel.FunctionResult"></returns>
  5004. }
  5005. Functions.prototype.confidence_T = function(alpha, standardDev, size) {
  5006. /// <summary>
  5007. /// Returns the confidence interval for a population mean, using a Student&apos;s T distribution. [Api set: ExcelApi 1.2]
  5008. /// </summary>
  5009. /// <param name="alpha" >Is the significance level used to compute the confidence level, a number greater than 0 and less than 1.</param>
  5010. /// <param name="standardDev" >Is the population standard deviation for the data range and is assumed to be known. standardDev must be greater than 0.</param>
  5011. /// <param name="size" >Is the sample size.</param>
  5012. /// <returns type="Excel.FunctionResult"></returns>
  5013. }
  5014. Functions.prototype.convert = function(number, fromUnit, toUnit) {
  5015. /// <summary>
  5016. /// Converts a number from one measurement system to another. [Api set: ExcelApi 1.2]
  5017. /// </summary>
  5018. /// <param name="number" >Is the value in from_units to convert.</param>
  5019. /// <param name="fromUnit" >Is the units for number.</param>
  5020. /// <param name="toUnit" >Is the units for the result.</param>
  5021. /// <returns type="Excel.FunctionResult"></returns>
  5022. }
  5023. Functions.prototype.cos = function(number) {
  5024. /// <summary>
  5025. /// Returns the cosine of an angle. [Api set: ExcelApi 1.2]
  5026. /// </summary>
  5027. /// <param name="number" >Is the angle in radians for which you want the cosine.</param>
  5028. /// <returns type="Excel.FunctionResult"></returns>
  5029. }
  5030. Functions.prototype.cosh = function(number) {
  5031. /// <summary>
  5032. /// Returns the hyperbolic cosine of a number. [Api set: ExcelApi 1.2]
  5033. /// </summary>
  5034. /// <param name="number" >Is any real number.</param>
  5035. /// <returns type="Excel.FunctionResult"></returns>
  5036. }
  5037. Functions.prototype.cot = function(number) {
  5038. /// <summary>
  5039. /// Returns the cotangent of an angle. [Api set: ExcelApi 1.2]
  5040. /// </summary>
  5041. /// <param name="number" >Is the angle in radians for which you want the cotangent.</param>
  5042. /// <returns type="Excel.FunctionResult"></returns>
  5043. }
  5044. Functions.prototype.coth = function(number) {
  5045. /// <summary>
  5046. /// Returns the hyperbolic cotangent of a number. [Api set: ExcelApi 1.2]
  5047. /// </summary>
  5048. /// <param name="number" >Is the angle in radians for which you want the hyperbolic cotangent.</param>
  5049. /// <returns type="Excel.FunctionResult"></returns>
  5050. }
  5051. Functions.prototype.count = function(values) {
  5052. /// <summary>
  5053. /// Counts the number of cells in a range that contain numbers. [Api set: ExcelApi 1.2]
  5054. /// </summary>
  5055. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 arguments that can contain or refer to a variety of different types of data, but only numbers are counted.</param>
  5056. /// <returns type="Excel.FunctionResult"></returns>
  5057. }
  5058. Functions.prototype.countA = function(values) {
  5059. /// <summary>
  5060. /// Counts the number of cells in a range that are not empty. [Api set: ExcelApi 1.2]
  5061. /// </summary>
  5062. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 arguments representing the values and cells you want to count. Values can be any type of information.</param>
  5063. /// <returns type="Excel.FunctionResult"></returns>
  5064. }
  5065. Functions.prototype.countBlank = function(range) {
  5066. /// <summary>
  5067. /// Counts the number of empty cells in a specified range of cells. [Api set: ExcelApi 1.2]
  5068. /// </summary>
  5069. /// <param name="range" >Is the range from which you want to count the empty cells.</param>
  5070. /// <returns type="Excel.FunctionResult"></returns>
  5071. }
  5072. Functions.prototype.countIf = function(range, criteria) {
  5073. /// <summary>
  5074. /// Counts the number of cells within a range that meet the given condition. [Api set: ExcelApi 1.2]
  5075. /// </summary>
  5076. /// <param name="range" >Is the range of cells from which you want to count nonblank cells.</param>
  5077. /// <param name="criteria" >Is the condition in the form of a number, expression, or text that defines which cells will be counted.</param>
  5078. /// <returns type="Excel.FunctionResult"></returns>
  5079. }
  5080. Functions.prototype.countIfs = function(values) {
  5081. /// <summary>
  5082. /// Counts the number of cells specified by a given set of conditions or criteria. [Api set: ExcelApi 1.2]
  5083. /// </summary>
  5084. /// <param name="values" type="Array" >List of parameters, where the first element of each pair is the Is the range of cells you want evaluated for the particular condition , and the second element is is the condition in the form of a number, expression, or text that defines which cells will be counted.</param>
  5085. /// <returns type="Excel.FunctionResult"></returns>
  5086. }
  5087. Functions.prototype.coupDayBs = function(settlement, maturity, frequency, basis) {
  5088. /// <summary>
  5089. /// Returns the number of days from the beginning of the coupon period to the settlement date. [Api set: ExcelApi 1.2]
  5090. /// </summary>
  5091. /// <param name="settlement" >Is the security&apos;s settlement date, expressed as a serial date number.</param>
  5092. /// <param name="maturity" >Is the security&apos;s maturity date, expressed as a serial date number.</param>
  5093. /// <param name="frequency" >Is the number of coupon payments per year.</param>
  5094. /// <param name="basis" optional="true">Is the type of day count basis to use.</param>
  5095. /// <returns type="Excel.FunctionResult"></returns>
  5096. }
  5097. Functions.prototype.coupDays = function(settlement, maturity, frequency, basis) {
  5098. /// <summary>
  5099. /// Returns the number of days in the coupon period that contains the settlement date. [Api set: ExcelApi 1.2]
  5100. /// </summary>
  5101. /// <param name="settlement" >Is the security&apos;s settlement date, expressed as a serial date number.</param>
  5102. /// <param name="maturity" >Is the security&apos;s maturity date, expressed as a serial date number.</param>
  5103. /// <param name="frequency" >Is the number of coupon payments per year.</param>
  5104. /// <param name="basis" optional="true">Is the type of day count basis to use.</param>
  5105. /// <returns type="Excel.FunctionResult"></returns>
  5106. }
  5107. Functions.prototype.coupDaysNc = function(settlement, maturity, frequency, basis) {
  5108. /// <summary>
  5109. /// Returns the number of days from the settlement date to the next coupon date. [Api set: ExcelApi 1.2]
  5110. /// </summary>
  5111. /// <param name="settlement" >Is the security&apos;s settlement date, expressed as a serial date number.</param>
  5112. /// <param name="maturity" >Is the security&apos;s maturity date, expressed as a serial date number.</param>
  5113. /// <param name="frequency" >Is the number of coupon payments per year.</param>
  5114. /// <param name="basis" optional="true">Is the type of day count basis to use.</param>
  5115. /// <returns type="Excel.FunctionResult"></returns>
  5116. }
  5117. Functions.prototype.coupNcd = function(settlement, maturity, frequency, basis) {
  5118. /// <summary>
  5119. /// Returns the next coupon date after the settlement date. [Api set: ExcelApi 1.2]
  5120. /// </summary>
  5121. /// <param name="settlement" >Is the security&apos;s settlement date, expressed as a serial date number.</param>
  5122. /// <param name="maturity" >Is the security&apos;s maturity date, expressed as a serial date number.</param>
  5123. /// <param name="frequency" >Is the number of coupon payments per year.</param>
  5124. /// <param name="basis" optional="true">Is the type of day count basis to use.</param>
  5125. /// <returns type="Excel.FunctionResult"></returns>
  5126. }
  5127. Functions.prototype.coupNum = function(settlement, maturity, frequency, basis) {
  5128. /// <summary>
  5129. /// Returns the number of coupons payable between the settlement date and maturity date. [Api set: ExcelApi 1.2]
  5130. /// </summary>
  5131. /// <param name="settlement" >Is the security&apos;s settlement date, expressed as a serial date number.</param>
  5132. /// <param name="maturity" >Is the security&apos;s maturity date, expressed as a serial date number.</param>
  5133. /// <param name="frequency" >Is the number of coupon payments per year.</param>
  5134. /// <param name="basis" optional="true">Is the type of day count basis to use.</param>
  5135. /// <returns type="Excel.FunctionResult"></returns>
  5136. }
  5137. Functions.prototype.coupPcd = function(settlement, maturity, frequency, basis) {
  5138. /// <summary>
  5139. /// Returns the previous coupon date before the settlement date. [Api set: ExcelApi 1.2]
  5140. /// </summary>
  5141. /// <param name="settlement" >Is the security&apos;s settlement date, expressed as a serial date number.</param>
  5142. /// <param name="maturity" >Is the security&apos;s maturity date, expressed as a serial date number.</param>
  5143. /// <param name="frequency" >Is the number of coupon payments per year.</param>
  5144. /// <param name="basis" optional="true">Is the type of day count basis to use.</param>
  5145. /// <returns type="Excel.FunctionResult"></returns>
  5146. }
  5147. Functions.prototype.csc = function(number) {
  5148. /// <summary>
  5149. /// Returns the cosecant of an angle. [Api set: ExcelApi 1.2]
  5150. /// </summary>
  5151. /// <param name="number" >Is the angle in radians for which you want the cosecant.</param>
  5152. /// <returns type="Excel.FunctionResult"></returns>
  5153. }
  5154. Functions.prototype.csch = function(number) {
  5155. /// <summary>
  5156. /// Returns the hyperbolic cosecant of an angle. [Api set: ExcelApi 1.2]
  5157. /// </summary>
  5158. /// <param name="number" >Is the angle in radians for which you want the hyperbolic cosecant.</param>
  5159. /// <returns type="Excel.FunctionResult"></returns>
  5160. }
  5161. Functions.prototype.cumIPmt = function(rate, nper, pv, startPeriod, endPeriod, type) {
  5162. /// <summary>
  5163. /// Returns the cumulative interest paid between two periods. [Api set: ExcelApi 1.2]
  5164. /// </summary>
  5165. /// <param name="rate" >Is the interest rate.</param>
  5166. /// <param name="nper" >Is the total number of payment periods.</param>
  5167. /// <param name="pv" >Is the present value.</param>
  5168. /// <param name="startPeriod" >Is the first period in the calculation.</param>
  5169. /// <param name="endPeriod" >Is the last period in the calculation.</param>
  5170. /// <param name="type" >Is the timing of the payment.</param>
  5171. /// <returns type="Excel.FunctionResult"></returns>
  5172. }
  5173. Functions.prototype.cumPrinc = function(rate, nper, pv, startPeriod, endPeriod, type) {
  5174. /// <summary>
  5175. /// Returns the cumulative principal paid on a loan between two periods. [Api set: ExcelApi 1.2]
  5176. /// </summary>
  5177. /// <param name="rate" >Is the interest rate.</param>
  5178. /// <param name="nper" >Is the total number of payment periods.</param>
  5179. /// <param name="pv" >Is the present value.</param>
  5180. /// <param name="startPeriod" >Is the first period in the calculation.</param>
  5181. /// <param name="endPeriod" >Is the last period in the calculation.</param>
  5182. /// <param name="type" >Is the timing of the payment.</param>
  5183. /// <returns type="Excel.FunctionResult"></returns>
  5184. }
  5185. Functions.prototype.daverage = function(database, field, criteria) {
  5186. /// <summary>
  5187. /// Averages the values in a column in a list or database that match conditions you specify. [Api set: ExcelApi 1.2]
  5188. /// </summary>
  5189. /// <param name="database" >Is the range of cells that makes up the list or database. A database is a list of related data.</param>
  5190. /// <param name="field" >Is either the label of the column in double quotation marks or a number that represents the column&apos;s position in the list.</param>
  5191. /// <param name="criteria" >Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.</param>
  5192. /// <returns type="Excel.FunctionResult"></returns>
  5193. }
  5194. Functions.prototype.dcount = function(database, field, criteria) {
  5195. /// <summary>
  5196. /// Counts the cells containing numbers in the field (column) of records in the database that match the conditions you specify. [Api set: ExcelApi 1.2]
  5197. /// </summary>
  5198. /// <param name="database" >Is the range of cells that makes up the list or database. A database is a list of related data.</param>
  5199. /// <param name="field" >Is either the label of the column in double quotation marks or a number that represents the column&apos;s position in the list.</param>
  5200. /// <param name="criteria" >Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.</param>
  5201. /// <returns type="Excel.FunctionResult"></returns>
  5202. }
  5203. Functions.prototype.dcountA = function(database, field, criteria) {
  5204. /// <summary>
  5205. /// Counts nonblank cells in the field (column) of records in the database that match the conditions you specify. [Api set: ExcelApi 1.2]
  5206. /// </summary>
  5207. /// <param name="database" >Is the range of cells that makes up the list or database. A database is a list of related data.</param>
  5208. /// <param name="field" >Is either the label of the column in double quotation marks or a number that represents the column&apos;s position in the list.</param>
  5209. /// <param name="criteria" >Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.</param>
  5210. /// <returns type="Excel.FunctionResult"></returns>
  5211. }
  5212. Functions.prototype.dget = function(database, field, criteria) {
  5213. /// <summary>
  5214. /// Extracts from a database a single record that matches the conditions you specify. [Api set: ExcelApi 1.2]
  5215. /// </summary>
  5216. /// <param name="database" >Is the range of cells that makes up the list or database. A database is a list of related data.</param>
  5217. /// <param name="field" >Is either the label of the column in double quotation marks or a number that represents the column&apos;s position in the list.</param>
  5218. /// <param name="criteria" >Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.</param>
  5219. /// <returns type="Excel.FunctionResult"></returns>
  5220. }
  5221. Functions.prototype.dmax = function(database, field, criteria) {
  5222. /// <summary>
  5223. /// Returns the largest number in the field (column) of records in the database that match the conditions you specify. [Api set: ExcelApi 1.2]
  5224. /// </summary>
  5225. /// <param name="database" >Is the range of cells that makes up the list or database. A database is a list of related data.</param>
  5226. /// <param name="field" >Is either the label of the column in double quotation marks or a number that represents the column&apos;s position in the list.</param>
  5227. /// <param name="criteria" >Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.</param>
  5228. /// <returns type="Excel.FunctionResult"></returns>
  5229. }
  5230. Functions.prototype.dmin = function(database, field, criteria) {
  5231. /// <summary>
  5232. /// Returns the smallest number in the field (column) of records in the database that match the conditions you specify. [Api set: ExcelApi 1.2]
  5233. /// </summary>
  5234. /// <param name="database" >Is the range of cells that makes up the list or database. A database is a list of related data.</param>
  5235. /// <param name="field" >Is either the label of the column in double quotation marks or a number that represents the column&apos;s position in the list.</param>
  5236. /// <param name="criteria" >Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.</param>
  5237. /// <returns type="Excel.FunctionResult"></returns>
  5238. }
  5239. Functions.prototype.dproduct = function(database, field, criteria) {
  5240. /// <summary>
  5241. /// Multiplies the values in the field (column) of records in the database that match the conditions you specify. [Api set: ExcelApi 1.2]
  5242. /// </summary>
  5243. /// <param name="database" >Is the range of cells that makes up the list or database. A database is a list of related data.</param>
  5244. /// <param name="field" >Is either the label of the column in double quotation marks or a number that represents the column&apos;s position in the list.</param>
  5245. /// <param name="criteria" >Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.</param>
  5246. /// <returns type="Excel.FunctionResult"></returns>
  5247. }
  5248. Functions.prototype.dstDev = function(database, field, criteria) {
  5249. /// <summary>
  5250. /// Estimates the standard deviation based on a sample from selected database entries. [Api set: ExcelApi 1.2]
  5251. /// </summary>
  5252. /// <param name="database" >Is the range of cells that makes up the list or database. A database is a list of related data.</param>
  5253. /// <param name="field" >Is either the label of the column in double quotation marks or a number that represents the column&apos;s position in the list.</param>
  5254. /// <param name="criteria" >Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.</param>
  5255. /// <returns type="Excel.FunctionResult"></returns>
  5256. }
  5257. Functions.prototype.dstDevP = function(database, field, criteria) {
  5258. /// <summary>
  5259. /// Calculates the standard deviation based on the entire population of selected database entries. [Api set: ExcelApi 1.2]
  5260. /// </summary>
  5261. /// <param name="database" >Is the range of cells that makes up the list or database. A database is a list of related data.</param>
  5262. /// <param name="field" >Is either the label of the column in double quotation marks or a number that represents the column&apos;s position in the list.</param>
  5263. /// <param name="criteria" >Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.</param>
  5264. /// <returns type="Excel.FunctionResult"></returns>
  5265. }
  5266. Functions.prototype.dsum = function(database, field, criteria) {
  5267. /// <summary>
  5268. /// Adds the numbers in the field (column) of records in the database that match the conditions you specify. [Api set: ExcelApi 1.2]
  5269. /// </summary>
  5270. /// <param name="database" >Is the range of cells that makes up the list or database. A database is a list of related data.</param>
  5271. /// <param name="field" >Is either the label of the column in double quotation marks or a number that represents the column&apos;s position in the list.</param>
  5272. /// <param name="criteria" >Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.</param>
  5273. /// <returns type="Excel.FunctionResult"></returns>
  5274. }
  5275. Functions.prototype.dvar = function(database, field, criteria) {
  5276. /// <summary>
  5277. /// Estimates variance based on a sample from selected database entries. [Api set: ExcelApi 1.2]
  5278. /// </summary>
  5279. /// <param name="database" >Is the range of cells that makes up the list or database. A database is a list of related data.</param>
  5280. /// <param name="field" >Is either the label of the column in double quotation marks or a number that represents the column&apos;s position in the list.</param>
  5281. /// <param name="criteria" >Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.</param>
  5282. /// <returns type="Excel.FunctionResult"></returns>
  5283. }
  5284. Functions.prototype.dvarP = function(database, field, criteria) {
  5285. /// <summary>
  5286. /// Calculates variance based on the entire population of selected database entries. [Api set: ExcelApi 1.2]
  5287. /// </summary>
  5288. /// <param name="database" >Is the range of cells that makes up the list or database. A database is a list of related data.</param>
  5289. /// <param name="field" >Is either the label of the column in double quotation marks or a number that represents the column&apos;s position in the list.</param>
  5290. /// <param name="criteria" >Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.</param>
  5291. /// <returns type="Excel.FunctionResult"></returns>
  5292. }
  5293. Functions.prototype.date = function(year, month, day) {
  5294. /// <summary>
  5295. /// Returns the number that represents the date in Microsoft Excel date-time code. [Api set: ExcelApi 1.2]
  5296. /// </summary>
  5297. /// <param name="year" >Is a number from 1900 or 1904 (depending on the workbook&apos;s date system) to 9999.</param>
  5298. /// <param name="month" >Is a number from 1 to 12 representing the month of the year.</param>
  5299. /// <param name="day" >Is a number from 1 to 31 representing the day of the month.</param>
  5300. /// <returns type="Excel.FunctionResult"></returns>
  5301. }
  5302. Functions.prototype.datevalue = function(dateText) {
  5303. /// <summary>
  5304. /// Converts a date in the form of text to a number that represents the date in Microsoft Excel date-time code. [Api set: ExcelApi 1.2]
  5305. /// </summary>
  5306. /// <param name="dateText" >Is text that represents a date in a Microsoft Excel date format, between 1/1/1900 or 1/1/1904 (depending on the workbook&apos;s date system) and 12/31/9999.</param>
  5307. /// <returns type="Excel.FunctionResult"></returns>
  5308. }
  5309. Functions.prototype.day = function(serialNumber) {
  5310. /// <summary>
  5311. /// Returns the day of the month, a number from 1 to 31. [Api set: ExcelApi 1.2]
  5312. /// </summary>
  5313. /// <param name="serialNumber" >Is a number in the date-time code used by Microsoft Excel.</param>
  5314. /// <returns type="Excel.FunctionResult"></returns>
  5315. }
  5316. Functions.prototype.days = function(endDate, startDate) {
  5317. /// <summary>
  5318. /// Returns the number of days between the two dates. [Api set: ExcelApi 1.2]
  5319. /// </summary>
  5320. /// <param name="endDate" >startDate and endDate are the two dates between which you want to know the number of days.</param>
  5321. /// <param name="startDate" >startDate and endDate are the two dates between which you want to know the number of days.</param>
  5322. /// <returns type="Excel.FunctionResult"></returns>
  5323. }
  5324. Functions.prototype.days360 = function(startDate, endDate, method) {
  5325. /// <summary>
  5326. /// Returns the number of days between two dates based on a 360-day year (twelve 30-day months). [Api set: ExcelApi 1.2]
  5327. /// </summary>
  5328. /// <param name="startDate" >startDate and endDate are the two dates between which you want to know the number of days.</param>
  5329. /// <param name="endDate" >startDate and endDate are the two dates between which you want to know the number of days.</param>
  5330. /// <param name="method" optional="true">Is a logical value specifying the calculation method: U.S. (NASD) = FALSE or omitted; European = TRUE.</param>
  5331. /// <returns type="Excel.FunctionResult"></returns>
  5332. }
  5333. Functions.prototype.db = function(cost, salvage, life, period, month) {
  5334. /// <summary>
  5335. /// Returns the depreciation of an asset for a specified period using the fixed-declining balance method. [Api set: ExcelApi 1.2]
  5336. /// </summary>
  5337. /// <param name="cost" >Is the initial cost of the asset.</param>
  5338. /// <param name="salvage" >Is the salvage value at the end of the life of the asset.</param>
  5339. /// <param name="life" >Is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset).</param>
  5340. /// <param name="period" >Is the period for which you want to calculate the depreciation. Period must use the same units as Life.</param>
  5341. /// <param name="month" optional="true">Is the number of months in the first year. If month is omitted, it is assumed to be 12.</param>
  5342. /// <returns type="Excel.FunctionResult"></returns>
  5343. }
  5344. Functions.prototype.dbcs = function(text) {
  5345. /// <summary>
  5346. /// Changes half-width (single-byte) characters within a character string to full-width (double-byte) characters. Use with double-byte character sets (DBCS). [Api set: ExcelApi 1.2]
  5347. /// </summary>
  5348. /// <param name="text" >Is a text, or a reference to a cell containing a text.</param>
  5349. /// <returns type="Excel.FunctionResult"></returns>
  5350. }
  5351. Functions.prototype.ddb = function(cost, salvage, life, period, factor) {
  5352. /// <summary>
  5353. /// Returns the depreciation of an asset for a specified period using the double-declining balance method or some other method you specify. [Api set: ExcelApi 1.2]
  5354. /// </summary>
  5355. /// <param name="cost" >Is the initial cost of the asset.</param>
  5356. /// <param name="salvage" >Is the salvage value at the end of the life of the asset.</param>
  5357. /// <param name="life" >Is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset).</param>
  5358. /// <param name="period" >Is the period for which you want to calculate the depreciation. Period must use the same units as Life.</param>
  5359. /// <param name="factor" optional="true">Is the rate at which the balance declines. If Factor is omitted, it is assumed to be 2 (the double-declining balance method).</param>
  5360. /// <returns type="Excel.FunctionResult"></returns>
  5361. }
  5362. Functions.prototype.dec2Bin = function(number, places) {
  5363. /// <summary>
  5364. /// Converts a decimal number to binary. [Api set: ExcelApi 1.2]
  5365. /// </summary>
  5366. /// <param name="number" >Is the decimal integer you want to convert.</param>
  5367. /// <param name="places" optional="true">Is the number of characters to use.</param>
  5368. /// <returns type="Excel.FunctionResult"></returns>
  5369. }
  5370. Functions.prototype.dec2Hex = function(number, places) {
  5371. /// <summary>
  5372. /// Converts a decimal number to hexadecimal. [Api set: ExcelApi 1.2]
  5373. /// </summary>
  5374. /// <param name="number" >Is the decimal integer you want to convert.</param>
  5375. /// <param name="places" optional="true">Is the number of characters to use.</param>
  5376. /// <returns type="Excel.FunctionResult"></returns>
  5377. }
  5378. Functions.prototype.dec2Oct = function(number, places) {
  5379. /// <summary>
  5380. /// Converts a decimal number to octal. [Api set: ExcelApi 1.2]
  5381. /// </summary>
  5382. /// <param name="number" >Is the decimal integer you want to convert.</param>
  5383. /// <param name="places" optional="true">Is the number of characters to use.</param>
  5384. /// <returns type="Excel.FunctionResult"></returns>
  5385. }
  5386. Functions.prototype.decimal = function(number, radix) {
  5387. /// <summary>
  5388. /// Converts a text representation of a number in a given base into a decimal number. [Api set: ExcelApi 1.2]
  5389. /// </summary>
  5390. /// <param name="number" >Is the number that you want to convert.</param>
  5391. /// <param name="radix" >Is the base Radix of the number you are converting.</param>
  5392. /// <returns type="Excel.FunctionResult"></returns>
  5393. }
  5394. Functions.prototype.degrees = function(angle) {
  5395. /// <summary>
  5396. /// Converts radians to degrees. [Api set: ExcelApi 1.2]
  5397. /// </summary>
  5398. /// <param name="angle" >Is the angle in radians that you want to convert.</param>
  5399. /// <returns type="Excel.FunctionResult"></returns>
  5400. }
  5401. Functions.prototype.delta = function(number1, number2) {
  5402. /// <summary>
  5403. /// Tests whether two numbers are equal. [Api set: ExcelApi 1.2]
  5404. /// </summary>
  5405. /// <param name="number1" >Is the first number.</param>
  5406. /// <param name="number2" optional="true">Is the second number.</param>
  5407. /// <returns type="Excel.FunctionResult"></returns>
  5408. }
  5409. Functions.prototype.devSq = function(values) {
  5410. /// <summary>
  5411. /// Returns the sum of squares of deviations of data points from their sample mean. [Api set: ExcelApi 1.2]
  5412. /// </summary>
  5413. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 arguments, or an array or array reference, on which you want DEVSQ to calculate.</param>
  5414. /// <returns type="Excel.FunctionResult"></returns>
  5415. }
  5416. Functions.prototype.disc = function(settlement, maturity, pr, redemption, basis) {
  5417. /// <summary>
  5418. /// Returns the discount rate for a security. [Api set: ExcelApi 1.2]
  5419. /// </summary>
  5420. /// <param name="settlement" >Is the security&apos;s settlement date, expressed as a serial date number.</param>
  5421. /// <param name="maturity" >Is the security&apos;s maturity date, expressed as a serial date number.</param>
  5422. /// <param name="pr" >Is the security&apos;s price per $100 face value.</param>
  5423. /// <param name="redemption" >Is the security&apos;s redemption value per $100 face value.</param>
  5424. /// <param name="basis" optional="true">Is the type of day count basis to use.</param>
  5425. /// <returns type="Excel.FunctionResult"></returns>
  5426. }
  5427. Functions.prototype.dollar = function(number, decimals) {
  5428. /// <summary>
  5429. /// Converts a number to text, using currency format. [Api set: ExcelApi 1.2]
  5430. /// </summary>
  5431. /// <param name="number" >Is a number, a reference to a cell containing a number, or a formula that evaluates to a number.</param>
  5432. /// <param name="decimals" optional="true">Is the number of digits to the right of the decimal point. The number is rounded as necessary; if omitted, Decimals = 2.</param>
  5433. /// <returns type="Excel.FunctionResult"></returns>
  5434. }
  5435. Functions.prototype.dollarDe = function(fractionalDollar, fraction) {
  5436. /// <summary>
  5437. /// Converts a dollar price, expressed as a fraction, into a dollar price, expressed as a decimal number. [Api set: ExcelApi 1.2]
  5438. /// </summary>
  5439. /// <param name="fractionalDollar" >Is a number expressed as a fraction.</param>
  5440. /// <param name="fraction" >Is the integer to use in the denominator of the fraction.</param>
  5441. /// <returns type="Excel.FunctionResult"></returns>
  5442. }
  5443. Functions.prototype.dollarFr = function(decimalDollar, fraction) {
  5444. /// <summary>
  5445. /// Converts a dollar price, expressed as a decimal number, into a dollar price, expressed as a fraction. [Api set: ExcelApi 1.2]
  5446. /// </summary>
  5447. /// <param name="decimalDollar" >Is a decimal number.</param>
  5448. /// <param name="fraction" >Is the integer to use in the denominator of a fraction.</param>
  5449. /// <returns type="Excel.FunctionResult"></returns>
  5450. }
  5451. Functions.prototype.duration = function(settlement, maturity, coupon, yld, frequency, basis) {
  5452. /// <summary>
  5453. /// Returns the annual duration of a security with periodic interest payments. [Api set: ExcelApi 1.2]
  5454. /// </summary>
  5455. /// <param name="settlement" >Is the security&apos;s settlement date, expressed as a serial date number.</param>
  5456. /// <param name="maturity" >Is the security&apos;s maturity date, expressed as a serial date number.</param>
  5457. /// <param name="coupon" >Is the security&apos;s annual coupon rate.</param>
  5458. /// <param name="yld" >Is the security&apos;s annual yield.</param>
  5459. /// <param name="frequency" >Is the number of coupon payments per year.</param>
  5460. /// <param name="basis" optional="true">Is the type of day count basis to use.</param>
  5461. /// <returns type="Excel.FunctionResult"></returns>
  5462. }
  5463. Functions.prototype.ecma_Ceiling = function(number, significance) {
  5464. /// <summary>
  5465. /// Rounds a number up, to the nearest integer or to the nearest multiple of significance. [Api set: ExcelApi 1.2]
  5466. /// </summary>
  5467. /// <param name="number" >Is the value you want to round.</param>
  5468. /// <param name="significance" >Is the multiple to which you want to round.</param>
  5469. /// <returns type="Excel.FunctionResult"></returns>
  5470. }
  5471. Functions.prototype.edate = function(startDate, months) {
  5472. /// <summary>
  5473. /// Returns the serial number of the date that is the indicated number of months before or after the start date. [Api set: ExcelApi 1.2]
  5474. /// </summary>
  5475. /// <param name="startDate" >Is a serial date number that represents the start date.</param>
  5476. /// <param name="months" >Is the number of months before or after startDate.</param>
  5477. /// <returns type="Excel.FunctionResult"></returns>
  5478. }
  5479. Functions.prototype.effect = function(nominalRate, npery) {
  5480. /// <summary>
  5481. /// Returns the effective annual interest rate. [Api set: ExcelApi 1.2]
  5482. /// </summary>
  5483. /// <param name="nominalRate" >Is the nominal interest rate.</param>
  5484. /// <param name="npery" >Is the number of compounding periods per year.</param>
  5485. /// <returns type="Excel.FunctionResult"></returns>
  5486. }
  5487. Functions.prototype.eoMonth = function(startDate, months) {
  5488. /// <summary>
  5489. /// Returns the serial number of the last day of the month before or after a specified number of months. [Api set: ExcelApi 1.2]
  5490. /// </summary>
  5491. /// <param name="startDate" >Is a serial date number that represents the start date.</param>
  5492. /// <param name="months" >Is the number of months before or after the startDate.</param>
  5493. /// <returns type="Excel.FunctionResult"></returns>
  5494. }
  5495. Functions.prototype.erf = function(lowerLimit, upperLimit) {
  5496. /// <summary>
  5497. /// Returns the error function. [Api set: ExcelApi 1.2]
  5498. /// </summary>
  5499. /// <param name="lowerLimit" >Is the lower bound for integrating ERF.</param>
  5500. /// <param name="upperLimit" optional="true">Is the upper bound for integrating ERF.</param>
  5501. /// <returns type="Excel.FunctionResult"></returns>
  5502. }
  5503. Functions.prototype.erfC = function(x) {
  5504. /// <summary>
  5505. /// Returns the complementary error function. [Api set: ExcelApi 1.2]
  5506. /// </summary>
  5507. /// <param name="x" >Is the lower bound for integrating ERF.</param>
  5508. /// <returns type="Excel.FunctionResult"></returns>
  5509. }
  5510. Functions.prototype.erfC_Precise = function(X) {
  5511. /// <summary>
  5512. /// Returns the complementary error function. [Api set: ExcelApi 1.2]
  5513. /// </summary>
  5514. /// <param name="X" >Is the lower bound for integrating ERFC.PRECISE.</param>
  5515. /// <returns type="Excel.FunctionResult"></returns>
  5516. }
  5517. Functions.prototype.erf_Precise = function(X) {
  5518. /// <summary>
  5519. /// Returns the error function. [Api set: ExcelApi 1.2]
  5520. /// </summary>
  5521. /// <param name="X" >Is the lower bound for integrating ERF.PRECISE.</param>
  5522. /// <returns type="Excel.FunctionResult"></returns>
  5523. }
  5524. Functions.prototype.error_Type = function(errorVal) {
  5525. /// <summary>
  5526. /// Returns a number matching an error value. [Api set: ExcelApi 1.2]
  5527. /// </summary>
  5528. /// <param name="errorVal" >Is the error value for which you want the identifying number, and can be an actual error value or a reference to a cell containing an error value.</param>
  5529. /// <returns type="Excel.FunctionResult"></returns>
  5530. }
  5531. Functions.prototype.even = function(number) {
  5532. /// <summary>
  5533. /// Rounds a positive number up and negative number down to the nearest even integer. [Api set: ExcelApi 1.2]
  5534. /// </summary>
  5535. /// <param name="number" >Is the value to round.</param>
  5536. /// <returns type="Excel.FunctionResult"></returns>
  5537. }
  5538. Functions.prototype.exact = function(text1, text2) {
  5539. /// <summary>
  5540. /// Checks whether two text strings are exactly the same, and returns TRUE or FALSE. EXACT is case-sensitive. [Api set: ExcelApi 1.2]
  5541. /// </summary>
  5542. /// <param name="text1" >Is the first text string.</param>
  5543. /// <param name="text2" >Is the second text string.</param>
  5544. /// <returns type="Excel.FunctionResult"></returns>
  5545. }
  5546. Functions.prototype.exp = function(number) {
  5547. /// <summary>
  5548. /// Returns e raised to the power of a given number. [Api set: ExcelApi 1.2]
  5549. /// </summary>
  5550. /// <param name="number" >Is the exponent applied to the base e. The constant e equals 2.71828182845904, the base of the natural logarithm.</param>
  5551. /// <returns type="Excel.FunctionResult"></returns>
  5552. }
  5553. Functions.prototype.expon_Dist = function(x, lambda, cumulative) {
  5554. /// <summary>
  5555. /// Returns the exponential distribution. [Api set: ExcelApi 1.2]
  5556. /// </summary>
  5557. /// <param name="x" >Is the value of the function, a nonnegative number.</param>
  5558. /// <param name="lambda" >Is the parameter value, a positive number.</param>
  5559. /// <param name="cumulative" >Is a logical value for the function to return: the cumulative distribution function = TRUE; the probability density function = FALSE.</param>
  5560. /// <returns type="Excel.FunctionResult"></returns>
  5561. }
  5562. Functions.prototype.fvschedule = function(principal, schedule) {
  5563. /// <summary>
  5564. /// Returns the future value of an initial principal after applying a series of compound interest rates. [Api set: ExcelApi 1.2]
  5565. /// </summary>
  5566. /// <param name="principal" >Is the present value.</param>
  5567. /// <param name="schedule" >Is an array of interest rates to apply.</param>
  5568. /// <returns type="Excel.FunctionResult"></returns>
  5569. }
  5570. Functions.prototype.f_Dist = function(x, degFreedom1, degFreedom2, cumulative) {
  5571. /// <summary>
  5572. /// Returns the (left-tailed) F probability distribution (degree of diversity) for two data sets. [Api set: ExcelApi 1.2]
  5573. /// </summary>
  5574. /// <param name="x" >Is the value at which to evaluate the function, a nonnegative number.</param>
  5575. /// <param name="degFreedom1" >Is the numerator degrees of freedom, a number between 1 and 10^10, excluding 10^10.</param>
  5576. /// <param name="degFreedom2" >Is the denominator degrees of freedom, a number between 1 and 10^10, excluding 10^10.</param>
  5577. /// <param name="cumulative" >Is a logical value for the function to return: the cumulative distribution function = TRUE; the probability density function = FALSE.</param>
  5578. /// <returns type="Excel.FunctionResult"></returns>
  5579. }
  5580. Functions.prototype.f_Dist_RT = function(x, degFreedom1, degFreedom2) {
  5581. /// <summary>
  5582. /// Returns the (right-tailed) F probability distribution (degree of diversity) for two data sets. [Api set: ExcelApi 1.2]
  5583. /// </summary>
  5584. /// <param name="x" >Is the value at which to evaluate the function, a nonnegative number.</param>
  5585. /// <param name="degFreedom1" >Is the numerator degrees of freedom, a number between 1 and 10^10, excluding 10^10.</param>
  5586. /// <param name="degFreedom2" >Is the denominator degrees of freedom, a number between 1 and 10^10, excluding 10^10.</param>
  5587. /// <returns type="Excel.FunctionResult"></returns>
  5588. }
  5589. Functions.prototype.f_Inv = function(probability, degFreedom1, degFreedom2) {
  5590. /// <summary>
  5591. /// Returns the inverse of the (left-tailed) F probability distribution: if p = F.DIST(x,...), then F.INV(p,...) = x. [Api set: ExcelApi 1.2]
  5592. /// </summary>
  5593. /// <param name="probability" >Is a probability associated with the F cumulative distribution, a number between 0 and 1 inclusive.</param>
  5594. /// <param name="degFreedom1" >Is the numerator degrees of freedom, a number between 1 and 10^10, excluding 10^10.</param>
  5595. /// <param name="degFreedom2" >Is the denominator degrees of freedom, a number between 1 and 10^10, excluding 10^10.</param>
  5596. /// <returns type="Excel.FunctionResult"></returns>
  5597. }
  5598. Functions.prototype.f_Inv_RT = function(probability, degFreedom1, degFreedom2) {
  5599. /// <summary>
  5600. /// Returns the inverse of the (right-tailed) F probability distribution: if p = F.DIST.RT(x,...), then F.INV.RT(p,...) = x. [Api set: ExcelApi 1.2]
  5601. /// </summary>
  5602. /// <param name="probability" >Is a probability associated with the F cumulative distribution, a number between 0 and 1 inclusive.</param>
  5603. /// <param name="degFreedom1" >Is the numerator degrees of freedom, a number between 1 and 10^10, excluding 10^10.</param>
  5604. /// <param name="degFreedom2" >Is the denominator degrees of freedom, a number between 1 and 10^10, excluding 10^10.</param>
  5605. /// <returns type="Excel.FunctionResult"></returns>
  5606. }
  5607. Functions.prototype.fact = function(number) {
  5608. /// <summary>
  5609. /// Returns the factorial of a number, equal to 1*2*3*...* Number. [Api set: ExcelApi 1.2]
  5610. /// </summary>
  5611. /// <param name="number" >Is the nonnegative number you want the factorial of.</param>
  5612. /// <returns type="Excel.FunctionResult"></returns>
  5613. }
  5614. Functions.prototype.factDouble = function(number) {
  5615. /// <summary>
  5616. /// Returns the double factorial of a number. [Api set: ExcelApi 1.2]
  5617. /// </summary>
  5618. /// <param name="number" >Is the value for which to return the double factorial.</param>
  5619. /// <returns type="Excel.FunctionResult"></returns>
  5620. }
  5621. Functions.prototype.false = function() {
  5622. /// <summary>
  5623. /// Returns the logical value FALSE. [Api set: ExcelApi 1.2]
  5624. /// </summary>
  5625. /// <returns type="Excel.FunctionResult"></returns>
  5626. }
  5627. Functions.prototype.find = function(findText, withinText, startNum) {
  5628. /// <summary>
  5629. /// Returns the starting position of one text string within another text string. FIND is case-sensitive. [Api set: ExcelApi 1.2]
  5630. /// </summary>
  5631. /// <param name="findText" >Is the text you want to find. Use double quotes (empty text) to match the first character in withinText; wildcard characters not allowed.</param>
  5632. /// <param name="withinText" >Is the text containing the text you want to find.</param>
  5633. /// <param name="startNum" optional="true">Specifies the character at which to start the search. The first character in withinText is character number 1. If omitted, startNum = 1.</param>
  5634. /// <returns type="Excel.FunctionResult"></returns>
  5635. }
  5636. Functions.prototype.findB = function(findText, withinText, startNum) {
  5637. /// <summary>
  5638. /// Finds the starting position of one text string within another text string. FINDB is case-sensitive. Use with double-byte character sets (DBCS). [Api set: ExcelApi 1.2]
  5639. /// </summary>
  5640. /// <param name="findText" >Is the text you want to find.</param>
  5641. /// <param name="withinText" >Is the text containing the text you want to find.</param>
  5642. /// <param name="startNum" optional="true">Specifies the character at which to start the search.</param>
  5643. /// <returns type="Excel.FunctionResult"></returns>
  5644. }
  5645. Functions.prototype.fisher = function(x) {
  5646. /// <summary>
  5647. /// Returns the Fisher transformation. [Api set: ExcelApi 1.2]
  5648. /// </summary>
  5649. /// <param name="x" >Is the value for which you want the transformation, a number between -1 and 1, excluding -1 and 1.</param>
  5650. /// <returns type="Excel.FunctionResult"></returns>
  5651. }
  5652. Functions.prototype.fisherInv = function(y) {
  5653. /// <summary>
  5654. /// Returns the inverse of the Fisher transformation: if y = FISHER(x), then FISHERINV(y) = x. [Api set: ExcelApi 1.2]
  5655. /// </summary>
  5656. /// <param name="y" >Is the value for which you want to perform the inverse of the transformation.</param>
  5657. /// <returns type="Excel.FunctionResult"></returns>
  5658. }
  5659. Functions.prototype.fixed = function(number, decimals, noCommas) {
  5660. /// <summary>
  5661. /// Rounds a number to the specified number of decimals and returns the result as text with or without commas. [Api set: ExcelApi 1.2]
  5662. /// </summary>
  5663. /// <param name="number" >Is the number you want to round and convert to text.</param>
  5664. /// <param name="decimals" optional="true">Is the number of digits to the right of the decimal point. If omitted, Decimals = 2.</param>
  5665. /// <param name="noCommas" optional="true">Is a logical value: do not display commas in the returned text = TRUE; do display commas in the returned text = FALSE or omitted.</param>
  5666. /// <returns type="Excel.FunctionResult"></returns>
  5667. }
  5668. Functions.prototype.floor_Math = function(number, significance, mode) {
  5669. /// <summary>
  5670. /// Rounds a number down, to the nearest integer or to the nearest multiple of significance. [Api set: ExcelApi 1.2]
  5671. /// </summary>
  5672. /// <param name="number" >Is the value you want to round.</param>
  5673. /// <param name="significance" optional="true">Is the multiple to which you want to round.</param>
  5674. /// <param name="mode" optional="true">When given and nonzero this function will round towards zero.</param>
  5675. /// <returns type="Excel.FunctionResult"></returns>
  5676. }
  5677. Functions.prototype.floor_Precise = function(number, significance) {
  5678. /// <summary>
  5679. /// Rounds a number down, to the nearest integer or to the nearest multiple of significance. [Api set: ExcelApi 1.2]
  5680. /// </summary>
  5681. /// <param name="number" >Is the numeric value you want to round.</param>
  5682. /// <param name="significance" optional="true">Is the multiple to which you want to round.</param>
  5683. /// <returns type="Excel.FunctionResult"></returns>
  5684. }
  5685. Functions.prototype.fv = function(rate, nper, pmt, pv, type) {
  5686. /// <summary>
  5687. /// Returns the future value of an investment based on periodic, constant payments and a constant interest rate. [Api set: ExcelApi 1.2]
  5688. /// </summary>
  5689. /// <param name="rate" >Is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR.</param>
  5690. /// <param name="nper" >Is the total number of payment periods in the investment.</param>
  5691. /// <param name="pmt" >Is the payment made each period; it cannot change over the life of the investment.</param>
  5692. /// <param name="pv" optional="true">Is the present value, or the lump-sum amount that a series of future payments is worth now. If omitted, Pv = 0.</param>
  5693. /// <param name="type" optional="true">Is a value representing the timing of payment: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted.</param>
  5694. /// <returns type="Excel.FunctionResult"></returns>
  5695. }
  5696. Functions.prototype.gamma = function(x) {
  5697. /// <summary>
  5698. /// Returns the Gamma function value. [Api set: ExcelApi 1.2]
  5699. /// </summary>
  5700. /// <param name="x" >Is the value for which you want to calculate Gamma.</param>
  5701. /// <returns type="Excel.FunctionResult"></returns>
  5702. }
  5703. Functions.prototype.gammaLn = function(x) {
  5704. /// <summary>
  5705. /// Returns the natural logarithm of the gamma function. [Api set: ExcelApi 1.2]
  5706. /// </summary>
  5707. /// <param name="x" >Is the value for which you want to calculate GAMMALN, a positive number.</param>
  5708. /// <returns type="Excel.FunctionResult"></returns>
  5709. }
  5710. Functions.prototype.gammaLn_Precise = function(x) {
  5711. /// <summary>
  5712. /// Returns the natural logarithm of the gamma function. [Api set: ExcelApi 1.2]
  5713. /// </summary>
  5714. /// <param name="x" >Is the value for which you want to calculate GAMMALN.PRECISE, a positive number.</param>
  5715. /// <returns type="Excel.FunctionResult"></returns>
  5716. }
  5717. Functions.prototype.gamma_Dist = function(x, alpha, beta, cumulative) {
  5718. /// <summary>
  5719. /// Returns the gamma distribution. [Api set: ExcelApi 1.2]
  5720. /// </summary>
  5721. /// <param name="x" >Is the value at which you want to evaluate the distribution, a nonnegative number.</param>
  5722. /// <param name="alpha" >Is a parameter to the distribution, a positive number.</param>
  5723. /// <param name="beta" >Is a parameter to the distribution, a positive number. If beta = 1, GAMMA.DIST returns the standard gamma distribution.</param>
  5724. /// <param name="cumulative" >Is a logical value: return the cumulative distribution function = TRUE; return the probability mass function = FALSE or omitted.</param>
  5725. /// <returns type="Excel.FunctionResult"></returns>
  5726. }
  5727. Functions.prototype.gamma_Inv = function(probability, alpha, beta) {
  5728. /// <summary>
  5729. /// Returns the inverse of the gamma cumulative distribution: if p = GAMMA.DIST(x,...), then GAMMA.INV(p,...) = x. [Api set: ExcelApi 1.2]
  5730. /// </summary>
  5731. /// <param name="probability" >Is the probability associated with the gamma distribution, a number between 0 and 1, inclusive.</param>
  5732. /// <param name="alpha" >Is a parameter to the distribution, a positive number.</param>
  5733. /// <param name="beta" >Is a parameter to the distribution, a positive number. If beta = 1, GAMMA.INV returns the inverse of the standard gamma distribution.</param>
  5734. /// <returns type="Excel.FunctionResult"></returns>
  5735. }
  5736. Functions.prototype.gauss = function(x) {
  5737. /// <summary>
  5738. /// Returns 0.5 less than the standard normal cumulative distribution. [Api set: ExcelApi 1.2]
  5739. /// </summary>
  5740. /// <param name="x" >Is the value for which you want the distribution.</param>
  5741. /// <returns type="Excel.FunctionResult"></returns>
  5742. }
  5743. Functions.prototype.gcd = function(values) {
  5744. /// <summary>
  5745. /// Returns the greatest common divisor. [Api set: ExcelApi 1.2]
  5746. /// </summary>
  5747. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 values.</param>
  5748. /// <returns type="Excel.FunctionResult"></returns>
  5749. }
  5750. Functions.prototype.geStep = function(number, step) {
  5751. /// <summary>
  5752. /// Tests whether a number is greater than a threshold value. [Api set: ExcelApi 1.2]
  5753. /// </summary>
  5754. /// <param name="number" >Is the value to test against step.</param>
  5755. /// <param name="step" optional="true">Is the threshold value.</param>
  5756. /// <returns type="Excel.FunctionResult"></returns>
  5757. }
  5758. Functions.prototype.geoMean = function(values) {
  5759. /// <summary>
  5760. /// Returns the geometric mean of an array or range of positive numeric data. [Api set: ExcelApi 1.2]
  5761. /// </summary>
  5762. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 numbers or names, arrays, or references that contain numbers for which you want the mean.</param>
  5763. /// <returns type="Excel.FunctionResult"></returns>
  5764. }
  5765. Functions.prototype.hlookup = function(lookupValue, tableArray, rowIndexNum, rangeLookup) {
  5766. /// <summary>
  5767. /// Looks for a value in the top row of a table or array of values and returns the value in the same column from a row you specify. [Api set: ExcelApi 1.2]
  5768. /// </summary>
  5769. /// <param name="lookupValue" >Is the value to be found in the first row of the table and can be a value, a reference, or a text string.</param>
  5770. /// <param name="tableArray" >Is a table of text, numbers, or logical values in which data is looked up. tableArray can be a reference to a range or a range name.</param>
  5771. /// <param name="rowIndexNum" >Is the row number in tableArray from which the matching value should be returned. The first row of values in the table is row 1.</param>
  5772. /// <param name="rangeLookup" optional="true">Is a logical value: to find the closest match in the top row (sorted in ascending order) = TRUE or omitted; find an exact match = FALSE.</param>
  5773. /// <returns type="Excel.FunctionResult"></returns>
  5774. }
  5775. Functions.prototype.harMean = function(values) {
  5776. /// <summary>
  5777. /// Returns the harmonic mean of a data set of positive numbers: the reciprocal of the arithmetic mean of reciprocals. [Api set: ExcelApi 1.2]
  5778. /// </summary>
  5779. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 numbers or names, arrays, or references that contain numbers for which you want the harmonic mean.</param>
  5780. /// <returns type="Excel.FunctionResult"></returns>
  5781. }
  5782. Functions.prototype.hex2Bin = function(number, places) {
  5783. /// <summary>
  5784. /// Converts a Hexadecimal number to binary. [Api set: ExcelApi 1.2]
  5785. /// </summary>
  5786. /// <param name="number" >Is the hexadecimal number you want to convert.</param>
  5787. /// <param name="places" optional="true">Is the number of characters to use.</param>
  5788. /// <returns type="Excel.FunctionResult"></returns>
  5789. }
  5790. Functions.prototype.hex2Dec = function(number) {
  5791. /// <summary>
  5792. /// Converts a hexadecimal number to decimal. [Api set: ExcelApi 1.2]
  5793. /// </summary>
  5794. /// <param name="number" >Is the hexadecimal number you want to convert.</param>
  5795. /// <returns type="Excel.FunctionResult"></returns>
  5796. }
  5797. Functions.prototype.hex2Oct = function(number, places) {
  5798. /// <summary>
  5799. /// Converts a hexadecimal number to octal. [Api set: ExcelApi 1.2]
  5800. /// </summary>
  5801. /// <param name="number" >Is the hexadecimal number you want to convert.</param>
  5802. /// <param name="places" optional="true">Is the number of characters to use.</param>
  5803. /// <returns type="Excel.FunctionResult"></returns>
  5804. }
  5805. Functions.prototype.hour = function(serialNumber) {
  5806. /// <summary>
  5807. /// Returns the hour as a number from 0 (12:00 A.M.) to 23 (11:00 P.M.). [Api set: ExcelApi 1.2]
  5808. /// </summary>
  5809. /// <param name="serialNumber" >Is a number in the date-time code used by Microsoft Excel, or text in time format, such as 16:48:00 or 4:48:00 PM.</param>
  5810. /// <returns type="Excel.FunctionResult"></returns>
  5811. }
  5812. Functions.prototype.hypGeom_Dist = function(sampleS, numberSample, populationS, numberPop, cumulative) {
  5813. /// <summary>
  5814. /// Returns the hypergeometric distribution. [Api set: ExcelApi 1.2]
  5815. /// </summary>
  5816. /// <param name="sampleS" >Is the number of successes in the sample.</param>
  5817. /// <param name="numberSample" >Is the size of the sample.</param>
  5818. /// <param name="populationS" >Is the number of successes in the population.</param>
  5819. /// <param name="numberPop" >Is the population size.</param>
  5820. /// <param name="cumulative" >Is a logical value: for the cumulative distribution function, use TRUE; for the probability density function, use FALSE.</param>
  5821. /// <returns type="Excel.FunctionResult"></returns>
  5822. }
  5823. Functions.prototype.hyperlink = function(linkLocation, friendlyName) {
  5824. /// <summary>
  5825. /// Creates a shortcut or jump that opens a document stored on your hard drive, a network server, or on the Internet. [Api set: ExcelApi 1.2]
  5826. /// </summary>
  5827. /// <param name="linkLocation" >Is the text giving the path and file name to the document to be opened, a hard drive location, UNC address, or URL path.</param>
  5828. /// <param name="friendlyName" optional="true">Is text or a number that is displayed in the cell. If omitted, the cell displays the linkLocation text.</param>
  5829. /// <returns type="Excel.FunctionResult"></returns>
  5830. }
  5831. Functions.prototype.iso_Ceiling = function(number, significance) {
  5832. /// <summary>
  5833. /// Rounds a number up, to the nearest integer or to the nearest multiple of significance. [Api set: ExcelApi 1.2]
  5834. /// </summary>
  5835. /// <param name="number" >Is the value you want to round.</param>
  5836. /// <param name="significance" optional="true">Is the optional multiple to which you want to round.</param>
  5837. /// <returns type="Excel.FunctionResult"></returns>
  5838. }
  5839. Functions.prototype.if = function(logicalTest, valueIfTrue, valueIfFalse) {
  5840. /// <summary>
  5841. /// Checks whether a condition is met, and returns one value if TRUE, and another value if FALSE. [Api set: ExcelApi 1.2]
  5842. /// </summary>
  5843. /// <param name="logicalTest" >Is any value or expression that can be evaluated to TRUE or FALSE.</param>
  5844. /// <param name="valueIfTrue" optional="true">Is the value that is returned if logicalTest is TRUE. If omitted, TRUE is returned. You can nest up to seven IF functions.</param>
  5845. /// <param name="valueIfFalse" optional="true">Is the value that is returned if logicalTest is FALSE. If omitted, FALSE is returned.</param>
  5846. /// <returns type="Excel.FunctionResult"></returns>
  5847. }
  5848. Functions.prototype.imAbs = function(inumber) {
  5849. /// <summary>
  5850. /// Returns the absolute value (modulus) of a complex number. [Api set: ExcelApi 1.2]
  5851. /// </summary>
  5852. /// <param name="inumber" >Is a complex number for which you want the absolute value.</param>
  5853. /// <returns type="Excel.FunctionResult"></returns>
  5854. }
  5855. Functions.prototype.imArgument = function(inumber) {
  5856. /// <summary>
  5857. /// Returns the argument q, an angle expressed in radians. [Api set: ExcelApi 1.2]
  5858. /// </summary>
  5859. /// <param name="inumber" >Is a complex number for which you want the argument.</param>
  5860. /// <returns type="Excel.FunctionResult"></returns>
  5861. }
  5862. Functions.prototype.imConjugate = function(inumber) {
  5863. /// <summary>
  5864. /// Returns the complex conjugate of a complex number. [Api set: ExcelApi 1.2]
  5865. /// </summary>
  5866. /// <param name="inumber" >Is a complex number for which you want the conjugate.</param>
  5867. /// <returns type="Excel.FunctionResult"></returns>
  5868. }
  5869. Functions.prototype.imCos = function(inumber) {
  5870. /// <summary>
  5871. /// Returns the cosine of a complex number. [Api set: ExcelApi 1.2]
  5872. /// </summary>
  5873. /// <param name="inumber" >Is a complex number for which you want the cosine.</param>
  5874. /// <returns type="Excel.FunctionResult"></returns>
  5875. }
  5876. Functions.prototype.imCosh = function(inumber) {
  5877. /// <summary>
  5878. /// Returns the hyperbolic cosine of a complex number. [Api set: ExcelApi 1.2]
  5879. /// </summary>
  5880. /// <param name="inumber" >Is a complex number for which you want the hyperbolic cosine.</param>
  5881. /// <returns type="Excel.FunctionResult"></returns>
  5882. }
  5883. Functions.prototype.imCot = function(inumber) {
  5884. /// <summary>
  5885. /// Returns the cotangent of a complex number. [Api set: ExcelApi 1.2]
  5886. /// </summary>
  5887. /// <param name="inumber" >Is a complex number for which you want the cotangent.</param>
  5888. /// <returns type="Excel.FunctionResult"></returns>
  5889. }
  5890. Functions.prototype.imCsc = function(inumber) {
  5891. /// <summary>
  5892. /// Returns the cosecant of a complex number. [Api set: ExcelApi 1.2]
  5893. /// </summary>
  5894. /// <param name="inumber" >Is a complex number for which you want the cosecant.</param>
  5895. /// <returns type="Excel.FunctionResult"></returns>
  5896. }
  5897. Functions.prototype.imCsch = function(inumber) {
  5898. /// <summary>
  5899. /// Returns the hyperbolic cosecant of a complex number. [Api set: ExcelApi 1.2]
  5900. /// </summary>
  5901. /// <param name="inumber" >Is a complex number for which you want the hyperbolic cosecant.</param>
  5902. /// <returns type="Excel.FunctionResult"></returns>
  5903. }
  5904. Functions.prototype.imDiv = function(inumber1, inumber2) {
  5905. /// <summary>
  5906. /// Returns the quotient of two complex numbers. [Api set: ExcelApi 1.2]
  5907. /// </summary>
  5908. /// <param name="inumber1" >Is the complex numerator or dividend.</param>
  5909. /// <param name="inumber2" >Is the complex denominator or divisor.</param>
  5910. /// <returns type="Excel.FunctionResult"></returns>
  5911. }
  5912. Functions.prototype.imExp = function(inumber) {
  5913. /// <summary>
  5914. /// Returns the exponential of a complex number. [Api set: ExcelApi 1.2]
  5915. /// </summary>
  5916. /// <param name="inumber" >Is a complex number for which you want the exponential.</param>
  5917. /// <returns type="Excel.FunctionResult"></returns>
  5918. }
  5919. Functions.prototype.imLn = function(inumber) {
  5920. /// <summary>
  5921. /// Returns the natural logarithm of a complex number. [Api set: ExcelApi 1.2]
  5922. /// </summary>
  5923. /// <param name="inumber" >Is a complex number for which you want the natural logarithm.</param>
  5924. /// <returns type="Excel.FunctionResult"></returns>
  5925. }
  5926. Functions.prototype.imLog10 = function(inumber) {
  5927. /// <summary>
  5928. /// Returns the base-10 logarithm of a complex number. [Api set: ExcelApi 1.2]
  5929. /// </summary>
  5930. /// <param name="inumber" >Is a complex number for which you want the common logarithm.</param>
  5931. /// <returns type="Excel.FunctionResult"></returns>
  5932. }
  5933. Functions.prototype.imLog2 = function(inumber) {
  5934. /// <summary>
  5935. /// Returns the base-2 logarithm of a complex number. [Api set: ExcelApi 1.2]
  5936. /// </summary>
  5937. /// <param name="inumber" >Is a complex number for which you want the base-2 logarithm.</param>
  5938. /// <returns type="Excel.FunctionResult"></returns>
  5939. }
  5940. Functions.prototype.imPower = function(inumber, number) {
  5941. /// <summary>
  5942. /// Returns a complex number raised to an integer power. [Api set: ExcelApi 1.2]
  5943. /// </summary>
  5944. /// <param name="inumber" >Is a complex number you want to raise to a power.</param>
  5945. /// <param name="number" >Is the power to which you want to raise the complex number.</param>
  5946. /// <returns type="Excel.FunctionResult"></returns>
  5947. }
  5948. Functions.prototype.imProduct = function(values) {
  5949. /// <summary>
  5950. /// Returns the product of 1 to 255 complex numbers. [Api set: ExcelApi 1.2]
  5951. /// </summary>
  5952. /// <param name="values" type="Array" >Inumber1, Inumber2,... are from 1 to 255 complex numbers to multiply.</param>
  5953. /// <returns type="Excel.FunctionResult"></returns>
  5954. }
  5955. Functions.prototype.imReal = function(inumber) {
  5956. /// <summary>
  5957. /// Returns the real coefficient of a complex number. [Api set: ExcelApi 1.2]
  5958. /// </summary>
  5959. /// <param name="inumber" >Is a complex number for which you want the real coefficient.</param>
  5960. /// <returns type="Excel.FunctionResult"></returns>
  5961. }
  5962. Functions.prototype.imSec = function(inumber) {
  5963. /// <summary>
  5964. /// Returns the secant of a complex number. [Api set: ExcelApi 1.2]
  5965. /// </summary>
  5966. /// <param name="inumber" >Is a complex number for which you want the secant.</param>
  5967. /// <returns type="Excel.FunctionResult"></returns>
  5968. }
  5969. Functions.prototype.imSech = function(inumber) {
  5970. /// <summary>
  5971. /// Returns the hyperbolic secant of a complex number. [Api set: ExcelApi 1.2]
  5972. /// </summary>
  5973. /// <param name="inumber" >Is a complex number for which you want the hyperbolic secant.</param>
  5974. /// <returns type="Excel.FunctionResult"></returns>
  5975. }
  5976. Functions.prototype.imSin = function(inumber) {
  5977. /// <summary>
  5978. /// Returns the sine of a complex number. [Api set: ExcelApi 1.2]
  5979. /// </summary>
  5980. /// <param name="inumber" >Is a complex number for which you want the sine.</param>
  5981. /// <returns type="Excel.FunctionResult"></returns>
  5982. }
  5983. Functions.prototype.imSinh = function(inumber) {
  5984. /// <summary>
  5985. /// Returns the hyperbolic sine of a complex number. [Api set: ExcelApi 1.2]
  5986. /// </summary>
  5987. /// <param name="inumber" >Is a complex number for which you want the hyperbolic sine.</param>
  5988. /// <returns type="Excel.FunctionResult"></returns>
  5989. }
  5990. Functions.prototype.imSqrt = function(inumber) {
  5991. /// <summary>
  5992. /// Returns the square root of a complex number. [Api set: ExcelApi 1.2]
  5993. /// </summary>
  5994. /// <param name="inumber" >Is a complex number for which you want the square root.</param>
  5995. /// <returns type="Excel.FunctionResult"></returns>
  5996. }
  5997. Functions.prototype.imSub = function(inumber1, inumber2) {
  5998. /// <summary>
  5999. /// Returns the difference of two complex numbers. [Api set: ExcelApi 1.2]
  6000. /// </summary>
  6001. /// <param name="inumber1" >Is the complex number from which to subtract inumber2.</param>
  6002. /// <param name="inumber2" >Is the complex number to subtract from inumber1.</param>
  6003. /// <returns type="Excel.FunctionResult"></returns>
  6004. }
  6005. Functions.prototype.imSum = function(values) {
  6006. /// <summary>
  6007. /// Returns the sum of complex numbers. [Api set: ExcelApi 1.2]
  6008. /// </summary>
  6009. /// <param name="values" type="Array" >List of parameters, whose elements are from 1 to 255 complex numbers to add.</param>
  6010. /// <returns type="Excel.FunctionResult"></returns>
  6011. }
  6012. Functions.prototype.imTan = function(inumber) {
  6013. /// <summary>
  6014. /// Returns the tangent of a complex number. [Api set: ExcelApi 1.2]
  6015. /// </summary>
  6016. /// <param name="inumber" >Is a complex number for which you want the tangent.</param>
  6017. /// <returns type="Excel.FunctionResult"></returns>
  6018. }
  6019. Functions.prototype.imaginary = function(inumber) {
  6020. /// <summary>
  6021. /// Returns the imaginary coefficient of a complex number. [Api set: ExcelApi 1.2]
  6022. /// </summary>
  6023. /// <param name="inumber" >Is a complex number for which you want the imaginary coefficient.</param>
  6024. /// <returns type="Excel.FunctionResult"></returns>
  6025. }
  6026. Functions.prototype.int = function(number) {
  6027. /// <summary>
  6028. /// Rounds a number down to the nearest integer. [Api set: ExcelApi 1.2]
  6029. /// </summary>
  6030. /// <param name="number" >Is the real number you want to round down to an integer.</param>
  6031. /// <returns type="Excel.FunctionResult"></returns>
  6032. }
  6033. Functions.prototype.intRate = function(settlement, maturity, investment, redemption, basis) {
  6034. /// <summary>
  6035. /// Returns the interest rate for a fully invested security. [Api set: ExcelApi 1.2]
  6036. /// </summary>
  6037. /// <param name="settlement" >Is the security&apos;s settlement date, expressed as a serial date number.</param>
  6038. /// <param name="maturity" >Is the security&apos;s maturity date, expressed as a serial date number.</param>
  6039. /// <param name="investment" >Is the amount invested in the security.</param>
  6040. /// <param name="redemption" >Is the amount to be received at maturity.</param>
  6041. /// <param name="basis" optional="true">Is the type of day count basis to use.</param>
  6042. /// <returns type="Excel.FunctionResult"></returns>
  6043. }
  6044. Functions.prototype.ipmt = function(rate, per, nper, pv, fv, type) {
  6045. /// <summary>
  6046. /// Returns the interest payment for a given period for an investment, based on periodic, constant payments and a constant interest rate. [Api set: ExcelApi 1.2]
  6047. /// </summary>
  6048. /// <param name="rate" >Is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR.</param>
  6049. /// <param name="per" >Is the period for which you want to find the interest and must be in the range 1 to Nper.</param>
  6050. /// <param name="nper" >Is the total number of payment periods in an investment.</param>
  6051. /// <param name="pv" >Is the present value, or the lump-sum amount that a series of future payments is worth now.</param>
  6052. /// <param name="fv" optional="true">Is the future value, or a cash balance you want to attain after the last payment is made. If omitted, Fv = 0.</param>
  6053. /// <param name="type" optional="true">Is a logical value representing the timing of payment: at the end of the period = 0 or omitted, at the beginning of the period = 1.</param>
  6054. /// <returns type="Excel.FunctionResult"></returns>
  6055. }
  6056. Functions.prototype.irr = function(values, guess) {
  6057. /// <summary>
  6058. /// Returns the internal rate of return for a series of cash flows. [Api set: ExcelApi 1.2]
  6059. /// </summary>
  6060. /// <param name="values" >Is an array or a reference to cells that contain numbers for which you want to calculate the internal rate of return.</param>
  6061. /// <param name="guess" optional="true">Is a number that you guess is close to the result of IRR; 0.1 (10 percent) if omitted.</param>
  6062. /// <returns type="Excel.FunctionResult"></returns>
  6063. }
  6064. Functions.prototype.isErr = function(value) {
  6065. /// <summary>
  6066. /// Checks whether a value is an error (#VALUE!, #REF!, #DIV/0!, #NUM!, #NAME?, or #NULL!) excluding #N/A, and returns TRUE or FALSE. [Api set: ExcelApi 1.2]
  6067. /// </summary>
  6068. /// <param name="value" >Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value.</param>
  6069. /// <returns type="Excel.FunctionResult"></returns>
  6070. }
  6071. Functions.prototype.isError = function(value) {
  6072. /// <summary>
  6073. /// Checks whether a value is an error (#N/A, #VALUE!, #REF!, #DIV/0!, #NUM!, #NAME?, or #NULL!), and returns TRUE or FALSE. [Api set: ExcelApi 1.2]
  6074. /// </summary>
  6075. /// <param name="value" >Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value.</param>
  6076. /// <returns type="Excel.FunctionResult"></returns>
  6077. }
  6078. Functions.prototype.isEven = function(number) {
  6079. /// <summary>
  6080. /// Returns TRUE if the number is even. [Api set: ExcelApi 1.2]
  6081. /// </summary>
  6082. /// <param name="number" >Is the value to test.</param>
  6083. /// <returns type="Excel.FunctionResult"></returns>
  6084. }
  6085. Functions.prototype.isFormula = function(reference) {
  6086. /// <summary>
  6087. /// Checks whether a reference is to a cell containing a formula, and returns TRUE or FALSE. [Api set: ExcelApi 1.2]
  6088. /// </summary>
  6089. /// <param name="reference" >Is a reference to the cell you want to test. Reference can be a cell reference, a formula, or name that refers to a cell.</param>
  6090. /// <returns type="Excel.FunctionResult"></returns>
  6091. }
  6092. Functions.prototype.isLogical = function(value) {
  6093. /// <summary>
  6094. /// Checks whether a value is a logical value (TRUE or FALSE), and returns TRUE or FALSE. [Api set: ExcelApi 1.2]
  6095. /// </summary>
  6096. /// <param name="value" >Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value.</param>
  6097. /// <returns type="Excel.FunctionResult"></returns>
  6098. }
  6099. Functions.prototype.isNA = function(value) {
  6100. /// <summary>
  6101. /// Checks whether a value is #N/A, and returns TRUE or FALSE. [Api set: ExcelApi 1.2]
  6102. /// </summary>
  6103. /// <param name="value" >Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value.</param>
  6104. /// <returns type="Excel.FunctionResult"></returns>
  6105. }
  6106. Functions.prototype.isNonText = function(value) {
  6107. /// <summary>
  6108. /// Checks whether a value is not text (blank cells are not text), and returns TRUE or FALSE. [Api set: ExcelApi 1.2]
  6109. /// </summary>
  6110. /// <param name="value" >Is the value you want tested: a cell; a formula; or a name referring to a cell, formula, or value.</param>
  6111. /// <returns type="Excel.FunctionResult"></returns>
  6112. }
  6113. Functions.prototype.isNumber = function(value) {
  6114. /// <summary>
  6115. /// Checks whether a value is a number, and returns TRUE or FALSE. [Api set: ExcelApi 1.2]
  6116. /// </summary>
  6117. /// <param name="value" >Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value.</param>
  6118. /// <returns type="Excel.FunctionResult"></returns>
  6119. }
  6120. Functions.prototype.isOdd = function(number) {
  6121. /// <summary>
  6122. /// Returns TRUE if the number is odd. [Api set: ExcelApi 1.2]
  6123. /// </summary>
  6124. /// <param name="number" >Is the value to test.</param>
  6125. /// <returns type="Excel.FunctionResult"></returns>
  6126. }
  6127. Functions.prototype.isText = function(value) {
  6128. /// <summary>
  6129. /// Checks whether a value is text, and returns TRUE or FALSE. [Api set: ExcelApi 1.2]
  6130. /// </summary>
  6131. /// <param name="value" >Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value.</param>
  6132. /// <returns type="Excel.FunctionResult"></returns>
  6133. }
  6134. Functions.prototype.isoWeekNum = function(date) {
  6135. /// <summary>
  6136. /// Returns the ISO week number in the year for a given date. [Api set: ExcelApi 1.2]
  6137. /// </summary>
  6138. /// <param name="date" >Is the date-time code used by Microsoft Excel for date and time calculation.</param>
  6139. /// <returns type="Excel.FunctionResult"></returns>
  6140. }
  6141. Functions.prototype.ispmt = function(rate, per, nper, pv) {
  6142. /// <summary>
  6143. /// Returns the interest paid during a specific period of an investment. [Api set: ExcelApi 1.2]
  6144. /// </summary>
  6145. /// <param name="rate" >Interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR.</param>
  6146. /// <param name="per" >Period for which you want to find the interest.</param>
  6147. /// <param name="nper" >Number of payment periods in an investment.</param>
  6148. /// <param name="pv" >Lump sum amount that a series of future payments is right now.</param>
  6149. /// <returns type="Excel.FunctionResult"></returns>
  6150. }
  6151. Functions.prototype.isref = function(value) {
  6152. /// <summary>
  6153. /// Checks whether a value is a reference, and returns TRUE or FALSE. [Api set: ExcelApi 1.2]
  6154. /// </summary>
  6155. /// <param name="value" >Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value.</param>
  6156. /// <returns type="Excel.FunctionResult"></returns>
  6157. }
  6158. Functions.prototype.kurt = function(values) {
  6159. /// <summary>
  6160. /// Returns the kurtosis of a data set. [Api set: ExcelApi 1.2]
  6161. /// </summary>
  6162. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 numbers or names, arrays, or references that contain numbers for which you want the kurtosis.</param>
  6163. /// <returns type="Excel.FunctionResult"></returns>
  6164. }
  6165. Functions.prototype.large = function(array, k) {
  6166. /// <summary>
  6167. /// Returns the k-th largest value in a data set. For example, the fifth largest number. [Api set: ExcelApi 1.2]
  6168. /// </summary>
  6169. /// <param name="array" >Is the array or range of data for which you want to determine the k-th largest value.</param>
  6170. /// <param name="k" >Is the position (from the largest) in the array or cell range of the value to return.</param>
  6171. /// <returns type="Excel.FunctionResult"></returns>
  6172. }
  6173. Functions.prototype.lcm = function(values) {
  6174. /// <summary>
  6175. /// Returns the least common multiple. [Api set: ExcelApi 1.2]
  6176. /// </summary>
  6177. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 values for which you want the least common multiple.</param>
  6178. /// <returns type="Excel.FunctionResult"></returns>
  6179. }
  6180. Functions.prototype.left = function(text, numChars) {
  6181. /// <summary>
  6182. /// Returns the specified number of characters from the start of a text string. [Api set: ExcelApi 1.2]
  6183. /// </summary>
  6184. /// <param name="text" >Is the text string containing the characters you want to extract.</param>
  6185. /// <param name="numChars" optional="true">Specifies how many characters you want LEFT to extract; 1 if omitted.</param>
  6186. /// <returns type="Excel.FunctionResult"></returns>
  6187. }
  6188. Functions.prototype.leftb = function(text, numBytes) {
  6189. /// <summary>
  6190. /// Returns the specified number of characters from the start of a text string. Use with double-byte character sets (DBCS). [Api set: ExcelApi 1.2]
  6191. /// </summary>
  6192. /// <param name="text" >Is the text string containing the characters you want to extract.</param>
  6193. /// <param name="numBytes" optional="true">Specifies how many characters you want LEFT to return.</param>
  6194. /// <returns type="Excel.FunctionResult"></returns>
  6195. }
  6196. Functions.prototype.len = function(text) {
  6197. /// <summary>
  6198. /// Returns the number of characters in a text string. [Api set: ExcelApi 1.2]
  6199. /// </summary>
  6200. /// <param name="text" >Is the text whose length you want to find. Spaces count as characters.</param>
  6201. /// <returns type="Excel.FunctionResult"></returns>
  6202. }
  6203. Functions.prototype.lenb = function(text) {
  6204. /// <summary>
  6205. /// Returns the number of characters in a text string. Use with double-byte character sets (DBCS). [Api set: ExcelApi 1.2]
  6206. /// </summary>
  6207. /// <param name="text" >Is the text whose length you want to find.</param>
  6208. /// <returns type="Excel.FunctionResult"></returns>
  6209. }
  6210. Functions.prototype.ln = function(number) {
  6211. /// <summary>
  6212. /// Returns the natural logarithm of a number. [Api set: ExcelApi 1.2]
  6213. /// </summary>
  6214. /// <param name="number" >Is the positive real number for which you want the natural logarithm.</param>
  6215. /// <returns type="Excel.FunctionResult"></returns>
  6216. }
  6217. Functions.prototype.log = function(number, base) {
  6218. /// <summary>
  6219. /// Returns the logarithm of a number to the base you specify. [Api set: ExcelApi 1.2]
  6220. /// </summary>
  6221. /// <param name="number" >Is the positive real number for which you want the logarithm.</param>
  6222. /// <param name="base" optional="true">Is the base of the logarithm; 10 if omitted.</param>
  6223. /// <returns type="Excel.FunctionResult"></returns>
  6224. }
  6225. Functions.prototype.log10 = function(number) {
  6226. /// <summary>
  6227. /// Returns the base-10 logarithm of a number. [Api set: ExcelApi 1.2]
  6228. /// </summary>
  6229. /// <param name="number" >Is the positive real number for which you want the base-10 logarithm.</param>
  6230. /// <returns type="Excel.FunctionResult"></returns>
  6231. }
  6232. Functions.prototype.logNorm_Dist = function(x, mean, standardDev, cumulative) {
  6233. /// <summary>
  6234. /// Returns the lognormal distribution of x, where ln(x) is normally distributed with parameters Mean and Standard_dev. [Api set: ExcelApi 1.2]
  6235. /// </summary>
  6236. /// <param name="x" >Is the value at which to evaluate the function, a positive number.</param>
  6237. /// <param name="mean" >Is the mean of ln(x).</param>
  6238. /// <param name="standardDev" >Is the standard deviation of ln(x), a positive number.</param>
  6239. /// <param name="cumulative" >Is a logical value: for the cumulative distribution function, use TRUE; for the probability density function, use FALSE.</param>
  6240. /// <returns type="Excel.FunctionResult"></returns>
  6241. }
  6242. Functions.prototype.logNorm_Inv = function(probability, mean, standardDev) {
  6243. /// <summary>
  6244. /// Returns the inverse of the lognormal cumulative distribution function of x, where ln(x) is normally distributed with parameters Mean and Standard_dev. [Api set: ExcelApi 1.2]
  6245. /// </summary>
  6246. /// <param name="probability" >Is a probability associated with the lognormal distribution, a number between 0 and 1, inclusive.</param>
  6247. /// <param name="mean" >Is the mean of ln(x).</param>
  6248. /// <param name="standardDev" >Is the standard deviation of ln(x), a positive number.</param>
  6249. /// <returns type="Excel.FunctionResult"></returns>
  6250. }
  6251. Functions.prototype.lookup = function(lookupValue, lookupVector, resultVector) {
  6252. /// <summary>
  6253. /// Looks up a value either from a one-row or one-column range or from an array. Provided for backward compatibility. [Api set: ExcelApi 1.2]
  6254. /// </summary>
  6255. /// <param name="lookupValue" >Is a value that LOOKUP searches for in lookupVector and can be a number, text, a logical value, or a name or reference to a value.</param>
  6256. /// <param name="lookupVector" >Is a range that contains only one row or one column of text, numbers, or logical values, placed in ascending order.</param>
  6257. /// <param name="resultVector" optional="true">Is a range that contains only one row or column, the same size as lookupVector.</param>
  6258. /// <returns type="Excel.FunctionResult"></returns>
  6259. }
  6260. Functions.prototype.lower = function(text) {
  6261. /// <summary>
  6262. /// Converts all letters in a text string to lowercase. [Api set: ExcelApi 1.2]
  6263. /// </summary>
  6264. /// <param name="text" >Is the text you want to convert to lowercase. Characters in Text that are not letters are not changed.</param>
  6265. /// <returns type="Excel.FunctionResult"></returns>
  6266. }
  6267. Functions.prototype.mduration = function(settlement, maturity, coupon, yld, frequency, basis) {
  6268. /// <summary>
  6269. /// Returns the Macauley modified duration for a security with an assumed par value of $100. [Api set: ExcelApi 1.2]
  6270. /// </summary>
  6271. /// <param name="settlement" >Is the security&apos;s settlement date, expressed as a serial date number.</param>
  6272. /// <param name="maturity" >Is the security&apos;s maturity date, expressed as a serial date number.</param>
  6273. /// <param name="coupon" >Is the security&apos;s annual coupon rate.</param>
  6274. /// <param name="yld" >Is the security&apos;s annual yield.</param>
  6275. /// <param name="frequency" >Is the number of coupon payments per year.</param>
  6276. /// <param name="basis" optional="true">Is the type of day count basis to use.</param>
  6277. /// <returns type="Excel.FunctionResult"></returns>
  6278. }
  6279. Functions.prototype.mirr = function(values, financeRate, reinvestRate) {
  6280. /// <summary>
  6281. /// Returns the internal rate of return for a series of periodic cash flows, considering both cost of investment and interest on reinvestment of cash. [Api set: ExcelApi 1.2]
  6282. /// </summary>
  6283. /// <param name="values" >Is an array or a reference to cells that contain numbers that represent a series of payments (negative) and income (positive) at regular periods.</param>
  6284. /// <param name="financeRate" >Is the interest rate you pay on the money used in the cash flows.</param>
  6285. /// <param name="reinvestRate" >Is the interest rate you receive on the cash flows as you reinvest them.</param>
  6286. /// <returns type="Excel.FunctionResult"></returns>
  6287. }
  6288. Functions.prototype.mround = function(number, multiple) {
  6289. /// <summary>
  6290. /// Returns a number rounded to the desired multiple. [Api set: ExcelApi 1.2]
  6291. /// </summary>
  6292. /// <param name="number" >Is the value to round.</param>
  6293. /// <param name="multiple" >Is the multiple to which you want to round number.</param>
  6294. /// <returns type="Excel.FunctionResult"></returns>
  6295. }
  6296. Functions.prototype.match = function(lookupValue, lookupArray, matchType) {
  6297. /// <summary>
  6298. /// Returns the relative position of an item in an array that matches a specified value in a specified order. [Api set: ExcelApi 1.2]
  6299. /// </summary>
  6300. /// <param name="lookupValue" >Is the value you use to find the value you want in the array, a number, text, or logical value, or a reference to one of these.</param>
  6301. /// <param name="lookupArray" >Is a contiguous range of cells containing possible lookup values, an array of values, or a reference to an array.</param>
  6302. /// <param name="matchType" optional="true">Is a number 1, 0, or -1 indicating which value to return.</param>
  6303. /// <returns type="Excel.FunctionResult"></returns>
  6304. }
  6305. Functions.prototype.max = function(values) {
  6306. /// <summary>
  6307. /// Returns the largest value in a set of values. Ignores logical values and text. [Api set: ExcelApi 1.2]
  6308. /// </summary>
  6309. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 numbers, empty cells, logical values, or text numbers for which you want the maximum.</param>
  6310. /// <returns type="Excel.FunctionResult"></returns>
  6311. }
  6312. Functions.prototype.maxA = function(values) {
  6313. /// <summary>
  6314. /// Returns the largest value in a set of values. Does not ignore logical values and text. [Api set: ExcelApi 1.2]
  6315. /// </summary>
  6316. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 numbers, empty cells, logical values, or text numbers for which you want the maximum.</param>
  6317. /// <returns type="Excel.FunctionResult"></returns>
  6318. }
  6319. Functions.prototype.median = function(values) {
  6320. /// <summary>
  6321. /// Returns the median, or the number in the middle of the set of given numbers. [Api set: ExcelApi 1.2]
  6322. /// </summary>
  6323. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 numbers or names, arrays, or references that contain numbers for which you want the median.</param>
  6324. /// <returns type="Excel.FunctionResult"></returns>
  6325. }
  6326. Functions.prototype.mid = function(text, startNum, numChars) {
  6327. /// <summary>
  6328. /// Returns the characters from the middle of a text string, given a starting position and length. [Api set: ExcelApi 1.2]
  6329. /// </summary>
  6330. /// <param name="text" >Is the text string from which you want to extract the characters.</param>
  6331. /// <param name="startNum" >Is the position of the first character you want to extract. The first character in Text is 1.</param>
  6332. /// <param name="numChars" >Specifies how many characters to return from Text.</param>
  6333. /// <returns type="Excel.FunctionResult"></returns>
  6334. }
  6335. Functions.prototype.midb = function(text, startNum, numBytes) {
  6336. /// <summary>
  6337. /// Returns characters from the middle of a text string, given a starting position and length. Use with double-byte character sets (DBCS). [Api set: ExcelApi 1.2]
  6338. /// </summary>
  6339. /// <param name="text" >Is the text string containing the characters you want to extract.</param>
  6340. /// <param name="startNum" >Is the position of the first character you want to extract in text.</param>
  6341. /// <param name="numBytes" >Specifies how many characters to return from text.</param>
  6342. /// <returns type="Excel.FunctionResult"></returns>
  6343. }
  6344. Functions.prototype.min = function(values) {
  6345. /// <summary>
  6346. /// Returns the smallest number in a set of values. Ignores logical values and text. [Api set: ExcelApi 1.2]
  6347. /// </summary>
  6348. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 numbers, empty cells, logical values, or text numbers for which you want the minimum.</param>
  6349. /// <returns type="Excel.FunctionResult"></returns>
  6350. }
  6351. Functions.prototype.minA = function(values) {
  6352. /// <summary>
  6353. /// Returns the smallest value in a set of values. Does not ignore logical values and text. [Api set: ExcelApi 1.2]
  6354. /// </summary>
  6355. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 numbers, empty cells, logical values, or text numbers for which you want the minimum.</param>
  6356. /// <returns type="Excel.FunctionResult"></returns>
  6357. }
  6358. Functions.prototype.minute = function(serialNumber) {
  6359. /// <summary>
  6360. /// Returns the minute, a number from 0 to 59. [Api set: ExcelApi 1.2]
  6361. /// </summary>
  6362. /// <param name="serialNumber" >Is a number in the date-time code used by Microsoft Excel or text in time format, such as 16:48:00 or 4:48:00 PM.</param>
  6363. /// <returns type="Excel.FunctionResult"></returns>
  6364. }
  6365. Functions.prototype.mod = function(number, divisor) {
  6366. /// <summary>
  6367. /// Returns the remainder after a number is divided by a divisor. [Api set: ExcelApi 1.2]
  6368. /// </summary>
  6369. /// <param name="number" >Is the number for which you want to find the remainder after the division is performed.</param>
  6370. /// <param name="divisor" >Is the number by which you want to divide Number.</param>
  6371. /// <returns type="Excel.FunctionResult"></returns>
  6372. }
  6373. Functions.prototype.month = function(serialNumber) {
  6374. /// <summary>
  6375. /// Returns the month, a number from 1 (January) to 12 (December). [Api set: ExcelApi 1.2]
  6376. /// </summary>
  6377. /// <param name="serialNumber" >Is a number in the date-time code used by Microsoft Excel.</param>
  6378. /// <returns type="Excel.FunctionResult"></returns>
  6379. }
  6380. Functions.prototype.multiNomial = function(values) {
  6381. /// <summary>
  6382. /// Returns the multinomial of a set of numbers. [Api set: ExcelApi 1.2]
  6383. /// </summary>
  6384. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 values for which you want the multinomial.</param>
  6385. /// <returns type="Excel.FunctionResult"></returns>
  6386. }
  6387. Functions.prototype.n = function(value) {
  6388. /// <summary>
  6389. /// Converts non-number value to a number, dates to serial numbers, TRUE to 1, anything else to 0 (zero). [Api set: ExcelApi 1.2]
  6390. /// </summary>
  6391. /// <param name="value" >Is the value you want converted.</param>
  6392. /// <returns type="Excel.FunctionResult"></returns>
  6393. }
  6394. Functions.prototype.nper = function(rate, pmt, pv, fv, type) {
  6395. /// <summary>
  6396. /// Returns the number of periods for an investment based on periodic, constant payments and a constant interest rate. [Api set: ExcelApi 1.2]
  6397. /// </summary>
  6398. /// <param name="rate" >Is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR.</param>
  6399. /// <param name="pmt" >Is the payment made each period; it cannot change over the life of the investment.</param>
  6400. /// <param name="pv" >Is the present value, or the lump-sum amount that a series of future payments is worth now.</param>
  6401. /// <param name="fv" optional="true">Is the future value, or a cash balance you want to attain after the last payment is made. If omitted, zero is used.</param>
  6402. /// <param name="type" optional="true">Is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted.</param>
  6403. /// <returns type="Excel.FunctionResult"></returns>
  6404. }
  6405. Functions.prototype.na = function() {
  6406. /// <summary>
  6407. /// Returns the error value #N/A (value not available). [Api set: ExcelApi 1.2]
  6408. /// </summary>
  6409. /// <returns type="Excel.FunctionResult"></returns>
  6410. }
  6411. Functions.prototype.negBinom_Dist = function(numberF, numberS, probabilityS, cumulative) {
  6412. /// <summary>
  6413. /// Returns the negative binomial distribution, the probability that there will be Number_f failures before the Number_s-th success, with Probability_s probability of a success. [Api set: ExcelApi 1.2]
  6414. /// </summary>
  6415. /// <param name="numberF" >Is the number of failures.</param>
  6416. /// <param name="numberS" >Is the threshold number of successes.</param>
  6417. /// <param name="probabilityS" >Is the probability of a success; a number between 0 and 1.</param>
  6418. /// <param name="cumulative" >Is a logical value: for the cumulative distribution function, use TRUE; for the probability mass function, use FALSE.</param>
  6419. /// <returns type="Excel.FunctionResult"></returns>
  6420. }
  6421. Functions.prototype.networkDays = function(startDate, endDate, holidays) {
  6422. /// <summary>
  6423. /// Returns the number of whole workdays between two dates. [Api set: ExcelApi 1.2]
  6424. /// </summary>
  6425. /// <param name="startDate" >Is a serial date number that represents the start date.</param>
  6426. /// <param name="endDate" >Is a serial date number that represents the end date.</param>
  6427. /// <param name="holidays" optional="true">Is an optional set of one or more serial date numbers to exclude from the working calendar, such as state and federal holidays and floating holidays.</param>
  6428. /// <returns type="Excel.FunctionResult"></returns>
  6429. }
  6430. Functions.prototype.networkDays_Intl = function(startDate, endDate, weekend, holidays) {
  6431. /// <summary>
  6432. /// Returns the number of whole workdays between two dates with custom weekend parameters. [Api set: ExcelApi 1.2]
  6433. /// </summary>
  6434. /// <param name="startDate" >Is a serial date number that represents the start date.</param>
  6435. /// <param name="endDate" >Is a serial date number that represents the end date.</param>
  6436. /// <param name="weekend" optional="true">Is a number or string specifying when weekends occur.</param>
  6437. /// <param name="holidays" optional="true">Is an optional set of one or more serial date numbers to exclude from the working calendar, such as state and federal holidays and floating holidays.</param>
  6438. /// <returns type="Excel.FunctionResult"></returns>
  6439. }
  6440. Functions.prototype.nominal = function(effectRate, npery) {
  6441. /// <summary>
  6442. /// Returns the annual nominal interest rate. [Api set: ExcelApi 1.2]
  6443. /// </summary>
  6444. /// <param name="effectRate" >Is the effective interest rate.</param>
  6445. /// <param name="npery" >Is the number of compounding periods per year.</param>
  6446. /// <returns type="Excel.FunctionResult"></returns>
  6447. }
  6448. Functions.prototype.norm_Dist = function(x, mean, standardDev, cumulative) {
  6449. /// <summary>
  6450. /// Returns the normal distribution for the specified mean and standard deviation. [Api set: ExcelApi 1.2]
  6451. /// </summary>
  6452. /// <param name="x" >Is the value for which you want the distribution.</param>
  6453. /// <param name="mean" >Is the arithmetic mean of the distribution.</param>
  6454. /// <param name="standardDev" >Is the standard deviation of the distribution, a positive number.</param>
  6455. /// <param name="cumulative" >Is a logical value: for the cumulative distribution function, use TRUE; for the probability density function, use FALSE.</param>
  6456. /// <returns type="Excel.FunctionResult"></returns>
  6457. }
  6458. Functions.prototype.norm_Inv = function(probability, mean, standardDev) {
  6459. /// <summary>
  6460. /// Returns the inverse of the normal cumulative distribution for the specified mean and standard deviation. [Api set: ExcelApi 1.2]
  6461. /// </summary>
  6462. /// <param name="probability" >Is a probability corresponding to the normal distribution, a number between 0 and 1 inclusive.</param>
  6463. /// <param name="mean" >Is the arithmetic mean of the distribution.</param>
  6464. /// <param name="standardDev" >Is the standard deviation of the distribution, a positive number.</param>
  6465. /// <returns type="Excel.FunctionResult"></returns>
  6466. }
  6467. Functions.prototype.norm_S_Dist = function(z, cumulative) {
  6468. /// <summary>
  6469. /// Returns the standard normal distribution (has a mean of zero and a standard deviation of one). [Api set: ExcelApi 1.2]
  6470. /// </summary>
  6471. /// <param name="z" >Is the value for which you want the distribution.</param>
  6472. /// <param name="cumulative" >Is a logical value for the function to return: the cumulative distribution function = TRUE; the probability density function = FALSE.</param>
  6473. /// <returns type="Excel.FunctionResult"></returns>
  6474. }
  6475. Functions.prototype.norm_S_Inv = function(probability) {
  6476. /// <summary>
  6477. /// Returns the inverse of the standard normal cumulative distribution (has a mean of zero and a standard deviation of one). [Api set: ExcelApi 1.2]
  6478. /// </summary>
  6479. /// <param name="probability" >Is a probability corresponding to the normal distribution, a number between 0 and 1 inclusive.</param>
  6480. /// <returns type="Excel.FunctionResult"></returns>
  6481. }
  6482. Functions.prototype.not = function(logical) {
  6483. /// <summary>
  6484. /// Changes FALSE to TRUE, or TRUE to FALSE. [Api set: ExcelApi 1.2]
  6485. /// </summary>
  6486. /// <param name="logical" >Is a value or expression that can be evaluated to TRUE or FALSE.</param>
  6487. /// <returns type="Excel.FunctionResult"></returns>
  6488. }
  6489. Functions.prototype.now = function() {
  6490. /// <summary>
  6491. /// Returns the current date and time formatted as a date and time. [Api set: ExcelApi 1.2]
  6492. /// </summary>
  6493. /// <returns type="Excel.FunctionResult"></returns>
  6494. }
  6495. Functions.prototype.npv = function(rate, values) {
  6496. /// <summary>
  6497. /// Returns the net present value of an investment based on a discount rate and a series of future payments (negative values) and income (positive values). [Api set: ExcelApi 1.2]
  6498. /// </summary>
  6499. /// <param name="rate" >Is the rate of discount over the length of one period.</param>
  6500. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 254 payments and income, equally spaced in time and occurring at the end of each period.</param>
  6501. /// <returns type="Excel.FunctionResult"></returns>
  6502. }
  6503. Functions.prototype.numberValue = function(text, decimalSeparator, groupSeparator) {
  6504. /// <summary>
  6505. /// Converts text to number in a locale-independent manner. [Api set: ExcelApi 1.2]
  6506. /// </summary>
  6507. /// <param name="text" >Is the string representing the number you want to convert.</param>
  6508. /// <param name="decimalSeparator" optional="true">Is the character used as the decimal separator in the string.</param>
  6509. /// <param name="groupSeparator" optional="true">Is the character used as the group separator in the string.</param>
  6510. /// <returns type="Excel.FunctionResult"></returns>
  6511. }
  6512. Functions.prototype.oct2Bin = function(number, places) {
  6513. /// <summary>
  6514. /// Converts an octal number to binary. [Api set: ExcelApi 1.2]
  6515. /// </summary>
  6516. /// <param name="number" >Is the octal number you want to convert.</param>
  6517. /// <param name="places" optional="true">Is the number of characters to use.</param>
  6518. /// <returns type="Excel.FunctionResult"></returns>
  6519. }
  6520. Functions.prototype.oct2Dec = function(number) {
  6521. /// <summary>
  6522. /// Converts an octal number to decimal. [Api set: ExcelApi 1.2]
  6523. /// </summary>
  6524. /// <param name="number" >Is the octal number you want to convert.</param>
  6525. /// <returns type="Excel.FunctionResult"></returns>
  6526. }
  6527. Functions.prototype.oct2Hex = function(number, places) {
  6528. /// <summary>
  6529. /// Converts an octal number to hexadecimal. [Api set: ExcelApi 1.2]
  6530. /// </summary>
  6531. /// <param name="number" >Is the octal number you want to convert.</param>
  6532. /// <param name="places" optional="true">Is the number of characters to use.</param>
  6533. /// <returns type="Excel.FunctionResult"></returns>
  6534. }
  6535. Functions.prototype.odd = function(number) {
  6536. /// <summary>
  6537. /// Rounds a positive number up and negative number down to the nearest odd integer. [Api set: ExcelApi 1.2]
  6538. /// </summary>
  6539. /// <param name="number" >Is the value to round.</param>
  6540. /// <returns type="Excel.FunctionResult"></returns>
  6541. }
  6542. Functions.prototype.oddFPrice = function(settlement, maturity, issue, firstCoupon, rate, yld, redemption, frequency, basis) {
  6543. /// <summary>
  6544. /// Returns the price per $100 face value of a security with an odd first period. [Api set: ExcelApi 1.2]
  6545. /// </summary>
  6546. /// <param name="settlement" >Is the security&apos;s settlement date, expressed as a serial date number.</param>
  6547. /// <param name="maturity" >Is the security&apos;s maturity date, expressed as a serial date number.</param>
  6548. /// <param name="issue" >Is the security&apos;s issue date, expressed as a serial date number.</param>
  6549. /// <param name="firstCoupon" >Is the security&apos;s first coupon date, expressed as a serial date number.</param>
  6550. /// <param name="rate" >Is the security&apos;s interest rate.</param>
  6551. /// <param name="yld" >Is the security&apos;s annual yield.</param>
  6552. /// <param name="redemption" >Is the security&apos;s redemption value per $100 face value.</param>
  6553. /// <param name="frequency" >Is the number of coupon payments per year.</param>
  6554. /// <param name="basis" optional="true">Is the type of day count basis to use.</param>
  6555. /// <returns type="Excel.FunctionResult"></returns>
  6556. }
  6557. Functions.prototype.oddFYield = function(settlement, maturity, issue, firstCoupon, rate, pr, redemption, frequency, basis) {
  6558. /// <summary>
  6559. /// Returns the yield of a security with an odd first period. [Api set: ExcelApi 1.2]
  6560. /// </summary>
  6561. /// <param name="settlement" >Is the security&apos;s settlement date, expressed as a serial date number.</param>
  6562. /// <param name="maturity" >Is the security&apos;s maturity date, expressed as a serial date number.</param>
  6563. /// <param name="issue" >Is the security&apos;s issue date, expressed as a serial date number.</param>
  6564. /// <param name="firstCoupon" >Is the security&apos;s first coupon date, expressed as a serial date number.</param>
  6565. /// <param name="rate" >Is the security&apos;s interest rate.</param>
  6566. /// <param name="pr" >Is the security&apos;s price.</param>
  6567. /// <param name="redemption" >Is the security&apos;s redemption value per $100 face value.</param>
  6568. /// <param name="frequency" >Is the number of coupon payments per year.</param>
  6569. /// <param name="basis" optional="true">Is the type of day count basis to use.</param>
  6570. /// <returns type="Excel.FunctionResult"></returns>
  6571. }
  6572. Functions.prototype.oddLPrice = function(settlement, maturity, lastInterest, rate, yld, redemption, frequency, basis) {
  6573. /// <summary>
  6574. /// Returns the price per $100 face value of a security with an odd last period. [Api set: ExcelApi 1.2]
  6575. /// </summary>
  6576. /// <param name="settlement" >Is the security&apos;s settlement date, expressed as a serial date number.</param>
  6577. /// <param name="maturity" >Is the security&apos;s maturity date, expressed as a serial date number.</param>
  6578. /// <param name="lastInterest" >Is the security&apos;s last coupon date, expressed as a serial date number.</param>
  6579. /// <param name="rate" >Is the security&apos;s interest rate.</param>
  6580. /// <param name="yld" >Is the security&apos;s annual yield.</param>
  6581. /// <param name="redemption" >Is the security&apos;s redemption value per $100 face value.</param>
  6582. /// <param name="frequency" >Is the number of coupon payments per year.</param>
  6583. /// <param name="basis" optional="true">Is the type of day count basis to use.</param>
  6584. /// <returns type="Excel.FunctionResult"></returns>
  6585. }
  6586. Functions.prototype.oddLYield = function(settlement, maturity, lastInterest, rate, pr, redemption, frequency, basis) {
  6587. /// <summary>
  6588. /// Returns the yield of a security with an odd last period. [Api set: ExcelApi 1.2]
  6589. /// </summary>
  6590. /// <param name="settlement" >Is the security&apos;s settlement date, expressed as a serial date number.</param>
  6591. /// <param name="maturity" >Is the security&apos;s maturity date, expressed as a serial date number.</param>
  6592. /// <param name="lastInterest" >Is the security&apos;s last coupon date, expressed as a serial date number.</param>
  6593. /// <param name="rate" >Is the security&apos;s interest rate.</param>
  6594. /// <param name="pr" >Is the security&apos;s price.</param>
  6595. /// <param name="redemption" >Is the security&apos;s redemption value per $100 face value.</param>
  6596. /// <param name="frequency" >Is the number of coupon payments per year.</param>
  6597. /// <param name="basis" optional="true">Is the type of day count basis to use.</param>
  6598. /// <returns type="Excel.FunctionResult"></returns>
  6599. }
  6600. Functions.prototype.or = function(values) {
  6601. /// <summary>
  6602. /// Checks whether any of the arguments are TRUE, and returns TRUE or FALSE. Returns FALSE only if all arguments are FALSE. [Api set: ExcelApi 1.2]
  6603. /// </summary>
  6604. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 conditions that you want to test that can be either TRUE or FALSE.</param>
  6605. /// <returns type="Excel.FunctionResult"></returns>
  6606. }
  6607. Functions.prototype.pduration = function(rate, pv, fv) {
  6608. /// <summary>
  6609. /// Returns the number of periods required by an investment to reach a specified value. [Api set: ExcelApi 1.2]
  6610. /// </summary>
  6611. /// <param name="rate" >Is the interest rate per period.</param>
  6612. /// <param name="pv" >Is the present value of the investment.</param>
  6613. /// <param name="fv" >Is the desired future value of the investment.</param>
  6614. /// <returns type="Excel.FunctionResult"></returns>
  6615. }
  6616. Functions.prototype.percentRank_Exc = function(array, x, significance) {
  6617. /// <summary>
  6618. /// Returns the rank of a value in a data set as a percentage of the data set as a percentage (0..1, exclusive) of the data set. [Api set: ExcelApi 1.2]
  6619. /// </summary>
  6620. /// <param name="array" >Is the array or range of data with numeric values that defines relative standing.</param>
  6621. /// <param name="x" >Is the value for which you want to know the rank.</param>
  6622. /// <param name="significance" optional="true">Is an optional value that identifies the number of significant digits for the returned percentage, three digits if omitted (0.xxx%).</param>
  6623. /// <returns type="Excel.FunctionResult"></returns>
  6624. }
  6625. Functions.prototype.percentRank_Inc = function(array, x, significance) {
  6626. /// <summary>
  6627. /// Returns the rank of a value in a data set as a percentage of the data set as a percentage (0..1, inclusive) of the data set. [Api set: ExcelApi 1.2]
  6628. /// </summary>
  6629. /// <param name="array" >Is the array or range of data with numeric values that defines relative standing.</param>
  6630. /// <param name="x" >Is the value for which you want to know the rank.</param>
  6631. /// <param name="significance" optional="true">Is an optional value that identifies the number of significant digits for the returned percentage, three digits if omitted (0.xxx%).</param>
  6632. /// <returns type="Excel.FunctionResult"></returns>
  6633. }
  6634. Functions.prototype.percentile_Exc = function(array, k) {
  6635. /// <summary>
  6636. /// Returns the k-th percentile of values in a range, where k is in the range 0..1, exclusive. [Api set: ExcelApi 1.2]
  6637. /// </summary>
  6638. /// <param name="array" >Is the array or range of data that defines relative standing.</param>
  6639. /// <param name="k" >Is the percentile value that is between 0 through 1, inclusive.</param>
  6640. /// <returns type="Excel.FunctionResult"></returns>
  6641. }
  6642. Functions.prototype.percentile_Inc = function(array, k) {
  6643. /// <summary>
  6644. /// Returns the k-th percentile of values in a range, where k is in the range 0..1, inclusive. [Api set: ExcelApi 1.2]
  6645. /// </summary>
  6646. /// <param name="array" >Is the array or range of data that defines relative standing.</param>
  6647. /// <param name="k" >Is the percentile value that is between 0 through 1, inclusive.</param>
  6648. /// <returns type="Excel.FunctionResult"></returns>
  6649. }
  6650. Functions.prototype.permut = function(number, numberChosen) {
  6651. /// <summary>
  6652. /// Returns the number of permutations for a given number of objects that can be selected from the total objects. [Api set: ExcelApi 1.2]
  6653. /// </summary>
  6654. /// <param name="number" >Is the total number of objects.</param>
  6655. /// <param name="numberChosen" >Is the number of objects in each permutation.</param>
  6656. /// <returns type="Excel.FunctionResult"></returns>
  6657. }
  6658. Functions.prototype.permutationa = function(number, numberChosen) {
  6659. /// <summary>
  6660. /// Returns the number of permutations for a given number of objects (with repetitions) that can be selected from the total objects. [Api set: ExcelApi 1.2]
  6661. /// </summary>
  6662. /// <param name="number" >Is the total number of objects.</param>
  6663. /// <param name="numberChosen" >Is the number of objects in each permutation.</param>
  6664. /// <returns type="Excel.FunctionResult"></returns>
  6665. }
  6666. Functions.prototype.phi = function(x) {
  6667. /// <summary>
  6668. /// Returns the value of the density function for a standard normal distribution. [Api set: ExcelApi 1.2]
  6669. /// </summary>
  6670. /// <param name="x" >Is the number for which you want the density of the standard normal distribution.</param>
  6671. /// <returns type="Excel.FunctionResult"></returns>
  6672. }
  6673. Functions.prototype.pi = function() {
  6674. /// <summary>
  6675. /// Returns the value of Pi, 3.14159265358979, accurate to 15 digits. [Api set: ExcelApi 1.2]
  6676. /// </summary>
  6677. /// <returns type="Excel.FunctionResult"></returns>
  6678. }
  6679. Functions.prototype.pmt = function(rate, nper, pv, fv, type) {
  6680. /// <summary>
  6681. /// Calculates the payment for a loan based on constant payments and a constant interest rate. [Api set: ExcelApi 1.2]
  6682. /// </summary>
  6683. /// <param name="rate" >Is the interest rate per period for the loan. For example, use 6%/4 for quarterly payments at 6% APR.</param>
  6684. /// <param name="nper" >Is the total number of payments for the loan.</param>
  6685. /// <param name="pv" >Is the present value: the total amount that a series of future payments is worth now.</param>
  6686. /// <param name="fv" optional="true">Is the future value, or a cash balance you want to attain after the last payment is made, 0 (zero) if omitted.</param>
  6687. /// <param name="type" optional="true">Is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted.</param>
  6688. /// <returns type="Excel.FunctionResult"></returns>
  6689. }
  6690. Functions.prototype.poisson_Dist = function(x, mean, cumulative) {
  6691. /// <summary>
  6692. /// Returns the Poisson distribution. [Api set: ExcelApi 1.2]
  6693. /// </summary>
  6694. /// <param name="x" >Is the number of events.</param>
  6695. /// <param name="mean" >Is the expected numeric value, a positive number.</param>
  6696. /// <param name="cumulative" >Is a logical value: for the cumulative Poisson probability, use TRUE; for the Poisson probability mass function, use FALSE.</param>
  6697. /// <returns type="Excel.FunctionResult"></returns>
  6698. }
  6699. Functions.prototype.power = function(number, power) {
  6700. /// <summary>
  6701. /// Returns the result of a number raised to a power. [Api set: ExcelApi 1.2]
  6702. /// </summary>
  6703. /// <param name="number" >Is the base number, any real number.</param>
  6704. /// <param name="power" >Is the exponent, to which the base number is raised.</param>
  6705. /// <returns type="Excel.FunctionResult"></returns>
  6706. }
  6707. Functions.prototype.ppmt = function(rate, per, nper, pv, fv, type) {
  6708. /// <summary>
  6709. /// Returns the payment on the principal for a given investment based on periodic, constant payments and a constant interest rate. [Api set: ExcelApi 1.2]
  6710. /// </summary>
  6711. /// <param name="rate" >Is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR.</param>
  6712. /// <param name="per" >Specifies the period and must be in the range 1 to nper.</param>
  6713. /// <param name="nper" >Is the total number of payment periods in an investment.</param>
  6714. /// <param name="pv" >Is the present value: the total amount that a series of future payments is worth now.</param>
  6715. /// <param name="fv" optional="true">Is the future value, or cash balance you want to attain after the last payment is made.</param>
  6716. /// <param name="type" optional="true">Is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted.</param>
  6717. /// <returns type="Excel.FunctionResult"></returns>
  6718. }
  6719. Functions.prototype.price = function(settlement, maturity, rate, yld, redemption, frequency, basis) {
  6720. /// <summary>
  6721. /// Returns the price per $100 face value of a security that pays periodic interest. [Api set: ExcelApi 1.2]
  6722. /// </summary>
  6723. /// <param name="settlement" >Is the security&apos;s settlement date, expressed as a serial date number.</param>
  6724. /// <param name="maturity" >Is the security&apos;s maturity date, expressed as a serial date number.</param>
  6725. /// <param name="rate" >Is the security&apos;s annual coupon rate.</param>
  6726. /// <param name="yld" >Is the security&apos;s annual yield.</param>
  6727. /// <param name="redemption" >Is the security&apos;s redemption value per $100 face value.</param>
  6728. /// <param name="frequency" >Is the number of coupon payments per year.</param>
  6729. /// <param name="basis" optional="true">Is the type of day count basis to use.</param>
  6730. /// <returns type="Excel.FunctionResult"></returns>
  6731. }
  6732. Functions.prototype.priceDisc = function(settlement, maturity, discount, redemption, basis) {
  6733. /// <summary>
  6734. /// Returns the price per $100 face value of a discounted security. [Api set: ExcelApi 1.2]
  6735. /// </summary>
  6736. /// <param name="settlement" >Is the security&apos;s settlement date, expressed as a serial date number.</param>
  6737. /// <param name="maturity" >Is the security&apos;s maturity date, expressed as a serial date number.</param>
  6738. /// <param name="discount" >Is the security&apos;s discount rate.</param>
  6739. /// <param name="redemption" >Is the security&apos;s redemption value per $100 face value.</param>
  6740. /// <param name="basis" optional="true">Is the type of day count basis to use.</param>
  6741. /// <returns type="Excel.FunctionResult"></returns>
  6742. }
  6743. Functions.prototype.priceMat = function(settlement, maturity, issue, rate, yld, basis) {
  6744. /// <summary>
  6745. /// Returns the price per $100 face value of a security that pays interest at maturity. [Api set: ExcelApi 1.2]
  6746. /// </summary>
  6747. /// <param name="settlement" >Is the security&apos;s settlement date, expressed as a serial date number.</param>
  6748. /// <param name="maturity" >Is the security&apos;s maturity date, expressed as a serial date number.</param>
  6749. /// <param name="issue" >Is the security&apos;s issue date, expressed as a serial date number.</param>
  6750. /// <param name="rate" >Is the security&apos;s interest rate at date of issue.</param>
  6751. /// <param name="yld" >Is the security&apos;s annual yield.</param>
  6752. /// <param name="basis" optional="true">Is the type of day count basis to use.</param>
  6753. /// <returns type="Excel.FunctionResult"></returns>
  6754. }
  6755. Functions.prototype.product = function(values) {
  6756. /// <summary>
  6757. /// Multiplies all the numbers given as arguments. [Api set: ExcelApi 1.2]
  6758. /// </summary>
  6759. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 numbers, logical values, or text representations of numbers that you want to multiply.</param>
  6760. /// <returns type="Excel.FunctionResult"></returns>
  6761. }
  6762. Functions.prototype.proper = function(text) {
  6763. /// <summary>
  6764. /// Converts a text string to proper case; the first letter in each word to uppercase, and all other letters to lowercase. [Api set: ExcelApi 1.2]
  6765. /// </summary>
  6766. /// <param name="text" >Is text enclosed in quotation marks, a formula that returns text, or a reference to a cell containing text to partially capitalize.</param>
  6767. /// <returns type="Excel.FunctionResult"></returns>
  6768. }
  6769. Functions.prototype.pv = function(rate, nper, pmt, fv, type) {
  6770. /// <summary>
  6771. /// Returns the present value of an investment: the total amount that a series of future payments is worth now. [Api set: ExcelApi 1.2]
  6772. /// </summary>
  6773. /// <param name="rate" >Is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR.</param>
  6774. /// <param name="nper" >Is the total number of payment periods in an investment.</param>
  6775. /// <param name="pmt" >Is the payment made each period and cannot change over the life of the investment.</param>
  6776. /// <param name="fv" optional="true">Is the future value, or a cash balance you want to attain after the last payment is made.</param>
  6777. /// <param name="type" optional="true">Is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted.</param>
  6778. /// <returns type="Excel.FunctionResult"></returns>
  6779. }
  6780. Functions.prototype.quartile_Exc = function(array, quart) {
  6781. /// <summary>
  6782. /// Returns the quartile of a data set, based on percentile values from 0..1, exclusive. [Api set: ExcelApi 1.2]
  6783. /// </summary>
  6784. /// <param name="array" >Is the array or cell range of numeric values for which you want the quartile value.</param>
  6785. /// <param name="quart" >Is a number: minimum value = 0; 1st quartile = 1; median value = 2; 3rd quartile = 3; maximum value = 4.</param>
  6786. /// <returns type="Excel.FunctionResult"></returns>
  6787. }
  6788. Functions.prototype.quartile_Inc = function(array, quart) {
  6789. /// <summary>
  6790. /// Returns the quartile of a data set, based on percentile values from 0..1, inclusive. [Api set: ExcelApi 1.2]
  6791. /// </summary>
  6792. /// <param name="array" >Is the array or cell range of numeric values for which you want the quartile value.</param>
  6793. /// <param name="quart" >Is a number: minimum value = 0; 1st quartile = 1; median value = 2; 3rd quartile = 3; maximum value = 4.</param>
  6794. /// <returns type="Excel.FunctionResult"></returns>
  6795. }
  6796. Functions.prototype.quotient = function(numerator, denominator) {
  6797. /// <summary>
  6798. /// Returns the integer portion of a division. [Api set: ExcelApi 1.2]
  6799. /// </summary>
  6800. /// <param name="numerator" >Is the dividend.</param>
  6801. /// <param name="denominator" >Is the divisor.</param>
  6802. /// <returns type="Excel.FunctionResult"></returns>
  6803. }
  6804. Functions.prototype.radians = function(angle) {
  6805. /// <summary>
  6806. /// Converts degrees to radians. [Api set: ExcelApi 1.2]
  6807. /// </summary>
  6808. /// <param name="angle" >Is an angle in degrees that you want to convert.</param>
  6809. /// <returns type="Excel.FunctionResult"></returns>
  6810. }
  6811. Functions.prototype.rand = function() {
  6812. /// <summary>
  6813. /// Returns a random number greater than or equal to 0 and less than 1, evenly distributed (changes on recalculation). [Api set: ExcelApi 1.2]
  6814. /// </summary>
  6815. /// <returns type="Excel.FunctionResult"></returns>
  6816. }
  6817. Functions.prototype.randBetween = function(bottom, top) {
  6818. /// <summary>
  6819. /// Returns a random number between the numbers you specify. [Api set: ExcelApi 1.2]
  6820. /// </summary>
  6821. /// <param name="bottom" >Is the smallest integer RANDBETWEEN will return.</param>
  6822. /// <param name="top" >Is the largest integer RANDBETWEEN will return.</param>
  6823. /// <returns type="Excel.FunctionResult"></returns>
  6824. }
  6825. Functions.prototype.rank_Avg = function(number, ref, order) {
  6826. /// <summary>
  6827. /// Returns the rank of a number in a list of numbers: its size relative to other values in the list; if more than one value has the same rank, the average rank is returned. [Api set: ExcelApi 1.2]
  6828. /// </summary>
  6829. /// <param name="number" >Is the number for which you want to find the rank.</param>
  6830. /// <param name="ref" >Is an array of, or a reference to, a list of numbers. Nonnumeric values are ignored.</param>
  6831. /// <param name="order" optional="true">Is a number: rank in the list sorted descending = 0 or omitted; rank in the list sorted ascending = any nonzero value.</param>
  6832. /// <returns type="Excel.FunctionResult"></returns>
  6833. }
  6834. Functions.prototype.rank_Eq = function(number, ref, order) {
  6835. /// <summary>
  6836. /// Returns the rank of a number in a list of numbers: its size relative to other values in the list; if more than one value has the same rank, the top rank of that set of values is returned. [Api set: ExcelApi 1.2]
  6837. /// </summary>
  6838. /// <param name="number" >Is the number for which you want to find the rank.</param>
  6839. /// <param name="ref" >Is an array of, or a reference to, a list of numbers. Nonnumeric values are ignored.</param>
  6840. /// <param name="order" optional="true">Is a number: rank in the list sorted descending = 0 or omitted; rank in the list sorted ascending = any nonzero value.</param>
  6841. /// <returns type="Excel.FunctionResult"></returns>
  6842. }
  6843. Functions.prototype.rate = function(nper, pmt, pv, fv, type, guess) {
  6844. /// <summary>
  6845. /// Returns the interest rate per period of a loan or an investment. For example, use 6%/4 for quarterly payments at 6% APR. [Api set: ExcelApi 1.2]
  6846. /// </summary>
  6847. /// <param name="nper" >Is the total number of payment periods for the loan or investment.</param>
  6848. /// <param name="pmt" >Is the payment made each period and cannot change over the life of the loan or investment.</param>
  6849. /// <param name="pv" >Is the present value: the total amount that a series of future payments is worth now.</param>
  6850. /// <param name="fv" optional="true">Is the future value, or a cash balance you want to attain after the last payment is made. If omitted, uses Fv = 0.</param>
  6851. /// <param name="type" optional="true">Is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted.</param>
  6852. /// <param name="guess" optional="true">Is your guess for what the rate will be; if omitted, Guess = 0.1 (10 percent).</param>
  6853. /// <returns type="Excel.FunctionResult"></returns>
  6854. }
  6855. Functions.prototype.received = function(settlement, maturity, investment, discount, basis) {
  6856. /// <summary>
  6857. /// Returns the amount received at maturity for a fully invested security. [Api set: ExcelApi 1.2]
  6858. /// </summary>
  6859. /// <param name="settlement" >Is the security&apos;s settlement date, expressed as a serial date number.</param>
  6860. /// <param name="maturity" >Is the security&apos;s maturity date, expressed as a serial date number.</param>
  6861. /// <param name="investment" >Is the amount invested in the security.</param>
  6862. /// <param name="discount" >Is the security&apos;s discount rate.</param>
  6863. /// <param name="basis" optional="true">Is the type of day count basis to use.</param>
  6864. /// <returns type="Excel.FunctionResult"></returns>
  6865. }
  6866. Functions.prototype.replace = function(oldText, startNum, numChars, newText) {
  6867. /// <summary>
  6868. /// Replaces part of a text string with a different text string. [Api set: ExcelApi 1.2]
  6869. /// </summary>
  6870. /// <param name="oldText" >Is text in which you want to replace some characters.</param>
  6871. /// <param name="startNum" >Is the position of the character in oldText that you want to replace with newText.</param>
  6872. /// <param name="numChars" >Is the number of characters in oldText that you want to replace.</param>
  6873. /// <param name="newText" >Is the text that will replace characters in oldText.</param>
  6874. /// <returns type="Excel.FunctionResult"></returns>
  6875. }
  6876. Functions.prototype.replaceB = function(oldText, startNum, numBytes, newText) {
  6877. /// <summary>
  6878. /// Replaces part of a text string with a different text string. Use with double-byte character sets (DBCS). [Api set: ExcelApi 1.2]
  6879. /// </summary>
  6880. /// <param name="oldText" >Is text in which you want to replace some characters.</param>
  6881. /// <param name="startNum" >Is the position of the character in oldText that you want to replace with newText.</param>
  6882. /// <param name="numBytes" >Is the number of characters in oldText that you want to replace with newText.</param>
  6883. /// <param name="newText" >Is the text that will replace characters in oldText.</param>
  6884. /// <returns type="Excel.FunctionResult"></returns>
  6885. }
  6886. Functions.prototype.rept = function(text, numberTimes) {
  6887. /// <summary>
  6888. /// Repeats text a given number of times. Use REPT to fill a cell with a number of instances of a text string. [Api set: ExcelApi 1.2]
  6889. /// </summary>
  6890. /// <param name="text" >Is the text you want to repeat.</param>
  6891. /// <param name="numberTimes" >Is a positive number specifying the number of times to repeat text.</param>
  6892. /// <returns type="Excel.FunctionResult"></returns>
  6893. }
  6894. Functions.prototype.right = function(text, numChars) {
  6895. /// <summary>
  6896. /// Returns the specified number of characters from the end of a text string. [Api set: ExcelApi 1.2]
  6897. /// </summary>
  6898. /// <param name="text" >Is the text string that contains the characters you want to extract.</param>
  6899. /// <param name="numChars" optional="true">Specifies how many characters you want to extract, 1 if omitted.</param>
  6900. /// <returns type="Excel.FunctionResult"></returns>
  6901. }
  6902. Functions.prototype.rightb = function(text, numBytes) {
  6903. /// <summary>
  6904. /// Returns the specified number of characters from the end of a text string. Use with double-byte character sets (DBCS). [Api set: ExcelApi 1.2]
  6905. /// </summary>
  6906. /// <param name="text" >Is the text string containing the characters you want to extract.</param>
  6907. /// <param name="numBytes" optional="true">Specifies how many characters you want to extract.</param>
  6908. /// <returns type="Excel.FunctionResult"></returns>
  6909. }
  6910. Functions.prototype.roman = function(number, form) {
  6911. /// <summary>
  6912. /// Converts an Arabic numeral to Roman, as text. [Api set: ExcelApi 1.2]
  6913. /// </summary>
  6914. /// <param name="number" >Is the Arabic numeral you want to convert.</param>
  6915. /// <param name="form" optional="true">Is the number specifying the type of Roman numeral you want.</param>
  6916. /// <returns type="Excel.FunctionResult"></returns>
  6917. }
  6918. Functions.prototype.round = function(number, numDigits) {
  6919. /// <summary>
  6920. /// Rounds a number to a specified number of digits. [Api set: ExcelApi 1.2]
  6921. /// </summary>
  6922. /// <param name="number" >Is the number you want to round.</param>
  6923. /// <param name="numDigits" >Is the number of digits to which you want to round. Negative rounds to the left of the decimal point; zero to the nearest integer.</param>
  6924. /// <returns type="Excel.FunctionResult"></returns>
  6925. }
  6926. Functions.prototype.roundDown = function(number, numDigits) {
  6927. /// <summary>
  6928. /// Rounds a number down, toward zero. [Api set: ExcelApi 1.2]
  6929. /// </summary>
  6930. /// <param name="number" >Is any real number that you want rounded down.</param>
  6931. /// <param name="numDigits" >Is the number of digits to which you want to round. Negative rounds to the left of the decimal point; zero or omitted, to the nearest integer.</param>
  6932. /// <returns type="Excel.FunctionResult"></returns>
  6933. }
  6934. Functions.prototype.roundUp = function(number, numDigits) {
  6935. /// <summary>
  6936. /// Rounds a number up, away from zero. [Api set: ExcelApi 1.2]
  6937. /// </summary>
  6938. /// <param name="number" >Is any real number that you want rounded up.</param>
  6939. /// <param name="numDigits" >Is the number of digits to which you want to round. Negative rounds to the left of the decimal point; zero or omitted, to the nearest integer.</param>
  6940. /// <returns type="Excel.FunctionResult"></returns>
  6941. }
  6942. Functions.prototype.rows = function(array) {
  6943. /// <summary>
  6944. /// Returns the number of rows in a reference or array. [Api set: ExcelApi 1.2]
  6945. /// </summary>
  6946. /// <param name="array" >Is an array, an array formula, or a reference to a range of cells for which you want the number of rows.</param>
  6947. /// <returns type="Excel.FunctionResult"></returns>
  6948. }
  6949. Functions.prototype.rri = function(nper, pv, fv) {
  6950. /// <summary>
  6951. /// Returns an equivalent interest rate for the growth of an investment. [Api set: ExcelApi 1.2]
  6952. /// </summary>
  6953. /// <param name="nper" >Is the number of periods for the investment.</param>
  6954. /// <param name="pv" >Is the present value of the investment.</param>
  6955. /// <param name="fv" >Is the future value of the investment.</param>
  6956. /// <returns type="Excel.FunctionResult"></returns>
  6957. }
  6958. Functions.prototype.sec = function(number) {
  6959. /// <summary>
  6960. /// Returns the secant of an angle. [Api set: ExcelApi 1.2]
  6961. /// </summary>
  6962. /// <param name="number" >Is the angle in radians for which you want the secant.</param>
  6963. /// <returns type="Excel.FunctionResult"></returns>
  6964. }
  6965. Functions.prototype.sech = function(number) {
  6966. /// <summary>
  6967. /// Returns the hyperbolic secant of an angle. [Api set: ExcelApi 1.2]
  6968. /// </summary>
  6969. /// <param name="number" >Is the angle in radians for which you want the hyperbolic secant.</param>
  6970. /// <returns type="Excel.FunctionResult"></returns>
  6971. }
  6972. Functions.prototype.second = function(serialNumber) {
  6973. /// <summary>
  6974. /// Returns the second, a number from 0 to 59. [Api set: ExcelApi 1.2]
  6975. /// </summary>
  6976. /// <param name="serialNumber" >Is a number in the date-time code used by Microsoft Excel or text in time format, such as 16:48:23 or 4:48:47 PM.</param>
  6977. /// <returns type="Excel.FunctionResult"></returns>
  6978. }
  6979. Functions.prototype.seriesSum = function(x, n, m, coefficients) {
  6980. /// <summary>
  6981. /// Returns the sum of a power series based on the formula. [Api set: ExcelApi 1.2]
  6982. /// </summary>
  6983. /// <param name="x" >Is the input value to the power series.</param>
  6984. /// <param name="n" >Is the initial power to which you want to raise x.</param>
  6985. /// <param name="m" >Is the step by which to increase n for each term in the series.</param>
  6986. /// <param name="coefficients" >Is a set of coefficients by which each successive power of x is multiplied.</param>
  6987. /// <returns type="Excel.FunctionResult"></returns>
  6988. }
  6989. Functions.prototype.sheet = function(value) {
  6990. /// <summary>
  6991. /// Returns the sheet number of the referenced sheet. [Api set: ExcelApi 1.2]
  6992. /// </summary>
  6993. /// <param name="value" optional="true">Is the name of a sheet or a reference that you want the sheet number of. If omitted the number of the sheet containing the function is returned.</param>
  6994. /// <returns type="Excel.FunctionResult"></returns>
  6995. }
  6996. Functions.prototype.sheets = function(reference) {
  6997. /// <summary>
  6998. /// Returns the number of sheets in a reference. [Api set: ExcelApi 1.2]
  6999. /// </summary>
  7000. /// <param name="reference" optional="true">Is a reference for which you want to know the number of sheets it contains. If omitted the number of sheets in the workbook containing the function is returned.</param>
  7001. /// <returns type="Excel.FunctionResult"></returns>
  7002. }
  7003. Functions.prototype.sign = function(number) {
  7004. /// <summary>
  7005. /// Returns the sign of a number: 1 if the number is positive, zero if the number is zero, or -1 if the number is negative. [Api set: ExcelApi 1.2]
  7006. /// </summary>
  7007. /// <param name="number" >Is any real number.</param>
  7008. /// <returns type="Excel.FunctionResult"></returns>
  7009. }
  7010. Functions.prototype.sin = function(number) {
  7011. /// <summary>
  7012. /// Returns the sine of an angle. [Api set: ExcelApi 1.2]
  7013. /// </summary>
  7014. /// <param name="number" >Is the angle in radians for which you want the sine. Degrees * PI()/180 = radians.</param>
  7015. /// <returns type="Excel.FunctionResult"></returns>
  7016. }
  7017. Functions.prototype.sinh = function(number) {
  7018. /// <summary>
  7019. /// Returns the hyperbolic sine of a number. [Api set: ExcelApi 1.2]
  7020. /// </summary>
  7021. /// <param name="number" >Is any real number.</param>
  7022. /// <returns type="Excel.FunctionResult"></returns>
  7023. }
  7024. Functions.prototype.skew = function(values) {
  7025. /// <summary>
  7026. /// Returns the skewness of a distribution: a characterization of the degree of asymmetry of a distribution around its mean. [Api set: ExcelApi 1.2]
  7027. /// </summary>
  7028. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 numbers or names, arrays, or references that contain numbers for which you want the skewness.</param>
  7029. /// <returns type="Excel.FunctionResult"></returns>
  7030. }
  7031. Functions.prototype.skew_p = function(values) {
  7032. /// <summary>
  7033. /// Returns the skewness of a distribution based on a population: a characterization of the degree of asymmetry of a distribution around its mean. [Api set: ExcelApi 1.2]
  7034. /// </summary>
  7035. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 254 numbers or names, arrays, or references that contain numbers for which you want the population skewness.</param>
  7036. /// <returns type="Excel.FunctionResult"></returns>
  7037. }
  7038. Functions.prototype.sln = function(cost, salvage, life) {
  7039. /// <summary>
  7040. /// Returns the straight-line depreciation of an asset for one period. [Api set: ExcelApi 1.2]
  7041. /// </summary>
  7042. /// <param name="cost" >Is the initial cost of the asset.</param>
  7043. /// <param name="salvage" >Is the salvage value at the end of the life of the asset.</param>
  7044. /// <param name="life" >Is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset).</param>
  7045. /// <returns type="Excel.FunctionResult"></returns>
  7046. }
  7047. Functions.prototype.small = function(array, k) {
  7048. /// <summary>
  7049. /// Returns the k-th smallest value in a data set. For example, the fifth smallest number. [Api set: ExcelApi 1.2]
  7050. /// </summary>
  7051. /// <param name="array" >Is an array or range of numerical data for which you want to determine the k-th smallest value.</param>
  7052. /// <param name="k" >Is the position (from the smallest) in the array or range of the value to return.</param>
  7053. /// <returns type="Excel.FunctionResult"></returns>
  7054. }
  7055. Functions.prototype.sqrt = function(number) {
  7056. /// <summary>
  7057. /// Returns the square root of a number. [Api set: ExcelApi 1.2]
  7058. /// </summary>
  7059. /// <param name="number" >Is the number for which you want the square root.</param>
  7060. /// <returns type="Excel.FunctionResult"></returns>
  7061. }
  7062. Functions.prototype.sqrtPi = function(number) {
  7063. /// <summary>
  7064. /// Returns the square root of (number * Pi). [Api set: ExcelApi 1.2]
  7065. /// </summary>
  7066. /// <param name="number" >Is the number by which p is multiplied.</param>
  7067. /// <returns type="Excel.FunctionResult"></returns>
  7068. }
  7069. Functions.prototype.stDevA = function(values) {
  7070. /// <summary>
  7071. /// Estimates standard deviation based on a sample, including logical values and text. Text and the logical value FALSE have the value 0; the logical value TRUE has the value 1. [Api set: ExcelApi 1.2]
  7072. /// </summary>
  7073. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 values corresponding to a sample of a population and can be values or names or references to values.</param>
  7074. /// <returns type="Excel.FunctionResult"></returns>
  7075. }
  7076. Functions.prototype.stDevPA = function(values) {
  7077. /// <summary>
  7078. /// Calculates standard deviation based on an entire population, including logical values and text. Text and the logical value FALSE have the value 0; the logical value TRUE has the value 1. [Api set: ExcelApi 1.2]
  7079. /// </summary>
  7080. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 values corresponding to a population and can be values, names, arrays, or references that contain values.</param>
  7081. /// <returns type="Excel.FunctionResult"></returns>
  7082. }
  7083. Functions.prototype.stDev_P = function(values) {
  7084. /// <summary>
  7085. /// Calculates standard deviation based on the entire population given as arguments (ignores logical values and text). [Api set: ExcelApi 1.2]
  7086. /// </summary>
  7087. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 numbers corresponding to a population and can be numbers or references that contain numbers.</param>
  7088. /// <returns type="Excel.FunctionResult"></returns>
  7089. }
  7090. Functions.prototype.stDev_S = function(values) {
  7091. /// <summary>
  7092. /// Estimates standard deviation based on a sample (ignores logical values and text in the sample). [Api set: ExcelApi 1.2]
  7093. /// </summary>
  7094. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 numbers corresponding to a sample of a population and can be numbers or references that contain numbers.</param>
  7095. /// <returns type="Excel.FunctionResult"></returns>
  7096. }
  7097. Functions.prototype.standardize = function(x, mean, standardDev) {
  7098. /// <summary>
  7099. /// Returns a normalized value from a distribution characterized by a mean and standard deviation. [Api set: ExcelApi 1.2]
  7100. /// </summary>
  7101. /// <param name="x" >Is the value you want to normalize.</param>
  7102. /// <param name="mean" >Is the arithmetic mean of the distribution.</param>
  7103. /// <param name="standardDev" >Is the standard deviation of the distribution, a positive number.</param>
  7104. /// <returns type="Excel.FunctionResult"></returns>
  7105. }
  7106. Functions.prototype.substitute = function(text, oldText, newText, instanceNum) {
  7107. /// <summary>
  7108. /// Replaces existing text with new text in a text string. [Api set: ExcelApi 1.2]
  7109. /// </summary>
  7110. /// <param name="text" >Is the text or the reference to a cell containing text in which you want to substitute characters.</param>
  7111. /// <param name="oldText" >Is the existing text you want to replace. If the case of oldText does not match the case of text, SUBSTITUTE will not replace the text.</param>
  7112. /// <param name="newText" >Is the text you want to replace oldText with.</param>
  7113. /// <param name="instanceNum" optional="true">Specifies which occurrence of oldText you want to replace. If omitted, every instance of oldText is replaced.</param>
  7114. /// <returns type="Excel.FunctionResult"></returns>
  7115. }
  7116. Functions.prototype.subtotal = function(functionNum, values) {
  7117. /// <summary>
  7118. /// Returns a subtotal in a list or database. [Api set: ExcelApi 1.2]
  7119. /// </summary>
  7120. /// <param name="functionNum" >Is the number 1 to 11 that specifies the summary function for the subtotal.</param>
  7121. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 254 ranges or references for which you want the subtotal.</param>
  7122. /// <returns type="Excel.FunctionResult"></returns>
  7123. }
  7124. Functions.prototype.sum = function(values) {
  7125. /// <summary>
  7126. /// Adds all the numbers in a range of cells. [Api set: ExcelApi 1.2]
  7127. /// </summary>
  7128. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 numbers to sum. Logical values and text are ignored in cells, included if typed as arguments.</param>
  7129. /// <returns type="Excel.FunctionResult"></returns>
  7130. }
  7131. Functions.prototype.sumIf = function(range, criteria, sumRange) {
  7132. /// <summary>
  7133. /// Adds the cells specified by a given condition or criteria. [Api set: ExcelApi 1.2]
  7134. /// </summary>
  7135. /// <param name="range" >Is the range of cells you want evaluated.</param>
  7136. /// <param name="criteria" >Is the condition or criteria in the form of a number, expression, or text that defines which cells will be added.</param>
  7137. /// <param name="sumRange" optional="true">Are the actual cells to sum. If omitted, the cells in range are used.</param>
  7138. /// <returns type="Excel.FunctionResult"></returns>
  7139. }
  7140. Functions.prototype.sumIfs = function(sumRange, values) {
  7141. /// <summary>
  7142. /// Adds the cells specified by a given set of conditions or criteria. [Api set: ExcelApi 1.2]
  7143. /// </summary>
  7144. /// <param name="sumRange" >Are the actual cells to sum.</param>
  7145. /// <param name="values" type="Array" >List of parameters, where the first element of each pair is the Is the range of cells you want evaluated for the particular condition , and the second element is is the condition or criteria in the form of a number, expression, or text that defines which cells will be added.</param>
  7146. /// <returns type="Excel.FunctionResult"></returns>
  7147. }
  7148. Functions.prototype.sumSq = function(values) {
  7149. /// <summary>
  7150. /// Returns the sum of the squares of the arguments. The arguments can be numbers, arrays, names, or references to cells that contain numbers. [Api set: ExcelApi 1.2]
  7151. /// </summary>
  7152. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 numbers, arrays, names, or references to arrays for which you want the sum of the squares.</param>
  7153. /// <returns type="Excel.FunctionResult"></returns>
  7154. }
  7155. Functions.prototype.syd = function(cost, salvage, life, per) {
  7156. /// <summary>
  7157. /// Returns the sum-of-years&apos; digits depreciation of an asset for a specified period. [Api set: ExcelApi 1.2]
  7158. /// </summary>
  7159. /// <param name="cost" >Is the initial cost of the asset.</param>
  7160. /// <param name="salvage" >Is the salvage value at the end of the life of the asset.</param>
  7161. /// <param name="life" >Is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset).</param>
  7162. /// <param name="per" >Is the period and must use the same units as Life.</param>
  7163. /// <returns type="Excel.FunctionResult"></returns>
  7164. }
  7165. Functions.prototype.t = function(value) {
  7166. /// <summary>
  7167. /// Checks whether a value is text, and returns the text if it is, or returns double quotes (empty text) if it is not. [Api set: ExcelApi 1.2]
  7168. /// </summary>
  7169. /// <param name="value" >Is the value to test.</param>
  7170. /// <returns type="Excel.FunctionResult"></returns>
  7171. }
  7172. Functions.prototype.tbillEq = function(settlement, maturity, discount) {
  7173. /// <summary>
  7174. /// Returns the bond-equivalent yield for a treasury bill. [Api set: ExcelApi 1.2]
  7175. /// </summary>
  7176. /// <param name="settlement" >Is the Treasury bill&apos;s settlement date, expressed as a serial date number.</param>
  7177. /// <param name="maturity" >Is the Treasury bill&apos;s maturity date, expressed as a serial date number.</param>
  7178. /// <param name="discount" >Is the Treasury bill&apos;s discount rate.</param>
  7179. /// <returns type="Excel.FunctionResult"></returns>
  7180. }
  7181. Functions.prototype.tbillPrice = function(settlement, maturity, discount) {
  7182. /// <summary>
  7183. /// Returns the price per $100 face value for a treasury bill. [Api set: ExcelApi 1.2]
  7184. /// </summary>
  7185. /// <param name="settlement" >Is the Treasury bill&apos;s settlement date, expressed as a serial date number.</param>
  7186. /// <param name="maturity" >Is the Treasury bill&apos;s maturity date, expressed as a serial date number.</param>
  7187. /// <param name="discount" >Is the Treasury bill&apos;s discount rate.</param>
  7188. /// <returns type="Excel.FunctionResult"></returns>
  7189. }
  7190. Functions.prototype.tbillYield = function(settlement, maturity, pr) {
  7191. /// <summary>
  7192. /// Returns the yield for a treasury bill. [Api set: ExcelApi 1.2]
  7193. /// </summary>
  7194. /// <param name="settlement" >Is the Treasury bill&apos;s settlement date, expressed as a serial date number.</param>
  7195. /// <param name="maturity" >Is the Treasury bill&apos;s maturity date, expressed as a serial date number.</param>
  7196. /// <param name="pr" >Is the Treasury Bill&apos;s price per $100 face value.</param>
  7197. /// <returns type="Excel.FunctionResult"></returns>
  7198. }
  7199. Functions.prototype.t_Dist = function(x, degFreedom, cumulative) {
  7200. /// <summary>
  7201. /// Returns the left-tailed Student&apos;s t-distribution. [Api set: ExcelApi 1.2]
  7202. /// </summary>
  7203. /// <param name="x" >Is the numeric value at which to evaluate the distribution.</param>
  7204. /// <param name="degFreedom" >Is an integer indicating the number of degrees of freedom that characterize the distribution.</param>
  7205. /// <param name="cumulative" >Is a logical value: for the cumulative distribution function, use TRUE; for the probability density function, use FALSE.</param>
  7206. /// <returns type="Excel.FunctionResult"></returns>
  7207. }
  7208. Functions.prototype.t_Dist_2T = function(x, degFreedom) {
  7209. /// <summary>
  7210. /// Returns the two-tailed Student&apos;s t-distribution. [Api set: ExcelApi 1.2]
  7211. /// </summary>
  7212. /// <param name="x" >Is the numeric value at which to evaluate the distribution.</param>
  7213. /// <param name="degFreedom" >Is an integer indicating the number of degrees of freedom that characterize the distribution.</param>
  7214. /// <returns type="Excel.FunctionResult"></returns>
  7215. }
  7216. Functions.prototype.t_Dist_RT = function(x, degFreedom) {
  7217. /// <summary>
  7218. /// Returns the right-tailed Student&apos;s t-distribution. [Api set: ExcelApi 1.2]
  7219. /// </summary>
  7220. /// <param name="x" >Is the numeric value at which to evaluate the distribution.</param>
  7221. /// <param name="degFreedom" >Is an integer indicating the number of degrees of freedom that characterize the distribution.</param>
  7222. /// <returns type="Excel.FunctionResult"></returns>
  7223. }
  7224. Functions.prototype.t_Inv = function(probability, degFreedom) {
  7225. /// <summary>
  7226. /// Returns the left-tailed inverse of the Student&apos;s t-distribution. [Api set: ExcelApi 1.2]
  7227. /// </summary>
  7228. /// <param name="probability" >Is the probability associated with the two-tailed Student&apos;s t-distribution, a number between 0 and 1 inclusive.</param>
  7229. /// <param name="degFreedom" >Is a positive integer indicating the number of degrees of freedom to characterize the distribution.</param>
  7230. /// <returns type="Excel.FunctionResult"></returns>
  7231. }
  7232. Functions.prototype.t_Inv_2T = function(probability, degFreedom) {
  7233. /// <summary>
  7234. /// Returns the two-tailed inverse of the Student&apos;s t-distribution. [Api set: ExcelApi 1.2]
  7235. /// </summary>
  7236. /// <param name="probability" >Is the probability associated with the two-tailed Student&apos;s t-distribution, a number between 0 and 1 inclusive.</param>
  7237. /// <param name="degFreedom" >Is a positive integer indicating the number of degrees of freedom to characterize the distribution.</param>
  7238. /// <returns type="Excel.FunctionResult"></returns>
  7239. }
  7240. Functions.prototype.tan = function(number) {
  7241. /// <summary>
  7242. /// Returns the tangent of an angle. [Api set: ExcelApi 1.2]
  7243. /// </summary>
  7244. /// <param name="number" >Is the angle in radians for which you want the tangent. Degrees * PI()/180 = radians.</param>
  7245. /// <returns type="Excel.FunctionResult"></returns>
  7246. }
  7247. Functions.prototype.tanh = function(number) {
  7248. /// <summary>
  7249. /// Returns the hyperbolic tangent of a number. [Api set: ExcelApi 1.2]
  7250. /// </summary>
  7251. /// <param name="number" >Is any real number.</param>
  7252. /// <returns type="Excel.FunctionResult"></returns>
  7253. }
  7254. Functions.prototype.text = function(value, formatText) {
  7255. /// <summary>
  7256. /// Converts a value to text in a specific number format. [Api set: ExcelApi 1.2]
  7257. /// </summary>
  7258. /// <param name="value" >Is a number, a formula that evaluates to a numeric value, or a reference to a cell containing a numeric value.</param>
  7259. /// <param name="formatText" >Is a number format in text form from the Category box on the Number tab in the Format Cells dialog box (not General).</param>
  7260. /// <returns type="Excel.FunctionResult"></returns>
  7261. }
  7262. Functions.prototype.time = function(hour, minute, second) {
  7263. /// <summary>
  7264. /// Converts hours, minutes, and seconds given as numbers to an Excel serial number, formatted with a time format. [Api set: ExcelApi 1.2]
  7265. /// </summary>
  7266. /// <param name="hour" >Is a number from 0 to 23 representing the hour.</param>
  7267. /// <param name="minute" >Is a number from 0 to 59 representing the minute.</param>
  7268. /// <param name="second" >Is a number from 0 to 59 representing the second.</param>
  7269. /// <returns type="Excel.FunctionResult"></returns>
  7270. }
  7271. Functions.prototype.timevalue = function(timeText) {
  7272. /// <summary>
  7273. /// Converts a text time to an Excel serial number for a time, a number from 0 (12:00:00 AM) to 0.999988426 (11:59:59 PM). Format the number with a time format after entering the formula. [Api set: ExcelApi 1.2]
  7274. /// </summary>
  7275. /// <param name="timeText" >Is a text string that gives a time in any one of the Microsoft Excel time formats (date information in the string is ignored).</param>
  7276. /// <returns type="Excel.FunctionResult"></returns>
  7277. }
  7278. Functions.prototype.today = function() {
  7279. /// <summary>
  7280. /// Returns the current date formatted as a date. [Api set: ExcelApi 1.2]
  7281. /// </summary>
  7282. /// <returns type="Excel.FunctionResult"></returns>
  7283. }
  7284. Functions.prototype.trim = function(text) {
  7285. /// <summary>
  7286. /// Removes all spaces from a text string except for single spaces between words. [Api set: ExcelApi 1.2]
  7287. /// </summary>
  7288. /// <param name="text" >Is the text from which you want spaces removed.</param>
  7289. /// <returns type="Excel.FunctionResult"></returns>
  7290. }
  7291. Functions.prototype.trimMean = function(array, percent) {
  7292. /// <summary>
  7293. /// Returns the mean of the interior portion of a set of data values. [Api set: ExcelApi 1.2]
  7294. /// </summary>
  7295. /// <param name="array" >Is the range or array of values to trim and average.</param>
  7296. /// <param name="percent" >Is the fractional number of data points to exclude from the top and bottom of the data set.</param>
  7297. /// <returns type="Excel.FunctionResult"></returns>
  7298. }
  7299. Functions.prototype.true = function() {
  7300. /// <summary>
  7301. /// Returns the logical value TRUE. [Api set: ExcelApi 1.2]
  7302. /// </summary>
  7303. /// <returns type="Excel.FunctionResult"></returns>
  7304. }
  7305. Functions.prototype.trunc = function(number, numDigits) {
  7306. /// <summary>
  7307. /// Truncates a number to an integer by removing the decimal, or fractional, part of the number. [Api set: ExcelApi 1.2]
  7308. /// </summary>
  7309. /// <param name="number" >Is the number you want to truncate.</param>
  7310. /// <param name="numDigits" optional="true">Is a number specifying the precision of the truncation, 0 (zero) if omitted.</param>
  7311. /// <returns type="Excel.FunctionResult"></returns>
  7312. }
  7313. Functions.prototype.type = function(value) {
  7314. /// <summary>
  7315. /// Returns an integer representing the data type of a value: number = 1; text = 2; logical value = 4; error value = 16; array = 64. [Api set: ExcelApi 1.2]
  7316. /// </summary>
  7317. /// <param name="value" >Can be any value.</param>
  7318. /// <returns type="Excel.FunctionResult"></returns>
  7319. }
  7320. Functions.prototype.usdollar = function(number, decimals) {
  7321. /// <summary>
  7322. /// Converts a number to text, using currency format. [Api set: ExcelApi 1.2]
  7323. /// </summary>
  7324. /// <param name="number" >Is a number, a reference to a cell containing a number, or a formula that evaluates to a number.</param>
  7325. /// <param name="decimals" optional="true">Is the number of digits to the right of the decimal point.</param>
  7326. /// <returns type="Excel.FunctionResult"></returns>
  7327. }
  7328. Functions.prototype.unichar = function(number) {
  7329. /// <summary>
  7330. /// Returns the Unicode character referenced by the given numeric value. [Api set: ExcelApi 1.2]
  7331. /// </summary>
  7332. /// <param name="number" >Is the Unicode number representing a character.</param>
  7333. /// <returns type="Excel.FunctionResult"></returns>
  7334. }
  7335. Functions.prototype.unicode = function(text) {
  7336. /// <summary>
  7337. /// Returns the number (code point) corresponding to the first character of the text. [Api set: ExcelApi 1.2]
  7338. /// </summary>
  7339. /// <param name="text" >Is the character that you want the Unicode value of.</param>
  7340. /// <returns type="Excel.FunctionResult"></returns>
  7341. }
  7342. Functions.prototype.upper = function(text) {
  7343. /// <summary>
  7344. /// Converts a text string to all uppercase letters. [Api set: ExcelApi 1.2]
  7345. /// </summary>
  7346. /// <param name="text" >Is the text you want converted to uppercase, a reference or a text string.</param>
  7347. /// <returns type="Excel.FunctionResult"></returns>
  7348. }
  7349. Functions.prototype.vlookup = function(lookupValue, tableArray, colIndexNum, rangeLookup) {
  7350. /// <summary>
  7351. /// Looks for a value in the leftmost column of a table, and then returns a value in the same row from a column you specify. By default, the table must be sorted in an ascending order. [Api set: ExcelApi 1.2]
  7352. /// </summary>
  7353. /// <param name="lookupValue" >Is the value to be found in the first column of the table, and can be a value, a reference, or a text string.</param>
  7354. /// <param name="tableArray" >Is a table of text, numbers, or logical values, in which data is retrieved. tableArray can be a reference to a range or a range name.</param>
  7355. /// <param name="colIndexNum" >Is the column number in tableArray from which the matching value should be returned. The first column of values in the table is column 1.</param>
  7356. /// <param name="rangeLookup" optional="true">Is a logical value: to find the closest match in the first column (sorted in ascending order) = TRUE or omitted; find an exact match = FALSE.</param>
  7357. /// <returns type="Excel.FunctionResult"></returns>
  7358. }
  7359. Functions.prototype.value = function(text) {
  7360. /// <summary>
  7361. /// Converts a text string that represents a number to a number. [Api set: ExcelApi 1.2]
  7362. /// </summary>
  7363. /// <param name="text" >Is the text enclosed in quotation marks or a reference to a cell containing the text you want to convert.</param>
  7364. /// <returns type="Excel.FunctionResult"></returns>
  7365. }
  7366. Functions.prototype.varA = function(values) {
  7367. /// <summary>
  7368. /// Estimates variance based on a sample, including logical values and text. Text and the logical value FALSE have the value 0; the logical value TRUE has the value 1. [Api set: ExcelApi 1.2]
  7369. /// </summary>
  7370. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 value arguments corresponding to a sample of a population.</param>
  7371. /// <returns type="Excel.FunctionResult"></returns>
  7372. }
  7373. Functions.prototype.varPA = function(values) {
  7374. /// <summary>
  7375. /// Calculates variance based on the entire population, including logical values and text. Text and the logical value FALSE have the value 0; the logical value TRUE has the value 1. [Api set: ExcelApi 1.2]
  7376. /// </summary>
  7377. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 value arguments corresponding to a population.</param>
  7378. /// <returns type="Excel.FunctionResult"></returns>
  7379. }
  7380. Functions.prototype.var_P = function(values) {
  7381. /// <summary>
  7382. /// Calculates variance based on the entire population (ignores logical values and text in the population). [Api set: ExcelApi 1.2]
  7383. /// </summary>
  7384. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 numeric arguments corresponding to a population.</param>
  7385. /// <returns type="Excel.FunctionResult"></returns>
  7386. }
  7387. Functions.prototype.var_S = function(values) {
  7388. /// <summary>
  7389. /// Estimates variance based on a sample (ignores logical values and text in the sample). [Api set: ExcelApi 1.2]
  7390. /// </summary>
  7391. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 255 numeric arguments corresponding to a sample of a population.</param>
  7392. /// <returns type="Excel.FunctionResult"></returns>
  7393. }
  7394. Functions.prototype.vdb = function(cost, salvage, life, startPeriod, endPeriod, factor, noSwitch) {
  7395. /// <summary>
  7396. /// Returns the depreciation of an asset for any period you specify, including partial periods, using the double-declining balance method or some other method you specify. [Api set: ExcelApi 1.2]
  7397. /// </summary>
  7398. /// <param name="cost" >Is the initial cost of the asset.</param>
  7399. /// <param name="salvage" >Is the salvage value at the end of the life of the asset.</param>
  7400. /// <param name="life" >Is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset).</param>
  7401. /// <param name="startPeriod" >Is the starting period for which you want to calculate the depreciation, in the same units as Life.</param>
  7402. /// <param name="endPeriod" >Is the ending period for which you want to calculate the depreciation, in the same units as Life.</param>
  7403. /// <param name="factor" optional="true">Is the rate at which the balance declines, 2 (double-declining balance) if omitted.</param>
  7404. /// <param name="noSwitch" optional="true">Switch to straight-line depreciation when depreciation is greater than the declining balance = FALSE or omitted; do not switch = TRUE.</param>
  7405. /// <returns type="Excel.FunctionResult"></returns>
  7406. }
  7407. Functions.prototype.weekNum = function(serialNumber, returnType) {
  7408. /// <summary>
  7409. /// Returns the week number in the year. [Api set: ExcelApi 1.2]
  7410. /// </summary>
  7411. /// <param name="serialNumber" >Is the date-time code used by Microsoft Excel for date and time calculation.</param>
  7412. /// <param name="returnType" optional="true">Is a number (1 or 2) that determines the type of the return value.</param>
  7413. /// <returns type="Excel.FunctionResult"></returns>
  7414. }
  7415. Functions.prototype.weekday = function(serialNumber, returnType) {
  7416. /// <summary>
  7417. /// Returns a number from 1 to 7 identifying the day of the week of a date. [Api set: ExcelApi 1.2]
  7418. /// </summary>
  7419. /// <param name="serialNumber" >Is a number that represents a date.</param>
  7420. /// <param name="returnType" optional="true">Is a number: for Sunday=1 through Saturday=7, use 1; for Monday=1 through Sunday=7, use 2; for Monday=0 through Sunday=6, use 3.</param>
  7421. /// <returns type="Excel.FunctionResult"></returns>
  7422. }
  7423. Functions.prototype.weibull_Dist = function(x, alpha, beta, cumulative) {
  7424. /// <summary>
  7425. /// Returns the Weibull distribution. [Api set: ExcelApi 1.2]
  7426. /// </summary>
  7427. /// <param name="x" >Is the value at which to evaluate the function, a nonnegative number.</param>
  7428. /// <param name="alpha" >Is a parameter to the distribution, a positive number.</param>
  7429. /// <param name="beta" >Is a parameter to the distribution, a positive number.</param>
  7430. /// <param name="cumulative" >Is a logical value: for the cumulative distribution function, use TRUE; for the probability mass function, use FALSE.</param>
  7431. /// <returns type="Excel.FunctionResult"></returns>
  7432. }
  7433. Functions.prototype.workDay = function(startDate, days, holidays) {
  7434. /// <summary>
  7435. /// Returns the serial number of the date before or after a specified number of workdays. [Api set: ExcelApi 1.2]
  7436. /// </summary>
  7437. /// <param name="startDate" >Is a serial date number that represents the start date.</param>
  7438. /// <param name="days" >Is the number of nonweekend and non-holiday days before or after startDate.</param>
  7439. /// <param name="holidays" optional="true">Is an optional array of one or more serial date numbers to exclude from the working calendar, such as state and federal holidays and floating holidays.</param>
  7440. /// <returns type="Excel.FunctionResult"></returns>
  7441. }
  7442. Functions.prototype.workDay_Intl = function(startDate, days, weekend, holidays) {
  7443. /// <summary>
  7444. /// Returns the serial number of the date before or after a specified number of workdays with custom weekend parameters. [Api set: ExcelApi 1.2]
  7445. /// </summary>
  7446. /// <param name="startDate" >Is a serial date number that represents the start date.</param>
  7447. /// <param name="days" >Is the number of nonweekend and non-holiday days before or after startDate.</param>
  7448. /// <param name="weekend" optional="true">Is a number or string specifying when weekends occur.</param>
  7449. /// <param name="holidays" optional="true">Is an optional array of one or more serial date numbers to exclude from the working calendar, such as state and federal holidays and floating holidays.</param>
  7450. /// <returns type="Excel.FunctionResult"></returns>
  7451. }
  7452. Functions.prototype.xirr = function(values, dates, guess) {
  7453. /// <summary>
  7454. /// Returns the internal rate of return for a schedule of cash flows. [Api set: ExcelApi 1.2]
  7455. /// </summary>
  7456. /// <param name="values" >Is a series of cash flows that correspond to a schedule of payments in dates.</param>
  7457. /// <param name="dates" >Is a schedule of payment dates that corresponds to the cash flow payments.</param>
  7458. /// <param name="guess" optional="true">Is a number that you guess is close to the result of XIRR.</param>
  7459. /// <returns type="Excel.FunctionResult"></returns>
  7460. }
  7461. Functions.prototype.xnpv = function(rate, values, dates) {
  7462. /// <summary>
  7463. /// Returns the net present value for a schedule of cash flows. [Api set: ExcelApi 1.2]
  7464. /// </summary>
  7465. /// <param name="rate" >Is the discount rate to apply to the cash flows.</param>
  7466. /// <param name="values" >Is a series of cash flows that correspond to a schedule of payments in dates.</param>
  7467. /// <param name="dates" >Is a schedule of payment dates that corresponds to the cash flow payments.</param>
  7468. /// <returns type="Excel.FunctionResult"></returns>
  7469. }
  7470. Functions.prototype.xor = function(values) {
  7471. /// <summary>
  7472. /// Returns a logical &apos;Exclusive Or&apos; of all arguments. [Api set: ExcelApi 1.2]
  7473. /// </summary>
  7474. /// <param name="values" type="Array" >List of parameters, whose elements are 1 to 254 conditions you want to test that can be either TRUE or FALSE and can be logical values, arrays, or references.</param>
  7475. /// <returns type="Excel.FunctionResult"></returns>
  7476. }
  7477. Functions.prototype.year = function(serialNumber) {
  7478. /// <summary>
  7479. /// Returns the year of a date, an integer in the range 1900 - 9999. [Api set: ExcelApi 1.2]
  7480. /// </summary>
  7481. /// <param name="serialNumber" >Is a number in the date-time code used by Microsoft Excel.</param>
  7482. /// <returns type="Excel.FunctionResult"></returns>
  7483. }
  7484. Functions.prototype.yearFrac = function(startDate, endDate, basis) {
  7485. /// <summary>
  7486. /// Returns the year fraction representing the number of whole days between start_date and end_date. [Api set: ExcelApi 1.2]
  7487. /// </summary>
  7488. /// <param name="startDate" >Is a serial date number that represents the start date.</param>
  7489. /// <param name="endDate" >Is a serial date number that represents the end date.</param>
  7490. /// <param name="basis" optional="true">Is the type of day count basis to use.</param>
  7491. /// <returns type="Excel.FunctionResult"></returns>
  7492. }
  7493. Functions.prototype.yield = function(settlement, maturity, rate, pr, redemption, frequency, basis) {
  7494. /// <summary>
  7495. /// Returns the yield on a security that pays periodic interest. [Api set: ExcelApi 1.2]
  7496. /// </summary>
  7497. /// <param name="settlement" >Is the security&apos;s settlement date, expressed as a serial date number.</param>
  7498. /// <param name="maturity" >Is the security&apos;s maturity date, expressed as a serial date number.</param>
  7499. /// <param name="rate" >Is the security&apos;s annual coupon rate.</param>
  7500. /// <param name="pr" >Is the security&apos;s price per $100 face value.</param>
  7501. /// <param name="redemption" >Is the security&apos;s redemption value per $100 face value.</param>
  7502. /// <param name="frequency" >Is the number of coupon payments per year.</param>
  7503. /// <param name="basis" optional="true">Is the type of day count basis to use.</param>
  7504. /// <returns type="Excel.FunctionResult"></returns>
  7505. }
  7506. Functions.prototype.yieldDisc = function(settlement, maturity, pr, redemption, basis) {
  7507. /// <summary>
  7508. /// Returns the annual yield for a discounted security. For example, a treasury bill. [Api set: ExcelApi 1.2]
  7509. /// </summary>
  7510. /// <param name="settlement" >Is the security&apos;s settlement date, expressed as a serial date number.</param>
  7511. /// <param name="maturity" >Is the security&apos;s maturity date, expressed as a serial date number.</param>
  7512. /// <param name="pr" >Is the security&apos;s price per $100 face value.</param>
  7513. /// <param name="redemption" >Is the security&apos;s redemption value per $100 face value.</param>
  7514. /// <param name="basis" optional="true">Is the type of day count basis to use.</param>
  7515. /// <returns type="Excel.FunctionResult"></returns>
  7516. }
  7517. Functions.prototype.yieldMat = function(settlement, maturity, issue, rate, pr, basis) {
  7518. /// <summary>
  7519. /// Returns the annual yield of a security that pays interest at maturity. [Api set: ExcelApi 1.2]
  7520. /// </summary>
  7521. /// <param name="settlement" >Is the security&apos;s settlement date, expressed as a serial date number.</param>
  7522. /// <param name="maturity" >Is the security&apos;s maturity date, expressed as a serial date number.</param>
  7523. /// <param name="issue" >Is the security&apos;s issue date, expressed as a serial date number.</param>
  7524. /// <param name="rate" >Is the security&apos;s interest rate at date of issue.</param>
  7525. /// <param name="pr" >Is the security&apos;s price per $100 face value.</param>
  7526. /// <param name="basis" optional="true">Is the type of day count basis to use.</param>
  7527. /// <returns type="Excel.FunctionResult"></returns>
  7528. }
  7529. Functions.prototype.z_Test = function(array, x, sigma) {
  7530. /// <summary>
  7531. /// Returns the one-tailed P-value of a z-test. [Api set: ExcelApi 1.2]
  7532. /// </summary>
  7533. /// <param name="array" >Is the array or range of data against which to test X.</param>
  7534. /// <param name="x" >Is the value to test.</param>
  7535. /// <param name="sigma" optional="true">Is the population (known) standard deviation. If omitted, the sample standard deviation is used.</param>
  7536. /// <returns type="Excel.FunctionResult"></returns>
  7537. }
  7538. return Functions;
  7539. })(OfficeExtension.ClientObject);
  7540. Excel.Functions = Functions;
  7541. })(Excel || (Excel = {__proto__: null}));
  7542. var Excel;
  7543. (function (Excel) {
  7544. /// <summary> [Api set: ExcelApi 1.1] </summary>
  7545. var HorizontalAlignment = {
  7546. __proto__: null,
  7547. "general": "general",
  7548. "left": "left",
  7549. "center": "center",
  7550. "right": "right",
  7551. "fill": "fill",
  7552. "justify": "justify",
  7553. "centerAcrossSelection": "centerAcrossSelection",
  7554. "distributed": "distributed",
  7555. }
  7556. Excel.HorizontalAlignment = HorizontalAlignment;
  7557. })(Excel || (Excel = {__proto__: null}));
  7558. var Excel;
  7559. (function (Excel) {
  7560. var Interfaces;
  7561. (function (Interfaces) {
  7562. var Icon = (function() {
  7563. function Icon() {
  7564. /// <summary> Represents a cell icon. [Api set: ExcelApi 1.2] </summary>
  7565. /// <field name="index" type="Number">Represents the index of the icon in the given set. [Api set: ExcelApi 1.2]</field>
  7566. /// <field name="set" type="String">Represents the set that the icon is part of. [Api set: ExcelApi 1.2]</field>
  7567. }
  7568. return Icon;
  7569. })();
  7570. Interfaces.Icon.__proto__ = null;
  7571. Interfaces.Icon = Icon;
  7572. })(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
  7573. })(Excel || (Excel = {__proto__: null}));
  7574. var Excel;
  7575. (function (Excel) {
  7576. /// <summary> [Api set: ExcelApi 1.2] </summary>
  7577. var IconSet = {
  7578. __proto__: null,
  7579. "invalid": "invalid",
  7580. "threeArrows": "threeArrows",
  7581. "threeArrowsGray": "threeArrowsGray",
  7582. "threeFlags": "threeFlags",
  7583. "threeTrafficLights1": "threeTrafficLights1",
  7584. "threeTrafficLights2": "threeTrafficLights2",
  7585. "threeSigns": "threeSigns",
  7586. "threeSymbols": "threeSymbols",
  7587. "threeSymbols2": "threeSymbols2",
  7588. "fourArrows": "fourArrows",
  7589. "fourArrowsGray": "fourArrowsGray",
  7590. "fourRedToBlack": "fourRedToBlack",
  7591. "fourRating": "fourRating",
  7592. "fourTrafficLights": "fourTrafficLights",
  7593. "fiveArrows": "fiveArrows",
  7594. "fiveArrowsGray": "fiveArrowsGray",
  7595. "fiveRating": "fiveRating",
  7596. "fiveQuarters": "fiveQuarters",
  7597. "threeStars": "threeStars",
  7598. "threeTriangles": "threeTriangles",
  7599. "fiveBoxes": "fiveBoxes",
  7600. }
  7601. Excel.IconSet = IconSet;
  7602. })(Excel || (Excel = {__proto__: null}));
  7603. var Excel;
  7604. (function (Excel) {
  7605. /// <summary> [Api set: ExcelApi 1.2] </summary>
  7606. var ImageFittingMode = {
  7607. __proto__: null,
  7608. "fit": "fit",
  7609. "fitAndCenter": "fitAndCenter",
  7610. "fill": "fill",
  7611. }
  7612. Excel.ImageFittingMode = ImageFittingMode;
  7613. })(Excel || (Excel = {__proto__: null}));
  7614. var Excel;
  7615. (function (Excel) {
  7616. /// <summary> [Api set: ExcelApi 1.1] </summary>
  7617. var InsertShiftDirection = {
  7618. __proto__: null,
  7619. "down": "down",
  7620. "right": "right",
  7621. }
  7622. Excel.InsertShiftDirection = InsertShiftDirection;
  7623. })(Excel || (Excel = {__proto__: null}));
  7624. var Excel;
  7625. (function (Excel) {
  7626. var NamedItem = (function(_super) {
  7627. __extends(NamedItem, _super);
  7628. function NamedItem() {
  7629. /// <summary> Represents a defined name for a range of cells or value. Names can be primitive named objects (as seen in the type below), range object, reference to a range. This object can be used to obtain range object associated with names. [Api set: ExcelApi 1.1] </summary>
  7630. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  7631. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  7632. /// <field name="name" type="String">The name of the object. Read-only. [Api set: ExcelApi 1.1]</field>
  7633. /// <field name="type" type="String">Indicates what type of reference is associated with the name. See Excel.NamedItemType for details. Read-only. [Api set: ExcelApi 1.1]</field>
  7634. /// <field name="value" >Represents the formula that the name is defined to refer to. E.g. =Sheet14!$B$2:$H$12, =4.75, etc. Read-only. [Api set: ExcelApi 1.1]</field>
  7635. /// <field name="visible" type="Boolean">Specifies whether the object is visible or not. [Api set: ExcelApi 1.1]</field>
  7636. }
  7637. NamedItem.prototype.load = function(option) {
  7638. /// <summary>
  7639. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  7640. /// </summary>
  7641. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  7642. /// <returns type="Excel.NamedItem"/>
  7643. }
  7644. NamedItem.prototype.getRange = function() {
  7645. /// <summary>
  7646. /// Returns the range object that is associated with the name. Throws an exception if the named item&apos;s type is not a range. [Api set: ExcelApi 1.1]
  7647. /// </summary>
  7648. /// <returns type="Excel.Range"></returns>
  7649. }
  7650. return NamedItem;
  7651. })(OfficeExtension.ClientObject);
  7652. Excel.NamedItem = NamedItem;
  7653. })(Excel || (Excel = {__proto__: null}));
  7654. var Excel;
  7655. (function (Excel) {
  7656. var NamedItemCollection = (function(_super) {
  7657. __extends(NamedItemCollection, _super);
  7658. function NamedItemCollection() {
  7659. /// <summary> A collection of all the nameditem objects that are part of the workbook. [Api set: ExcelApi 1.1] </summary>
  7660. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  7661. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  7662. /// <field name="items" type="Array" elementType="Excel.NamedItem">Gets the loaded child items in this collection.</field>
  7663. }
  7664. NamedItemCollection.prototype.load = function(option) {
  7665. /// <summary>
  7666. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  7667. /// </summary>
  7668. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  7669. /// <returns type="Excel.NamedItemCollection"/>
  7670. }
  7671. NamedItemCollection.prototype.getItem = function(name) {
  7672. /// <summary>
  7673. /// Gets a nameditem object using its name [Api set: ExcelApi 1.1]
  7674. /// </summary>
  7675. /// <param name="name" type="String">nameditem name.</param>
  7676. /// <returns type="Excel.NamedItem"></returns>
  7677. }
  7678. return NamedItemCollection;
  7679. })(OfficeExtension.ClientObject);
  7680. Excel.NamedItemCollection = NamedItemCollection;
  7681. })(Excel || (Excel = {__proto__: null}));
  7682. var Excel;
  7683. (function (Excel) {
  7684. /// <summary> [Api set: ExcelApi 1.1] </summary>
  7685. var NamedItemType = {
  7686. __proto__: null,
  7687. "string": "string",
  7688. "integer": "integer",
  7689. "double": "double",
  7690. "boolean": "boolean",
  7691. "range": "range",
  7692. }
  7693. Excel.NamedItemType = NamedItemType;
  7694. })(Excel || (Excel = {__proto__: null}));
  7695. var Excel;
  7696. (function (Excel) {
  7697. var PivotTable = (function(_super) {
  7698. __extends(PivotTable, _super);
  7699. function PivotTable() {
  7700. /// <summary> Represents an Excel PivotTable. [Api set: ExcelApi 1.3] </summary>
  7701. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  7702. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  7703. /// <field name="name" type="String">Name of the PivotTable. [Api set: ExcelApi 1.3]</field>
  7704. /// <field name="worksheet" type="Excel.Worksheet">The worksheet containing the current PivotTable. Read-only. [Api set: ExcelApi 1.3]</field>
  7705. }
  7706. PivotTable.prototype.load = function(option) {
  7707. /// <summary>
  7708. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  7709. /// </summary>
  7710. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  7711. /// <returns type="Excel.PivotTable"/>
  7712. }
  7713. PivotTable.prototype.refresh = function() {
  7714. /// <summary>
  7715. /// Refreshes the PivotTable. [Api set: ExcelApi 1.3]
  7716. /// </summary>
  7717. /// <returns ></returns>
  7718. }
  7719. return PivotTable;
  7720. })(OfficeExtension.ClientObject);
  7721. Excel.PivotTable = PivotTable;
  7722. })(Excel || (Excel = {__proto__: null}));
  7723. var Excel;
  7724. (function (Excel) {
  7725. var PivotTableCollection = (function(_super) {
  7726. __extends(PivotTableCollection, _super);
  7727. function PivotTableCollection() {
  7728. /// <summary> Represents a collection of all the PivotTables that are part of the workbook or worksheet. [Api set: ExcelApi 1.3] </summary>
  7729. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  7730. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  7731. /// <field name="items" type="Array" elementType="Excel.PivotTable">Gets the loaded child items in this collection.</field>
  7732. }
  7733. PivotTableCollection.prototype.load = function(option) {
  7734. /// <summary>
  7735. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  7736. /// </summary>
  7737. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  7738. /// <returns type="Excel.PivotTableCollection"/>
  7739. }
  7740. PivotTableCollection.prototype.getItem = function(name) {
  7741. /// <summary>
  7742. /// Gets a PivotTable by name. [Api set: ExcelApi 1.3]
  7743. /// </summary>
  7744. /// <param name="name" type="String">Name of the PivotTable to be retrieved.</param>
  7745. /// <returns type="Excel.PivotTable"></returns>
  7746. }
  7747. PivotTableCollection.prototype.refreshAll = function() {
  7748. /// <summary>
  7749. /// Refreshes all the PivotTables in the collection. [Api set: ExcelApi 1.3]
  7750. /// </summary>
  7751. /// <returns ></returns>
  7752. }
  7753. return PivotTableCollection;
  7754. })(OfficeExtension.ClientObject);
  7755. Excel.PivotTableCollection = PivotTableCollection;
  7756. })(Excel || (Excel = {__proto__: null}));
  7757. var Excel;
  7758. (function (Excel) {
  7759. var Range = (function(_super) {
  7760. __extends(Range, _super);
  7761. function Range() {
  7762. /// <summary> Range represents a set of one or more contiguous cells such as a cell, a row, a column, block of cells, etc. [Api set: ExcelApi 1.1] </summary>
  7763. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  7764. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  7765. /// <field name="address" type="String">Represents the range reference in A1-style. Address value will contain the Sheet reference (e.g. Sheet1!A1:B4). Read-only. [Api set: ExcelApi 1.1]</field>
  7766. /// <field name="addressLocal" type="String">Represents range reference for the specified range in the language of the user. Read-only. [Api set: ExcelApi 1.1]</field>
  7767. /// <field name="cellCount" type="Number">Number of cells in the range. This API will return -1 if the cell count exceeds 2^31-1 (2,147,483,647). Read-only. [Api set: ExcelApi 1.1]</field>
  7768. /// <field name="columnCount" type="Number">Represents the total number of columns in the range. Read-only. [Api set: ExcelApi 1.1]</field>
  7769. /// <field name="columnHidden" type="Boolean">Represents if all columns of the current range are hidden. [Api set: ExcelApi 1.2]</field>
  7770. /// <field name="columnIndex" type="Number">Represents the column number of the first cell in the range. Zero-indexed. Read-only. [Api set: ExcelApi 1.1]</field>
  7771. /// <field name="format" type="Excel.RangeFormat">Returns a format object, encapsulating the range&apos;s font, fill, borders, alignment, and other properties. Read-only. [Api set: ExcelApi 1.1]</field>
  7772. /// <field name="formulas" type="Array" elementType="Array">Represents the formula in A1-style notation. [Api set: ExcelApi 1.1]</field>
  7773. /// <field name="formulasLocal" type="Array" elementType="Array">Represents the formula in A1-style notation, in the user&apos;s language and number-formatting locale. For example, the English &quot;=SUM(A1, 1.5)&quot; formula would become &quot;=SUMME(A1; 1,5)&quot; in German. [Api set: ExcelApi 1.1]</field>
  7774. /// <field name="formulasR1C1" type="Array" elementType="Array">Represents the formula in R1C1-style notation. [Api set: ExcelApi 1.2]</field>
  7775. /// <field name="hidden" type="Boolean">Represents if all cells of the current range are hidden. [Api set: ExcelApi 1.2]</field>
  7776. /// <field name="numberFormat" type="Array" elementType="Array">Represents Excel&apos;s number format code for the given cell. [Api set: ExcelApi 1.1]</field>
  7777. /// <field name="rowCount" type="Number">Returns the total number of rows in the range. Read-only. [Api set: ExcelApi 1.1]</field>
  7778. /// <field name="rowHidden" type="Boolean">Represents if all rows of the current range are hidden. [Api set: ExcelApi 1.2]</field>
  7779. /// <field name="rowIndex" type="Number">Returns the row number of the first cell in the range. Zero-indexed. Read-only. [Api set: ExcelApi 1.1]</field>
  7780. /// <field name="sort" type="Excel.RangeSort">Represents the range sort of the current range. [Api set: ExcelApi 1.2]</field>
  7781. /// <field name="text" type="Array" elementType="Array">Text values of the specified range. The Text value will not depend on the cell width. The # sign substitution that happens in Excel UI will not affect the text value returned by the API. Read-only. [Api set: ExcelApi 1.1]</field>
  7782. /// <field name="valueTypes" type="Array" elementType="Array">Represents the type of data of each cell. Read-only. [Api set: ExcelApi 1.1]</field>
  7783. /// <field name="values" type="Array" elementType="Array">Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string. [Api set: ExcelApi 1.1]</field>
  7784. /// <field name="worksheet" type="Excel.Worksheet">The worksheet containing the current range. Read-only. [Api set: ExcelApi 1.1]</field>
  7785. }
  7786. Range.prototype.load = function(option) {
  7787. /// <summary>
  7788. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  7789. /// </summary>
  7790. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  7791. /// <returns type="Excel.Range"/>
  7792. }
  7793. Range.prototype.clear = function(applyTo) {
  7794. /// <summary>
  7795. /// Clear range values, format, fill, border, etc. [Api set: ExcelApi 1.1]
  7796. /// </summary>
  7797. /// <param name="applyTo" type="String" optional="true">Determines the type of clear action. See Excel.ClearApplyTo for details.</param>
  7798. /// <returns ></returns>
  7799. }
  7800. Range.prototype.delete = function(shift) {
  7801. /// <summary>
  7802. /// Deletes the cells associated with the range. [Api set: ExcelApi 1.1]
  7803. /// </summary>
  7804. /// <param name="shift" type="String">Specifies which way to shift the cells. See Excel.DeleteShiftDirection for details.</param>
  7805. /// <returns ></returns>
  7806. }
  7807. Range.prototype.getBoundingRect = function(anotherRange) {
  7808. /// <summary>
  7809. /// Gets the smallest range object that encompasses the given ranges. For example, the GetBoundingRect of &quot;B2:C5&quot; and &quot;D10:E15&quot; is &quot;B2:E16&quot;. [Api set: ExcelApi 1.1]
  7810. /// </summary>
  7811. /// <param name="anotherRange" >The range object or address or range name.</param>
  7812. /// <returns type="Excel.Range"></returns>
  7813. }
  7814. Range.prototype.getCell = function(row, column) {
  7815. /// <summary>
  7816. /// Gets the range object containing the single cell based on row and column numbers. The cell can be outside the bounds of its parent range, so long as it&apos;s stays within the worksheet grid. The returned cell is located relative to the top left cell of the range. [Api set: ExcelApi 1.1]
  7817. /// </summary>
  7818. /// <param name="row" type="Number">Row number of the cell to be retrieved. Zero-indexed.</param>
  7819. /// <param name="column" type="Number">Column number of the cell to be retrieved. Zero-indexed.</param>
  7820. /// <returns type="Excel.Range"></returns>
  7821. }
  7822. Range.prototype.getColumn = function(column) {
  7823. /// <summary>
  7824. /// Gets a column contained in the range. [Api set: ExcelApi 1.1]
  7825. /// </summary>
  7826. /// <param name="column" type="Number">Column number of the range to be retrieved. Zero-indexed.</param>
  7827. /// <returns type="Excel.Range"></returns>
  7828. }
  7829. Range.prototype.getColumnsAfter = function(count) {
  7830. /// <summary>
  7831. /// Gets a certain number of columns to the right of the current Range object. [Api set: ExcelApi 1.2]
  7832. /// </summary>
  7833. /// <param name="count" type="Number" optional="true">The number of columns to include in the resulting range. In general, use a positive number to create a range outside the current range. You can also use a negative number to create a range within the current range. The default value is 1.</param>
  7834. /// <returns type="Excel.Range"></returns>
  7835. }
  7836. Range.prototype.getColumnsBefore = function(count) {
  7837. /// <summary>
  7838. /// Gets a certain number of columns to the left of the current Range object. [Api set: ExcelApi 1.2]
  7839. /// </summary>
  7840. /// <param name="count" type="Number" optional="true">The number of columns to include in the resulting range. In general, use a positive number to create a range outside the current range. You can also use a negative number to create a range within the current range. The default value is 1.</param>
  7841. /// <returns type="Excel.Range"></returns>
  7842. }
  7843. Range.prototype.getEntireColumn = function() {
  7844. /// <summary>
  7845. /// Gets an object that represents the entire column of the range. [Api set: ExcelApi 1.1]
  7846. /// </summary>
  7847. /// <returns type="Excel.Range"></returns>
  7848. }
  7849. Range.prototype.getEntireRow = function() {
  7850. /// <summary>
  7851. /// Gets an object that represents the entire row of the range. [Api set: ExcelApi 1.1]
  7852. /// </summary>
  7853. /// <returns type="Excel.Range"></returns>
  7854. }
  7855. Range.prototype.getIntersection = function(anotherRange) {
  7856. /// <summary>
  7857. /// Gets the range object that represents the rectangular intersection of the given ranges. [Api set: ExcelApi 1.1]
  7858. /// </summary>
  7859. /// <param name="anotherRange" >The range object or range address that will be used to determine the intersection of ranges.</param>
  7860. /// <returns type="Excel.Range"></returns>
  7861. }
  7862. Range.prototype.getLastCell = function() {
  7863. /// <summary>
  7864. /// Gets the last cell within the range. For example, the last cell of &quot;B2:D5&quot; is &quot;D5&quot;. [Api set: ExcelApi 1.1]
  7865. /// </summary>
  7866. /// <returns type="Excel.Range"></returns>
  7867. }
  7868. Range.prototype.getLastColumn = function() {
  7869. /// <summary>
  7870. /// Gets the last column within the range. For example, the last column of &quot;B2:D5&quot; is &quot;D2:D5&quot;. [Api set: ExcelApi 1.1]
  7871. /// </summary>
  7872. /// <returns type="Excel.Range"></returns>
  7873. }
  7874. Range.prototype.getLastRow = function() {
  7875. /// <summary>
  7876. /// Gets the last row within the range. For example, the last row of &quot;B2:D5&quot; is &quot;B5:D5&quot;. [Api set: ExcelApi 1.1]
  7877. /// </summary>
  7878. /// <returns type="Excel.Range"></returns>
  7879. }
  7880. Range.prototype.getOffsetRange = function(rowOffset, columnOffset) {
  7881. /// <summary>
  7882. /// Gets an object which represents a range that&apos;s offset from the specified range. The dimension of the returned range will match this range. If the resulting range is forced outside the bounds of the worksheet grid, an exception will be thrown. [Api set: ExcelApi 1.1]
  7883. /// </summary>
  7884. /// <param name="rowOffset" type="Number">The number of rows (positive, negative, or 0) by which the range is to be offset. Positive values are offset downward, and negative values are offset upward.</param>
  7885. /// <param name="columnOffset" type="Number">The number of columns (positive, negative, or 0) by which the range is to be offset. Positive values are offset to the right, and negative values are offset to the left.</param>
  7886. /// <returns type="Excel.Range"></returns>
  7887. }
  7888. Range.prototype.getResizedRange = function(deltaRows, deltaColumns) {
  7889. /// <summary>
  7890. /// Gets a Range object similar to the current Range object, but with its bottom-right corner expanded (or contracted) by some number of rows and columns. [Api set: ExcelApi 1.2]
  7891. /// </summary>
  7892. /// <param name="deltaRows" type="Number">The number of rows by which to expand the bottom-right corner, relative to the current range. Use a positive number to expand the range, or a negative number to decrease it.</param>
  7893. /// <param name="deltaColumns" type="Number">The number of columnsby which to expand the bottom-right corner, relative to the current range. Use a positive number to expand the range, or a negative number to decrease it.</param>
  7894. /// <returns type="Excel.Range"></returns>
  7895. }
  7896. Range.prototype.getRow = function(row) {
  7897. /// <summary>
  7898. /// Gets a row contained in the range. [Api set: ExcelApi 1.1]
  7899. /// </summary>
  7900. /// <param name="row" type="Number">Row number of the range to be retrieved. Zero-indexed.</param>
  7901. /// <returns type="Excel.Range"></returns>
  7902. }
  7903. Range.prototype.getRowsAbove = function(count) {
  7904. /// <summary>
  7905. /// Gets a certain number of rows above the current Range object. [Api set: ExcelApi 1.2]
  7906. /// </summary>
  7907. /// <param name="count" type="Number" optional="true">The number of rows to include in the resulting range. In general, use a positive number to create a range outside the current range. You can also use a negative number to create a range within the current range. The default value is 1.</param>
  7908. /// <returns type="Excel.Range"></returns>
  7909. }
  7910. Range.prototype.getRowsBelow = function(count) {
  7911. /// <summary>
  7912. /// Gets a certain number of rows below the current Range object. [Api set: ExcelApi 1.2]
  7913. /// </summary>
  7914. /// <param name="count" type="Number" optional="true">The number of rows to include in the resulting range. In general, use a positive number to create a range outside the current range. You can also use a negative number to create a range within the current range. The default value is 1.</param>
  7915. /// <returns type="Excel.Range"></returns>
  7916. }
  7917. Range.prototype.getUsedRange = function(valuesOnly) {
  7918. /// <summary>
  7919. /// Returns the used range of the given range object. [Api set: ExcelApi 1.1]
  7920. /// </summary>
  7921. /// <param name="valuesOnly" type="Boolean" optional="true">Considers only cells with values as used cells. [Api set: ExcelApi 1.2]</param>
  7922. /// <returns type="Excel.Range"></returns>
  7923. }
  7924. Range.prototype.getVisibleView = function() {
  7925. /// <summary>
  7926. /// Represents the visible rows of the current range. [Api set: ExcelApi 1.3]
  7927. /// </summary>
  7928. /// <returns type="Excel.RangeView"></returns>
  7929. }
  7930. Range.prototype.insert = function(shift) {
  7931. /// <summary>
  7932. /// Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. Returns a new Range object at the now blank space. [Api set: ExcelApi 1.1]
  7933. /// </summary>
  7934. /// <param name="shift" type="String">Specifies which way to shift the cells. See Excel.InsertShiftDirection for details.</param>
  7935. /// <returns type="Excel.Range"></returns>
  7936. }
  7937. Range.prototype.merge = function(across) {
  7938. /// <summary>
  7939. /// Merge the range cells into one region in the worksheet. [Api set: ExcelApi 1.2]
  7940. /// </summary>
  7941. /// <param name="across" type="Boolean" optional="true">Set true to merge cells in each row of the specified range as separate merged cells. The default value is false.</param>
  7942. /// <returns ></returns>
  7943. }
  7944. Range.prototype.select = function() {
  7945. /// <summary>
  7946. /// Selects the specified range in the Excel UI. [Api set: ExcelApi 1.1]
  7947. /// </summary>
  7948. /// <returns ></returns>
  7949. }
  7950. Range.prototype.unmerge = function() {
  7951. /// <summary>
  7952. /// Unmerge the range cells into separate cells. [Api set: ExcelApi 1.2]
  7953. /// </summary>
  7954. /// <returns ></returns>
  7955. }
  7956. Range.prototype.track = function() {
  7957. /// <summary>
  7958. /// Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.
  7959. /// </summary>
  7960. /// <returns type="Excel.Range"/>
  7961. }
  7962. Range.prototype.untrack = function() {
  7963. /// <summary>
  7964. /// Release the memory associated with this object, if has previous been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.
  7965. /// </summary>
  7966. /// <returns type="Excel.Range"/>
  7967. }
  7968. return Range;
  7969. })(OfficeExtension.ClientObject);
  7970. Excel.Range = Range;
  7971. })(Excel || (Excel = {__proto__: null}));
  7972. var Excel;
  7973. (function (Excel) {
  7974. var RangeBorder = (function(_super) {
  7975. __extends(RangeBorder, _super);
  7976. function RangeBorder() {
  7977. /// <summary> Represents the border of an object. [Api set: ExcelApi 1.1] </summary>
  7978. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  7979. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  7980. /// <field name="color" type="String">HTML color code representing the color of the border line, of the form #RRGGBB (e.g. &quot;FFA500&quot;) or as a named HTML color (e.g. &quot;orange&quot;). [Api set: ExcelApi 1.1]</field>
  7981. /// <field name="sideIndex" type="String">Constant value that indicates the specific side of the border. See Excel.BorderIndex for details. Read-only. [Api set: ExcelApi 1.1]</field>
  7982. /// <field name="style" type="String">One of the constants of line style specifying the line style for the border. See Excel.BorderLineStyle for details. [Api set: ExcelApi 1.1]</field>
  7983. /// <field name="weight" type="String">Specifies the weight of the border around a range. See Excel.BorderWeight for details. [Api set: ExcelApi 1.1]</field>
  7984. }
  7985. RangeBorder.prototype.load = function(option) {
  7986. /// <summary>
  7987. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  7988. /// </summary>
  7989. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  7990. /// <returns type="Excel.RangeBorder"/>
  7991. }
  7992. return RangeBorder;
  7993. })(OfficeExtension.ClientObject);
  7994. Excel.RangeBorder = RangeBorder;
  7995. })(Excel || (Excel = {__proto__: null}));
  7996. var Excel;
  7997. (function (Excel) {
  7998. var RangeBorderCollection = (function(_super) {
  7999. __extends(RangeBorderCollection, _super);
  8000. function RangeBorderCollection() {
  8001. /// <summary> Represents the border objects that make up range border. [Api set: ExcelApi 1.1] </summary>
  8002. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  8003. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  8004. /// <field name="count" type="Number">Number of border objects in the collection. Read-only. [Api set: ExcelApi 1.1]</field>
  8005. /// <field name="items" type="Array" elementType="Excel.RangeBorder">Gets the loaded child items in this collection.</field>
  8006. }
  8007. RangeBorderCollection.prototype.load = function(option) {
  8008. /// <summary>
  8009. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  8010. /// </summary>
  8011. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  8012. /// <returns type="Excel.RangeBorderCollection"/>
  8013. }
  8014. RangeBorderCollection.prototype.getItem = function(index) {
  8015. /// <summary>
  8016. /// Gets a border object using its name [Api set: ExcelApi 1.1]
  8017. /// </summary>
  8018. /// <param name="index" type="String">Index value of the border object to be retrieved. See Excel.BorderIndex for details.</param>
  8019. /// <returns type="Excel.RangeBorder"></returns>
  8020. }
  8021. RangeBorderCollection.prototype.getItemAt = function(index) {
  8022. /// <summary>
  8023. /// Gets a border object using its index [Api set: ExcelApi 1.1]
  8024. /// </summary>
  8025. /// <param name="index" type="Number">Index value of the object to be retrieved. Zero-indexed.</param>
  8026. /// <returns type="Excel.RangeBorder"></returns>
  8027. }
  8028. return RangeBorderCollection;
  8029. })(OfficeExtension.ClientObject);
  8030. Excel.RangeBorderCollection = RangeBorderCollection;
  8031. })(Excel || (Excel = {__proto__: null}));
  8032. var Excel;
  8033. (function (Excel) {
  8034. var RangeFill = (function(_super) {
  8035. __extends(RangeFill, _super);
  8036. function RangeFill() {
  8037. /// <summary> Represents the background of a range object. [Api set: ExcelApi 1.1] </summary>
  8038. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  8039. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  8040. /// <field name="color" type="String">HTML color code representing the color of the border line, of the form #RRGGBB (e.g. &quot;FFA500&quot;) or as a named HTML color (e.g. &quot;orange&quot;) [Api set: ExcelApi 1.1]</field>
  8041. }
  8042. RangeFill.prototype.load = function(option) {
  8043. /// <summary>
  8044. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  8045. /// </summary>
  8046. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  8047. /// <returns type="Excel.RangeFill"/>
  8048. }
  8049. RangeFill.prototype.clear = function() {
  8050. /// <summary>
  8051. /// Resets the range background. [Api set: ExcelApi 1.1]
  8052. /// </summary>
  8053. /// <returns ></returns>
  8054. }
  8055. return RangeFill;
  8056. })(OfficeExtension.ClientObject);
  8057. Excel.RangeFill = RangeFill;
  8058. })(Excel || (Excel = {__proto__: null}));
  8059. var Excel;
  8060. (function (Excel) {
  8061. var RangeFont = (function(_super) {
  8062. __extends(RangeFont, _super);
  8063. function RangeFont() {
  8064. /// <summary> This object represents the font attributes (font name, font size, color, etc.) for an object. [Api set: ExcelApi 1.1] </summary>
  8065. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  8066. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  8067. /// <field name="bold" type="Boolean">Represents the bold status of font. [Api set: ExcelApi 1.1]</field>
  8068. /// <field name="color" type="String">HTML color code representation of the text color. E.g. #FF0000 represents Red. [Api set: ExcelApi 1.1]</field>
  8069. /// <field name="italic" type="Boolean">Represents the italic status of the font. [Api set: ExcelApi 1.1]</field>
  8070. /// <field name="name" type="String">Font name (e.g. &quot;Calibri&quot;) [Api set: ExcelApi 1.1]</field>
  8071. /// <field name="size" type="Number">Font size. [Api set: ExcelApi 1.1]</field>
  8072. /// <field name="underline" type="String">Type of underline applied to the font. See Excel.RangeUnderlineStyle for details. [Api set: ExcelApi 1.1]</field>
  8073. }
  8074. RangeFont.prototype.load = function(option) {
  8075. /// <summary>
  8076. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  8077. /// </summary>
  8078. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  8079. /// <returns type="Excel.RangeFont"/>
  8080. }
  8081. return RangeFont;
  8082. })(OfficeExtension.ClientObject);
  8083. Excel.RangeFont = RangeFont;
  8084. })(Excel || (Excel = {__proto__: null}));
  8085. var Excel;
  8086. (function (Excel) {
  8087. var RangeFormat = (function(_super) {
  8088. __extends(RangeFormat, _super);
  8089. function RangeFormat() {
  8090. /// <summary> A format object encapsulating the range&apos;s font, fill, borders, alignment, and other properties. [Api set: ExcelApi 1.1] </summary>
  8091. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  8092. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  8093. /// <field name="borders" type="Excel.RangeBorderCollection">Collection of border objects that apply to the overall range. Read-only. [Api set: ExcelApi 1.1]</field>
  8094. /// <field name="columnWidth" type="Number">Gets or sets the width of all colums within the range. If the column widths are not uniform, null will be returned. [Api set: ExcelApi 1.2]</field>
  8095. /// <field name="fill" type="Excel.RangeFill">Returns the fill object defined on the overall range. Read-only. [Api set: ExcelApi 1.1]</field>
  8096. /// <field name="font" type="Excel.RangeFont">Returns the font object defined on the overall range. Read-only. [Api set: ExcelApi 1.1]</field>
  8097. /// <field name="horizontalAlignment" type="String">Represents the horizontal alignment for the specified object. See Excel.HorizontalAlignment for details. [Api set: ExcelApi 1.1]</field>
  8098. /// <field name="protection" type="Excel.FormatProtection">Returns the format protection object for a range. [Api set: ExcelApi 1.2]</field>
  8099. /// <field name="rowHeight" type="Number">Gets or sets the height of all rows in the range. If the row heights are not uniform null will be returned. [Api set: ExcelApi 1.2]</field>
  8100. /// <field name="verticalAlignment" type="String">Represents the vertical alignment for the specified object. See Excel.VerticalAlignment for details. [Api set: ExcelApi 1.1]</field>
  8101. /// <field name="wrapText" type="Boolean">Indicates if Excel wraps the text in the object. A null value indicates that the entire range doesn&apos;t have uniform wrap setting [Api set: ExcelApi 1.1]</field>
  8102. }
  8103. RangeFormat.prototype.load = function(option) {
  8104. /// <summary>
  8105. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  8106. /// </summary>
  8107. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  8108. /// <returns type="Excel.RangeFormat"/>
  8109. }
  8110. RangeFormat.prototype.autofitColumns = function() {
  8111. /// <summary>
  8112. /// Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. [Api set: ExcelApi 1.2]
  8113. /// </summary>
  8114. /// <returns ></returns>
  8115. }
  8116. RangeFormat.prototype.autofitRows = function() {
  8117. /// <summary>
  8118. /// Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns. [Api set: ExcelApi 1.2]
  8119. /// </summary>
  8120. /// <returns ></returns>
  8121. }
  8122. return RangeFormat;
  8123. })(OfficeExtension.ClientObject);
  8124. Excel.RangeFormat = RangeFormat;
  8125. })(Excel || (Excel = {__proto__: null}));
  8126. var Excel;
  8127. (function (Excel) {
  8128. var Interfaces;
  8129. (function (Interfaces) {
  8130. var RangeReference = (function() {
  8131. function RangeReference() {
  8132. /// <summary> Represents a string reference of the form SheetName!A1:B5, or a global or local named range [Api set: ExcelApi 1.2] </summary>
  8133. /// <field name="address" type="String"> [Api set: ExcelApi 1.2]</field>
  8134. }
  8135. return RangeReference;
  8136. })();
  8137. Interfaces.RangeReference.__proto__ = null;
  8138. Interfaces.RangeReference = RangeReference;
  8139. })(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
  8140. })(Excel || (Excel = {__proto__: null}));
  8141. var Excel;
  8142. (function (Excel) {
  8143. var RangeSort = (function(_super) {
  8144. __extends(RangeSort, _super);
  8145. function RangeSort() {
  8146. /// <summary> Manages sorting operations on Range objects. [Api set: ExcelApi 1.2] </summary>
  8147. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  8148. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  8149. }
  8150. RangeSort.prototype.load = function(option) {
  8151. /// <summary>
  8152. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  8153. /// </summary>
  8154. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  8155. /// <returns type="Excel.RangeSort"/>
  8156. }
  8157. RangeSort.prototype.apply = function(fields, matchCase, hasHeaders, orientation, method) {
  8158. /// <summary>
  8159. /// Perform a sort operation. [Api set: ExcelApi 1.2]
  8160. /// </summary>
  8161. /// <param name="fields" type="Array" elementType="Excel.Interfaces.SortField">The list of conditions to sort on.</param>
  8162. /// <param name="matchCase" type="Boolean" optional="true">Whether to have the casing impact string ordering.</param>
  8163. /// <param name="hasHeaders" type="Boolean" optional="true">Whether the range has a header.</param>
  8164. /// <param name="orientation" type="String" optional="true">Whether the operation is sorting rows or columns.</param>
  8165. /// <param name="method" type="String" optional="true">The ordering method used for Chinese characters.</param>
  8166. /// <returns ></returns>
  8167. }
  8168. return RangeSort;
  8169. })(OfficeExtension.ClientObject);
  8170. Excel.RangeSort = RangeSort;
  8171. })(Excel || (Excel = {__proto__: null}));
  8172. var Excel;
  8173. (function (Excel) {
  8174. /// <summary> [Api set: ExcelApi 1.1] </summary>
  8175. var RangeUnderlineStyle = {
  8176. __proto__: null,
  8177. "none": "none",
  8178. "single": "single",
  8179. "double": "double",
  8180. "singleAccountant": "singleAccountant",
  8181. "doubleAccountant": "doubleAccountant",
  8182. }
  8183. Excel.RangeUnderlineStyle = RangeUnderlineStyle;
  8184. })(Excel || (Excel = {__proto__: null}));
  8185. var Excel;
  8186. (function (Excel) {
  8187. /// <summary> [Api set: ExcelApi 1.1] </summary>
  8188. var RangeValueType = {
  8189. __proto__: null,
  8190. "unknown": "unknown",
  8191. "empty": "empty",
  8192. "string": "string",
  8193. "integer": "integer",
  8194. "double": "double",
  8195. "boolean": "boolean",
  8196. "error": "error",
  8197. }
  8198. Excel.RangeValueType = RangeValueType;
  8199. })(Excel || (Excel = {__proto__: null}));
  8200. var Excel;
  8201. (function (Excel) {
  8202. var RangeView = (function(_super) {
  8203. __extends(RangeView, _super);
  8204. function RangeView() {
  8205. /// <summary> RangeView represents a set of visible cells of the parent range. [Api set: ExcelApi 1.3] </summary>
  8206. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  8207. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  8208. /// <field name="cellAddresses" type="Array" elementType="Array">Represents the cell addresses of the RangeView. [Api set: ExcelApi 1.3]</field>
  8209. /// <field name="columnCount" type="Number">Returns the number of visible columns. Read-only. [Api set: ExcelApi 1.3]</field>
  8210. /// <field name="formulas" type="Array" elementType="Array">Represents the formula in A1-style notation. [Api set: ExcelApi 1.3]</field>
  8211. /// <field name="formulasLocal" type="Array" elementType="Array">Represents the formula in A1-style notation, in the user&apos;s language and number-formatting locale. For example, the English &quot;=SUM(A1, 1.5)&quot; formula would become &quot;=SUMME(A1; 1,5)&quot; in German. [Api set: ExcelApi 1.3]</field>
  8212. /// <field name="formulasR1C1" type="Array" elementType="Array">Represents the formula in R1C1-style notation. [Api set: ExcelApi 1.3]</field>
  8213. /// <field name="index" type="Number">Returns a value that represents the index of the RangeView. Read-only. [Api set: ExcelApi 1.3]</field>
  8214. /// <field name="numberFormat" type="Array" elementType="Array">Represents Excel&apos;s number format code for the given cell. [Api set: ExcelApi 1.3]</field>
  8215. /// <field name="rowCount" type="Number">Returns the number of visible rows. Read-only. [Api set: ExcelApi 1.3]</field>
  8216. /// <field name="rows" type="Excel.RangeViewCollection">Represents a collection of range views associated with the range. Read-only. [Api set: ExcelApi 1.3]</field>
  8217. /// <field name="text" type="Array" elementType="Array">Text values of the specified range. The Text value will not depend on the cell width. The # sign substitution that happens in Excel UI will not affect the text value returned by the API. Read-only. [Api set: ExcelApi 1.3]</field>
  8218. /// <field name="valueTypes" type="Array" elementType="Array">Represents the type of data of each cell. Read-only. [Api set: ExcelApi 1.3]</field>
  8219. /// <field name="values" type="Array" elementType="Array">Represents the raw values of the specified range view. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string. [Api set: ExcelApi 1.3]</field>
  8220. }
  8221. RangeView.prototype.load = function(option) {
  8222. /// <summary>
  8223. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  8224. /// </summary>
  8225. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  8226. /// <returns type="Excel.RangeView"/>
  8227. }
  8228. RangeView.prototype.getRange = function() {
  8229. /// <summary>
  8230. /// Gets the parent range associated with the current RangeView. [Api set: ExcelApi 1.3]
  8231. /// </summary>
  8232. /// <returns type="Excel.Range"></returns>
  8233. }
  8234. return RangeView;
  8235. })(OfficeExtension.ClientObject);
  8236. Excel.RangeView = RangeView;
  8237. })(Excel || (Excel = {__proto__: null}));
  8238. var Excel;
  8239. (function (Excel) {
  8240. var RangeViewCollection = (function(_super) {
  8241. __extends(RangeViewCollection, _super);
  8242. function RangeViewCollection() {
  8243. /// <summary> Represents a collection of worksheet objects that are part of the workbook. [Api set: ExcelApi 1.3] </summary>
  8244. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  8245. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  8246. /// <field name="items" type="Array" elementType="Excel.RangeView">Gets the loaded child items in this collection.</field>
  8247. }
  8248. RangeViewCollection.prototype.load = function(option) {
  8249. /// <summary>
  8250. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  8251. /// </summary>
  8252. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  8253. /// <returns type="Excel.RangeViewCollection"/>
  8254. }
  8255. RangeViewCollection.prototype.getItemAt = function(index) {
  8256. /// <summary>
  8257. /// Gets a RangeView Row via it&apos;s index. Zero-Indexed. [Api set: ExcelApi 1.3]
  8258. /// </summary>
  8259. /// <param name="index" type="Number">Index of the visible row.</param>
  8260. /// <returns type="Excel.RangeView"></returns>
  8261. }
  8262. return RangeViewCollection;
  8263. })(OfficeExtension.ClientObject);
  8264. Excel.RangeViewCollection = RangeViewCollection;
  8265. })(Excel || (Excel = {__proto__: null}));
  8266. var Excel;
  8267. (function (Excel) {
  8268. var Interfaces;
  8269. (function (Interfaces) {
  8270. var SelectionChangedEventArgs = (function() {
  8271. function SelectionChangedEventArgs() {
  8272. /// <summary> Provides information about the document that raised the SelectionChanged event. [Api set: ExcelApi 1.2] </summary>
  8273. /// <field name="workbook" type="Excel.Workbook">Gets the workbook object that raised the SelectionChanged event. [Api set: ExcelApi 1.2]</field>
  8274. }
  8275. return SelectionChangedEventArgs;
  8276. })();
  8277. Interfaces.SelectionChangedEventArgs.__proto__ = null;
  8278. Interfaces.SelectionChangedEventArgs = SelectionChangedEventArgs;
  8279. })(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
  8280. })(Excel || (Excel = {__proto__: null}));
  8281. var Excel;
  8282. (function (Excel) {
  8283. var Setting = (function(_super) {
  8284. __extends(Setting, _super);
  8285. function Setting() {
  8286. /// <summary> Setting represents a key-value pair of a setting persisted to the document. [Api set: ExcelApi 1.3] </summary>
  8287. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  8288. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  8289. /// <field name="key" type="String">Returns the key that represents the id of the Setting. Read-only. [Api set: ExcelApi 1.3]</field>
  8290. }
  8291. Setting.prototype.load = function(option) {
  8292. /// <summary>
  8293. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  8294. /// </summary>
  8295. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  8296. /// <returns type="Excel.Setting"/>
  8297. }
  8298. Setting.prototype.delete = function() {
  8299. /// <summary>
  8300. /// Deletes the setting. [Api set: ExcelApi 1.3]
  8301. /// </summary>
  8302. /// <returns ></returns>
  8303. }
  8304. return Setting;
  8305. })(OfficeExtension.ClientObject);
  8306. Excel.Setting = Setting;
  8307. })(Excel || (Excel = {__proto__: null}));
  8308. var Excel;
  8309. (function (Excel) {
  8310. /// <summary> [Api set: ExcelApi 1.1] </summary>
  8311. var SheetVisibility = {
  8312. __proto__: null,
  8313. "visible": "visible",
  8314. "hidden": "hidden",
  8315. "veryHidden": "veryHidden",
  8316. }
  8317. Excel.SheetVisibility = SheetVisibility;
  8318. })(Excel || (Excel = {__proto__: null}));
  8319. var Excel;
  8320. (function (Excel) {
  8321. /// <summary> [Api set: ExcelApi 1.2] </summary>
  8322. var SortDataOption = {
  8323. __proto__: null,
  8324. "normal": "normal",
  8325. "textAsNumber": "textAsNumber",
  8326. }
  8327. Excel.SortDataOption = SortDataOption;
  8328. })(Excel || (Excel = {__proto__: null}));
  8329. var Excel;
  8330. (function (Excel) {
  8331. var Interfaces;
  8332. (function (Interfaces) {
  8333. var SortField = (function() {
  8334. function SortField() {
  8335. /// <summary> Represents a condition in a sorting operation. [Api set: ExcelApi 1.2] </summary>
  8336. /// <field name="ascending" type="Boolean">Represents whether the sorting is done in an ascending fashion. [Api set: ExcelApi 1.2]</field>
  8337. /// <field name="color" type="String">Represents the color that is the target of the condition if the sorting is on font or cell color. [Api set: ExcelApi 1.2]</field>
  8338. /// <field name="dataOption" type="String">Represents additional sorting options for this field. [Api set: ExcelApi 1.2]</field>
  8339. /// <field name="icon" type="Excel.Interfaces.Icon">Represents the icon that is the target of the condition if the sorting is on the cell&apos;s icon. [Api set: ExcelApi 1.2]</field>
  8340. /// <field name="key" type="Number">Represents the column (or row, depending on the sort orientation) that the condition is on. Represented as an offset from the first column (or row). [Api set: ExcelApi 1.2]</field>
  8341. /// <field name="sortOn" type="String">Represents the type of sorting of this condition. [Api set: ExcelApi 1.2]</field>
  8342. }
  8343. return SortField;
  8344. })();
  8345. Interfaces.SortField.__proto__ = null;
  8346. Interfaces.SortField = SortField;
  8347. })(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
  8348. })(Excel || (Excel = {__proto__: null}));
  8349. var Excel;
  8350. (function (Excel) {
  8351. /// <summary> [Api set: ExcelApi 1.2] </summary>
  8352. var SortMethod = {
  8353. __proto__: null,
  8354. "pinYin": "pinYin",
  8355. "strokeCount": "strokeCount",
  8356. }
  8357. Excel.SortMethod = SortMethod;
  8358. })(Excel || (Excel = {__proto__: null}));
  8359. var Excel;
  8360. (function (Excel) {
  8361. /// <summary> [Api set: ExcelApi 1.2] </summary>
  8362. var SortOn = {
  8363. __proto__: null,
  8364. "value": "value",
  8365. "cellColor": "cellColor",
  8366. "fontColor": "fontColor",
  8367. "icon": "icon",
  8368. }
  8369. Excel.SortOn = SortOn;
  8370. })(Excel || (Excel = {__proto__: null}));
  8371. var Excel;
  8372. (function (Excel) {
  8373. /// <summary> [Api set: ExcelApi 1.2] </summary>
  8374. var SortOrientation = {
  8375. __proto__: null,
  8376. "rows": "rows",
  8377. "columns": "columns",
  8378. }
  8379. Excel.SortOrientation = SortOrientation;
  8380. })(Excel || (Excel = {__proto__: null}));
  8381. var Excel;
  8382. (function (Excel) {
  8383. var Table = (function(_super) {
  8384. __extends(Table, _super);
  8385. function Table() {
  8386. /// <summary> Represents an Excel table. [Api set: ExcelApi 1.1] </summary>
  8387. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  8388. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  8389. /// <field name="columns" type="Excel.TableColumnCollection">Represents a collection of all the columns in the table. Read-only. [Api set: ExcelApi 1.1]</field>
  8390. /// <field name="highlightFirstColumn" type="Boolean">Indicates whether the first column contains special formatting. [Api set: ExcelApi 1.3]</field>
  8391. /// <field name="highlightLastColumn" type="Boolean">Indicates whether the last column contains special formatting. [Api set: ExcelApi 1.3]</field>
  8392. /// <field name="id" type="Number">Returns a value that uniquely identifies the table in a given workbook. The value of the identifier remains the same even when the table is renamed. Read-only. [Api set: ExcelApi 1.1]</field>
  8393. /// <field name="name" type="String">Name of the table. [Api set: ExcelApi 1.1]</field>
  8394. /// <field name="rows" type="Excel.TableRowCollection">Represents a collection of all the rows in the table. Read-only. [Api set: ExcelApi 1.1]</field>
  8395. /// <field name="showBandedColumns" type="Boolean">Indicates whether the columns show banded formatting in which odd columns are highlighted differently from even ones to make reading the table easier. [Api set: ExcelApi 1.3]</field>
  8396. /// <field name="showBandedRows" type="Boolean">Indicates whether the rows show banded formatting in which odd rows are highlighted differently from even ones to make reading the table easier. [Api set: ExcelApi 1.3]</field>
  8397. /// <field name="showFilterButton" type="Boolean">Indicates whether the filter buttons are visible at the top of each column header. Setting this is only allowed if the table contains a header row. [Api set: ExcelApi 1.3]</field>
  8398. /// <field name="showHeaders" type="Boolean">Indicates whether the header row is visible or not. This value can be set to show or remove the header row. [Api set: ExcelApi 1.1]</field>
  8399. /// <field name="showTotals" type="Boolean">Indicates whether the total row is visible or not. This value can be set to show or remove the total row. [Api set: ExcelApi 1.1]</field>
  8400. /// <field name="sort" type="Excel.TableSort">Represents the sorting for the table. [Api set: ExcelApi 1.2]</field>
  8401. /// <field name="style" type="String">Constant value that represents the Table style. Possible values are: TableStyleLight1 thru TableStyleLight21, TableStyleMedium1 thru TableStyleMedium28, TableStyleStyleDark1 thru TableStyleStyleDark11. A custom user-defined style present in the workbook can also be specified. [Api set: ExcelApi 1.1]</field>
  8402. /// <field name="worksheet" type="Excel.Worksheet">The worksheet containing the current table. Read-only. [Api set: ExcelApi 1.2]</field>
  8403. }
  8404. Table.prototype.load = function(option) {
  8405. /// <summary>
  8406. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  8407. /// </summary>
  8408. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  8409. /// <returns type="Excel.Table"/>
  8410. }
  8411. Table.prototype.clearFilters = function() {
  8412. /// <summary>
  8413. /// Clears all the filters currently applied on the table. [Api set: ExcelApi 1.2]
  8414. /// </summary>
  8415. /// <returns ></returns>
  8416. }
  8417. Table.prototype.convertToRange = function() {
  8418. /// <summary>
  8419. /// Converts the table into a normal range of cells. All data is preserved. [Api set: ExcelApi 1.2]
  8420. /// </summary>
  8421. /// <returns type="Excel.Range"></returns>
  8422. }
  8423. Table.prototype.delete = function() {
  8424. /// <summary>
  8425. /// Deletes the table. [Api set: ExcelApi 1.1]
  8426. /// </summary>
  8427. /// <returns ></returns>
  8428. }
  8429. Table.prototype.getDataBodyRange = function() {
  8430. /// <summary>
  8431. /// Gets the range object associated with the data body of the table. [Api set: ExcelApi 1.1]
  8432. /// </summary>
  8433. /// <returns type="Excel.Range"></returns>
  8434. }
  8435. Table.prototype.getHeaderRowRange = function() {
  8436. /// <summary>
  8437. /// Gets the range object associated with header row of the table. [Api set: ExcelApi 1.1]
  8438. /// </summary>
  8439. /// <returns type="Excel.Range"></returns>
  8440. }
  8441. Table.prototype.getRange = function() {
  8442. /// <summary>
  8443. /// Gets the range object associated with the entire table. [Api set: ExcelApi 1.1]
  8444. /// </summary>
  8445. /// <returns type="Excel.Range"></returns>
  8446. }
  8447. Table.prototype.getTotalRowRange = function() {
  8448. /// <summary>
  8449. /// Gets the range object associated with totals row of the table. [Api set: ExcelApi 1.1]
  8450. /// </summary>
  8451. /// <returns type="Excel.Range"></returns>
  8452. }
  8453. Table.prototype.reapplyFilters = function() {
  8454. /// <summary>
  8455. /// Reapplies all the filters currently on the table. [Api set: ExcelApi 1.2]
  8456. /// </summary>
  8457. /// <returns ></returns>
  8458. }
  8459. return Table;
  8460. })(OfficeExtension.ClientObject);
  8461. Excel.Table = Table;
  8462. })(Excel || (Excel = {__proto__: null}));
  8463. var Excel;
  8464. (function (Excel) {
  8465. var TableCollection = (function(_super) {
  8466. __extends(TableCollection, _super);
  8467. function TableCollection() {
  8468. /// <summary> Represents a collection of all the tables that are part of the workbook. [Api set: ExcelApi 1.1] </summary>
  8469. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  8470. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  8471. /// <field name="count" type="Number">Returns the number of tables in the workbook. Read-only. [Api set: ExcelApi 1.1]</field>
  8472. /// <field name="items" type="Array" elementType="Excel.Table">Gets the loaded child items in this collection.</field>
  8473. }
  8474. TableCollection.prototype.load = function(option) {
  8475. /// <summary>
  8476. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  8477. /// </summary>
  8478. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  8479. /// <returns type="Excel.TableCollection"/>
  8480. }
  8481. TableCollection.prototype.add = function(address, hasHeaders) {
  8482. /// <summary>
  8483. /// Create a new table. The range object or source address determines the worksheet under which the table will be added. If the table cannot be added (e.g., because the address is invalid, or the table would overlap with another table), an error will be thrown. [Api set: ExcelApi 1.1]
  8484. /// </summary>
  8485. /// <param name="address" >A Range object, or a string address or name of the range representing the data source. If the address does not contain a sheet name, the currently-active sheet is used. [Api set: ExcelApi 1.1 for string parameter; 1.3 for accepting a Range object as well]</param>
  8486. /// <param name="hasHeaders" type="Boolean">Boolean value that indicates whether the data being imported has column labels. If the source does not contain headers (i.e,. when this property set to false), Excel will automatically generate header shifting the data down by one row.</param>
  8487. /// <returns type="Excel.Table"></returns>
  8488. }
  8489. TableCollection.prototype.getItem = function(key) {
  8490. /// <summary>
  8491. /// Gets a table by Name or ID. [Api set: ExcelApi 1.1]
  8492. /// </summary>
  8493. /// <param name="key" >Name or ID of the table to be retrieved.</param>
  8494. /// <returns type="Excel.Table"></returns>
  8495. }
  8496. TableCollection.prototype.getItemAt = function(index) {
  8497. /// <summary>
  8498. /// Gets a table based on its position in the collection. [Api set: ExcelApi 1.1]
  8499. /// </summary>
  8500. /// <param name="index" type="Number">Index value of the object to be retrieved. Zero-indexed.</param>
  8501. /// <returns type="Excel.Table"></returns>
  8502. }
  8503. return TableCollection;
  8504. })(OfficeExtension.ClientObject);
  8505. Excel.TableCollection = TableCollection;
  8506. })(Excel || (Excel = {__proto__: null}));
  8507. var Excel;
  8508. (function (Excel) {
  8509. var TableColumn = (function(_super) {
  8510. __extends(TableColumn, _super);
  8511. function TableColumn() {
  8512. /// <summary> Represents a column in a table. [Api set: ExcelApi 1.1] </summary>
  8513. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  8514. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  8515. /// <field name="filter" type="Excel.Filter">Retrieve the filter applied to the column. [Api set: ExcelApi 1.2]</field>
  8516. /// <field name="id" type="Number">Returns a unique key that identifies the column within the table. Read-only. [Api set: ExcelApi 1.1]</field>
  8517. /// <field name="index" type="Number">Returns the index number of the column within the columns collection of the table. Zero-indexed. Read-only. [Api set: ExcelApi 1.1]</field>
  8518. /// <field name="name" type="String">Returns the name of the table column. Read-only. [Api set: ExcelApi 1.1]</field>
  8519. /// <field name="values" type="Array" elementType="Array">Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string. [Api set: ExcelApi 1.1]</field>
  8520. }
  8521. TableColumn.prototype.load = function(option) {
  8522. /// <summary>
  8523. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  8524. /// </summary>
  8525. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  8526. /// <returns type="Excel.TableColumn"/>
  8527. }
  8528. TableColumn.prototype.delete = function() {
  8529. /// <summary>
  8530. /// Deletes the column from the table. [Api set: ExcelApi 1.1]
  8531. /// </summary>
  8532. /// <returns ></returns>
  8533. }
  8534. TableColumn.prototype.getDataBodyRange = function() {
  8535. /// <summary>
  8536. /// Gets the range object associated with the data body of the column. [Api set: ExcelApi 1.1]
  8537. /// </summary>
  8538. /// <returns type="Excel.Range"></returns>
  8539. }
  8540. TableColumn.prototype.getHeaderRowRange = function() {
  8541. /// <summary>
  8542. /// Gets the range object associated with the header row of the column. [Api set: ExcelApi 1.1]
  8543. /// </summary>
  8544. /// <returns type="Excel.Range"></returns>
  8545. }
  8546. TableColumn.prototype.getRange = function() {
  8547. /// <summary>
  8548. /// Gets the range object associated with the entire column. [Api set: ExcelApi 1.1]
  8549. /// </summary>
  8550. /// <returns type="Excel.Range"></returns>
  8551. }
  8552. TableColumn.prototype.getTotalRowRange = function() {
  8553. /// <summary>
  8554. /// Gets the range object associated with the totals row of the column. [Api set: ExcelApi 1.1]
  8555. /// </summary>
  8556. /// <returns type="Excel.Range"></returns>
  8557. }
  8558. return TableColumn;
  8559. })(OfficeExtension.ClientObject);
  8560. Excel.TableColumn = TableColumn;
  8561. })(Excel || (Excel = {__proto__: null}));
  8562. var Excel;
  8563. (function (Excel) {
  8564. var TableColumnCollection = (function(_super) {
  8565. __extends(TableColumnCollection, _super);
  8566. function TableColumnCollection() {
  8567. /// <summary> Represents a collection of all the columns that are part of the table. [Api set: ExcelApi 1.1] </summary>
  8568. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  8569. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  8570. /// <field name="count" type="Number">Returns the number of columns in the table. Read-only. [Api set: ExcelApi 1.1]</field>
  8571. /// <field name="items" type="Array" elementType="Excel.TableColumn">Gets the loaded child items in this collection.</field>
  8572. }
  8573. TableColumnCollection.prototype.load = function(option) {
  8574. /// <summary>
  8575. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  8576. /// </summary>
  8577. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  8578. /// <returns type="Excel.TableColumnCollection"/>
  8579. }
  8580. TableColumnCollection.prototype.add = function(index, values) {
  8581. /// <summary>
  8582. /// Adds a new column to the table. [Api set: ExcelApi 1.1 requires an index smaller than the total column count; 1.4 allows index to be optional (null or -1) and will append a column at the end.]
  8583. /// </summary>
  8584. /// <param name="index" type="Number" optional="true">Specifies the relative position of the new column. If null or -1, the addition happens at the end. Columns with a higher index will be shifted to the side. Zero-indexed.</param>
  8585. /// <param name="values" optional="true">A 2-dimensional array of unformatted values of the table column.</param>
  8586. /// <returns type="Excel.TableColumn"></returns>
  8587. }
  8588. TableColumnCollection.prototype.getItem = function(key) {
  8589. /// <summary>
  8590. /// Gets a column object by Name or ID. [Api set: ExcelApi 1.1]
  8591. /// </summary>
  8592. /// <param name="key" >Column Name or ID.</param>
  8593. /// <returns type="Excel.TableColumn"></returns>
  8594. }
  8595. TableColumnCollection.prototype.getItemAt = function(index) {
  8596. /// <summary>
  8597. /// Gets a column based on its position in the collection. [Api set: ExcelApi 1.1]
  8598. /// </summary>
  8599. /// <param name="index" type="Number">Index value of the object to be retrieved. Zero-indexed.</param>
  8600. /// <returns type="Excel.TableColumn"></returns>
  8601. }
  8602. return TableColumnCollection;
  8603. })(OfficeExtension.ClientObject);
  8604. Excel.TableColumnCollection = TableColumnCollection;
  8605. })(Excel || (Excel = {__proto__: null}));
  8606. var Excel;
  8607. (function (Excel) {
  8608. var TableRow = (function(_super) {
  8609. __extends(TableRow, _super);
  8610. function TableRow() {
  8611. /// <summary> Represents a row in a table. [Api set: ExcelApi 1.1] </summary>
  8612. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  8613. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  8614. /// <field name="index" type="Number">Returns the index number of the row within the rows collection of the table. Zero-indexed. Read-only. [Api set: ExcelApi 1.1]</field>
  8615. /// <field name="values" type="Array" elementType="Array">Represents the raw values of the specified range. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string. [Api set: ExcelApi 1.1]</field>
  8616. }
  8617. TableRow.prototype.load = function(option) {
  8618. /// <summary>
  8619. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  8620. /// </summary>
  8621. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  8622. /// <returns type="Excel.TableRow"/>
  8623. }
  8624. TableRow.prototype.delete = function() {
  8625. /// <summary>
  8626. /// Deletes the row from the table. [Api set: ExcelApi 1.1]
  8627. /// </summary>
  8628. /// <returns ></returns>
  8629. }
  8630. TableRow.prototype.getRange = function() {
  8631. /// <summary>
  8632. /// Returns the range object associated with the entire row. [Api set: ExcelApi 1.1]
  8633. /// </summary>
  8634. /// <returns type="Excel.Range"></returns>
  8635. }
  8636. return TableRow;
  8637. })(OfficeExtension.ClientObject);
  8638. Excel.TableRow = TableRow;
  8639. })(Excel || (Excel = {__proto__: null}));
  8640. var Excel;
  8641. (function (Excel) {
  8642. var TableRowCollection = (function(_super) {
  8643. __extends(TableRowCollection, _super);
  8644. function TableRowCollection() {
  8645. /// <summary> Represents a collection of all the rows that are part of the table. [Api set: ExcelApi 1.1] </summary>
  8646. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  8647. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  8648. /// <field name="count" type="Number">Returns the number of rows in the table. Read-only. [Api set: ExcelApi 1.1]</field>
  8649. /// <field name="items" type="Array" elementType="Excel.TableRow">Gets the loaded child items in this collection.</field>
  8650. }
  8651. TableRowCollection.prototype.load = function(option) {
  8652. /// <summary>
  8653. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  8654. /// </summary>
  8655. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  8656. /// <returns type="Excel.TableRowCollection"/>
  8657. }
  8658. TableRowCollection.prototype.add = function(index, values) {
  8659. /// <summary>
  8660. /// Adds one or more rows to the table. The return object will be the top of the newly added row(s). [Api set: ExcelApi 1.1 for adding a single row; 1.4 allows adding of multiple rows.]
  8661. /// </summary>
  8662. /// <param name="index" type="Number" optional="true">Specifies the relative position of the new row. If null or -1, the addition happens at the end. Any rows below the inserted row are shifted downwards. Zero-indexed.</param>
  8663. /// <param name="values" optional="true">A 2-dimensional array of unformatted values of the table row.</param>
  8664. /// <returns type="Excel.TableRow"></returns>
  8665. }
  8666. TableRowCollection.prototype.getItemAt = function(index) {
  8667. /// <summary>
  8668. /// Gets a row based on its position in the collection. [Api set: ExcelApi 1.1]
  8669. /// </summary>
  8670. /// <param name="index" type="Number">Index value of the object to be retrieved. Zero-indexed.</param>
  8671. /// <returns type="Excel.TableRow"></returns>
  8672. }
  8673. return TableRowCollection;
  8674. })(OfficeExtension.ClientObject);
  8675. Excel.TableRowCollection = TableRowCollection;
  8676. })(Excel || (Excel = {__proto__: null}));
  8677. var Excel;
  8678. (function (Excel) {
  8679. var TableSort = (function(_super) {
  8680. __extends(TableSort, _super);
  8681. function TableSort() {
  8682. /// <summary> Manages sorting operations on Table objects. [Api set: ExcelApi 1.2] </summary>
  8683. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  8684. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  8685. /// <field name="fields" type="Array" elementType="Excel.Interfaces.SortField">Represents the current conditions used to last sort the table. [Api set: ExcelApi 1.2]</field>
  8686. /// <field name="matchCase" type="Boolean">Represents whether the casing impacted the last sort of the table. [Api set: ExcelApi 1.2]</field>
  8687. /// <field name="method" type="String">Represents Chinese character ordering method last used to sort the table. [Api set: ExcelApi 1.2]</field>
  8688. }
  8689. TableSort.prototype.load = function(option) {
  8690. /// <summary>
  8691. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  8692. /// </summary>
  8693. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  8694. /// <returns type="Excel.TableSort"/>
  8695. }
  8696. TableSort.prototype.apply = function(fields, matchCase, method) {
  8697. /// <summary>
  8698. /// Perform a sort operation. [Api set: ExcelApi 1.2]
  8699. /// </summary>
  8700. /// <param name="fields" type="Array" elementType="Excel.Interfaces.SortField">The list of conditions to sort on.</param>
  8701. /// <param name="matchCase" type="Boolean" optional="true">Whether to have the casing impact string ordering.</param>
  8702. /// <param name="method" type="String" optional="true">The ordering method used for Chinese characters.</param>
  8703. /// <returns ></returns>
  8704. }
  8705. TableSort.prototype.clear = function() {
  8706. /// <summary>
  8707. /// Clears the sorting that is currently on the table. While this doesn&apos;t modify the table&apos;s ordering, it clears the state of the header buttons. [Api set: ExcelApi 1.2]
  8708. /// </summary>
  8709. /// <returns ></returns>
  8710. }
  8711. TableSort.prototype.reapply = function() {
  8712. /// <summary>
  8713. /// Reapplies the current sorting parameters to the table. [Api set: ExcelApi 1.2]
  8714. /// </summary>
  8715. /// <returns ></returns>
  8716. }
  8717. return TableSort;
  8718. })(OfficeExtension.ClientObject);
  8719. Excel.TableSort = TableSort;
  8720. })(Excel || (Excel = {__proto__: null}));
  8721. var Excel;
  8722. (function (Excel) {
  8723. /// <summary> [Api set: ExcelApi 1.3] </summary>
  8724. var V1CoercionType = {
  8725. __proto__: null,
  8726. "matrix": "matrix",
  8727. "table": "table",
  8728. "text": "text",
  8729. "image": "image",
  8730. }
  8731. Excel.V1CoercionType = V1CoercionType;
  8732. })(Excel || (Excel = {__proto__: null}));
  8733. var Excel;
  8734. (function (Excel) {
  8735. /// <summary> [Api set: ExcelApi 1.3] </summary>
  8736. var V1TableEnum = {
  8737. __proto__: null,
  8738. "all": "all",
  8739. "data": "data",
  8740. "headers": "headers",
  8741. }
  8742. Excel.V1TableEnum = V1TableEnum;
  8743. })(Excel || (Excel = {__proto__: null}));
  8744. var Excel;
  8745. (function (Excel) {
  8746. /// <summary> [Api set: ExcelApi 1.1] </summary>
  8747. var VerticalAlignment = {
  8748. __proto__: null,
  8749. "top": "top",
  8750. "center": "center",
  8751. "bottom": "bottom",
  8752. "justify": "justify",
  8753. "distributed": "distributed",
  8754. }
  8755. Excel.VerticalAlignment = VerticalAlignment;
  8756. })(Excel || (Excel = {__proto__: null}));
  8757. var Excel;
  8758. (function (Excel) {
  8759. var Workbook = (function(_super) {
  8760. __extends(Workbook, _super);
  8761. function Workbook() {
  8762. /// <summary> Workbook is the top level object which contains related workbook objects such as worksheets, tables, ranges, etc. [Api set: ExcelApi 1.1] </summary>
  8763. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  8764. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  8765. /// <field name="application" type="Excel.Application">Represents Excel application instance that contains this workbook. Read-only. [Api set: ExcelApi 1.1]</field>
  8766. /// <field name="bindings" type="Excel.BindingCollection">Represents a collection of bindings that are part of the workbook. Read-only. [Api set: ExcelApi 1.1]</field>
  8767. /// <field name="functions" type="Excel.Functions">Represents Excel application instance that contains this workbook. Read-only. [Api set: ExcelApi 1.2]</field>
  8768. /// <field name="names" type="Excel.NamedItemCollection">Represents a collection of workbook scoped named items (named ranges and constants). Read-only. [Api set: ExcelApi 1.1]</field>
  8769. /// <field name="pivotTables" type="Excel.PivotTableCollection">Represents a collection of PivotTables associated with the workbook. Read-only. [Api set: ExcelApi 1.3]</field>
  8770. /// <field name="tables" type="Excel.TableCollection">Represents a collection of tables associated with the workbook. Read-only. [Api set: ExcelApi 1.1]</field>
  8771. /// <field name="worksheets" type="Excel.WorksheetCollection">Represents a collection of worksheets associated with the workbook. Read-only. [Api set: ExcelApi 1.1]</field>
  8772. /// <field name="onSelectionChanged" type="OfficeExtension.EventHandlers">Occurs when the selection in the document is changed. [Api set: ExcelApi 1.2]</field>
  8773. }
  8774. Workbook.prototype.load = function(option) {
  8775. /// <summary>
  8776. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  8777. /// </summary>
  8778. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  8779. /// <returns type="Excel.Workbook"/>
  8780. }
  8781. Workbook.prototype.getSelectedRange = function() {
  8782. /// <summary>
  8783. /// Gets the currently selected range from the workbook. [Api set: ExcelApi 1.1]
  8784. /// </summary>
  8785. /// <returns type="Excel.Range"></returns>
  8786. }
  8787. Workbook.prototype.onSelectionChanged = {
  8788. __proto__: null,
  8789. add: function (handler) {
  8790. /// <param name="handler" type="function(eventArgs: Excel.Interfaces.SelectionChangedEventArgs)">Handler for the event. EventArgs: Provides information about the document that raised the SelectionChanged event. </param>
  8791. /// <returns type="OfficeExtension.EventHandlerResult"></returns>
  8792. var eventInfo = new Excel.Interfaces.SelectionChangedEventArgs();
  8793. eventInfo.__proto__ = null;
  8794. handler(eventInfo);
  8795. },
  8796. remove: function (handler) {
  8797. /// <param name="handler" type="function(eventArgs: Excel.Interfaces.SelectionChangedEventArgs)">Handler for the event.</param>
  8798. return;
  8799. },
  8800. removeAll: function () {
  8801. return;
  8802. }
  8803. };
  8804. return Workbook;
  8805. })(OfficeExtension.ClientObject);
  8806. Excel.Workbook = Workbook;
  8807. })(Excel || (Excel = {__proto__: null}));
  8808. var Excel;
  8809. (function (Excel) {
  8810. var Worksheet = (function(_super) {
  8811. __extends(Worksheet, _super);
  8812. function Worksheet() {
  8813. /// <summary> An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc. [Api set: ExcelApi 1.1] </summary>
  8814. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  8815. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  8816. /// <field name="charts" type="Excel.ChartCollection">Returns collection of charts that are part of the worksheet. Read-only. [Api set: ExcelApi 1.1]</field>
  8817. /// <field name="id" type="String">Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains the same even when the worksheet is renamed or moved. Read-only. [Api set: ExcelApi 1.1]</field>
  8818. /// <field name="name" type="String">The display name of the worksheet. [Api set: ExcelApi 1.1]</field>
  8819. /// <field name="pivotTables" type="Excel.PivotTableCollection">Collection of PivotTables that are part of the worksheet. Read-only. [Api set: ExcelApi 1.3]</field>
  8820. /// <field name="position" type="Number">The zero-based position of the worksheet within the workbook. [Api set: ExcelApi 1.1]</field>
  8821. /// <field name="protection" type="Excel.WorksheetProtection">Returns sheet protection object for a worksheet. [Api set: ExcelApi 1.2]</field>
  8822. /// <field name="tables" type="Excel.TableCollection">Collection of tables that are part of the worksheet. Read-only. [Api set: ExcelApi 1.1]</field>
  8823. /// <field name="visibility" type="String">The Visibility of the worksheet. [Api set: ExcelApi 1.1 for reading visibility; 1.2 for setting it.]</field>
  8824. }
  8825. Worksheet.prototype.load = function(option) {
  8826. /// <summary>
  8827. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  8828. /// </summary>
  8829. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  8830. /// <returns type="Excel.Worksheet"/>
  8831. }
  8832. Worksheet.prototype.activate = function() {
  8833. /// <summary>
  8834. /// Activate the worksheet in the Excel UI. [Api set: ExcelApi 1.1]
  8835. /// </summary>
  8836. /// <returns ></returns>
  8837. }
  8838. Worksheet.prototype.delete = function() {
  8839. /// <summary>
  8840. /// Deletes the worksheet from the workbook. [Api set: ExcelApi 1.1]
  8841. /// </summary>
  8842. /// <returns ></returns>
  8843. }
  8844. Worksheet.prototype.getCell = function(row, column) {
  8845. /// <summary>
  8846. /// Gets the range object containing the single cell based on row and column numbers. The cell can be outside the bounds of its parent range, so long as it&apos;s stays within the worksheet grid. [Api set: ExcelApi 1.1]
  8847. /// </summary>
  8848. /// <param name="row" type="Number">The row number of the cell to be retrieved. Zero-indexed.</param>
  8849. /// <param name="column" type="Number">the column number of the cell to be retrieved. Zero-indexed.</param>
  8850. /// <returns type="Excel.Range"></returns>
  8851. }
  8852. Worksheet.prototype.getRange = function(address) {
  8853. /// <summary>
  8854. /// Gets the range object specified by the address or name. [Api set: ExcelApi 1.1]
  8855. /// </summary>
  8856. /// <param name="address" type="String" optional="true">The address or the name of the range. If not specified, the entire worksheet range is returned.</param>
  8857. /// <returns type="Excel.Range"></returns>
  8858. }
  8859. Worksheet.prototype.getUsedRange = function(valuesOnly) {
  8860. /// <summary>
  8861. /// The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them. If the worksheet is blank, this function will return the top left cell. [Api set: ExcelApi 1.1]
  8862. /// </summary>
  8863. /// <param name="valuesOnly" type="Boolean" optional="true">Considers only cells with values as used cells (ignores formatting). [Api set: ExcelApi 1.2]</param>
  8864. /// <returns type="Excel.Range"></returns>
  8865. }
  8866. return Worksheet;
  8867. })(OfficeExtension.ClientObject);
  8868. Excel.Worksheet = Worksheet;
  8869. })(Excel || (Excel = {__proto__: null}));
  8870. var Excel;
  8871. (function (Excel) {
  8872. var WorksheetCollection = (function(_super) {
  8873. __extends(WorksheetCollection, _super);
  8874. function WorksheetCollection() {
  8875. /// <summary> Represents a collection of worksheet objects that are part of the workbook. [Api set: ExcelApi 1.1] </summary>
  8876. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  8877. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  8878. /// <field name="items" type="Array" elementType="Excel.Worksheet">Gets the loaded child items in this collection.</field>
  8879. }
  8880. WorksheetCollection.prototype.load = function(option) {
  8881. /// <summary>
  8882. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  8883. /// </summary>
  8884. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  8885. /// <returns type="Excel.WorksheetCollection"/>
  8886. }
  8887. WorksheetCollection.prototype.add = function(name) {
  8888. /// <summary>
  8889. /// Adds a new worksheet to the workbook. The worksheet will be added at the end of existing worksheets. If you wish to activate the newly added worksheet, call &quot;.activate() on it. [Api set: ExcelApi 1.1]
  8890. /// </summary>
  8891. /// <param name="name" type="String" optional="true">The name of the worksheet to be added. If specified, name should be unqiue. If not specified, Excel determines the name of the new worksheet.</param>
  8892. /// <returns type="Excel.Worksheet"></returns>
  8893. }
  8894. WorksheetCollection.prototype.getActiveWorksheet = function() {
  8895. /// <summary>
  8896. /// Gets the currently active worksheet in the workbook. [Api set: ExcelApi 1.1]
  8897. /// </summary>
  8898. /// <returns type="Excel.Worksheet"></returns>
  8899. }
  8900. WorksheetCollection.prototype.getItem = function(key) {
  8901. /// <summary>
  8902. /// Gets a worksheet object using its Name or ID. [Api set: ExcelApi 1.1]
  8903. /// </summary>
  8904. /// <param name="key" type="String">The Name or ID of the worksheet.</param>
  8905. /// <returns type="Excel.Worksheet"></returns>
  8906. }
  8907. return WorksheetCollection;
  8908. })(OfficeExtension.ClientObject);
  8909. Excel.WorksheetCollection = WorksheetCollection;
  8910. })(Excel || (Excel = {__proto__: null}));
  8911. var Excel;
  8912. (function (Excel) {
  8913. var WorksheetProtection = (function(_super) {
  8914. __extends(WorksheetProtection, _super);
  8915. function WorksheetProtection() {
  8916. /// <summary> Represents the protection of a sheet object. [Api set: ExcelApi 1.2] </summary>
  8917. /// <field name="context" type="Excel.RequestContext">The request context associated with this object.</field>
  8918. /// <field name="isNull" type="Boolean">Returns a boolean value for whether the corresponding object is null. You must call "context.sync()" before reading the isNull property.</field>
  8919. /// <field name="options" type="Excel.Interfaces.WorksheetProtectionOptions">Sheet protection options. Read-Only. [Api set: ExcelApi 1.2]</field>
  8920. /// <field name="protected" type="Boolean">Indicates if the worksheet is protected. Read-Only. [Api set: ExcelApi 1.2]</field>
  8921. }
  8922. WorksheetProtection.prototype.load = function(option) {
  8923. /// <summary>
  8924. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  8925. /// </summary>
  8926. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  8927. /// <returns type="Excel.WorksheetProtection"/>
  8928. }
  8929. WorksheetProtection.prototype.protect = function(options) {
  8930. /// <summary>
  8931. /// Protects a worksheet. Fails if the worksheet has been protected. [Api set: ExcelApi 1.2]
  8932. /// </summary>
  8933. /// <param name="options" type="Excel.Interfaces.WorksheetProtectionOptions" optional="true">sheet protection options.</param>
  8934. /// <returns ></returns>
  8935. }
  8936. WorksheetProtection.prototype.unprotect = function() {
  8937. /// <summary>
  8938. /// Unprotects a worksheet. [Api set: ExcelApi 1.2]
  8939. /// </summary>
  8940. /// <returns ></returns>
  8941. }
  8942. return WorksheetProtection;
  8943. })(OfficeExtension.ClientObject);
  8944. Excel.WorksheetProtection = WorksheetProtection;
  8945. })(Excel || (Excel = {__proto__: null}));
  8946. var Excel;
  8947. (function (Excel) {
  8948. var Interfaces;
  8949. (function (Interfaces) {
  8950. var WorksheetProtectionOptions = (function() {
  8951. function WorksheetProtectionOptions() {
  8952. /// <summary> Represents the options in sheet protection. [Api set: ExcelApi 1.2] </summary>
  8953. /// <field name="allowAutoFilter" type="Boolean">Represents the worksheet protection option of allowing using auto filter feature. [Api set: ExcelApi 1.2]</field>
  8954. /// <field name="allowDeleteColumns" type="Boolean">Represents the worksheet protection option of allowing deleting columns. [Api set: ExcelApi 1.2]</field>
  8955. /// <field name="allowDeleteRows" type="Boolean">Represents the worksheet protection option of allowing deleting rows. [Api set: ExcelApi 1.2]</field>
  8956. /// <field name="allowFormatCells" type="Boolean">Represents the worksheet protection option of allowing formatting cells. [Api set: ExcelApi 1.2]</field>
  8957. /// <field name="allowFormatColumns" type="Boolean">Represents the worksheet protection option of allowing formatting columns. [Api set: ExcelApi 1.2]</field>
  8958. /// <field name="allowFormatRows" type="Boolean">Represents the worksheet protection option of allowing formatting rows. [Api set: ExcelApi 1.2]</field>
  8959. /// <field name="allowInsertColumns" type="Boolean">Represents the worksheet protection option of allowing inserting columns. [Api set: ExcelApi 1.2]</field>
  8960. /// <field name="allowInsertHyperlinks" type="Boolean">Represents the worksheet protection option of allowing inserting hyperlinks. [Api set: ExcelApi 1.2]</field>
  8961. /// <field name="allowInsertRows" type="Boolean">Represents the worksheet protection option of allowing inserting rows. [Api set: ExcelApi 1.2]</field>
  8962. /// <field name="allowPivotTables" type="Boolean">Represents the worksheet protection option of allowing using PivotTable feature. [Api set: ExcelApi 1.2]</field>
  8963. /// <field name="allowSort" type="Boolean">Represents the worksheet protection option of allowing using sort feature. [Api set: ExcelApi 1.2]</field>
  8964. }
  8965. return WorksheetProtectionOptions;
  8966. })();
  8967. Interfaces.WorksheetProtectionOptions.__proto__ = null;
  8968. Interfaces.WorksheetProtectionOptions = WorksheetProtectionOptions;
  8969. })(Interfaces = Excel.Interfaces || (Excel.Interfaces = { __proto__: null}));
  8970. })(Excel || (Excel = {__proto__: null}));
  8971. var Excel;
  8972. (function (Excel) {
  8973. var RequestContext = (function (_super) {
  8974. __extends(RequestContext, _super);
  8975. function RequestContext() {
  8976. /// <summary>
  8977. /// The RequestContext object facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the request context is required to get access to the Excel object model from the add-in.
  8978. /// </summary>
  8979. /// <field name="workbook" type="Excel.Workbook">Root object for interacting with the document</field>
  8980. _super.call(this, null);
  8981. }
  8982. return RequestContext;
  8983. })(OfficeExtension.ClientRequestContext);
  8984. Excel.RequestContext = RequestContext;
  8985. Excel.run = function (batch) {
  8986. /// <signature>
  8987. /// <summary>
  8988. /// Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
  8989. /// </summary>
  8990. /// <param name="batch" type="function(context) { ... }">
  8991. /// A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()").
  8992. /// <br />
  8993. /// The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in.
  8994. /// </param>
  8995. /// </signature>
  8996. /// <signature>
  8997. /// <summary>
  8998. /// Executes a batch script that performs actions on the Excel object model, using the RequestContext of a previously-created API object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
  8999. /// </summary>
  9000. /// <param name="object" type="OfficeExtension.ClientObject">
  9001. /// A previously-created API object. The batch will use the same RequestContext as the passed-in object, which means that any changes applied to the object will be picked up by "context.sync()".
  9002. /// </param>
  9003. /// <param name="batch" type="function(context) { ... }">
  9004. /// A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()").
  9005. /// <br />
  9006. /// The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in.
  9007. /// </param>
  9008. /// </signature>
  9009. /// <signature>
  9010. /// <summary>
  9011. /// Executes a batch script that performs actions on the Excel object model, using the RequestContext of a previously-created API object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
  9012. /// </summary>
  9013. /// <param name="objects" type="Array&lt;OfficeExtension.ClientObject&gt;">
  9014. /// An array of previously-created API objects. The array will be validated to make sure that all of the objects share the same context. The batch will use this shared RequestContext, which means that any changes applied to these objects will be picked up by "context.sync()".
  9015. /// </param>
  9016. /// <param name="batch" type="function(context) { ... }">
  9017. /// A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()").
  9018. /// <br />
  9019. /// The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in.
  9020. /// </param>
  9021. /// </signature>
  9022. arguments[arguments.length - 1](new Excel.RequestContext());
  9023. return new OfficeExtension.Promise();
  9024. }
  9025. })(Excel || (Excel = {__proto__: null}));
  9026. Excel.__proto__ = null;
  9027. var Word;
  9028. (function (Word) {
  9029. /// <summary> [Api set: WordApi] </summary>
  9030. var Alignment = {
  9031. __proto__: null,
  9032. "unknown": "unknown",
  9033. "left": "left",
  9034. "centered": "centered",
  9035. "right": "right",
  9036. "justified": "justified",
  9037. }
  9038. Word.Alignment = Alignment;
  9039. })(Word || (Word = {}));
  9040. var Word;
  9041. (function (Word) {
  9042. var Body = (function(_super) {
  9043. __extends(Body, _super);
  9044. function Body() {
  9045. /// <summary> Represents the body of a document or a section. [Api set: WordApi] </summary>
  9046. /// <field name="context" type="Word.RequestContext">The request context associated with this object</field>
  9047. /// <field name="contentControls" type="Word.ContentControlCollection">Gets the collection of rich text content control objects that are in the body. Read-only. [Api set: WordApi]</field>
  9048. /// <field name="font" type="Word.Font">Gets the text format of the body. Use this to get and set font name, size, color, and other properties. Read-only. [Api set: WordApi]</field>
  9049. /// <field name="inlinePictures" type="Word.InlinePictureCollection">Gets the collection of inlinePicture objects that are in the body. The collection does not include floating images. Read-only. [Api set: WordApi]</field>
  9050. /// <field name="paragraphs" type="Word.ParagraphCollection">Gets the collection of paragraph objects that are in the body. Read-only. [Api set: WordApi]</field>
  9051. /// <field name="parentContentControl" type="Word.ContentControl">Gets the content control that contains the body. Returns null if there isn&apos;t a parent content control. Read-only. [Api set: WordApi]</field>
  9052. /// <field name="style" type="String">Gets or sets the style used for the body. This is the name of the pre-installed or custom style. [Api set: WordApi]</field>
  9053. /// <field name="text" type="String">Gets the text of the body. Use the insertText method to insert text. Read-only. [Api set: WordApi]</field>
  9054. }
  9055. Body.prototype.load = function(option) {
  9056. /// <summary>
  9057. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  9058. /// </summary>
  9059. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  9060. /// <returns type="Word.Body"/>
  9061. }
  9062. Body.prototype.clear = function() {
  9063. /// <summary>
  9064. /// Clears the contents of the body object. The user can perform the undo operation on the cleared content. [Api set: WordApi]
  9065. /// </summary>
  9066. /// <returns ></returns>
  9067. }
  9068. Body.prototype.getHtml = function() {
  9069. /// <summary>
  9070. /// Gets the HTML representation of the body object. [Api set: WordApi]
  9071. /// </summary>
  9072. /// <returns type="OfficeExtension.ClientResult&lt;string&gt;"></returns>
  9073. var result = new OfficeExtension.ClientResult();
  9074. result.__proto__ = null;
  9075. result.value = '';
  9076. return result;
  9077. }
  9078. Body.prototype.getOoxml = function() {
  9079. /// <summary>
  9080. /// Gets the OOXML (Office Open XML) representation of the body object. [Api set: WordApi]
  9081. /// </summary>
  9082. /// <returns type="OfficeExtension.ClientResult&lt;string&gt;"></returns>
  9083. var result = new OfficeExtension.ClientResult();
  9084. result.__proto__ = null;
  9085. result.value = '';
  9086. return result;
  9087. }
  9088. Body.prototype.insertBreak = function(breakType, insertLocation) {
  9089. /// <summary>
  9090. /// Inserts a break at the specified location in the main document. The insertLocation value can be &apos;Start&apos; or &apos;End&apos;. [Api set: WordApi]
  9091. /// </summary>
  9092. /// <param name="breakType" type="String">Required. The break type to add to the body.</param>
  9093. /// <param name="insertLocation" type="String">Required. The value can be &apos;Start&apos; or &apos;End&apos;.</param>
  9094. /// <returns ></returns>
  9095. }
  9096. Body.prototype.insertContentControl = function() {
  9097. /// <summary>
  9098. /// Wraps the body object with a Rich Text content control. [Api set: WordApi]
  9099. /// </summary>
  9100. /// <returns type="Word.ContentControl"></returns>
  9101. }
  9102. Body.prototype.insertFileFromBase64 = function(base64File, insertLocation) {
  9103. /// <summary>
  9104. /// Inserts a document into the body at the specified location. The insertLocation value can be &apos;Replace&apos;, &apos;Start&apos; or &apos;End&apos;. [Api set: WordApi]
  9105. /// </summary>
  9106. /// <param name="base64File" type="String">Required. The base64 encoded content of a .docx file.</param>
  9107. /// <param name="insertLocation" type="String">Required. The value can be &apos;Replace&apos;, &apos;Start&apos; or &apos;End&apos;.</param>
  9108. /// <returns type="Word.Range"></returns>
  9109. }
  9110. Body.prototype.insertHtml = function(html, insertLocation) {
  9111. /// <summary>
  9112. /// Inserts HTML at the specified location. The insertLocation value can be &apos;Replace&apos;, &apos;Start&apos; or &apos;End&apos;. [Api set: WordApi]
  9113. /// </summary>
  9114. /// <param name="html" type="String">Required. The HTML to be inserted in the document.</param>
  9115. /// <param name="insertLocation" type="String">Required. The value can be &apos;Replace&apos;, &apos;Start&apos; or &apos;End&apos;.</param>
  9116. /// <returns type="Word.Range"></returns>
  9117. }
  9118. Body.prototype.insertInlinePictureFromBase64 = function(base64EncodedImage, insertLocation) {
  9119. /// <summary>
  9120. /// Inserts a picture into the body at the specified location. The insertLocation value can be &apos;Start&apos; or &apos;End&apos;. [Api set: WordApi]
  9121. /// </summary>
  9122. /// <param name="base64EncodedImage" type="String">Required. The base64 encoded image to be inserted in the body.</param>
  9123. /// <param name="insertLocation" type="String">Required. The value can be &apos;Start&apos; or &apos;End&apos;.</param>
  9124. /// <returns type="Word.InlinePicture"></returns>
  9125. }
  9126. Body.prototype.insertOoxml = function(ooxml, insertLocation) {
  9127. /// <summary>
  9128. /// Inserts OOXML at the specified location. The insertLocation value can be &apos;Replace&apos;, &apos;Start&apos; or &apos;End&apos;. [Api set: WordApi]
  9129. /// </summary>
  9130. /// <param name="ooxml" type="String">Required. The OOXML to be inserted.</param>
  9131. /// <param name="insertLocation" type="String">Required. The value can be &apos;Replace&apos;, &apos;Start&apos; or &apos;End&apos;.</param>
  9132. /// <returns type="Word.Range"></returns>
  9133. }
  9134. Body.prototype.insertParagraph = function(paragraphText, insertLocation) {
  9135. /// <summary>
  9136. /// Inserts a paragraph at the specified location. The insertLocation value can be &apos;Start&apos; or &apos;End&apos;. [Api set: WordApi]
  9137. /// </summary>
  9138. /// <param name="paragraphText" type="String">Required. The paragraph text to be inserted.</param>
  9139. /// <param name="insertLocation" type="String">Required. The value can be &apos;Start&apos; or &apos;End&apos;.</param>
  9140. /// <returns type="Word.Paragraph"></returns>
  9141. }
  9142. Body.prototype.insertText = function(text, insertLocation) {
  9143. /// <summary>
  9144. /// Inserts text into the body at the specified location. The insertLocation value can be &apos;Replace&apos;, &apos;Start&apos; or &apos;End&apos;. [Api set: WordApi]
  9145. /// </summary>
  9146. /// <param name="text" type="String">Required. Text to be inserted.</param>
  9147. /// <param name="insertLocation" type="String">Required. The value can be &apos;Replace&apos;, &apos;Start&apos; or &apos;End&apos;.</param>
  9148. /// <returns type="Word.Range"></returns>
  9149. }
  9150. Body.prototype.search = function(searchText, searchOptions) {
  9151. /// <summary>
  9152. /// Performs a search with the specified searchOptions on the scope of the body object. The search results are a collection of range objects. [Api set: WordApi]
  9153. /// </summary>
  9154. /// <param name="searchText" type="String">Required. The search text.</param>
  9155. /// <param name="searchOptions" type="Word.SearchOptions" optional="true">Optional. Options for the search.</param>
  9156. /// <returns type="Word.SearchResultCollection"></returns>
  9157. }
  9158. Body.prototype.select = function(selectionMode) {
  9159. /// <summary>
  9160. /// Selects the body and navigates the Word UI to it. [Api set: WordApi]
  9161. /// </summary>
  9162. /// <param name="selectionMode" type="String" optional="true">Optional. The selection mode can be &apos;Select&apos;, &apos;Start&apos; or &apos;End&apos;. &apos;Select&apos; is the default.</param>
  9163. /// <returns ></returns>
  9164. }
  9165. return Body;
  9166. })(OfficeExtension.ClientObject);
  9167. Word.Body = Body;
  9168. })(Word || (Word = {}));
  9169. var Word;
  9170. (function (Word) {
  9171. /// <summary> [Api set: WordApi] </summary>
  9172. var BreakType = {
  9173. __proto__: null,
  9174. "page": "page",
  9175. "next": "next",
  9176. "sectionNext": "sectionNext",
  9177. "sectionContinuous": "sectionContinuous",
  9178. "sectionEven": "sectionEven",
  9179. "sectionOdd": "sectionOdd",
  9180. "line": "line",
  9181. }
  9182. Word.BreakType = BreakType;
  9183. })(Word || (Word = {}));
  9184. var Word;
  9185. (function (Word) {
  9186. var ContentControl = (function(_super) {
  9187. __extends(ContentControl, _super);
  9188. function ContentControl() {
  9189. /// <summary> Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text content controls are supported. [Api set: WordApi] </summary>
  9190. /// <field name="context" type="Word.RequestContext">The request context associated with this object</field>
  9191. /// <field name="appearance" type="String">Gets or sets the appearance of the content control. The value can be &apos;boundingBox&apos;, &apos;tags&apos; or &apos;hidden&apos;. [Api set: WordApi]</field>
  9192. /// <field name="cannotDelete" type="Boolean">Gets or sets a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. [Api set: WordApi]</field>
  9193. /// <field name="cannotEdit" type="Boolean">Gets or sets a value that indicates whether the user can edit the contents of the content control. [Api set: WordApi]</field>
  9194. /// <field name="color" type="String">Gets or sets the color of the content control. Color is set in &quot;#RRGGBB&quot; format or by using the color name. [Api set: WordApi]</field>
  9195. /// <field name="contentControls" type="Word.ContentControlCollection">Gets the collection of content control objects in the content control. Read-only. [Api set: WordApi]</field>
  9196. /// <field name="font" type="Word.Font">Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. Read-only. [Api set: WordApi]</field>
  9197. /// <field name="id" type="Number">Gets an integer that represents the content control identifier. Read-only. [Api set: WordApi]</field>
  9198. /// <field name="inlinePictures" type="Word.InlinePictureCollection">Gets the collection of inlinePicture objects in the content control. The collection does not include floating images. Read-only. [Api set: WordApi]</field>
  9199. /// <field name="paragraphs" type="Word.ParagraphCollection">Get the collection of paragraph objects in the content control. Read-only. [Api set: WordApi]</field>
  9200. /// <field name="parentContentControl" type="Word.ContentControl">Gets the content control that contains the content control. Returns null if there isn&apos;t a parent content control. Read-only. [Api set: WordApi]</field>
  9201. /// <field name="placeholderText" type="String">Gets or sets the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. [Api set: WordApi]</field>
  9202. /// <field name="removeWhenEdited" type="Boolean">Gets or sets a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. [Api set: WordApi]</field>
  9203. /// <field name="style" type="String">Gets or sets the style used for the content control. This is the name of the pre-installed or custom style. [Api set: WordApi]</field>
  9204. /// <field name="tag" type="String">Gets or sets a tag to identify a content control. [Api set: WordApi]</field>
  9205. /// <field name="text" type="String">Gets the text of the content control. Read-only. [Api set: WordApi]</field>
  9206. /// <field name="title" type="String">Gets or sets the title for a content control. [Api set: WordApi]</field>
  9207. /// <field name="type" type="String">Gets the content control type. Only rich text content controls are supported currently. Read-only. [Api set: WordApi]</field>
  9208. }
  9209. ContentControl.prototype.load = function(option) {
  9210. /// <summary>
  9211. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  9212. /// </summary>
  9213. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  9214. /// <returns type="Word.ContentControl"/>
  9215. }
  9216. ContentControl.prototype.clear = function() {
  9217. /// <summary>
  9218. /// Clears the contents of the content control. The user can perform the undo operation on the cleared content. [Api set: WordApi]
  9219. /// </summary>
  9220. /// <returns ></returns>
  9221. }
  9222. ContentControl.prototype.delete = function(keepContent) {
  9223. /// <summary>
  9224. /// Deletes the content control and its content. If keepContent is set to true, the content is not deleted. [Api set: WordApi]
  9225. /// </summary>
  9226. /// <param name="keepContent" type="Boolean">Required. Indicates whether the content should be deleted with the content control. If keepContent is set to true, the content is not deleted.</param>
  9227. /// <returns ></returns>
  9228. }
  9229. ContentControl.prototype.getHtml = function() {
  9230. /// <summary>
  9231. /// Gets the HTML representation of the content control object. [Api set: WordApi]
  9232. /// </summary>
  9233. /// <returns type="OfficeExtension.ClientResult&lt;string&gt;"></returns>
  9234. var result = new OfficeExtension.ClientResult();
  9235. result.__proto__ = null;
  9236. result.value = '';
  9237. return result;
  9238. }
  9239. ContentControl.prototype.getOoxml = function() {
  9240. /// <summary>
  9241. /// Gets the Office Open XML (OOXML) representation of the content control object. [Api set: WordApi]
  9242. /// </summary>
  9243. /// <returns type="OfficeExtension.ClientResult&lt;string&gt;"></returns>
  9244. var result = new OfficeExtension.ClientResult();
  9245. result.__proto__ = null;
  9246. result.value = '';
  9247. return result;
  9248. }
  9249. ContentControl.prototype.insertBreak = function(breakType, insertLocation) {
  9250. /// <summary>
  9251. /// Inserts a break at the specified location in the main document. The insertLocation value can be &apos;Start&apos;, &apos;End&apos;, &apos;Before&apos; or &apos;After&apos;. [Api set: WordApi]
  9252. /// </summary>
  9253. /// <param name="breakType" type="String">Required. Type of break.</param>
  9254. /// <param name="insertLocation" type="String">Required. The value can be &apos;Start&apos;, &apos;End&apos;, &apos;Before&apos; or &apos;After&apos;.</param>
  9255. /// <returns ></returns>
  9256. }
  9257. ContentControl.prototype.insertFileFromBase64 = function(base64File, insertLocation) {
  9258. /// <summary>
  9259. /// Inserts a document into the content control at the specified location. The insertLocation value can be &apos;Replace&apos;, &apos;Start&apos; or &apos;End&apos;. [Api set: WordApi]
  9260. /// </summary>
  9261. /// <param name="base64File" type="String">Required. The base64 encoded content of a .docx file.</param>
  9262. /// <param name="insertLocation" type="String">Required. The value can be &apos;Replace&apos;, &apos;Start&apos; or &apos;End&apos;.</param>
  9263. /// <returns type="Word.Range"></returns>
  9264. }
  9265. ContentControl.prototype.insertHtml = function(html, insertLocation) {
  9266. /// <summary>
  9267. /// Inserts HTML into the content control at the specified location. The insertLocation value can be &apos;Replace&apos;, &apos;Start&apos; or &apos;End&apos;. [Api set: WordApi]
  9268. /// </summary>
  9269. /// <param name="html" type="String">Required. The HTML to be inserted in to the content control.</param>
  9270. /// <param name="insertLocation" type="String">Required. The value can be &apos;Replace&apos;, &apos;Start&apos; or &apos;End&apos;.</param>
  9271. /// <returns type="Word.Range"></returns>
  9272. }
  9273. ContentControl.prototype.insertInlinePictureFromBase64 = function(base64EncodedImage, insertLocation) {
  9274. /// <summary>
  9275. /// Inserts an inline picture into the content control at the specified location. The insertLocation value can be &apos;Replace&apos;, &apos;Start&apos; or &apos;End&apos;. [Api set: WordApi]
  9276. /// </summary>
  9277. /// <param name="base64EncodedImage" type="String">Required. The base64 encoded image to be inserted in the content control.</param>
  9278. /// <param name="insertLocation" type="String">Required. The value can be &apos;Replace&apos;, &apos;Start&apos; or &apos;End&apos;.</param>
  9279. /// <returns type="Word.InlinePicture"></returns>
  9280. }
  9281. ContentControl.prototype.insertOoxml = function(ooxml, insertLocation) {
  9282. /// <summary>
  9283. /// Inserts OOXML into the content control at the specified location. The insertLocation value can be &apos;Replace&apos;, &apos;Start&apos; or &apos;End&apos;. [Api set: WordApi]
  9284. /// </summary>
  9285. /// <param name="ooxml" type="String">Required. The OOXML to be inserted in to the content control.</param>
  9286. /// <param name="insertLocation" type="String">Required. The value can be &apos;Replace&apos;, &apos;Start&apos; or &apos;End&apos;.</param>
  9287. /// <returns type="Word.Range"></returns>
  9288. }
  9289. ContentControl.prototype.insertParagraph = function(paragraphText, insertLocation) {
  9290. /// <summary>
  9291. /// Inserts a paragraph at the specified location. The insertLocation value can be &apos;Start&apos;, &apos;End&apos;, &apos;Before&apos; or &apos;After&apos;. [Api set: WordApi]
  9292. /// </summary>
  9293. /// <param name="paragraphText" type="String">Required. The paragrph text to be inserted.</param>
  9294. /// <param name="insertLocation" type="String">Required. The value can be &apos;Start&apos;, &apos;End&apos;, &apos;Before&apos; or &apos;After&apos;.</param>
  9295. /// <returns type="Word.Paragraph"></returns>
  9296. }
  9297. ContentControl.prototype.insertText = function(text, insertLocation) {
  9298. /// <summary>
  9299. /// Inserts text into the content control at the specified location. The insertLocation value can be &apos;Replace&apos;, &apos;Start&apos; or &apos;End&apos;. [Api set: WordApi]
  9300. /// </summary>
  9301. /// <param name="text" type="String">Required. The text to be inserted in to the content control.</param>
  9302. /// <param name="insertLocation" type="String">Required. The value can be &apos;Replace&apos;, &apos;Start&apos; or &apos;End&apos;.</param>
  9303. /// <returns type="Word.Range"></returns>
  9304. }
  9305. ContentControl.prototype.search = function(searchText, searchOptions) {
  9306. /// <summary>
  9307. /// Performs a search with the specified searchOptions on the scope of the content control object. The search results are a collection of range objects. [Api set: WordApi]
  9308. /// </summary>
  9309. /// <param name="searchText" type="String">Required. The search text.</param>
  9310. /// <param name="searchOptions" type="Word.SearchOptions" optional="true">Optional. Options for the search.</param>
  9311. /// <returns type="Word.SearchResultCollection"></returns>
  9312. }
  9313. ContentControl.prototype.select = function(selectionMode) {
  9314. /// <summary>
  9315. /// Selects the content control. This causes Word to scroll to the selection. [Api set: WordApi]
  9316. /// </summary>
  9317. /// <param name="selectionMode" type="String" optional="true">Optional. The selection mode can be &apos;Select&apos;, &apos;Start&apos; or &apos;End&apos;. &apos;Select&apos; is the default.</param>
  9318. /// <returns ></returns>
  9319. }
  9320. return ContentControl;
  9321. })(OfficeExtension.ClientObject);
  9322. Word.ContentControl = ContentControl;
  9323. })(Word || (Word = {}));
  9324. var Word;
  9325. (function (Word) {
  9326. /// <summary> ContentControl appearance [Api set: WordApi] </summary>
  9327. var ContentControlAppearance = {
  9328. __proto__: null,
  9329. "boundingBox": "boundingBox",
  9330. "tags": "tags",
  9331. "hidden": "hidden",
  9332. }
  9333. Word.ContentControlAppearance = ContentControlAppearance;
  9334. })(Word || (Word = {}));
  9335. var Word;
  9336. (function (Word) {
  9337. var ContentControlCollection = (function(_super) {
  9338. __extends(ContentControlCollection, _super);
  9339. function ContentControlCollection() {
  9340. /// <summary> Contains a collection of ContentControl objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text content controls are supported. [Api set: WordApi] </summary>
  9341. /// <field name="context" type="Word.RequestContext">The request context associated with this object</field>
  9342. /// <field name="items" type="Array" elementType="Word.ContentControl">Gets the loaded child items in this collection.</field>
  9343. }
  9344. ContentControlCollection.prototype.load = function(option) {
  9345. /// <summary>
  9346. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  9347. /// </summary>
  9348. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  9349. /// <returns type="Word.ContentControlCollection"/>
  9350. }
  9351. ContentControlCollection.prototype.getById = function(id) {
  9352. /// <summary>
  9353. /// Gets a content control by its identifier. [Api set: WordApi]
  9354. /// </summary>
  9355. /// <param name="id" type="Number">Required. A content control identifier.</param>
  9356. /// <returns type="Word.ContentControl"></returns>
  9357. }
  9358. ContentControlCollection.prototype.getByTag = function(tag) {
  9359. /// <summary>
  9360. /// Gets the content controls that have the specified tag. [Api set: WordApi]
  9361. /// </summary>
  9362. /// <param name="tag" type="String">Required. A tag set on a content control.</param>
  9363. /// <returns type="Word.ContentControlCollection"></returns>
  9364. }
  9365. ContentControlCollection.prototype.getByTitle = function(title) {
  9366. /// <summary>
  9367. /// Gets the content controls that have the specified title. [Api set: WordApi]
  9368. /// </summary>
  9369. /// <param name="title" type="String">Required. The title of a content control.</param>
  9370. /// <returns type="Word.ContentControlCollection"></returns>
  9371. }
  9372. ContentControlCollection.prototype.getItem = function(index) {
  9373. /// <summary>
  9374. /// Gets a content control by its index in the collection. [Api set: WordApi]
  9375. /// </summary>
  9376. /// <param name="index" >The index</param>
  9377. /// <returns type="Word.ContentControl"></returns>
  9378. }
  9379. return ContentControlCollection;
  9380. })(OfficeExtension.ClientObject);
  9381. Word.ContentControlCollection = ContentControlCollection;
  9382. })(Word || (Word = {}));
  9383. var Word;
  9384. (function (Word) {
  9385. /// <summary> ContentControl types [Api set: WordApi] </summary>
  9386. var ContentControlType = {
  9387. __proto__: null,
  9388. "richText": "richText",
  9389. }
  9390. Word.ContentControlType = ContentControlType;
  9391. })(Word || (Word = {}));
  9392. var Word;
  9393. (function (Word) {
  9394. var Document = (function(_super) {
  9395. __extends(Document, _super);
  9396. function Document() {
  9397. /// <summary> The Document object is the top level object. A Document object contains one or more sections, content controls, and the body that contains the contents of the document. [Api set: WordApi] </summary>
  9398. /// <field name="context" type="Word.RequestContext">The request context associated with this object</field>
  9399. /// <field name="body" type="Word.Body">Gets the body of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.. Read-only. [Api set: WordApi]</field>
  9400. /// <field name="contentControls" type="Word.ContentControlCollection">Gets the collection of content control objects that are in the current document. This includes content controls in the body of the document, headers, footers, textboxes, etc.. Read-only. [Api set: WordApi]</field>
  9401. /// <field name="saved" type="Boolean">Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn&apos;t changed since it was saved. Read-only. [Api set: WordApi]</field>
  9402. /// <field name="sections" type="Word.SectionCollection">Gets the collection of section objects that are in the document. Read-only. [Api set: WordApi]</field>
  9403. }
  9404. Document.prototype.load = function(option) {
  9405. /// <summary>
  9406. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  9407. /// </summary>
  9408. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  9409. /// <returns type="Word.Document"/>
  9410. }
  9411. Document.prototype.getSelection = function() {
  9412. /// <summary>
  9413. /// Gets the current selection of the document. Multiple selections are not supported. [Api set: WordApi]
  9414. /// </summary>
  9415. /// <returns type="Word.Range"></returns>
  9416. }
  9417. Document.prototype.save = function() {
  9418. /// <summary>
  9419. /// Saves the document. This will use the Word default file naming convention if the document has not been saved before. [Api set: WordApi]
  9420. /// </summary>
  9421. /// <returns ></returns>
  9422. }
  9423. return Document;
  9424. })(OfficeExtension.ClientObject);
  9425. Word.Document = Document;
  9426. })(Word || (Word = {}));
  9427. var Word;
  9428. (function (Word) {
  9429. var Font = (function(_super) {
  9430. __extends(Font, _super);
  9431. function Font() {
  9432. /// <summary> Represents a font. [Api set: WordApi] </summary>
  9433. /// <field name="context" type="Word.RequestContext">The request context associated with this object</field>
  9434. /// <field name="bold" type="Boolean">Gets or sets a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. [Api set: WordApi]</field>
  9435. /// <field name="color" type="String">Gets or sets the color for the specified font. You can provide the value in the &quot;#RRGGBB&quot; format or the color name. [Api set: WordApi]</field>
  9436. /// <field name="doubleStrikeThrough" type="Boolean">Gets or sets a value that indicates whether the font has a double strike through. True if the font is formatted as double strikethrough text, otherwise, false. [Api set: WordApi]</field>
  9437. /// <field name="highlightColor" type="String">Gets or sets the highlight color for the specified font. You can provide the value as either in the &quot;#RRGGBB&quot; format or the color name. [Api set: WordApi]</field>
  9438. /// <field name="italic" type="Boolean">Gets or sets a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. [Api set: WordApi]</field>
  9439. /// <field name="name" type="String">Gets or sets a value that represents the name of the font. [Api set: WordApi]</field>
  9440. /// <field name="size" type="Number">Gets or sets a value that represents the font size in points. [Api set: WordApi]</field>
  9441. /// <field name="strikeThrough" type="Boolean">Gets or sets a value that indicates whether the font has a strike through. True if the font is formatted as strikethrough text, otherwise, false. [Api set: WordApi]</field>
  9442. /// <field name="subscript" type="Boolean">Gets or sets a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. [Api set: WordApi]</field>
  9443. /// <field name="superscript" type="Boolean">Gets or sets a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. [Api set: WordApi]</field>
  9444. /// <field name="underline" type="String">Gets or sets a value that indicates the font&apos;s underline type. &apos;None&apos; if the font is not underlined. [Api set: WordApi]</field>
  9445. }
  9446. Font.prototype.load = function(option) {
  9447. /// <summary>
  9448. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  9449. /// </summary>
  9450. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  9451. /// <returns type="Word.Font"/>
  9452. }
  9453. return Font;
  9454. })(OfficeExtension.ClientObject);
  9455. Word.Font = Font;
  9456. })(Word || (Word = {}));
  9457. var Word;
  9458. (function (Word) {
  9459. /// <summary> [Api set: WordApi] </summary>
  9460. var HeaderFooterType = {
  9461. __proto__: null,
  9462. "primary": "primary",
  9463. "firstPage": "firstPage",
  9464. "evenPages": "evenPages",
  9465. }
  9466. Word.HeaderFooterType = HeaderFooterType;
  9467. })(Word || (Word = {}));
  9468. var Word;
  9469. (function (Word) {
  9470. var InlinePicture = (function(_super) {
  9471. __extends(InlinePicture, _super);
  9472. function InlinePicture() {
  9473. /// <summary> Represents an inline picture. [Api set: WordApi] </summary>
  9474. /// <field name="context" type="Word.RequestContext">The request context associated with this object</field>
  9475. /// <field name="altTextDescription" type="String">Gets or sets a string that represents the alternative text associated with the inline image [Api set: WordApi]</field>
  9476. /// <field name="altTextTitle" type="String">Gets or sets a string that contains the title for the inline image. [Api set: WordApi]</field>
  9477. /// <field name="height" type="Number">Gets or sets a number that describes the height of the inline image. [Api set: WordApi]</field>
  9478. /// <field name="hyperlink" type="String">Gets or sets the hyperlink associated with the inline image. [Api set: WordApi]</field>
  9479. /// <field name="lockAspectRatio" type="Boolean">Gets or sets a value that indicates whether the inline image retains its original proportions when you resize it. [Api set: WordApi]</field>
  9480. /// <field name="paragraph" type="Word.Paragraph">Gets the paragraph that contains the inline image. Read-only. [Api set: WordApi]</field>
  9481. /// <field name="parentContentControl" type="Word.ContentControl">Gets the content control that contains the inline image. Returns null if there isn&apos;t a parent content control. Read-only. [Api set: WordApi]</field>
  9482. /// <field name="width" type="Number">Gets or sets a number that describes the width of the inline image. [Api set: WordApi]</field>
  9483. }
  9484. InlinePicture.prototype.load = function(option) {
  9485. /// <summary>
  9486. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  9487. /// </summary>
  9488. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  9489. /// <returns type="Word.InlinePicture"/>
  9490. }
  9491. InlinePicture.prototype.delete = function() {
  9492. /// <summary>
  9493. /// Deletes the inline picture from the document. [Api set: WordApi]
  9494. /// </summary>
  9495. /// <returns ></returns>
  9496. }
  9497. InlinePicture.prototype.getBase64ImageSrc = function() {
  9498. /// <summary>
  9499. /// Gets the base64 encoded string representation of the inline image. [Api set: WordApi]
  9500. /// </summary>
  9501. /// <returns type="OfficeExtension.ClientResult&lt;string&gt;"></returns>
  9502. var result = new OfficeExtension.ClientResult();
  9503. result.__proto__ = null;
  9504. result.value = '';
  9505. return result;
  9506. }
  9507. InlinePicture.prototype.insertBreak = function(breakType, insertLocation) {
  9508. /// <summary>
  9509. /// Inserts a break at the specified location in the main document. The insertLocation value can be &apos;Before&apos; or &apos;After&apos;. [Api set: WordApi]
  9510. /// </summary>
  9511. /// <param name="breakType" type="String">Required. The break type to add.</param>
  9512. /// <param name="insertLocation" type="String">Required. The value can be &apos;Before&apos; or &apos;After&apos;.</param>
  9513. /// <returns ></returns>
  9514. }
  9515. InlinePicture.prototype.insertContentControl = function() {
  9516. /// <summary>
  9517. /// Wraps the inline picture with a rich text content control. [Api set: WordApi]
  9518. /// </summary>
  9519. /// <returns type="Word.ContentControl"></returns>
  9520. }
  9521. InlinePicture.prototype.insertFileFromBase64 = function(base64File, insertLocation) {
  9522. /// <summary>
  9523. /// Inserts a document at the specified location. The insertLocation value can be &apos;Before&apos; or &apos;After&apos;. [Api set: WordApi]
  9524. /// </summary>
  9525. /// <param name="base64File" type="String">Required. The base64 encoded content of a .docx file.</param>
  9526. /// <param name="insertLocation" type="String">Required. The value can be &apos;Before&apos; or &apos;After&apos;.</param>
  9527. /// <returns type="Word.Range"></returns>
  9528. }
  9529. InlinePicture.prototype.insertHtml = function(html, insertLocation) {
  9530. /// <summary>
  9531. /// Inserts HTML at the specified location. The insertLocation value can be &apos;Before&apos; or &apos;After&apos;. [Api set: WordApi]
  9532. /// </summary>
  9533. /// <param name="html" type="String">Required. The HTML to be inserted.</param>
  9534. /// <param name="insertLocation" type="String">Required. The value can be &apos;Before&apos; or &apos;After&apos;.</param>
  9535. /// <returns type="Word.Range"></returns>
  9536. }
  9537. InlinePicture.prototype.insertInlinePictureFromBase64 = function(base64EncodedImage, insertLocation) {
  9538. /// <summary>
  9539. /// Inserts an inline picture at the specified location. The insertLocation value can be &apos;Replace&apos;, &apos;Before&apos; or &apos;After&apos;. [Api set: WordApi]
  9540. /// </summary>
  9541. /// <param name="base64EncodedImage" type="String">Required. The base64 encoded image to be inserted.</param>
  9542. /// <param name="insertLocation" type="String">Required. The value can be &apos;Replace&apos;, &apos;Before&apos; or &apos;After&apos;.</param>
  9543. /// <returns type="Word.InlinePicture"></returns>
  9544. }
  9545. InlinePicture.prototype.insertOoxml = function(ooxml, insertLocation) {
  9546. /// <summary>
  9547. /// Inserts OOXML at the specified location. The insertLocation value can be &apos;Before&apos; or &apos;After&apos;. [Api set: WordApi]
  9548. /// </summary>
  9549. /// <param name="ooxml" type="String">Required. The OOXML to be inserted.</param>
  9550. /// <param name="insertLocation" type="String">Required. The value can be &apos;Before&apos; or &apos;After&apos;.</param>
  9551. /// <returns type="Word.Range"></returns>
  9552. }
  9553. InlinePicture.prototype.insertParagraph = function(paragraphText, insertLocation) {
  9554. /// <summary>
  9555. /// Inserts a paragraph at the specified location. The insertLocation value can be &apos;Before&apos; or &apos;After&apos;. [Api set: WordApi]
  9556. /// </summary>
  9557. /// <param name="paragraphText" type="String">Required. The paragraph text to be inserted.</param>
  9558. /// <param name="insertLocation" type="String">Required. The value can be &apos;Before&apos; or &apos;After&apos;.</param>
  9559. /// <returns type="Word.Paragraph"></returns>
  9560. }
  9561. InlinePicture.prototype.insertText = function(text, insertLocation) {
  9562. /// <summary>
  9563. /// Inserts text at the specified location. The insertLocation value can be &apos;Before&apos; or &apos;After&apos;. [Api set: WordApi]
  9564. /// </summary>
  9565. /// <param name="text" type="String">Required. Text to be inserted.</param>
  9566. /// <param name="insertLocation" type="String">Required. The value can be &apos;Before&apos; or &apos;After&apos;.</param>
  9567. /// <returns type="Word.Range"></returns>
  9568. }
  9569. InlinePicture.prototype.select = function(selectionMode) {
  9570. /// <summary>
  9571. /// Selects the inline picture. This causes Word to scroll to the selection. [Api set: WordApi]
  9572. /// </summary>
  9573. /// <param name="selectionMode" type="String" optional="true">Optional. The selection mode can be &apos;Select&apos;, &apos;Start&apos; or &apos;End&apos;. &apos;Select&apos; is the default.</param>
  9574. /// <returns ></returns>
  9575. }
  9576. return InlinePicture;
  9577. })(OfficeExtension.ClientObject);
  9578. Word.InlinePicture = InlinePicture;
  9579. })(Word || (Word = {}));
  9580. var Word;
  9581. (function (Word) {
  9582. var InlinePictureCollection = (function(_super) {
  9583. __extends(InlinePictureCollection, _super);
  9584. function InlinePictureCollection() {
  9585. /// <summary> Contains a collection of [inlinePicture](inlinePicture.md) objects. [Api set: WordApi] </summary>
  9586. /// <field name="context" type="Word.RequestContext">The request context associated with this object</field>
  9587. /// <field name="items" type="Array" elementType="Word.InlinePicture">Gets the loaded child items in this collection.</field>
  9588. }
  9589. InlinePictureCollection.prototype.load = function(option) {
  9590. /// <summary>
  9591. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  9592. /// </summary>
  9593. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  9594. /// <returns type="Word.InlinePictureCollection"/>
  9595. }
  9596. return InlinePictureCollection;
  9597. })(OfficeExtension.ClientObject);
  9598. Word.InlinePictureCollection = InlinePictureCollection;
  9599. })(Word || (Word = {}));
  9600. var Word;
  9601. (function (Word) {
  9602. /// <summary> The insertion location types [Api set: WordApi] </summary>
  9603. var InsertLocation = {
  9604. __proto__: null,
  9605. "before": "before",
  9606. "after": "after",
  9607. "start": "start",
  9608. "end": "end",
  9609. "replace": "replace",
  9610. }
  9611. Word.InsertLocation = InsertLocation;
  9612. })(Word || (Word = {}));
  9613. var Word;
  9614. (function (Word) {
  9615. var Paragraph = (function(_super) {
  9616. __extends(Paragraph, _super);
  9617. function Paragraph() {
  9618. /// <summary> Represents a single paragraph in a selection, range, content control, or document body. [Api set: WordApi] </summary>
  9619. /// <field name="context" type="Word.RequestContext">The request context associated with this object</field>
  9620. /// <field name="alignment" type="String">Gets or sets the alignment for a paragraph. The value can be &quot;left&quot;, &quot;centered&quot;, &quot;right&quot;, or &quot;justified&quot;. [Api set: WordApi]</field>
  9621. /// <field name="contentControls" type="Word.ContentControlCollection">Gets the collection of content control objects that are in the paragraph. Read-only. [Api set: WordApi]</field>
  9622. /// <field name="firstLineIndent" type="Number">Gets or sets the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. [Api set: WordApi]</field>
  9623. /// <field name="font" type="Word.Font">Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. Read-only. [Api set: WordApi]</field>
  9624. /// <field name="inlinePictures" type="Word.InlinePictureCollection">Gets the collection of inlinePicture objects that are in the paragraph. The collection does not include floating images. Read-only. [Api set: WordApi]</field>
  9625. /// <field name="leftIndent" type="Number">Gets or sets the left indent value, in points, for the paragraph. [Api set: WordApi]</field>
  9626. /// <field name="lineSpacing" type="Number">Gets or sets the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. [Api set: WordApi]</field>
  9627. /// <field name="lineUnitAfter" type="Number">Gets or sets the amount of spacing, in grid lines. after the paragraph. [Api set: WordApi]</field>
  9628. /// <field name="lineUnitBefore" type="Number">Gets or sets the amount of spacing, in grid lines, before the paragraph. [Api set: WordApi]</field>
  9629. /// <field name="outlineLevel" type="Number">Gets or sets the outline level for the paragraph. [Api set: WordApi]</field>
  9630. /// <field name="parentContentControl" type="Word.ContentControl">Gets the content control that contains the paragraph. Returns null if there isn&apos;t a parent content control. Read-only. [Api set: WordApi]</field>
  9631. /// <field name="rightIndent" type="Number">Gets or sets the right indent value, in points, for the paragraph. [Api set: WordApi]</field>
  9632. /// <field name="spaceAfter" type="Number">Gets or sets the spacing, in points, after the paragraph. [Api set: WordApi]</field>
  9633. /// <field name="spaceBefore" type="Number">Gets or sets the spacing, in points, before the paragraph. [Api set: WordApi]</field>
  9634. /// <field name="style" type="String">Gets or sets the style used for the paragraph. This is the name of the pre-installed or custom style. [Api set: WordApi]</field>
  9635. /// <field name="text" type="String">Gets the text of the paragraph. Read-only. [Api set: WordApi]</field>
  9636. }
  9637. Paragraph.prototype.load = function(option) {
  9638. /// <summary>
  9639. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  9640. /// </summary>
  9641. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  9642. /// <returns type="Word.Paragraph"/>
  9643. }
  9644. Paragraph.prototype.clear = function() {
  9645. /// <summary>
  9646. /// Clears the contents of the paragraph object. The user can perform the undo operation on the cleared content. [Api set: WordApi]
  9647. /// </summary>
  9648. /// <returns ></returns>
  9649. }
  9650. Paragraph.prototype.delete = function() {
  9651. /// <summary>
  9652. /// Deletes the paragraph and its content from the document. [Api set: WordApi]
  9653. /// </summary>
  9654. /// <returns ></returns>
  9655. }
  9656. Paragraph.prototype.getHtml = function() {
  9657. /// <summary>
  9658. /// Gets the HTML representation of the paragraph object. [Api set: WordApi]
  9659. /// </summary>
  9660. /// <returns type="OfficeExtension.ClientResult&lt;string&gt;"></returns>
  9661. var result = new OfficeExtension.ClientResult();
  9662. result.__proto__ = null;
  9663. result.value = '';
  9664. return result;
  9665. }
  9666. Paragraph.prototype.getOoxml = function() {
  9667. /// <summary>
  9668. /// Gets the Office Open XML (OOXML) representation of the paragraph object. [Api set: WordApi]
  9669. /// </summary>
  9670. /// <returns type="OfficeExtension.ClientResult&lt;string&gt;"></returns>
  9671. var result = new OfficeExtension.ClientResult();
  9672. result.__proto__ = null;
  9673. result.value = '';
  9674. return result;
  9675. }
  9676. Paragraph.prototype.insertBreak = function(breakType, insertLocation) {
  9677. /// <summary>
  9678. /// Inserts a break at the specified location in the main document. The insertLocation value can be &apos;Before&apos; or &apos;After&apos;. [Api set: WordApi]
  9679. /// </summary>
  9680. /// <param name="breakType" type="String">Required. The break type to add to the document.</param>
  9681. /// <param name="insertLocation" type="String">Required. The value can be &apos;Before&apos; or &apos;After&apos;.</param>
  9682. /// <returns ></returns>
  9683. }
  9684. Paragraph.prototype.insertContentControl = function() {
  9685. /// <summary>
  9686. /// Wraps the paragraph object with a rich text content control. [Api set: WordApi]
  9687. /// </summary>
  9688. /// <returns type="Word.ContentControl"></returns>
  9689. }
  9690. Paragraph.prototype.insertFileFromBase64 = function(base64File, insertLocation) {
  9691. /// <summary>
  9692. /// Inserts a document into the paragraph at the specified location. The insertLocation value can be &apos;Replace&apos;, &apos;Start&apos; or &apos;End&apos;. [Api set: WordApi]
  9693. /// </summary>
  9694. /// <param name="base64File" type="String">Required. The base64 encoded content of a .docx file.</param>
  9695. /// <param name="insertLocation" type="String">Required. The value can be &apos;Replace&apos;, &apos;Start&apos; or &apos;End&apos;.</param>
  9696. /// <returns type="Word.Range"></returns>
  9697. }
  9698. Paragraph.prototype.insertHtml = function(html, insertLocation) {
  9699. /// <summary>
  9700. /// Inserts HTML into the paragraph at the specified location. The insertLocation value can be &apos;Replace&apos;, &apos;Start&apos; or &apos;End&apos;. [Api set: WordApi]
  9701. /// </summary>
  9702. /// <param name="html" type="String">Required. The HTML to be inserted in the paragraph.</param>
  9703. /// <param name="insertLocation" type="String">Required. The value can be &apos;Replace&apos;, &apos;Start&apos; or &apos;End&apos;.</param>
  9704. /// <returns type="Word.Range"></returns>
  9705. }
  9706. Paragraph.prototype.insertInlinePictureFromBase64 = function(base64EncodedImage, insertLocation) {
  9707. /// <summary>
  9708. /// Inserts a picture into the paragraph at the specified location. The insertLocation value can be &apos;Replace&apos;, &apos;Start&apos; or &apos;End&apos;. [Api set: WordApi]
  9709. /// </summary>
  9710. /// <param name="base64EncodedImage" type="String">Required. The base64 encoded image to be inserted.</param>
  9711. /// <param name="insertLocation" type="String">Required. The value can be &apos;Replace&apos;, &apos;Start&apos; or &apos;End&apos;.</param>
  9712. /// <returns type="Word.InlinePicture"></returns>
  9713. }
  9714. Paragraph.prototype.insertOoxml = function(ooxml, insertLocation) {
  9715. /// <summary>
  9716. /// Inserts OOXML into the paragraph at the specified location. The insertLocation value can be &apos;Replace&apos;, &apos;Start&apos; or &apos;End&apos;. [Api set: WordApi]
  9717. /// </summary>
  9718. /// <param name="ooxml" type="String">Required. The OOXML to be inserted in the paragraph.</param>
  9719. /// <param name="insertLocation" type="String">Required. The value can be &apos;Replace&apos;, &apos;Start&apos; or &apos;End&apos;.</param>
  9720. /// <returns type="Word.Range"></returns>
  9721. }
  9722. Paragraph.prototype.insertParagraph = function(paragraphText, insertLocation) {
  9723. /// <summary>
  9724. /// Inserts a paragraph at the specified location. The insertLocation value can be &apos;Before&apos; or &apos;After&apos;. [Api set: WordApi]
  9725. /// </summary>
  9726. /// <param name="paragraphText" type="String">Required. The paragraph text to be inserted.</param>
  9727. /// <param name="insertLocation" type="String">Required. The value can be &apos;Before&apos; or &apos;After&apos;.</param>
  9728. /// <returns type="Word.Paragraph"></returns>
  9729. }
  9730. Paragraph.prototype.insertText = function(text, insertLocation) {
  9731. /// <summary>
  9732. /// Inserts text into the paragraph at the specified location. The insertLocation value can be &apos;Replace&apos;, &apos;Start&apos; or &apos;End&apos;. [Api set: WordApi]
  9733. /// </summary>
  9734. /// <param name="text" type="String">Required. Text to be inserted.</param>
  9735. /// <param name="insertLocation" type="String">Required. The value can be &apos;Replace&apos;, &apos;Start&apos; or &apos;End&apos;.</param>
  9736. /// <returns type="Word.Range"></returns>
  9737. }
  9738. Paragraph.prototype.search = function(searchText, searchOptions) {
  9739. /// <summary>
  9740. /// Performs a search with the specified searchOptions on the scope of the paragraph object. The search results are a collection of range objects. [Api set: WordApi]
  9741. /// </summary>
  9742. /// <param name="searchText" type="String">Required. The search text.</param>
  9743. /// <param name="searchOptions" type="Word.SearchOptions" optional="true">Optional. Options for the search.</param>
  9744. /// <returns type="Word.SearchResultCollection"></returns>
  9745. }
  9746. Paragraph.prototype.select = function(selectionMode) {
  9747. /// <summary>
  9748. /// Selects and navigates the Word UI to the paragraph. [Api set: WordApi]
  9749. /// </summary>
  9750. /// <param name="selectionMode" type="String" optional="true">Optional. The selection mode can be &apos;Select&apos;, &apos;Start&apos; or &apos;End&apos;. &apos;Select&apos; is the default.</param>
  9751. /// <returns ></returns>
  9752. }
  9753. return Paragraph;
  9754. })(OfficeExtension.ClientObject);
  9755. Word.Paragraph = Paragraph;
  9756. })(Word || (Word = {}));
  9757. var Word;
  9758. (function (Word) {
  9759. var ParagraphCollection = (function(_super) {
  9760. __extends(ParagraphCollection, _super);
  9761. function ParagraphCollection() {
  9762. /// <summary> Contains a collection of [paragraph](paragraph.md) objects. [Api set: WordApi] </summary>
  9763. /// <field name="context" type="Word.RequestContext">The request context associated with this object</field>
  9764. /// <field name="items" type="Array" elementType="Word.Paragraph">Gets the loaded child items in this collection.</field>
  9765. }
  9766. ParagraphCollection.prototype.load = function(option) {
  9767. /// <summary>
  9768. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  9769. /// </summary>
  9770. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  9771. /// <returns type="Word.ParagraphCollection"/>
  9772. }
  9773. return ParagraphCollection;
  9774. })(OfficeExtension.ClientObject);
  9775. Word.ParagraphCollection = ParagraphCollection;
  9776. })(Word || (Word = {}));
  9777. var Word;
  9778. (function (Word) {
  9779. var Range = (function(_super) {
  9780. __extends(Range, _super);
  9781. function Range() {
  9782. /// <summary> Represents a contiguous area in a document. [Api set: WordApi] </summary>
  9783. /// <field name="context" type="Word.RequestContext">The request context associated with this object</field>
  9784. /// <field name="contentControls" type="Word.ContentControlCollection">Gets the collection of content control objects that are in the range. Read-only. [Api set: WordApi]</field>
  9785. /// <field name="font" type="Word.Font">Gets the text format of the range. Use this to get and set font name, size, color, and other properties. Read-only. [Api set: WordApi]</field>
  9786. /// <field name="inlinePictures" type="Word.InlinePictureCollection">Gets the collection of inline picture objects that are in the range. Read-only. [Api set: WordApi]</field>
  9787. /// <field name="paragraphs" type="Word.ParagraphCollection">Gets the collection of paragraph objects that are in the range. Read-only. [Api set: WordApi]</field>
  9788. /// <field name="parentContentControl" type="Word.ContentControl">Gets the content control that contains the range. Returns null if there isn&apos;t a parent content control. Read-only. [Api set: WordApi]</field>
  9789. /// <field name="style" type="String">Gets or sets the style used for the range. This is the name of the pre-installed or custom style. [Api set: WordApi]</field>
  9790. /// <field name="text" type="String">Gets the text of the range. Read-only. [Api set: WordApi]</field>
  9791. }
  9792. Range.prototype.load = function(option) {
  9793. /// <summary>
  9794. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  9795. /// </summary>
  9796. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  9797. /// <returns type="Word.Range"/>
  9798. }
  9799. Range.prototype.clear = function() {
  9800. /// <summary>
  9801. /// Clears the contents of the range object. The user can perform the undo operation on the cleared content. [Api set: WordApi]
  9802. /// </summary>
  9803. /// <returns ></returns>
  9804. }
  9805. Range.prototype.delete = function() {
  9806. /// <summary>
  9807. /// Deletes the range and its content from the document. [Api set: WordApi]
  9808. /// </summary>
  9809. /// <returns ></returns>
  9810. }
  9811. Range.prototype.getHtml = function() {
  9812. /// <summary>
  9813. /// Gets the HTML representation of the range object. [Api set: WordApi]
  9814. /// </summary>
  9815. /// <returns type="OfficeExtension.ClientResult&lt;string&gt;"></returns>
  9816. var result = new OfficeExtension.ClientResult();
  9817. result.__proto__ = null;
  9818. result.value = '';
  9819. return result;
  9820. }
  9821. Range.prototype.getOoxml = function() {
  9822. /// <summary>
  9823. /// Gets the OOXML representation of the range object. [Api set: WordApi]
  9824. /// </summary>
  9825. /// <returns type="OfficeExtension.ClientResult&lt;string&gt;"></returns>
  9826. var result = new OfficeExtension.ClientResult();
  9827. result.__proto__ = null;
  9828. result.value = '';
  9829. return result;
  9830. }
  9831. Range.prototype.insertBreak = function(breakType, insertLocation) {
  9832. /// <summary>
  9833. /// Inserts a break at the specified location in the main document. The insertLocation value can be &apos;Replace&apos;, &apos;Before&apos; or &apos;After&apos;. [Api set: WordApi]
  9834. /// </summary>
  9835. /// <param name="breakType" type="String">Required. The break type to add.</param>
  9836. /// <param name="insertLocation" type="String">Required. The value can be &apos;Replace&apos;, &apos;Before&apos; or &apos;After&apos;.</param>
  9837. /// <returns ></returns>
  9838. }
  9839. Range.prototype.insertContentControl = function() {
  9840. /// <summary>
  9841. /// Wraps the range object with a rich text content control. [Api set: WordApi]
  9842. /// </summary>
  9843. /// <returns type="Word.ContentControl"></returns>
  9844. }
  9845. Range.prototype.insertFileFromBase64 = function(base64File, insertLocation) {
  9846. /// <summary>
  9847. /// Inserts a document at the specified location. The insertLocation value can be &apos;Replace&apos;, &apos;Start&apos;, &apos;End&apos;, &apos;Before&apos; or &apos;After&apos;. [Api set: WordApi]
  9848. /// </summary>
  9849. /// <param name="base64File" type="String">Required. The base64 encoded content of a .docx file.</param>
  9850. /// <param name="insertLocation" type="String">Required. The value can be &apos;Replace&apos;, &apos;Start&apos;, &apos;End&apos;, &apos;Before&apos; or &apos;After&apos;.</param>
  9851. /// <returns type="Word.Range"></returns>
  9852. }
  9853. Range.prototype.insertHtml = function(html, insertLocation) {
  9854. /// <summary>
  9855. /// Inserts HTML at the specified location. The insertLocation value can be &apos;Replace&apos;, &apos;Start&apos;, &apos;End&apos;, &apos;Before&apos; or &apos;After&apos;. [Api set: WordApi]
  9856. /// </summary>
  9857. /// <param name="html" type="String">Required. The HTML to be inserted.</param>
  9858. /// <param name="insertLocation" type="String">Required. The value can be &apos;Replace&apos;, &apos;Start&apos;, &apos;End&apos;, &apos;Before&apos; or &apos;After&apos;.</param>
  9859. /// <returns type="Word.Range"></returns>
  9860. }
  9861. Range.prototype.insertInlinePictureFromBase64 = function(base64EncodedImage, insertLocation) {
  9862. /// <summary>
  9863. /// Inserts a picture at the specified location. The insertLocation value can be &apos;Replace&apos;, &apos;Start&apos;, &apos;End&apos;, &apos;Before&apos; or &apos;After&apos;. [Api set: WordApi]
  9864. /// </summary>
  9865. /// <param name="base64EncodedImage" type="String">Required. The base64 encoded image to be inserted.</param>
  9866. /// <param name="insertLocation" type="String">Required. The value can be &apos;Replace&apos;, &apos;Start&apos;, &apos;End&apos;, &apos;Before&apos; or &apos;After&apos;.</param>
  9867. /// <returns type="Word.InlinePicture"></returns>
  9868. }
  9869. Range.prototype.insertOoxml = function(ooxml, insertLocation) {
  9870. /// <summary>
  9871. /// Inserts OOXML at the specified location. The insertLocation value can be &apos;Replace&apos;, &apos;Start&apos;, &apos;End&apos;, &apos;Before&apos; or &apos;After&apos;. [Api set: WordApi]
  9872. /// </summary>
  9873. /// <param name="ooxml" type="String">Required. The OOXML to be inserted.</param>
  9874. /// <param name="insertLocation" type="String">Required. The value can be &apos;Replace&apos;, &apos;Start&apos;, &apos;End&apos;, &apos;Before&apos; or &apos;After&apos;.</param>
  9875. /// <returns type="Word.Range"></returns>
  9876. }
  9877. Range.prototype.insertParagraph = function(paragraphText, insertLocation) {
  9878. /// <summary>
  9879. /// Inserts a paragraph at the specified location. The insertLocation value can be &apos;Before&apos; or &apos;After&apos;. [Api set: WordApi]
  9880. /// </summary>
  9881. /// <param name="paragraphText" type="String">Required. The paragraph text to be inserted.</param>
  9882. /// <param name="insertLocation" type="String">Required. The value can be &apos;Before&apos; or &apos;After&apos;.</param>
  9883. /// <returns type="Word.Paragraph"></returns>
  9884. }
  9885. Range.prototype.insertText = function(text, insertLocation) {
  9886. /// <summary>
  9887. /// Inserts text at the specified location. The insertLocation value can be &apos;Replace&apos;, &apos;Start&apos;, &apos;End&apos;, &apos;Before&apos; or &apos;After&apos;. [Api set: WordApi]
  9888. /// </summary>
  9889. /// <param name="text" type="String">Required. Text to be inserted.</param>
  9890. /// <param name="insertLocation" type="String">Required. The value can be &apos;Replace&apos;, &apos;Start&apos;, &apos;End&apos;, &apos;Before&apos; or &apos;After&apos;.</param>
  9891. /// <returns type="Word.Range"></returns>
  9892. }
  9893. Range.prototype.search = function(searchText, searchOptions) {
  9894. /// <summary>
  9895. /// Performs a search with the specified searchOptions on the scope of the range object. The search results are a collection of range objects. [Api set: WordApi]
  9896. /// </summary>
  9897. /// <param name="searchText" type="String">Required. The search text.</param>
  9898. /// <param name="searchOptions" type="Word.SearchOptions" optional="true">Optional. Options for the search.</param>
  9899. /// <returns type="Word.SearchResultCollection"></returns>
  9900. }
  9901. Range.prototype.select = function(selectionMode) {
  9902. /// <summary>
  9903. /// Selects and navigates the Word UI to the range. [Api set: WordApi]
  9904. /// </summary>
  9905. /// <param name="selectionMode" type="String" optional="true">Optional. The selection mode can be &apos;Select&apos;, &apos;Start&apos; or &apos;End&apos;. &apos;Select&apos; is the default.</param>
  9906. /// <returns ></returns>
  9907. }
  9908. return Range;
  9909. })(OfficeExtension.ClientObject);
  9910. Word.Range = Range;
  9911. })(Word || (Word = {}));
  9912. var Word;
  9913. (function (Word) {
  9914. var SearchOptions = (function(_super) {
  9915. __extends(SearchOptions, _super);
  9916. function SearchOptions() {
  9917. /// <summary> Specifies the options to be included in a search operation. [Api set: WordApi] </summary>
  9918. /// <field name="context" type="Word.RequestContext">The request context associated with this object</field>
  9919. /// <field name="ignorePunct" type="Boolean">Gets or sets a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. [Api set: WordApi]</field>
  9920. /// <field name="ignoreSpace" type="Boolean">Gets or sets a value that indicates whether to ignore all white space between words. Corresponds to the Ignore white-space characters check box in the Find and Replace dialog box. [Api set: WordApi]</field>
  9921. /// <field name="matchCase" type="Boolean">Gets or sets a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box (Edit menu). [Api set: WordApi]</field>
  9922. /// <field name="matchPrefix" type="Boolean">Gets or sets a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. [Api set: WordApi]</field>
  9923. /// <field name="matchSoundsLike" type="Boolean">Gets or sets a value that indicates whether to find words that sound similar to the search string. Corresponds to the Sounds like check box in the Find and Replace dialog box [Api set: WordApi]</field>
  9924. /// <field name="matchSuffix" type="Boolean">Gets or sets a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. [Api set: WordApi]</field>
  9925. /// <field name="matchWholeWord" type="Boolean">Gets or sets a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. [Api set: WordApi]</field>
  9926. /// <field name="matchWildcards" type="Boolean">Gets or sets a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. [Api set: WordApi]</field>
  9927. }
  9928. SearchOptions.prototype.load = function(option) {
  9929. /// <summary>
  9930. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  9931. /// </summary>
  9932. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  9933. /// <returns type="Word.SearchOptions"/>
  9934. }
  9935. return SearchOptions;
  9936. })(OfficeExtension.ClientObject);
  9937. Word.SearchOptions = SearchOptions;
  9938. })(Word || (Word = {}));
  9939. var Word;
  9940. (function (Word) {
  9941. var SearchResultCollection = (function(_super) {
  9942. __extends(SearchResultCollection, _super);
  9943. function SearchResultCollection() {
  9944. /// <summary> Contains a collection of [range](range.md) objects as a result of a search operation. [Api set: WordApi] </summary>
  9945. /// <field name="context" type="Word.RequestContext">The request context associated with this object</field>
  9946. /// <field name="items" type="Array" elementType="Word.Range">Gets the loaded child items in this collection.</field>
  9947. }
  9948. SearchResultCollection.prototype.load = function(option) {
  9949. /// <summary>
  9950. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  9951. /// </summary>
  9952. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  9953. /// <returns type="Word.SearchResultCollection"/>
  9954. }
  9955. return SearchResultCollection;
  9956. })(OfficeExtension.ClientObject);
  9957. Word.SearchResultCollection = SearchResultCollection;
  9958. })(Word || (Word = {}));
  9959. var Word;
  9960. (function (Word) {
  9961. var Section = (function(_super) {
  9962. __extends(Section, _super);
  9963. function Section() {
  9964. /// <summary> Represents a section in a Word document. [Api set: WordApi] </summary>
  9965. /// <field name="context" type="Word.RequestContext">The request context associated with this object</field>
  9966. /// <field name="body" type="Word.Body">Gets the body of the section. This does not include the header/footer and other section metadata. Read-only. [Api set: WordApi]</field>
  9967. }
  9968. Section.prototype.load = function(option) {
  9969. /// <summary>
  9970. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  9971. /// </summary>
  9972. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  9973. /// <returns type="Word.Section"/>
  9974. }
  9975. Section.prototype.getFooter = function(type) {
  9976. /// <summary>
  9977. /// Gets one of the section&apos;s footers. [Api set: WordApi]
  9978. /// </summary>
  9979. /// <param name="type" type="String">Required. The type of footer to return. This value can be: &apos;primary&apos;, &apos;firstPage&apos; or &apos;evenPages&apos;.</param>
  9980. /// <returns type="Word.Body"></returns>
  9981. }
  9982. Section.prototype.getHeader = function(type) {
  9983. /// <summary>
  9984. /// Gets one of the section&apos;s headers. [Api set: WordApi]
  9985. /// </summary>
  9986. /// <param name="type" type="String">Required. The type of header to return. This value can be: &apos;primary&apos;, &apos;firstPage&apos; or &apos;evenPages&apos;.</param>
  9987. /// <returns type="Word.Body"></returns>
  9988. }
  9989. return Section;
  9990. })(OfficeExtension.ClientObject);
  9991. Word.Section = Section;
  9992. })(Word || (Word = {}));
  9993. var Word;
  9994. (function (Word) {
  9995. var SectionCollection = (function(_super) {
  9996. __extends(SectionCollection, _super);
  9997. function SectionCollection() {
  9998. /// <summary> Contains the collection of the document&apos;s [section](section.md) objects. [Api set: WordApi] </summary>
  9999. /// <field name="context" type="Word.RequestContext">The request context associated with this object</field>
  10000. /// <field name="items" type="Array" elementType="Word.Section">Gets the loaded child items in this collection.</field>
  10001. }
  10002. SectionCollection.prototype.load = function(option) {
  10003. /// <summary>
  10004. /// Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.
  10005. /// </summary>
  10006. /// <param name="option" type="string | string[] | OfficeExtension.LoadOption"/>
  10007. /// <returns type="Word.SectionCollection"/>
  10008. }
  10009. return SectionCollection;
  10010. })(OfficeExtension.ClientObject);
  10011. Word.SectionCollection = SectionCollection;
  10012. })(Word || (Word = {}));
  10013. var Word;
  10014. (function (Word) {
  10015. /// <summary> [Api set: WordApi] </summary>
  10016. var SelectionMode = {
  10017. __proto__: null,
  10018. "select": "select",
  10019. "start": "start",
  10020. "end": "end",
  10021. }
  10022. Word.SelectionMode = SelectionMode;
  10023. })(Word || (Word = {}));
  10024. var Word;
  10025. (function (Word) {
  10026. /// <summary> Underline types [Api set: WordApi] </summary>
  10027. var UnderlineType = {
  10028. __proto__: null,
  10029. "none": "none",
  10030. "single": "single",
  10031. "word": "word",
  10032. "double": "double",
  10033. "dotted": "dotted",
  10034. "hidden": "hidden",
  10035. "thick": "thick",
  10036. "dashLine": "dashLine",
  10037. "dotLine": "dotLine",
  10038. "dotDashLine": "dotDashLine",
  10039. "twoDotDashLine": "twoDotDashLine",
  10040. "wave": "wave",
  10041. }
  10042. Word.UnderlineType = UnderlineType;
  10043. })(Word || (Word = {}));
  10044. var Word;
  10045. (function (Word) {
  10046. var RequestContext = (function (_super) {
  10047. __extends(RequestContext, _super);
  10048. function RequestContext() {
  10049. /// <summary>
  10050. /// The RequestContext object facilitates requests to the Word application. Since the Office add-in and the Word application run in two different processes, the request context is required to get access to the Word object model from the add-in.
  10051. /// </summary>
  10052. /// <field name="document" type="Word.Document">Root object for interacting with the document</field>
  10053. _super.call(this, null);
  10054. }
  10055. return RequestContext;
  10056. })(OfficeExtension.ClientRequestContext);
  10057. Word.RequestContext = RequestContext;
  10058. Word.run = function (batch) {
  10059. /// <summary>
  10060. /// Executes a batch script that performs actions on the Word object model. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
  10061. /// </summary>
  10062. /// <param name="batch" type="function(context) { ... }">
  10063. /// A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()").
  10064. /// <br />
  10065. /// The context parameter facilitates requests to the Word application. Since the Office add-in and the Word application run in two different processes, the request context is required to get access to the Word object model from the add-in.
  10066. /// </param>
  10067. batch(new Word.RequestContext());
  10068. return new OfficeExtension.IPromise();
  10069. }
  10070. })(Word || (Word = {}));
  10071. Word.__proto__ = null;