Infragistics2.Win.UltraWinCalcManager.v9.2.xml 816 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Infragistics2.Win.UltraWinCalcManager.v9.2</name>
  5. </assembly>
  6. <members>
  7. <member name="M:Infragistics.Shared.LocalizedCategoryAttribute.GetLocalizedString(System.String)">
  8. <summary>
  9. Returns the localized category name
  10. </summary>
  11. <param name="value">Name of the category to retreive</param>
  12. <returns>The localized string value</returns>
  13. </member>
  14. <!-- Badly formed XML comment ignored for member "T:PerCederberg.Grammatica.Parser.RE.AlternativeElement" -->
  15. <!-- Badly formed XML comment ignored for member "T:PerCederberg.Grammatica.Parser.RE.Element" -->
  16. <member name="M:PerCederberg.Grammatica.Parser.RE.Element.Clone">
  17. Creates a copy of this element. The copy will be an
  18. instance of the same class matching the same strings.
  19. Copies of elements are necessary to allow elements to cache
  20. intermediate results while matching strings without
  21. interfering with other threads.
  22. @return a copy of this element
  23. </member>
  24. <member name="M:PerCederberg.Grammatica.Parser.RE.Element.Match(PerCederberg.Grammatica.Parser.RE.Matcher,System.String,System.Int32,System.Int32)">
  25. Returns the length of a matching string starting at the
  26. specified position. The number of matches to skip can also
  27. be specified, but numbers higher than zero (0) cause a
  28. failed match for any element that doesn't attempt to
  29. combine other elements.
  30. @param m the matcher being used
  31. @param str the string to match
  32. @param start the starting position
  33. @param skip the number of matches to skip
  34. @return the length of the matching string, or
  35. -1 if no match was found
  36. </member>
  37. <member name="M:PerCederberg.Grammatica.Parser.RE.Element.PrintTo(System.IO.TextWriter,System.String)">
  38. Prints this element to the specified output stream.
  39. @param output the output stream to use
  40. @param indent the current indentation
  41. </member>
  42. <member name="F:PerCederberg.Grammatica.Parser.RE.AlternativeElement.elem1">
  43. The first alternative element.
  44. </member>
  45. <member name="F:PerCederberg.Grammatica.Parser.RE.AlternativeElement.elem2">
  46. The second alternative element.
  47. </member>
  48. <member name="M:PerCederberg.Grammatica.Parser.RE.AlternativeElement.#ctor(PerCederberg.Grammatica.Parser.RE.Element,PerCederberg.Grammatica.Parser.RE.Element)">
  49. Creates a new alternative element.
  50. @param first the first alternative
  51. @param second the second alternative
  52. </member>
  53. <member name="M:PerCederberg.Grammatica.Parser.RE.AlternativeElement.Clone">
  54. Creates a copy of this element. The copy will be an
  55. instance of the same class matching the same strings.
  56. Copies of elements are necessary to allow elements to cache
  57. intermediate results while matching strings without
  58. interfering with other threads.
  59. @return a copy of this element
  60. </member>
  61. <member name="M:PerCederberg.Grammatica.Parser.RE.AlternativeElement.Match(PerCederberg.Grammatica.Parser.RE.Matcher,System.String,System.Int32,System.Int32)">
  62. Returns the length of a matching string starting at the
  63. specified position. The number of matches to skip can also
  64. be specified, but numbers higher than zero (0) cause a
  65. failed match for any element that doesn't attempt to
  66. combine other elements.
  67. @param m the matcher being used
  68. @param str the string to match
  69. @param start the starting position
  70. @param skip the number of matches to skip
  71. @return the length of the longest matching string, or
  72. -1 if no match was found
  73. </member>
  74. <member name="M:PerCederberg.Grammatica.Parser.RE.AlternativeElement.PrintTo(System.IO.TextWriter,System.String)">
  75. Prints this element to the specified output stream.
  76. @param output the output stream to use
  77. @param indent the current indentation
  78. </member>
  79. <!-- Badly formed XML comment ignored for member "T:PerCederberg.Grammatica.Parser.RE.CharacterSetElement" -->
  80. <member name="F:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.DOT">
  81. The dot ('.') character set. This element matches a single
  82. character that is not equal to a newline character.
  83. </member>
  84. <member name="F:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.DIGIT">
  85. The digit character set. This element matches a single
  86. numeric character.
  87. </member>
  88. <member name="F:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.NON_DIGIT">
  89. The non-digit character set. This element matches a single
  90. non-numeric character.
  91. </member>
  92. <member name="F:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.WHITESPACE">
  93. The whitespace character set. This element matches a single
  94. whitespace character.
  95. </member>
  96. <member name="F:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.NON_WHITESPACE">
  97. The non-whitespace character set. This element matches a
  98. single non-whitespace character.
  99. </member>
  100. <member name="F:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.WORD">
  101. The word character set. This element matches a single word
  102. character.
  103. </member>
  104. <member name="F:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.NON_WORD">
  105. The non-word character set. This element matches a single
  106. non-word character.
  107. </member>
  108. <member name="F:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.inverted">
  109. The inverted character set flag.
  110. </member>
  111. <member name="F:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.contents">
  112. The character set content. This array may contain either
  113. range objects or Character objects.
  114. </member>
  115. <member name="M:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.#ctor(System.Boolean)">
  116. Creates a new character set element. If the inverted character
  117. set flag is set, only characters NOT in the set will match.
  118. @param inverted the inverted character set flag
  119. </member>
  120. <member name="M:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.AddCharacter(System.Char)">
  121. Adds a single character to this character set.
  122. @param c the character to add
  123. </member>
  124. <member name="M:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.AddCharacters(System.String)">
  125. Adds multiple characters to this character set.
  126. @param str the string with characters to add
  127. </member>
  128. <member name="M:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.AddCharacters(PerCederberg.Grammatica.Parser.RE.StringElement)">
  129. Adds multiple characters to this character set.
  130. @param elem the string element with characters to add
  131. </member>
  132. <member name="M:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.AddRange(System.Char,System.Char)">
  133. Adds a character range to this character set.
  134. @param min the minimum character value
  135. @param max the maximum character value
  136. </member>
  137. <member name="M:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.AddCharacterSet(PerCederberg.Grammatica.Parser.RE.CharacterSetElement)">
  138. Adds a character subset to this character set.
  139. @param elem the character set to add
  140. </member>
  141. <member name="M:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.Clone">
  142. Returns this element as the character set shouldn't be
  143. modified after creation. This partially breaks the contract
  144. of clone(), but as new characters are not added to the
  145. character set after creation, this will work correctly.
  146. @return this character set element
  147. </member>
  148. <member name="M:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.Match(PerCederberg.Grammatica.Parser.RE.Matcher,System.String,System.Int32,System.Int32)">
  149. Returns the length of a matching string starting at the
  150. specified position. The number of matches to skip can also be
  151. specified, but numbers higher than zero (0) cause a failed
  152. match for any element that doesn't attempt to combine other
  153. elements.
  154. @param m the matcher being used
  155. @param str the string to match
  156. @param start the starting position
  157. @param skip the number of matches to skip
  158. @return the length of the matching string, or
  159. -1 if no match was found
  160. </member>
  161. <member name="M:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.InSet(System.Char)">
  162. Checks if the specified character matches this character
  163. set. This method takes the inverted flag into account.
  164. @param c the character to check
  165. @return true if the character matches, or
  166. false otherwise
  167. </member>
  168. <member name="M:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.InDotSet(System.Char)">
  169. Checks if the specified character is present in the 'dot'
  170. set. This method does not consider the inverted flag.
  171. @param c the character to check
  172. @return true if the character is present, or
  173. false otherwise
  174. </member>
  175. <member name="M:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.InDigitSet(System.Char)">
  176. Checks if the specified character is a digit. This method
  177. does not consider the inverted flag.
  178. @param c the character to check
  179. @return true if the character is a digit, or
  180. false otherwise
  181. </member>
  182. <member name="M:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.InWhitespaceSet(System.Char)">
  183. Checks if the specified character is a whitespace
  184. character. This method does not consider the inverted flag.
  185. @param c the character to check
  186. @return true if the character is a whitespace character, or
  187. false otherwise
  188. </member>
  189. <member name="M:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.InWordSet(System.Char)">
  190. Checks if the specified character is a word character. This
  191. method does not consider the inverted flag.
  192. @param c the character to check
  193. @return true if the character is a word character, or
  194. false otherwise
  195. </member>
  196. <member name="M:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.InUserSet(System.Char)">
  197. Checks if the specified character is present in the user-
  198. defined set. This method does not consider the inverted
  199. flag.
  200. @param value the character to check
  201. @return true if the character is present, or
  202. false otherwise
  203. </member>
  204. <member name="M:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.PrintTo(System.IO.TextWriter,System.String)">
  205. Prints this element to the specified output stream.
  206. @param output the output stream to use
  207. @param indent the current indentation
  208. </member>
  209. <member name="M:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.ToString">
  210. Returns a string description of this character set.
  211. @return a string description of this character set
  212. </member>
  213. <member name="T:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.Range">
  214. A character range class.
  215. </member>
  216. <member name="F:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.Range.min">
  217. The minimum character value.
  218. </member>
  219. <member name="F:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.Range.max">
  220. The maximum character value.
  221. </member>
  222. <member name="M:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.Range.#ctor(System.Char,System.Char)">
  223. Creates a new character range.
  224. @param min the minimum character value
  225. @param max the maximum character value
  226. </member>
  227. <member name="M:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.Range.Inside(System.Char)">
  228. Checks if the specified character is inside the range.
  229. @param c the character to check
  230. @return true if the character is in the range, or
  231. false otherwise
  232. </member>
  233. <member name="M:PerCederberg.Grammatica.Parser.RE.CharacterSetElement.Range.ToString">
  234. Returns a string representation of this object.
  235. @return a string representation of this object
  236. </member>
  237. <!-- Badly formed XML comment ignored for member "T:PerCederberg.Grammatica.Parser.RE.CombineElement" -->
  238. <member name="F:PerCederberg.Grammatica.Parser.RE.CombineElement.elem1">
  239. The first element.
  240. </member>
  241. <member name="F:PerCederberg.Grammatica.Parser.RE.CombineElement.elem2">
  242. The second element.
  243. </member>
  244. <member name="M:PerCederberg.Grammatica.Parser.RE.CombineElement.#ctor(PerCederberg.Grammatica.Parser.RE.Element,PerCederberg.Grammatica.Parser.RE.Element)">
  245. Creates a new combine element.
  246. @param first the first element
  247. @param second the second element
  248. </member>
  249. <member name="M:PerCederberg.Grammatica.Parser.RE.CombineElement.Clone">
  250. Creates a copy of this element. The copy will be an
  251. instance of the same class matching the same strings.
  252. Copies of elements are necessary to allow elements to cache
  253. intermediate results while matching strings without
  254. interfering with other threads.
  255. @return a copy of this element
  256. </member>
  257. <member name="M:PerCederberg.Grammatica.Parser.RE.CombineElement.Match(PerCederberg.Grammatica.Parser.RE.Matcher,System.String,System.Int32,System.Int32)">
  258. Returns the length of a matching string starting at the
  259. specified position. The number of matches to skip can also be
  260. specified, but numbers higher than zero (0) cause a failed
  261. match for any element that doesn't attempt to combine other
  262. elements.
  263. @param m the matcher being used
  264. @param str the string to match
  265. @param start the starting position
  266. @param skip the number of matches to skip
  267. @return the length of the longest matching string, or
  268. -1 if no match was found
  269. </member>
  270. <member name="M:PerCederberg.Grammatica.Parser.RE.CombineElement.PrintTo(System.IO.TextWriter,System.String)">
  271. Prints this element to the specified output stream.
  272. @param output the output stream to use
  273. @param indent the current indentation
  274. </member>
  275. <!-- Badly formed XML comment ignored for member "T:PerCederberg.Grammatica.Parser.RE.Matcher" -->
  276. <member name="F:PerCederberg.Grammatica.Parser.RE.Matcher.element">
  277. The base regular expression element.
  278. </member>
  279. <member name="F:PerCederberg.Grammatica.Parser.RE.Matcher.str">
  280. The string to work with
  281. </member>
  282. <member name="F:PerCederberg.Grammatica.Parser.RE.Matcher.start">
  283. The start of the latest match found.
  284. </member>
  285. <member name="F:PerCederberg.Grammatica.Parser.RE.Matcher.length">
  286. The length of the latest match found.
  287. </member>
  288. <member name="F:PerCederberg.Grammatica.Parser.RE.Matcher.endOfString">
  289. The end of string reached flag. This flag is set if the end
  290. of the string was encountered during the latest match.
  291. </member>
  292. <member name="M:PerCederberg.Grammatica.Parser.RE.Matcher.#ctor(PerCederberg.Grammatica.Parser.RE.Element,System.String)">
  293. Creates a new matcher with the specified element.
  294. @param e the base regular expression element
  295. @param str the string to work with
  296. </member>
  297. <member name="M:PerCederberg.Grammatica.Parser.RE.Matcher.Reset">
  298. Resets the information about the last match. This will
  299. clear all flags and set the match length to a negative
  300. value. This method is automatically called by all matching
  301. methods.
  302. </member>
  303. <member name="M:PerCederberg.Grammatica.Parser.RE.Matcher.Start">
  304. Returns the start position of the latest match. If no match
  305. has been encountered, this method returns zero (0).
  306. @return the start position of the latest match
  307. </member>
  308. <member name="M:PerCederberg.Grammatica.Parser.RE.Matcher.End">
  309. Returns the end position of the latest match. This is one
  310. character after the match end, i.e. the first character
  311. after the match. If no match has been encountered, this
  312. method returns the same value as start().
  313. @return the end position of the latest match
  314. </member>
  315. <member name="M:PerCederberg.Grammatica.Parser.RE.Matcher.Length">
  316. Returns the length of the latest match.
  317. @return the length of the latest match, or
  318. -1 if no match was found
  319. </member>
  320. <member name="M:PerCederberg.Grammatica.Parser.RE.Matcher.HasReadEndOfString">
  321. Checks if the end of the string was encountered during the
  322. last match attempt. This flag signals that more input may
  323. be needed in order to get a match (or a longer match).
  324. @return true if the end of string was encountered, or
  325. false otherwise
  326. </member>
  327. <member name="M:PerCederberg.Grammatica.Parser.RE.Matcher.MatchFromBeginning">
  328. Attempts to find a match starting at the beginning of the
  329. string.
  330. @return true if a match was found, or
  331. false otherwise
  332. </member>
  333. <member name="M:PerCederberg.Grammatica.Parser.RE.Matcher.MatchFrom(System.Int32)">
  334. Attempts to find a match starting at the specified position
  335. in the string.
  336. @param pos the starting position of the match
  337. @return true if a match was found, or
  338. false otherwise
  339. </member>
  340. <member name="M:PerCederberg.Grammatica.Parser.RE.Matcher.ToString">
  341. Returns the latest matched string. If no string has been
  342. matched, an empty string will be returned.
  343. @return the latest matched string
  344. </member>
  345. <member name="M:PerCederberg.Grammatica.Parser.RE.Matcher.SetReadEndOfString">
  346. Sets the end of string encountered flag. This method is
  347. called by the various elements analyzing the string.
  348. </member>
  349. <!-- Badly formed XML comment ignored for member "T:PerCederberg.Grammatica.Parser.RE.RegExp" -->
  350. <member name="F:PerCederberg.Grammatica.Parser.RE.RegExp.element">
  351. The base regular expression element.
  352. </member>
  353. <member name="F:PerCederberg.Grammatica.Parser.RE.RegExp.pattern">
  354. The regular expression pattern.
  355. </member>
  356. <member name="F:PerCederberg.Grammatica.Parser.RE.RegExp.pos">
  357. The current position in the pattern. This variable is used by
  358. the parsing methods.
  359. </member>
  360. <member name="M:PerCederberg.Grammatica.Parser.RE.RegExp.#ctor(System.String)">
  361. Creates a new regular expression.
  362. @param pattern the regular expression pattern
  363. @throws RegExpException if the regular expression couldn't be
  364. parsed correctly
  365. </member>
  366. <member name="M:PerCederberg.Grammatica.Parser.RE.RegExp.Matcher(System.String)">
  367. Creates a new matcher for the specified string.
  368. @param str the string to work with
  369. @return the regular expresion matcher
  370. </member>
  371. <member name="M:PerCederberg.Grammatica.Parser.RE.RegExp.ToString">
  372. Returns a string representation of the regular expression.
  373. @return a string representation of the regular expression
  374. </member>
  375. <member name="M:PerCederberg.Grammatica.Parser.RE.RegExp.ParseExpr">
  376. Parses a regular expression. This method handles the Expr
  377. production in the grammar (see regexp.grammar).
  378. @return the element representing this expression
  379. @throws RegExpException if an error was encountered in the
  380. pattern string
  381. </member>
  382. <member name="M:PerCederberg.Grammatica.Parser.RE.RegExp.ParseTerm">
  383. Parses a regular expression term. This method handles the
  384. Term production in the grammar (see regexp.grammar).
  385. @return the element representing this term
  386. @throws RegExpException if an error was encountered in the
  387. pattern string
  388. </member>
  389. <member name="M:PerCederberg.Grammatica.Parser.RE.RegExp.ParseFact">
  390. Parses a regular expression factor. This method handles the
  391. Fact production in the grammar (see regexp.grammar).
  392. @return the element representing this factor
  393. @throws RegExpException if an error was encountered in the
  394. pattern string
  395. </member>
  396. <member name="M:PerCederberg.Grammatica.Parser.RE.RegExp.ParseAtom">
  397. Parses a regular expression atom. This method handles the
  398. Atom production in the grammar (see regexp.grammar).
  399. @return the element representing this atom
  400. @throws RegExpException if an error was encountered in the
  401. pattern string
  402. </member>
  403. <member name="M:PerCederberg.Grammatica.Parser.RE.RegExp.ParseAtomModifier(PerCederberg.Grammatica.Parser.RE.Element)">
  404. Parses a regular expression atom modifier. This method handles
  405. the AtomModifier production in the grammar (see regexp.grammar).
  406. @param elem the element to modify
  407. @return the modified element
  408. @throws RegExpException if an error was encountered in the
  409. pattern string
  410. </member>
  411. <member name="M:PerCederberg.Grammatica.Parser.RE.RegExp.ParseCharSet">
  412. Parses a regular expression character set. This method handles
  413. the contents of the '[...]' construct in a regular expression.
  414. @return the element representing this character set
  415. @throws RegExpException if an error was encountered in the
  416. pattern string
  417. </member>
  418. <member name="M:PerCederberg.Grammatica.Parser.RE.RegExp.ParseChar">
  419. Parses a regular expression character. This method handles
  420. a single normal character in a regular expression.
  421. @return the element representing this character
  422. @throws RegExpException if an error was encountered in the
  423. pattern string
  424. </member>
  425. <member name="M:PerCederberg.Grammatica.Parser.RE.RegExp.ParseEscapeChar">
  426. Parses a regular expression character escape. This method
  427. handles a single character escape in a regular expression.
  428. @return the element representing this character escape
  429. @throws RegExpException if an error was encountered in the
  430. pattern string
  431. </member>
  432. <member name="M:PerCederberg.Grammatica.Parser.RE.RegExp.ReadNumber">
  433. Reads a number from the pattern. If the next character isn't a
  434. numeric character, an exception is thrown. This method reads
  435. several consecutive numeric characters.
  436. @return the numeric value read
  437. @throws RegExpException if an error was encountered in the
  438. pattern string
  439. </member>
  440. <member name="M:PerCederberg.Grammatica.Parser.RE.RegExp.ReadChar">
  441. Reads the next character in the pattern. If no next character
  442. exists, an exception is thrown.
  443. @return the character read
  444. @throws RegExpException if no next character was available in
  445. the pattern string
  446. </member>
  447. <member name="M:PerCederberg.Grammatica.Parser.RE.RegExp.ReadChar(System.Char)">
  448. Reads the next character in the pattern. If the character
  449. wasn't the specified one, an exception is thrown.
  450. @param c the character to read
  451. @return the character read
  452. @throws RegExpException if the character read didn't match the
  453. specified one, or if no next character was
  454. available in the pattern string
  455. </member>
  456. <member name="M:PerCederberg.Grammatica.Parser.RE.RegExp.PeekChar(System.Int32)">
  457. Returns a character that has not yet been read from the
  458. pattern. If the requested position is beyond the end of the
  459. pattern string, -1 is returned.
  460. @param count the preview position, from zero (0)
  461. @return the character found, or
  462. -1 if beyond the end of the pattern string
  463. </member>
  464. <member name="M:PerCederberg.Grammatica.Parser.RE.RegExp.CombineElements(System.Collections.ArrayList)">
  465. Combines a list of elements. This method takes care to always
  466. concatenate adjacent string elements into a single string
  467. element.
  468. @param list the list with elements
  469. @return the combined element
  470. </member>
  471. <!-- Badly formed XML comment ignored for member "T:PerCederberg.Grammatica.Parser.RE.RegExpException" -->
  472. <member name="F:PerCederberg.Grammatica.Parser.RE.RegExpException.type">
  473. The error type constant.
  474. </member>
  475. <member name="F:PerCederberg.Grammatica.Parser.RE.RegExpException.position">
  476. The error position.
  477. </member>
  478. <member name="F:PerCederberg.Grammatica.Parser.RE.RegExpException.pattern">
  479. The regular expression pattern.
  480. </member>
  481. <member name="M:PerCederberg.Grammatica.Parser.RE.RegExpException.#ctor(PerCederberg.Grammatica.Parser.RE.RegExpException.ErrorType,System.Int32,System.String)">
  482. Creates a new regular expression exception.
  483. @param type the error type constant
  484. @param pos the error position
  485. @param pattern the regular expression pattern
  486. </member>
  487. <member name="M:PerCederberg.Grammatica.Parser.RE.RegExpException.GetMessage">
  488. Returns the exception error message.
  489. @return the exception error message
  490. </member>
  491. <member name="P:PerCederberg.Grammatica.Parser.RE.RegExpException.Message">
  492. The message property. This property contains the detailed
  493. exception error message.
  494. </member>
  495. <member name="T:PerCederberg.Grammatica.Parser.RE.RegExpException.ErrorType">
  496. The error type enumeration.
  497. </member>
  498. <!-- Badly formed XML comment ignored for member "T:PerCederberg.Grammatica.Parser.RE.RepeatElement" -->
  499. <member name="F:PerCederberg.Grammatica.Parser.RE.RepeatElement.elem">
  500. The element to repeat.
  501. </member>
  502. <member name="F:PerCederberg.Grammatica.Parser.RE.RepeatElement.min">
  503. The minimum number of repetitions.
  504. </member>
  505. <member name="F:PerCederberg.Grammatica.Parser.RE.RepeatElement.max">
  506. The maximum number of repetitions.
  507. </member>
  508. <member name="F:PerCederberg.Grammatica.Parser.RE.RepeatElement.type">
  509. The repeat type.
  510. </member>
  511. <member name="F:PerCederberg.Grammatica.Parser.RE.RepeatElement.matchStart">
  512. The start position of the last set of matches.
  513. </member>
  514. <member name="F:PerCederberg.Grammatica.Parser.RE.RepeatElement.matches">
  515. A set with all matches starting at matchStart. A match with
  516. a specific length is reported by a non-zero bit in the bit
  517. array.
  518. </member>
  519. <member name="M:PerCederberg.Grammatica.Parser.RE.RepeatElement.#ctor(PerCederberg.Grammatica.Parser.RE.Element,System.Int32,System.Int32,PerCederberg.Grammatica.Parser.RE.RepeatElement.RepeatType)">
  520. Creats a new element repeater.
  521. @param elem the element to repeat
  522. @param min the minimum count
  523. @param max the maximum count
  524. @param type the repeat type constant
  525. </member>
  526. <member name="M:PerCederberg.Grammatica.Parser.RE.RepeatElement.Clone">
  527. Creates a copy of this element. The copy will be an
  528. instance of the same class matching the same strings.
  529. Copies of elements are necessary to allow elements to cache
  530. intermediate results while matching strings without
  531. interfering with other threads.
  532. @return a copy of this element
  533. </member>
  534. <member name="M:PerCederberg.Grammatica.Parser.RE.RepeatElement.Match(PerCederberg.Grammatica.Parser.RE.Matcher,System.String,System.Int32,System.Int32)">
  535. Returns the length of a matching string starting at the
  536. specified position. The number of matches to skip can also be
  537. specified.
  538. @param m the matcher being used
  539. @param str the string to match
  540. @param start the starting position
  541. @param skip the number of matches to skip
  542. @return the length of the matching string, or
  543. -1 if no match was found
  544. </member>
  545. <member name="M:PerCederberg.Grammatica.Parser.RE.RepeatElement.MatchGreedy(PerCederberg.Grammatica.Parser.RE.Matcher,System.String,System.Int32,System.Int32)">
  546. Returns the length of the longest possible matching string
  547. starting at the specified position. The number of matches
  548. to skip can also be specified.
  549. @param m the matcher being used
  550. @param str the string to match
  551. @param start the starting position
  552. @param skip the number of matches to skip
  553. @return the length of the longest matching string, or
  554. -1 if no match was found
  555. </member>
  556. <member name="M:PerCederberg.Grammatica.Parser.RE.RepeatElement.MatchReluctant(PerCederberg.Grammatica.Parser.RE.Matcher,System.String,System.Int32,System.Int32)">
  557. Returns the length of the shortest possible matchine string
  558. starting at the specified position. The number of matches to
  559. skip can also be specified.
  560. @param m the matcher being used
  561. @param str the string to match
  562. @param start the starting position
  563. @param skip the number of matches to skip
  564. @return the length of the shortest matching string, or
  565. -1 if no match was found
  566. </member>
  567. <member name="M:PerCederberg.Grammatica.Parser.RE.RepeatElement.MatchPossessive(PerCederberg.Grammatica.Parser.RE.Matcher,System.String,System.Int32,System.Int32)">
  568. Returns the length of the maximum number of elements matching
  569. the string starting at the specified position. This method
  570. allows no backtracking, i.e. no skips..
  571. @param m the matcher being used
  572. @param str the string to match
  573. @param start the starting position
  574. @param count the start count, normally zero (0)
  575. @return the length of the longest matching string, or
  576. -1 if no match was found
  577. </member>
  578. <member name="M:PerCederberg.Grammatica.Parser.RE.RepeatElement.FindMatches(PerCederberg.Grammatica.Parser.RE.Matcher,System.String,System.Int32,System.Int32,System.Int32,System.Int32)">
  579. Finds all matches and adds the lengths to the matches set.
  580. @param m the matcher being used
  581. @param str the string to match
  582. @param start the starting position
  583. @param length the match length at the start position
  584. @param count the number of sub-elements matched
  585. @param attempt the number of match attempts here
  586. </member>
  587. <member name="M:PerCederberg.Grammatica.Parser.RE.RepeatElement.PrintTo(System.IO.TextWriter,System.String)">
  588. Prints this element to the specified output stream.
  589. @param output the output stream to use
  590. @param indent the current indentation
  591. </member>
  592. <member name="T:PerCederberg.Grammatica.Parser.RE.RepeatElement.RepeatType">
  593. The repeat type constants.
  594. </member>
  595. <!-- Badly formed XML comment ignored for member "T:PerCederberg.Grammatica.Parser.RE.StringElement" -->
  596. <member name="F:PerCederberg.Grammatica.Parser.RE.StringElement.value">
  597. The string to match with.
  598. </member>
  599. <member name="M:PerCederberg.Grammatica.Parser.RE.StringElement.#ctor(System.Char)">
  600. Creates a new string element.
  601. @param c the character to match with
  602. </member>
  603. <member name="M:PerCederberg.Grammatica.Parser.RE.StringElement.#ctor(System.String)">
  604. Creates a new string element.
  605. @param str the string to match with
  606. </member>
  607. <member name="M:PerCederberg.Grammatica.Parser.RE.StringElement.GetString">
  608. Returns the string to be matched.
  609. @return the string to be matched
  610. </member>
  611. <member name="M:PerCederberg.Grammatica.Parser.RE.StringElement.Clone">
  612. Returns this element as it is immutable.
  613. @return this string element
  614. </member>
  615. <member name="M:PerCederberg.Grammatica.Parser.RE.StringElement.Match(PerCederberg.Grammatica.Parser.RE.Matcher,System.String,System.Int32,System.Int32)">
  616. Returns the length of a matching string starting at the
  617. specified position. The number of matches to skip can also
  618. be specified, but numbers higher than zero (0) cause a
  619. failed match for any element that doesn't attempt to
  620. combine other elements.
  621. @param m the matcher being used
  622. @param str the string to match
  623. @param start the starting position
  624. @param skip the number of matches to skip
  625. @return the length of the longest matching string, or
  626. -1 if no match was found
  627. </member>
  628. <member name="M:PerCederberg.Grammatica.Parser.RE.StringElement.PrintTo(System.IO.TextWriter,System.String)">
  629. Prints this element to the specified output stream.
  630. @param output the output stream to use
  631. @param indent the current indentation
  632. </member>
  633. <!-- Badly formed XML comment ignored for member "T:PerCederberg.Grammatica.Parser.Analyzer" -->
  634. <member name="M:PerCederberg.Grammatica.Parser.Analyzer.#ctor">
  635. Creates a new parse tree analyzer.
  636. </member>
  637. <member name="M:PerCederberg.Grammatica.Parser.Analyzer.Analyze(PerCederberg.Grammatica.Parser.Node)">
  638. Analyzes a parse tree node by traversing all it's child nodes.
  639. The tree traversal is depth-first, and the appropriate
  640. callback methods will be called. If the node is a production
  641. node, a new production node will be created and children will
  642. be added by recursively processing the children of the
  643. specified production node. This method is used to process a
  644. parse tree after creation.
  645. @param node the parse tree node to process
  646. @return the resulting parse tree node
  647. @throws ParserLogException if the node analysis discovered
  648. errors
  649. </member>
  650. <member name="M:PerCederberg.Grammatica.Parser.Analyzer.Analyze(PerCederberg.Grammatica.Parser.Node,PerCederberg.Grammatica.Parser.ParserLogException)">
  651. Analyzes a parse tree node by traversing all it's child nodes.
  652. The tree traversal is depth-first, and the appropriate
  653. callback methods will be called. If the node is a production
  654. node, a new production node will be created and children will
  655. be added by recursively processing the children of the
  656. specified production node. This method is used to process a
  657. parse tree after creation.
  658. @param node the parse tree node to process
  659. @param log the parser error log
  660. @return the resulting parse tree node
  661. </member>
  662. <member name="M:PerCederberg.Grammatica.Parser.Analyzer.Enter(PerCederberg.Grammatica.Parser.Node)">
  663. Called when entering a parse tree node. By default this method
  664. does nothing. A subclass can override this method to handle
  665. each node separately.
  666. @param node the node being entered
  667. @throws ParseException if the node analysis discovered errors
  668. </member>
  669. <member name="M:PerCederberg.Grammatica.Parser.Analyzer.Exit(PerCederberg.Grammatica.Parser.Node)">
  670. Called when exiting a parse tree node. By default this method
  671. returns the node. A subclass can override this method to handle
  672. each node separately. If no parse tree should be created, this
  673. method should return null.
  674. @param node the node being exited
  675. @return the node to add to the parse tree, or
  676. null if no parse tree should be created
  677. @throws ParseException if the node analysis discovered errors
  678. </member>
  679. <member name="M:PerCederberg.Grammatica.Parser.Analyzer.Child(PerCederberg.Grammatica.Parser.Production,PerCederberg.Grammatica.Parser.Node)">
  680. Called when adding a child to a parse tree node. By default
  681. this method adds the child to the production node. A subclass
  682. can override this method to handle each node separately. Note
  683. that the child node may be null if the corresponding exit()
  684. method returned null.
  685. @param node the parent node
  686. @param child the child node, or null
  687. @throws ParseException if the node analysis discovered errors
  688. </member>
  689. <member name="M:PerCederberg.Grammatica.Parser.Analyzer.GetChildAt(PerCederberg.Grammatica.Parser.Node,System.Int32)">
  690. Returns a child at the specified position. If either the node
  691. or the child node is null, this method will throw a parse
  692. exception with the internal error type.
  693. @param node the parent node
  694. @param pos the child position
  695. @return the child node
  696. @throws ParseException if either the node or the child node
  697. was null
  698. </member>
  699. <member name="M:PerCederberg.Grammatica.Parser.Analyzer.GetChildWithId(PerCederberg.Grammatica.Parser.Node,System.Int32)">
  700. Returns the first child with the specified id. If the node is
  701. null, or no child with the specified id could be found, this
  702. method will throw a parse exception with the internal error
  703. type.
  704. @param node the parent node
  705. @param id the child node id
  706. @return the child node
  707. @throws ParseException if the node was null, or a child node
  708. couldn't be found
  709. </member>
  710. <member name="M:PerCederberg.Grammatica.Parser.Analyzer.GetValue(PerCederberg.Grammatica.Parser.Node,System.Int32)">
  711. Returns the node value at the specified position. If either
  712. the node or the value is null, this method will throw a parse
  713. exception with the internal error type.
  714. @param node the parse tree node
  715. @param pos the child position
  716. @return the value object
  717. @throws ParseException if either the node or the value was null
  718. </member>
  719. <member name="M:PerCederberg.Grammatica.Parser.Analyzer.GetIntValue(PerCederberg.Grammatica.Parser.Node,System.Int32)">
  720. Returns the node integer value at the specified position. If
  721. either the node is null, or the value is not an instance of
  722. the Integer class, this method will throw a parse exception
  723. with the internal error type.
  724. @param node the parse tree node
  725. @param pos the child position
  726. @return the value object
  727. @throws ParseException if either the node was null, or the
  728. value wasn't an integer
  729. </member>
  730. <member name="M:PerCederberg.Grammatica.Parser.Analyzer.GetStringValue(PerCederberg.Grammatica.Parser.Node,System.Int32)">
  731. Returns the node string value at the specified position. If
  732. either the node is null, or the value is not an instance of
  733. the String class, this method will throw a parse exception
  734. with the internal error type.
  735. @param node the parse tree node
  736. @param pos the child position
  737. @return the value object
  738. @throws ParseException if either the node was null, or the
  739. value wasn't a string
  740. </member>
  741. <member name="M:PerCederberg.Grammatica.Parser.Analyzer.GetChildValues(PerCederberg.Grammatica.Parser.Node)">
  742. Returns all the node values for all child nodes.
  743. @param node the parse tree node
  744. @return a list with all the child node values
  745. @since 1.3
  746. </member>
  747. <!-- Badly formed XML comment ignored for member "T:PerCederberg.Grammatica.Parser.LookAheadSet" -->
  748. <member name="F:PerCederberg.Grammatica.Parser.LookAheadSet.elements">
  749. The set of token look-ahead sequences. Each sequence in
  750. turn is represented by an ArrayList with Integers for the
  751. token id:s.
  752. </member>
  753. <member name="F:PerCederberg.Grammatica.Parser.LookAheadSet.maxLength">
  754. The maximum length of any look-ahead sequence.
  755. </member>
  756. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.#ctor(System.Int32)">
  757. Creates a new look-ahead set with the specified maximum
  758. length.
  759. @param maxLength the maximum token sequence length
  760. </member>
  761. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.#ctor(System.Int32,PerCederberg.Grammatica.Parser.LookAheadSet)">
  762. Creates a duplicate look-ahead set, possibly with a
  763. different maximum length.
  764. @param maxLength the maximum token sequence length
  765. @param set the look-ahead set to copy
  766. </member>
  767. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.Size">
  768. Returns the size of this look-ahead set.
  769. @return the number of token sequences in the set
  770. </member>
  771. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.GetMinLength">
  772. Returns the length of the shortest token sequence in this
  773. set. This method will return zero (0) if the set is empty.
  774. @return the length of the shortest token sequence
  775. </member>
  776. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.GetMaxLength">
  777. Returns the length of the longest token sequence in this
  778. set. This method will return zero (0) if the set is empty.
  779. @return the length of the longest token sequence
  780. </member>
  781. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.GetInitialTokens">
  782. Returns a list of the initial token id:s in this look-ahead
  783. set. The list returned will not contain any duplicates.
  784. @return a list of the inital token id:s in this look-ahead set
  785. </member>
  786. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.IsRepetitive">
  787. Checks if this look-ahead set contains a repetitive token
  788. sequence.
  789. @return true if at least one token sequence is repetitive, or
  790. false otherwise
  791. </member>
  792. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.IsNext(PerCederberg.Grammatica.Parser.Parser)">
  793. Checks if the next token(s) in the parser match any token
  794. sequence in this set.
  795. @param parser the parser to check
  796. @return true if the next tokens are in the set, or
  797. false otherwise
  798. </member>
  799. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.IsNext(PerCederberg.Grammatica.Parser.Parser,System.Int32)">
  800. Checks if the next token(s) in the parser match any token
  801. sequence in this set.
  802. @param parser the parser to check
  803. @param length the maximum number of tokens to check
  804. @return true if the next tokens are in the set, or
  805. false otherwise
  806. </member>
  807. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.IsOverlap(PerCederberg.Grammatica.Parser.LookAheadSet)">
  808. Checks if another look-ahead set has an overlapping token
  809. sequence. An overlapping token sequence is a token sequence
  810. that is identical to another sequence, but for the length.
  811. I.e. one of the two sequences may be longer than the other.
  812. @param set the look-ahead set to check
  813. @return true if there is some token sequence that overlaps, or
  814. false otherwise
  815. </member>
  816. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.IsOverlap(PerCederberg.Grammatica.Parser.LookAheadSet.Sequence)">
  817. Checks if a token sequence is overlapping. An overlapping token
  818. sequence is a token sequence that is identical to another
  819. sequence, but for the length. I.e. one of the two sequences may
  820. be longer than the other.
  821. @param seq the token sequence to check
  822. @return true if there is some token sequence that overlaps, or
  823. false otherwise
  824. </member>
  825. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.Contains(PerCederberg.Grammatica.Parser.LookAheadSet.Sequence)">
  826. Checks if the specified token sequence is present in the
  827. set.
  828. @param elem the token sequence to check
  829. @return true if the sequence is present in this set, or
  830. false otherwise
  831. </member>
  832. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.Intersects(PerCederberg.Grammatica.Parser.LookAheadSet)">
  833. Checks if some token sequence is present in both this set
  834. and a specified one.
  835. @param set the look-ahead set to compare with
  836. @return true if the look-ahead sets intersect, or
  837. false otherwise
  838. </member>
  839. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.FindSequence(PerCederberg.Grammatica.Parser.LookAheadSet.Sequence)">
  840. Finds an identical token sequence if present in the set.
  841. @param elem the token sequence to search for
  842. @return an identical the token sequence if found, or
  843. null if not found
  844. </member>
  845. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.Add(PerCederberg.Grammatica.Parser.LookAheadSet.Sequence)">
  846. Adds a token sequence to this set. The sequence will only
  847. be added if it is not already in the set. Also, if the
  848. sequence is longer than the allowed maximum, a truncated
  849. sequence will be added instead.
  850. @param seq the token sequence to add
  851. </member>
  852. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.Add(System.Int32)">
  853. Adds a new token sequence with a single token to this set.
  854. The sequence will only be added if it is not already in the
  855. set.
  856. @param token the token to add
  857. </member>
  858. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.AddAll(PerCederberg.Grammatica.Parser.LookAheadSet)">
  859. Adds all the token sequences from a specified set. Only
  860. sequences not already in this set will be added.
  861. @param set the set to add from
  862. </member>
  863. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.AddEmpty">
  864. Adds an empty token sequence to this set. The sequence will
  865. only be added if it is not already in the set.
  866. </member>
  867. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.Remove(PerCederberg.Grammatica.Parser.LookAheadSet.Sequence)">
  868. Removes a token sequence from this set.
  869. @param seq the token sequence to remove
  870. </member>
  871. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.RemoveAll(PerCederberg.Grammatica.Parser.LookAheadSet)">
  872. Removes all the token sequences from a specified set. Only
  873. sequences already in this set will be removed.
  874. @param set the set to remove from
  875. </member>
  876. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.CreateNextSet(System.Int32)">
  877. Creates a new look-ahead set that is the result of reading
  878. the specified token. The new look-ahead set will contain
  879. the rest of all the token sequences that started with the
  880. specified token.
  881. @param token the token to read
  882. @return a new look-ahead set containing the remaining tokens
  883. </member>
  884. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.CreateIntersection(PerCederberg.Grammatica.Parser.LookAheadSet)">
  885. Creates a new look-ahead set that is the intersection of
  886. this set with another set. The token sequences in the net
  887. set will only have the repeat flag set if it was set in
  888. both the identical token sequences.
  889. @param set the set to intersect with
  890. @return a new look-ahead set containing the intersection
  891. </member>
  892. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.CreateCombination(PerCederberg.Grammatica.Parser.LookAheadSet)">
  893. Creates a new look-ahead set that is the combination of
  894. this set with another set. The combination is created by
  895. creating new token sequences that consist of appending all
  896. elements from the specified set onto all elements in this
  897. set. This is sometimes referred to as the cartesian
  898. product.
  899. @param set the set to combine with
  900. @return a new look-ahead set containing the combination
  901. </member>
  902. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.CreateOverlaps(PerCederberg.Grammatica.Parser.LookAheadSet)">
  903. Creates a new look-ahead set with overlaps from another. All
  904. token sequences in this set that overlaps with the other set
  905. will be added to the new look-ahead set.
  906. @param set the look-ahead set to check with
  907. @return a new look-ahead set containing the overlaps
  908. </member>
  909. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.CreateFilter(PerCederberg.Grammatica.Parser.LookAheadSet)">
  910. Creates a new look-ahead set filter. The filter will contain
  911. all sequences from this set, possibly left trimmed by each one
  912. of the sequences in the specified set.
  913. @param set the look-ahead set to trim with
  914. @return a new look-ahead set filter
  915. </member>
  916. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.CreateRepetitive">
  917. Creates a new identical look-ahead set, except for the
  918. repeat flag being set in each token sequence.
  919. @return a new repetitive look-ahead set
  920. </member>
  921. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.ToString">
  922. Returns a string representation of this object.
  923. @return a string representation of this object
  924. </member>
  925. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.ToString(PerCederberg.Grammatica.Parser.Tokenizer)">
  926. Returns a string representation of this object.
  927. @param tokenizer the tokenizer containing the tokens
  928. @return a string representation of this object
  929. </member>
  930. <!-- Badly formed XML comment ignored for member "T:PerCederberg.Grammatica.Parser.LookAheadSet.Sequence" -->
  931. <member name="F:PerCederberg.Grammatica.Parser.LookAheadSet.Sequence.repeat">
  932. The repeat flag. If this flag is set, the token
  933. sequence or some part of it may be repeated infinitely.
  934. </member>
  935. <member name="F:PerCederberg.Grammatica.Parser.LookAheadSet.Sequence.tokens">
  936. The list of token ids in this sequence.
  937. </member>
  938. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.Sequence.#ctor">
  939. Creates a new empty token sequence. The repeat flag
  940. will be set to false.
  941. </member>
  942. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.Sequence.#ctor(System.Boolean,System.Int32)">
  943. Creates a new token sequence with a single token.
  944. @param repeat the repeat flag value
  945. @param token the token to add
  946. </member>
  947. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.Sequence.#ctor(System.Int32,PerCederberg.Grammatica.Parser.LookAheadSet.Sequence)">
  948. Creates a new token sequence that is a duplicate of
  949. another sequence. Only a limited number of tokens will
  950. be copied however. The repeat flag from the original
  951. will be kept intact.
  952. @param length the maximum number of tokens to copy
  953. @param seq the sequence to copy
  954. </member>
  955. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.Sequence.#ctor(System.Boolean,PerCederberg.Grammatica.Parser.LookAheadSet.Sequence)">
  956. Creates a new token sequence that is a duplicate of
  957. another sequence. The new value of the repeat flag will
  958. be used however.
  959. @param repeat the new repeat flag value
  960. @param seq the sequence to copy
  961. </member>
  962. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.Sequence.Length">
  963. Returns the length of the token sequence.
  964. @return the number of tokens in the sequence
  965. </member>
  966. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.Sequence.GetToken(System.Int32)">
  967. Returns a token at a specified position in the sequence.
  968. @param pos the sequence position
  969. @return the token id found, or null
  970. </member>
  971. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.Sequence.Equals(System.Object)">
  972. Checks if this sequence is equal to another object.
  973. Only token sequences with the same tokens in the same
  974. order will be considered equal. The repeat flag will be
  975. disregarded.
  976. @param obj the object to compare with
  977. @return true if the objects are equal, or
  978. false otherwise
  979. </member>
  980. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.Sequence.Equals(PerCederberg.Grammatica.Parser.LookAheadSet.Sequence)">
  981. Checks if this sequence is equal to another sequence.
  982. Only sequences with the same tokens in the same order
  983. will be considered equal. The repeat flag will be
  984. disregarded.
  985. @param seq the sequence to compare with
  986. @return true if the sequences are equal, or
  987. false otherwise
  988. </member>
  989. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.Sequence.StartsWith(PerCederberg.Grammatica.Parser.LookAheadSet.Sequence)">
  990. Checks if this token sequence starts with the tokens from
  991. another sequence. If the other sequence is longer than this
  992. sequence, this method will always return false.
  993. @param seq the token sequence to check
  994. @return true if this sequence starts with the other, or
  995. false otherwise
  996. </member>
  997. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.Sequence.IsRepetitive">
  998. Checks if this token sequence is repetitive. A repetitive
  999. token sequence is one with the repeat flag set.
  1000. @return true if this token sequence is repetitive, or
  1001. false otherwise
  1002. </member>
  1003. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.Sequence.IsNext(PerCederberg.Grammatica.Parser.Parser)">
  1004. Checks if the next token(s) in the parser matches this
  1005. token sequence.
  1006. @param parser the parser to check
  1007. @return true if the next tokens are in the sequence, or
  1008. false otherwise
  1009. </member>
  1010. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.Sequence.IsNext(PerCederberg.Grammatica.Parser.Parser,System.Int32)">
  1011. Checks if the next token(s) in the parser matches this
  1012. token sequence.
  1013. @param parser the parser to check
  1014. @param length the maximum number of tokens to check
  1015. @return true if the next tokens are in the sequence, or
  1016. false otherwise
  1017. </member>
  1018. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.Sequence.ToString">
  1019. Returns a string representation of this object.
  1020. @return a string representation of this object
  1021. </member>
  1022. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.Sequence.ToString(PerCederberg.Grammatica.Parser.Tokenizer)">
  1023. Returns a string representation of this object.
  1024. @param tokenizer the tokenizer containing the tokens
  1025. @return a string representation of this object
  1026. </member>
  1027. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.Sequence.Concat(System.Int32,PerCederberg.Grammatica.Parser.LookAheadSet.Sequence)">
  1028. Creates a new token sequence that is the concatenation
  1029. of this sequence and another. A maximum length for the
  1030. new sequence is also specified.
  1031. @param length the maximum length of the result
  1032. @param seq the other sequence
  1033. @return the concatenated token sequence
  1034. </member>
  1035. <member name="M:PerCederberg.Grammatica.Parser.LookAheadSet.Sequence.Subsequence(System.Int32)">
  1036. Creates a new token sequence that is a subsequence of
  1037. this one.
  1038. @param start the subsequence start position
  1039. @return the new token subsequence
  1040. </member>
  1041. <!-- Badly formed XML comment ignored for member "T:PerCederberg.Grammatica.Parser.Node" -->
  1042. <member name="F:PerCederberg.Grammatica.Parser.Node.parent">
  1043. The parent node.
  1044. </member>
  1045. <member name="F:PerCederberg.Grammatica.Parser.Node.values">
  1046. The computed node values.
  1047. </member>
  1048. <member name="M:PerCederberg.Grammatica.Parser.Node.IsHidden">
  1049. Checks if this node is hidden, i.e. if it should not be
  1050. visible outside the parser.
  1051. @return true if the node should be hidden, or
  1052. false otherwise
  1053. </member>
  1054. <member name="M:PerCederberg.Grammatica.Parser.Node.GetId">
  1055. Returns the node type id. This value is set as a unique
  1056. identifier for each type of node, in order to simplify
  1057. later identification.
  1058. @return the node type id
  1059. </member>
  1060. <member name="M:PerCederberg.Grammatica.Parser.Node.GetName">
  1061. Returns the node name.
  1062. @return the node name
  1063. </member>
  1064. <member name="M:PerCederberg.Grammatica.Parser.Node.GetStartLine">
  1065. The line number of the first character in this node. If the
  1066. node has child elements, this value will be fetched from
  1067. the first child.
  1068. @return the line number of the first character, or
  1069. -1 if not applicable
  1070. </member>
  1071. <member name="M:PerCederberg.Grammatica.Parser.Node.GetStartColumn">
  1072. The column number of the first character in this node. If
  1073. the node has child elements, this value will be fetched
  1074. from the first child.
  1075. @return the column number of the first token character, or
  1076. -1 if not applicable
  1077. </member>
  1078. <member name="M:PerCederberg.Grammatica.Parser.Node.GetEndLine">
  1079. The line number of the last character in this node. If the
  1080. node has child elements, this value will be fetched from
  1081. the last child.
  1082. @return the line number of the last token character, or
  1083. -1 if not applicable
  1084. </member>
  1085. <member name="M:PerCederberg.Grammatica.Parser.Node.GetEndColumn">
  1086. The column number of the last character in this node. If
  1087. the node has child elements, this value will be fetched
  1088. from the last child.
  1089. @return the column number of the last token character, or
  1090. -1 if not applicable
  1091. </member>
  1092. <member name="M:PerCederberg.Grammatica.Parser.Node.GetParent">
  1093. Returns the parent node.
  1094. @return the parent parse tree node
  1095. </member>
  1096. <member name="M:PerCederberg.Grammatica.Parser.Node.SetParent(PerCederberg.Grammatica.Parser.Node)">
  1097. Sets the parent node.
  1098. @param parent the new parent node
  1099. </member>
  1100. <member name="M:PerCederberg.Grammatica.Parser.Node.GetChildCount">
  1101. Returns the number of child nodes.
  1102. @return the number of child nodes
  1103. </member>
  1104. <!-- Badly formed XML comment ignored for member "M:PerCederberg.Grammatica.Parser.Node.GetChildAt(System.Int32)" -->
  1105. <member name="M:PerCederberg.Grammatica.Parser.Node.GetDescendantCount">
  1106. Returns the number of descendant nodes.
  1107. @return the number of descendant nodes
  1108. @since 1.2
  1109. </member>
  1110. <member name="M:PerCederberg.Grammatica.Parser.Node.GetValueCount">
  1111. Returns the number of computed values associated with this
  1112. node. Any number of values can be associated with a node
  1113. through calls to AddValue().
  1114. @return the number of values associated with this node
  1115. </member>
  1116. <!-- Badly formed XML comment ignored for member "M:PerCederberg.Grammatica.Parser.Node.GetValue(System.Int32)" -->
  1117. <member name="M:PerCederberg.Grammatica.Parser.Node.GetAllValues">
  1118. Returns the list with all the computed values for this
  1119. node. Note that the list is not a copy, so changes will
  1120. affect the values in this node (as it is the same object).
  1121. @return a list with all values, or
  1122. null if no values have been set
  1123. </member>
  1124. <member name="M:PerCederberg.Grammatica.Parser.Node.AddValue(System.Object)">
  1125. Adds a computed value to this node. The computed value may
  1126. be used for storing intermediate results in the parse tree
  1127. during analysis.
  1128. @param value the node value
  1129. </member>
  1130. <member name="M:PerCederberg.Grammatica.Parser.Node.AddValues(System.Collections.ArrayList)">
  1131. Adds a set of computed values to this node.
  1132. @param values the vector with node values
  1133. </member>
  1134. <member name="M:PerCederberg.Grammatica.Parser.Node.RemoveAllValues">
  1135. Removes all computed values stored in this node.
  1136. </member>
  1137. <member name="M:PerCederberg.Grammatica.Parser.Node.PrintTo(System.IO.TextWriter)">
  1138. Prints this node and all subnodes to the specified output
  1139. stream.
  1140. @param output the output stream to use
  1141. </member>
  1142. <member name="M:PerCederberg.Grammatica.Parser.Node.PrintTo(System.IO.TextWriter,System.String)">
  1143. Prints this node and all subnodes to the specified output
  1144. stream.
  1145. @param output the output stream to use
  1146. @param indent the indentation string
  1147. </member>
  1148. <!-- Badly formed XML comment ignored for member "T:PerCederberg.Grammatica.Parser.ParseException" -->
  1149. <member name="F:PerCederberg.Grammatica.Parser.ParseException.type">
  1150. The error type.
  1151. </member>
  1152. <member name="F:PerCederberg.Grammatica.Parser.ParseException.info">
  1153. The additional information string.
  1154. </member>
  1155. <member name="F:PerCederberg.Grammatica.Parser.ParseException.details">
  1156. The additional details information. This variable is only
  1157. used for unexpected token errors.
  1158. </member>
  1159. <member name="F:PerCederberg.Grammatica.Parser.ParseException.line">
  1160. The line number.
  1161. </member>
  1162. <member name="F:PerCederberg.Grammatica.Parser.ParseException.column">
  1163. The column number.
  1164. </member>
  1165. <member name="M:PerCederberg.Grammatica.Parser.ParseException.#ctor(PerCederberg.Grammatica.Parser.ParseException.ErrorType,System.String,System.Int32,System.Int32)">
  1166. Creates a new parse exception.
  1167. @param type the parse error type
  1168. @param info the additional information
  1169. @param line the line number, or -1 for unknown
  1170. @param column the column number, or -1 for unknown
  1171. </member>
  1172. <member name="M:PerCederberg.Grammatica.Parser.ParseException.#ctor(PerCederberg.Grammatica.Parser.ParseException.ErrorType,System.String,System.Collections.ArrayList,System.Int32,System.Int32)">
  1173. Creates a new parse exception. This constructor is only
  1174. used to supply the detailed information array, which is
  1175. only used for expected token errors. The list then contains
  1176. descriptions of the expected tokens.
  1177. @param type the parse error type
  1178. @param info the additional information
  1179. @param details the additional detailed information
  1180. @param line the line number, or -1 for unknown
  1181. @param column the column number, or -1 for unknown
  1182. </member>
  1183. <member name="M:PerCederberg.Grammatica.Parser.ParseException.GetErrorType">
  1184. Returns the error type.
  1185. @return the error type
  1186. </member>
  1187. <member name="M:PerCederberg.Grammatica.Parser.ParseException.GetInfo">
  1188. Returns the additional error information.
  1189. @return the additional error information
  1190. </member>
  1191. <member name="M:PerCederberg.Grammatica.Parser.ParseException.GetDetails">
  1192. Returns the additional detailed error information.
  1193. @return the additional detailed error information
  1194. </member>
  1195. <member name="M:PerCederberg.Grammatica.Parser.ParseException.GetLine">
  1196. Returns the line number where the error occured.
  1197. @return the line number of the error, or
  1198. -1 if unknown
  1199. </member>
  1200. <member name="M:PerCederberg.Grammatica.Parser.ParseException.GetColumn">
  1201. Returns the column number where the error occured.
  1202. @return the column number of the error, or
  1203. -1 if unknown
  1204. </member>
  1205. <member name="M:PerCederberg.Grammatica.Parser.ParseException.GetMessage">
  1206. Returns a default error message.
  1207. @return a default error message
  1208. </member>
  1209. <member name="M:PerCederberg.Grammatica.Parser.ParseException.GetErrorMessage">
  1210. Returns the error message. This message will contain all the
  1211. information available, except for the line and column number
  1212. information.
  1213. @return the error message
  1214. </member>
  1215. <member name="M:PerCederberg.Grammatica.Parser.ParseException.GetMessageDetails">
  1216. Returns a string containing all the detailed information in
  1217. a list. The elements are separated with a comma.
  1218. @return the detailed information string
  1219. </member>
  1220. <member name="P:PerCederberg.Grammatica.Parser.ParseException.Message">
  1221. The message property. This property contains the detailed
  1222. exception error message.
  1223. </member>
  1224. <member name="T:PerCederberg.Grammatica.Parser.ParseException.ErrorType">
  1225. The error type enumeration.
  1226. </member>
  1227. <!-- Badly formed XML comment ignored for member "T:PerCederberg.Grammatica.Parser.Parser" -->
  1228. <member name="F:PerCederberg.Grammatica.Parser.Parser.initialized">
  1229. The parser initialization flag.
  1230. </member>
  1231. <member name="F:PerCederberg.Grammatica.Parser.Parser.tokenizer">
  1232. The tokenizer to use.
  1233. </member>
  1234. <member name="F:PerCederberg.Grammatica.Parser.Parser.analyzer">
  1235. The analyzer to use for callbacks.
  1236. </member>
  1237. <member name="F:PerCederberg.Grammatica.Parser.Parser.patterns">
  1238. The list of production patterns.
  1239. </member>
  1240. <member name="F:PerCederberg.Grammatica.Parser.Parser.patternIds">
  1241. The map with production patterns and their id:s. This map
  1242. contains the production patterns indexed by their id:s.
  1243. </member>
  1244. <member name="F:PerCederberg.Grammatica.Parser.Parser.tokens">
  1245. The list of buffered tokens. This list will contain tokens that
  1246. have been read from the tokenizer, but not yet consumed.
  1247. </member>
  1248. <member name="F:PerCederberg.Grammatica.Parser.Parser.errorLog">
  1249. The error log. All parse errors will be added to this log as
  1250. the parser attempts to recover from the error. If the error
  1251. count is higher than zero (0), this log will be thrown as the
  1252. result from the parse() method.
  1253. </member>
  1254. <member name="F:PerCederberg.Grammatica.Parser.Parser.errorRecovery">
  1255. The error recovery counter. This counter is initially set to a
  1256. negative value to indicate that no error requiring recovery
  1257. has been encountered. When a parse error is found, the counter
  1258. is set to three (3), and is then decreased by one for each
  1259. correctly read token until it reaches zero (0).
  1260. </member>
  1261. <member name="M:PerCederberg.Grammatica.Parser.Parser.#ctor(PerCederberg.Grammatica.Parser.Tokenizer)">
  1262. Creates a new parser.
  1263. @param tokenizer the tokenizer to use
  1264. </member>
  1265. <member name="M:PerCederberg.Grammatica.Parser.Parser.#ctor(PerCederberg.Grammatica.Parser.Tokenizer,PerCederberg.Grammatica.Parser.Analyzer)">
  1266. Creates a new parser.
  1267. @param tokenizer the tokenizer to use
  1268. @param analyzer the analyzer callback to use
  1269. </member>
  1270. <member name="M:PerCederberg.Grammatica.Parser.Parser.GetTokenizer">
  1271. Returns the tokenizer in use by this parser.
  1272. @return the tokenizer in use by this parser
  1273. @since 1.4
  1274. </member>
  1275. <member name="M:PerCederberg.Grammatica.Parser.Parser.GetAnalyzer">
  1276. Returns the analyzer in use by this parser.
  1277. @return the analyzer in use by this parser
  1278. @since 1.4
  1279. </member>
  1280. <member name="M:PerCederberg.Grammatica.Parser.Parser.SetInitialized(System.Boolean)">
  1281. Sets the parser initialized flag. Normally this flag is set by
  1282. the prepare() method, but this method allows further
  1283. modifications to it.
  1284. @param initialized the new initialized flag
  1285. </member>
  1286. <member name="M:PerCederberg.Grammatica.Parser.Parser.AddPattern(PerCederberg.Grammatica.Parser.ProductionPattern)">
  1287. Adds a new production pattern to the parser. The first pattern
  1288. added is assumed to be the starting point in the grammar. The
  1289. patterns added may be validated to some extent.
  1290. @param pattern the pattern to add
  1291. @throws ParserCreationException if the pattern couldn't be
  1292. added correctly to the parser
  1293. </member>
  1294. <member name="M:PerCederberg.Grammatica.Parser.Parser.Prepare">
  1295. Initializes the parser. All the added production patterns will
  1296. be analyzed for ambiguities and errors. This method also
  1297. initializes internal data structures used during the parsing.
  1298. @throws ParserCreationException if the parser couldn't be
  1299. initialized correctly
  1300. </member>
  1301. <member name="M:PerCederberg.Grammatica.Parser.Parser.CheckPattern(PerCederberg.Grammatica.Parser.ProductionPattern)">
  1302. Checks a production pattern for completeness. If some rule
  1303. in the pattern referenced an production pattern not added
  1304. to this parser, a parser creation exception will be thrown.
  1305. @param pattern the production pattern to check
  1306. @throws ParserCreationException if the pattern referenced a
  1307. pattern not added to this parser
  1308. </member>
  1309. <member name="M:PerCederberg.Grammatica.Parser.Parser.CheckRule(System.String,PerCederberg.Grammatica.Parser.ProductionPatternAlternative)">
  1310. Checks a production pattern rule for completeness. If some
  1311. element in the rule referenced an production pattern not
  1312. added to this parser, a parser creation exception will be
  1313. thrown.
  1314. @param name the name of the pattern being checked
  1315. @param rule the production pattern rule to check
  1316. @throws ParserCreationException if the rule referenced a
  1317. pattern not added to this parser
  1318. </member>
  1319. <member name="M:PerCederberg.Grammatica.Parser.Parser.CheckElement(System.String,PerCederberg.Grammatica.Parser.ProductionPatternElement)">
  1320. Checks a production pattern element for completeness. If
  1321. the element references a production pattern not added to
  1322. this parser, a parser creation exception will be thrown.
  1323. @param name the name of the pattern being checked
  1324. @param elem the production pattern element to check
  1325. @throws ParserCreationException if the element referenced a
  1326. pattern not added to this parser
  1327. </member>
  1328. <member name="M:PerCederberg.Grammatica.Parser.Parser.Parse">
  1329. Parses the token stream and returns a parse tree. This method
  1330. will call prepare() if not previously called. In case of a
  1331. parse error, the parser will attempt to recover and throw all
  1332. the errors found in a parser log exception in the end.
  1333. @return the parse tree
  1334. @throws ParserCreationException if the parser couldn't be
  1335. initialized correctly
  1336. @throws ParserLogException if the input couldn't be parsed
  1337. correctly
  1338. @see #prepare
  1339. </member>
  1340. <member name="M:PerCederberg.Grammatica.Parser.Parser.ParseStart">
  1341. Parses the token stream and returns a parse tree.
  1342. @return the parse tree
  1343. @throws ParseException if the input couldn't be parsed
  1344. correctly
  1345. </member>
  1346. <member name="M:PerCederberg.Grammatica.Parser.Parser.AddError(PerCederberg.Grammatica.Parser.ParseException,System.Boolean)">
  1347. Adds an error to the error log. If the parser is in error
  1348. recovery mode, the error will not be added to the log. If the
  1349. recovery flag is set, this method will set the error recovery
  1350. counter thus enter error recovery mode. Only lexical or
  1351. syntactical errors require recovery, so this flag shouldn't be
  1352. set otherwise.
  1353. @param e the error to add
  1354. @param recovery the recover flag
  1355. </member>
  1356. <member name="M:PerCederberg.Grammatica.Parser.Parser.GetPattern(System.Int32)">
  1357. Returns the production pattern with the specified id.
  1358. @param id the production pattern id
  1359. @return the production pattern found, or
  1360. null if non-existent
  1361. </member>
  1362. <member name="M:PerCederberg.Grammatica.Parser.Parser.GetStartPattern">
  1363. Returns the production pattern for the starting production.
  1364. @return the start production pattern, or
  1365. null if no patterns have been added
  1366. </member>
  1367. <member name="M:PerCederberg.Grammatica.Parser.Parser.GetPatterns">
  1368. Returns the ordered set of production patterns.
  1369. @return the ordered set of production patterns
  1370. </member>
  1371. <member name="M:PerCederberg.Grammatica.Parser.Parser.EnterNode(PerCederberg.Grammatica.Parser.Node)">
  1372. Handles the parser entering a production. This method calls the
  1373. appropriate analyzer callback if the node is not hidden. Note
  1374. that this method will not call any callback if an error
  1375. requiring recovery has ocurred.
  1376. @param node the parse tree node
  1377. </member>
  1378. <member name="M:PerCederberg.Grammatica.Parser.Parser.ExitNode(PerCederberg.Grammatica.Parser.Node)">
  1379. Handles the parser leaving a production. This method calls the
  1380. appropriate analyzer callback if the node is not hidden, and
  1381. returns the result. Note that this method will not call any
  1382. callback if an error requiring recovery has ocurred.
  1383. @param node the parse tree node
  1384. @return the parse tree node, or
  1385. null if no parse tree should be created
  1386. </member>
  1387. <member name="M:PerCederberg.Grammatica.Parser.Parser.AddNode(PerCederberg.Grammatica.Parser.Production,PerCederberg.Grammatica.Parser.Node)">
  1388. Handles the parser adding a child node to a production. This
  1389. method calls the appropriate analyzer callback. Note that this
  1390. method will not call any callback if an error requiring
  1391. recovery has ocurred.
  1392. @param node the parent parse tree node
  1393. @param child the child parse tree node, or null
  1394. </member>
  1395. <member name="M:PerCederberg.Grammatica.Parser.Parser.NextToken">
  1396. Reads and consumes the next token in the queue. If no token
  1397. was available for consumation, a parse error will be
  1398. thrown.
  1399. @return the token consumed
  1400. @throws ParseException if the input stream couldn't be read or
  1401. parsed correctly
  1402. </member>
  1403. <member name="M:PerCederberg.Grammatica.Parser.Parser.NextToken(System.Int32)">
  1404. Reads and consumes the next token in the queue. If no token was
  1405. available for consumation, a parse error will be thrown. A
  1406. parse error will also be thrown if the token id didn't match
  1407. the specified one.
  1408. @param id the expected token id
  1409. @return the token consumed
  1410. @throws ParseException if the input stream couldn't be parsed
  1411. correctly, or if the token wasn't expected
  1412. </member>
  1413. <member name="M:PerCederberg.Grammatica.Parser.Parser.PeekToken(System.Int32)">
  1414. Returns a token from the queue. This method is used to check
  1415. coming tokens before they have been consumed. Any number of
  1416. tokens forward can be checked.
  1417. @param steps the token queue number, zero (0) for first
  1418. @return the token in the queue, or
  1419. null if no more tokens in the queue
  1420. </member>
  1421. <member name="M:PerCederberg.Grammatica.Parser.Parser.ToString">
  1422. Returns a string representation of this parser. The string will
  1423. contain all the production definitions and various additional
  1424. information.
  1425. @return a detailed string representation of this parser
  1426. </member>
  1427. <member name="M:PerCederberg.Grammatica.Parser.Parser.ToString(PerCederberg.Grammatica.Parser.ProductionPattern)">
  1428. Returns a string representation of a production pattern.
  1429. @param prod the production pattern
  1430. @return a detailed string representation of the pattern
  1431. </member>
  1432. <member name="M:PerCederberg.Grammatica.Parser.Parser.ToString(PerCederberg.Grammatica.Parser.ProductionPatternAlternative)">
  1433. Returns a string representation of a production pattern
  1434. alternative.
  1435. @param alt the production pattern alternative
  1436. @return a detailed string representation of the alternative
  1437. </member>
  1438. <member name="M:PerCederberg.Grammatica.Parser.Parser.ToString(PerCederberg.Grammatica.Parser.ProductionPatternElement)">
  1439. Returns a string representation of a production pattern
  1440. element.
  1441. @param elem the production pattern element
  1442. @return a detailed string representation of the element
  1443. </member>
  1444. <member name="M:PerCederberg.Grammatica.Parser.Parser.GetTokenDescription(System.Int32)">
  1445. Returns a token description for a specified token.
  1446. @param token the token to describe
  1447. @return the token description
  1448. </member>
  1449. <!-- Badly formed XML comment ignored for member "T:PerCederberg.Grammatica.Parser.ParserCreationException" -->
  1450. <member name="F:PerCederberg.Grammatica.Parser.ParserCreationException.type">
  1451. The error type.
  1452. </member>
  1453. <member name="F:PerCederberg.Grammatica.Parser.ParserCreationException.name">
  1454. The token or production pattern name. This variable is only
  1455. set for some error types.
  1456. </member>
  1457. <member name="F:PerCederberg.Grammatica.Parser.ParserCreationException.info">
  1458. The additional error information string. This variable is only
  1459. set for some error types.
  1460. </member>
  1461. <member name="F:PerCederberg.Grammatica.Parser.ParserCreationException.details">
  1462. The error details list. This variable is only set for some
  1463. error types.
  1464. </member>
  1465. <member name="M:PerCederberg.Grammatica.Parser.ParserCreationException.#ctor(PerCederberg.Grammatica.Parser.ParserCreationException.ErrorType,System.String)">
  1466. Creates a new parser creation exception.
  1467. @param type the parse error type
  1468. @param info the additional error information
  1469. </member>
  1470. <member name="M:PerCederberg.Grammatica.Parser.ParserCreationException.#ctor(PerCederberg.Grammatica.Parser.ParserCreationException.ErrorType,System.String,System.String)">
  1471. Creates a new parser creation exception.
  1472. @param type the parse error type
  1473. @param name the token or production pattern name
  1474. @param info the additional error information
  1475. </member>
  1476. <member name="M:PerCederberg.Grammatica.Parser.ParserCreationException.#ctor(PerCederberg.Grammatica.Parser.ParserCreationException.ErrorType,System.String,System.String,System.Collections.ArrayList)">
  1477. Creates a new parser creation exception.
  1478. @param type the parse error type
  1479. @param name the token or production pattern name
  1480. @param info the additional error information
  1481. @param details the error details list
  1482. </member>
  1483. <member name="M:PerCederberg.Grammatica.Parser.ParserCreationException.GetErrorType">
  1484. Returns the error type.
  1485. @return the error type
  1486. </member>
  1487. <member name="M:PerCederberg.Grammatica.Parser.ParserCreationException.GetName">
  1488. Returns the token or production name.
  1489. @return the token or production name
  1490. </member>
  1491. <member name="M:PerCederberg.Grammatica.Parser.ParserCreationException.GetInfo">
  1492. Returns the additional error information.
  1493. @return the additional error information
  1494. </member>
  1495. <member name="M:PerCederberg.Grammatica.Parser.ParserCreationException.GetDetails">
  1496. Returns the detailed error information as a string
  1497. @return the detailed error information
  1498. </member>
  1499. <member name="M:PerCederberg.Grammatica.Parser.ParserCreationException.GetMessage">
  1500. Returns the error message. This message will contain all the
  1501. information available.
  1502. @return the error message
  1503. </member>
  1504. <member name="P:PerCederberg.Grammatica.Parser.ParserCreationException.Message">
  1505. The message property. This property contains the detailed
  1506. exception error message.
  1507. </member>
  1508. <member name="T:PerCederberg.Grammatica.Parser.ParserCreationException.ErrorType">
  1509. The error type enumeration.
  1510. </member>
  1511. <!-- Badly formed XML comment ignored for member "T:PerCederberg.Grammatica.Parser.ParserLogException" -->
  1512. <member name="F:PerCederberg.Grammatica.Parser.ParserLogException.errors">
  1513. The list of errors found.
  1514. </member>
  1515. <member name="M:PerCederberg.Grammatica.Parser.ParserLogException.#ctor">
  1516. Creates a new empty parser log exception.
  1517. </member>
  1518. <member name="M:PerCederberg.Grammatica.Parser.ParserLogException.GetErrorCount">
  1519. Returns the number of errors in this log.
  1520. @return the number of errors in this log
  1521. </member>
  1522. <!-- Badly formed XML comment ignored for member "M:PerCederberg.Grammatica.Parser.ParserLogException.GetError(System.Int32)" -->
  1523. <member name="M:PerCederberg.Grammatica.Parser.ParserLogException.AddError(PerCederberg.Grammatica.Parser.ParseException)">
  1524. Adds a parse error to the log.
  1525. @param e the parse error to add
  1526. </member>
  1527. <member name="M:PerCederberg.Grammatica.Parser.ParserLogException.GetMessage">
  1528. Returns the detailed error message. This message will contain
  1529. the error messages from all errors in this log, separated by
  1530. a newline.
  1531. @return the detailed error message
  1532. </member>
  1533. <member name="P:PerCederberg.Grammatica.Parser.ParserLogException.Message">
  1534. The message property. This property contains the detailed
  1535. exception error message.
  1536. </member>
  1537. <!-- Badly formed XML comment ignored for member "T:PerCederberg.Grammatica.Parser.Production" -->
  1538. <member name="F:PerCederberg.Grammatica.Parser.Production.pattern">
  1539. The production pattern used for this production.
  1540. </member>
  1541. <member name="F:PerCederberg.Grammatica.Parser.Production.children">
  1542. The child nodes.
  1543. </member>
  1544. <member name="M:PerCederberg.Grammatica.Parser.Production.#ctor(PerCederberg.Grammatica.Parser.ProductionPattern)">
  1545. Creates a new production node.
  1546. @param pattern the production pattern
  1547. </member>
  1548. <member name="M:PerCederberg.Grammatica.Parser.Production.IsHidden">
  1549. Checks if this node is hidden, i.e. if it should not be visible
  1550. outside the parser.
  1551. @return true if the node should be hidden, or
  1552. false otherwise
  1553. </member>
  1554. <member name="M:PerCederberg.Grammatica.Parser.Production.GetPattern">
  1555. Returns the production pattern for this production.
  1556. @return the production pattern
  1557. </member>
  1558. <member name="M:PerCederberg.Grammatica.Parser.Production.GetId">
  1559. Returns the production (pattern) id. This value is set as a
  1560. unique identifier when creating the production pattern to
  1561. simplify later identification.
  1562. @return the production id
  1563. </member>
  1564. <member name="M:PerCederberg.Grammatica.Parser.Production.GetName">
  1565. Returns the production node name.
  1566. @return the production node name
  1567. </member>
  1568. <member name="M:PerCederberg.Grammatica.Parser.Production.GetChildCount">
  1569. Returns the number of child nodes.
  1570. @return the number of child nodes
  1571. </member>
  1572. <!-- Badly formed XML comment ignored for member "M:PerCederberg.Grammatica.Parser.Production.GetChildAt(System.Int32)" -->
  1573. <member name="M:PerCederberg.Grammatica.Parser.Production.AddChild(PerCederberg.Grammatica.Parser.Node)">
  1574. Adds a child node. The node will be added last in the list of
  1575. children.
  1576. @param child the child node to add
  1577. </member>
  1578. <member name="M:PerCederberg.Grammatica.Parser.Production.ToString">
  1579. Returns a string representation of this production.
  1580. @return a string representation of this production
  1581. </member>
  1582. <!-- Badly formed XML comment ignored for member "T:PerCederberg.Grammatica.Parser.ProductionPattern" -->
  1583. <member name="F:PerCederberg.Grammatica.Parser.ProductionPattern.id">
  1584. The production pattern identity.
  1585. </member>
  1586. <member name="F:PerCederberg.Grammatica.Parser.ProductionPattern.name">
  1587. The production pattern name.
  1588. </member>
  1589. <member name="F:PerCederberg.Grammatica.Parser.ProductionPattern.syntetic">
  1590. The syntectic production flag. If this flag is set, the
  1591. production identified by this pattern has been artificially
  1592. inserted into the grammar.
  1593. </member>
  1594. <member name="F:PerCederberg.Grammatica.Parser.ProductionPattern.alternatives">
  1595. The list of production pattern alternatives.
  1596. </member>
  1597. <member name="F:PerCederberg.Grammatica.Parser.ProductionPattern.defaultAlt">
  1598. The default production pattern alternative. This alternative
  1599. is used when no other alternatives match. It may be set to
  1600. -1, meaning that there is no default (or fallback) alternative.
  1601. </member>
  1602. <member name="F:PerCederberg.Grammatica.Parser.ProductionPattern.lookAhead">
  1603. The look-ahead set associated with this pattern.
  1604. </member>
  1605. <member name="M:PerCederberg.Grammatica.Parser.ProductionPattern.#ctor(System.Int32,System.String)">
  1606. Creates a new production pattern.
  1607. @param id the production pattern id
  1608. @param name the production pattern name
  1609. </member>
  1610. <member name="M:PerCederberg.Grammatica.Parser.ProductionPattern.IsSyntetic">
  1611. Checks if the syntetic production flag is set. If this flag
  1612. is set, the production identified by this pattern has been
  1613. artificially inserted into the grammar. No parse tree nodes
  1614. will be created for such nodes, instead the child nodes
  1615. will be added directly to the parent node.
  1616. @return true if this production pattern is syntetic, or
  1617. false otherwise
  1618. </member>
  1619. <member name="M:PerCederberg.Grammatica.Parser.ProductionPattern.IsLeftRecursive">
  1620. Checks if this pattern is recursive on the left-hand side.
  1621. This method checks if any of the production pattern
  1622. alternatives is left-recursive.
  1623. @return true if at least one alternative is left recursive, or
  1624. false otherwise
  1625. </member>
  1626. <member name="M:PerCederberg.Grammatica.Parser.ProductionPattern.IsRightRecursive">
  1627. Checks if this pattern is recursive on the right-hand side.
  1628. This method checks if any of the production pattern
  1629. alternatives is right-recursive.
  1630. @return true if at least one alternative is right recursive, or
  1631. false otherwise
  1632. </member>
  1633. <member name="M:PerCederberg.Grammatica.Parser.ProductionPattern.IsMatchingEmpty">
  1634. Checks if this pattern would match an empty stream of
  1635. tokens. This method checks if any one of the production
  1636. pattern alternatives would match the empty token stream.
  1637. @return true if at least one alternative match no tokens, or
  1638. false otherwise
  1639. </member>
  1640. <member name="M:PerCederberg.Grammatica.Parser.ProductionPattern.GetId">
  1641. Returns the unique production pattern identity value.
  1642. @return the production pattern id
  1643. </member>
  1644. <member name="M:PerCederberg.Grammatica.Parser.ProductionPattern.GetName">
  1645. Returns the production pattern name.
  1646. @return the production pattern name
  1647. </member>
  1648. <member name="M:PerCederberg.Grammatica.Parser.ProductionPattern.SetSyntetic(System.Boolean)">
  1649. Sets the syntetic production pattern flag. If this flag is set,
  1650. the production identified by this pattern has been artificially
  1651. inserted into the grammar. By default this flag is set to
  1652. false.
  1653. @param syntetic the new value of the syntetic flag
  1654. </member>
  1655. <member name="M:PerCederberg.Grammatica.Parser.ProductionPattern.GetAlternativeCount">
  1656. Returns the number of alternatives in this pattern.
  1657. @return the number of alternatives in this pattern
  1658. </member>
  1659. <!-- Badly formed XML comment ignored for member "M:PerCederberg.Grammatica.Parser.ProductionPattern.GetAlternative(System.Int32)" -->
  1660. <member name="M:PerCederberg.Grammatica.Parser.ProductionPattern.AddAlternative(PerCederberg.Grammatica.Parser.ProductionPatternAlternative)">
  1661. Adds a production pattern alternative.
  1662. @param alt the production pattern alternative to add
  1663. @throws ParserCreationException if an identical alternative has
  1664. already been added
  1665. </member>
  1666. <member name="M:PerCederberg.Grammatica.Parser.ProductionPattern.ToString">
  1667. Returns a string representation of this object.
  1668. @return a token string representation
  1669. </member>
  1670. <member name="M:PerCederberg.Grammatica.Parser.ProductionPattern.GetLookAhead">
  1671. Returns the look-ahead set associated with this alternative.
  1672. @return the look-ahead set associated with this alternative
  1673. </member>
  1674. <member name="M:PerCederberg.Grammatica.Parser.ProductionPattern.SetLookAhead(PerCederberg.Grammatica.Parser.LookAheadSet)">
  1675. Sets the look-ahead set for this alternative.
  1676. @param lookAhead the new look-ahead set
  1677. </member>
  1678. <member name="M:PerCederberg.Grammatica.Parser.ProductionPattern.GetDefaultAlternative">
  1679. Returns the default pattern alternative. The default
  1680. alternative is used when no other alternative matches.
  1681. @return the default pattern alternative, or
  1682. null if none has been set
  1683. </member>
  1684. <member name="M:PerCederberg.Grammatica.Parser.ProductionPattern.SetDefaultAlternative(System.Int32)">
  1685. Sets the default pattern alternative. The default alternative
  1686. is used when no other alternative matches.
  1687. @param pos the position of the default alternative
  1688. </member>
  1689. <!-- Badly formed XML comment ignored for member "T:PerCederberg.Grammatica.Parser.ProductionPatternAlternative" -->
  1690. <member name="F:PerCederberg.Grammatica.Parser.ProductionPatternAlternative.pattern">
  1691. The production pattern.
  1692. </member>
  1693. <member name="F:PerCederberg.Grammatica.Parser.ProductionPatternAlternative.elements">
  1694. The element list.
  1695. </member>
  1696. <member name="F:PerCederberg.Grammatica.Parser.ProductionPatternAlternative.lookAhead">
  1697. The look-ahead set associated with this alternative.
  1698. </member>
  1699. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternAlternative.#ctor">
  1700. Creates a new production pattern alternative.
  1701. </member>
  1702. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternAlternative.IsLeftRecursive">
  1703. Checks if this alternative is recursive on the left-hand
  1704. side. This method checks all the possible left side
  1705. elements and returns true if the pattern itself is among
  1706. them.
  1707. @return true if the alternative is left side recursive, or
  1708. false otherwise
  1709. </member>
  1710. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternAlternative.IsRightRecursive">
  1711. Checks if this alternative is recursive on the right-hand side.
  1712. This method checks all the possible right side elements and
  1713. returns true if the pattern itself is among them.
  1714. @return true if the alternative is right side recursive, or
  1715. false otherwise
  1716. </member>
  1717. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternAlternative.IsMatchingEmpty">
  1718. Checks if this alternative would match an empty stream of
  1719. tokens. This check is equivalent of getMinElementCount()
  1720. returning zero (0).
  1721. @return true if the rule can match an empty token stream, or
  1722. false otherwise
  1723. </member>
  1724. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternAlternative.GetPattern">
  1725. Returns the production pattern containing this alternative.
  1726. @return the production pattern for this alternative
  1727. </member>
  1728. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternAlternative.SetPattern(PerCederberg.Grammatica.Parser.ProductionPattern)">
  1729. Changes the production pattern containing this alternative.
  1730. This method should only be called by the production pattern
  1731. class.
  1732. @param pattern the new production pattern
  1733. </member>
  1734. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternAlternative.GetElementCount">
  1735. Returns the number of elements in this alternative.
  1736. @return the number of elements in this alternative
  1737. </member>
  1738. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternAlternative.GetMinElementCount">
  1739. Returns the minimum number of elements needed to satisfy
  1740. this alternative. The value returned is the sum of all the
  1741. elements minimum count.
  1742. @return the minimum number of elements
  1743. </member>
  1744. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternAlternative.GetMaxElementCount">
  1745. Returns the maximum number of elements needed to satisfy
  1746. this alternative. The value returned is the sum of all the
  1747. elements maximum count.
  1748. @return the maximum number of elements
  1749. </member>
  1750. <!-- Badly formed XML comment ignored for member "M:PerCederberg.Grammatica.Parser.ProductionPatternAlternative.GetElement(System.Int32)" -->
  1751. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternAlternative.AddToken(System.Int32,System.Int32,System.Int32)">
  1752. Adds a token to this alternative. The token is appended to
  1753. the end of the element list. The multiplicity values
  1754. specified define if the token is optional or required, and
  1755. if it can be repeated.
  1756. @param id the token (pattern) id
  1757. @param min the minimum number of occurancies
  1758. @param max the maximum number of occurancies, or
  1759. -1 for infinite
  1760. </member>
  1761. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternAlternative.AddProduction(System.Int32,System.Int32,System.Int32)">
  1762. Adds a production to this alternative. The production is
  1763. appended to the end of the element list. The multiplicity
  1764. values specified define if the production is optional or
  1765. required, and if it can be repeated.
  1766. @param id the production (pattern) id
  1767. @param min the minimum number of occurancies
  1768. @param max the maximum number of occurancies, or
  1769. -1 for infinite
  1770. </member>
  1771. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternAlternative.AddElement(PerCederberg.Grammatica.Parser.ProductionPatternElement)">
  1772. Adds a production pattern element to this alternative. The
  1773. element is appended to the end of the element list.
  1774. @param elem the production pattern element
  1775. </member>
  1776. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternAlternative.AddElement(PerCederberg.Grammatica.Parser.ProductionPatternElement,System.Int32,System.Int32)">
  1777. Adds a production pattern element to this alternative. The
  1778. multiplicity values in the element will be overridden with
  1779. the specified values. The element is appended to the end of
  1780. the element list.
  1781. @param elem the production pattern element
  1782. @param min the minimum number of occurancies
  1783. @param max the maximum number of occurancies, or
  1784. -1 for infinite
  1785. </member>
  1786. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternAlternative.Equals(System.Object)">
  1787. Checks if this object is equal to another. This method only
  1788. returns true for another production pattern alternative
  1789. with identical elements in the same order.
  1790. @param obj the object to compare with
  1791. @return true if the object is identical to this one, or
  1792. false otherwise
  1793. </member>
  1794. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternAlternative.Equals(PerCederberg.Grammatica.Parser.ProductionPatternAlternative)">
  1795. Checks if this alternative is equal to another. This method
  1796. returns true if the other production pattern alternative
  1797. has identical elements in the same order.
  1798. @param alt the alternative to compare with
  1799. @return true if the object is identical to this one, or
  1800. false otherwise
  1801. </member>
  1802. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternAlternative.ToString">
  1803. Returns a string representation of this object.
  1804. @return a token string representation
  1805. </member>
  1806. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternAlternative.GetLookAhead">
  1807. Returns the look-ahead set associated with this alternative.
  1808. @return the look-ahead set associated with this alternative
  1809. </member>
  1810. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternAlternative.SetLookAhead(PerCederberg.Grammatica.Parser.LookAheadSet)">
  1811. Sets the look-ahead set for this alternative.
  1812. @param lookAhead the new look-ahead set
  1813. </member>
  1814. <!-- Badly formed XML comment ignored for member "T:PerCederberg.Grammatica.Parser.ProductionPatternElement" -->
  1815. <member name="F:PerCederberg.Grammatica.Parser.ProductionPatternElement.token">
  1816. The token flag. This flag is true for token elements, and
  1817. false for production elements.
  1818. </member>
  1819. <member name="F:PerCederberg.Grammatica.Parser.ProductionPatternElement.id">
  1820. The node identity.
  1821. </member>
  1822. <member name="F:PerCederberg.Grammatica.Parser.ProductionPatternElement.min">
  1823. The minimum occurance count.
  1824. </member>
  1825. <member name="F:PerCederberg.Grammatica.Parser.ProductionPatternElement.max">
  1826. The maximum occurance count.
  1827. </member>
  1828. <member name="F:PerCederberg.Grammatica.Parser.ProductionPatternElement.lookAhead">
  1829. The look-ahead set associated with this element.
  1830. </member>
  1831. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternElement.#ctor(System.Boolean,System.Int32,System.Int32,System.Int32)">
  1832. Creates a new element. If the maximum value if zero (0) or
  1833. negative, it will be set to Int32.MaxValue.
  1834. @param isToken the token flag
  1835. @param id the node identity
  1836. @param min the minimum number of occurancies
  1837. @param max the maximum number of occurancies, or
  1838. negative for infinite
  1839. </member>
  1840. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternElement.IsToken">
  1841. Returns true if this element represents a token.
  1842. @return true if the element is a token, or
  1843. false otherwise
  1844. </member>
  1845. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternElement.IsProduction">
  1846. Returns true if this element represents a production.
  1847. @return true if the element is a production, or
  1848. false otherwise
  1849. </member>
  1850. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternElement.IsMatch(PerCederberg.Grammatica.Parser.Token)">
  1851. Checks if a specific token matches this element. This
  1852. method will only return true if this element is a token
  1853. element, and the token has the same id and this element.
  1854. @param token the token to check
  1855. @return true if the token matches this element, or
  1856. false otherwise
  1857. </member>
  1858. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternElement.GetId">
  1859. Returns the node identity.
  1860. @return the node identity
  1861. </member>
  1862. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternElement.GetMinCount">
  1863. Returns the minimum occurence count.
  1864. @return the minimum occurence count
  1865. </member>
  1866. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternElement.GetMaxCount">
  1867. Returns the maximum occurence count.
  1868. @return the maximum occurence count
  1869. </member>
  1870. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternElement.Equals(System.Object)">
  1871. Checks if this object is equal to another. This method only
  1872. returns true for another identical production pattern
  1873. element.
  1874. @param obj the object to compare with
  1875. @return true if the object is identical to this one, or
  1876. false otherwise
  1877. </member>
  1878. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternElement.ToString">
  1879. Returns a string representation of this object.
  1880. @return a string representation of this object
  1881. </member>
  1882. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternElement.GetLookAhead">
  1883. Returns the look-ahead set associated with this alternative.
  1884. @return the look-ahead set associated with this alternative
  1885. </member>
  1886. <member name="M:PerCederberg.Grammatica.Parser.ProductionPatternElement.SetLookAhead(PerCederberg.Grammatica.Parser.LookAheadSet)">
  1887. Sets the look-ahead set for this alternative.
  1888. @param lookAhead the new look-ahead set
  1889. </member>
  1890. <!-- Badly formed XML comment ignored for member "T:PerCederberg.Grammatica.Parser.RecursiveDescentParser" -->
  1891. <member name="F:PerCederberg.Grammatica.Parser.RecursiveDescentParser.lookAheads">
  1892. The map of pattern look-ahead sets. The map is indexed by
  1893. the production pattern object.
  1894. </member>
  1895. <member name="M:PerCederberg.Grammatica.Parser.RecursiveDescentParser.#ctor(PerCederberg.Grammatica.Parser.Tokenizer)">
  1896. Creates a new parser.
  1897. @param tokenizer the tokenizer to use
  1898. </member>
  1899. <member name="M:PerCederberg.Grammatica.Parser.RecursiveDescentParser.#ctor(PerCederberg.Grammatica.Parser.Tokenizer,PerCederberg.Grammatica.Parser.Analyzer)">
  1900. Creates a new parser.
  1901. @param tokenizer the tokenizer to use
  1902. @param analyzer the analyzer callback to use
  1903. </member>
  1904. <member name="M:PerCederberg.Grammatica.Parser.RecursiveDescentParser.AddPattern(PerCederberg.Grammatica.Parser.ProductionPattern)">
  1905. Adds a new production pattern to the parser. The pattern
  1906. will be added last in the list. The first pattern added is
  1907. assumed to be the starting point in the grammar. The
  1908. pattern will be validated against the grammar type to some
  1909. extent.
  1910. @param pattern the pattern to add
  1911. @throws ParserCreationException if the pattern couldn't be
  1912. added correctly to the parser
  1913. </member>
  1914. <member name="M:PerCederberg.Grammatica.Parser.RecursiveDescentParser.Prepare">
  1915. Initializes the parser. All the added production patterns
  1916. will be analyzed for ambiguities and errors. This method
  1917. also initializes the internal data structures used during
  1918. the parsing.
  1919. @throws ParserCreationException if the parser couldn't be
  1920. initialized correctly
  1921. </member>
  1922. <member name="M:PerCederberg.Grammatica.Parser.RecursiveDescentParser.ParseStart">
  1923. Parses the input stream and creates a parse tree.
  1924. @return the parse tree
  1925. @throws ParseException if the input couldn't be parsed
  1926. correctly
  1927. </member>
  1928. <member name="M:PerCederberg.Grammatica.Parser.RecursiveDescentParser.ParsePattern(PerCederberg.Grammatica.Parser.ProductionPattern)">
  1929. Parses a production pattern. A parse tree node may or may
  1930. not be created depending on the analyzer callbacks.
  1931. @param pattern the production pattern to parse
  1932. @return the parse tree node created, or null
  1933. @throws ParseException if the input couldn't be parsed
  1934. correctly
  1935. </member>
  1936. <member name="M:PerCederberg.Grammatica.Parser.RecursiveDescentParser.ParseAlternative(PerCederberg.Grammatica.Parser.ProductionPatternAlternative)">
  1937. Parses a production pattern alternative. A parse tree node
  1938. may or may not be created depending on the analyzer
  1939. callbacks.
  1940. @param alt the production pattern alternative
  1941. @return the parse tree node created, or null
  1942. @throws ParseException if the input couldn't be parsed
  1943. correctly
  1944. </member>
  1945. <member name="M:PerCederberg.Grammatica.Parser.RecursiveDescentParser.ParseElement(PerCederberg.Grammatica.Parser.Production,PerCederberg.Grammatica.Parser.ProductionPatternElement)">
  1946. Parses a production pattern element. All nodes parsed may
  1947. or may not be added to the parse tree node specified,
  1948. depending on the analyzer callbacks.
  1949. @param node the production parse tree node
  1950. @param elem the production pattern element to parse
  1951. @throws ParseException if the input couldn't be parsed
  1952. correctly
  1953. </member>
  1954. <member name="M:PerCederberg.Grammatica.Parser.RecursiveDescentParser.IsNext(PerCederberg.Grammatica.Parser.ProductionPattern)">
  1955. Checks if the next tokens match a production pattern. The
  1956. pattern look-ahead set will be used if existing, otherwise
  1957. this method returns false.
  1958. @param pattern the pattern to check
  1959. @return true if the next tokens match, or
  1960. false otherwise
  1961. </member>
  1962. <member name="M:PerCederberg.Grammatica.Parser.RecursiveDescentParser.IsNext(PerCederberg.Grammatica.Parser.ProductionPatternAlternative)">
  1963. Checks if the next tokens match a production pattern
  1964. alternative. The pattern alternative look-ahead set will be
  1965. used if existing, otherwise this method returns false.
  1966. @param alt the pattern alternative to check
  1967. @return true if the next tokens match, or
  1968. false otherwise
  1969. </member>
  1970. <member name="M:PerCederberg.Grammatica.Parser.RecursiveDescentParser.IsNext(PerCederberg.Grammatica.Parser.ProductionPatternElement)">
  1971. Checks if the next tokens match a production pattern
  1972. element. If the element has a look-ahead set it will be
  1973. used, otherwise the look-ahead set of the referenced
  1974. production or token will be used.
  1975. @param elem the pattern element to check
  1976. @return true if the next tokens match, or
  1977. false otherwise
  1978. </member>
  1979. <member name="M:PerCederberg.Grammatica.Parser.RecursiveDescentParser.CalculateLookAhead(PerCederberg.Grammatica.Parser.ProductionPattern)">
  1980. Calculates the look-ahead needed for the specified production
  1981. pattern. This method attempts to resolve any conflicts and
  1982. stores the results in the pattern look-ahead object.
  1983. @param pattern the production pattern
  1984. @throws ParserCreationException if the look-ahead set couldn't
  1985. be determined due to inherent ambiguities
  1986. </member>
  1987. <member name="M:PerCederberg.Grammatica.Parser.RecursiveDescentParser.CalculateLookAhead(PerCederberg.Grammatica.Parser.ProductionPatternAlternative,System.Int32)">
  1988. Calculates the look-aheads needed for the specified pattern
  1989. alternative. This method attempts to resolve any conflicts in
  1990. optional elements by recalculating look-aheads for referenced
  1991. productions.
  1992. @param alt the production pattern alternative
  1993. @param pos the pattern element position
  1994. @throws ParserCreationException if the look-ahead set couldn't
  1995. be determined due to inherent ambiguities
  1996. </member>
  1997. <member name="M:PerCederberg.Grammatica.Parser.RecursiveDescentParser.FindLookAhead(PerCederberg.Grammatica.Parser.ProductionPattern,System.Int32,PerCederberg.Grammatica.Parser.RecursiveDescentParser.CallStack,PerCederberg.Grammatica.Parser.LookAheadSet)">
  1998. Finds the look-ahead set for a production pattern. The maximum
  1999. look-ahead length must be specified. It is also possible to
  2000. specify a look-ahead set filter, which will make sure that
  2001. unnecessary token sequences will be avoided.
  2002. @param pattern the production pattern
  2003. @param length the maximum look-ahead length
  2004. @param stack the call stack used for loop detection
  2005. @param filter the look-ahead set filter
  2006. @return the look-ahead set for the production pattern
  2007. @throws ParserCreationException if an infinite loop was found
  2008. in the grammar
  2009. </member>
  2010. <member name="M:PerCederberg.Grammatica.Parser.RecursiveDescentParser.FindLookAhead(PerCederberg.Grammatica.Parser.ProductionPatternAlternative,System.Int32,System.Int32,PerCederberg.Grammatica.Parser.RecursiveDescentParser.CallStack,PerCederberg.Grammatica.Parser.LookAheadSet)">
  2011. Finds the look-ahead set for a production pattern alternative.
  2012. The pattern position and maximum look-ahead length must be
  2013. specified. It is also possible to specify a look-ahead set
  2014. filter, which will make sure that unnecessary token sequences
  2015. will be avoided.
  2016. @param alt the production pattern alternative
  2017. @param length the maximum look-ahead length
  2018. @param pos the pattern element position
  2019. @param stack the call stack used for loop detection
  2020. @param filter the look-ahead set filter
  2021. @return the look-ahead set for the pattern alternative
  2022. @throws ParserCreationException if an infinite loop was found
  2023. in the grammar
  2024. </member>
  2025. <member name="M:PerCederberg.Grammatica.Parser.RecursiveDescentParser.FindLookAhead(PerCederberg.Grammatica.Parser.ProductionPatternElement,System.Int32,PerCederberg.Grammatica.Parser.RecursiveDescentParser.CallStack,PerCederberg.Grammatica.Parser.LookAheadSet)">
  2026. Finds the look-ahead set for a production pattern element. The
  2027. maximum look-ahead length must be specified. This method takes
  2028. the element repeats into consideration when creating the
  2029. look-ahead set, but does NOT include an empty sequence even if
  2030. the minimum count is zero (0). It is also possible to specify a
  2031. look-ahead set filter, which will make sure that unnecessary
  2032. token sequences will be avoided.
  2033. @param elem the production pattern element
  2034. @param length the maximum look-ahead length
  2035. @param stack the call stack used for loop detection
  2036. @param filter the look-ahead set filter
  2037. @return the look-ahead set for the pattern element
  2038. @throws ParserCreationException if an infinite loop was found
  2039. in the grammar
  2040. </member>
  2041. <member name="M:PerCederberg.Grammatica.Parser.RecursiveDescentParser.FindLookAhead(PerCederberg.Grammatica.Parser.ProductionPatternElement,System.Int32,System.Int32,PerCederberg.Grammatica.Parser.RecursiveDescentParser.CallStack,PerCederberg.Grammatica.Parser.LookAheadSet)">
  2042. Finds the look-ahead set for a production pattern element. The
  2043. maximum look-ahead length must be specified. This method does
  2044. NOT take the element repeat into consideration when creating
  2045. the look-ahead set. It is also possible to specify a look-ahead
  2046. set filter, which will make sure that unnecessary token
  2047. sequences will be avoided.
  2048. @param elem the production pattern element
  2049. @param length the maximum look-ahead length
  2050. @param dummy a parameter to distinguish the method
  2051. @param stack the call stack used for loop detection
  2052. @param filter the look-ahead set filter
  2053. @return the look-ahead set for the pattern element
  2054. @throws ParserCreationException if an infinite loop was found
  2055. in the grammar
  2056. </member>
  2057. <member name="M:PerCederberg.Grammatica.Parser.RecursiveDescentParser.FindConflicts(PerCederberg.Grammatica.Parser.ProductionPattern,System.Int32)">
  2058. Returns a look-ahead set with all conflics between
  2059. alternatives in a production pattern.
  2060. @param pattern the production pattern
  2061. @param maxLength the maximum token sequence length
  2062. @return a look-ahead set with the conflicts found
  2063. @throws ParserCreationException if an inherent ambiguity was
  2064. found among the look-ahead sets
  2065. </member>
  2066. <member name="M:PerCederberg.Grammatica.Parser.RecursiveDescentParser.FindConflicts(System.String,System.String,PerCederberg.Grammatica.Parser.LookAheadSet,PerCederberg.Grammatica.Parser.LookAheadSet)">
  2067. Returns a look-ahead set with all conflicts between two
  2068. look-ahead sets.
  2069. @param pattern the pattern name being analyzed
  2070. @param location the pattern location
  2071. @param set1 the first look-ahead set
  2072. @param set2 the second look-ahead set
  2073. @return a look-ahead set with the conflicts found
  2074. @throws ParserCreationException if an inherent ambiguity was
  2075. found among the look-ahead sets
  2076. </member>
  2077. <member name="M:PerCederberg.Grammatica.Parser.RecursiveDescentParser.FindUnion(PerCederberg.Grammatica.Parser.ProductionPattern)">
  2078. Returns the union of all alternative look-ahead sets in a
  2079. production pattern.
  2080. @param pattern the production pattern
  2081. @return a unified look-ahead set
  2082. </member>
  2083. <member name="M:PerCederberg.Grammatica.Parser.RecursiveDescentParser.ThrowParseException(PerCederberg.Grammatica.Parser.LookAheadSet)">
  2084. Throws a parse exception that matches the specified look-ahead
  2085. set. This method will take into account any initial matching
  2086. tokens in the look-ahead set.
  2087. @param set the look-ahead set to match
  2088. @throws ParseException always thrown by this method
  2089. </member>
  2090. <member name="M:PerCederberg.Grammatica.Parser.RecursiveDescentParser.ThrowAmbiguityException(System.String,System.String,PerCederberg.Grammatica.Parser.LookAheadSet)">
  2091. Throws a parser creation exception for an ambiguity. The
  2092. specified look-ahead set contains the token conflicts to be
  2093. reported.
  2094. @param pattern the production pattern name
  2095. @param location the production pattern location, or null
  2096. @param set the look-ahead set with conflicts
  2097. @throws ParserCreationException always thrown by this method
  2098. </member>
  2099. <member name="T:PerCederberg.Grammatica.Parser.RecursiveDescentParser.CallStack">
  2100. A name value stack. This stack is used to detect loops and
  2101. repetitions of the same production during look-ahead analysis.
  2102. </member>
  2103. <member name="F:PerCederberg.Grammatica.Parser.RecursiveDescentParser.CallStack.nameStack">
  2104. A stack with names.
  2105. </member>
  2106. <member name="F:PerCederberg.Grammatica.Parser.RecursiveDescentParser.CallStack.valueStack">
  2107. A stack with values.
  2108. </member>
  2109. <member name="M:PerCederberg.Grammatica.Parser.RecursiveDescentParser.CallStack.Contains(System.String)">
  2110. Checks if the specified name is on the stack.
  2111. @param name the name to search for
  2112. @return true if the name is on the stack, or
  2113. false otherwise
  2114. </member>
  2115. <member name="M:PerCederberg.Grammatica.Parser.RecursiveDescentParser.CallStack.Contains(System.String,System.Int32)">
  2116. Checks if the specified name and value combination is on
  2117. the stack.
  2118. @param name the name to search for
  2119. @param value the value to search for
  2120. @return true if the combination is on the stack, or
  2121. false otherwise
  2122. </member>
  2123. <member name="M:PerCederberg.Grammatica.Parser.RecursiveDescentParser.CallStack.Clear">
  2124. Clears the stack. This method removes all elements on
  2125. the stack.
  2126. </member>
  2127. <member name="M:PerCederberg.Grammatica.Parser.RecursiveDescentParser.CallStack.Push(System.String,System.Int32)">
  2128. Adds a new element to the top of the stack.
  2129. @param name the stack name
  2130. @param value the stack value
  2131. </member>
  2132. <member name="M:PerCederberg.Grammatica.Parser.RecursiveDescentParser.CallStack.Pop">
  2133. Removes the top element of the stack.
  2134. </member>
  2135. <!-- Badly formed XML comment ignored for member "T:PerCederberg.Grammatica.Parser.Token" -->
  2136. <member name="F:PerCederberg.Grammatica.Parser.Token.pattern">
  2137. The token pattern used for this token.
  2138. </member>
  2139. <member name="F:PerCederberg.Grammatica.Parser.Token.image">
  2140. The characters that constitute this token. This is normally
  2141. referred to as the token image.
  2142. </member>
  2143. <member name="F:PerCederberg.Grammatica.Parser.Token.startLine">
  2144. The line number of the first character in the token image.
  2145. </member>
  2146. <member name="F:PerCederberg.Grammatica.Parser.Token.startColumn">
  2147. The column number of the first character in the token image.
  2148. </member>
  2149. <member name="F:PerCederberg.Grammatica.Parser.Token.endLine">
  2150. The line number of the last character in the token image.
  2151. </member>
  2152. <member name="F:PerCederberg.Grammatica.Parser.Token.endColumn">
  2153. The column number of the last character in the token image.
  2154. </member>
  2155. <member name="F:PerCederberg.Grammatica.Parser.Token.previous">
  2156. The previous token in the list of tokens.
  2157. </member>
  2158. <member name="F:PerCederberg.Grammatica.Parser.Token.next">
  2159. The next token in the list of tokens.
  2160. </member>
  2161. <member name="M:PerCederberg.Grammatica.Parser.Token.#ctor(PerCederberg.Grammatica.Parser.TokenPattern,System.String,System.Int32,System.Int32)">
  2162. Creates a new token.
  2163. @param pattern the token pattern
  2164. @param image the token image (i.e. characters)
  2165. @param line the line number of the first character
  2166. @param col the column number of the first character
  2167. </member>
  2168. <member name="M:PerCederberg.Grammatica.Parser.Token.GetId">
  2169. Returns the token (pattern) id. This value is set as a unique
  2170. identifier when creating the token pattern to simplify later
  2171. identification.
  2172. @return the token id
  2173. </member>
  2174. <member name="M:PerCederberg.Grammatica.Parser.Token.GetName">
  2175. Returns the token node name.
  2176. @return the token node name
  2177. </member>
  2178. <member name="M:PerCederberg.Grammatica.Parser.Token.GetImage">
  2179. Returns the token image (i.e. the characters).
  2180. @return the token characters
  2181. </member>
  2182. <member name="M:PerCederberg.Grammatica.Parser.Token.GetStartLine">
  2183. The line number of the first character in the token image.
  2184. @return the line number of the first token character
  2185. </member>
  2186. <member name="M:PerCederberg.Grammatica.Parser.Token.GetStartColumn">
  2187. The column number of the first character in the token image.
  2188. @return the column number of the first token character
  2189. </member>
  2190. <member name="M:PerCederberg.Grammatica.Parser.Token.GetEndLine">
  2191. The line number of the last character in the token image.
  2192. @return the line number of the last token character
  2193. </member>
  2194. <member name="M:PerCederberg.Grammatica.Parser.Token.GetEndColumn">
  2195. The column number of the last character in the token image.
  2196. @return the column number of the last token character
  2197. </member>
  2198. <member name="M:PerCederberg.Grammatica.Parser.Token.GetPattern">
  2199. Returns the token pattern.
  2200. @return the token pattern
  2201. </member>
  2202. <member name="M:PerCederberg.Grammatica.Parser.Token.GetPreviousToken">
  2203. Returns the previuos token. The previous token may be a token
  2204. that has been ignored in the parsing. Note that if the token
  2205. list feature hasn't been used in the tokenizer, this method
  2206. will always return null. By default the token list feature is
  2207. not used.
  2208. @return the previous token, or
  2209. null if no such token is available
  2210. @see #getNextToken
  2211. @see Tokenizer#getUseTokenList
  2212. @see Tokenizer#setUseTokenList
  2213. @since 1.4
  2214. </member>
  2215. <member name="M:PerCederberg.Grammatica.Parser.Token.SetPreviousToken(PerCederberg.Grammatica.Parser.Token)">
  2216. Sets the previous token in the token list. This method will
  2217. also modify the token specified to have this token as it's
  2218. next token.
  2219. @param previous the previous token, or null for none
  2220. @since 1.4
  2221. </member>
  2222. <member name="M:PerCederberg.Grammatica.Parser.Token.GetNextToken">
  2223. Returns the next token. The next token may be a token that has
  2224. been ignored in the parsing. Note that if the token list
  2225. feature hasn't been used in the tokenizer, this method will
  2226. always return null. By default the token list feature is not
  2227. used.
  2228. @return the next token, or
  2229. null if no such token is available
  2230. @see #getPreviousToken
  2231. @see Tokenizer#getUseTokenList
  2232. @see Tokenizer#setUseTokenList
  2233. @since 1.4
  2234. </member>
  2235. <member name="M:PerCederberg.Grammatica.Parser.Token.SetNextToken(PerCederberg.Grammatica.Parser.Token)">
  2236. Sets the next token in the token list. This method will also
  2237. modify the token specified to have this token as it's
  2238. previous token.
  2239. @param next the next token, or null for none
  2240. @since 1.4
  2241. </member>
  2242. <member name="M:PerCederberg.Grammatica.Parser.Token.ToString">
  2243. Returns a string representation of this token.
  2244. @return a string representation of this token
  2245. </member>
  2246. <member name="M:PerCederberg.Grammatica.Parser.Token.ToShortString">
  2247. Returns a short string representation of this token. The
  2248. string will only contain the token image and possibly the
  2249. token pattern name.
  2250. @return a short string representation of this token
  2251. </member>
  2252. <!-- Badly formed XML comment ignored for member "T:PerCederberg.Grammatica.Parser.Tokenizer" -->
  2253. <member name="F:PerCederberg.Grammatica.Parser.Tokenizer.useTokenList">
  2254. The token list feature flag.
  2255. </member>
  2256. <member name="F:PerCederberg.Grammatica.Parser.Tokenizer.stringMatcher">
  2257. The string token matcher. This token matcher is used for all
  2258. string token patterns. This matcher implements a DFA to
  2259. provide maximum performance.
  2260. </member>
  2261. <member name="F:PerCederberg.Grammatica.Parser.Tokenizer.regexpMatchers">
  2262. The list of all regular expression token matchers. These
  2263. matchers each test matches for a single regular expression.
  2264. </member>
  2265. <member name="F:PerCederberg.Grammatica.Parser.Tokenizer.input">
  2266. The input stream to read from. When this is set to null, no
  2267. further input is available.
  2268. </member>
  2269. <member name="F:PerCederberg.Grammatica.Parser.Tokenizer.buffer">
  2270. The buffer with previously read characters. Normally characters
  2271. are appended in blocks to this buffer, and for every token that
  2272. is found, its characters are removed from the buffer.
  2273. </member>
  2274. <member name="F:PerCederberg.Grammatica.Parser.Tokenizer.position">
  2275. The current position in the string buffer.
  2276. </member>
  2277. <member name="F:PerCederberg.Grammatica.Parser.Tokenizer.line">
  2278. The line number of the first character in the buffer. This
  2279. value will be incremented when reading past line breaks.
  2280. </member>
  2281. <member name="F:PerCederberg.Grammatica.Parser.Tokenizer.column">
  2282. The column number of the first character in the buffer. This
  2283. value will be updated for every character read.
  2284. </member>
  2285. <member name="F:PerCederberg.Grammatica.Parser.Tokenizer.endOfBuffer">
  2286. The end of buffer read flag. This flag is set if the end of
  2287. the buffer was encountered while matching token patterns.
  2288. </member>
  2289. <member name="F:PerCederberg.Grammatica.Parser.Tokenizer.previousToken">
  2290. The previous token in the token list.
  2291. </member>
  2292. <member name="M:PerCederberg.Grammatica.Parser.Tokenizer.#ctor(System.IO.TextReader)">
  2293. Creates a new tokenizer for the specified input stream.
  2294. @param input the input stream to read
  2295. </member>
  2296. <member name="M:PerCederberg.Grammatica.Parser.Tokenizer.GetUseTokenList">
  2297. Checks if the token list feature is used. The token list
  2298. feature makes all tokens (including ignored tokens) link to
  2299. each other in a linked list. By default the token list feature
  2300. is not used.
  2301. @return true if the token list feature is used, or
  2302. false otherwise
  2303. @see #setUseTokenList
  2304. @see Token#getPreviousToken
  2305. @see Token#getNextToken
  2306. @since 1.4
  2307. </member>
  2308. <member name="M:PerCederberg.Grammatica.Parser.Tokenizer.SetUseTokenList(System.Boolean)">
  2309. Sets the token list feature flag. The token list feature makes
  2310. all tokens (including ignored tokens) link to each other in a
  2311. linked list when active. By default the token list feature is
  2312. not used.
  2313. @param useTokenList the token list feature flag
  2314. @see #getUseTokenList
  2315. @see Token#getPreviousToken
  2316. @see Token#getNextToken
  2317. @since 1.4
  2318. </member>
  2319. <member name="M:PerCederberg.Grammatica.Parser.Tokenizer.GetPatternDescription(System.Int32)">
  2320. Returns a description of the token pattern with the
  2321. specified id.
  2322. @param id the token pattern id
  2323. @return the token pattern description, or
  2324. null if not present
  2325. </member>
  2326. <member name="M:PerCederberg.Grammatica.Parser.Tokenizer.GetCurrentLine">
  2327. Returns the current line number. This number will be the line
  2328. number of the next token returned.
  2329. @return the current line number
  2330. </member>
  2331. <member name="M:PerCederberg.Grammatica.Parser.Tokenizer.GetCurrentColumn">
  2332. Returns the current column number. This number will be the
  2333. column number of the next token returned.
  2334. @return the current column number
  2335. </member>
  2336. <member name="M:PerCederberg.Grammatica.Parser.Tokenizer.AddPattern(PerCederberg.Grammatica.Parser.TokenPattern)">
  2337. Adds a new token pattern to the tokenizer. The pattern will be
  2338. added last in the list, choosing a previous token pattern in
  2339. case two matches the same string.
  2340. @param pattern the pattern to add
  2341. @throws ParserCreationException if the pattern couldn't be
  2342. added to the tokenizer
  2343. </member>
  2344. <member name="M:PerCederberg.Grammatica.Parser.Tokenizer.Next">
  2345. Finds the next token on the stream. This method will return
  2346. null when end of file has been reached. It will return a
  2347. parse exception if no token matched the input stream, or if
  2348. a token pattern with the error flag set matched. Any tokens
  2349. matching a token pattern with the ignore flag set will be
  2350. silently ignored and the next token will be returned.
  2351. @return the next token found, or
  2352. null if end of file was encountered
  2353. @throws ParseException if the input stream couldn't be read or
  2354. parsed correctly
  2355. </member>
  2356. <member name="M:PerCederberg.Grammatica.Parser.Tokenizer.NextToken">
  2357. Finds the next token on the stream. This method will return
  2358. null when end of file has been reached. It will return a
  2359. parse exception if no token matched the input stream.
  2360. @return the next token found, or
  2361. null if end of file was encountered
  2362. @throws ParseException if the input stream couldn't be read or
  2363. parsed correctly
  2364. </member>
  2365. <member name="M:PerCederberg.Grammatica.Parser.Tokenizer.ReadInput">
  2366. Reads characters from the input stream and appends them to
  2367. the input buffer. This method is safe to call even though
  2368. the end of file has been reached. As a side effect, this
  2369. method may also remove
  2370. @throws ParseException if an error was encountered while
  2371. reading the input stream
  2372. </member>
  2373. <member name="M:PerCederberg.Grammatica.Parser.Tokenizer.FindMatch">
  2374. Finds the longest token match from the current buffer
  2375. position. This method will return the token matcher for the
  2376. best match, or null if no match was found. As a side
  2377. effect, this method will also set the end of buffer flag.
  2378. @return the token mathcher with the longest match, or
  2379. null if no match was found
  2380. </member>
  2381. <member name="M:PerCederberg.Grammatica.Parser.Tokenizer.ToString">
  2382. Returns a string representation of this object. The returned
  2383. string will contain the details of all the token patterns
  2384. contained in this tokenizer.
  2385. @return a detailed string representation
  2386. </member>
  2387. <member name="T:PerCederberg.Grammatica.Parser.TokenMatcher">
  2388. A token pattern matcher. This class is the base class for the
  2389. two types of token matchers that exist. The token matcher
  2390. checks for matches with the tokenizer buffer, and maintains the
  2391. state of the last match.
  2392. </member>
  2393. <member name="M:PerCederberg.Grammatica.Parser.TokenMatcher.GetMatchedPattern">
  2394. Returns the latest matched token pattern.
  2395. @return the latest matched token pattern, or
  2396. null if no match found
  2397. </member>
  2398. <member name="M:PerCederberg.Grammatica.Parser.TokenMatcher.GetMatchedLength">
  2399. Returns the length of the latest match.
  2400. @return the length of the latest match, or
  2401. zero (0) if no match found
  2402. </member>
  2403. <member name="M:PerCederberg.Grammatica.Parser.TokenMatcher.HasReadEndOfString">
  2404. Checks if the end of string was encountered during the last
  2405. match.
  2406. @return true if the end of string was reached, or
  2407. false otherwise
  2408. </member>
  2409. <member name="T:PerCederberg.Grammatica.Parser.RegExpTokenMatcher">
  2410. A regular expression token pattern matcher. This class is used
  2411. to match a single regular expression with the tokenizer
  2412. buffer. This class also maintains the state of the last match.
  2413. </member>
  2414. <member name="F:PerCederberg.Grammatica.Parser.RegExpTokenMatcher.pattern">
  2415. The token pattern to match with.
  2416. </member>
  2417. <member name="F:PerCederberg.Grammatica.Parser.RegExpTokenMatcher.regExp">
  2418. The regular expression to use.
  2419. </member>
  2420. <member name="F:PerCederberg.Grammatica.Parser.RegExpTokenMatcher.matcher">
  2421. The regular expression matcher to use.
  2422. </member>
  2423. <member name="M:PerCederberg.Grammatica.Parser.RegExpTokenMatcher.#ctor(PerCederberg.Grammatica.Parser.TokenPattern)">
  2424. Creates a new regular expression token matcher.
  2425. @param pattern the pattern to match
  2426. @throws RegExpException if the regular expression couldn't
  2427. be created properly
  2428. </member>
  2429. <member name="M:PerCederberg.Grammatica.Parser.RegExpTokenMatcher.GetPattern">
  2430. Returns the token pattern.
  2431. @return the token pattern
  2432. </member>
  2433. <member name="M:PerCederberg.Grammatica.Parser.RegExpTokenMatcher.Start">
  2434. Returns the start position of the latest match.
  2435. @return the start position of the last match, or
  2436. zero (0) if none found
  2437. </member>
  2438. <member name="M:PerCederberg.Grammatica.Parser.RegExpTokenMatcher.GetMatchedPattern">
  2439. Returns the latest matched token pattern.
  2440. @return the latest matched token pattern, or
  2441. null if no match found
  2442. </member>
  2443. <member name="M:PerCederberg.Grammatica.Parser.RegExpTokenMatcher.GetMatchedLength">
  2444. Returns the length of the latest match.
  2445. @return the length of the latest match, or
  2446. zero (0) if no match found
  2447. </member>
  2448. <member name="M:PerCederberg.Grammatica.Parser.RegExpTokenMatcher.HasReadEndOfString">
  2449. Checks if the end of string was encountered during the last
  2450. match.
  2451. @return true if the end of string was reached, or
  2452. false otherwise
  2453. </member>
  2454. <member name="M:PerCederberg.Grammatica.Parser.RegExpTokenMatcher.MatchFrom(System.String,System.Int32)">
  2455. Checks if the token pattern matches the tokenizer buffer
  2456. from the specified position. This method will also reset
  2457. all flags in this matcher.
  2458. @param str the string to match
  2459. @param pos the starting position
  2460. @return true if a match was found, or
  2461. false otherwise
  2462. </member>
  2463. <member name="M:PerCederberg.Grammatica.Parser.RegExpTokenMatcher.ToString">
  2464. Returns a string representation of this token matcher.
  2465. @return a detailed string representation of this matcher
  2466. </member>
  2467. <member name="T:PerCederberg.Grammatica.Parser.StringTokenMatcher">
  2468. A string token pattern matcher. This class is used to match a
  2469. set of strings with the tokenizer buffer. This class
  2470. internally uses a DFA for maximum performance. It also
  2471. maintains the state of the last match.
  2472. </member>
  2473. <member name="F:PerCederberg.Grammatica.Parser.StringTokenMatcher.patterns">
  2474. The list of string token patterns.
  2475. </member>
  2476. <member name="F:PerCederberg.Grammatica.Parser.StringTokenMatcher.start">
  2477. The finite automaton to use for matching.
  2478. </member>
  2479. <member name="F:PerCederberg.Grammatica.Parser.StringTokenMatcher.match">
  2480. The last token pattern match found.
  2481. </member>
  2482. <member name="F:PerCederberg.Grammatica.Parser.StringTokenMatcher.endOfString">
  2483. The end of string read flag.
  2484. </member>
  2485. <member name="M:PerCederberg.Grammatica.Parser.StringTokenMatcher.#ctor">
  2486. Creates a new string token matcher.
  2487. </member>
  2488. <member name="M:PerCederberg.Grammatica.Parser.StringTokenMatcher.Reset">
  2489. Resets the matcher state. This will clear the results of
  2490. the last match.
  2491. </member>
  2492. <member name="M:PerCederberg.Grammatica.Parser.StringTokenMatcher.GetMatchedPattern">
  2493. Returns the latest matched token pattern.
  2494. @return the latest matched token pattern, or
  2495. null if no match found
  2496. </member>
  2497. <member name="M:PerCederberg.Grammatica.Parser.StringTokenMatcher.GetMatchedLength">
  2498. Returns the length of the latest match.
  2499. @return the length of the latest match, or
  2500. zero (0) if no match found
  2501. </member>
  2502. <member name="M:PerCederberg.Grammatica.Parser.StringTokenMatcher.HasReadEndOfString">
  2503. Checks if the end of string was encountered during the last
  2504. match.
  2505. @return true if the end of string was reached, or
  2506. false otherwise
  2507. </member>
  2508. <member name="M:PerCederberg.Grammatica.Parser.StringTokenMatcher.SetReadEndOfString">
  2509. Sets the end of string encountered flag.
  2510. </member>
  2511. <member name="M:PerCederberg.Grammatica.Parser.StringTokenMatcher.GetPattern(System.Int32)">
  2512. Returns the token pattern with the specified id. Only
  2513. token patterns handled by this matcher can be returned.
  2514. @param id the token pattern id
  2515. @return the token pattern found, or
  2516. null if not found
  2517. </member>
  2518. <member name="M:PerCederberg.Grammatica.Parser.StringTokenMatcher.AddPattern(PerCederberg.Grammatica.Parser.TokenPattern)">
  2519. Adds a string token pattern to this matcher.
  2520. @param pattern the pattern to add
  2521. </member>
  2522. <member name="M:PerCederberg.Grammatica.Parser.StringTokenMatcher.MatchFrom(System.String,System.Int32)">
  2523. Checks if the token pattern matches the tokenizer buffer
  2524. from the specified position. This method will also reset
  2525. all flags in this matcher.
  2526. @param str the string to match
  2527. @param pos the starting position
  2528. @return true if a match was found, or
  2529. false otherwise
  2530. </member>
  2531. <member name="M:PerCederberg.Grammatica.Parser.StringTokenMatcher.ToString">
  2532. Returns a string representation of this matcher. This will
  2533. contain all the token patterns.
  2534. @return a detailed string representation of this matcher
  2535. </member>
  2536. <member name="T:PerCederberg.Grammatica.Parser.Automaton">
  2537. A deterministic finite automaton. This is a simple automaton
  2538. for character sequences. It cannot handle character set state
  2539. transitions, but only supports single character transitions.
  2540. </member>
  2541. <member name="F:PerCederberg.Grammatica.Parser.Automaton.value">
  2542. The state value.
  2543. </member>
  2544. <member name="F:PerCederberg.Grammatica.Parser.Automaton.tree">
  2545. The automaton state transition tree. Each transition from
  2546. this state to another state is added to this tree with the
  2547. corresponding character.
  2548. </member>
  2549. <member name="M:PerCederberg.Grammatica.Parser.Automaton.#ctor">
  2550. Creates a new empty automaton.
  2551. </member>
  2552. <member name="M:PerCederberg.Grammatica.Parser.Automaton.AddMatch(System.String,System.Object)">
  2553. Adds a string match to this automaton. New states and
  2554. transitions will be added to extend this automaton to
  2555. support the specified string.
  2556. @param str the string to match
  2557. @param value the match value
  2558. </member>
  2559. <member name="M:PerCederberg.Grammatica.Parser.Automaton.MatchFrom(PerCederberg.Grammatica.Parser.StringTokenMatcher,System.String,System.Int32)">
  2560. Checks if the automaton matches the tokenizer buffer from
  2561. the specified position. This method will set the end of
  2562. buffer flag in the specified token matcher if the end of
  2563. buffer is reached.
  2564. @param m the string token matcher
  2565. @param str the string to match
  2566. @param pos the starting position
  2567. @return the match value, or
  2568. null if no match is found
  2569. </member>
  2570. <member name="T:PerCederberg.Grammatica.Parser.AutomatonTree">
  2571. An automaton state transition tree. This class contains a
  2572. binary search tree for the automaton transitions from one
  2573. state to another. All transitions are linked to a single
  2574. character.
  2575. </member>
  2576. <member name="F:PerCederberg.Grammatica.Parser.AutomatonTree.value">
  2577. The transition character. If this value is set to the zero
  2578. ('\0') character, this tree is empty.
  2579. </member>
  2580. <member name="F:PerCederberg.Grammatica.Parser.AutomatonTree.state">
  2581. The transition state.
  2582. </member>
  2583. <member name="F:PerCederberg.Grammatica.Parser.AutomatonTree.left">
  2584. The left subtree.
  2585. </member>
  2586. <member name="F:PerCederberg.Grammatica.Parser.AutomatonTree.right">
  2587. The right subtree.
  2588. </member>
  2589. <member name="M:PerCederberg.Grammatica.Parser.AutomatonTree.#ctor">
  2590. Creates a new empty automaton transition tree.
  2591. </member>
  2592. <member name="M:PerCederberg.Grammatica.Parser.AutomatonTree.Find(System.Char)">
  2593. Finds an automaton state from the specified transition
  2594. character. This method searches this transition tree for
  2595. a matching transition.
  2596. @param c the character to search for
  2597. @return the automaton state found, or
  2598. null if no transition exists
  2599. </member>
  2600. <member name="M:PerCederberg.Grammatica.Parser.AutomatonTree.Add(System.Char,PerCederberg.Grammatica.Parser.Automaton)">
  2601. Adds a transition to this tree.
  2602. @param c the character to transition for
  2603. @param state the state to transition to
  2604. </member>
  2605. <!-- Badly formed XML comment ignored for member "T:PerCederberg.Grammatica.Parser.TokenPattern" -->
  2606. <member name="F:PerCederberg.Grammatica.Parser.TokenPattern.id">
  2607. The token pattern identity.
  2608. </member>
  2609. <member name="F:PerCederberg.Grammatica.Parser.TokenPattern.name">
  2610. The token pattern name.
  2611. </member>
  2612. <member name="F:PerCederberg.Grammatica.Parser.TokenPattern.type">
  2613. The token pattern type.
  2614. </member>
  2615. <member name="F:PerCederberg.Grammatica.Parser.TokenPattern.pattern">
  2616. The token pattern.
  2617. </member>
  2618. <member name="F:PerCederberg.Grammatica.Parser.TokenPattern.error">
  2619. The token error flag. If this flag is set, it means that an
  2620. error should be reported if the token is found. The error
  2621. message is present in the errorMessage variable.
  2622. @see #errorMessage
  2623. </member>
  2624. <member name="F:PerCederberg.Grammatica.Parser.TokenPattern.errorMessage">
  2625. The token error message. This message will only be set if the
  2626. token error flag is set.
  2627. @see #error
  2628. </member>
  2629. <member name="F:PerCederberg.Grammatica.Parser.TokenPattern.ignore">
  2630. The token ignore flag. If this flag is set, it means that the
  2631. token should be ignored if found. If an ignore message is
  2632. present in the ignoreMessage variable, it will also be reported
  2633. as a warning.
  2634. @see #ignoreMessage
  2635. </member>
  2636. <member name="F:PerCederberg.Grammatica.Parser.TokenPattern.ignoreMessage">
  2637. The token ignore message. If this message is set when the token
  2638. ignore flag is also set, a warning message will be printed if
  2639. the token is found.
  2640. @see #ignore
  2641. </member>
  2642. <member name="M:PerCederberg.Grammatica.Parser.TokenPattern.#ctor(System.Int32,System.String,PerCederberg.Grammatica.Parser.TokenPattern.PatternType,System.String)">
  2643. Creates a new token pattern.
  2644. @param id the token pattern id
  2645. @param name the token pattern name
  2646. @param type the token pattern type
  2647. @param pattern the token pattern
  2648. </member>
  2649. <member name="M:PerCederberg.Grammatica.Parser.TokenPattern.IsError">
  2650. Checks if the pattern corresponds to an error token. If this
  2651. is true, it means that an error should be reported if a
  2652. matching token is found.
  2653. @return true if the pattern maps to an error token, or
  2654. false otherwise
  2655. </member>
  2656. <member name="M:PerCederberg.Grammatica.Parser.TokenPattern.IsIgnore">
  2657. Checks if the pattern corresponds to an ignored token. If this
  2658. is true, it means that the token should be ignored if found.
  2659. @return true if the pattern maps to an ignored token, or
  2660. false otherwise
  2661. </member>
  2662. <member name="M:PerCederberg.Grammatica.Parser.TokenPattern.GetId">
  2663. Returns the unique token pattern identity value.
  2664. @return the token pattern id
  2665. </member>
  2666. <member name="M:PerCederberg.Grammatica.Parser.TokenPattern.GetName">
  2667. Returns the token pattern name.
  2668. @return the token pattern name
  2669. </member>
  2670. <member name="M:PerCederberg.Grammatica.Parser.TokenPattern.GetPatternType">
  2671. Returns the token pattern type.
  2672. @return the token pattern type
  2673. </member>
  2674. <member name="M:PerCederberg.Grammatica.Parser.TokenPattern.GetPattern">
  2675. Returns te token pattern.
  2676. @return the token pattern
  2677. </member>
  2678. <member name="M:PerCederberg.Grammatica.Parser.TokenPattern.GetErrorMessage">
  2679. Returns the token error message if the pattern corresponds to
  2680. an error token.
  2681. @return the token error message
  2682. </member>
  2683. <member name="M:PerCederberg.Grammatica.Parser.TokenPattern.GetIgnoreMessage">
  2684. Returns the token ignore message if the pattern corresponds to
  2685. an ignored token.
  2686. @return the token ignore message
  2687. </member>
  2688. <member name="M:PerCederberg.Grammatica.Parser.TokenPattern.SetError">
  2689. Sets the token error flag and assigns a default error message.
  2690. </member>
  2691. <member name="M:PerCederberg.Grammatica.Parser.TokenPattern.SetError(System.String)">
  2692. Sets the token error flag and assigns the specified error
  2693. message.
  2694. @param message the error message to display
  2695. </member>
  2696. <member name="M:PerCederberg.Grammatica.Parser.TokenPattern.SetIgnore">
  2697. Sets the token ignore flag and clears the ignore message.
  2698. </member>
  2699. <member name="M:PerCederberg.Grammatica.Parser.TokenPattern.SetIgnore(System.String)">
  2700. Sets the token ignore flag and assigns the specified ignore
  2701. message.
  2702. @param message the ignore message to display
  2703. </member>
  2704. <member name="M:PerCederberg.Grammatica.Parser.TokenPattern.ToString">
  2705. Returns a string representation of this object.
  2706. @return a token pattern string representation
  2707. </member>
  2708. <member name="M:PerCederberg.Grammatica.Parser.TokenPattern.ToShortString">
  2709. Returns a short string representation of this object.
  2710. @return a short string representation of this object
  2711. </member>
  2712. <member name="T:PerCederberg.Grammatica.Parser.TokenPattern.PatternType">
  2713. The pattern type enumeration.
  2714. </member>
  2715. <member name="T:Infragistics.Win.CalcEngine.UCCompilation">
  2716. <summary>
  2717. UCCompliation represents a compiled formula. It encapsulates the formula parser and is responsible
  2718. for formula parsing.
  2719. </summary>
  2720. </member>
  2721. <member name="F:Infragistics.Win.CalcEngine.UCCompilation.baseRef">
  2722. <summary>
  2723. Storage for the context reference where the formula is stored. Used to create references found in the
  2724. formula.
  2725. </summary>
  2726. </member>
  2727. <member name="F:Infragistics.Win.CalcEngine.UCCompilation.formula">
  2728. <summary>
  2729. Storage for the string representation of the formula.
  2730. </summary>
  2731. </member>
  2732. <member name="F:Infragistics.Win.CalcEngine.UCCompilation.error">
  2733. <summary>
  2734. Storage for the last compilation error message.
  2735. </summary>
  2736. </member>
  2737. <member name="F:Infragistics.Win.CalcEngine.UCCompilation.parsedNode">
  2738. <summary>
  2739. Storage for the root of the parse tree.
  2740. </summary>
  2741. </member>
  2742. <member name="F:Infragistics.Win.CalcEngine.UCCompilation.tokens">
  2743. <summary>
  2744. Storage for the formula tokens.
  2745. </summary>
  2746. </member>
  2747. <member name="F:Infragistics.Win.CalcEngine.UCCompilation.functionFactory">
  2748. <summary>
  2749. Storage for the UltraCalcFunctionFactory instance used to create function calls.
  2750. </summary>
  2751. </member>
  2752. <member name="M:Infragistics.Win.CalcEngine.UCCompilation.#ctor">
  2753. <summary>
  2754. Constructor with default function factory.
  2755. </summary>
  2756. </member>
  2757. <member name="M:Infragistics.Win.CalcEngine.UCCompilation.#ctor(Infragistics.Win.CalcEngine.UltraCalcFunctionFactory)">
  2758. <summary>
  2759. Constructor with a specified function factory.
  2760. </summary>
  2761. <param name="functionFactory">The function factory used to construct function calls.</param>
  2762. </member>
  2763. <member name="M:Infragistics.Win.CalcEngine.UCCompilation.Parse(Infragistics.Win.CalcEngine.IUltraCalcReference,System.String)">
  2764. <summary>
  2765. Parse the formula into a parse tree. Initializes the FormulaString and RootNode properties.
  2766. </summary>
  2767. <param name="baseReference">The context reference where the formula is stored.</param>
  2768. <param name="formula">The formula to parse.</param>
  2769. <returns>true if successful, otherwise Error contains compilation error message</returns>
  2770. </member>
  2771. <member name="M:Infragistics.Win.CalcEngine.UCCompilation.Tokenize">
  2772. <summary>
  2773. Converts the parsed formula into tokenized form. Parse must be called first.
  2774. <see cref="M:Infragistics.Win.CalcEngine.UCCompilation.Parse(Infragistics.Win.CalcEngine.IUltraCalcReference,System.String)"/>
  2775. </summary>
  2776. <returns>true if successful, otherwise Error contains compilation error message</returns>
  2777. </member>
  2778. <member name="M:Infragistics.Win.CalcEngine.UCCompilation.DoPostfixNode(PerCederberg.Grammatica.Parser.Node,Infragistics.Win.CalcEngine.UltraCalcFormulaTokenCollection)">
  2779. <summary>
  2780. Recursive function used by Tokenize to walk the parse tree and generate the formula tokens.
  2781. </summary>
  2782. <param name="n">The current node being evaluated.</param>
  2783. <param name="tokens">The formula token collection to append to.</param>
  2784. <returns>true if successful, otherwise Error contains compilation error message</returns>
  2785. </member>
  2786. <member name="M:Infragistics.Win.CalcEngine.UCCompilation.DoTermLoop(Infragistics.Win.CalcEngine.UCparserConstants,PerCederberg.Grammatica.Parser.Node,Infragistics.Win.CalcEngine.UltraCalcFormulaTokenCollection)">
  2787. <summary>
  2788. Function used by DoPostfixNode to extract a collection of terms from the parse tree.
  2789. </summary>
  2790. <param name="termID">The term identifier.</param>
  2791. <param name="n">The root node of the term collection.</param>
  2792. <param name="tokens">The formula token collection to append to.</param>
  2793. <returns>true if successful, otherwise Error contains compilation error message</returns>
  2794. </member>
  2795. <member name="M:Infragistics.Win.CalcEngine.UCCompilation.DoOpNode(PerCederberg.Grammatica.Parser.Node,Infragistics.Win.CalcEngine.UltraCalcFormulaTokenCollection)">
  2796. <summary>
  2797. Function used by DoPostfixNode to extract an Operator from the parse tree.
  2798. </summary>
  2799. <param name="n">The operator node.</param>
  2800. <param name="tokens">The formula token collection to append to.</param>
  2801. <returns>true if successful, otherwise Error contains compilation error message</returns>
  2802. </member>
  2803. <member name="M:Infragistics.Win.CalcEngine.UCCompilation.ConcatChildren(PerCederberg.Grammatica.Parser.Node)">
  2804. <summary>
  2805. Function used by DoPostfixNode to concatenate a collection of nodes.
  2806. <param name="n">The root node to concatenate.</param>
  2807. <returns>true if successful, otherwise Error contains compilation error message</returns>
  2808. </summary>
  2809. </member>
  2810. <member name="M:Infragistics.Win.CalcEngine.UCCompilation.CountFuncArgs(PerCederberg.Grammatica.Parser.Node)">
  2811. <summary>
  2812. Function used by DoPostfixNode to determine the number of function arguments for a function.
  2813. <param name="n">The function node.</param>
  2814. <returns>the argument count.</returns>
  2815. </summary>
  2816. </member>
  2817. <member name="P:Infragistics.Win.CalcEngine.UCCompilation.FormulaString">
  2818. <summary>
  2819. Return the string representation of the formula. Read Only.
  2820. </summary>
  2821. </member>
  2822. <member name="P:Infragistics.Win.CalcEngine.UCCompilation.HasAlwaysDirty">
  2823. <summary>
  2824. Denotes whether the formula contains an always dirty function
  2825. </summary>
  2826. </member>
  2827. <member name="P:Infragistics.Win.CalcEngine.UCCompilation.Tokens">
  2828. <summary>
  2829. Return the collection of tokens for the parsed formula. Read Only.
  2830. </summary>
  2831. </member>
  2832. <member name="P:Infragistics.Win.CalcEngine.UCCompilation.Error">
  2833. <summary>
  2834. Return the last compilation error message. Read Only.
  2835. </summary>
  2836. </member>
  2837. <member name="P:Infragistics.Win.CalcEngine.UCCompilation.RootNode">
  2838. <summary>
  2839. Return the root of the parse tree. Read Only.
  2840. </summary>
  2841. </member>
  2842. <member name="T:Infragistics.Win.CalcEngine.UCparserAnalyzer">
  2843. <remarks>A class providing callback methods for the
  2844. parser.</remarks>
  2845. </member>
  2846. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.Enter(PerCederberg.Grammatica.Parser.Node)">
  2847. <summary>Called when entering a parse tree node.</summary>
  2848. <param name="node">the node being entered</param>
  2849. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  2850. discovered errors</exception>
  2851. </member>
  2852. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.Exit(PerCederberg.Grammatica.Parser.Node)">
  2853. <summary>Called when exiting a parse tree node.</summary>
  2854. <param name="node">the node being exited</param>
  2855. <returns>the node to add to the parse tree, or
  2856. null if no parse tree should be created</returns>
  2857. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  2858. discovered errors</exception>
  2859. </member>
  2860. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.Child(PerCederberg.Grammatica.Parser.Production,PerCederberg.Grammatica.Parser.Node)">
  2861. <summary>Called when adding a child to a parse tree
  2862. node.</summary>
  2863. <param name="node">the parent node</param>
  2864. <param name="child">the child node, or null</param>
  2865. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  2866. discovered errors</exception>
  2867. </member>
  2868. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterLeftParen(PerCederberg.Grammatica.Parser.Token)">
  2869. <summary>Called when entering a parse tree node.</summary>
  2870. <param name="node">the node being entered</param>
  2871. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  2872. discovered errors</exception>
  2873. </member>
  2874. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitLeftParen(PerCederberg.Grammatica.Parser.Token)">
  2875. <summary>Called when exiting a parse tree node.</summary>
  2876. <param name="node">the node being exited</param>
  2877. <returns>the node to add to the parse tree, or
  2878. null if no parse tree should be created</returns>
  2879. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  2880. discovered errors</exception>
  2881. </member>
  2882. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterRightParen(PerCederberg.Grammatica.Parser.Token)">
  2883. <summary>Called when entering a parse tree node.</summary>
  2884. <param name="node">the node being entered</param>
  2885. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  2886. discovered errors</exception>
  2887. </member>
  2888. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitRightParen(PerCederberg.Grammatica.Parser.Token)">
  2889. <summary>Called when exiting a parse tree node.</summary>
  2890. <param name="node">the node being exited</param>
  2891. <returns>the node to add to the parse tree, or
  2892. null if no parse tree should be created</returns>
  2893. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  2894. discovered errors</exception>
  2895. </member>
  2896. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterNumber(PerCederberg.Grammatica.Parser.Token)">
  2897. <summary>Called when entering a parse tree node.</summary>
  2898. <param name="node">the node being entered</param>
  2899. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  2900. discovered errors</exception>
  2901. </member>
  2902. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitNumber(PerCederberg.Grammatica.Parser.Token)">
  2903. <summary>Called when exiting a parse tree node.</summary>
  2904. <param name="node">the node being exited</param>
  2905. <returns>the node to add to the parse tree, or
  2906. null if no parse tree should be created</returns>
  2907. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  2908. discovered errors</exception>
  2909. </member>
  2910. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterText(PerCederberg.Grammatica.Parser.Token)">
  2911. <summary>Called when entering a parse tree node.</summary>
  2912. <param name="node">the node being entered</param>
  2913. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  2914. discovered errors</exception>
  2915. </member>
  2916. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitText(PerCederberg.Grammatica.Parser.Token)">
  2917. <summary>Called when exiting a parse tree node.</summary>
  2918. <param name="node">the node being exited</param>
  2919. <returns>the node to add to the parse tree, or
  2920. null if no parse tree should be created</returns>
  2921. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  2922. discovered errors</exception>
  2923. </member>
  2924. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterOpDot(PerCederberg.Grammatica.Parser.Token)">
  2925. <summary>Called when entering a parse tree node.</summary>
  2926. <param name="node">the node being entered</param>
  2927. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  2928. discovered errors</exception>
  2929. </member>
  2930. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitOpDot(PerCederberg.Grammatica.Parser.Token)">
  2931. <summary>Called when exiting a parse tree node.</summary>
  2932. <param name="node">the node being exited</param>
  2933. <returns>the node to add to the parse tree, or
  2934. null if no parse tree should be created</returns>
  2935. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  2936. discovered errors</exception>
  2937. </member>
  2938. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterOpEqual(PerCederberg.Grammatica.Parser.Token)">
  2939. <summary>Called when entering a parse tree node.</summary>
  2940. <param name="node">the node being entered</param>
  2941. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  2942. discovered errors</exception>
  2943. </member>
  2944. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitOpEqual(PerCederberg.Grammatica.Parser.Token)">
  2945. <summary>Called when exiting a parse tree node.</summary>
  2946. <param name="node">the node being exited</param>
  2947. <returns>the node to add to the parse tree, or
  2948. null if no parse tree should be created</returns>
  2949. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  2950. discovered errors</exception>
  2951. </member>
  2952. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterOpGt(PerCederberg.Grammatica.Parser.Token)">
  2953. <summary>Called when entering a parse tree node.</summary>
  2954. <param name="node">the node being entered</param>
  2955. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  2956. discovered errors</exception>
  2957. </member>
  2958. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitOpGt(PerCederberg.Grammatica.Parser.Token)">
  2959. <summary>Called when exiting a parse tree node.</summary>
  2960. <param name="node">the node being exited</param>
  2961. <returns>the node to add to the parse tree, or
  2962. null if no parse tree should be created</returns>
  2963. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  2964. discovered errors</exception>
  2965. </member>
  2966. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterOpLt(PerCederberg.Grammatica.Parser.Token)">
  2967. <summary>Called when entering a parse tree node.</summary>
  2968. <param name="node">the node being entered</param>
  2969. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  2970. discovered errors</exception>
  2971. </member>
  2972. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitOpLt(PerCederberg.Grammatica.Parser.Token)">
  2973. <summary>Called when exiting a parse tree node.</summary>
  2974. <param name="node">the node being exited</param>
  2975. <returns>the node to add to the parse tree, or
  2976. null if no parse tree should be created</returns>
  2977. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  2978. discovered errors</exception>
  2979. </member>
  2980. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterOpGe(PerCederberg.Grammatica.Parser.Token)">
  2981. <summary>Called when entering a parse tree node.</summary>
  2982. <param name="node">the node being entered</param>
  2983. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  2984. discovered errors</exception>
  2985. </member>
  2986. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitOpGe(PerCederberg.Grammatica.Parser.Token)">
  2987. <summary>Called when exiting a parse tree node.</summary>
  2988. <param name="node">the node being exited</param>
  2989. <returns>the node to add to the parse tree, or
  2990. null if no parse tree should be created</returns>
  2991. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  2992. discovered errors</exception>
  2993. </member>
  2994. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterOpLe(PerCederberg.Grammatica.Parser.Token)">
  2995. <summary>Called when entering a parse tree node.</summary>
  2996. <param name="node">the node being entered</param>
  2997. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  2998. discovered errors</exception>
  2999. </member>
  3000. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitOpLe(PerCederberg.Grammatica.Parser.Token)">
  3001. <summary>Called when exiting a parse tree node.</summary>
  3002. <param name="node">the node being exited</param>
  3003. <returns>the node to add to the parse tree, or
  3004. null if no parse tree should be created</returns>
  3005. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3006. discovered errors</exception>
  3007. </member>
  3008. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterOpNe(PerCederberg.Grammatica.Parser.Token)">
  3009. <summary>Called when entering a parse tree node.</summary>
  3010. <param name="node">the node being entered</param>
  3011. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3012. discovered errors</exception>
  3013. </member>
  3014. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitOpNe(PerCederberg.Grammatica.Parser.Token)">
  3015. <summary>Called when exiting a parse tree node.</summary>
  3016. <param name="node">the node being exited</param>
  3017. <returns>the node to add to the parse tree, or
  3018. null if no parse tree should be created</returns>
  3019. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3020. discovered errors</exception>
  3021. </member>
  3022. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterOpAltNe(PerCederberg.Grammatica.Parser.Token)">
  3023. <summary>Called when entering a parse tree node.</summary>
  3024. <param name="node">the node being entered</param>
  3025. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3026. discovered errors</exception>
  3027. </member>
  3028. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitOpAltNe(PerCederberg.Grammatica.Parser.Token)">
  3029. <summary>Called when exiting a parse tree node.</summary>
  3030. <param name="node">the node being exited</param>
  3031. <returns>the node to add to the parse tree, or
  3032. null if no parse tree should be created</returns>
  3033. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3034. discovered errors</exception>
  3035. </member>
  3036. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterOpConcat(PerCederberg.Grammatica.Parser.Token)">
  3037. <summary>Called when entering a parse tree node.</summary>
  3038. <param name="node">the node being entered</param>
  3039. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3040. discovered errors</exception>
  3041. </member>
  3042. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitOpConcat(PerCederberg.Grammatica.Parser.Token)">
  3043. <summary>Called when exiting a parse tree node.</summary>
  3044. <param name="node">the node being exited</param>
  3045. <returns>the node to add to the parse tree, or
  3046. null if no parse tree should be created</returns>
  3047. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3048. discovered errors</exception>
  3049. </member>
  3050. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterOpPlus(PerCederberg.Grammatica.Parser.Token)">
  3051. <summary>Called when entering a parse tree node.</summary>
  3052. <param name="node">the node being entered</param>
  3053. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3054. discovered errors</exception>
  3055. </member>
  3056. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitOpPlus(PerCederberg.Grammatica.Parser.Token)">
  3057. <summary>Called when exiting a parse tree node.</summary>
  3058. <param name="node">the node being exited</param>
  3059. <returns>the node to add to the parse tree, or
  3060. null if no parse tree should be created</returns>
  3061. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3062. discovered errors</exception>
  3063. </member>
  3064. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterOpMinus(PerCederberg.Grammatica.Parser.Token)">
  3065. <summary>Called when entering a parse tree node.</summary>
  3066. <param name="node">the node being entered</param>
  3067. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3068. discovered errors</exception>
  3069. </member>
  3070. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitOpMinus(PerCederberg.Grammatica.Parser.Token)">
  3071. <summary>Called when exiting a parse tree node.</summary>
  3072. <param name="node">the node being exited</param>
  3073. <returns>the node to add to the parse tree, or
  3074. null if no parse tree should be created</returns>
  3075. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3076. discovered errors</exception>
  3077. </member>
  3078. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterOpTimes(PerCederberg.Grammatica.Parser.Token)">
  3079. <summary>Called when entering a parse tree node.</summary>
  3080. <param name="node">the node being entered</param>
  3081. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3082. discovered errors</exception>
  3083. </member>
  3084. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitOpTimes(PerCederberg.Grammatica.Parser.Token)">
  3085. <summary>Called when exiting a parse tree node.</summary>
  3086. <param name="node">the node being exited</param>
  3087. <returns>the node to add to the parse tree, or
  3088. null if no parse tree should be created</returns>
  3089. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3090. discovered errors</exception>
  3091. </member>
  3092. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterOpDiv(PerCederberg.Grammatica.Parser.Token)">
  3093. <summary>Called when entering a parse tree node.</summary>
  3094. <param name="node">the node being entered</param>
  3095. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3096. discovered errors</exception>
  3097. </member>
  3098. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitOpDiv(PerCederberg.Grammatica.Parser.Token)">
  3099. <summary>Called when exiting a parse tree node.</summary>
  3100. <param name="node">the node being exited</param>
  3101. <returns>the node to add to the parse tree, or
  3102. null if no parse tree should be created</returns>
  3103. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3104. discovered errors</exception>
  3105. </member>
  3106. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterOpExpon(PerCederberg.Grammatica.Parser.Token)">
  3107. <summary>Called when entering a parse tree node.</summary>
  3108. <param name="node">the node being entered</param>
  3109. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3110. discovered errors</exception>
  3111. </member>
  3112. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitOpExpon(PerCederberg.Grammatica.Parser.Token)">
  3113. <summary>Called when exiting a parse tree node.</summary>
  3114. <param name="node">the node being exited</param>
  3115. <returns>the node to add to the parse tree, or
  3116. null if no parse tree should be created</returns>
  3117. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3118. discovered errors</exception>
  3119. </member>
  3120. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterOpPercent(PerCederberg.Grammatica.Parser.Token)">
  3121. <summary>Called when entering a parse tree node.</summary>
  3122. <param name="node">the node being entered</param>
  3123. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3124. discovered errors</exception>
  3125. </member>
  3126. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitOpPercent(PerCederberg.Grammatica.Parser.Token)">
  3127. <summary>Called when exiting a parse tree node.</summary>
  3128. <param name="node">the node being exited</param>
  3129. <returns>the node to add to the parse tree, or
  3130. null if no parse tree should be created</returns>
  3131. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3132. discovered errors</exception>
  3133. </member>
  3134. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterArgSep(PerCederberg.Grammatica.Parser.Token)">
  3135. <summary>Called when entering a parse tree node.</summary>
  3136. <param name="node">the node being entered</param>
  3137. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3138. discovered errors</exception>
  3139. </member>
  3140. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitArgSep(PerCederberg.Grammatica.Parser.Token)">
  3141. <summary>Called when exiting a parse tree node.</summary>
  3142. <param name="node">the node being exited</param>
  3143. <returns>the node to add to the parse tree, or
  3144. null if no parse tree should be created</returns>
  3145. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3146. discovered errors</exception>
  3147. </member>
  3148. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterRangeSep(PerCederberg.Grammatica.Parser.Token)">
  3149. <summary>Called when entering a parse tree node.</summary>
  3150. <param name="node">the node being entered</param>
  3151. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3152. discovered errors</exception>
  3153. </member>
  3154. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitRangeSep(PerCederberg.Grammatica.Parser.Token)">
  3155. <summary>Called when exiting a parse tree node.</summary>
  3156. <param name="node">the node being exited</param>
  3157. <returns>the node to add to the parse tree, or
  3158. null if no parse tree should be created</returns>
  3159. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3160. discovered errors</exception>
  3161. </member>
  3162. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterReference(PerCederberg.Grammatica.Parser.Token)">
  3163. <summary>Called when entering a parse tree node.</summary>
  3164. <param name="node">the node being entered</param>
  3165. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3166. discovered errors</exception>
  3167. </member>
  3168. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitReference(PerCederberg.Grammatica.Parser.Token)">
  3169. <summary>Called when exiting a parse tree node.</summary>
  3170. <param name="node">the node being exited</param>
  3171. <returns>the node to add to the parse tree, or
  3172. null if no parse tree should be created</returns>
  3173. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3174. discovered errors</exception>
  3175. </member>
  3176. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterQuotedString(PerCederberg.Grammatica.Parser.Token)">
  3177. <summary>Called when entering a parse tree node.</summary>
  3178. <param name="node">the node being entered</param>
  3179. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3180. discovered errors</exception>
  3181. </member>
  3182. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitQuotedString(PerCederberg.Grammatica.Parser.Token)">
  3183. <summary>Called when exiting a parse tree node.</summary>
  3184. <param name="node">the node being exited</param>
  3185. <returns>the node to add to the parse tree, or
  3186. null if no parse tree should be created</returns>
  3187. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3188. discovered errors</exception>
  3189. </member>
  3190. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterFormula(PerCederberg.Grammatica.Parser.Production)">
  3191. <summary>Called when entering a parse tree node.</summary>
  3192. <param name="node">the node being entered</param>
  3193. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3194. discovered errors</exception>
  3195. </member>
  3196. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitFormula(PerCederberg.Grammatica.Parser.Production)">
  3197. <summary>Called when exiting a parse tree node.</summary>
  3198. <param name="node">the node being exited</param>
  3199. <returns>the node to add to the parse tree, or
  3200. null if no parse tree should be created</returns>
  3201. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3202. discovered errors</exception>
  3203. </member>
  3204. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ChildFormula(PerCederberg.Grammatica.Parser.Production,PerCederberg.Grammatica.Parser.Node)">
  3205. <summary>Called when adding a child to a parse tree
  3206. node.</summary>
  3207. <param name="node">the parent node</param>
  3208. <param name="child">the child node, or null</param>
  3209. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3210. discovered errors</exception>
  3211. </member>
  3212. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterComparisonOp(PerCederberg.Grammatica.Parser.Production)">
  3213. <summary>Called when entering a parse tree node.</summary>
  3214. <param name="node">the node being entered</param>
  3215. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3216. discovered errors</exception>
  3217. </member>
  3218. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitComparisonOp(PerCederberg.Grammatica.Parser.Production)">
  3219. <summary>Called when exiting a parse tree node.</summary>
  3220. <param name="node">the node being exited</param>
  3221. <returns>the node to add to the parse tree, or
  3222. null if no parse tree should be created</returns>
  3223. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3224. discovered errors</exception>
  3225. </member>
  3226. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ChildComparisonOp(PerCederberg.Grammatica.Parser.Production,PerCederberg.Grammatica.Parser.Node)">
  3227. <summary>Called when adding a child to a parse tree
  3228. node.</summary>
  3229. <param name="node">the parent node</param>
  3230. <param name="child">the child node, or null</param>
  3231. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3232. discovered errors</exception>
  3233. </member>
  3234. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterComparisonTerm(PerCederberg.Grammatica.Parser.Production)">
  3235. <summary>Called when entering a parse tree node.</summary>
  3236. <param name="node">the node being entered</param>
  3237. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3238. discovered errors</exception>
  3239. </member>
  3240. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitComparisonTerm(PerCederberg.Grammatica.Parser.Production)">
  3241. <summary>Called when exiting a parse tree node.</summary>
  3242. <param name="node">the node being exited</param>
  3243. <returns>the node to add to the parse tree, or
  3244. null if no parse tree should be created</returns>
  3245. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3246. discovered errors</exception>
  3247. </member>
  3248. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ChildComparisonTerm(PerCederberg.Grammatica.Parser.Production,PerCederberg.Grammatica.Parser.Node)">
  3249. <summary>Called when adding a child to a parse tree
  3250. node.</summary>
  3251. <param name="node">the parent node</param>
  3252. <param name="child">the child node, or null</param>
  3253. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3254. discovered errors</exception>
  3255. </member>
  3256. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterConcatOp(PerCederberg.Grammatica.Parser.Production)">
  3257. <summary>Called when entering a parse tree node.</summary>
  3258. <param name="node">the node being entered</param>
  3259. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3260. discovered errors</exception>
  3261. </member>
  3262. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitConcatOp(PerCederberg.Grammatica.Parser.Production)">
  3263. <summary>Called when exiting a parse tree node.</summary>
  3264. <param name="node">the node being exited</param>
  3265. <returns>the node to add to the parse tree, or
  3266. null if no parse tree should be created</returns>
  3267. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3268. discovered errors</exception>
  3269. </member>
  3270. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ChildConcatOp(PerCederberg.Grammatica.Parser.Production,PerCederberg.Grammatica.Parser.Node)">
  3271. <summary>Called when adding a child to a parse tree
  3272. node.</summary>
  3273. <param name="node">the parent node</param>
  3274. <param name="child">the child node, or null</param>
  3275. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3276. discovered errors</exception>
  3277. </member>
  3278. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterConcatTerm(PerCederberg.Grammatica.Parser.Production)">
  3279. <summary>Called when entering a parse tree node.</summary>
  3280. <param name="node">the node being entered</param>
  3281. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3282. discovered errors</exception>
  3283. </member>
  3284. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitConcatTerm(PerCederberg.Grammatica.Parser.Production)">
  3285. <summary>Called when exiting a parse tree node.</summary>
  3286. <param name="node">the node being exited</param>
  3287. <returns>the node to add to the parse tree, or
  3288. null if no parse tree should be created</returns>
  3289. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3290. discovered errors</exception>
  3291. </member>
  3292. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ChildConcatTerm(PerCederberg.Grammatica.Parser.Production,PerCederberg.Grammatica.Parser.Node)">
  3293. <summary>Called when adding a child to a parse tree
  3294. node.</summary>
  3295. <param name="node">the parent node</param>
  3296. <param name="child">the child node, or null</param>
  3297. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3298. discovered errors</exception>
  3299. </member>
  3300. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterAdditiveOp(PerCederberg.Grammatica.Parser.Production)">
  3301. <summary>Called when entering a parse tree node.</summary>
  3302. <param name="node">the node being entered</param>
  3303. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3304. discovered errors</exception>
  3305. </member>
  3306. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitAdditiveOp(PerCederberg.Grammatica.Parser.Production)">
  3307. <summary>Called when exiting a parse tree node.</summary>
  3308. <param name="node">the node being exited</param>
  3309. <returns>the node to add to the parse tree, or
  3310. null if no parse tree should be created</returns>
  3311. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3312. discovered errors</exception>
  3313. </member>
  3314. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ChildAdditiveOp(PerCederberg.Grammatica.Parser.Production,PerCederberg.Grammatica.Parser.Node)">
  3315. <summary>Called when adding a child to a parse tree
  3316. node.</summary>
  3317. <param name="node">the parent node</param>
  3318. <param name="child">the child node, or null</param>
  3319. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3320. discovered errors</exception>
  3321. </member>
  3322. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterAdditiveTerm(PerCederberg.Grammatica.Parser.Production)">
  3323. <summary>Called when entering a parse tree node.</summary>
  3324. <param name="node">the node being entered</param>
  3325. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3326. discovered errors</exception>
  3327. </member>
  3328. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitAdditiveTerm(PerCederberg.Grammatica.Parser.Production)">
  3329. <summary>Called when exiting a parse tree node.</summary>
  3330. <param name="node">the node being exited</param>
  3331. <returns>the node to add to the parse tree, or
  3332. null if no parse tree should be created</returns>
  3333. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3334. discovered errors</exception>
  3335. </member>
  3336. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ChildAdditiveTerm(PerCederberg.Grammatica.Parser.Production,PerCederberg.Grammatica.Parser.Node)">
  3337. <summary>Called when adding a child to a parse tree
  3338. node.</summary>
  3339. <param name="node">the parent node</param>
  3340. <param name="child">the child node, or null</param>
  3341. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3342. discovered errors</exception>
  3343. </member>
  3344. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterMultOp(PerCederberg.Grammatica.Parser.Production)">
  3345. <summary>Called when entering a parse tree node.</summary>
  3346. <param name="node">the node being entered</param>
  3347. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3348. discovered errors</exception>
  3349. </member>
  3350. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitMultOp(PerCederberg.Grammatica.Parser.Production)">
  3351. <summary>Called when exiting a parse tree node.</summary>
  3352. <param name="node">the node being exited</param>
  3353. <returns>the node to add to the parse tree, or
  3354. null if no parse tree should be created</returns>
  3355. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3356. discovered errors</exception>
  3357. </member>
  3358. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ChildMultOp(PerCederberg.Grammatica.Parser.Production,PerCederberg.Grammatica.Parser.Node)">
  3359. <summary>Called when adding a child to a parse tree
  3360. node.</summary>
  3361. <param name="node">the parent node</param>
  3362. <param name="child">the child node, or null</param>
  3363. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3364. discovered errors</exception>
  3365. </member>
  3366. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterMultTerm(PerCederberg.Grammatica.Parser.Production)">
  3367. <summary>Called when entering a parse tree node.</summary>
  3368. <param name="node">the node being entered</param>
  3369. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3370. discovered errors</exception>
  3371. </member>
  3372. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitMultTerm(PerCederberg.Grammatica.Parser.Production)">
  3373. <summary>Called when exiting a parse tree node.</summary>
  3374. <param name="node">the node being exited</param>
  3375. <returns>the node to add to the parse tree, or
  3376. null if no parse tree should be created</returns>
  3377. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3378. discovered errors</exception>
  3379. </member>
  3380. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ChildMultTerm(PerCederberg.Grammatica.Parser.Production,PerCederberg.Grammatica.Parser.Node)">
  3381. <summary>Called when adding a child to a parse tree
  3382. node.</summary>
  3383. <param name="node">the parent node</param>
  3384. <param name="child">the child node, or null</param>
  3385. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3386. discovered errors</exception>
  3387. </member>
  3388. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterExponOp(PerCederberg.Grammatica.Parser.Production)">
  3389. <summary>Called when entering a parse tree node.</summary>
  3390. <param name="node">the node being entered</param>
  3391. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3392. discovered errors</exception>
  3393. </member>
  3394. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitExponOp(PerCederberg.Grammatica.Parser.Production)">
  3395. <summary>Called when exiting a parse tree node.</summary>
  3396. <param name="node">the node being exited</param>
  3397. <returns>the node to add to the parse tree, or
  3398. null if no parse tree should be created</returns>
  3399. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3400. discovered errors</exception>
  3401. </member>
  3402. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ChildExponOp(PerCederberg.Grammatica.Parser.Production,PerCederberg.Grammatica.Parser.Node)">
  3403. <summary>Called when adding a child to a parse tree
  3404. node.</summary>
  3405. <param name="node">the parent node</param>
  3406. <param name="child">the child node, or null</param>
  3407. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3408. discovered errors</exception>
  3409. </member>
  3410. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterPostfixOp(PerCederberg.Grammatica.Parser.Production)">
  3411. <summary>Called when entering a parse tree node.</summary>
  3412. <param name="node">the node being entered</param>
  3413. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3414. discovered errors</exception>
  3415. </member>
  3416. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitPostfixOp(PerCederberg.Grammatica.Parser.Production)">
  3417. <summary>Called when exiting a parse tree node.</summary>
  3418. <param name="node">the node being exited</param>
  3419. <returns>the node to add to the parse tree, or
  3420. null if no parse tree should be created</returns>
  3421. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3422. discovered errors</exception>
  3423. </member>
  3424. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ChildPostfixOp(PerCederberg.Grammatica.Parser.Production,PerCederberg.Grammatica.Parser.Node)">
  3425. <summary>Called when adding a child to a parse tree
  3426. node.</summary>
  3427. <param name="node">the parent node</param>
  3428. <param name="child">the child node, or null</param>
  3429. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3430. discovered errors</exception>
  3431. </member>
  3432. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterExponTerm(PerCederberg.Grammatica.Parser.Production)">
  3433. <summary>Called when entering a parse tree node.</summary>
  3434. <param name="node">the node being entered</param>
  3435. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3436. discovered errors</exception>
  3437. </member>
  3438. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitExponTerm(PerCederberg.Grammatica.Parser.Production)">
  3439. <summary>Called when exiting a parse tree node.</summary>
  3440. <param name="node">the node being exited</param>
  3441. <returns>the node to add to the parse tree, or
  3442. null if no parse tree should be created</returns>
  3443. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3444. discovered errors</exception>
  3445. </member>
  3446. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ChildExponTerm(PerCederberg.Grammatica.Parser.Production,PerCederberg.Grammatica.Parser.Node)">
  3447. <summary>Called when adding a child to a parse tree
  3448. node.</summary>
  3449. <param name="node">the parent node</param>
  3450. <param name="child">the child node, or null</param>
  3451. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3452. discovered errors</exception>
  3453. </member>
  3454. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterPrefixOp(PerCederberg.Grammatica.Parser.Production)">
  3455. <summary>Called when entering a parse tree node.</summary>
  3456. <param name="node">the node being entered</param>
  3457. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3458. discovered errors</exception>
  3459. </member>
  3460. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitPrefixOp(PerCederberg.Grammatica.Parser.Production)">
  3461. <summary>Called when exiting a parse tree node.</summary>
  3462. <param name="node">the node being exited</param>
  3463. <returns>the node to add to the parse tree, or
  3464. null if no parse tree should be created</returns>
  3465. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3466. discovered errors</exception>
  3467. </member>
  3468. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ChildPrefixOp(PerCederberg.Grammatica.Parser.Production,PerCederberg.Grammatica.Parser.Node)">
  3469. <summary>Called when adding a child to a parse tree
  3470. node.</summary>
  3471. <param name="node">the parent node</param>
  3472. <param name="child">the child node, or null</param>
  3473. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3474. discovered errors</exception>
  3475. </member>
  3476. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterPostfixTerm(PerCederberg.Grammatica.Parser.Production)">
  3477. <summary>Called when entering a parse tree node.</summary>
  3478. <param name="node">the node being entered</param>
  3479. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3480. discovered errors</exception>
  3481. </member>
  3482. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitPostfixTerm(PerCederberg.Grammatica.Parser.Production)">
  3483. <summary>Called when exiting a parse tree node.</summary>
  3484. <param name="node">the node being exited</param>
  3485. <returns>the node to add to the parse tree, or
  3486. null if no parse tree should be created</returns>
  3487. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3488. discovered errors</exception>
  3489. </member>
  3490. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ChildPostfixTerm(PerCederberg.Grammatica.Parser.Production,PerCederberg.Grammatica.Parser.Node)">
  3491. <summary>Called when adding a child to a parse tree
  3492. node.</summary>
  3493. <param name="node">the parent node</param>
  3494. <param name="child">the child node, or null</param>
  3495. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3496. discovered errors</exception>
  3497. </member>
  3498. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterConstant(PerCederberg.Grammatica.Parser.Production)">
  3499. <summary>Called when entering a parse tree node.</summary>
  3500. <param name="node">the node being entered</param>
  3501. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3502. discovered errors</exception>
  3503. </member>
  3504. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitConstant(PerCederberg.Grammatica.Parser.Production)">
  3505. <summary>Called when exiting a parse tree node.</summary>
  3506. <param name="node">the node being exited</param>
  3507. <returns>the node to add to the parse tree, or
  3508. null if no parse tree should be created</returns>
  3509. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3510. discovered errors</exception>
  3511. </member>
  3512. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ChildConstant(PerCederberg.Grammatica.Parser.Production,PerCederberg.Grammatica.Parser.Node)">
  3513. <summary>Called when adding a child to a parse tree
  3514. node.</summary>
  3515. <param name="node">the parent node</param>
  3516. <param name="child">the child node, or null</param>
  3517. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3518. discovered errors</exception>
  3519. </member>
  3520. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterTerm(PerCederberg.Grammatica.Parser.Production)">
  3521. <summary>Called when entering a parse tree node.</summary>
  3522. <param name="node">the node being entered</param>
  3523. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3524. discovered errors</exception>
  3525. </member>
  3526. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitTerm(PerCederberg.Grammatica.Parser.Production)">
  3527. <summary>Called when exiting a parse tree node.</summary>
  3528. <param name="node">the node being exited</param>
  3529. <returns>the node to add to the parse tree, or
  3530. null if no parse tree should be created</returns>
  3531. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3532. discovered errors</exception>
  3533. </member>
  3534. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ChildTerm(PerCederberg.Grammatica.Parser.Production,PerCederberg.Grammatica.Parser.Node)">
  3535. <summary>Called when adding a child to a parse tree
  3536. node.</summary>
  3537. <param name="node">the parent node</param>
  3538. <param name="child">the child node, or null</param>
  3539. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3540. discovered errors</exception>
  3541. </member>
  3542. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterRange(PerCederberg.Grammatica.Parser.Production)">
  3543. <summary>Called when entering a parse tree node.</summary>
  3544. <param name="node">the node being entered</param>
  3545. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3546. discovered errors</exception>
  3547. </member>
  3548. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitRange(PerCederberg.Grammatica.Parser.Production)">
  3549. <summary>Called when exiting a parse tree node.</summary>
  3550. <param name="node">the node being exited</param>
  3551. <returns>the node to add to the parse tree, or
  3552. null if no parse tree should be created</returns>
  3553. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3554. discovered errors</exception>
  3555. </member>
  3556. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ChildRange(PerCederberg.Grammatica.Parser.Production,PerCederberg.Grammatica.Parser.Node)">
  3557. <summary>Called when adding a child to a parse tree
  3558. node.</summary>
  3559. <param name="node">the parent node</param>
  3560. <param name="child">the child node, or null</param>
  3561. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3562. discovered errors</exception>
  3563. </member>
  3564. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterFuncId(PerCederberg.Grammatica.Parser.Production)">
  3565. <summary>Called when entering a parse tree node.</summary>
  3566. <param name="node">the node being entered</param>
  3567. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3568. discovered errors</exception>
  3569. </member>
  3570. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitFuncId(PerCederberg.Grammatica.Parser.Production)">
  3571. <summary>Called when exiting a parse tree node.</summary>
  3572. <param name="node">the node being exited</param>
  3573. <returns>the node to add to the parse tree, or
  3574. null if no parse tree should be created</returns>
  3575. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3576. discovered errors</exception>
  3577. </member>
  3578. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ChildFuncId(PerCederberg.Grammatica.Parser.Production,PerCederberg.Grammatica.Parser.Node)">
  3579. <summary>Called when adding a child to a parse tree
  3580. node.</summary>
  3581. <param name="node">the parent node</param>
  3582. <param name="child">the child node, or null</param>
  3583. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3584. discovered errors</exception>
  3585. </member>
  3586. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterFuncArgs(PerCederberg.Grammatica.Parser.Production)">
  3587. <summary>Called when entering a parse tree node.</summary>
  3588. <param name="node">the node being entered</param>
  3589. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3590. discovered errors</exception>
  3591. </member>
  3592. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitFuncArgs(PerCederberg.Grammatica.Parser.Production)">
  3593. <summary>Called when exiting a parse tree node.</summary>
  3594. <param name="node">the node being exited</param>
  3595. <returns>the node to add to the parse tree, or
  3596. null if no parse tree should be created</returns>
  3597. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3598. discovered errors</exception>
  3599. </member>
  3600. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ChildFuncArgs(PerCederberg.Grammatica.Parser.Production,PerCederberg.Grammatica.Parser.Node)">
  3601. <summary>Called when adding a child to a parse tree
  3602. node.</summary>
  3603. <param name="node">the parent node</param>
  3604. <param name="child">the child node, or null</param>
  3605. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3606. discovered errors</exception>
  3607. </member>
  3608. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterFuncArg(PerCederberg.Grammatica.Parser.Production)">
  3609. <summary>Called when entering a parse tree node.</summary>
  3610. <param name="node">the node being entered</param>
  3611. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3612. discovered errors</exception>
  3613. </member>
  3614. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitFuncArg(PerCederberg.Grammatica.Parser.Production)">
  3615. <summary>Called when exiting a parse tree node.</summary>
  3616. <param name="node">the node being exited</param>
  3617. <returns>the node to add to the parse tree, or
  3618. null if no parse tree should be created</returns>
  3619. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3620. discovered errors</exception>
  3621. </member>
  3622. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ChildFuncArg(PerCederberg.Grammatica.Parser.Production,PerCederberg.Grammatica.Parser.Node)">
  3623. <summary>Called when adding a child to a parse tree
  3624. node.</summary>
  3625. <param name="node">the parent node</param>
  3626. <param name="child">the child node, or null</param>
  3627. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3628. discovered errors</exception>
  3629. </member>
  3630. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.EnterFunction(PerCederberg.Grammatica.Parser.Production)">
  3631. <summary>Called when entering a parse tree node.</summary>
  3632. <param name="node">the node being entered</param>
  3633. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3634. discovered errors</exception>
  3635. </member>
  3636. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ExitFunction(PerCederberg.Grammatica.Parser.Production)">
  3637. <summary>Called when exiting a parse tree node.</summary>
  3638. <param name="node">the node being exited</param>
  3639. <returns>the node to add to the parse tree, or
  3640. null if no parse tree should be created</returns>
  3641. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3642. discovered errors</exception>
  3643. </member>
  3644. <member name="M:Infragistics.Win.CalcEngine.UCparserAnalyzer.ChildFunction(PerCederberg.Grammatica.Parser.Production,PerCederberg.Grammatica.Parser.Node)">
  3645. <summary>Called when adding a child to a parse tree
  3646. node.</summary>
  3647. <param name="node">the parent node</param>
  3648. <param name="child">the child node, or null</param>
  3649. <exception cref="T:PerCederberg.Grammatica.Parser.ParseException">if the node analysis
  3650. discovered errors</exception>
  3651. </member>
  3652. <member name="T:Infragistics.Win.CalcEngine.UCparserConstants">
  3653. <remarks>An enumeration with token and production node
  3654. constants.</remarks>
  3655. </member>
  3656. <member name="T:Infragistics.Win.CalcEngine.UCparserParser">
  3657. <remarks>A token stream parser.</remarks>
  3658. </member>
  3659. <member name="M:Infragistics.Win.CalcEngine.UCparserParser.#ctor(System.IO.TextReader)">
  3660. <summary>Creates a new parser.</summary>
  3661. <param name="input">the input stream to read from</param>
  3662. <exception cref="T:PerCederberg.Grammatica.Parser.ParserCreationException">if the parser
  3663. couldn't be initialized correctly</exception>
  3664. </member>
  3665. <member name="M:Infragistics.Win.CalcEngine.UCparserParser.#ctor(System.IO.TextReader,PerCederberg.Grammatica.Parser.Analyzer)">
  3666. <summary>Creates a new parser.</summary>
  3667. <param name="input">the input stream to read from</param>
  3668. <param name="analyzer">the analyzer to parse with</param>
  3669. <exception cref="T:PerCederberg.Grammatica.Parser.ParserCreationException">if the parser
  3670. couldn't be initialized correctly</exception>
  3671. </member>
  3672. <member name="M:Infragistics.Win.CalcEngine.UCparserParser.CreatePatterns">
  3673. <summary>Initializes the parser by creating all the production
  3674. patterns.</summary>
  3675. <exception cref="T:PerCederberg.Grammatica.Parser.ParserCreationException">if the parser
  3676. couldn't be initialized correctly</exception>
  3677. </member>
  3678. <member name="T:Infragistics.Win.CalcEngine.UCparserParser.SynteticPatterns">
  3679. <summary>An enumeration with the generated production node
  3680. identity constants.</summary>
  3681. </member>
  3682. <member name="T:Infragistics.Win.CalcEngine.UCparserTokenizer">
  3683. <remarks>A character stream tokenizer.</remarks>
  3684. </member>
  3685. <member name="M:Infragistics.Win.CalcEngine.UCparserTokenizer.#ctor(System.IO.TextReader)">
  3686. <summary>Creates a new tokenizer for the specified input
  3687. stream.</summary>
  3688. <param name="input">the input stream to read</param>
  3689. <exception cref="T:PerCederberg.Grammatica.Parser.ParserCreationException">if the tokenizer
  3690. couldn't be initialized correctly</exception>
  3691. </member>
  3692. <member name="M:Infragistics.Win.CalcEngine.UCparserTokenizer.CreatePatterns">
  3693. <summary>Initializes the tokenizer by creating all the token
  3694. patterns.</summary>
  3695. <exception cref="T:PerCederberg.Grammatica.Parser.ParserCreationException">if the tokenizer
  3696. couldn't be initialized correctly</exception>
  3697. </member>
  3698. <member name="T:Infragistics.Win.CalcEngine.ReferenceActionCode">
  3699. <summary>
  3700. Identifies formula token types in the <b>UltraCalcFormulaToken</b> class
  3701. </summary>
  3702. </member>
  3703. <member name="M:Infragistics.Win.CalcEngine.UCRecalcChain.CopyTo(System.Array,System.Int32)">
  3704. <summary>
  3705. Copys the collection to an array.
  3706. </summary>
  3707. <param name="array">Array used for the desitnation of the copy.</param>
  3708. <param name="index">The zero-based index in array at which copying begins.</param>
  3709. </member>
  3710. <member name="M:Infragistics.Win.CalcEngine.UCRecalcChain.GetEnumerator">
  3711. <summary>
  3712. Returns the collection enumerator.
  3713. </summary>
  3714. <returns>Collection enumerator.</returns>
  3715. </member>
  3716. <member name="P:Infragistics.Win.CalcEngine.UCRecalcChain.IsSynchronized">
  3717. <summary>
  3718. Denotes whether the collection is thread-safe.
  3719. </summary>
  3720. </member>
  3721. <member name="P:Infragistics.Win.CalcEngine.UCRecalcChain.Count">
  3722. <summary>
  3723. Returns a number of elements in the collection.
  3724. </summary>
  3725. </member>
  3726. <member name="P:Infragistics.Win.CalcEngine.UCRecalcChain.SyncRoot">
  3727. <summary>
  3728. Returns an object that can be used to synchronize access to the collection.
  3729. </summary>
  3730. </member>
  3731. <member name="M:Infragistics.Win.CalcEngine.UltraCalcAncestorMap.AddAncestor(Infragistics.Win.CalcEngine.UCReference,Infragistics.Win.CalcEngine.IUltraCalcReference)">
  3732. <summary>
  3733. Add a formula refernce the given predecessor reference
  3734. </summary>
  3735. <param name="predecessor"><b>UCReference</b> predecessor reference</param>
  3736. <param name="ancestor"><b>IUltraCalcReference</b> of formula that contains the given predecessor</param>
  3737. </member>
  3738. <member name="M:Infragistics.Win.CalcEngine.UltraCalcAncestorMap.Find(Infragistics.Win.CalcEngine.IUltraCalcReference)">
  3739. <summary>
  3740. Return the position of the given predecessor in the collection
  3741. </summary>
  3742. <param name="predecessor"></param>
  3743. <returns></returns>
  3744. </member>
  3745. <member name="M:Infragistics.Win.CalcEngine.UltraCalcAncestorMap.DeleteAncestor(Infragistics.Win.CalcEngine.IUltraCalcReference,Infragistics.Win.CalcEngine.IUltraCalcReference)">
  3746. <summary>
  3747. Remove the given formula ancestor from the given predecessor's list of formulas.
  3748. </summary>
  3749. <param name="formulaPredecessor"><b>IUltraCalcReference</b> that's referenced by given ancestor's formula</param>
  3750. <param name="ancestor">Formula refernce to remove for given predecessor's list of formulas</param>
  3751. </member>
  3752. <member name="M:Infragistics.Win.CalcEngine.UltraCalcAncestorMap.DeleteAncestorAt(System.Int32,System.Int32,System.Boolean)">
  3753. <summary>
  3754. Remove the given formula ancestor from the given predecessor's list of formulas.
  3755. </summary>
  3756. <param name="posPredecessor">Position of the predecessor in the ancestor list</param>
  3757. <param name="posAncestor">Position of the ancestor in the predecessor's Ancestors list</param>
  3758. <param name="replacePredecessorInMapEntry">Indicates whether to update the predecessor reference in the ancestor map</param>
  3759. </member>
  3760. <member name="M:Infragistics.Win.CalcEngine.UltraCalcAncestorMap.Ancestors(Infragistics.Win.CalcEngine.IUltraCalcReference)">
  3761. <summary>
  3762. Return the collection of ancestors of the given predecessor
  3763. </summary>
  3764. <param name="predecessor">Reference whose collection of formulas to return</param>
  3765. <returns>Collection of references whose formulas reference the given predecessor</returns>
  3766. </member>
  3767. <member name="M:Infragistics.Win.CalcEngine.UltraCalcAncestorMap.IndexOf(Infragistics.Win.CalcEngine.IUltraCalcReference)">
  3768. <summary>
  3769. Return the index of the given predecessor
  3770. </summary>
  3771. <param name="predecessor">Reference whose index is to be returned</param>
  3772. <returns>Index of given predecessor, or -1 if its not found</returns>
  3773. </member>
  3774. <member name="M:Infragistics.Win.CalcEngine.UltraCalcAncestorMap.CopyTo(System.Array,System.Int32)">
  3775. <summary>
  3776. Copys the collection to an array.
  3777. </summary>
  3778. <param name="array">Array used for the desitnation of the copy.</param>
  3779. <param name="index">The zero-based index in array at which copying begins.</param>
  3780. </member>
  3781. <member name="M:Infragistics.Win.CalcEngine.UltraCalcAncestorMap.GetEnumerator">
  3782. <summary>
  3783. Returns the collection enumerator.
  3784. </summary>
  3785. <returns>Collection enumerator.</returns>
  3786. </member>
  3787. <member name="P:Infragistics.Win.CalcEngine.UltraCalcAncestorMap.IsSynchronized">
  3788. <summary>
  3789. Denotes whether the collection is thread-safe.
  3790. </summary>
  3791. </member>
  3792. <member name="P:Infragistics.Win.CalcEngine.UltraCalcAncestorMap.Count">
  3793. <summary>
  3794. Returns a number of elements in the collection.
  3795. </summary>
  3796. </member>
  3797. <member name="P:Infragistics.Win.CalcEngine.UltraCalcAncestorMap.SyncRoot">
  3798. <summary>
  3799. Returns an object that can be used to synchronize access to the collection.
  3800. </summary>
  3801. </member>
  3802. <member name="T:Infragistics.Win.CalcEngine.UltraCalcAncestorMap.AncestorMapEntry">
  3803. <summary>
  3804. Provides methods and properties to manage a list of formulas that reference a given reference
  3805. </summary>
  3806. </member>
  3807. <member name="M:Infragistics.Win.CalcEngine.UltraCalcAncestorMap.AncestorMapEntry.#ctor">
  3808. <summary>
  3809. Default constructor
  3810. </summary>
  3811. </member>
  3812. <member name="M:Infragistics.Win.CalcEngine.UltraCalcAncestorMap.AncestorMapEntry.#ctor(Infragistics.Win.CalcEngine.UCReference)">
  3813. <summary>
  3814. Predecessor constructor
  3815. </summary>
  3816. <param name="predecessor">predecessor for this instance</param>
  3817. </member>
  3818. <member name="M:Infragistics.Win.CalcEngine.UltraCalcAncestorMap.AncestorMapEntry.Equals(System.Object)">
  3819. <summary>
  3820. Equality method that returns whether an object is equal to this one
  3821. </summary>
  3822. <param name="obj">Object to compare to this entry</param>
  3823. <returns>True if object is equal to this instance, else false</returns>
  3824. </member>
  3825. <member name="M:Infragistics.Win.CalcEngine.UltraCalcAncestorMap.AncestorMapEntry.GetHashCode">
  3826. <summary>
  3827. Return hashcode for this object
  3828. </summary>
  3829. <returns>Integer hash code for this object</returns>
  3830. </member>
  3831. <member name="F:Infragistics.Win.CalcEngine.UltraCalcAncestorMap.AncestorMapEntry.formulaPredecessor">
  3832. <summary>
  3833. Storage for predecessor
  3834. </summary>
  3835. </member>
  3836. <member name="F:Infragistics.Win.CalcEngine.UltraCalcAncestorMap.AncestorMapEntry.formulaAncestors">
  3837. <summary>
  3838. Storage for ancestor collection
  3839. </summary>
  3840. </member>
  3841. <member name="P:Infragistics.Win.CalcEngine.UltraCalcAncestorMap.AncestorMapEntry.Predecessor">
  3842. <summary>
  3843. Get/Set the predecessor for this entry
  3844. </summary>
  3845. </member>
  3846. <member name="P:Infragistics.Win.CalcEngine.UltraCalcAncestorMap.AncestorMapEntry.Ancestors">
  3847. <summary>
  3848. Get/Set the ancestor collection for this entry
  3849. </summary>
  3850. </member>
  3851. <member name="T:Infragistics.Win.CalcEngine.FormulaReference">
  3852. <summary>
  3853. IUltraCalcReference implementation for caching the Formula of the underlying reference.
  3854. </summary>
  3855. </member>
  3856. <member name="M:Infragistics.Win.CalcEngine.UltraCalcEngine.#ctor">
  3857. <summary>
  3858. Initializes a new <see cref="T:Infragistics.Win.CalcEngine.UltraCalcEngine"/>
  3859. </summary>
  3860. </member>
  3861. <member name="M:Infragistics.Win.CalcEngine.UltraCalcEngine.OnRecalcValue(Infragistics.Win.CalcEngine.UltraCalcReferenceEventArgs)">
  3862. <summary>
  3863. Used to invoke the <see cref="E:Infragistics.Win.CalcEngine.UltraCalcEngine.RecalcValue"/> event
  3864. </summary>
  3865. <param name="e">Event args</param>
  3866. </member>
  3867. <member name="M:Infragistics.Win.CalcEngine.UltraCalcEngine.OnCircularity(Infragistics.Win.CalcEngine.UltraCalcReferenceEventArgs)">
  3868. <summary>
  3869. Used to invoke the <see cref="E:Infragistics.Win.CalcEngine.UltraCalcEngine.Circularity"/> event
  3870. </summary>
  3871. <param name="e">Event args</param>
  3872. </member>
  3873. <member name="M:Infragistics.Win.CalcEngine.UltraCalcEngine.OnDirtyValue(Infragistics.Win.CalcEngine.UltraCalcReferenceEventArgs)">
  3874. <summary>
  3875. Used to invoke the <see cref="E:Infragistics.Win.CalcEngine.UltraCalcEngine.DirtyValue"/> event
  3876. </summary>
  3877. <param name="e">Event args</param>
  3878. </member>
  3879. <member name="M:Infragistics.Win.CalcEngine.UltraCalcEngine.AddFunctionLibrary(System.String)">
  3880. <summary>
  3881. Registers an assembly containing <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunction"/> derived types.
  3882. </summary>
  3883. <param name="assemblyPath">File path to the assembly</param>
  3884. <returns>Returns true if the assembly was registered successfully, else false if the registration failed</returns>
  3885. <remarks>
  3886. <p class="body">
  3887. All types within the registered assembly are enumerated and any that derive from <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunction"/> class are added to the list of available formula functions
  3888. </p>
  3889. </remarks>
  3890. <seealso cref="M:Infragistics.Win.CalcEngine.UltraCalcEngine.AddFunction(Infragistics.Win.CalcEngine.UltraCalcFunction)"/>
  3891. </member>
  3892. <member name="M:Infragistics.Win.CalcEngine.UltraCalcEngine.AddFunctionLibrary(System.Reflection.Assembly)">
  3893. <summary>
  3894. Registers an assembly containing <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunction"/> derived types.
  3895. </summary>
  3896. <param name="assembly">Loaded assembly to register</param>
  3897. <returns>Returns true if the assembly was registered successfully, else false if the registration failed</returns>
  3898. <remarks>
  3899. <p class="body">
  3900. All types within the registered assembly are enumerated and any that derive from <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunction"/> class are added to the list of available formula functions
  3901. </p>
  3902. </remarks>
  3903. <seealso cref="M:Infragistics.Win.CalcEngine.UltraCalcEngine.AddFunction(Infragistics.Win.CalcEngine.UltraCalcFunction)"/>
  3904. </member>
  3905. <member name="M:Infragistics.Win.CalcEngine.UltraCalcEngine.AddFunction(Infragistics.Win.CalcEngine.UltraCalcFunction)">
  3906. <summary>
  3907. Registers a single <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunction"/>
  3908. </summary>
  3909. <param name="function">User defined function instance to register</param>
  3910. <returns>Returns true if the type was registered successfully, else false if the registration failed</returns>
  3911. <remarks>
  3912. <p class="body">
  3913. Users can build custom functions used in formulas by sub-classing the <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunction"/> class.
  3914. Once the derived class is instaniated it must be registered by using the <b>AddFunction</b> method before being avilable and referenced by a formulas.
  3915. Users can build a library of functions packaged in an assembly and register all the functions within the assembly by using the <b>AddFunctionLibrary</b> method.
  3916. </p>
  3917. </remarks>
  3918. </member>
  3919. <member name="M:Infragistics.Win.CalcEngine.UltraCalcEngine.AddFormula(Infragistics.Win.CalcEngine.IUltraCalcFormula)">
  3920. <summary>
  3921. Adds a formula into the calculation network.
  3922. </summary>
  3923. <param name="formula">Formula instance containing compiled formula string to add into the calculation network</param>
  3924. <remarks>
  3925. <p class="body">
  3926. Formulas are entered into the calculation network by first compiling the formula string using the <b>Compile</b> method on the <b>UltraCalcFormula</b> class, then passing the <b>UltraCalcFormula</b> instance to the <b>AddFormula</b> method.
  3927. </p>
  3928. </remarks>
  3929. </member>
  3930. <member name="M:Infragistics.Win.CalcEngine.UltraCalcEngine.DeleteFormula(Infragistics.Win.CalcEngine.IUltraCalcFormula)">
  3931. <summary>
  3932. Deletes a formula from the calculation network
  3933. </summary>
  3934. <param name="formula">Formula instance to be removed</param>
  3935. <remarks>
  3936. <p class="body">
  3937. References to formulas that are deleted are recalculated.
  3938. </p>
  3939. </remarks>
  3940. <seealso cref="M:Infragistics.Win.CalcEngine.UltraCalcEngine.ProcessAddFormula(Infragistics.Win.CalcEngine.IUltraCalcFormula,Infragistics.Win.CalcEngine.IUltraCalcReference)"/>
  3941. <seealso cref="T:Infragistics.Win.CalcEngine.UltraCalcFormulaBase"/>
  3942. </member>
  3943. <member name="M:Infragistics.Win.CalcEngine.UltraCalcEngine.Recalc(System.Int64)">
  3944. <summary>
  3945. Performs a time-based recalculation
  3946. </summary>
  3947. <param name="ticks">Denotes the number of 100-nanosecond intervals used to perform time-based partial recalculation cycles</param>
  3948. <returns>Returns true if there are still formulas to recalculate or false if recalculation process is complete</returns>
  3949. <remarks>
  3950. <p class="body">
  3951. This method performs a partial recalculation cycle, yielding after the given number of ticks has expired. This method should be repeately
  3952. called until it returns false denoting all dirty formulas have been recalculated.
  3953. <p></p>
  3954. <seealso cref="M:Infragistics.Win.CalcEngine.UltraCalcEngine.Recalc(System.Int64)"/>
  3955. </p>
  3956. </remarks>
  3957. </member>
  3958. <member name="M:Infragistics.Win.CalcEngine.UltraCalcEngine.Recalc">
  3959. <summary>
  3960. Performs a synchronous recalculation
  3961. </summary>
  3962. <returns>Returns true if the reference is dirty, else false</returns>
  3963. <p></p>
  3964. <seealso cref="M:Infragistics.Win.CalcEngine.UltraCalcEngine.Recalc(System.Int64)"/>
  3965. <remarks>
  3966. <p class="body">
  3967. This method recalculates all dirty formulas before returning.
  3968. </p>
  3969. </remarks>
  3970. </member>
  3971. <member name="M:Infragistics.Win.CalcEngine.UltraCalcEngine.IsDirty(Infragistics.Win.CalcEngine.IUltraCalcReference,System.Boolean)">
  3972. <summary>
  3973. Checks to see if a reference is dirty, and optionally waits for it to be recalculated
  3974. </summary>
  3975. <param name="reference">Reference whose dirty state is requested</param>
  3976. <param name="wait">Denotes whether caller wants to wait until the reference is recalculated</param>
  3977. <returns>True if the reference is dirty</returns>
  3978. </member>
  3979. <member name="M:Infragistics.Win.CalcEngine.UltraCalcEngine.Dump">
  3980. <summary>
  3981. Outputs information about the current state of the calculation engine.
  3982. </summary>
  3983. </member>
  3984. <member name="M:Infragistics.Win.CalcEngine.UltraCalcEngine.AfterFormulaEvaluationCompleted(Infragistics.Win.CalcEngine.IUltraCalcReference,Infragistics.Win.CalcEngine.UltraCalcFormulaBase,Infragistics.Win.CalcEngine.UltraCalcValue)">
  3985. <summary>
  3986. Occurs after a single evaluation of a formula has completed.
  3987. </summary>
  3988. </member>
  3989. <member name="E:Infragistics.Win.CalcEngine.UltraCalcEngine.RecalcValue">
  3990. <summary>
  3991. Recalced value event
  3992. </summary>
  3993. </member>
  3994. <member name="E:Infragistics.Win.CalcEngine.UltraCalcEngine.Circularity">
  3995. <summary>
  3996. Circularity
  3997. </summary>
  3998. </member>
  3999. <member name="E:Infragistics.Win.CalcEngine.UltraCalcEngine.DirtyValue">
  4000. <summary>
  4001. Dirty value event
  4002. </summary>
  4003. </member>
  4004. <member name="P:Infragistics.Win.CalcEngine.UltraCalcEngine.EnableMarkedColumns">
  4005. <summary>
  4006. Returns or sets whether deferred calculations are enabled.
  4007. </summary>
  4008. </member>
  4009. <member name="P:Infragistics.Win.CalcEngine.UltraCalcEngine.FunctionFactory">
  4010. <summary>
  4011. Returns the formula function factory for this instance of the calc engine
  4012. </summary>
  4013. <remarks>
  4014. <p class="body">
  4015. Use the function factory to access detailed information about each function available to formulas compiled against this instance of the calc engine.
  4016. </p>
  4017. </remarks>
  4018. </member>
  4019. <member name="P:Infragistics.Win.CalcEngine.UltraCalcEngine.CircularReference">
  4020. <summary>
  4021. Gets or sets a reference within a circular reference cycle.
  4022. </summary>
  4023. </member>
  4024. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFormulaBase">
  4025. <summary>
  4026. Provides methods to compile and evaluate formulas.
  4027. </summary>
  4028. <remarks>
  4029. <p class="body">
  4030. </p>
  4031. </remarks>
  4032. </member>
  4033. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFormulaBase.Evaluate(Infragistics.Win.CalcEngine.IUltraCalcReference)">
  4034. <summary>
  4035. Evaluate the compiled expression against the given base reference
  4036. </summary>
  4037. <param name="reference">Base reference used to resolve relative references into absolute references</param>
  4038. <returns>Retuns an UltraCalcValue containing result of formula evaluation</returns>
  4039. </member>
  4040. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFormulaBase.HasSyntaxError">
  4041. <summary>
  4042. Returns true if the formula has a syntax error. Formulas with syntax errors can not be added to the calc-network.
  4043. </summary>
  4044. </member>
  4045. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFormulaBase.SyntaxError">
  4046. <summary>
  4047. Syntax error message. Returns null if the formula has no syntax errors, as would be indicated by <see cref="P:Infragistics.Win.CalcEngine.UltraCalcFormulaBase.HasSyntaxError"/> method.
  4048. </summary>
  4049. </member>
  4050. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFormulaBase.HasAlwaysDirty">
  4051. <summary>
  4052. Denotes whether the formula contains an always dirty function
  4053. </summary>
  4054. </member>
  4055. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFormulaBase.FormulaString">
  4056. <summary>
  4057. Returns the formula string
  4058. </summary>
  4059. </member>
  4060. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFormulaBase.BaseReference">
  4061. <summary>
  4062. Gets or sets the formula base reference
  4063. </summary>
  4064. <remarks>
  4065. <p class="body">
  4066. The base reference of a formula is sometimes referred to as the Left-Hand-Side (LHS)of an expression.
  4067. It represents the location within the grid, or other object, whose value is being computed by the given formula.
  4068. References within the formula expression my be fully qualified or relative to the formula's base reference.
  4069. For example, if we want to calculate a "[Total]" column in a grid we might have a formula such as "[Units] * [Price]". Each cells within the
  4070. "Total" column would be computed multiplying the "Units" cell and "Price" cell for row in the band.
  4071. </p>
  4072. </remarks>
  4073. </member>
  4074. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFormulaBase.Tokens">
  4075. <summary>
  4076. Returns a collection of formula tokens in pre-fix form, called Reverse Polish Notation.
  4077. </summary>
  4078. <returns>Formula token collection</returns>
  4079. <remarks>
  4080. <p class="body">
  4081. Compiling a formula converts the in-fix expression string into an intemediate post-fix form optimized for evaluation.
  4082. </p>
  4083. </remarks>
  4084. </member>
  4085. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFormulaBase.References">
  4086. <summary>
  4087. Retuns a collection of references contained in the formula token string
  4088. </summary>
  4089. <returns>Collection of IUltraCalcReferences</returns>
  4090. </member>
  4091. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFormula.#ctor(Infragistics.Win.CalcEngine.IUltraCalcReference,System.String)">
  4092. <summary>
  4093. Initializes and compiles a new <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFormula"/>
  4094. </summary>
  4095. <param name="formulaReference">Formula base reference</param>
  4096. <param name="formula">Formula string to be compiled</param>
  4097. </member>
  4098. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFormula.#ctor(Infragistics.Win.CalcEngine.IUltraCalcReference,System.String,Infragistics.Win.CalcEngine.UltraCalcFunctionFactory)">
  4099. <summary>
  4100. Initializes and compiles a new <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFormula"/>
  4101. </summary>
  4102. <param name="formulaReference">Formula base reference</param>
  4103. <param name="formula">Formula string to be compiled</param>
  4104. <param name="functionFactory">Class providing the functions</param>
  4105. </member>
  4106. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFormula.Compile(Infragistics.Win.CalcEngine.IUltraCalcReference,System.String)">
  4107. <summary>
  4108. Compile a formula string for the given base reference.
  4109. </summary>
  4110. <param name="formulaReference">Formula base reference</param>
  4111. <param name="formula">Expression string</param>
  4112. <returns>True if the formula is successfully compiled, else false</returns>
  4113. <remarks>
  4114. <p class="body">
  4115. Compiling a formula converts the in-fix expression string into an intemediate post-fix form optimized for evaluation.
  4116. If the formula compliation fails, the Error property contains the reason and location of the error.
  4117. Once formulas are compiled, they may be entered into the calculation network for a given UltraCalcManager instance by calling the <b>UlraCalcEngine.AddFormula</b> method.
  4118. </p>
  4119. </remarks>
  4120. </member>
  4121. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFormula.BaseReference">
  4122. <summary>
  4123. Gets or sets the formula base reference
  4124. </summary>
  4125. <remarks>
  4126. <p class="body">
  4127. The base reference of a formula is sometimes referred to as the Left-Hand-Side (LHS)of an expression.
  4128. It represents the location within the grid, or other object, whose value is being computed by the given formula.
  4129. References within the formula expression my be fully qualified or relative to the formula's base reference.
  4130. For example, if we want to calculate a "[Total]" column in a grid we might have a formula such as "[Units] * [Price]". Each cells within the
  4131. "Total" column would be computed multiplying the "Units" cell and "Price" cell for row in the band.
  4132. </p>
  4133. </remarks>
  4134. </member>
  4135. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFormula.FormulaString">
  4136. <summary>
  4137. Returns the formula string
  4138. </summary>
  4139. </member>
  4140. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFormula.HasSyntaxError">
  4141. <summary>
  4142. Returns true if the formula has a syntax error. Formulas with syntax errors can not be added to the calc-network.
  4143. </summary>
  4144. </member>
  4145. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFormula.SyntaxError">
  4146. <summary>
  4147. Syntax error message. Returns null if the formula has no syntax errors, as would be indicated by <see cref="P:Infragistics.Win.CalcEngine.UltraCalcFormula.HasSyntaxError"/> method.
  4148. </summary>
  4149. </member>
  4150. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFormula.Tokens">
  4151. <summary>
  4152. Returns a collection of formula tokens in pre-fix form, called Reverse Polish Notation.
  4153. </summary>
  4154. <returns>Formula token collection</returns>
  4155. <remarks>
  4156. <p class="body">
  4157. Compiling a formula converts the in-fix expression string into an intemediate post-fix form optimized for evaluation.
  4158. </p>
  4159. </remarks>
  4160. </member>
  4161. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFormulaReferenceCollection">
  4162. <summary>
  4163. Provides methods and properties that manage a collection of <b>IUltraCalcFormulaReference</b> objects.
  4164. </summary>
  4165. </member>
  4166. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFormulaReferenceCollection.#ctor">
  4167. <summary>
  4168. Default constructor.
  4169. </summary>
  4170. </member>
  4171. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFormulaReferenceCollection.#ctor(Infragistics.Win.CalcEngine.UltraCalcFormulaBase)">
  4172. <summary>
  4173. Constructor that accepts a collection of formula tokens used to access the references in a formula.
  4174. </summary>
  4175. <param name="formula">The formula which owns the collection.</param>
  4176. </member>
  4177. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFormulaReferenceCollection.Add(Infragistics.Win.CalcEngine.IUltraCalcReference)">
  4178. <summary>
  4179. Adds a reference to the collection.
  4180. </summary>
  4181. <param name="reference"><b>IUltraCalcReference</b> instance to add to collection.</param>
  4182. </member>
  4183. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFormulaReferenceCollection.CopyTo(System.Array,System.Int32)">
  4184. <summary>
  4185. Copys the collection to an array.
  4186. </summary>
  4187. <param name="array">Array used for the desitnation of the copy.</param>
  4188. <param name="index">The zero-based index in array at which copying begins.</param>
  4189. </member>
  4190. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFormulaReferenceCollection.GetEnumerator">
  4191. <summary>
  4192. Returns the collection enumerator.
  4193. </summary>
  4194. <returns>Collection enumerator.</returns>
  4195. </member>
  4196. <member name="F:Infragistics.Win.CalcEngine.UltraCalcFormulaReferenceCollection.tokenArray">
  4197. <summary>
  4198. Underlying collection object managing the token collection.
  4199. </summary>
  4200. </member>
  4201. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFormulaReferenceCollection.IsSynchronized">
  4202. <summary>
  4203. Denotes whether the collection is thread-safe.
  4204. </summary>
  4205. </member>
  4206. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFormulaReferenceCollection.Count">
  4207. <summary>
  4208. Returns a number of elements in the collection.
  4209. </summary>
  4210. </member>
  4211. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFormulaReferenceCollection.SyncRoot">
  4212. <summary>
  4213. Returns an object that can be used to synchronize access to the collection.
  4214. </summary>
  4215. </member>
  4216. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFormulaToken">
  4217. <summary>
  4218. Abstract base class from which all formula tokens must derive.
  4219. </summary>
  4220. </member>
  4221. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFormulaToken.#ctor(Infragistics.Win.CalcEngine.UltraCalcFormulaTokenType)">
  4222. <summary>
  4223. Default constructor
  4224. </summary>
  4225. </member>
  4226. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFormulaToken.Type">
  4227. <summary>
  4228. Return the token's type code
  4229. </summary>
  4230. <returns>The <b>UltraClacFormulaTokenType</b> for the this token</returns>
  4231. </member>
  4232. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionToken.ArgumentCount">
  4233. <summary>
  4234. Returns the number of arguments to the function.
  4235. </summary>
  4236. </member>
  4237. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionToken.Infragistics#Win#CalcEngine#IUltraCalcFunctionToken#FunctionName">
  4238. <summary>
  4239. The name of the UltraCalcFunction represented by the token.
  4240. </summary>
  4241. </member>
  4242. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionToken.Infragistics#Win#CalcEngine#IUltraCalcFunctionToken#FunctionOperator">
  4243. <summary>
  4244. Returns an UltraCalcOperatorFunction indicating the operator that the function reprsents or null of the function does not represent an operator.
  4245. </summary>
  4246. </member>
  4247. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFormulaTokenCollection">
  4248. <summary>
  4249. Provides method and properties to manage a collection of <b>UltraCalcFormulaTokens.</b>
  4250. </summary>
  4251. </member>
  4252. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFormulaTokenCollection.#ctor">
  4253. <summary>
  4254. Default constructor
  4255. </summary>
  4256. </member>
  4257. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFormulaTokenCollection.Add(Infragistics.Win.CalcEngine.UltraCalcFormulaToken)">
  4258. <summary>
  4259. Add a token to the collection.
  4260. </summary>
  4261. <param name="token">Token to add to collection.</param>
  4262. </member>
  4263. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFormulaTokenCollection.TrimToSize">
  4264. <summary>
  4265. Sets the capacity to the actual number of elements in the underlying ArrayList.
  4266. </summary>
  4267. </member>
  4268. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFormulaTokenCollection.ToArray">
  4269. <summary>
  4270. Copies the elements of the underlying ArrayList to a new array.
  4271. </summary>
  4272. <returns>Copy of collection.</returns>
  4273. </member>
  4274. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFormulaTokenCollection.CopyTo(System.Array,System.Int32)">
  4275. <summary>
  4276. Copies the collection to an array.
  4277. </summary>
  4278. <param name="array">Array that is the destination of the copy.</param>
  4279. <param name="index">Index into array to begin copying collection elements.</param>
  4280. </member>
  4281. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFormulaTokenCollection.GetEnumerator">
  4282. <summary>
  4283. Returns the collection enumerator
  4284. </summary>
  4285. <returns>Collection enumerator</returns>
  4286. </member>
  4287. <member name="F:Infragistics.Win.CalcEngine.UltraCalcFormulaTokenCollection.TokenArray">
  4288. <summary>
  4289. Underlying ArrayList used to manage token collection.
  4290. </summary>
  4291. </member>
  4292. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFormulaTokenCollection.IsSynchronized">
  4293. <summary>
  4294. Denotes whether the collection is thread-safe.
  4295. </summary>
  4296. </member>
  4297. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFormulaTokenCollection.Count">
  4298. <summary>
  4299. Returns the number of collection elements.
  4300. </summary>
  4301. </member>
  4302. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFormulaTokenCollection.SyncRoot">
  4303. <summary>
  4304. Returns an object that can be used to synchronize access to the collection.
  4305. </summary>
  4306. </member>
  4307. <member name="T:Infragistics.Win.CalcEngine.OneBasedArgumentNumberingAttribute">
  4308. <summary>
  4309. For Infragistics Internal use only.
  4310. </summary>
  4311. </member>
  4312. <member name="M:Infragistics.Win.CalcEngine.OneBasedArgumentNumberingAttribute.#ctor(System.Int32)">
  4313. <summary>
  4314. For Infragistics Internal use only.
  4315. </summary>
  4316. </member>
  4317. <member name="P:Infragistics.Win.CalcEngine.OneBasedArgumentNumberingAttribute.ArgumentIndex">
  4318. <summary>
  4319. For Infragistics Internal use only.
  4320. </summary>
  4321. </member>
  4322. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunction">
  4323. <summary>
  4324. Base class for formula functions.
  4325. </summary>
  4326. </member>
  4327. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunction.#ctor">
  4328. <summary>
  4329. Initializes a new <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunction"/>
  4330. </summary>
  4331. </member>
  4332. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunction.PerformEvaluation(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  4333. <summary>
  4334. Evaluates the function against the arguments on the number stack.
  4335. </summary>
  4336. <param name="numberStack">Formula number stack containing function arguments.</param>
  4337. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  4338. </member>
  4339. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunction.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  4340. <summary>
  4341. Evaluates the function against the arguments on the number stack.
  4342. </summary>
  4343. <param name="numberStack">Formula number stack containing function arguments.</param>
  4344. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  4345. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  4346. </member>
  4347. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunction.GetArguments(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32,System.Boolean)">
  4348. <summary>
  4349. A helper method for extracting the <see cref="T:Infragistics.Win.CalcEngine.UltraCalcValue"/> instances from the stack.
  4350. </summary>
  4351. <param name="numberStack">Number stack whose values should be popped.</param>
  4352. <param name="argumentCount">Number of items to pop/evaluate from the number stack</param>
  4353. <param name="skipEmptyValues">True to ignore values whose IsNull returns true; otherwise false to include empty items in the list.</param>
  4354. <returns>An array of UltraCalcValue instances removed from the number stack.</returns>
  4355. </member>
  4356. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunction.IsAlwaysDirty">
  4357. <summary>
  4358. Indicates whether the results of the function is always dirty.
  4359. </summary>
  4360. </member>
  4361. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunction.Name">
  4362. <summary>
  4363. Function name used to reference the function in a formula
  4364. </summary>
  4365. </member>
  4366. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunction.MinArgs">
  4367. <summary>
  4368. Minimum number of arguments required for the function
  4369. </summary>
  4370. </member>
  4371. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunction.MaxArgs">
  4372. <summary>
  4373. Maximum number of arguments required for the function
  4374. </summary>
  4375. </member>
  4376. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunction.Description">
  4377. <summary>
  4378. Summary description for the function displayed by the formula builder tool
  4379. </summary>
  4380. </member>
  4381. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunction.Category">
  4382. <summary>
  4383. Category description for the function displayed by the formula builder tool
  4384. </summary>
  4385. </member>
  4386. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunction.ArgList">
  4387. <summary>
  4388. Array list of argument names
  4389. </summary>
  4390. </member>
  4391. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunction.ArgDescriptors">
  4392. <summary>
  4393. Array list of argument descriptors
  4394. </summary>
  4395. </member>
  4396. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunction.HelpURL">
  4397. <summary>
  4398. A URL to a help topic.
  4399. </summary>
  4400. <remarks>
  4401. <p class="body">This property is used by the FunctionBuilder at design-time to provide a link to a help topic describing the function.</p>
  4402. <p class="body">The default implementation returns an empty string. In this case, the Designer will not show the Help link."</p>
  4403. </remarks>
  4404. </member>
  4405. <member name="T:Infragistics.Win.CalcEngine.BuiltInFunctionBase">
  4406. <summary>
  4407. Base class for the built in functions.
  4408. </summary>
  4409. </member>
  4410. <member name="P:Infragistics.Win.CalcEngine.BuiltInFunctionBase.Description">
  4411. <summary>
  4412. Summary description for the function displayed by the formula builder tool
  4413. </summary>
  4414. </member>
  4415. <member name="P:Infragistics.Win.CalcEngine.BuiltInFunctionBase.Category">
  4416. <summary>
  4417. Category description for the function displayed by the formula builder tool
  4418. </summary>
  4419. </member>
  4420. <member name="P:Infragistics.Win.CalcEngine.BuiltInFunctionBase.ArgList">
  4421. <summary>
  4422. Array list of argument names
  4423. </summary>
  4424. </member>
  4425. <member name="P:Infragistics.Win.CalcEngine.BuiltInFunctionBase.ArgDescriptors">
  4426. <summary>
  4427. Array list of argument descriptors
  4428. </summary>
  4429. </member>
  4430. <member name="P:Infragistics.Win.CalcEngine.BuiltInFunctionBase.HelpURL">
  4431. <summary>
  4432. A URL to a help topic.
  4433. </summary>
  4434. <remarks>
  4435. <p class="body">This property is used by the FunctionBuilder at design-time to provide a link to a help topic describing the function.</p>
  4436. <p class="body">The default implementation returns the Func_CategoryURL_Template resource string. The first substitution string argument '{0}' will be replaced by the Func_FUNCTIONNAME_CategoryURL resource. The second substitution string is the Function Name."</p>
  4437. </remarks>
  4438. </member>
  4439. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionAverage">
  4440. <summary>
  4441. Calculates an average (arithmetic mean) for a series of numbers.
  4442. </summary>
  4443. <remarks>
  4444. <p class="body">AVERAGE(value1, value2, ...)</p>
  4445. <p class="body">Value1, value2, ... are one or more numeric values or
  4446. references to numeric values. An average (arithmetic mean) is calculated
  4447. by taking the sum of all values, and dividing by the number of values.</p>
  4448. <p class="body">Each value is equally weighted. To obtain a weighted average,
  4449. you can multiply each value by a weight in the expression.</p>
  4450. <code>
  4451. AVERAGE( [Value1]*[Weight1], [Value2]*[Weight2], [Value3]*[Weight3])
  4452. </code>
  4453. </remarks>
  4454. </member>
  4455. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionAverage.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  4456. <summary>
  4457. Evaluates the function against the arguments on the number stack
  4458. </summary>
  4459. <param name="numberStack">Formula number stack containing function arguments</param>
  4460. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  4461. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  4462. </member>
  4463. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionAverage.Name">
  4464. <summary>
  4465. Function name used to reference the function in a formula
  4466. </summary>
  4467. </member>
  4468. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionAverage.MinArgs">
  4469. <summary>
  4470. Minimum number of arguments required for the function
  4471. </summary>
  4472. </member>
  4473. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionAverage.MaxArgs">
  4474. <summary>
  4475. Maximum number of arguments required for the function
  4476. </summary>
  4477. </member>
  4478. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionSum">
  4479. <summary>
  4480. Adds a series of numbers to obtain a total amount.
  4481. </summary>
  4482. <remarks>
  4483. <p class="body">SUM(value1,value2,...)</p>
  4484. <p class="body">Value1, value2, ... are references for which you want to find the total value.
  4485. Text representations of numbers and literal numeric constants that you specify in the list of
  4486. arguments will be included in the sum. If <em>value</em> is a column or vector reference then
  4487. the sum will be taken of all cells or values contained by the reference. Any error values in
  4488. the argument list, or text that is not convertible to a numeric value, will produce an error.</p>
  4489. </remarks>
  4490. </member>
  4491. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionSum.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  4492. <summary>
  4493. Evaluates the function against the arguments on the number stack
  4494. </summary>
  4495. <param name="numberStack">Formula number stack containing function arguments</param>
  4496. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  4497. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  4498. </member>
  4499. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSum.Name">
  4500. <summary>
  4501. Function name used to reference the function in a formula
  4502. </summary>
  4503. </member>
  4504. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSum.MinArgs">
  4505. <summary>
  4506. Minimum number of arguments required for the function
  4507. </summary>
  4508. </member>
  4509. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSum.MaxArgs">
  4510. <summary>
  4511. Maximum number of arguments required for the function
  4512. </summary>
  4513. </member>
  4514. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionUnaryPlus">
  4515. <summary>
  4516. '+' Unary plus formula operator (+20)
  4517. </summary>
  4518. </member>
  4519. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionUnaryPlus.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  4520. <summary>
  4521. Evaluates the function against the arguments on the number stack
  4522. </summary>
  4523. <param name="numberStack">Formula number stack containing function arguments</param>
  4524. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  4525. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  4526. </member>
  4527. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionUnaryPlus.Name">
  4528. <summary>
  4529. Function name used to reference the function in a formula
  4530. </summary>
  4531. </member>
  4532. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionUnaryPlus.MinArgs">
  4533. <summary>
  4534. Minimum number of arguments required for the function
  4535. </summary>
  4536. </member>
  4537. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionUnaryPlus.MaxArgs">
  4538. <summary>
  4539. Maximum number of arguments required for the function
  4540. </summary>
  4541. </member>
  4542. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionUnaryMinus">
  4543. <summary>
  4544. '-' Negation formula operator (-20)
  4545. </summary>
  4546. </member>
  4547. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionUnaryMinus.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  4548. <summary>
  4549. Evaluates the function against the arguments on the number stack
  4550. </summary>
  4551. <param name="numberStack">Formula number stack containing function arguments</param>
  4552. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  4553. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  4554. </member>
  4555. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionUnaryMinus.Name">
  4556. <summary>
  4557. Function name used to reference the function in a formula
  4558. </summary>
  4559. </member>
  4560. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionUnaryMinus.MinArgs">
  4561. <summary>
  4562. Minimum number of arguments required for the function
  4563. </summary>
  4564. </member>
  4565. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionUnaryMinus.MaxArgs">
  4566. <summary>
  4567. Maximum number of arguments required for the function
  4568. </summary>
  4569. </member>
  4570. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionPlus">
  4571. <summary>
  4572. '+' Addition formula operator (1+2)
  4573. </summary>
  4574. </member>
  4575. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionPlus.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  4576. <summary>
  4577. Evaluates the function against the arguments on the number stack
  4578. </summary>
  4579. <param name="numberStack">Formula number stack containing function arguments</param>
  4580. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  4581. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  4582. </member>
  4583. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionPlus.Name">
  4584. <summary>
  4585. Function name used to reference the function in a formula
  4586. </summary>
  4587. </member>
  4588. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionPlus.MinArgs">
  4589. <summary>
  4590. Minimum number of arguments required for the function
  4591. </summary>
  4592. </member>
  4593. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionPlus.MaxArgs">
  4594. <summary>
  4595. Maximum number of arguments required for the function
  4596. </summary>
  4597. </member>
  4598. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionMinus">
  4599. <summary>
  4600. '-' Subtraction formula operator (3-2)
  4601. </summary>
  4602. </member>
  4603. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionMinus.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  4604. <summary>
  4605. Evaluates the function against the arguments on the number stack
  4606. </summary>
  4607. <param name="numberStack">Formula number stack containing function arguments</param>
  4608. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  4609. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  4610. </member>
  4611. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMinus.Name">
  4612. <summary>
  4613. Function name used to reference the function in a formula
  4614. </summary>
  4615. </member>
  4616. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMinus.MinArgs">
  4617. <summary>
  4618. Minimum number of arguments required for the function
  4619. </summary>
  4620. </member>
  4621. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMinus.MaxArgs">
  4622. <summary>
  4623. Maximum number of arguments required for the function
  4624. </summary>
  4625. </member>
  4626. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionPercent">
  4627. <summary>
  4628. '%' Percent formula operator (20%)
  4629. </summary>
  4630. </member>
  4631. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionPercent.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  4632. <summary>
  4633. Evaluates the function against the arguments on the number stack
  4634. </summary>
  4635. <param name="numberStack">Formula number stack containing function arguments</param>
  4636. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  4637. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  4638. </member>
  4639. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionPercent.Name">
  4640. <summary>
  4641. Function name used to reference the function in a formula
  4642. </summary>
  4643. </member>
  4644. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionPercent.MinArgs">
  4645. <summary>
  4646. Minimum number of arguments required for the function
  4647. </summary>
  4648. </member>
  4649. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionPercent.MaxArgs">
  4650. <summary>
  4651. Maximum number of arguments required for the function
  4652. </summary>
  4653. </member>
  4654. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionMultiply">
  4655. <summary>
  4656. '*' Multiplication formula operator (2*3)
  4657. </summary>
  4658. </member>
  4659. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionMultiply.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  4660. <summary>
  4661. Evaluates the function against the arguments on the number stack
  4662. </summary>
  4663. <param name="numberStack">Formula number stack containing function arguments</param>
  4664. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  4665. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  4666. </member>
  4667. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMultiply.Name">
  4668. <summary>
  4669. Function name used to reference the function in a formula
  4670. </summary>
  4671. </member>
  4672. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMultiply.MinArgs">
  4673. <summary>
  4674. Minimum number of arguments required for the function
  4675. </summary>
  4676. </member>
  4677. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMultiply.MaxArgs">
  4678. <summary>
  4679. Maximum number of arguments required for the function
  4680. </summary>
  4681. </member>
  4682. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionDivide">
  4683. <summary>
  4684. '/' Division formula operator (3/2)
  4685. </summary>
  4686. </member>
  4687. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionDivide.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  4688. <summary>
  4689. Evaluates the function against the arguments on the number stack
  4690. </summary>
  4691. <param name="numberStack">Formula number stack containing function arguments</param>
  4692. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  4693. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  4694. </member>
  4695. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDivide.Name">
  4696. <summary>
  4697. Function name used to reference the function in a formula
  4698. </summary>
  4699. </member>
  4700. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDivide.MinArgs">
  4701. <summary>
  4702. Minimum number of arguments required for the function
  4703. </summary>
  4704. </member>
  4705. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDivide.MaxArgs">
  4706. <summary>
  4707. Maximum number of arguments required for the function
  4708. </summary>
  4709. </member>
  4710. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionConcat">
  4711. <summary>
  4712. '&amp;' formula operator used to concatenate two strings. ("First" &amp; "Second")
  4713. </summary>
  4714. </member>
  4715. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionConcat.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  4716. <summary>
  4717. Evaluates the function against the arguments on the number stack
  4718. </summary>
  4719. <param name="numberStack">Formula number stack containing function arguments</param>
  4720. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  4721. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  4722. </member>
  4723. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionConcat.Name">
  4724. <summary>
  4725. Function name used to reference the function in a formula
  4726. </summary>
  4727. </member>
  4728. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionConcat.MinArgs">
  4729. <summary>
  4730. Minimum number of arguments required for the function
  4731. </summary>
  4732. </member>
  4733. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionConcat.MaxArgs">
  4734. <summary>
  4735. Maximum number of arguments required for the function
  4736. </summary>
  4737. </member>
  4738. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionConcatenate">
  4739. <summary>
  4740. Combines two or more text values into a single text string.
  4741. </summary>
  4742. <remarks>
  4743. <p class="body">CONCATENATE(text1, text2, ..., textN)</p>
  4744. <p class="body">Text1, text2, ..., textN are multiple text values that
  4745. you want to concatenate into one text string. These text values may be
  4746. text strings, numbers (which will be converted into text), or a single
  4747. value reference (such as a cell reference) containing such a value.</p>
  4748. <p class="body">This function provides for elementary text processing
  4749. in UltraCalc, such as when building message text or appending some
  4750. connective text or punctuation to the results of evaluating other
  4751. text-bearing expressions.</p>
  4752. </remarks>
  4753. </member>
  4754. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionConcatenate.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  4755. <summary>
  4756. Evaluates the function against the arguments on the number stack
  4757. </summary>
  4758. <param name="numberStack">Formula number stack containing function arguments</param>
  4759. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  4760. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  4761. </member>
  4762. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionConcatenate.Name">
  4763. <summary>
  4764. Function name used to reference the function in a formula
  4765. </summary>
  4766. </member>
  4767. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionConcatenate.MinArgs">
  4768. <summary>
  4769. Minimum number of arguments required for the function
  4770. </summary>
  4771. </member>
  4772. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionConcatenate.MaxArgs">
  4773. <summary>
  4774. Maximum number of arguments required for the function
  4775. </summary>
  4776. </member>
  4777. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionEqual">
  4778. <summary>
  4779. '=' Equality formula operator (Price = 200)
  4780. </summary>
  4781. </member>
  4782. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionEqual.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  4783. <summary>
  4784. Evaluates the function against the arguments on the number stack
  4785. </summary>
  4786. <param name="numberStack">Formula number stack containing function arguments</param>
  4787. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  4788. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  4789. </member>
  4790. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionEqual.Name">
  4791. <summary>
  4792. Function name used to reference the function in a formula
  4793. </summary>
  4794. </member>
  4795. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionEqual.MinArgs">
  4796. <summary>
  4797. Minimum number of arguments required for the function
  4798. </summary>
  4799. </member>
  4800. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionEqual.MaxArgs">
  4801. <summary>
  4802. Maximum number of arguments required for the function
  4803. </summary>
  4804. </member>
  4805. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionNE">
  4806. <summary>
  4807. "&lt;&gt;" Inequality formula operator (Price &lt;&gt; 200)
  4808. </summary>
  4809. </member>
  4810. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionNE.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  4811. <summary>
  4812. Evaluates the function against the arguments on the number stack
  4813. </summary>
  4814. <param name="numberStack">Formula number stack containing function arguments</param>
  4815. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  4816. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  4817. </member>
  4818. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionNE.Name">
  4819. <summary>
  4820. Function name used to reference the function in a formula
  4821. </summary>
  4822. </member>
  4823. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionNE.MinArgs">
  4824. <summary>
  4825. Minimum number of arguments required for the function
  4826. </summary>
  4827. </member>
  4828. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionNE.MaxArgs">
  4829. <summary>
  4830. Maximum number of arguments required for the function
  4831. </summary>
  4832. </member>
  4833. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionLT">
  4834. <summary>
  4835. '&lt;' Less than formula operator (Price &lt; 200)
  4836. </summary>
  4837. </member>
  4838. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionLT.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  4839. <summary>
  4840. Evaluates the function against the arguments on the number stack
  4841. </summary>
  4842. <param name="numberStack">Formula number stack containing function arguments</param>
  4843. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  4844. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  4845. </member>
  4846. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionLT.Name">
  4847. <summary>
  4848. Function name used to reference the function in a formula
  4849. </summary>
  4850. </member>
  4851. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionLT.MinArgs">
  4852. <summary>
  4853. Minimum number of arguments required for the function
  4854. </summary>
  4855. </member>
  4856. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionLT.MaxArgs">
  4857. <summary>
  4858. Maximum number of arguments required for the function
  4859. </summary>
  4860. </member>
  4861. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionLE">
  4862. <summary>
  4863. "&lt;=" Less than or equal formula operator (Price &lt;= 200)
  4864. </summary>
  4865. </member>
  4866. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionLE.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  4867. <summary>
  4868. Evaluates the function against the arguments on the number stack
  4869. </summary>
  4870. <param name="numberStack">Formula number stack containing function arguments</param>
  4871. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  4872. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  4873. </member>
  4874. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionLE.Name">
  4875. <summary>
  4876. Function name used to reference the function in a formula
  4877. </summary>
  4878. </member>
  4879. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionLE.MinArgs">
  4880. <summary>
  4881. Minimum number of arguments required for the function
  4882. </summary>
  4883. </member>
  4884. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionLE.MaxArgs">
  4885. <summary>
  4886. Maximum number of arguments required for the function
  4887. </summary>
  4888. </member>
  4889. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionGT">
  4890. <summary>
  4891. "&gt;" Greater than formula operator (Price > 200)
  4892. </summary>
  4893. </member>
  4894. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionGT.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  4895. <summary>
  4896. Evaluates the function against the arguments on the number stack
  4897. </summary>
  4898. <param name="numberStack">Formula number stack containing function arguments</param>
  4899. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  4900. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  4901. </member>
  4902. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionGT.Name">
  4903. <summary>
  4904. Function name used to reference the function in a formula
  4905. </summary>
  4906. </member>
  4907. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionGT.MinArgs">
  4908. <summary>
  4909. Minimum number of arguments required for the function
  4910. </summary>
  4911. </member>
  4912. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionGT.MaxArgs">
  4913. <summary>
  4914. Maximum number of arguments required for the function
  4915. </summary>
  4916. </member>
  4917. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionGE">
  4918. <summary>
  4919. "&gt;=" Greater than or equal formula operator (Price >= 200)
  4920. </summary>
  4921. </member>
  4922. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionGE.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  4923. <summary>
  4924. Evaluates the function against the arguments on the number stack
  4925. </summary>
  4926. <param name="numberStack">Formula number stack containing function arguments</param>
  4927. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  4928. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  4929. </member>
  4930. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionGE.Name">
  4931. <summary>
  4932. Function name used to reference the function in a formula
  4933. </summary>
  4934. </member>
  4935. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionGE.MinArgs">
  4936. <summary>
  4937. Minimum number of arguments required for the function
  4938. </summary>
  4939. </member>
  4940. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionGE.MaxArgs">
  4941. <summary>
  4942. Maximum number of arguments required for the function
  4943. </summary>
  4944. </member>
  4945. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionExpon">
  4946. <summary>
  4947. "^" Exponentiation formula operator (3^2)
  4948. </summary>
  4949. </member>
  4950. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionExpon.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  4951. <summary>
  4952. Evaluates the function against the arguments on the number stack
  4953. </summary>
  4954. <param name="numberStack">Formula number stack containing function arguments</param>
  4955. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  4956. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  4957. </member>
  4958. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionExpon.Name">
  4959. <summary>
  4960. Function name used to reference the function in a formula
  4961. </summary>
  4962. </member>
  4963. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionExpon.MinArgs">
  4964. <summary>
  4965. Minimum number of arguments required for the function
  4966. </summary>
  4967. </member>
  4968. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionExpon.MaxArgs">
  4969. <summary>
  4970. Maximum number of arguments required for the function
  4971. </summary>
  4972. </member>
  4973. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionIf">
  4974. <summary>
  4975. Chooses between two outcomes (or UltraCalc expressions to evaluate) based on
  4976. the result of a logical test on a value or UltraCalc expression you specify.
  4977. </summary>
  4978. <remarks>
  4979. <p class="body">IF( boolean_test, result_if_true, [result_if_false])</p>
  4980. <p class="body">Boolean_test is a value (or an UltraCalc expression) which the IF function
  4981. evaluates to produce a boolean value of either TRUE or FALSE. The outcome of
  4982. this test determines which result will be returned by the function.
  4983. </p>
  4984. <p class="body">Result_if_true is a value (or the outcome of another
  4985. UltraCalc expression) that will be returned only when boolean_test has
  4986. evaluated to the boolean value, TRUE.</p>
  4987. <p class="body">Result_if_false is a value (or the outcome of another
  4988. UltraCalc expression) that will be returned only when boolean_test has
  4989. evaluated to the boolean value, FALSE.</p>
  4990. <p class="body">The IF function allows you to write an UltraCalc expression
  4991. that branches to one expression (when the boolean_test is TRUE) or another
  4992. (when the boolean_test is FALSE) based on an arbitrary condition you have
  4993. specified.</p>
  4994. <p class="body">The result_if_false is not specified and boolean_test is FALSE, the
  4995. IF function will return FALSE.</p>
  4996. <p class="note">If boolean_test's evaluation produces an error value then
  4997. neither Result_if_true nor Result_if_false will be evaluated. Instead, the
  4998. IF function returns the error value from its evaluation of boolean_test.</p>
  4999. </remarks>
  5000. </member>
  5001. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionIf.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  5002. <summary>
  5003. Evaluates the function against the arguments on the number stack
  5004. </summary>
  5005. <param name="numberStack">Formula number stack containing function arguments</param>
  5006. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  5007. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  5008. </member>
  5009. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIf.Name">
  5010. <summary>
  5011. Function name used to reference the function in a formula
  5012. </summary>
  5013. </member>
  5014. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIf.MinArgs">
  5015. <summary>
  5016. Minimum number of arguments required for the function
  5017. </summary>
  5018. </member>
  5019. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIf.MaxArgs">
  5020. <summary>
  5021. Maximum number of arguments required for the function
  5022. </summary>
  5023. </member>
  5024. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionAbs">
  5025. <summary>
  5026. Calculates a number's absolute value.
  5027. </summary>
  5028. <remarks>
  5029. <p class="body">ABS( value)</p>
  5030. <p class="body">A number's absolute value is it's value without any
  5031. sign. It represents the magnitude of a value while ignoring it's
  5032. direction (positive or negative) on a number line or vector.</p>
  5033. </remarks>
  5034. </member>
  5035. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionAbs.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  5036. <summary>
  5037. Evaluates the function against the arguments on the number stack
  5038. </summary>
  5039. <param name="numberStack">Formula number stack containing function arguments</param>
  5040. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  5041. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  5042. </member>
  5043. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionAbs.Name">
  5044. <summary>
  5045. Function name used to reference the function in a formula
  5046. </summary>
  5047. </member>
  5048. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionAbs.MinArgs">
  5049. <summary>
  5050. Minimum number of arguments required for the function
  5051. </summary>
  5052. </member>
  5053. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionAbs.MaxArgs">
  5054. <summary>
  5055. Maximum number of arguments required for the function
  5056. </summary>
  5057. </member>
  5058. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionMod">
  5059. <summary>
  5060. Gets the remainder following integer division of two numbers.
  5061. </summary>
  5062. <remarks>
  5063. <p class="body">MOD(numerator, denominator)</p>
  5064. <p class="body">Numerator is the number being divided by <em>denominator</em>.
  5065. When <em>denominator</em> can only be taken from <em>numerator</em>
  5066. a certain whole number of types (the quotient), any leftover is the
  5067. remainder.</p>
  5068. <p class="body">Denominator is the number dividing the <em>numerator</em>.
  5069. Any remainder will have the sign of the <em>denominator</em>. This number
  5070. cannot be zero, otherwise the MOD() function returns a #DIV/0 error.</p>
  5071. <p class="body">If you want to perform integer division on these two numbers
  5072. then use the <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionQuotient">QUOTIENT()</see> function.
  5073. </p>
  5074. </remarks>
  5075. </member>
  5076. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionMod.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  5077. <summary>
  5078. Evaluates the function against the arguments on the number stack.
  5079. </summary>
  5080. <param name="numberStack">Formula number stack containing function arguments</param>
  5081. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  5082. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  5083. </member>
  5084. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMod.Name">
  5085. <summary>
  5086. Function name used to reference the function in a formula
  5087. </summary>
  5088. </member>
  5089. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMod.MinArgs">
  5090. <summary>
  5091. Minimum number of arguments required for the function
  5092. </summary>
  5093. </member>
  5094. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMod.MaxArgs">
  5095. <summary>
  5096. Maximum number of arguments required for the function
  5097. </summary>
  5098. </member>
  5099. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionQuotient">
  5100. <summary>
  5101. Performs integer division on two numbers disregarding any remainder.
  5102. </summary>
  5103. <remarks>
  5104. <p class="body">QUOTIENT(numerator, denominator)</p>
  5105. <p class="body">Numerator is a numeric value that will be divided
  5106. by the <em>denominator</em>. It is sometimes called the dividend.
  5107. </p>
  5108. <p class="body">Denominator is the numeric value that divides the
  5109. <em>numerator</em>. It is sometimes called the divisor. It cannot
  5110. be zero or a #DIV/0 error value will be returned.
  5111. </p>
  5112. <p class="body">When either the <em>numerator</em> or the
  5113. <em>denominator</em> is not a number, the QUOTIENT() function
  5114. returns an error value (#VALUE!).</p>
  5115. <p class="body">If you need the remainder from an integer division,
  5116. use the <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionMod">MOD()</see> function.</p>
  5117. </remarks>
  5118. </member>
  5119. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionQuotient.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  5120. <summary>
  5121. Evaluates the function against the arguments on the number stack.
  5122. </summary>
  5123. <param name="numberStack">Formula number stack containing function arguments</param>
  5124. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  5125. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  5126. </member>
  5127. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionQuotient.Name">
  5128. <summary>
  5129. Function name used to reference the function in a formula
  5130. </summary>
  5131. </member>
  5132. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionQuotient.MinArgs">
  5133. <summary>
  5134. Minimum number of arguments required for the function
  5135. </summary>
  5136. </member>
  5137. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionQuotient.MaxArgs">
  5138. <summary>
  5139. Maximum number of arguments required for the function
  5140. </summary>
  5141. </member>
  5142. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionProduct">
  5143. <summary>
  5144. Multiplies a series of numbers to return their total product.
  5145. </summary>
  5146. <remarks>
  5147. <p class="body">PRODUCT( value1, value2, ..., valueN)</p>
  5148. <p class="body">Value1 is the first number (the multiplicand) in a
  5149. series of numbers that you want to multiply.</p>
  5150. <p class="body">Value2 is the second number (the first multiplier)
  5151. in a series of numbers that you want to multiply.</p>
  5152. <p class="body">Value<em>N</em> is the last number (the last multiplier)
  5153. in a series of numbers that you want to multiply.</p>
  5154. <p class="body">This function offers a convenience when you need to
  5155. multiply many numbers or expressions at one time.</p>
  5156. </remarks>
  5157. </member>
  5158. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionProduct.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  5159. <summary>
  5160. Evaluates the function against the arguments on the number stack
  5161. </summary>
  5162. <param name="numberStack">Formula number stack containing function arguments</param>
  5163. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  5164. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  5165. </member>
  5166. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionProduct.Name">
  5167. <summary>
  5168. Function name used to reference the function in a formula
  5169. </summary>
  5170. </member>
  5171. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionProduct.MinArgs">
  5172. <summary>
  5173. Minimum number of arguments required for the function
  5174. </summary>
  5175. </member>
  5176. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionProduct.MaxArgs">
  5177. <summary>
  5178. Maximum number of arguments required for the function
  5179. </summary>
  5180. </member>
  5181. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionPower">
  5182. <summary>
  5183. Raises the specific number to a power.
  5184. </summary>
  5185. <remarks>
  5186. <p class="body">POWER(value, exponent)</p>
  5187. <p class="body">Value is a numeric value or reference to a numeric value
  5188. which you want to raise to a power.</p>
  5189. <p class="body">Exponent is a real number power to which <em>value</em>
  5190. is to be raised. Imaginary exponents are not supported.</p>
  5191. <p class="body">Common applications of the POWER() function occur when
  5192. you need to multiply a number against itself multiple times. For example,
  5193. it is common in many computer applications to create bit mask values by
  5194. raising the value 2 to integer exponents, which produce a sequence such
  5195. as (1, 2, 4, 8, 16, 32, 64, 128, ...)</p>
  5196. <p class="body">The POWER() function additionally supports fractional
  5197. exponents, and can be used to emulate other functions such as the quad
  5198. root (raising to an exponent of 0.25, which is 1/4) or the inverse
  5199. square (raising to an exponent of -2.0).</p>
  5200. </remarks>
  5201. </member>
  5202. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionPower.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  5203. <summary>
  5204. Evaluates the function against the arguments on the number stack
  5205. </summary>
  5206. <param name="numberStack">Formula number stack containing function arguments</param>
  5207. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  5208. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  5209. </member>
  5210. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionPower.Name">
  5211. <summary>
  5212. Function name used to reference the function in a formula
  5213. </summary>
  5214. </member>
  5215. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionPower.MinArgs">
  5216. <summary>
  5217. Minimum number of arguments required for the function
  5218. </summary>
  5219. </member>
  5220. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionPower.MaxArgs">
  5221. <summary>
  5222. Maximum number of arguments required for the function
  5223. </summary>
  5224. </member>
  5225. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionInt">
  5226. <summary>
  5227. Converts a real numeric value (which may have a fractional part)
  5228. into a whole number.
  5229. </summary>
  5230. <remarks>
  5231. <p class="body">INT(value)</p>
  5232. <p class="body">Value is a real numeric value that you want to
  5233. convert into a whole number. INT() is a more specialized version
  5234. of the <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionTrunc">TRUNC()</see> function
  5235. because it always produces integer values (whereas the TRUNC()
  5236. function allows you to specify a precision at which to truncate
  5237. the numeric value.)</p>
  5238. </remarks>
  5239. </member>
  5240. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionInt.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  5241. <summary>
  5242. Evaluates the function against the arguments on the number stack
  5243. </summary>
  5244. <param name="numberStack">Formula number stack containing function arguments</param>
  5245. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  5246. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  5247. </member>
  5248. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionInt.Name">
  5249. <summary>
  5250. Function name used to reference the function in a formula
  5251. </summary>
  5252. </member>
  5253. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionInt.MinArgs">
  5254. <summary>
  5255. Minimum number of arguments required for the function
  5256. </summary>
  5257. </member>
  5258. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionInt.MaxArgs">
  5259. <summary>
  5260. Maximum number of arguments required for the function
  5261. </summary>
  5262. </member>
  5263. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionTrunc">
  5264. <summary>
  5265. Truncates the fractional portion of a numeric value to produce an integer.
  5266. </summary>
  5267. <remarks>
  5268. <p class="body">TRUNC(value, number_of_digits)</p>
  5269. <p class="body">Value is a numeric value or reference to a numeric value
  5270. that you want to truncate.</p>
  5271. <p class="body">Number_of_digits specifies the precision at which truncation
  5272. should occur. By default, truncation occurs zero places right of the decimal
  5273. point which will produce an integer.</p>
  5274. <p class="body">Truncation always discards the fractional value, causing the
  5275. <em>Value</em> to move closer to zero (whether it was positive or negative
  5276. before the truncation). It differs from the <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionRound">ROUND()</see>
  5277. function in that the value always changes to a lesser value.</p>
  5278. </remarks>
  5279. </member>
  5280. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionTrunc.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  5281. <summary>
  5282. Evaluates the function against the arguments on the number stack
  5283. </summary>
  5284. <param name="numberStack">Formula number stack containing function arguments</param>
  5285. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  5286. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  5287. </member>
  5288. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionTrunc.Name">
  5289. <summary>
  5290. Function name used to reference the function in a formula
  5291. </summary>
  5292. </member>
  5293. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionTrunc.MinArgs">
  5294. <summary>
  5295. Minimum number of arguments required for the function
  5296. </summary>
  5297. </member>
  5298. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionTrunc.MaxArgs">
  5299. <summary>
  5300. Maximum number of arguments required for the function
  5301. </summary>
  5302. </member>
  5303. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionCount">
  5304. <summary>
  5305. Counts how many cells have numeric or date/time values.
  5306. </summary>
  5307. <remarks>
  5308. <p class="body">COUNT(Value1, Value2, ..., ValueN)</p>
  5309. <p class="body">Value1, value2, ... valueN can be references to different data structures,
  5310. such as columns. Each numeric or date/time value is counted. Empty, error, boolean or text
  5311. values that are not convertible into numeric values are not counted.</p>
  5312. <p class="body">When a reference is a range reference, only those numeric and date/time
  5313. values within the range will be counted.</p>
  5314. </remarks>
  5315. </member>
  5316. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionCount.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  5317. <summary>
  5318. Evaluates the function against the arguments on the number stack
  5319. </summary>
  5320. <param name="numberStack">Formula number stack containing function arguments</param>
  5321. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  5322. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  5323. </member>
  5324. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionCount.Name">
  5325. <summary>
  5326. Function name used to reference the function in a formula
  5327. </summary>
  5328. </member>
  5329. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionCount.MinArgs">
  5330. <summary>
  5331. Minimum number of arguments required for the function
  5332. </summary>
  5333. </member>
  5334. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionCount.MaxArgs">
  5335. <summary>
  5336. Maximum number of arguments required for the function
  5337. </summary>
  5338. </member>
  5339. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionTrue">
  5340. <summary>
  5341. A constant function always returning the TRUE value of Boolean
  5342. logic.
  5343. </summary>
  5344. <remarks>
  5345. <p class="body">TRUE() will always evaluate to the boolean value
  5346. of TRUE. It takes no arguments.</p>
  5347. </remarks>
  5348. </member>
  5349. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionTrue.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  5350. <summary>
  5351. Evaluates the function against the arguments on the number stack
  5352. </summary>
  5353. <param name="numberStack">Formula number stack containing function arguments</param>
  5354. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  5355. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  5356. </member>
  5357. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionTrue.Name">
  5358. <summary>
  5359. Function name used to reference the function in a formula
  5360. </summary>
  5361. </member>
  5362. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionTrue.MinArgs">
  5363. <summary>
  5364. Minimum number of arguments required for the function
  5365. </summary>
  5366. </member>
  5367. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionTrue.MaxArgs">
  5368. <summary>
  5369. Maximum number of arguments required for the function
  5370. </summary>
  5371. </member>
  5372. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionFalse">
  5373. <summary>
  5374. A constant function always returning the FALSE value of Boolean
  5375. logic.
  5376. </summary>
  5377. <remarks>
  5378. <p class="body">FALSE() will always evaluate to the boolean value
  5379. of FALSE. It takes no arguments.</p>
  5380. </remarks>
  5381. </member>
  5382. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionFalse.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  5383. <summary>
  5384. Evaluates the function against the arguments on the number stack
  5385. </summary>
  5386. <param name="numberStack">Formula number stack containing function arguments</param>
  5387. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  5388. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  5389. </member>
  5390. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionFalse.Name">
  5391. <summary>
  5392. Function name used to reference the function in a formula
  5393. </summary>
  5394. </member>
  5395. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionFalse.MinArgs">
  5396. <summary>
  5397. Minimum number of arguments required for the function
  5398. </summary>
  5399. </member>
  5400. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionFalse.MaxArgs">
  5401. <summary>
  5402. Maximum number of arguments required for the function
  5403. </summary>
  5404. </member>
  5405. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionNot">
  5406. <summary>
  5407. Logical-NOT returns the inverse boolean value of it's argument.
  5408. </summary>
  5409. <remarks>
  5410. <p class="body">NOT(boolean1)</p>
  5411. <p class="body">Boolean1 is any boolean (TRUE or FALSE) value, or
  5412. conditional statement (made up of any UltraCalc expression which
  5413. itself evaluates to a boolean TRUE or FALSE value) to be inverted.</p>
  5414. <p class="body">If boolean1 was TRUE, then the Logical-NOT would
  5415. return FALSE. If boolean1 was FALSE, then the Logical-NOT would
  5416. return TRUE.</p>
  5417. <p class="note">If Boolean1 is an UltraCalc expression that evaluates
  5418. to an error value, then the result of a Logical-NOT operation is
  5419. undefined because an error value is neither TRUE nor FALSE.</p>
  5420. </remarks>
  5421. </member>
  5422. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionNot.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  5423. <summary>
  5424. Evaluates the function against the arguments on the number stack
  5425. </summary>
  5426. <param name="numberStack">Formula number stack containing function arguments</param>
  5427. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  5428. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  5429. </member>
  5430. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionNot.Name">
  5431. <summary>
  5432. Function name used to reference the function in a formula
  5433. </summary>
  5434. </member>
  5435. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionNot.MinArgs">
  5436. <summary>
  5437. Minimum number of arguments required for the function
  5438. </summary>
  5439. </member>
  5440. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionNot.MaxArgs">
  5441. <summary>
  5442. Maximum number of arguments required for the function
  5443. </summary>
  5444. </member>
  5445. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionAnd">
  5446. <summary>
  5447. Logical-AND returns the boolean value, FALSE, if at least one argument has a value of FALSE.
  5448. When <em>all</em> arguments are TRUE, then this function returns TRUE.
  5449. </summary>
  5450. <remarks>
  5451. <p class="body">AND(boolean1, boolean2, ...)</p>
  5452. <p class="body">Boolean1, boolean2, ... are a list of boolean (TRUE or FALSE) values or
  5453. conditional statements (any UltraCalc expression which itself evaluates to a boolean
  5454. TRUE or FALSE value) to be evaluated for the constraint that all arguments should be
  5455. TRUE (or conversely, that at least one argument should be FALSE.)</p>
  5456. <p class="body">All arguments are tested (<em>i.e.</em>, the logical-AND function
  5457. does not use "short-circuit" evaluation, in which the function can stop executing
  5458. as soon as the first argument having the boolean value, FALSE, has been processed.)</p>
  5459. <p class="note">This function stops evaluating immediately when any argument results in
  5460. an error value. An error value is neither TRUE nor FALSE, therefore the return value of
  5461. the logical-AND function is undefined.</p>
  5462. </remarks>
  5463. </member>
  5464. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionAnd.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  5465. <summary>
  5466. Evaluates the function against the arguments on the number stack
  5467. </summary>
  5468. <param name="numberStack">Formula number stack containing function arguments</param>
  5469. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  5470. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  5471. </member>
  5472. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionAnd.Name">
  5473. <summary>
  5474. Function name used to reference the function in a formula
  5475. </summary>
  5476. </member>
  5477. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionAnd.MinArgs">
  5478. <summary>
  5479. Minimum number of arguments required for the function
  5480. </summary>
  5481. </member>
  5482. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionAnd.MaxArgs">
  5483. <summary>
  5484. Maximum number of arguments required for the function
  5485. </summary>
  5486. </member>
  5487. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionOr">
  5488. <summary>
  5489. Logical-OR returns the boolean value, TRUE, if at least one argument has a value of TRUE.
  5490. When <em>all</em> arguments are FALSE, then this function returns FALSE.
  5491. </summary>
  5492. <remarks>
  5493. <p class="body">OR(boolean1, boolean2, ...)</p>
  5494. <p class="body">Boolean1, boolean2, ... are a list of boolean (TRUE or FALSE) values or
  5495. conditional statements (any UltraCalc expression which itself evaluates to a boolean
  5496. TRUE or FALSE value) to be evaluated for the constraint that at least one argument
  5497. should be TRUE (or conversely, that all arguments should be FALSE.)</p>
  5498. <p class="body">All arguments are tested (<em>i.e.</em>, the logical-OR function
  5499. does not use "short-circuit" evaluation, in which the function can stop executing
  5500. as soon as the first argument having the boolean value, TRUE, has been processed.)</p>
  5501. <p class="note">This function stops evaluating immediately when any argument results in
  5502. an error value. An error value is neither TRUE nor FALSE, therefore the return value of
  5503. the logical-OR function is undefined.</p>
  5504. </remarks>
  5505. </member>
  5506. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionOr.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  5507. <summary>
  5508. Evaluates the function against the arguments on the number stack
  5509. </summary>
  5510. <param name="numberStack">Formula number stack containing function arguments</param>
  5511. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  5512. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  5513. </member>
  5514. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionOr.Name">
  5515. <summary>
  5516. Function name used to reference the function in a formula
  5517. </summary>
  5518. </member>
  5519. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionOr.MinArgs">
  5520. <summary>
  5521. Minimum number of arguments required for the function
  5522. </summary>
  5523. </member>
  5524. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionOr.MaxArgs">
  5525. <summary>
  5526. Maximum number of arguments required for the function
  5527. </summary>
  5528. </member>
  5529. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionMin">
  5530. <summary>
  5531. Gives you the smallest numeric value out of a series.
  5532. </summary>
  5533. <remarks>
  5534. <p class="body">MIN(Value1, value2, ..., valueN)</p>
  5535. <p class="body">Value1, value2, ... valueN are any number of numeric values or references to
  5536. numeric values from which you want the minimum value found. Arguments may be numbers, boolean
  5537. values, text values convertible into numbers, or empty. Error values and text values that are
  5538. not convertible into numbers will produce an error.</p>
  5539. <p class="body">The minimum value for a series of numbers can be it's largest magnitude
  5540. negative number because larger magnitude negative numbers are less than smaller magnitude
  5541. negative numbers. For example, given the expression MIN( -1500, -50, 5, 150), the return value
  5542. is -1500 and not 5. To determine the numeric value with the smallest magnitude you would
  5543. use the <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionAbs">ABS()</see> function on each argument. The
  5544. following example would produce a minimum value of 5.</p>
  5545. <code>MIN( ABS(-1500), ABS(-50), ABS(5), ABS(150))</code>
  5546. <p class="body">When the argument list is empty, MIN() returns zero.</p>
  5547. <seealso cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionMax">MAX()</seealso>
  5548. </remarks>
  5549. </member>
  5550. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionMin.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  5551. <summary>
  5552. Evaluates the function against the arguments on the number stack
  5553. </summary>
  5554. <param name="numberStack">Formula number stack containing function arguments</param>
  5555. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  5556. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  5557. </member>
  5558. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMin.Name">
  5559. <summary>
  5560. Function name used to reference the function in a formula
  5561. </summary>
  5562. </member>
  5563. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMin.MinArgs">
  5564. <summary>
  5565. Minimum number of arguments required for the function
  5566. </summary>
  5567. </member>
  5568. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMin.MaxArgs">
  5569. <summary>
  5570. Maximum number of arguments required for the function
  5571. </summary>
  5572. </member>
  5573. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionMax">
  5574. <summary>
  5575. Gives you the largest numeric value out of a series.
  5576. </summary>
  5577. <remarks>
  5578. <p class="body">MAX(Value1, value2, ..., valueN)</p>
  5579. <p class="body">Value1, value2, ... valueN are any number of numeric values or references to numeric
  5580. values from which you want the maximum value found. Arguments may be numbers, boolean
  5581. values, text values convertible into numbers, or empty. Error values and text values
  5582. that are not convertible into numbers will produce an error.</p>
  5583. <p class="body">When the argument list is empty, MAX() returns zero.</p>
  5584. <seealso cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionMin">MIN()</seealso>
  5585. </remarks>
  5586. </member>
  5587. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionMax.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  5588. <summary>
  5589. Evaluates the function against the arguments on the number stack
  5590. </summary>
  5591. <param name="numberStack">Formula number stack containing function arguments</param>
  5592. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  5593. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  5594. </member>
  5595. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMax.Name">
  5596. <summary>
  5597. Function name used to reference the function in a formula
  5598. </summary>
  5599. </member>
  5600. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMax.MinArgs">
  5601. <summary>
  5602. Minimum number of arguments required for the function
  5603. </summary>
  5604. </member>
  5605. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMax.MaxArgs">
  5606. <summary>
  5607. Maximum number of arguments required for the function
  5608. </summary>
  5609. </member>
  5610. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionExp">
  5611. <summary>
  5612. Calculates the mathematical constant, e, raised to the specified power.
  5613. </summary>
  5614. <remarks>
  5615. <p class="body">EXP(exponent)</p>
  5616. <p class="body">Exponent is the power to which the base, e, is raised.
  5617. This gives the function it's characteristic "exponential" growth.</p>
  5618. <p class="body">Euler's Number, e, is the value 2.718281828459..., and
  5619. is also the base of the natural logarithm. You can represent the constant
  5620. e within your UltraCalc formula by specifying EXP(1). The exponential
  5621. function (and natural logarithm) have many applications in mathematics,
  5622. engineering, and for modeling behavioral and statistical distributions
  5623. commonly observed in nature and the social sciences.</p>
  5624. <seealso cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionLn">LN()</seealso>
  5625. </remarks>
  5626. </member>
  5627. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionExp.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  5628. <summary>
  5629. Evaluates the function against the arguments on the number stack
  5630. </summary>
  5631. <param name="numberStack">Formula number stack containing function arguments</param>
  5632. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  5633. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  5634. </member>
  5635. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionExp.Name">
  5636. <summary>
  5637. Function name used to reference the function in a formula
  5638. </summary>
  5639. </member>
  5640. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionExp.MinArgs">
  5641. <summary>
  5642. Minimum number of arguments required for the function
  5643. </summary>
  5644. </member>
  5645. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionExp.MaxArgs">
  5646. <summary>
  5647. Maximum number of arguments required for the function
  5648. </summary>
  5649. </member>
  5650. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionRound">
  5651. <summary>
  5652. Rounds the fractional portion of a numeric value up or down to produce an
  5653. integer.
  5654. </summary>
  5655. <remarks>
  5656. <p class="body">ROUND(value, number_of_digits)</p>
  5657. <p class="body">Value is a numeric value or reference to a numeric value
  5658. that you want to round up or down.</p>
  5659. <p class="body">Number_of_digits specifies the precision at which rounding
  5660. should occur. This will be the place value which UltraCalc examines to round
  5661. up or down. By default, rounding occurs zero places right of the decimal point
  5662. produces an integer.</p>
  5663. </remarks>
  5664. </member>
  5665. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionRound.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  5666. <summary>
  5667. Evaluates the function against the arguments on the number stack
  5668. </summary>
  5669. <param name="numberStack">Formula number stack containing function arguments</param>
  5670. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  5671. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  5672. </member>
  5673. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRound.Name">
  5674. <summary>
  5675. Function name used to reference the function in a formula
  5676. </summary>
  5677. </member>
  5678. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRound.MinArgs">
  5679. <summary>
  5680. Minimum number of arguments required for the function
  5681. </summary>
  5682. </member>
  5683. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRound.MaxArgs">
  5684. <summary>
  5685. Maximum number of arguments required for the function
  5686. </summary>
  5687. </member>
  5688. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionPi">
  5689. <summary>
  5690. Returns the mathematical constant for the Greek letter, pi.
  5691. </summary>
  5692. <remarks>
  5693. <p class="body">PI()</p>
  5694. <p class="body">The mathematical constant pi represents the relationship
  5695. between a circle's diameter and it's circumference. It is also the constant
  5696. relating the square of a circle's radius with the surface area of the circle.
  5697. It has a great many applications in mathematics, geometry, the sciences, and
  5698. engineering.</p>
  5699. <p class="body">The constant pi is a non-terminating decimal number, although
  5700. UltraCalc approximates it to 15 significant digits of precision (3.14159265358979).</p>
  5701. <p class="body">A common use of the PI function in UltraCalc is to convert
  5702. a measurement in radians which is the form in which trigonometric functions
  5703. take their arguments, and the more conventional degrees of arc. This conversion
  5704. can be accomplished by multiplying the radian measurement by PI()/180. The
  5705. following table describes some benchmarks for comparison between radians and
  5706. degrees.</p>
  5707. <table border="0">
  5708. <thead>
  5709. <th>Radians</th><th>Degrees</th><th>Turns of a wheel (common example)</th>
  5710. </thead>
  5711. <tbody>
  5712. <tr><td>0</td><td>0</td><td>no turns</td></tr>
  5713. <tr><td>PI/4</td><td>45</td><td>one-eighth turn</td></tr>
  5714. <tr><td>PI/2</td><td>90</td><td>one-quarter turn</td></tr>
  5715. <tr><td>PI</td><td>180</td><td>one-half turn</td></tr>
  5716. <tr><td>2x PI</td><td>360</td><td>one complete turn</td></tr>
  5717. <tr><td>3x PI</td><td>540</td><td>one and one-half turn</td></tr>
  5718. </tbody>
  5719. </table>
  5720. </remarks>
  5721. </member>
  5722. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionPi.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  5723. <summary>
  5724. Evaluates the function against the arguments on the number stack
  5725. </summary>
  5726. <param name="numberStack">Formula number stack containing function arguments</param>
  5727. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  5728. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  5729. </member>
  5730. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionPi.Name">
  5731. <summary>
  5732. Function name used to reference the function in a formula
  5733. </summary>
  5734. </member>
  5735. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionPi.MinArgs">
  5736. <summary>
  5737. Minimum number of arguments required for the function
  5738. </summary>
  5739. </member>
  5740. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionPi.MaxArgs">
  5741. <summary>
  5742. Maximum number of arguments required for the function
  5743. </summary>
  5744. </member>
  5745. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionSqrt">
  5746. <summary>
  5747. Calculates the square root of a number.
  5748. </summary>
  5749. <remarks>
  5750. <p class="body">SQRT(value)</p>
  5751. <p class="body">Value is the numeric value or reference to a numeric
  5752. value which you are calculating the square root of. Only real roots
  5753. are supported, therefore if <em>value</em> is negative (which would
  5754. produce an imaginary root) the SQRT() function will return an error
  5755. value (#NUM!).</p>
  5756. <p class="body">The square root is the number whose product, when
  5757. the number is multiplied against itself (squared), is <em>value</em>.
  5758. Note that it is possible to multiply two negative square roots to
  5759. produce the same positive <em>value</em>. By convention, the SQRT()
  5760. function only returns the positive root.</p>
  5761. </remarks>
  5762. </member>
  5763. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionSqrt.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  5764. <summary>
  5765. Evaluates the function against the arguments on the number stack
  5766. </summary>
  5767. <param name="numberStack">Formula number stack containing function arguments</param>
  5768. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  5769. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  5770. </member>
  5771. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSqrt.Name">
  5772. <summary>
  5773. Function name used to reference the function in a formula
  5774. </summary>
  5775. </member>
  5776. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSqrt.MinArgs">
  5777. <summary>
  5778. Minimum number of arguments required for the function
  5779. </summary>
  5780. </member>
  5781. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSqrt.MaxArgs">
  5782. <summary>
  5783. Maximum number of arguments required for the function
  5784. </summary>
  5785. </member>
  5786. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionCos">
  5787. <summary>
  5788. Calculates the trigonometric cosine of a specified angle (measured in
  5789. radians).
  5790. </summary>
  5791. <remarks>
  5792. <p class="body">COS(value)</p>
  5793. <p class="body">Value is the angle measured in radians for which you want
  5794. to take the cosine. If your argument must be in degrees, multiply it by
  5795. PI()/180 to convert it into radians.</p>
  5796. <p class="body">The cosine is an sinusoidal function with a period of 2*PI()
  5797. radians. It's value is always between 1 and -1. It behaves like the sine function,
  5798. <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionSin">SIN()</see>, with a phase shift (phi) of -PI()/4
  5799. radians.</p>
  5800. <p class="body">The cosine function value derives from the geometric ratio
  5801. between the length of the adjacent (non-hypotenuse) leg to the hypotenuse of
  5802. a right triangle, when the hypotenuse has a length of one. It is continuous
  5803. because at intervals of PI() radians the length of the adjacent leg and the
  5804. hypotenuse are equal.</p>
  5805. <p class="body">Another way of looking at this function is to imagine the
  5806. hypotenuse is the radius, r, of a unit circle centered on a Cartesian plane
  5807. with x- and y- axes. At any point on the edge of the unit circle, the
  5808. hypotenuse makes an angle, theta, with the x-axis. The cosine function
  5809. value of the angle theta is the distance from the center of the circle
  5810. to the point in the direction of the x-axis. Applied in this fashion,
  5811. the COS() function can be used to convert between Cartesian and Polar
  5812. coordinate systems.</p>
  5813. <p class="body">Both interpretations are equivalent because if you drop
  5814. a line from a point on the unit circle that intersects the x-axis at a
  5815. right angle you form a right triangle.</p>
  5816. <p class="body">These trigonometric concepts appear frequently in many
  5817. engineering, architectural and scientific applications.</p>
  5818. </remarks>
  5819. </member>
  5820. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionCos.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  5821. <summary>
  5822. Evaluates the function against the arguments on the number stack
  5823. </summary>
  5824. <param name="numberStack">Formula number stack containing function arguments</param>
  5825. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  5826. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  5827. </member>
  5828. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionCos.Name">
  5829. <summary>
  5830. Function name used to reference the function in a formula
  5831. </summary>
  5832. </member>
  5833. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionCos.MinArgs">
  5834. <summary>
  5835. Minimum number of arguments required for the function
  5836. </summary>
  5837. </member>
  5838. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionCos.MaxArgs">
  5839. <summary>
  5840. Maximum number of arguments required for the function
  5841. </summary>
  5842. </member>
  5843. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionACos">
  5844. <summary>
  5845. Returns the angle (measured in radians) having the specified value of the trigonometric cosine function.
  5846. </summary>
  5847. <remarks>
  5848. <p class="body">ACOS(value)</p>
  5849. <p class="body">Value is the real number result of the cosine function taken of an angle you want
  5850. to find. The legal values of the cosine function are from -1 to 1. An inverse cosine
  5851. by default will return the normal angle from 0 up to PI. This is because there are
  5852. several angles which may have an identical value of their cosine. For example, the
  5853. angles -PI/2, PI/2, 3PI/2, etc., all have a cosine of zero. You can find alternate
  5854. angles by adding (or subtracting) any multiple of PI radians to the normal angle
  5855. returned by the inverse cosine function.</p>
  5856. <p class="body">You can convert the result of the inverse cosine function from
  5857. radians into degrees by multiplying it by 180/PI().</p>
  5858. </remarks>
  5859. </member>
  5860. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionACos.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  5861. <summary>
  5862. Evaluates the function against the arguments on the number stack
  5863. </summary>
  5864. <param name="numberStack">Formula number stack containing function arguments</param>
  5865. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  5866. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  5867. </member>
  5868. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionACos.Name">
  5869. <summary>
  5870. Function name used to reference the function in a formula
  5871. </summary>
  5872. </member>
  5873. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionACos.MinArgs">
  5874. <summary>
  5875. Minimum number of arguments required for the function
  5876. </summary>
  5877. </member>
  5878. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionACos.MaxArgs">
  5879. <summary>
  5880. Maximum number of arguments required for the function
  5881. </summary>
  5882. </member>
  5883. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionCosh">
  5884. <summary>
  5885. Returns the angle (measured in radians) having the specified value of it's hyperbolic cosine function.
  5886. </summary>
  5887. <remarks>
  5888. <p class="body">ACOSH(value)</p>
  5889. <p class="body">Value is the hyperbolic cosine of some angle (measured in radians) that you want
  5890. to find. As you might expect, the values of the hyperbolic cosine function (see the <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionCosh">COSH</see> function)
  5891. increase at a hyperbolic rate, but one consequence is that these ever larger changes in the hyperbolic
  5892. cosine will correspond to ever smaller changes in the angle. This relationship is intrinsic to many of
  5893. the mathematical and engineering applications of the inverse hyperbolic cosine function, such as when
  5894. resistance or strain builds up on a body increasingly as it is rotated (hysteresis).</p>
  5895. </remarks>
  5896. </member>
  5897. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionCosh.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  5898. <summary>
  5899. Evaluates the function against the arguments on the number stack
  5900. </summary>
  5901. <param name="numberStack">Formula number stack containing function arguments</param>
  5902. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  5903. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  5904. </member>
  5905. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionCosh.Name">
  5906. <summary>
  5907. Function name used to reference the function in a formula
  5908. </summary>
  5909. </member>
  5910. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionCosh.MinArgs">
  5911. <summary>
  5912. Minimum number of arguments required for the function
  5913. </summary>
  5914. </member>
  5915. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionCosh.MaxArgs">
  5916. <summary>
  5917. Maximum number of arguments required for the function
  5918. </summary>
  5919. </member>
  5920. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionSin">
  5921. <summary>
  5922. Calculates the trigonometric sine of a specified angle (measured in
  5923. radians).
  5924. </summary>
  5925. <remarks>
  5926. <p class="body">SIN(value)</p>
  5927. <p class="body">Value is the angle measured in radians for which you want
  5928. to take the cosine. If your argument must be in degrees, multiply it by
  5929. PI()/180 to convert it into radians.</p>
  5930. <p class="body">The sine is an sinusoidal function with a period of 2*PI()
  5931. radians. It's value is always between 1 and -1.</p>
  5932. <p class="body">The sine function value derives from the geometric ratio
  5933. between the length of a right triangle's hypotenuse and the length of the
  5934. opposite leg, when the hypotenuse has a length of one. It is a continuous
  5935. function because at intervals of PI() radians the length of the opposite
  5936. leg and the hypotenuse are equal.</p>
  5937. <p class="body">Another way of looking at this function is to imagine the
  5938. hypotenuse is the radius, r, of a unit circle centered on a Cartesian plane
  5939. with x- and y- axes. At any point on the edge of the unit circle, the
  5940. hypotenuse makes an angle, theta, with the x-axis. The sine function
  5941. value of the angle theta is the distance from the center of the circle
  5942. to the point in the direction of the y-axis. Applied in this fashion,
  5943. the SIN() function can be used to convert between Cartesian and Polar
  5944. coordinate systems.</p>
  5945. <p class="body">Both interpretations are equivalent because if you drop a
  5946. line from a point on the unit circle that intersects the y-axis at a right
  5947. angle you form a right triangle.</p>
  5948. <p class="body">These trigonometric concepts appear frequently in many
  5949. engineering, architectural and scientific applications.</p>
  5950. <seealso cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionCos">COS()</seealso>
  5951. </remarks>
  5952. </member>
  5953. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionSin.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  5954. <summary>
  5955. Evaluates the function against the arguments on the number stack
  5956. </summary>
  5957. <param name="numberStack">Formula number stack containing function arguments</param>
  5958. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  5959. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  5960. </member>
  5961. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSin.Name">
  5962. <summary>
  5963. Function name used to reference the function in a formula
  5964. </summary>
  5965. </member>
  5966. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSin.MinArgs">
  5967. <summary>
  5968. Minimum number of arguments required for the function
  5969. </summary>
  5970. </member>
  5971. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSin.MaxArgs">
  5972. <summary>
  5973. Maximum number of arguments required for the function
  5974. </summary>
  5975. </member>
  5976. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionSinh">
  5977. <summary>
  5978. Calculates the hyperbolic sine of a specified angle measured in radians.
  5979. </summary>
  5980. <remarks>
  5981. <p class="body">SINH(value)</p>
  5982. <p class="body">Value is an angle measured in radians for which you want to
  5983. calculate the hyperbolic sine. If your angle is measured in degrees,
  5984. multiply it by PI()/180 to convert into radians. </p>
  5985. <p class="body">Many applications in mathematics and physics, for example
  5986. determining the gravitational potential of a cylinder, make use of the
  5987. hyperbolic sine function's characteristics.</p>
  5988. </remarks>
  5989. </member>
  5990. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionSinh.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  5991. <summary>
  5992. Evaluates the function against the arguments on the number stack
  5993. </summary>
  5994. <param name="numberStack">Formula number stack containing function arguments</param>
  5995. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  5996. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  5997. </member>
  5998. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSinh.Name">
  5999. <summary>
  6000. Function name used to reference the function in a formula
  6001. </summary>
  6002. </member>
  6003. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSinh.MinArgs">
  6004. <summary>
  6005. Minimum number of arguments required for the function
  6006. </summary>
  6007. </member>
  6008. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSinh.MaxArgs">
  6009. <summary>
  6010. Maximum number of arguments required for the function
  6011. </summary>
  6012. </member>
  6013. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionASin">
  6014. <summary>
  6015. Returns the angle (measured in radians) having the specified value of the trigonometric sine function.
  6016. </summary>
  6017. <remarks>
  6018. <p class="body">ASIN(value)</p>
  6019. <p class="body">Value is the sine value of the angle you want. Legal sine values are
  6020. confined to real numbers from -1 to 1, inclusive.</p>
  6021. <p class="body">The angle returned will be between -PI()/2 and PI()/2 radians. To convert
  6022. this angle into degrees, multiply by PI()/180.</p>
  6023. </remarks>
  6024. </member>
  6025. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionASin.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  6026. <summary>
  6027. Evaluates the function against the arguments on the number stack
  6028. </summary>
  6029. <param name="numberStack">Formula number stack containing function arguments</param>
  6030. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  6031. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  6032. </member>
  6033. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionASin.Name">
  6034. <summary>
  6035. Function name used to reference the function in a formula
  6036. </summary>
  6037. </member>
  6038. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionASin.MinArgs">
  6039. <summary>
  6040. Minimum number of arguments required for the function
  6041. </summary>
  6042. </member>
  6043. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionASin.MaxArgs">
  6044. <summary>
  6045. Maximum number of arguments required for the function
  6046. </summary>
  6047. </member>
  6048. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionTan">
  6049. <summary>
  6050. Calculates the trigonometric tangent of a specified angle (measured in
  6051. radians).
  6052. </summary>
  6053. <remarks>
  6054. <p class="body">TAN(value)</p>
  6055. <p class="body">Value is the angle measured in radians for which you want
  6056. to take the tangent. If your argument must be in degrees, multiply it by
  6057. PI()/180 to convert it into radians.</p>
  6058. <p class="body">The tangent can have a value from -INF to +INF, however it
  6059. is undefined at intervals of every PI()/2 radians +/- PI() radians.</p>
  6060. <p class="body">The tangent function value derives from a well-known geometric
  6061. ratio between the length of the opposite and the adjacent (non-hypotenuse) leg
  6062. of a right triangle. All 3 angles inside of any triangle must add up to exactly
  6063. PI() radians, and in a right triangle the angle opposite the hypotenuse must be
  6064. PI()/2 radians. Given these facts, it is not possible for either of the other
  6065. two angles within the triangle to reach PI()/2 radians themselves. If you choose
  6066. an angle (other than the triangle's right angle) which approaches PI()/2 radians
  6067. then the remaining angle must approach 0 radians. The tangent function value tells
  6068. you in these circumstances how the leg of the right triangle opposite your angle
  6069. approaches infinite length. These calculations have important applications in
  6070. architecture and engineering.</p>
  6071. </remarks>
  6072. </member>
  6073. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionTan.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  6074. <summary>
  6075. Evaluates the function against the arguments on the number stack
  6076. </summary>
  6077. <param name="numberStack">Formula number stack containing function arguments</param>
  6078. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  6079. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  6080. </member>
  6081. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionTan.Name">
  6082. <summary>
  6083. Function name used to reference the function in a formula
  6084. </summary>
  6085. </member>
  6086. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionTan.MinArgs">
  6087. <summary>
  6088. Minimum number of arguments required for the function
  6089. </summary>
  6090. </member>
  6091. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionTan.MaxArgs">
  6092. <summary>
  6093. Maximum number of arguments required for the function
  6094. </summary>
  6095. </member>
  6096. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionTanh">
  6097. <summary>
  6098. Calculates the hyperbolic tangent of a specified angle measured in radians.
  6099. </summary>
  6100. <remarks>
  6101. <p class="body">TANH(value)</p>
  6102. <p class="body">Value is an angle measured in radians for which you want to
  6103. calculate the hyperbolic tangent. If your angle is measured in degrees,
  6104. multiply it by PI()/180 to convert into radians. The hyperbolic tangent
  6105. has a range from -1 to 1.</p>
  6106. </remarks>
  6107. </member>
  6108. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionTanh.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  6109. <summary>
  6110. Evaluates the function against the arguments on the number stack
  6111. </summary>
  6112. <param name="numberStack">Formula number stack containing function arguments</param>
  6113. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  6114. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  6115. </member>
  6116. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionTanh.Name">
  6117. <summary>
  6118. Function name used to reference the function in a formula
  6119. </summary>
  6120. </member>
  6121. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionTanh.MinArgs">
  6122. <summary>
  6123. Minimum number of arguments required for the function
  6124. </summary>
  6125. </member>
  6126. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionTanh.MaxArgs">
  6127. <summary>
  6128. Maximum number of arguments required for the function
  6129. </summary>
  6130. </member>
  6131. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionATan">
  6132. <summary>
  6133. Calculates the normalized angle (measured in radians) which has the
  6134. specified tangent function value.
  6135. </summary>
  6136. <remarks>
  6137. <p class="body">ATAN(value)</p>
  6138. <p class="body">Value is a number containing a tangent function value
  6139. that you want to retrieve the angle of. This function returns an angle
  6140. of between PI()/2 and -PI()/2. Although the tangent function is undefined
  6141. for values of PI()/2 and -PI()/2, the return value of this function is
  6142. rounded to these values if <em>Value</em> is +INF or -INF, respectively.</p>
  6143. <p class="body">This function is sometimes referred to as the inverse
  6144. tangent function or the arctangent.</p>
  6145. <p class="body">The angle returned is the principal value, as
  6146. there exist an uncountable number of alternative angles satisfying
  6147. the requirement of having <em>Value</em> as their tangent function
  6148. value, at regular intervals of +/- PI() to either side of this
  6149. principal value.</p>
  6150. <p class="body">If you require a result in degrees, multiply the
  6151. arctangent by 180/PI().</p>
  6152. </remarks>
  6153. </member>
  6154. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionATan.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  6155. <summary>
  6156. Evaluates the function against the arguments on the number stack
  6157. </summary>
  6158. <param name="numberStack">Formula number stack containing function arguments</param>
  6159. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  6160. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  6161. </member>
  6162. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionATan.Name">
  6163. <summary>
  6164. Function name used to reference the function in a formula
  6165. </summary>
  6166. </member>
  6167. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionATan.MinArgs">
  6168. <summary>
  6169. Minimum number of arguments required for the function
  6170. </summary>
  6171. </member>
  6172. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionATan.MaxArgs">
  6173. <summary>
  6174. Maximum number of arguments required for the function
  6175. </summary>
  6176. </member>
  6177. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionATan2">
  6178. <summary>
  6179. Calculates the angle made with the x-axis on a Cartesian coordinate
  6180. plane by the specified (x, y) coordinates.
  6181. </summary>
  6182. <remarks>
  6183. <p class="body">ATAN2(x_ordinate, y_abscissa)</p>
  6184. <p class="body">X_ordinate is a number representing the distance along
  6185. the x-axis of a Cartesian point. It may also be thought of as the
  6186. adjacent leg of a right triangle, where the right angle is made by
  6187. dropping a perpendicular line from (<em>x_ordinate</em>, <em>y_abscissa</em>)
  6188. to the point (<em>x_ordinate</em>, 0) on the x-axis.</p>
  6189. <p class="body">Y_abscissa is a number representing the distance along
  6190. the y-axis of a Cartesian point. It may also be thought of as the
  6191. opposite leg of the right triangle constructed above.</p>
  6192. <p class="body">This variation on the arctangent (or inverse tangent function)
  6193. calculates for you the angle, theta, made with the x-axis when you extend a
  6194. line segment from the origin at (0, 0) to your specified coordinates at
  6195. (<em>x_ordinate</em>, <em>y_abscissa</em>). This line segment can also be
  6196. seen to be the hypotenuse of a right triangle, or the radius of the circle
  6197. on which the point, (<em>x_ordinate</em>, <em>y_abscissa</em>), sits on
  6198. the edge. This function is another way of looking at the trigonometric
  6199. tangent function value that is useful in many UltraCalc applications
  6200. because it affords you a more convenient parameterization for some tasks,
  6201. such as converting from Cartesian to Polar coordinate systems.</p>
  6202. <p class="body">The return value of this function is within the range of
  6203. PI()/2 and -PI()/2 measured in radians. If you need to convert this value
  6204. into degrees then multiply the result by 180/PI().</p>
  6205. <seealso cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionATan">ATAN()</seealso>
  6206. <seealso cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionTan">TAN()</seealso>
  6207. </remarks>
  6208. </member>
  6209. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionATan2.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  6210. <summary>
  6211. Evaluates the function against the arguments on the number stack
  6212. </summary>
  6213. <param name="numberStack">Formula number stack containing function arguments</param>
  6214. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  6215. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  6216. </member>
  6217. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionATan2.Name">
  6218. <summary>
  6219. Function name used to reference the function in a formula
  6220. </summary>
  6221. </member>
  6222. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionATan2.MinArgs">
  6223. <summary>
  6224. Minimum number of arguments required for the function
  6225. </summary>
  6226. </member>
  6227. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionATan2.MaxArgs">
  6228. <summary>
  6229. Maximum number of arguments required for the function
  6230. </summary>
  6231. </member>
  6232. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionFloor">
  6233. <summary>
  6234. Calculates the next lesser whole number for a specified numeric
  6235. value.
  6236. </summary>
  6237. <remarks>
  6238. <p class="body">FLOOR(value)</p>
  6239. <p class="body">Value is a real numeric value to be rounded down
  6240. to the next lesser whole number (also called an integer). FLOOR()
  6241. behaves differently from the <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionInt">INT()</see>
  6242. function because when <em>value</em> is negative, the "next lesser
  6243. whole number" will be a number having greater magnitude (i.e., it
  6244. becomes more negative.)</p>
  6245. </remarks>
  6246. </member>
  6247. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionFloor.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  6248. <summary>
  6249. Evaluates the function against the arguments on the number stack
  6250. </summary>
  6251. <param name="numberStack">Formula number stack containing function arguments</param>
  6252. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  6253. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  6254. </member>
  6255. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionFloor.Name">
  6256. <summary>
  6257. Function name used to reference the function in a formula
  6258. </summary>
  6259. </member>
  6260. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionFloor.MinArgs">
  6261. <summary>
  6262. Minimum number of arguments required for the function
  6263. </summary>
  6264. </member>
  6265. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionFloor.MaxArgs">
  6266. <summary>
  6267. Maximum number of arguments required for the function
  6268. </summary>
  6269. </member>
  6270. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionCeiling">
  6271. <summary>
  6272. Returns the smallest whole number greater than or equal to the given number
  6273. </summary>
  6274. <remarks>
  6275. <p class="body">
  6276. CEILING(number)
  6277. <p></p>
  6278. Number is the numeric value you want to round.
  6279. </p>
  6280. </remarks>
  6281. </member>
  6282. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionCeiling.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  6283. <summary>
  6284. Evaluates the function against the arguments on the number stack
  6285. </summary>
  6286. <param name="numberStack">Formula number stack containing function arguments</param>
  6287. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  6288. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  6289. </member>
  6290. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionCeiling.Name">
  6291. <summary>
  6292. Function name used to reference the function in a formula
  6293. </summary>
  6294. </member>
  6295. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionCeiling.MinArgs">
  6296. <summary>
  6297. Minimum number of arguments required for the function
  6298. </summary>
  6299. </member>
  6300. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionCeiling.MaxArgs">
  6301. <summary>
  6302. Maximum number of arguments required for the function
  6303. </summary>
  6304. </member>
  6305. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionRand">
  6306. <summary>
  6307. Generates a pseudorandom number from zero up to (but not including) one.
  6308. </summary>
  6309. <remarks>
  6310. <p class="body">RAND()</p>
  6311. <p>The RAND() function will generate another pseudorandom number each time it
  6312. is evaluated. It returns a fractional number on a unit basis, therefore
  6313. you can use RAND() to produce numbers between 0 and <em>C</em> by multiplying
  6314. the RAND() result by <em>C</em>. It follows that to produce a pseudorandom
  6315. number between <em>A</em> and <em>B</em> you could translate the result by
  6316. <em>A</em> like this:</p>
  6317. <code>RAND() * ( [B] - [A] ) + [A]</code>
  6318. <p class="body">The number generation of the RAND() function derives from the
  6319. system clock, and therefore may not be entirely random. It should not be used
  6320. for applications requiring cryptographically-strong randomness or uniform
  6321. probability distributions.</p>
  6322. </remarks>
  6323. </member>
  6324. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionRand.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  6325. <summary>
  6326. Evaluates the function against the arguments on the number stack
  6327. </summary>
  6328. <param name="numberStack">Formula number stack containing function arguments</param>
  6329. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  6330. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  6331. </member>
  6332. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRand.IsAlwaysDirty">
  6333. <summary>
  6334. Indicates whether the results of the function is always dirty.
  6335. </summary>
  6336. </member>
  6337. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRand.Name">
  6338. <summary>
  6339. Function name used to reference the function in a formula
  6340. </summary>
  6341. </member>
  6342. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRand.MinArgs">
  6343. <summary>
  6344. Minimum number of arguments required for the function
  6345. </summary>
  6346. </member>
  6347. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRand.MaxArgs">
  6348. <summary>
  6349. Maximum number of arguments required for the function
  6350. </summary>
  6351. </member>
  6352. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionLn">
  6353. <summary>
  6354. Calculates the natural logarithm of a specified numeric value.
  6355. </summary>
  6356. <remarks>
  6357. <p class="body">LN(value)</p>
  6358. <p class="body">Value is a real number to calculate the natural
  6359. logarithm of. <em>Value</em> must be positive as the logarithm
  6360. is undefined for negative values.</p>
  6361. <p class="body">A natural logarithm is a special case of a logarithm
  6362. having the base of Euler's Number, e (2.71828...). It is the inverse
  6363. of the <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionExp">EXP()</see> function.</p>
  6364. <p class="body">Logarithms have many applications in mathematics,
  6365. life and social sciences.</p>
  6366. </remarks>
  6367. </member>
  6368. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionLn.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  6369. <summary>
  6370. Evaluates the function against the arguments on the number stack
  6371. </summary>
  6372. <param name="numberStack">Formula number stack containing function arguments</param>
  6373. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  6374. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  6375. </member>
  6376. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionLn.Name">
  6377. <summary>
  6378. Function name used to reference the function in a formula
  6379. </summary>
  6380. </member>
  6381. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionLn.MinArgs">
  6382. <summary>
  6383. Minimum number of arguments required for the function
  6384. </summary>
  6385. </member>
  6386. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionLn.MaxArgs">
  6387. <summary>
  6388. Maximum number of arguments required for the function
  6389. </summary>
  6390. </member>
  6391. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionLog10">
  6392. <summary>
  6393. Calculates the logarithm (base 10) of a specified numeric value.
  6394. </summary>
  6395. <remarks>
  6396. <p class="body">LOG10(value)</p>
  6397. <p class="body">Value is a real number to calculate the decimal
  6398. logarithm of. <em>Value</em> must be positive as the logarithm
  6399. is undefined for negative values.</p>
  6400. <p class="body">To specify your own base for a logarithm use the
  6401. <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionLog">LOG()</see> function. To calculate
  6402. the natural logarithm use the <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionLn">LN()</see>
  6403. function.</p>
  6404. </remarks>
  6405. </member>
  6406. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionLog10.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  6407. <summary>
  6408. Evaluates the function against the arguments on the number stack
  6409. </summary>
  6410. <param name="numberStack">Formula number stack containing function arguments</param>
  6411. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  6412. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  6413. </member>
  6414. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionLog10.Name">
  6415. <summary>
  6416. Function name used to reference the function in a formula
  6417. </summary>
  6418. </member>
  6419. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionLog10.MinArgs">
  6420. <summary>
  6421. Minimum number of arguments required for the function
  6422. </summary>
  6423. </member>
  6424. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionLog10.MaxArgs">
  6425. <summary>
  6426. Maximum number of arguments required for the function
  6427. </summary>
  6428. </member>
  6429. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionLog">
  6430. <summary>
  6431. Calculates a logarithm for a specified numeric value to the
  6432. specified base.
  6433. </summary>
  6434. <remarks>
  6435. <p class="body">LOG(value, base)</p>
  6436. <p class="body">Value is a real number that you want to calculate the logarithm
  6437. to <em>base</em> for. This number must be positive, as the logarithm
  6438. is undefined for negative numbers.</p>
  6439. <p class="body">Base is the base of the logarithm, which defaults to 10.</p>
  6440. <p class="body">To calculate the natural logarithm (a logarithm to the base
  6441. of Euler's Number, e) it is usually more convenient to call the <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionLn">LN()</see>
  6442. function.</p>
  6443. </remarks>
  6444. </member>
  6445. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionLog.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  6446. <summary>
  6447. Evaluates the function against the arguments on the number stack
  6448. </summary>
  6449. <param name="numberStack">Formula number stack containing function arguments</param>
  6450. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  6451. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  6452. </member>
  6453. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionLog.Name">
  6454. <summary>
  6455. Function name used to reference the function in a formula
  6456. </summary>
  6457. </member>
  6458. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionLog.MinArgs">
  6459. <summary>
  6460. Minimum number of arguments required for the function
  6461. </summary>
  6462. </member>
  6463. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionLog.MaxArgs">
  6464. <summary>
  6465. Maximum number of arguments required for the function
  6466. </summary>
  6467. </member>
  6468. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionNPV">
  6469. <summary>
  6470. Calculates an investment's Net Present Value given it's expected rate or return and the cash flow
  6471. represented as positive numeric values (income) and negative numeric values (payments).
  6472. </summary>
  6473. <remarks>
  6474. <p class="body">NPV(discountRate, value1, value2, ..., valueN)</p>
  6475. <p class="body">DiscountRate is the investment's expected rate of return over the life of the
  6476. investment, expressed as a percentage growth (or decline) per payment period. In some applications
  6477. this may be the fixed interest rate. This numeric value is used to discount cash flows paid into or
  6478. received from the investment.</p>
  6479. <p class="body">Value1, value2, ... valueN are any number of numeric values representing cash inflows
  6480. (as positive numbers) or cash outflows (as negative numbers). These cash flows must occur at a fixed
  6481. period (the same period at which the <em>discountRate</em> is expressed), although some cash flows
  6482. may be zero. The order of the sequence is important, as <em>value1</em> is assumed to occur (<em>N</em>-1)
  6483. periods before <em>valueN</em> and will have been able to accrue that much more interest at the assumed
  6484. <em>discountRate</em>.</p>
  6485. <p class="body">By convention, the NPV() assumes cash flows occur at the end of each period. Consequently,
  6486. the NPV() represents the present value as of the date one period's length before the first cash flow,
  6487. <em>value1</em>, has been made. If you require flexibility in when cash flows occur (the beginning or
  6488. end of each period), consider using the <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionPV">PV()</see> function. However,
  6489. it differs from NPV() in that NPV() allows cash flows of different amounts.</p>
  6490. <p class="body">Only numeric values or text values convertible to numeric values may be passed to this
  6491. function. If a column or range reference is passed as a <em>value</em> argument, only numeric values or
  6492. text values convertible to numeric values are used.</p>
  6493. <seealso cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionIRR">IRR()</seealso>
  6494. </remarks>
  6495. </member>
  6496. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionNPV.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  6497. <summary>
  6498. Evaluates the function against the arguments on the number stack
  6499. </summary>
  6500. <param name="numberStack">Formula number stack containing function arguments</param>
  6501. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  6502. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  6503. </member>
  6504. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionNPV.Name">
  6505. <summary>
  6506. Function name used to reference the function in a formula
  6507. </summary>
  6508. </member>
  6509. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionNPV.MinArgs">
  6510. <summary>
  6511. Minimum number of arguments required for the function
  6512. </summary>
  6513. </member>
  6514. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionNPV.MaxArgs">
  6515. <summary>
  6516. Maximum number of arguments required for the function
  6517. </summary>
  6518. </member>
  6519. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionFV">
  6520. <summary>
  6521. Calculates the future value of an annuity having fixed payments and assuming
  6522. a fixed interest rate or rate of return.
  6523. </summary>
  6524. <remarks>
  6525. <p class="body">FV(interestRate, nPeriod, payment, presentValue, paymentDue)</p>
  6526. <p class="body">InterestRate is the assumed interest rate per period. The future
  6527. value calculation assumes no change in the interest rate over the course of the
  6528. investment. If you anticipate interest rate fluctuations, you should calculate
  6529. the future value incrementally over shorter periods in which the interest rate
  6530. is held constant. In some calculations, the <em>interestRate</em> may be
  6531. synonymous with an investments' expected growth or rate of return per period.</p>
  6532. <p class="body">NPeriod is the total number of payment periods in an annuity.
  6533. Each payment is assumed to be of the same amount, and occur at regular fixed
  6534. time intervals. A payment earlier in the annuity will be invested for a longer
  6535. period of time and therefore would accrue more interest than a payment made
  6536. later in the annuity.</p>
  6537. <p class="body">Payment is a fixed amount invested in the annuity at each
  6538. period. Use a negative number to represent an outflow of cash paid out, and a
  6539. positive number to represent an inflow of cash received. Calculating a future
  6540. value requires either a non-zero series of payments or a <em>presentValue</em>.</p>
  6541. <p class="body">PresentValue is the value of the investment at the beginning of
  6542. the annuity. It represents the discounted value of a series of future payments,
  6543. which over time could be worth a greater amount because they have accrued interest.
  6544. If the annuity has no present value, then you must specify a non-zero <em>payment</em>
  6545. amount.</p>
  6546. <p class="body">PaymentDue is a numeric value of either 1 or 0, and indicates whether
  6547. payments are invested in the annuity at the beginning of each period (1) or at the end
  6548. of each period (0).</p>
  6549. <p class="body">The <em>interestRate</em> and <em>nPeriod</em> arguments determine the
  6550. frequency of payments. If <em>interestRate</em> is given as an annual rate, and <em>nPeriod</em>
  6551. is 1 then payments are once per year. On the other hand, if <em>nPeriod</em> had been 4 then
  6552. payments would occur quarterly. Please ensure you use consistent time values when specifying
  6553. these arguments.</p>
  6554. </remarks>
  6555. </member>
  6556. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionFV.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  6557. <summary>
  6558. Evaluates the function against the arguments on the number stack
  6559. </summary>
  6560. <param name="numberStack">Formula number stack containing function arguments</param>
  6561. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  6562. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  6563. </member>
  6564. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionFV.Name">
  6565. <summary>
  6566. Function name used to reference the function in a formula
  6567. </summary>
  6568. </member>
  6569. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionFV.MinArgs">
  6570. <summary>
  6571. Minimum number of arguments required for the function
  6572. </summary>
  6573. </member>
  6574. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionFV.MaxArgs">
  6575. <summary>
  6576. Maximum number of arguments required for the function
  6577. </summary>
  6578. </member>
  6579. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionPV">
  6580. <summary>
  6581. Calculates an investment's present value by discounting what a series of fixed future payments is worth
  6582. at a specified interest rate.
  6583. </summary>
  6584. <remarks>
  6585. <p class="body">PV(interestRate, nPeriods, amount, futureValue, paymentDue)</p>
  6586. <p class="body">InterestRate is the per-period rate of interest used to discount the future payments. For
  6587. positive interest rates, the value of future payments diminishes (discounts) to what they are worth now.
  6588. It is assumed you can reinvest the present value at <em>interestRate</em> to receive <em>futureValue</em>
  6589. after <em>nPeriods</em>.</p>
  6590. <p class="body">NPeriods are the total number of payment periods over the course of the annuity. If your
  6591. retirement plan annuitizes in 35-years, and you make a fixed quarterly contribution into it, then you
  6592. would use 35x4 or 140 as your total number of payment periods.</p>
  6593. <p class="body">Amount is how much is paid (or received) each period. This <em>amount</em> must be constant
  6594. over the course of the investment. If you need to calculate the Net Present Value of a series of variable
  6595. payment amounts, then you should consider using the <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionNPV">NPV()</see> function.</p>
  6596. <p class="body">FutureValue is the expected cash balance of the investment at culmination. If this argument
  6597. is omitted, it will be assumed to be zero. In the common usage scenario of calculating loan repayments, a
  6598. future value of zero represents having a zero liability when the loan is fully repaid. When specifying a
  6599. zero future value, ensure that <em>amount</em> is non-zero (otherwise the loan could never be repaid). In
  6600. retirement planning, you would normally estimate the future value you would like to have when you retire.
  6601. </p>
  6602. <p class="body">PaymentDue is a numeric value of either 1 or 0, and indicates whether
  6603. payments are invested in the annuity at the beginning of each period (1) or at the end
  6604. of each period (0).</p>
  6605. </remarks>
  6606. </member>
  6607. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionPV.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  6608. <summary>
  6609. Evaluates the function against the arguments on the number stack
  6610. </summary>
  6611. <param name="numberStack">Formula number stack containing function arguments</param>
  6612. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  6613. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  6614. </member>
  6615. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionPV.Name">
  6616. <summary>
  6617. Function name used to reference the function in a formula
  6618. </summary>
  6619. </member>
  6620. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionPV.MinArgs">
  6621. <summary>
  6622. Minimum number of arguments required for the function
  6623. </summary>
  6624. </member>
  6625. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionPV.MaxArgs">
  6626. <summary>
  6627. Maximum number of arguments required for the function
  6628. </summary>
  6629. </member>
  6630. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionPmt">
  6631. <summary>
  6632. Calculates what the payment amount should be on a loan at a fixed interest rate requiring
  6633. a fixed number of payments.
  6634. </summary>
  6635. <remarks>
  6636. <p class="body">PMT(interestRate, nPeriods, presentValue, futureValue, paymentDue)</p>
  6637. <p class="body">InterestRate is the interest rate for the loan.</p>
  6638. <p class="body">NPeriods is the number of payments required to pay back the loan.</p>
  6639. <p class="body">PresentValue is the current value of the loan (also called the principal),
  6640. which is a lump sum that the future series of <em>nPeriods</em> payments (which accumulate
  6641. interest at <em>interestRate</em>) is worth today.</p>
  6642. <p class="body">FutureValue is the cash balance in the future (for a loan, this will typically
  6643. be a loan liability balance of zero) following this series of fixed payments, accruing a fixed
  6644. <em>interestRate</em>. If omitted, a default future value of 0 is used.</p>
  6645. <p class="body">PaymentDue is a numeric value of either 1 or 0, and indicates whether
  6646. payments are invested in the annuity at the beginning of each period (1) or at the end
  6647. of each period (0).</p>
  6648. </remarks>
  6649. </member>
  6650. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionPmt.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  6651. <summary>
  6652. Evaluates the function against the arguments on the number stack
  6653. </summary>
  6654. <param name="numberStack">Formula number stack containing function arguments</param>
  6655. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  6656. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  6657. </member>
  6658. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionPmt.Name">
  6659. <summary>
  6660. Function name used to reference the function in a formula
  6661. </summary>
  6662. </member>
  6663. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionPmt.MinArgs">
  6664. <summary>
  6665. Minimum number of arguments required for the function
  6666. </summary>
  6667. </member>
  6668. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionPmt.MaxArgs">
  6669. <summary>
  6670. Maximum number of arguments required for the function
  6671. </summary>
  6672. </member>
  6673. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionNPer">
  6674. <summary>
  6675. Calculates an investment's number of payment periods when the payment frequency, amount,
  6676. and interest rate are held steady.
  6677. </summary>
  6678. <remarks>
  6679. <p class="body">NPER(interestRate, amount, presentValue, futureValue, paymentDue)</p>
  6680. <p class="body">InterestRate is the rate of interest per payment period. This numeric
  6681. value must be held fixed for the duration of the investment. If you must calculate
  6682. financing based on changes in interest rate then you will need to break up the
  6683. calculation into several stages over which the interest rate is held constant.</p>
  6684. <p class="body">Amount is the payment amount due each period. This numeric value must
  6685. be constant over the duration of the investment.</p>
  6686. <p class="body">PresentValue is a discounted value or lump sum payment that if taken today
  6687. and invested at the <em>interestRate</em> would be worth the same as this series of fixed
  6688. payments in the future.</p>
  6689. <p class="body">FutureValue is the value after the last payment has been made. If this
  6690. numeric value is omitted it is assumed to be zero (since this function is normally used
  6691. in calculating loan repayment you will reach zero liability when the loan is finally
  6692. paid off.)</p>
  6693. <p class="body">PaymentDue indicates whether payments come due at the beginning of each
  6694. payment period (1) or at the end of each payment period (0). If left unspecified, the
  6695. default is to assume <em>paymentDue</em> occurs at the end of each payment period.</p>
  6696. </remarks>
  6697. </member>
  6698. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionNPer.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  6699. <summary>
  6700. Evaluates the function against the arguments on the number stack
  6701. </summary>
  6702. <param name="numberStack">Formula number stack containing function arguments</param>
  6703. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  6704. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  6705. </member>
  6706. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionNPer.Name">
  6707. <summary>
  6708. Function name used to reference the function in a formula
  6709. </summary>
  6710. </member>
  6711. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionNPer.MinArgs">
  6712. <summary>
  6713. Minimum number of arguments required for the function
  6714. </summary>
  6715. </member>
  6716. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionNPer.MaxArgs">
  6717. <summary>
  6718. Maximum number of arguments required for the function
  6719. </summary>
  6720. </member>
  6721. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionEven">
  6722. <summary>
  6723. Rounds a positive number up and a negative number down to the nearest even integer.
  6724. </summary>
  6725. <remarks>
  6726. <p class="body">
  6727. EVEN(Number)
  6728. <p></p>
  6729. Number is the value to round.
  6730. </p>
  6731. </remarks>
  6732. </member>
  6733. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionEven.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  6734. <summary>
  6735. Evaluates the function against the arguments on the number stack
  6736. </summary>
  6737. <param name="numberStack">Formula number stack containing function arguments</param>
  6738. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  6739. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  6740. </member>
  6741. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionEven.Name">
  6742. <summary>
  6743. Function name used to reference the function in a formula
  6744. </summary>
  6745. </member>
  6746. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionEven.MinArgs">
  6747. <summary>
  6748. Minimum number of arguments required for the function
  6749. </summary>
  6750. </member>
  6751. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionEven.MaxArgs">
  6752. <summary>
  6753. Maximum number of arguments required for the function
  6754. </summary>
  6755. </member>
  6756. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionOdd">
  6757. <summary>
  6758. Rounds a positive number up and a negative number down to the nearest odd integer.
  6759. </summary>
  6760. <remarks>
  6761. <p class="body">
  6762. ODD(Number)
  6763. <p></p>
  6764. Number is the value to round.
  6765. </p>
  6766. </remarks>
  6767. </member>
  6768. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionOdd.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  6769. <summary>
  6770. Evaluates the function against the arguments on the number stack
  6771. </summary>
  6772. <param name="numberStack">Formula number stack containing function arguments</param>
  6773. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  6774. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  6775. </member>
  6776. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionOdd.Name">
  6777. <summary>
  6778. Function name used to reference the function in a formula
  6779. </summary>
  6780. </member>
  6781. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionOdd.MinArgs">
  6782. <summary>
  6783. Minimum number of arguments required for the function
  6784. </summary>
  6785. </member>
  6786. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionOdd.MaxArgs">
  6787. <summary>
  6788. Maximum number of arguments required for the function
  6789. </summary>
  6790. </member>
  6791. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionPPmt">
  6792. <summary>
  6793. Calculates the principal portion of a payment due on an investment or loan with periodic, fixed payments
  6794. and having a fixed rate of interest.
  6795. </summary>
  6796. <remarks>
  6797. <p class="body">PPMT(interestRate, periodNumber, nPeriods, presentValue, futureValue, paymentDue)</p>
  6798. <p class="body">InterestRate is a fixed rate of interest per period. This function assumes there
  6799. is one payment made on each period, therefore in cases where you want to calculate quarterly or
  6800. monthly payments you should adjust an annual <em>interestRate</em> accordingly by dividing it
  6801. by the number of payments per year.</p>
  6802. <p class="body">PeriodNumber identifies the period of the current payment, where the first payment
  6803. has the number 1. The <em>periodNumber</em> must not exceed the total number of periods (<em>nPeriods</em>).</p>
  6804. <p class="body">NPeriods is the total number of payments over the course of this investment or loan.</p>
  6805. <p class="body">PresentValue is the discounted value of this series of future payments, if you could take
  6806. a lump sum payment today and invest it at the fixed <em>interestRate</em> until the future date when this
  6807. investment or loan had been repaid.</p>
  6808. <p class="body">FutureValue is the expected value of this series of payments after the last payment has
  6809. been made, where all previous payments have been accumulating interest at the fixed <em>interestRate</em>.
  6810. When omitted, such as when this function is used for calculating loan payments that reduce an outstanding
  6811. liability, the future value is assumed to be zero.</p>
  6812. <p class="body">PaymentDue is a numeric value indicating that payments are due at the beginning of each period (1)
  6813. or at the end of each period (0).</p>
  6814. <p class="body">The PPMT() function calculates the portion of a fixed payment attributed to principal. If you
  6815. need to calculate the portion of a fixed payment repaying interest then use the <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionIPmt">IPMT()</see>
  6816. function. To calculate fixed payment amounts, use the <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionPmt">PMT()</see> function.</p>
  6817. </remarks>
  6818. </member>
  6819. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionPPmt.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  6820. <summary>
  6821. Evaluates the function against the arguments on the number stack
  6822. </summary>
  6823. <param name="numberStack">Formula number stack containing function arguments</param>
  6824. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  6825. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  6826. </member>
  6827. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionPPmt.Name">
  6828. <summary>
  6829. Function name used to reference the function in a formula
  6830. </summary>
  6831. </member>
  6832. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionPPmt.MinArgs">
  6833. <summary>
  6834. Minimum number of arguments required for the function
  6835. </summary>
  6836. </member>
  6837. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionPPmt.MaxArgs">
  6838. <summary>
  6839. Maximum number of arguments required for the function
  6840. </summary>
  6841. </member>
  6842. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionIPmt">
  6843. <summary>
  6844. Calculates the interest portion of a payment due on an investment or loan with periodic, fixed payments
  6845. and having a fixed rate of interest.
  6846. </summary>
  6847. <remarks>
  6848. <p class="body">IPMT(interestRate, periodNumber, nPeriods, presentValue, futureValue, paymentDue)</p>
  6849. <p class="body">InterestRate is a fixed rate of interest per period. This function assumes there
  6850. is one payment made on each period, therefore in cases where you want to calculate quarterly or
  6851. monthly payments you should adjust an annual <em>interestRate</em> accordingly by dividing it
  6852. by the number of payments per year.</p>
  6853. <p class="body">PeriodNumber identifies the period of the current payment, where the first payment
  6854. has the number 1. The <em>periodNumber</em> must not exceed the total number of periods (<em>nPeriods</em>).</p>
  6855. <p class="body">NPeriods is the total number of payments over the course of this investment or loan.</p>
  6856. <p class="body">PresentValue is the discounted value of this series of future payments, if you could take
  6857. a lump sum payment today and invest it at the fixed <em>interestRate</em> until the future date when this
  6858. investment or loan had been repaid.</p>
  6859. <p class="body">FutureValue is the expected value of this series of payments after the last payment has
  6860. been made, where all previous payments have been accumulating interest at the fixed <em>interestRate</em>.
  6861. When omitted, such as when this function is used for calculating loan payments that reduce an outstanding
  6862. liability, the future value is assumed to be zero.</p>
  6863. <p class="body">PaymentDue is a numeric value indicating that payments are due at the beginning of each period (1)
  6864. or at the end of each period (0).</p>
  6865. <p class="body">The IPMT() function calculates the portion of a fixed payment attributed to interest. If you
  6866. need to calculate the portion of a fixed payment repaying loan principal then use the <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionPPmt">PPMT()</see>
  6867. function. To calculate fixed payment amounts, use the <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionPmt">PMT()</see> function.</p>
  6868. </remarks>
  6869. </member>
  6870. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionIPmt.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  6871. <summary>
  6872. Evaluates the function against the arguments on the number stack
  6873. </summary>
  6874. <param name="numberStack">Formula number stack containing function arguments</param>
  6875. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  6876. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  6877. </member>
  6878. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIPmt.Name">
  6879. <summary>
  6880. Function name used to reference the function in a formula
  6881. </summary>
  6882. </member>
  6883. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIPmt.MinArgs">
  6884. <summary>
  6885. Minimum number of arguments required for the function
  6886. </summary>
  6887. </member>
  6888. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIPmt.MaxArgs">
  6889. <summary>
  6890. Maximum number of arguments required for the function
  6891. </summary>
  6892. </member>
  6893. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionLower">
  6894. <summary>
  6895. Converts a text value to all lowercase letters.
  6896. </summary>
  6897. <remarks>
  6898. <p class="body">LOWER(text_value)</p>
  6899. <p class="body">Text_value is a piece of text you want converted into lowercase. The invariant
  6900. culture is used to translate characters, therefore this function may not be suitable for use
  6901. with localizable text values.</p>
  6902. </remarks>
  6903. </member>
  6904. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionLower.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  6905. <summary>
  6906. Evaluates the function against the arguments on the number stack
  6907. </summary>
  6908. <param name="numberStack">Formula number stack containing function arguments</param>
  6909. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  6910. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  6911. </member>
  6912. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionLower.Name">
  6913. <summary>
  6914. Function name used to reference the function in a formula
  6915. </summary>
  6916. </member>
  6917. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionLower.MinArgs">
  6918. <summary>
  6919. Minimum number of arguments required for the function
  6920. </summary>
  6921. </member>
  6922. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionLower.MaxArgs">
  6923. <summary>
  6924. Maximum number of arguments required for the function
  6925. </summary>
  6926. </member>
  6927. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionUpper">
  6928. <summary>
  6929. Converts all lowercase letters in a text string to uppercase.
  6930. </summary>
  6931. <remarks>
  6932. <p class="body">UPPER(text_value)</p>
  6933. <p class="body">Text_value is the text you want to convert to uppercase. UPPER does not change characters in text that are not letters.</p>
  6934. </remarks>
  6935. </member>
  6936. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionUpper.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  6937. <summary>
  6938. Evaluates the function against the arguments on the number stack
  6939. </summary>
  6940. <param name="numberStack">Formula number stack containing function arguments</param>
  6941. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  6942. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  6943. </member>
  6944. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionUpper.Name">
  6945. <summary>
  6946. Function name used to reference the function in a formula
  6947. </summary>
  6948. </member>
  6949. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionUpper.MinArgs">
  6950. <summary>
  6951. Minimum number of arguments required for the function
  6952. </summary>
  6953. </member>
  6954. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionUpper.MaxArgs">
  6955. <summary>
  6956. Maximum number of arguments required for the function
  6957. </summary>
  6958. </member>
  6959. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionLeft">
  6960. <summary>
  6961. Gets the leftmost characters from a text value, up to the specified number of characters.
  6962. </summary>
  6963. <remarks>
  6964. <p class="body">LEFT(text_value, num_chars)</p>
  6965. <p class="body">Text_value is a piece of text or reference to some text starting with
  6966. a substring you want to retrieve.</p>
  6967. <p class="body">Num_chars indicate the number of characters retrieved from the beginning
  6968. of <em>text_value</em>. An error value is returned if this argument is less than zero.
  6969. If this argument exceeds the length of <em>text_value</em>, then all of <em>text_value</em>
  6970. is retrieved. If omitted, the first character of <em>text_value</em> is retrieved.</p>
  6971. </remarks>
  6972. </member>
  6973. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionLeft.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  6974. <summary>
  6975. Evaluates the function against the arguments on the number stack
  6976. </summary>
  6977. <param name="numberStack">Formula number stack containing function arguments</param>
  6978. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  6979. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  6980. </member>
  6981. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionLeft.Name">
  6982. <summary>
  6983. Function name used to reference the function in a formula
  6984. </summary>
  6985. </member>
  6986. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionLeft.MinArgs">
  6987. <summary>
  6988. Minimum number of arguments required for the function
  6989. </summary>
  6990. </member>
  6991. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionLeft.MaxArgs">
  6992. <summary>
  6993. Maximum number of arguments required for the function
  6994. </summary>
  6995. </member>
  6996. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionRight">
  6997. <summary>
  6998. Gets the rightmost characters from a text value, up to the specified number of characters.
  6999. </summary>
  7000. <remarks>
  7001. <p class="body">RIGHT(text_value, num_chars)</p>
  7002. <p class="body">Text_value is a piece of text or reference to some text ending with
  7003. a substring you want to retrieve.</p>
  7004. <p class="body">Num_chars indicate the number of characters retrieved from the end
  7005. of <em>text_value</em>. An error value is returned if this argument is less than zero.
  7006. If this argument exceeds the length of <em>text_value</em>, then all of <em>text_value</em>
  7007. is retrieved. If omitted, the last character of <em>text_value</em> is retrieved.</p>
  7008. </remarks>
  7009. </member>
  7010. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionRight.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  7011. <summary>
  7012. Evaluates the function against the arguments on the number stack
  7013. </summary>
  7014. <param name="numberStack">Formula number stack containing function arguments</param>
  7015. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  7016. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  7017. </member>
  7018. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRight.Name">
  7019. <summary>
  7020. Function name used to reference the function in a formula
  7021. </summary>
  7022. </member>
  7023. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRight.MinArgs">
  7024. <summary>
  7025. Minimum number of arguments required for the function
  7026. </summary>
  7027. </member>
  7028. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRight.MaxArgs">
  7029. <summary>
  7030. Maximum number of arguments required for the function
  7031. </summary>
  7032. </member>
  7033. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionMid">
  7034. <summary>
  7035. Gets a specified number of characters from the middle of a text string, starting from a specified position in that string.
  7036. </summary>
  7037. <remarks>
  7038. <p class="body">MID(text_value, starting_point, character_count)</p>
  7039. <p class="body">Text_value is a piece of text containing the substring you want to retrieve, when you know
  7040. the position and length of your desired substring.</p>
  7041. <p class="body">Character_count specifies how long of a substring to retrieve from <em>text_value</em>
  7042. measured as a number of characters. If the requested length, when added to the specified <em>starting_point</em>,
  7043. exceeds the length of <em>text_value</em> then the remainder of the string starting at <em>starting_point</em>
  7044. is returned.</p>
  7045. <p class="body">Starting_point is the one-based position within <em>text_value</em> of the first character
  7046. in the substring you want to retrieve. If this argument exceeds the length of <em>text_value</em> then the
  7047. function will return an empty string.</p>
  7048. <p class="body">If either <em>character_count</em> or <em>starting_point</em> has a negative value, or
  7049. evaluate to an error value, then the function returns an error value.</p>
  7050. </remarks>
  7051. </member>
  7052. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionMid.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  7053. <summary>
  7054. Evaluates the function against the arguments on the number stack
  7055. </summary>
  7056. <param name="numberStack">Formula number stack containing function arguments</param>
  7057. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  7058. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  7059. </member>
  7060. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMid.Name">
  7061. <summary>
  7062. Function name used to reference the function in a formula
  7063. </summary>
  7064. </member>
  7065. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMid.MinArgs">
  7066. <summary>
  7067. Minimum number of arguments required for the function
  7068. </summary>
  7069. </member>
  7070. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMid.MaxArgs">
  7071. <summary>
  7072. Maximum number of arguments required for the function
  7073. </summary>
  7074. </member>
  7075. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionTrim">
  7076. <summary>
  7077. Removes any leading or trailing spaces from a text value, and normalizes runs of
  7078. whitespace within a text value.
  7079. </summary>
  7080. <remarks>
  7081. <p class="body">TRIM(text_value)</p>
  7082. <p class="body">Text_value is a piece of text to trim and normalize the white
  7083. space of. Trimming removes all leading and trailing white space. Normalization
  7084. reduces runs of consecutive whitespace appearing within the <em>text_value</em>
  7085. to single blank spaces.</p>
  7086. </remarks>
  7087. </member>
  7088. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionTrim.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  7089. <summary>
  7090. Evaluates the function against the arguments on the number stack
  7091. </summary>
  7092. <param name="numberStack">Formula number stack containing function arguments</param>
  7093. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  7094. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  7095. </member>
  7096. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionTrim.Name">
  7097. <summary>
  7098. Function name used to reference the function in a formula
  7099. </summary>
  7100. </member>
  7101. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionTrim.MinArgs">
  7102. <summary>
  7103. Minimum number of arguments required for the function
  7104. </summary>
  7105. </member>
  7106. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionTrim.MaxArgs">
  7107. <summary>
  7108. Maximum number of arguments required for the function
  7109. </summary>
  7110. </member>
  7111. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionLen">
  7112. <summary>
  7113. Counts the number of characters in a text value.
  7114. </summary>
  7115. <remarks>
  7116. <p class="body">LEN(text_value)</p>
  7117. <p class="body">Text_value is any text string or reference to a text value
  7118. for which you want a character count. The number of characters, including
  7119. all whitespace, determines the length of the text string.</p>
  7120. <p class="body">Depending on the character encoding used, some whitespace
  7121. characters such as line-breaks may count as two characters (one character
  7122. is a carriage return, the other character is a line feed).</p>
  7123. <p class="body">An empty text string contains no characters.</p>
  7124. </remarks>
  7125. </member>
  7126. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionLen.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  7127. <summary>
  7128. Evaluates the function against the arguments on the number stack
  7129. </summary>
  7130. <param name="numberStack">Formula number stack containing function arguments</param>
  7131. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  7132. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  7133. </member>
  7134. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionLen.Name">
  7135. <summary>
  7136. Function name used to reference the function in a formula
  7137. </summary>
  7138. </member>
  7139. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionLen.MinArgs">
  7140. <summary>
  7141. Minimum number of arguments required for the function
  7142. </summary>
  7143. </member>
  7144. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionLen.MaxArgs">
  7145. <summary>
  7146. Maximum number of arguments required for the function
  7147. </summary>
  7148. </member>
  7149. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionValue">
  7150. <summary>
  7151. Retrieves the numeric value of a piece of text that is supposed to
  7152. represent either a number or a currency.
  7153. </summary>
  7154. <remarks>
  7155. <p class="body">VALUE(text_value)</p>
  7156. <p class="body">Text_value is any text value or single-value reference to
  7157. a text string that you want to convert into a number. It may have been
  7158. formatted with a sign, currency symbol, or thousands separator. These
  7159. characters will be stripped to yield the numeric value of the text.</p>
  7160. <p class="body">If the <em>text_value</em> is an error value or could not
  7161. be converted into a numeric value then the function returns an error value.
  7162. </p>
  7163. </remarks>
  7164. </member>
  7165. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionValue.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  7166. <summary>
  7167. Evaluates the function against the argument on the number stack.
  7168. </summary>
  7169. <param name="numberStack">Formula number stack containing function arguments.</param>
  7170. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  7171. <remarks>
  7172. <p class="body">Returns an error if the <b>UltraCalcValue</b> argument at the top of the number stack was an error.</p>
  7173. <p class="body">Returns a value conversion into a double-precision numeric type if the incoming text can be interpreted as a numeric value (possibly after filtering off thousands separators, decimal separators, currency symbols, exponents and signs.)</p>
  7174. <p class="body">Returns a numeric conversion from another numeric type if the incoming argument was not text (sometimes when the result of such a conversion is poorly defined this may defy an application's expectations, for example, a <b>DATEVALUE</b> may convert into a numeric value of ticks.)</p>
  7175. </remarks>
  7176. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  7177. </member>
  7178. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionValue.Name">
  7179. <summary>
  7180. Function name used to reference the function in a formula.
  7181. </summary>
  7182. </member>
  7183. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionValue.MinArgs">
  7184. <summary>
  7185. Minimum number of arguments required for the function.
  7186. </summary>
  7187. </member>
  7188. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionValue.MaxArgs">
  7189. <summary>
  7190. Maximum number of arguments required for the function
  7191. </summary>
  7192. </member>
  7193. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionFind">
  7194. <summary>
  7195. Finds one piece of text within another piece of text.
  7196. </summary>
  7197. <remarks>
  7198. <p class="body">FIND(text_to_find, text_to_search, starting_point)</p>
  7199. <p class="body">Text_to_find is the piece of text you want to find. It can
  7200. be a reference (for example, a NamedReference to a constant text string or
  7201. a CalcSettings reference to a TextBox on the form). It should be shorter in
  7202. length than the <em>text_to_search</em>.</p>
  7203. <p class="body">Text_to_search is the piece of text you want to search for
  7204. <em>text_to_find</em> within. It's commonly a reference to a text string
  7205. that you want to search.</p>
  7206. <p class="body">Starting_point is the one-based character position inside of
  7207. <em>text_to_search</em> at which UltraCalc will begin searching. This argument
  7208. is optional and if omitted, the search will begin at the first character.</p>
  7209. <p class="body">If <em>text_to_find</em> is not found this function returns
  7210. a Value error, otherwise it returns the starting position of <em>text_to_find</em>
  7211. within <em>text_to_search</em>.</p>
  7212. </remarks>
  7213. </member>
  7214. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionFind.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  7215. <summary>
  7216. Evaluates the function against the arguments on the number stack
  7217. </summary>
  7218. <param name="numberStack">Formula number stack containing function arguments</param>
  7219. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  7220. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  7221. </member>
  7222. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionFind.Name">
  7223. <summary>
  7224. Function name used to reference the function in a formula
  7225. </summary>
  7226. </member>
  7227. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionFind.MinArgs">
  7228. <summary>
  7229. Minimum number of arguments required for the function
  7230. </summary>
  7231. </member>
  7232. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionFind.MaxArgs">
  7233. <summary>
  7234. Maximum number of arguments required for the function
  7235. </summary>
  7236. </member>
  7237. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionReplace">
  7238. <summary>
  7239. Replaces a substring of a text value with some new text. This substring is specified by giving
  7240. it's starting point and it's length in characters, within the original text value.
  7241. </summary>
  7242. <remarks>
  7243. <p class="body">REPLACE(text_value, starting_point, character_count, new_text_value)</p>
  7244. <p class="body">Text_value is the original text within which you want to replace some substring of text,
  7245. and you already know the <em>starting_point</em> and <em>character_count</em> of that substring.</p>
  7246. <p class="body">Starting_point is the one-based position within <em>text_value</em> where the replaced
  7247. substring begins.</p>
  7248. <p class="body">Character_count is the length of the substring being replaced as a count of the characters
  7249. it contains. If this value when added to <em>starting_point</em> would exceed the length remaining in
  7250. <em>text_value</em> then the entire remainder of <em>text_value</em> is replaced.</p>
  7251. <p class="body">New_text_value is some new text that replaces the text of the specified substring. It is
  7252. not required to be the same length as the replaced substring.</p>
  7253. <p class="body">When <em>starting_point</em> or <em>character_count</em> are error values, or less than zero,
  7254. an error value is returned. If <em>starting_point</em> exceeds the length of <em>text_value</em> then an error
  7255. value is returned.</p>
  7256. <p class="body">It is possible to use the REPLACE() function with other UltraCalc functions to express the
  7257. replacement of one substring with another. The following UltraCalc expression replaces the word "Old" with
  7258. the word "New" in the original text value.</p>
  7259. <code>REPLACE("Hello Old World", FIND("Old"), LEN("Old"), "New")</code>
  7260. </remarks>
  7261. </member>
  7262. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionReplace.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  7263. <summary>
  7264. Evaluates the function against the arguments on the number stack
  7265. </summary>
  7266. <param name="numberStack">Formula number stack containing function arguments</param>
  7267. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  7268. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  7269. </member>
  7270. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionReplace.Name">
  7271. <summary>
  7272. Function name used to reference the function in a formula
  7273. </summary>
  7274. </member>
  7275. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionReplace.MinArgs">
  7276. <summary>
  7277. Minimum number of arguments required for the function
  7278. </summary>
  7279. </member>
  7280. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionReplace.MaxArgs">
  7281. <summary>
  7282. Maximum number of arguments required for the function
  7283. </summary>
  7284. </member>
  7285. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionSYD">
  7286. <summary>
  7287. Calculates depreciation of an asset using the sum of years' digits (SYD)
  7288. calculation method.
  7289. </summary>
  7290. <remarks>
  7291. <p class="body">SYD(assetCost, salvageValue, lifespan, periodNumber)</p>
  7292. <p class="body">AssetCost is the initial value of the asset
  7293. when it was purchased new. This numeric value needs to be
  7294. greater than the <em>salvageValue</em> (otherwise the asset
  7295. would be appreciating in value).</p>
  7296. <p class="body">SalvageValue is the market price you can get
  7297. for an asset at the end of it's useful life (<em>lifespan</em>
  7298. periods). In some situations, this may represent the value of
  7299. the asset's spare parts.</p>
  7300. <p class="body">Lifespan is the useful life of the asset being
  7301. depreciated measured in fixed-length time periods (usually years).
  7302. The appropriate <em>lifespan</em> to use may vary with the kind
  7303. of asset being depreciated. As the name of this function suggests,
  7304. the <em>lifespan</em> when using this depreciation method is normally
  7305. measured in years (although this does not necessarily have to be the
  7306. case).</p>
  7307. <p class="body">PeriodNumber is the one-based number of the period
  7308. to calculate the depreciation of the asset for, having a value of
  7309. between 1 and <em>lifespan</em>. It must be measured in the same
  7310. units of time as the <em>lifespan</em>.</p>
  7311. </remarks>
  7312. </member>
  7313. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionSYD.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  7314. <summary>
  7315. Evaluates the function against the arguments on the number stack
  7316. </summary>
  7317. <param name="numberStack">Formula number stack containing function arguments</param>
  7318. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  7319. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  7320. </member>
  7321. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSYD.Name">
  7322. <summary>
  7323. Function name used to reference the function in a formula
  7324. </summary>
  7325. </member>
  7326. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSYD.MinArgs">
  7327. <summary>
  7328. Minimum number of arguments required for the function
  7329. </summary>
  7330. </member>
  7331. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSYD.MaxArgs">
  7332. <summary>
  7333. Maximum number of arguments required for the function
  7334. </summary>
  7335. </member>
  7336. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionSLN">
  7337. <summary>
  7338. Calculates what the straight-line depreciation
  7339. of an asset should be per period.
  7340. </summary>
  7341. <remarks>
  7342. <p class="body">SLN(assetCost, salvageValue, lifespan)</p>
  7343. <p class="body">AssetCost is the initial value of the asset
  7344. when it was purchased new. This numeric value needs to be
  7345. greater than the <em>salvageValue</em> (otherwise the asset
  7346. would be appreciating in value).</p>
  7347. <p class="body">SalvageValue is the market price you can get
  7348. for an asset at the end of it's useful life (<em>lifespan</em>
  7349. periods). In some situations, this may represent the value of
  7350. the asset's spare parts.</p>
  7351. <p class="body">Lifespan is the useful life of the asset being
  7352. depreciated measured in fixed-length time periods (usually years).
  7353. The appropriate <em>lifespan</em> to use may vary with the kind
  7354. of asset being depreciated.</p>
  7355. <p class="body">Straight-line depreciation expresses an asset's
  7356. depreciation at a constant rate per period. The asset is assumed
  7357. to lose useful value no faster in the first period depreciation
  7358. is calculated than in the last period. An accountant can advise
  7359. you as to which assets the straight-line depreciation calculation
  7360. method is suitable.</p>
  7361. </remarks>
  7362. </member>
  7363. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionSLN.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  7364. <summary>
  7365. Evaluates the function against the arguments on the number stack
  7366. </summary>
  7367. <param name="numberStack">Formula number stack containing function arguments</param>
  7368. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  7369. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  7370. </member>
  7371. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSLN.Name">
  7372. <summary>
  7373. Function name used to reference the function in a formula
  7374. </summary>
  7375. </member>
  7376. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSLN.MinArgs">
  7377. <summary>
  7378. Minimum number of arguments required for the function
  7379. </summary>
  7380. </member>
  7381. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSLN.MaxArgs">
  7382. <summary>
  7383. Maximum number of arguments required for the function
  7384. </summary>
  7385. </member>
  7386. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionDB">
  7387. <summary>
  7388. Calculates an asset's depreciation using the fixed declining balance (DB) method over a specified term.
  7389. </summary>
  7390. <remarks>
  7391. <p class="body">DB(assetCost, salvageValue, lifespan, period, months)</p>
  7392. <p class="body">AssetCost is the original cost or purchase price of the asset at the start of the
  7393. calculation.</p>
  7394. <p class="body">SalvageValue is the market value of the asset after it's expected useful life ends,
  7395. sometimes this will be the value of the asset as spare parts.</p>
  7396. <p class="body">Lifespan indicates for how many periods the asset is useful (it's useful life), and
  7397. must be depreciated. Accounting standards vary on what <em>lifespan</em> is appropriate for different
  7398. classes of assets, such as durable and non-durable goods.</p>
  7399. <p class="body">Period indicates the number of units of time between decremental calculations of the
  7400. depreciation. If <em>lifespan</em> is measured in years, then the value specified for the <em>period</em>
  7401. must also be in years.</p>
  7402. <p class="body">Months allows you to specify the number of months in the first year, if the depreciation
  7403. does not begin on the first day of the year. You might specify <em>months</em> based on when the asset
  7404. was purchased new. If omitted, the calculation defaults to 12 which is equivalent to calculating starting
  7405. from the first day of the year.</p>
  7406. <p class="body">For some assets, alternative calculation methods such as the <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionDDB">DDB()</see>
  7407. function may be more appropriate. Your accountant can tell you for which assets the fixed declining
  7408. balance method is an acceptable means of calculating depreciation.</p>
  7409. </remarks>
  7410. </member>
  7411. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionDB.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  7412. <summary>
  7413. Evaluates the function against the arguments on the number stack
  7414. </summary>
  7415. <param name="numberStack">Formula number stack containing function arguments</param>
  7416. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  7417. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  7418. </member>
  7419. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDB.Name">
  7420. <summary>
  7421. Function name used to reference the function in a formula
  7422. </summary>
  7423. </member>
  7424. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDB.MinArgs">
  7425. <summary>
  7426. Minimum number of arguments required for the function
  7427. </summary>
  7428. </member>
  7429. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDB.MaxArgs">
  7430. <summary>
  7431. Maximum number of arguments required for the function
  7432. </summary>
  7433. </member>
  7434. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionDDB">
  7435. <summary>
  7436. Calculates an asset's depreciation using the double declining balance (DDB) or another weighted
  7437. factor method over a specified term.
  7438. </summary>
  7439. <remarks>
  7440. <p class="body">DDB(assetCost, salvageValue, lifespan, period, weight)</p>
  7441. <p class="body">AssetCost is the original cost or purchase price of the asset at the start of the
  7442. calculation.</p>
  7443. <p class="body">SalvageValue is the market value of the asset after it's expected useful life ends,
  7444. sometimes this will be the value of the asset as spare parts.</p>
  7445. <p class="body">Lifespan indicates for how many periods the asset is useful (it's useful life), and
  7446. must be depreciated. Accounting standards vary on what <em>lifespan</em> is appropriate for different
  7447. classes of assets, such as durable and non-durable goods.</p>
  7448. <p class="body">Period indicates the number of units of time between decremental calculations of the
  7449. depreciation. If <em>lifespan</em> is measured in years, then the value specified for the <em>period</em>
  7450. must also be in years.</p>
  7451. <p class="body">Weight allows you to fine tune the calculation method. By default, the double declining
  7452. balance method uses a factor of 2.</p>
  7453. <p class="body">For some assets, alternative calculation methods such as the <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionDB">DB()</see>
  7454. function may be more appropriate. Your accountant can advise you for which assets the double declining
  7455. balance method is an acceptable means of calculating depreciation, and what factors can be used when
  7456. depreciating certain assets such as high-tech equipment or motor vehicles which exhibit accelerated
  7457. depreciation in their first years of use.</p>
  7458. </remarks>
  7459. </member>
  7460. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionDDB.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  7461. <summary>
  7462. Evaluates the function against the arguments on the number stack
  7463. </summary>
  7464. <param name="numberStack">Formula number stack containing function arguments</param>
  7465. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  7466. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  7467. </member>
  7468. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDDB.Name">
  7469. <summary>
  7470. Function name used to reference the function in a formula
  7471. </summary>
  7472. </member>
  7473. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDDB.MinArgs">
  7474. <summary>
  7475. Minimum number of arguments required for the function
  7476. </summary>
  7477. </member>
  7478. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDDB.MaxArgs">
  7479. <summary>
  7480. Maximum number of arguments required for the function
  7481. </summary>
  7482. </member>
  7483. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionIntRate">
  7484. <summary>
  7485. Calculates the interest rate yielded by a security
  7486. investment redeemable at a future date, such as a
  7487. zero coupon bond.
  7488. </summary>
  7489. <remarks>
  7490. <p class="body">INTRATE(settlementDate, maturityDate,
  7491. amount, redemptionValue, basis)</p>
  7492. <p class="body">SettlementDate is the date on which a
  7493. security purchase is settled with the buyer taking
  7494. possession of the security. Market conventions for
  7495. settlement of trades vary by security and exchange.
  7496. The settlement date may be substantially later than
  7497. a security's issue date when it is traded on the
  7498. secondary market.</p>
  7499. <p class="body">MaturityDate is the date when the
  7500. security can be redeemed. It ceases to accrue any
  7501. further value after this date. The maturity date
  7502. must be later than the <em>settlementDate</em> or
  7503. an error value is returned.</p>
  7504. <p class="body">Amount is the purchase price of the
  7505. security. For positive interest, this amount will be
  7506. smaller than the <em>redemptionValue</em> because it
  7507. discounts interest that will be accrued over the time
  7508. period the security is held.</p>
  7509. <p class="body">RedemptionValue is the price a security
  7510. holder may redeem their security for at the <em>maturityDate</em>.
  7511. In some cases, this may be called the face value of the
  7512. security.</p>
  7513. <p class="body">Basis describes what accounting convention to
  7514. use when counting days per calendar year, and days on which
  7515. interest can accrue. If omitted, a basis consistent with
  7516. United States National Association of Security Dealers (NASD)
  7517. of 30/360 will be employed.</p>
  7518. <table>
  7519. <colgroup><col width="100px"/><col width="240px"/></colgroup>
  7520. <tr><th>Basis</th><th>Day counting method</th></tr>
  7521. <tr><td>0</td><td>30/360 (US NASD)</td></tr>
  7522. <tr><td>1</td><td>Actual/actual</td></tr>
  7523. <tr><td>2</td><td>Actual/360</td></tr>
  7524. <tr><td>3</td><td>Actual/365</td></tr>
  7525. <tr><td>4</td><td>30/360 (European)</td></tr>
  7526. </table>
  7527. <p class="body">Date values should be passed to this function using either the
  7528. <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionDate">DATE()</see> function or <strong>UltraCalcValue</strong>
  7529. objects containing .NET <strong>DateTime</strong> values. Date values represented
  7530. as text may not be interpreted as you had intended.</p>
  7531. </remarks>
  7532. </member>
  7533. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionIntRate.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  7534. <summary>
  7535. Evaluates the function against the arguments on the number stack
  7536. </summary>
  7537. <param name="numberStack">Formula number stack containing function arguments</param>
  7538. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  7539. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  7540. </member>
  7541. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIntRate.Name">
  7542. <summary>
  7543. Function name used to reference the function in a formula
  7544. </summary>
  7545. </member>
  7546. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIntRate.MinArgs">
  7547. <summary>
  7548. Minimum number of arguments required for the function
  7549. </summary>
  7550. </member>
  7551. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIntRate.MaxArgs">
  7552. <summary>
  7553. Maximum number of arguments required for the function
  7554. </summary>
  7555. </member>
  7556. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionDateValue">
  7557. <summary>
  7558. Returns the .NET DateTime of the time represented by date formated in a string
  7559. </summary>
  7560. <remarks>
  7561. <p class="body">
  7562. DATEVALUE(date_text)
  7563. <p></p>
  7564. Date_text is text that represents a date in a .NET DateTime format
  7565. </p>
  7566. </remarks>
  7567. </member>
  7568. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionDateValue.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  7569. <summary>
  7570. Evaluates the function against the arguments on the number stack
  7571. </summary>
  7572. <param name="numberStack">Formula number stack containing function arguments</param>
  7573. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  7574. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  7575. </member>
  7576. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDateValue.Name">
  7577. <summary>
  7578. Function name used to reference the function in a formula
  7579. </summary>
  7580. </member>
  7581. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDateValue.MinArgs">
  7582. <summary>
  7583. Minimum number of arguments required for the function
  7584. </summary>
  7585. </member>
  7586. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDateValue.MaxArgs">
  7587. <summary>
  7588. Maximum number of arguments required for the function
  7589. </summary>
  7590. </member>
  7591. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionDate">
  7592. <summary>
  7593. Returns the .NET DateTime ticks number that represents a particular date
  7594. </summary>
  7595. <remarks>
  7596. <p class="body">
  7597. DATE(year,month,day)
  7598. <p></p>
  7599. Year is the number representing the year
  7600. <p></p>
  7601. Month is a number representing the month of the year
  7602. <p></p>
  7603. Day is a number representing the day of the month
  7604. </p>
  7605. </remarks>
  7606. </member>
  7607. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionDate.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  7608. <summary>
  7609. Evaluates the function against the arguments on the number stack
  7610. </summary>
  7611. <param name="numberStack">Formula number stack containing function arguments</param>
  7612. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  7613. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  7614. </member>
  7615. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDate.Name">
  7616. <summary>
  7617. Function name used to reference the function in a formula
  7618. </summary>
  7619. </member>
  7620. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDate.MinArgs">
  7621. <summary>
  7622. Minimum number of arguments required for the function
  7623. </summary>
  7624. </member>
  7625. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDate.MaxArgs">
  7626. <summary>
  7627. Maximum number of arguments required for the function
  7628. </summary>
  7629. </member>
  7630. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionDays360">
  7631. <summary>
  7632. Returns the number of days between two dates based on a 360-day year (twelve 30-day months), which is used in some accounting calculations.
  7633. </summary>
  7634. <remarks>
  7635. <p class="body">
  7636. DAYS360(start_date,end_date,method)
  7637. <p></p>
  7638. Start_date and end_date are the two dates between which you want to know the number of days.
  7639. <p></p>
  7640. If start_date occurs after end_date, DAYS360 returns a negative number.
  7641. Dates should be entered by using the DATE function, or as results of other formulas or functions.
  7642. For example, use DATE(2008,5,23) for the 23rd day of May, 2008. Problems can occur if dates are entered as text.
  7643. <p></p>
  7644. Method is a logical value that specifies whether to use the U.S. or European method in the calculation:
  7645. <p></p><t></t>
  7646. FALSE or omitted U.S. (NASD) method. If the starting date is the 31st of a month, it becomes equal to the 30th of the same month. If the ending date is the 31st of a month and the starting date is earlier than the 30th of a month, the ending date becomes equal to the 1st of the next month; otherwise the ending date becomes equal to the 30th of the same month.
  7647. <p></p><t></t>
  7648. TRUE European method. Starting dates and ending dates that occur on the 31st of a month become equal to the 30th of the same month.
  7649. </p>
  7650. </remarks>
  7651. </member>
  7652. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionDays360.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  7653. <summary>
  7654. Evaluates the function against the arguments on the number stack
  7655. </summary>
  7656. <param name="numberStack">Formula number stack containing function arguments</param>
  7657. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  7658. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  7659. </member>
  7660. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDays360.Name">
  7661. <summary>
  7662. Function name used to reference the function in a formula
  7663. </summary>
  7664. </member>
  7665. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDays360.MinArgs">
  7666. <summary>
  7667. Minimum number of arguments required for the function
  7668. </summary>
  7669. </member>
  7670. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDays360.MaxArgs">
  7671. <summary>
  7672. Maximum number of arguments required for the function
  7673. </summary>
  7674. </member>
  7675. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionDay">
  7676. <summary>
  7677. Returns the day of a date value
  7678. </summary>
  7679. </member>
  7680. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionDay.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  7681. <summary>
  7682. Evaluates the function against the arguments on the number stack
  7683. </summary>
  7684. <param name="numberStack">Formula number stack containing function arguments</param>
  7685. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  7686. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  7687. </member>
  7688. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDay.Name">
  7689. <summary>
  7690. Function name used to reference the function in a formula
  7691. </summary>
  7692. </member>
  7693. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDay.MinArgs">
  7694. <summary>
  7695. Minimum number of arguments required for the function
  7696. </summary>
  7697. </member>
  7698. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDay.MaxArgs">
  7699. <summary>
  7700. Maximum number of arguments required for the function
  7701. </summary>
  7702. </member>
  7703. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionMonth">
  7704. <summary>
  7705. Returns the month of a date value
  7706. </summary>
  7707. </member>
  7708. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionMonth.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  7709. <summary>
  7710. Evaluates the function against the arguments on the number stack
  7711. </summary>
  7712. <param name="numberStack">Formula number stack containing function arguments</param>
  7713. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  7714. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  7715. </member>
  7716. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMonth.Name">
  7717. <summary>
  7718. Function name used to reference the function in a formula
  7719. </summary>
  7720. </member>
  7721. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMonth.MinArgs">
  7722. <summary>
  7723. Minimum number of arguments required for the function
  7724. </summary>
  7725. </member>
  7726. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMonth.MaxArgs">
  7727. <summary>
  7728. Maximum number of arguments required for the function
  7729. </summary>
  7730. </member>
  7731. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionYear">
  7732. <summary>
  7733. Returns the year of a date value
  7734. </summary>
  7735. </member>
  7736. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionYear.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  7737. <summary>
  7738. Evaluates the function against the arguments on the number stack
  7739. </summary>
  7740. <param name="numberStack">Formula number stack containing function arguments</param>
  7741. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  7742. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  7743. </member>
  7744. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionYear.Name">
  7745. <summary>
  7746. Function name used to reference the function in a formula
  7747. </summary>
  7748. </member>
  7749. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionYear.MinArgs">
  7750. <summary>
  7751. Minimum number of arguments required for the function
  7752. </summary>
  7753. </member>
  7754. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionYear.MaxArgs">
  7755. <summary>
  7756. Maximum number of arguments required for the function
  7757. </summary>
  7758. </member>
  7759. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionHour">
  7760. <summary>
  7761. Returns the hour of a time value
  7762. </summary>
  7763. </member>
  7764. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionHour.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  7765. <summary>
  7766. Evaluates the function against the arguments on the number stack
  7767. </summary>
  7768. <param name="numberStack">Formula number stack containing function arguments</param>
  7769. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  7770. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  7771. </member>
  7772. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionHour.Name">
  7773. <summary>
  7774. Function name used to reference the function in a formula
  7775. </summary>
  7776. </member>
  7777. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionHour.MinArgs">
  7778. <summary>
  7779. Minimum number of arguments required for the function
  7780. </summary>
  7781. </member>
  7782. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionHour.MaxArgs">
  7783. <summary>
  7784. Maximum number of arguments required for the function
  7785. </summary>
  7786. </member>
  7787. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionMinute">
  7788. <summary>
  7789. Returns the minute of a time value
  7790. </summary>
  7791. </member>
  7792. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionMinute.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  7793. <summary>
  7794. Evaluates the function against the arguments on the number stack
  7795. </summary>
  7796. <param name="numberStack">Formula number stack containing function arguments</param>
  7797. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  7798. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  7799. </member>
  7800. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMinute.Name">
  7801. <summary>
  7802. Function name used to reference the function in a formula
  7803. </summary>
  7804. </member>
  7805. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMinute.MinArgs">
  7806. <summary>
  7807. Minimum number of arguments required for the function
  7808. </summary>
  7809. </member>
  7810. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMinute.MaxArgs">
  7811. <summary>
  7812. Maximum number of arguments required for the function
  7813. </summary>
  7814. </member>
  7815. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionSecond">
  7816. <summary>
  7817. Returns the second of a time value
  7818. </summary>
  7819. </member>
  7820. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionSecond.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  7821. <summary>
  7822. Evaluates the function against the arguments on the number stack
  7823. </summary>
  7824. <param name="numberStack">Formula number stack containing function arguments</param>
  7825. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  7826. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  7827. </member>
  7828. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSecond.Name">
  7829. <summary>
  7830. Function name used to reference the function in a formula
  7831. </summary>
  7832. </member>
  7833. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSecond.MinArgs">
  7834. <summary>
  7835. Minimum number of arguments required for the function
  7836. </summary>
  7837. </member>
  7838. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSecond.MaxArgs">
  7839. <summary>
  7840. Maximum number of arguments required for the function
  7841. </summary>
  7842. </member>
  7843. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionNow">
  7844. <summary>
  7845. Returns a .NET DateTime ticks value of the current day and time
  7846. </summary>
  7847. </member>
  7848. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionNow.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  7849. <summary>
  7850. Evaluates the function against the arguments on the number stack
  7851. </summary>
  7852. <param name="numberStack">Formula number stack containing function arguments</param>
  7853. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  7854. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  7855. </member>
  7856. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionNow.IsAlwaysDirty">
  7857. <summary>
  7858. Indicates whether the results of the function is always dirty.
  7859. </summary>
  7860. </member>
  7861. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionNow.Name">
  7862. <summary>
  7863. Function name used to reference the function in a formula
  7864. </summary>
  7865. </member>
  7866. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionNow.MinArgs">
  7867. <summary>
  7868. Minimum number of arguments required for the function
  7869. </summary>
  7870. </member>
  7871. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionNow.MaxArgs">
  7872. <summary>
  7873. Maximum number of arguments required for the function
  7874. </summary>
  7875. </member>
  7876. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionTimeValue">
  7877. <summary>
  7878. Returns the .Net DateTime of the time represented by time formated in a string
  7879. </summary>
  7880. <remarks>
  7881. <p class="body">
  7882. TIMEVALUE(time_text)
  7883. <p></p>
  7884. Time_text is text that represents a date in the .NET DateTime format
  7885. </p>
  7886. </remarks>
  7887. </member>
  7888. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionTimeValue.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  7889. <summary>
  7890. Evaluates the function against the arguments on the number stack
  7891. </summary>
  7892. <param name="numberStack">Formula number stack containing function arguments</param>
  7893. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  7894. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  7895. </member>
  7896. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionTimeValue.Name">
  7897. <summary>
  7898. Function name used to reference the function in a formula
  7899. </summary>
  7900. </member>
  7901. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionTimeValue.MinArgs">
  7902. <summary>
  7903. Minimum number of arguments required for the function
  7904. </summary>
  7905. </member>
  7906. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionTimeValue.MaxArgs">
  7907. <summary>
  7908. Maximum number of arguments required for the function
  7909. </summary>
  7910. </member>
  7911. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionTime">
  7912. <summary>
  7913. Returns the .NET DateTime ticks value that represents a particular time
  7914. </summary>
  7915. <remarks>
  7916. <p class="body">
  7917. TIME(hour,minute,second)
  7918. <p></p>
  7919. Hour is a number representing the time's hour
  7920. <p></p>
  7921. Minute is a number representing the time's minute
  7922. <p></p>
  7923. Second is a number representing the time's second
  7924. </p>
  7925. </remarks>
  7926. </member>
  7927. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionTime.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  7928. <summary>
  7929. Evaluates the function against the arguments on the number stack
  7930. </summary>
  7931. <param name="numberStack">Formula number stack containing function arguments</param>
  7932. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  7933. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  7934. </member>
  7935. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionTime.Name">
  7936. <summary>
  7937. Function name used to reference the function in a formula
  7938. </summary>
  7939. </member>
  7940. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionTime.MinArgs">
  7941. <summary>
  7942. Minimum number of arguments required for the function
  7943. </summary>
  7944. </member>
  7945. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionTime.MaxArgs">
  7946. <summary>
  7947. Maximum number of arguments required for the function
  7948. </summary>
  7949. </member>
  7950. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionMedian">
  7951. <summary>
  7952. Calculates the median value of a specified list of numeric values.
  7953. </summary>
  7954. <remarks>
  7955. <p class="body">MEDIAN(Value1, value2, ..., valueN)</p>
  7956. <p class="body">Value1, value2, ..., valueN are any number of numeric values or references to
  7957. numeric values for which you want the median value found. If any argument is an error value,
  7958. or there are no numeric values within the series of arguments, then MEDIAN() will return an
  7959. error value.</p>
  7960. <p class="body">The median is the middle value of the sorted list of numeric values (you do
  7961. not need to sort <em>Value1</em>, <em>value2</em>, ..., <em>valueN</em> prior to passing them
  7962. to the MEDIAN() function). When the list contains an odd number of values, the median will be
  7963. the value at position CEIL(<em>N</em>/2). For example, the median of the 5-value list 0, 20,
  7964. 30, 50, 80, is the value in the third position: 30. When the list contains an even number of
  7965. values, the median will be the average of the two values in the middle. For example, the
  7966. median of the 4-value list 7, 20, 30, 45, is the average of the two middle elements (20 and
  7967. 30): 25. Note that the value of the MEDIAN() varies most from the arithmetic mean of the
  7968. sorted list when the distribution of values tends to favor one side or the other of that
  7969. arithemtic mean. For example, the arithmetic mean of the 5-value list 1, 2, 3, 21, 43 is
  7970. 14 but it's median value is 3.</p>
  7971. </remarks>
  7972. </member>
  7973. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionMedian.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  7974. <summary>
  7975. Evaluates the function against the arguments on the number stack
  7976. </summary>
  7977. <param name="numberStack">Formula number stack containing function arguments</param>
  7978. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  7979. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  7980. </member>
  7981. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMedian.Name">
  7982. <summary>
  7983. Function name used to reference the function in a formula
  7984. </summary>
  7985. </member>
  7986. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMedian.MinArgs">
  7987. <summary>
  7988. Minimum number of arguments required for the function
  7989. </summary>
  7990. </member>
  7991. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMedian.MaxArgs">
  7992. <summary>
  7993. Maximum number of arguments required for the function
  7994. </summary>
  7995. </member>
  7996. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionVar">
  7997. <summary>
  7998. Calculates the estimated variance for a specified sampling of numeric values.
  7999. </summary>
  8000. <remarks>
  8001. <p class="body">VAR(Value1, value2, ..., valueN)</p>
  8002. <p class="body">Value1, value2, ..., valueN are any number of numeric values or
  8003. references to numeric values you provide to specify a sampling of your larger
  8004. data population. If any argument contains an error value or there arte no numeric
  8005. values in the sampling, the VAR() function evaluates to the first error value it
  8006. encounters.</p>
  8007. <p class="body">Variance is a measure of statistical variability, and is used in
  8008. statistical studies based on small samplings from much larger data populations to
  8009. draw inferences about the variability of those data populations.</p>
  8010. </remarks>
  8011. </member>
  8012. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionVar.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  8013. <summary>
  8014. Evaluates the function against the arguments on the number stack
  8015. </summary>
  8016. <param name="numberStack">Formula number stack containing function arguments</param>
  8017. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  8018. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  8019. </member>
  8020. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionVar.CalculateVariance(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  8021. <summary>
  8022. Estimates the variance based on a sample.
  8023. </summary>
  8024. <param name="numberStack">Number stack to evaluate</param>
  8025. <param name="argumentCount">Number of arguments on the stack to use</param>
  8026. <returns>A boolean indicating if the value was calculated</returns>
  8027. </member>
  8028. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionVar.Name">
  8029. <summary>
  8030. Function name used to reference the function in a formula
  8031. </summary>
  8032. </member>
  8033. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionVar.MinArgs">
  8034. <summary>
  8035. Minimum number of arguments required for the function
  8036. </summary>
  8037. </member>
  8038. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionVar.MaxArgs">
  8039. <summary>
  8040. Maximum number of arguments required for the function
  8041. </summary>
  8042. </member>
  8043. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionStdev">
  8044. <summary>
  8045. Calculates an approximate standard deviation of a specified sampling of numeric
  8046. values.
  8047. </summary>
  8048. <remarks>
  8049. <p class="body">STDEV(Value1, value2, ..., valueN)</p>
  8050. <p class="body">Value1, value2, ..., valueN are any number of numeric values or references
  8051. to numeric values that you've given to provide a sample space of your data set. If any value
  8052. contains an error, then the function evaluates to the first error encountered. An error value
  8053. is returned if the sample space contains no numeric values.</p>
  8054. <p class="body">The standard deviation is used in statistical studies to make inferences about
  8055. a larger population of data based on sampling only a subset. For well chosen samplings, a small
  8056. standard deviation indicates most data points tend to cluster within a narrow range of values.
  8057. A larger standard deviations indicates greater variability in the data points, and that there
  8058. is a higher likelihood for values to occur farther away and/or more frequently away from the
  8059. expected norm.</p>
  8060. </remarks>
  8061. </member>
  8062. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionStdev.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  8063. <summary>
  8064. Evaluates the function against the arguments on the number stack
  8065. </summary>
  8066. <param name="numberStack">Formula number stack containing function arguments</param>
  8067. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  8068. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  8069. </member>
  8070. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionStdev.Name">
  8071. <summary>
  8072. Function name used to reference the function in a formula
  8073. </summary>
  8074. </member>
  8075. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionStdev.MinArgs">
  8076. <summary>
  8077. Minimum number of arguments required for the function
  8078. </summary>
  8079. </member>
  8080. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionStdev.MaxArgs">
  8081. <summary>
  8082. Maximum number of arguments required for the function
  8083. </summary>
  8084. </member>
  8085. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionType">
  8086. <summary>
  8087. Returns the underlying UltraCalc data type for the specified value.
  8088. </summary>
  8089. <remarks>
  8090. <p class="body">TYPE( value)</p>
  8091. <p class="body">Value is an <strong>UltraCalcValue</strong> object or
  8092. the result of evaluating an UltraCalc expression.</p>
  8093. <p class="body">
  8094. <table border="0">
  8095. <colgroup><col width="160px"/><col width="160px"/></colgroup>
  8096. <thead><th>UltraCalc data type:</th><th>TYPE function returns:</th></thead>
  8097. <tbody>
  8098. <tr><td>Number</td><td>1</td></tr>
  8099. <tr><td>Text</td><td>2</td></tr>
  8100. <tr><td>Boolean</td><td>4</td></tr>
  8101. <tr><td>Error</td><td>16</td></tr>
  8102. </tbody>
  8103. </table>
  8104. </p>
  8105. </remarks>
  8106. </member>
  8107. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionType.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  8108. <summary>
  8109. Evaluates the function against the arguments on the number stack
  8110. </summary>
  8111. <param name="numberStack">Formula number stack containing function arguments</param>
  8112. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  8113. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  8114. </member>
  8115. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionType.Name">
  8116. <summary>
  8117. Function name used to reference the function in a formula
  8118. </summary>
  8119. </member>
  8120. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionType.MinArgs">
  8121. <summary>
  8122. Minimum number of arguments required for the function
  8123. </summary>
  8124. </member>
  8125. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionType.MaxArgs">
  8126. <summary>
  8127. Maximum number of arguments required for the function
  8128. </summary>
  8129. </member>
  8130. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionErrorType">
  8131. <summary>
  8132. When an error value is returned, the ERRORTYPE function returns a
  8133. numeric value corresponding to the UltraCalcErrorCode enumeration.
  8134. </summary>
  8135. <remarks>
  8136. <p class="body">ERRORTYPE(error_value)</p>
  8137. <p class="body">Error_value is an UltraCalc error value resulting
  8138. from the unsuccessful evaluation of an expression.</p>
  8139. <p class="body">The ERRORTYPE function returns an error value of
  8140. #N/A (Not Applicable) if you pass it an UltraCalc value that was
  8141. not an error value.</p>
  8142. <p class="body">
  8143. <table border="0">
  8144. <thead>
  8145. <th>Error_value</th>
  8146. <th>ERRORTYPE returns</th>
  8147. </thead>
  8148. <tbody>
  8149. <tr><td>#NULL!</td><td>1</td></tr>
  8150. <tr><td>#DIV/0!</td><td>2</td></tr>
  8151. <tr><td>#VALUE!</td><td>3</td></tr>
  8152. <tr><td>#REF!</td><td>4</td></tr>
  8153. <tr><td>#NAME?</td><td>5</td></tr>
  8154. <tr><td>#NUM!</td><td>6</td></tr>
  8155. <tr><td>#N/A!</td><td>7</td></tr>
  8156. </tbody>
  8157. </table>
  8158. </p>
  8159. </remarks>
  8160. </member>
  8161. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionErrorType.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  8162. <summary>
  8163. Evaluates the function against the arguments on the number stack
  8164. </summary>
  8165. <param name="numberStack">Formula number stack containing function arguments</param>
  8166. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  8167. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  8168. </member>
  8169. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionErrorType.Name">
  8170. <summary>
  8171. Function name used to reference the function in a formula
  8172. </summary>
  8173. </member>
  8174. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionErrorType.MinArgs">
  8175. <summary>
  8176. Minimum number of arguments required for the function
  8177. </summary>
  8178. </member>
  8179. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionErrorType.MaxArgs">
  8180. <summary>
  8181. Maximum number of arguments required for the function
  8182. </summary>
  8183. </member>
  8184. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionNa">
  8185. <summary>
  8186. Returns #N/A!, the error value representing a not applicable result.
  8187. </summary>
  8188. <remarks>
  8189. <p class="body">NA()</p>
  8190. <p class="body">The NA function always returns the same constant
  8191. error value.</p>
  8192. <p class="body">You might use this function when you wanted an IF
  8193. function or other complex UltraCalc expression to return the #N/A!
  8194. error value.</p>
  8195. </remarks>
  8196. </member>
  8197. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionNa.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  8198. <summary>
  8199. Evaluates the function against the arguments on the number stack
  8200. </summary>
  8201. <param name="numberStack">Formula number stack containing function arguments</param>
  8202. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  8203. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  8204. </member>
  8205. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionNa.Name">
  8206. <summary>
  8207. Function name used to reference the function in a formula
  8208. </summary>
  8209. </member>
  8210. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionNa.MinArgs">
  8211. <summary>
  8212. Minimum number of arguments required for the function
  8213. </summary>
  8214. </member>
  8215. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionNa.MaxArgs">
  8216. <summary>
  8217. Maximum number of arguments required for the function
  8218. </summary>
  8219. </member>
  8220. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionIsBlank">
  8221. <summary>
  8222. Returns TRUE if the specified value is blank.
  8223. </summary>
  8224. <remarks>
  8225. <p class="body">ISBLANK(value)</p>
  8226. <p class="body">Value can be any constant, reference or the result of
  8227. evaluating an UltraCalc expression.</p>
  8228. <p class="body">The definition of what constitutes "blank" is anything
  8229. that causes the <strong>IsNull</strong> method of the <strong>UltraCalcValue</strong>
  8230. object containing the argument, value, to return TRUE. This may vary
  8231. for different kinds of <strong>UltraCalcValue</strong> object.</p>
  8232. </remarks>
  8233. </member>
  8234. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionIsBlank.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  8235. <summary>
  8236. Evaluates the function against the arguments on the number stack
  8237. </summary>
  8238. <param name="numberStack">Formula number stack containing function arguments</param>
  8239. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  8240. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  8241. </member>
  8242. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsBlank.Name">
  8243. <summary>
  8244. Function name used to reference the function in a formula
  8245. </summary>
  8246. </member>
  8247. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsBlank.MinArgs">
  8248. <summary>
  8249. Minimum number of arguments required for the function
  8250. </summary>
  8251. </member>
  8252. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsBlank.MaxArgs">
  8253. <summary>
  8254. Maximum number of arguments required for the function
  8255. </summary>
  8256. </member>
  8257. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionIsErr">
  8258. <summary>
  8259. Returns TRUE if the specified value is any error value, except #N/A!
  8260. </summary>
  8261. <remarks>
  8262. <p class="body">ISERR(value)</p>
  8263. <p class="body">Value is an <strong>UltraCalcValue</strong> object (perhaps
  8264. the result of evaluating an UltraCalc expression) thought to be an error
  8265. value. The ISERR function will return FALSE when value is not an error
  8266. value, or it is an error but the error value was not applicable.</p>
  8267. <p class="body">This is a weaker variation of the more stringent
  8268. <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionIsError">ISERROR</see> function.</p>
  8269. </remarks>
  8270. </member>
  8271. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionIsErr.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  8272. <summary>
  8273. Evaluates the function against the arguments on the number stack
  8274. </summary>
  8275. <param name="numberStack">Formula number stack containing function arguments</param>
  8276. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  8277. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  8278. </member>
  8279. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsErr.Name">
  8280. <summary>
  8281. Function name used to reference the function in a formula
  8282. </summary>
  8283. </member>
  8284. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsErr.MinArgs">
  8285. <summary>
  8286. Minimum number of arguments required for the function
  8287. </summary>
  8288. </member>
  8289. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsErr.MaxArgs">
  8290. <summary>
  8291. Maximum number of arguments required for the function
  8292. </summary>
  8293. </member>
  8294. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionIsError">
  8295. <summary>
  8296. Returns TRUE if the specified value is any error value without exception.
  8297. </summary>
  8298. <remarks>
  8299. <p class="body">ISERROR(value)</p>
  8300. <p class="body">Value is an <strong>UltraCalcValue</strong> object (perhaps
  8301. the result of evaluating an UltraCalc expression) thought to be an error
  8302. value. The ISERROR function will return FALSE only when value is not an
  8303. error value.</p>
  8304. <p class="body">A more relaxed variation of this function is the
  8305. <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionIsErr">ISERR</see> function, which
  8306. returns TRUE when an error value is not applicable. The ISERROR
  8307. function treats this case as being an error. If you are using
  8308. certain UltraCalc functions then sometimes error values of #N/A!
  8309. should be treated by your application as non-errors and you
  8310. should choose ISERR instead of ISERROR.</p>
  8311. </remarks>
  8312. </member>
  8313. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionIsError.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  8314. <summary>
  8315. Evaluates the function against the arguments on the number stack.
  8316. </summary>
  8317. <param name="numberStack">Formula number stack containing function arguments</param>
  8318. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  8319. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  8320. </member>
  8321. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsError.Name">
  8322. <summary>
  8323. Function name used to reference the function in a formula.
  8324. </summary>
  8325. </member>
  8326. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsError.MinArgs">
  8327. <summary>
  8328. Minimum number of arguments required for the function.
  8329. </summary>
  8330. </member>
  8331. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsError.MaxArgs">
  8332. <summary>
  8333. Maximum number of arguments required for the function.
  8334. </summary>
  8335. </member>
  8336. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionIsLogical">
  8337. <summary>
  8338. Returns TRUE if the specified value refers to a two-state logic
  8339. or Boolean value.
  8340. </summary>
  8341. <remarks>
  8342. <p class="body">ISLOGICAL(value)</p>
  8343. <p class="body">Value is an <strong>UltraCalcValue</strong> object,
  8344. or the result of evaluating an UltraCalc expression, which is thought
  8345. to be a boolean value (TRUE or FALSE.) Boolean values are named in
  8346. honor of George Boole, whose development of Boolean algebra governs
  8347. the special characteristics of logical functions upon these two
  8348. values.</p>
  8349. <p class="body">Depending on the kind of value, it may not be convertible
  8350. into a boolean value and therefore the ISLOGICAL function returns FALSE.
  8351. The ISLOGICAL function only furnishes information about the compatibility
  8352. of a value with the boolean-typed values evaluated by UltraCalc.</p>
  8353. <p class="note">The ISLOGICAL function does not perform deductive reasoning.
  8354. A return value of TRUE should not be interpreted as proof any value or UltraCalc
  8355. expression passed to the ISLOGICAL function represents a logical outcome.</p>
  8356. </remarks>
  8357. </member>
  8358. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionIsLogical.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  8359. <summary>
  8360. Evaluates the function against the arguments on the number stack
  8361. </summary>
  8362. <param name="numberStack">Formula number stack containing function arguments</param>
  8363. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  8364. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  8365. </member>
  8366. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsLogical.Name">
  8367. <summary>
  8368. Function name used to reference the function in a formula
  8369. </summary>
  8370. </member>
  8371. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsLogical.MinArgs">
  8372. <summary>
  8373. Minimum number of arguments required for the function
  8374. </summary>
  8375. </member>
  8376. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsLogical.MaxArgs">
  8377. <summary>
  8378. Maximum number of arguments required for the function
  8379. </summary>
  8380. </member>
  8381. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionIsNa">
  8382. <summary>
  8383. Returns TRUE if an error value is #N/A (not applicable.)
  8384. </summary>
  8385. <remarks>
  8386. <p class="body">ISNA(value)</p>
  8387. <p class="body">Value is an error value thought to be the error value
  8388. returned when an error has happened, but the error code was not applicable.</p>
  8389. </remarks>
  8390. </member>
  8391. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionIsNa.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  8392. <summary>
  8393. Evaluates the function against the arguments on the number stack.
  8394. </summary>
  8395. <param name="numberStack">Formula number stack containing function arguments</param>
  8396. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  8397. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  8398. </member>
  8399. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsNa.Name">
  8400. <summary>
  8401. Function name used to reference the function in a formula.
  8402. </summary>
  8403. </member>
  8404. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsNa.MinArgs">
  8405. <summary>
  8406. Minimum number of arguments required for the function.
  8407. </summary>
  8408. </member>
  8409. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsNa.MaxArgs">
  8410. <summary>
  8411. Maximum number of arguments required for the function.
  8412. </summary>
  8413. </member>
  8414. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionIsNonText">
  8415. <summary>
  8416. Returns TRUE if the specified value refers to any not-text value.
  8417. </summary>
  8418. <remarks>
  8419. <p class="body">ISNONTEXT( value)</p>
  8420. <p class="body">Value is an <strong>UltraCalcValue</strong> object
  8421. or the result of an UltraCalc expression evaluation that you want
  8422. to test to determine whether it is a text value (such as a .NET
  8423. <strong>String</strong> object) or a non-text value.</p>
  8424. <seealso cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionIsText">ISTEXT function</seealso>
  8425. </remarks>
  8426. </member>
  8427. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionIsNonText.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  8428. <summary>
  8429. Evaluates the function against the arguments on the number stack
  8430. </summary>
  8431. <param name="numberStack">Formula number stack containing function arguments</param>
  8432. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  8433. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  8434. </member>
  8435. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsNonText.Name">
  8436. <summary>
  8437. Function name used to reference the function in a formula
  8438. </summary>
  8439. </member>
  8440. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsNonText.MinArgs">
  8441. <summary>
  8442. Minimum number of arguments required for the function
  8443. </summary>
  8444. </member>
  8445. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsNonText.MaxArgs">
  8446. <summary>
  8447. Maximum number of arguments required for the function
  8448. </summary>
  8449. </member>
  8450. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionIsNumber">
  8451. <summary>
  8452. Returns TRUE if the specified value refers to a numeric value.
  8453. </summary>
  8454. <remarks>
  8455. <p class="body">ISNUMBER( value)</p>
  8456. <p class="body">Value is an <strong>UltraCalcValue</strong> or the
  8457. result of evaluating an UltraCalc expression that you want to test
  8458. to determine whether it is a number or not. A numeric value can be
  8459. an integer, floating-point or decimal number.</p>
  8460. </remarks>
  8461. </member>
  8462. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionIsNumber.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  8463. <summary>
  8464. Evaluates the function against the arguments on the number stack
  8465. </summary>
  8466. <param name="numberStack">Formula number stack containing function arguments</param>
  8467. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  8468. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  8469. </member>
  8470. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsNumber.Name">
  8471. <summary>
  8472. Function name used to reference the function in a formula
  8473. </summary>
  8474. </member>
  8475. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsNumber.MinArgs">
  8476. <summary>
  8477. Minimum number of arguments required for the function
  8478. </summary>
  8479. </member>
  8480. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsNumber.MaxArgs">
  8481. <summary>
  8482. Maximum number of arguments required for the function
  8483. </summary>
  8484. </member>
  8485. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionIsRef">
  8486. <summary>
  8487. Returns TRUE if the specified value is an UltraCalc reference.
  8488. </summary>
  8489. <remarks>
  8490. <p class="body">ISREF( reference)</p>
  8491. <p class="body">Reference is an <strong>UltraCalcValue</strong>
  8492. object that contains a reference to some application-specific
  8493. control, field, or piece of information. You can think of it as
  8494. an address which the UltraCalc engine uses to look-up a value
  8495. in your application when one is needed to evaluate an expression.
  8496. </p>
  8497. <p class="body">The ISREF function returns TRUE when the specified
  8498. <strong>UltraCalcValue</strong> is a reference. Since it's value
  8499. is defined by the contents at another referenced location, it's
  8500. possible for this <strong>UltraCalcValue</strong> object to change
  8501. in value based on changes in your application (outside of the
  8502. UltraCalc engine.) Proper implementation of the <strong>IUltraCalcReference</strong>
  8503. interface and <strong>NotifyValueChange</strong> methods will ensure the
  8504. UltraCalc engine is made aware of any changes in a referenced value,
  8505. and that all references depending on this value are refreshed.</p>
  8506. <p class="body">Conversely, the ISREF function will return FALSE
  8507. should the <strong>UltraCalcValue</strong> you supply represent
  8508. a constant value or the temporary result of evaluating an UltraCalc
  8509. expression (a constant value sitting at the top of the UltraCalc
  8510. engine's number stack.)</p>
  8511. </remarks>
  8512. </member>
  8513. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionIsRef.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  8514. <summary>
  8515. Evaluates the function against the arguments on the number stack
  8516. </summary>
  8517. <param name="numberStack">Formula number stack containing function arguments</param>
  8518. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  8519. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  8520. </member>
  8521. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsRef.Name">
  8522. <summary>
  8523. Function name used to reference the function in a formula
  8524. </summary>
  8525. </member>
  8526. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsRef.MinArgs">
  8527. <summary>
  8528. Minimum number of arguments required for the function
  8529. </summary>
  8530. </member>
  8531. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsRef.MaxArgs">
  8532. <summary>
  8533. Maximum number of arguments required for the function
  8534. </summary>
  8535. </member>
  8536. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionIsText">
  8537. <summary>
  8538. Returns TRUE if the specified value refers to a text (or string) value.
  8539. </summary>
  8540. <remarks>
  8541. <p class="body">ISTEXT(value)</p>
  8542. <p class="body">Value is an <strong>UltraCalcValue</strong> object or
  8543. the result of evaluating an UltraCalc expression that you want to test
  8544. to determine whether it is of a text (<em>e.g.</em>, string) value or
  8545. a non-text value (which could be a numeric, boolean, or error value.)
  8546. </p>
  8547. <seealso cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionIsNonText">ISNONTEXT function</seealso>
  8548. </remarks>
  8549. </member>
  8550. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionIsText.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  8551. <summary>
  8552. Evaluates the function against the arguments on the number stack
  8553. </summary>
  8554. <param name="numberStack">Formula number stack containing function arguments</param>
  8555. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  8556. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  8557. </member>
  8558. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsText.Name">
  8559. <summary>
  8560. Function name used to reference the function in a formula
  8561. </summary>
  8562. </member>
  8563. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsText.MinArgs">
  8564. <summary>
  8565. Minimum number of arguments required for the function
  8566. </summary>
  8567. </member>
  8568. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsText.MaxArgs">
  8569. <summary>
  8570. Maximum number of arguments required for the function
  8571. </summary>
  8572. </member>
  8573. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionIsEven">
  8574. <summary>
  8575. Returns TRUE if the specified value is an even number.
  8576. </summary>
  8577. <remarks>
  8578. <p class="body">ISEVEN(value)</p>
  8579. <p class="body">Value is a number thought to be even (divisible by the
  8580. integer 2.) A value that is not an integer will first be converted to
  8581. an integer using the <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionFloor">FLOOR</see>
  8582. function before evaluation.</p>
  8583. <seealso cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionIsOdd">ISODD function</seealso>
  8584. </remarks>
  8585. </member>
  8586. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionIsEven.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  8587. <summary>
  8588. Evaluates the function against the arguments on the number stack
  8589. </summary>
  8590. <param name="numberStack">Formula number stack containing function arguments</param>
  8591. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  8592. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  8593. </member>
  8594. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsEven.Name">
  8595. <summary>
  8596. Function name used to reference the function in a formula
  8597. </summary>
  8598. </member>
  8599. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsEven.MinArgs">
  8600. <summary>
  8601. Minimum number of arguments required for the function
  8602. </summary>
  8603. </member>
  8604. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsEven.MaxArgs">
  8605. <summary>
  8606. Maximum number of arguments required for the function
  8607. </summary>
  8608. </member>
  8609. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionIsOdd">
  8610. <summary>
  8611. Returns TRUE if the specified value is an odd number.
  8612. </summary>
  8613. <remarks>
  8614. <p class="body">ISODD(value)</p>
  8615. <p class="body">Value is a number thought to be odd (not divisible by
  8616. the integer 2.) A value that is not an integer will first be converted
  8617. to an integer using the <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionFloor">FLOOR</see>
  8618. function before evaluation.</p>
  8619. <seealso cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionIsEven">ISEVEN function</seealso>
  8620. </remarks>
  8621. </member>
  8622. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionIsOdd.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  8623. <summary>
  8624. Evaluates the function against the arguments on the number stack
  8625. </summary>
  8626. <param name="numberStack">Formula number stack containing function arguments</param>
  8627. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  8628. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  8629. </member>
  8630. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsOdd.Name">
  8631. <summary>
  8632. Function name used to reference the function in a formula
  8633. </summary>
  8634. </member>
  8635. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsOdd.MinArgs">
  8636. <summary>
  8637. Minimum number of arguments required for the function
  8638. </summary>
  8639. </member>
  8640. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsOdd.MaxArgs">
  8641. <summary>
  8642. Maximum number of arguments required for the function
  8643. </summary>
  8644. </member>
  8645. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionIRR">
  8646. <summary>
  8647. Calculates an internal rate of return for a given series of cash flows represented by either positive (incoming) or
  8648. negative (outgoing) numeric values.
  8649. </summary>
  8650. <remarks>
  8651. <p class="body">IRR(value_reference, estimate)</p>
  8652. <p class="body">Value_reference must be a column or range reference of numeric values representing cash outflows
  8653. (payments) as negative numeric values, and cash inflows (income) as positive numeric values. Each cash flow must
  8654. occur with a regular period. If payments occur at irregular intervals, then you must represent the cash flow periods
  8655. as taking place on a period common to all cash flows, and at intervals without a cash flow specify a zero value.
  8656. For example, if you finance the purchase of a television by taking a $300 loan with monthly payments of $110, but
  8657. your payments do not start for three months, your series of cash flows would be monthly but would show three zero
  8658. values for the months without payments (+300, 0, 0, 0, -110, -110, -110).</p>
  8659. <p class="body">Estimate is an approximation close to what you expect the resulting internal rate of return to
  8660. be. This function employs an iterative algorithm starting with this estimate and then repeatedly converging on
  8661. a result that has a diminishing margin of error. If you do not provide an <em>estimate</em> then this function
  8662. uses 10 percent as it's starting point.</p>
  8663. <p class="body">If after twenty iterations the margin of error has not closed to within 1/1000 basis point then
  8664. a #NUM error value will be returned.</p>
  8665. <p class="body">The IRR() function has applications where you may be given a series of cash flows without an
  8666. interest rate, such as in the retail financing example above, and wish to calculate what it's effective rate
  8667. of interest would be. The internal rate is based on the period between cash flows, therefore when calculating
  8668. payments that are not annual, you must annualize the internal rate.</p>
  8669. <seealso cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionNPV">NPV()</seealso>
  8670. </remarks>
  8671. </member>
  8672. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionIRR.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  8673. <summary>
  8674. Evaluates the function against the arguments on the number stack
  8675. </summary>
  8676. <param name="numberStack">Formula number stack containing function arguments</param>
  8677. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  8678. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  8679. </member>
  8680. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIRR.Name">
  8681. <summary>
  8682. Function name used to reference the function in a formula
  8683. </summary>
  8684. </member>
  8685. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIRR.MinArgs">
  8686. <summary>
  8687. Minimum number of arguments required for the function
  8688. </summary>
  8689. </member>
  8690. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIRR.MaxArgs">
  8691. <summary>
  8692. Maximum number of arguments required for the function
  8693. </summary>
  8694. </member>
  8695. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionRate">
  8696. <summary>
  8697. Calculates the per-period interest rate for a series of cash flows (an annuity).
  8698. </summary>
  8699. <remarks>
  8700. <p class="body">RATE(nPeriods, amount, presentValue, paymentDue, futureValue, estimate)</p>
  8701. <p class="body">NPeriods are the total number of cash flows, whether a payment (negative <em>amount</em>)
  8702. or a receipt (positive <em>amount</em>) occuring periodically with a fixed time period between each cash
  8703. flow.</p>
  8704. <p class="body">Amount is the amount of cash paid (negative) or received (positive). It must be held
  8705. constant over the course of the annuity.</p>
  8706. <p class="body">PresentValue is the value today of the series of future payments. Payments made in the
  8707. future are discounted by the interest rate being calculated, because it is assumed that at that interest
  8708. rate a smaller sum could be invested today and would grow to the <em>amount</em> at a future time when
  8709. that payment became due.</p>
  8710. <p class="body">PaymentDue indicates whether cash flows occur at the beginning of each period (1) or at
  8711. the end of each period (0). If not specified, the payments at the end of each period is assumed.</p>
  8712. <p class="body">FutureValue is the accumulated balance attained after <em>nPeriods</em> payments have
  8713. been made and accrued interest at the calculated rate. If left unspecified, the default future value
  8714. is assumed to be zero (this represents reaching zero loan liability, when a loan has been fully repaid).
  8715. </p>
  8716. <p class="body">Estimate is an approximation of the interest rate used to start the calculation (which
  8717. works by iteratively refining the <em>estimate</em> until it converges on the correct value). When no
  8718. <em>estimate</em> is given a default of 10% is assumed.</p>
  8719. </remarks>
  8720. </member>
  8721. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionRate.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  8722. <summary>
  8723. Evaluates the function against the arguments on the number stack
  8724. </summary>
  8725. <param name="numberStack">Formula number stack containing function arguments</param>
  8726. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  8727. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  8728. </member>
  8729. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRate.Name">
  8730. <summary>
  8731. Function name used to reference the function in a formula
  8732. </summary>
  8733. </member>
  8734. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRate.MinArgs">
  8735. <summary>
  8736. Minimum number of arguments required for the function
  8737. </summary>
  8738. </member>
  8739. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRate.MaxArgs">
  8740. <summary>
  8741. Maximum number of arguments required for the function
  8742. </summary>
  8743. </member>
  8744. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionIsNull">
  8745. <summary>
  8746. Returns a boolean indicating if the value is null (Nothing in VB).
  8747. </summary>
  8748. </member>
  8749. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionIsNull.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  8750. <summary>
  8751. Evaluates the function against the arguments on the number stack
  8752. </summary>
  8753. <param name="numberStack">Formula number stack containing function arguments</param>
  8754. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  8755. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  8756. </member>
  8757. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsNull.Name">
  8758. <summary>
  8759. Function name used to reference the function in a formula
  8760. </summary>
  8761. </member>
  8762. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsNull.MinArgs">
  8763. <summary>
  8764. Minimum number of arguments required for the function
  8765. </summary>
  8766. </member>
  8767. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsNull.MaxArgs">
  8768. <summary>
  8769. Maximum number of arguments required for the function
  8770. </summary>
  8771. </member>
  8772. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionNull">
  8773. <summary>
  8774. Returns a null value (Nothing in VB)
  8775. </summary>
  8776. </member>
  8777. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionNull.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  8778. <summary>
  8779. Evaluates the function against the arguments on the number stack
  8780. </summary>
  8781. <param name="numberStack">Formula number stack containing function arguments</param>
  8782. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  8783. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  8784. </member>
  8785. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionNull.Name">
  8786. <summary>
  8787. Function name used to reference the function in a formula
  8788. </summary>
  8789. </member>
  8790. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionNull.MinArgs">
  8791. <summary>
  8792. Minimum number of arguments required for the function
  8793. </summary>
  8794. </member>
  8795. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionNull.MaxArgs">
  8796. <summary>
  8797. Maximum number of arguments required for the function
  8798. </summary>
  8799. </member>
  8800. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionIsDBNull">
  8801. <summary>
  8802. Returns a boolean indicating if the value is DBNull.
  8803. </summary>
  8804. </member>
  8805. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionIsDBNull.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  8806. <summary>
  8807. Evaluates the function against the arguments on the number stack
  8808. </summary>
  8809. <param name="numberStack">Formula number stack containing function arguments</param>
  8810. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  8811. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  8812. </member>
  8813. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsDBNull.Name">
  8814. <summary>
  8815. Function name used to reference the function in a formula
  8816. </summary>
  8817. </member>
  8818. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsDBNull.MinArgs">
  8819. <summary>
  8820. Minimum number of arguments required for the function
  8821. </summary>
  8822. </member>
  8823. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionIsDBNull.MaxArgs">
  8824. <summary>
  8825. Maximum number of arguments required for the function
  8826. </summary>
  8827. </member>
  8828. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionDBNull">
  8829. <summary>
  8830. Returns DBNull
  8831. </summary>
  8832. </member>
  8833. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionDBNull.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  8834. <summary>
  8835. Evaluates the function against the arguments on the number stack
  8836. </summary>
  8837. <param name="numberStack">Formula number stack containing function arguments</param>
  8838. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  8839. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  8840. </member>
  8841. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDBNull.Name">
  8842. <summary>
  8843. Function name used to reference the function in a formula
  8844. </summary>
  8845. </member>
  8846. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDBNull.MinArgs">
  8847. <summary>
  8848. Minimum number of arguments required for the function
  8849. </summary>
  8850. </member>
  8851. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDBNull.MaxArgs">
  8852. <summary>
  8853. Maximum number of arguments required for the function
  8854. </summary>
  8855. </member>
  8856. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionDateAdd">
  8857. <summary>
  8858. Returns a <see cref="T:System.DateTime"/> value resulting from adding a specified interval to a DateTime.
  8859. </summary>
  8860. </member>
  8861. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionDateAdd.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  8862. <summary>
  8863. Evaluates the function against the arguments on the number stack
  8864. </summary>
  8865. <param name="numberStack">Formula number stack containing function arguments</param>
  8866. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  8867. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  8868. </member>
  8869. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDateAdd.Name">
  8870. <summary>
  8871. Function name used to reference the function in a formula
  8872. </summary>
  8873. </member>
  8874. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDateAdd.MinArgs">
  8875. <summary>
  8876. Minimum number of arguments required for the function
  8877. </summary>
  8878. </member>
  8879. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDateAdd.MaxArgs">
  8880. <summary>
  8881. Maximum number of arguments required for the function
  8882. </summary>
  8883. </member>
  8884. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionDateDiff">
  8885. <summary>
  8886. Returns a value specifying the number of time intervals between two DateTime values.
  8887. </summary>
  8888. </member>
  8889. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionDateDiff.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  8890. <summary>
  8891. Evaluates the function against the arguments on the number stack
  8892. </summary>
  8893. <param name="numberStack">Formula number stack containing function arguments</param>
  8894. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  8895. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  8896. </member>
  8897. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDateDiff.Name">
  8898. <summary>
  8899. Function name used to reference the function in a formula
  8900. </summary>
  8901. </member>
  8902. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDateDiff.MinArgs">
  8903. <summary>
  8904. Minimum number of arguments required for the function
  8905. </summary>
  8906. </member>
  8907. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDateDiff.MaxArgs">
  8908. <summary>
  8909. Maximum number of arguments required for the function
  8910. </summary>
  8911. </member>
  8912. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionChar">
  8913. <summary>
  8914. Returns the character specified by the code number from the character set for your computer.
  8915. </summary>
  8916. </member>
  8917. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionChar.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  8918. <summary>
  8919. Evaluates the function against the arguments on the number stack
  8920. </summary>
  8921. <param name="numberStack">Formula number stack containing function arguments</param>
  8922. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  8923. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  8924. </member>
  8925. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionChar.Name">
  8926. <summary>
  8927. Function name used to reference the function in a formula
  8928. </summary>
  8929. </member>
  8930. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionChar.MinArgs">
  8931. <summary>
  8932. Minimum number of arguments required for the function
  8933. </summary>
  8934. </member>
  8935. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionChar.MaxArgs">
  8936. <summary>
  8937. Maximum number of arguments required for the function
  8938. </summary>
  8939. </member>
  8940. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionCode">
  8941. <summary>
  8942. Gives you the numeric code corresponding the the first character in a
  8943. specific text string.
  8944. </summary>
  8945. <remarks>
  8946. <p class="body">CODE(Text)</p>
  8947. <p class="body">Text is a text string of at least one character in length.
  8948. This function returns the numeric code of the first character in <em>Text</em>.
  8949. These code values correspond to those used by your machine to encode the text
  8950. characters in a string (<em>e.g.</em>, Unicode).</p>
  8951. <p class="body">If <em>Text</em> is an empty string of zero length, then
  8952. this function returns the code zero.</p>
  8953. </remarks>
  8954. </member>
  8955. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionCode.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  8956. <summary>
  8957. Evaluates the function against the arguments on the number stack
  8958. </summary>
  8959. <param name="numberStack">Formula number stack containing function arguments</param>
  8960. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  8961. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  8962. </member>
  8963. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionCode.Name">
  8964. <summary>
  8965. Function name used to reference the function in a formula
  8966. </summary>
  8967. </member>
  8968. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionCode.MinArgs">
  8969. <summary>
  8970. Minimum number of arguments required for the function
  8971. </summary>
  8972. </member>
  8973. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionCode.MaxArgs">
  8974. <summary>
  8975. Maximum number of arguments required for the function
  8976. </summary>
  8977. </member>
  8978. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionFixed">
  8979. <summary>
  8980. Formats a numeric value rounded to a specified number of decimal places and
  8981. with optional thousands separators.
  8982. </summary>
  8983. <remarks>
  8984. <p class="body">FIXED(value, decimal_places, exclude_thousands_separators)</p>
  8985. <p class="body">Value is the numeric value to be rounded and formatted as text.</p>
  8986. <p class="body">Decimal_places indicate how many places to the right of the decimal point
  8987. the <em>value</em> should be rounded. If omitted, rounding occurs to two decimal places.</p>
  8988. <p class="body">Exclude_thousands_separators is a boolean value (TRUE or FALSE) indicating
  8989. whether commas should appear in the formatted text value. By default the formatted text
  8990. includes commas as thousands separators.</p>
  8991. <p class="body">This function may not return text values consistent with your locale's
  8992. formatting of numbers because it operates using culture invariant settings (these include
  8993. commas as thousands separators and decimal points) to facilitate unambiguously parsing the
  8994. text values it formats into numeric values for subsequent calculations. Applications may
  8995. instead choose to format numeric values after UltraCalc has finished processing them, but
  8996. before presenting them to their end user.</p>
  8997. </remarks>
  8998. </member>
  8999. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionFixed.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  9000. <summary>
  9001. Evaluates the function against the arguments on the number stack
  9002. </summary>
  9003. <param name="numberStack">Formula number stack containing function arguments</param>
  9004. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  9005. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  9006. </member>
  9007. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionFixed.Name">
  9008. <summary>
  9009. Function name used to reference the function in a formula
  9010. </summary>
  9011. </member>
  9012. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionFixed.MinArgs">
  9013. <summary>
  9014. Minimum number of arguments required for the function
  9015. </summary>
  9016. </member>
  9017. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionFixed.MaxArgs">
  9018. <summary>
  9019. Maximum number of arguments required for the function
  9020. </summary>
  9021. </member>
  9022. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionToday">
  9023. <summary>
  9024. Gets the host's current date.
  9025. </summary>
  9026. <remarks>
  9027. <p class="body">No arguments are passed to this function.</p>
  9028. <p class="body">The date returned for TODAY() is based on the local time of the
  9029. host running UltraCalc. In some distributed applications, such as those built for
  9030. the Web, this may be different from today's date at the client.</p>
  9031. <p class="body">The date/time value returned is always adjusted to Midnight
  9032. (00:00).</p>
  9033. </remarks>
  9034. </member>
  9035. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionToday.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  9036. <summary>
  9037. Evaluates the function against the arguments on the number stack
  9038. </summary>
  9039. <param name="numberStack">Formula number stack containing function arguments</param>
  9040. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  9041. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  9042. </member>
  9043. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionToday.IsAlwaysDirty">
  9044. <summary>
  9045. Indicates whether the results of the function is always dirty.
  9046. </summary>
  9047. </member>
  9048. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionToday.Name">
  9049. <summary>
  9050. Function name used to reference the function in a formula
  9051. </summary>
  9052. </member>
  9053. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionToday.MinArgs">
  9054. <summary>
  9055. Minimum number of arguments required for the function
  9056. </summary>
  9057. </member>
  9058. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionToday.MaxArgs">
  9059. <summary>
  9060. Maximum number of arguments required for the function
  9061. </summary>
  9062. </member>
  9063. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionASinh">
  9064. <summary>
  9065. Returns the angle (measured in radians) having the specified value of it's hyperbolic sine function.
  9066. </summary>
  9067. <remarks>
  9068. <p class="body">ASINH(value)</p>
  9069. <p class="body">Value is the hyperbolic sine of some angle (measured in radians) that you want
  9070. to find. As you might expect, the values of the hyperbolic sine function (see the <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionSinh">SINH</see> function)
  9071. increase at a hyperbolic rate, but one consequence is that these ever larger changes in the hyperbolic
  9072. sine will correspond to ever smaller changes in the angle. This relationship is intrinsic to many of
  9073. the mathematical and engineering applications of the inverse hyperbolic sine function, such as when
  9074. resistance or strain builds up on a body increasingly as it is rotated (hysteresis).</p>
  9075. </remarks>
  9076. </member>
  9077. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionASinh.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  9078. <summary>
  9079. Evaluates the function, Arcsinh, against the arguments on the number stack.
  9080. </summary>
  9081. <param name="numberStack">Formula number stack containing function arguments.</param>
  9082. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  9083. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  9084. </member>
  9085. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionASinh.Name">
  9086. <summary>
  9087. Function name used to reference the function in a formula.
  9088. </summary>
  9089. </member>
  9090. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionASinh.MinArgs">
  9091. <summary>
  9092. Minimum number of arguments required for the function.
  9093. </summary>
  9094. </member>
  9095. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionASinh.MaxArgs">
  9096. <summary>
  9097. Maximum number of arguments required for the function.
  9098. </summary>
  9099. </member>
  9100. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionATanh">
  9101. <summary>
  9102. Calculates the hyperbolic tangent of a specified angle measured in radians.
  9103. </summary>
  9104. <remarks>
  9105. <p class="body">TANH(value)</p>
  9106. <p class="body">Value is an angle measured in radians for which you want to
  9107. calculate the hyperbolic tangent. If your angle is measured in degrees,
  9108. multiply it by PI()/180 to convert into radians. The hyperbolic tangent
  9109. has a range from -1 to 1.</p>
  9110. </remarks>
  9111. </member>
  9112. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionATanh.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  9113. <summary>
  9114. Evaluates the function, Arctanh, against the arguments on the number stack.
  9115. </summary>
  9116. <param name="numberStack">Formula number stack containing function arguments.</param>
  9117. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  9118. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  9119. </member>
  9120. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionATanh.Name">
  9121. <summary>
  9122. Function name used to reference the function in a formula.
  9123. </summary>
  9124. </member>
  9125. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionATanh.MinArgs">
  9126. <summary>
  9127. Minimum number of arguments required for the function.
  9128. </summary>
  9129. </member>
  9130. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionATanh.MaxArgs">
  9131. <summary>
  9132. Maximum number of arguments required for the function.
  9133. </summary>
  9134. </member>
  9135. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionACosh">
  9136. <summary>
  9137. Returns the angle (measured in radians) having the specified value of it's hyperbolic cosine function.
  9138. </summary>
  9139. <remarks>
  9140. <p class="body">ACOSH(value)</p>
  9141. <p class="body">Value is the hyperbolic cosine of some angle (measured in radians) that you want
  9142. to find. As you might expect, the values of the hyperbolic cosine function (see the <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionCosh">COSH</see> function)
  9143. increase at a hyperbolic rate, but one consequence is that these ever larger changes in the hyperbolic
  9144. cosine will correspond to ever smaller changes in the angle. This relationship is intrinsic to many of
  9145. the mathematical and engineering applications of the inverse hyperbolic cosine function, such as when
  9146. resistance or strain builds up on a body increasingly as it is rotated (hysteresis).</p>
  9147. </remarks>
  9148. </member>
  9149. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionACosh.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  9150. <summary>
  9151. Evaluates the function, Arccosh, against the arguments on the number stack.
  9152. </summary>
  9153. <param name="numberStack">Formula number stack containing function arguments.</param>
  9154. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  9155. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  9156. </member>
  9157. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionACosh.Name">
  9158. <summary>
  9159. Function name used to reference the function in a formula.
  9160. </summary>
  9161. </member>
  9162. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionACosh.MinArgs">
  9163. <summary>
  9164. Minimum number of arguments required for the function.
  9165. </summary>
  9166. </member>
  9167. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionACosh.MaxArgs">
  9168. <summary>
  9169. Maximum number of arguments required for the function.
  9170. </summary>
  9171. </member>
  9172. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionEDate">
  9173. <summary>
  9174. Returns a date that is the specified number of months before or after the start date.
  9175. </summary>
  9176. <remarks>
  9177. <p class="body">
  9178. DATE(date, numberOfMonths)
  9179. <br/>
  9180. Date is the starting date
  9181. <br/>
  9182. NumberOfMonths is a number of months to shift the date. A positive number means a date after the startdate. A negative number indicates a date prior to the start date.
  9183. </p>
  9184. </remarks>
  9185. </member>
  9186. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionEDate.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  9187. <summary>
  9188. Evaluates the function against the arguments on the number stack
  9189. </summary>
  9190. <param name="numberStack">Formula number stack containing function arguments</param>
  9191. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  9192. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  9193. </member>
  9194. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionEDate.Name">
  9195. <summary>
  9196. Function name used to reference the function in a formula
  9197. </summary>
  9198. </member>
  9199. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionEDate.MinArgs">
  9200. <summary>
  9201. Minimum number of arguments required for the function
  9202. </summary>
  9203. </member>
  9204. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionEDate.MaxArgs">
  9205. <summary>
  9206. Maximum number of arguments required for the function
  9207. </summary>
  9208. </member>
  9209. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionEOMonth">
  9210. <summary>
  9211. Returns a date that is at the end of the month which is the specified number of months before or after the start date.
  9212. </summary>
  9213. <remarks>
  9214. <p class="body">
  9215. EOMONTH(date, numberOfMonths)
  9216. <br/>
  9217. Date is the starting date
  9218. <br/>
  9219. NumberOfMonths is a number of months to shift the date. A positive number means a date after the startdate. A negative number indicates a date prior to the start date.
  9220. </p>
  9221. </remarks>
  9222. </member>
  9223. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionEOMonth.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  9224. <summary>
  9225. Evaluates the function against the arguments on the number stack
  9226. </summary>
  9227. <param name="numberStack">Formula number stack containing function arguments</param>
  9228. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  9229. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  9230. </member>
  9231. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionEOMonth.Name">
  9232. <summary>
  9233. Function name used to reference the function in a formula
  9234. </summary>
  9235. </member>
  9236. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionEOMonth.MinArgs">
  9237. <summary>
  9238. Minimum number of arguments required for the function
  9239. </summary>
  9240. </member>
  9241. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionEOMonth.MaxArgs">
  9242. <summary>
  9243. Maximum number of arguments required for the function
  9244. </summary>
  9245. </member>
  9246. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionWeekDay">
  9247. <summary>
  9248. Returns a number representing the day of the week of the specified date.
  9249. </summary>
  9250. <remarks>
  9251. <p class="body">
  9252. WEEKDAY(date, returnType)
  9253. <br/>
  9254. Date is a date.
  9255. <br/>
  9256. ReturnType determines which numbering scheme is used for the days of the week.
  9257. 1 (default) = Sunday (1) through Saturday (7)
  9258. 2 = Monday (1) through Sunday (7)
  9259. 3 = Monday (0) through Sunday (6)
  9260. </p>
  9261. </remarks>
  9262. </member>
  9263. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionWeekDay.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  9264. <summary>
  9265. Evaluates the function against the arguments on the number stack
  9266. </summary>
  9267. <param name="numberStack">Formula number stack containing function arguments</param>
  9268. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  9269. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  9270. </member>
  9271. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionWeekDay.Name">
  9272. <summary>
  9273. Function name used to reference the function in a formula
  9274. </summary>
  9275. </member>
  9276. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionWeekDay.MinArgs">
  9277. <summary>
  9278. Minimum number of arguments required for the function
  9279. </summary>
  9280. </member>
  9281. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionWeekDay.MaxArgs">
  9282. <summary>
  9283. Maximum number of arguments required for the function
  9284. </summary>
  9285. </member>
  9286. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionNetWorkDays">
  9287. <summary>
  9288. Returns the total number of whole work days between the specified dates, excluding any specified holidays.
  9289. </summary>
  9290. <remarks>
  9291. <p class="body">
  9292. NETWORKDAYS(startDate, endDate [, holiday1, holiday2, ..., holidayN])
  9293. <br/>
  9294. StartDate is the date from which to start.
  9295. <br/>
  9296. EndDate is the date at which to end.
  9297. <br/>
  9298. Holiday1, holiday2, ..., holidayN is any number of dates or range references containing dates that are to be considered non-working days.
  9299. </p>
  9300. </remarks>
  9301. </member>
  9302. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionNetWorkDays.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  9303. <summary>
  9304. Evaluates the function against the arguments on the number stack
  9305. </summary>
  9306. <param name="numberStack">Formula number stack containing function arguments</param>
  9307. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  9308. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  9309. </member>
  9310. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionNetWorkDays.Name">
  9311. <summary>
  9312. Function name used to reference the function in a formula
  9313. </summary>
  9314. </member>
  9315. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionNetWorkDays.MinArgs">
  9316. <summary>
  9317. Minimum number of arguments required for the function
  9318. </summary>
  9319. </member>
  9320. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionNetWorkDays.MaxArgs">
  9321. <summary>
  9322. Maximum number of arguments required for the function
  9323. </summary>
  9324. </member>
  9325. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionWeekNum">
  9326. <summary>
  9327. Returns the number of the week into which the specified date falls.
  9328. </summary>
  9329. <remarks>
  9330. <p class="body">
  9331. WEEKNUM(date, returnType)
  9332. <br/>
  9333. Date is a date.
  9334. <br/>
  9335. ReturnType determines which day begins the week.
  9336. 1 (default) = Sunday is the first day of the week.
  9337. 2 = Monday is the first day of the week.
  9338. </p>
  9339. </remarks>
  9340. </member>
  9341. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionWeekNum.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  9342. <summary>
  9343. Evaluates the function against the arguments on the number stack
  9344. </summary>
  9345. <param name="numberStack">Formula number stack containing function arguments</param>
  9346. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  9347. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  9348. </member>
  9349. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionWeekNum.Name">
  9350. <summary>
  9351. Function name used to reference the function in a formula
  9352. </summary>
  9353. </member>
  9354. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionWeekNum.MinArgs">
  9355. <summary>
  9356. Minimum number of arguments required for the function
  9357. </summary>
  9358. </member>
  9359. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionWeekNum.MaxArgs">
  9360. <summary>
  9361. Maximum number of arguments required for the function
  9362. </summary>
  9363. </member>
  9364. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionWorkDay">
  9365. <summary>
  9366. Returns a work day the specified number of days from the specified date, excluding any specified holidays.
  9367. </summary>
  9368. <remarks>
  9369. <p class="body">
  9370. WORKDAY(startDate, days [, holiday1, holiday2, ..., holidayN])
  9371. <br/>
  9372. StartDate is the date from which to start.
  9373. <br/>
  9374. Days is the number of work days to offset from the start date.
  9375. <br/>
  9376. Holiday1, holiday2, ..., holidayN is any number of dates or range references containing dates that are to be considered non-working days.
  9377. </p>
  9378. </remarks>
  9379. </member>
  9380. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionWorkDay.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  9381. <summary>
  9382. Evaluates the function against the arguments on the number stack
  9383. </summary>
  9384. <param name="numberStack">Formula number stack containing function arguments</param>
  9385. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  9386. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  9387. </member>
  9388. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionWorkDay.Name">
  9389. <summary>
  9390. Function name used to reference the function in a formula
  9391. </summary>
  9392. </member>
  9393. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionWorkDay.MinArgs">
  9394. <summary>
  9395. Minimum number of arguments required for the function
  9396. </summary>
  9397. </member>
  9398. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionWorkDay.MaxArgs">
  9399. <summary>
  9400. Maximum number of arguments required for the function
  9401. </summary>
  9402. </member>
  9403. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionDec2XBase">
  9404. <summary>
  9405. Returns a string representing the specified decimal value in the specified base number scheme.
  9406. </summary>
  9407. <remarks>
  9408. <p class="body">
  9409. Dec2X(number, places)
  9410. <br/>
  9411. Number is the decimal value to be converted.
  9412. <br/>
  9413. Places is the number of characters to use in representing the value. If places is not specified, the mimumum number of characters neccessary to represent the value will be used. Places allows you to specify leading zeros.
  9414. </p>
  9415. </remarks>
  9416. </member>
  9417. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionDec2XBase.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  9418. <summary>
  9419. Evaluates the function against the arguments on the number stack
  9420. </summary>
  9421. <param name="numberStack">Formula number stack containing function arguments</param>
  9422. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  9423. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  9424. </member>
  9425. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDec2XBase.MinNumber">
  9426. <summary>
  9427. The minimum value that the number argument to this function will allow.
  9428. </summary>
  9429. </member>
  9430. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDec2XBase.MaxNumber">
  9431. <summary>
  9432. The maximum value that the number argument to this function will allow.
  9433. </summary>
  9434. </member>
  9435. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDec2XBase.NumberSystem">
  9436. <summary>
  9437. The number system to convert to (2 = binary, 8 = octal, 16 = Hexadecimal, etc.)
  9438. </summary>
  9439. </member>
  9440. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDec2XBase.MinArgs">
  9441. <summary>
  9442. Minimum number of arguments required for the function
  9443. </summary>
  9444. </member>
  9445. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDec2XBase.MaxArgs">
  9446. <summary>
  9447. Maximum number of arguments required for the function
  9448. </summary>
  9449. </member>
  9450. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionDec2Bin">
  9451. <summary>
  9452. Returns a string representing the specified decimal value as a binary number.
  9453. </summary>
  9454. <remarks>
  9455. <p class="body">
  9456. Dec2Bin(number, places)
  9457. <br/>
  9458. Number is the decimal value to be converted.
  9459. <br/>
  9460. Places is the number of characters to use in representing the value. If places is not specified, the mimumum number of characters neccessary to represent the value will be used. Places allows you to specify leading zeros.
  9461. </p>
  9462. </remarks>
  9463. </member>
  9464. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDec2Bin.Name">
  9465. <summary>
  9466. Function name used to reference the function in a formula
  9467. </summary>
  9468. </member>
  9469. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDec2Bin.MinNumber">
  9470. <summary>
  9471. The minimum value that the number argument to this function will allow.
  9472. </summary>
  9473. </member>
  9474. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDec2Bin.MaxNumber">
  9475. <summary>
  9476. The maximum value that the number argument to this function will allow.
  9477. </summary>
  9478. </member>
  9479. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDec2Bin.NumberSystem">
  9480. <summary>
  9481. The number system to convert to (2 = binary, 8 = octal, 16 = Hexadecimal, etc.)
  9482. </summary>
  9483. </member>
  9484. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionDec2Hex">
  9485. <summary>
  9486. Returns a string representing the specified decimal value as a hexadecimal number.
  9487. </summary>
  9488. <remarks>
  9489. <p class="body">
  9490. Dec2Hex(number, places)
  9491. <br/>
  9492. Number is the decimal value to be converted.
  9493. <br/>
  9494. Places is the number of characters to use in representing the value. If places is not specified, the mimumum number of characters neccessary to represent the value will be used. Places allows you to specify leading zeros.
  9495. </p>
  9496. </remarks>
  9497. </member>
  9498. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDec2Hex.Name">
  9499. <summary>
  9500. Function name used to reference the function in a formula
  9501. </summary>
  9502. </member>
  9503. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDec2Hex.MinNumber">
  9504. <summary>
  9505. The minimum value that the number argument to this function will allow.
  9506. </summary>
  9507. </member>
  9508. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDec2Hex.MaxNumber">
  9509. <summary>
  9510. The maximum value that the number argument to this function will allow.
  9511. </summary>
  9512. </member>
  9513. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDec2Hex.NumberSystem">
  9514. <summary>
  9515. The number system to convert to (2 = hexadecimal, 8 = octal, 16 = Hexadecimal, etc.)
  9516. </summary>
  9517. </member>
  9518. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionDec2Oct">
  9519. <summary>
  9520. Returns a string representing the specified decimal value as a octal number.
  9521. </summary>
  9522. <remarks>
  9523. <p class="body">
  9524. Dec2Oct(number, places)
  9525. <br/>
  9526. Number is the decimal value to be converted.
  9527. <br/>
  9528. Places is the number of characters to use in representing the value. If places is not specified, the mimumum number of characters neccessary to represent the value will be used. Places allows you to specify leading zeros.
  9529. </p>
  9530. </remarks>
  9531. </member>
  9532. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDec2Oct.Name">
  9533. <summary>
  9534. Function name used to reference the function in a formula
  9535. </summary>
  9536. </member>
  9537. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDec2Oct.MinNumber">
  9538. <summary>
  9539. The minimum value that the number argument to this function will allow.
  9540. </summary>
  9541. </member>
  9542. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDec2Oct.MaxNumber">
  9543. <summary>
  9544. The maximum value that the number argument to this function will allow.
  9545. </summary>
  9546. </member>
  9547. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDec2Oct.NumberSystem">
  9548. <summary>
  9549. The number system to convert to (2 = octal, 8 = octal, 16 = Hexadecimal, etc.)
  9550. </summary>
  9551. </member>
  9552. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionXBase2Dec">
  9553. <summary>
  9554. Returns the decimal value of a string representation of a number in a non-decimal number system.
  9555. </summary>
  9556. <remarks>
  9557. <p class="body">
  9558. X2Dec(number)
  9559. <br/>
  9560. Number is a string represeting a number in a non-decimal number system.
  9561. </p>
  9562. </remarks>
  9563. </member>
  9564. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionXBase2Dec.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  9565. <summary>
  9566. Evaluates the function against the arguments on the number stack
  9567. </summary>
  9568. <param name="numberStack">Formula number stack containing function arguments</param>
  9569. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  9570. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  9571. </member>
  9572. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionXBase2Dec.MinNumber">
  9573. <summary>
  9574. The minimum value that the number argument to this function will allow.
  9575. </summary>
  9576. </member>
  9577. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionXBase2Dec.MaxNumber">
  9578. <summary>
  9579. The maximum value that the number argument to this function will allow.
  9580. </summary>
  9581. </member>
  9582. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionXBase2Dec.NumberSystem">
  9583. <summary>
  9584. The number system to convert to (2 = binary, 8 = octal, 16 = Hexadecimal, etc.)
  9585. </summary>
  9586. </member>
  9587. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionXBase2Dec.MaxLength">
  9588. <summary>
  9589. The maximum length of the number string.
  9590. </summary>
  9591. </member>
  9592. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionXBase2Dec.MinArgs">
  9593. <summary>
  9594. Minimum number of arguments required for the function
  9595. </summary>
  9596. </member>
  9597. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionXBase2Dec.MaxArgs">
  9598. <summary>
  9599. Maximum number of arguments required for the function
  9600. </summary>
  9601. </member>
  9602. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionBin2Dec">
  9603. <summary>
  9604. Returns the decimal value of a string representation of a number in a binary system.
  9605. </summary>
  9606. <remarks>
  9607. <p class="body">
  9608. Bin2Dec(number)
  9609. <br/>
  9610. Number is a string represeting a binary number.
  9611. </p>
  9612. </remarks>
  9613. </member>
  9614. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionBin2Dec.Name">
  9615. <summary>
  9616. Function name used to reference the function in a formula
  9617. </summary>
  9618. </member>
  9619. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionBin2Dec.MinNumber">
  9620. <summary>
  9621. The minimum value that the number argument to this function will allow.
  9622. </summary>
  9623. </member>
  9624. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionBin2Dec.MaxNumber">
  9625. <summary>
  9626. The maximum value that the number argument to this function will allow.
  9627. </summary>
  9628. </member>
  9629. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionBin2Dec.NumberSystem">
  9630. <summary>
  9631. The number system to convert from (2 = binary, 8 = octal, 16 = Hexadecimal, etc.)
  9632. </summary>
  9633. </member>
  9634. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionBin2Dec.MaxLength">
  9635. <summary>
  9636. The maximum length of the 'number' string.
  9637. </summary>
  9638. </member>
  9639. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionHex2Dec">
  9640. <summary>
  9641. Returns the decimal value of a string representation of a number in a hexadecimal system.
  9642. </summary>
  9643. <remarks>
  9644. <p class="body">
  9645. Hex2Dec(number)
  9646. <br/>
  9647. Number is a string represeting a hexadecimal number.
  9648. </p>
  9649. </remarks>
  9650. </member>
  9651. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionHex2Dec.Name">
  9652. <summary>
  9653. Function name used to reference the function in a formula
  9654. </summary>
  9655. </member>
  9656. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionHex2Dec.MinNumber">
  9657. <summary>
  9658. The minimum value that the number argument to this function will allow.
  9659. </summary>
  9660. </member>
  9661. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionHex2Dec.MaxNumber">
  9662. <summary>
  9663. The maximum value that the number argument to this function will allow.
  9664. </summary>
  9665. </member>
  9666. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionHex2Dec.NumberSystem">
  9667. <summary>
  9668. The number system to convert to (2 = hexadecimal, 8 = octal, 16 = Hexadecimal, etc.)
  9669. </summary>
  9670. </member>
  9671. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionHex2Dec.MaxLength">
  9672. <summary>
  9673. The maximum length of the 'number' string.
  9674. </summary>
  9675. </member>
  9676. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionOct2Dec">
  9677. <summary>
  9678. Returns the decimal value of a string representation of a number in a octal system.
  9679. </summary>
  9680. <remarks>
  9681. <p class="body">
  9682. Oct2Dec(number)
  9683. <br/>
  9684. Number is a string represeting a octal number.
  9685. </p>
  9686. </remarks>
  9687. </member>
  9688. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionOct2Dec.Name">
  9689. <summary>
  9690. Function name used to reference the function in a formula
  9691. </summary>
  9692. </member>
  9693. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionOct2Dec.MinNumber">
  9694. <summary>
  9695. The minimum value that the number argument to this function will allow.
  9696. </summary>
  9697. </member>
  9698. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionOct2Dec.MaxNumber">
  9699. <summary>
  9700. The maximum value that the number argument to this function will allow.
  9701. </summary>
  9702. </member>
  9703. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionOct2Dec.NumberSystem">
  9704. <summary>
  9705. The number system to convert to (2 = octal, 8 = octal, 16 = Hexadecimal, etc.)
  9706. </summary>
  9707. </member>
  9708. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionOct2Dec.MaxLength">
  9709. <summary>
  9710. The maximum length of the 'number' string.
  9711. </summary>
  9712. </member>
  9713. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionXBase2XBase">
  9714. <summary>
  9715. Converts a string representing a number in a non-decimal number system to a number in another non-decimal number system.
  9716. </summary>
  9717. <remarks>
  9718. <p class="body">
  9719. XBase2XBase(number, places)
  9720. <br/>
  9721. Number is the value to be converted.
  9722. <br/>
  9723. Places is the number of characters to use in representing the value. If places is not specified, the mimumum number of characters neccessary to represent the value will be used. Places allows you to specify leading zeros.
  9724. </p>
  9725. </remarks>
  9726. </member>
  9727. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionXBase2XBase.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  9728. <summary>
  9729. Evaluates the function against the arguments on the number stack
  9730. </summary>
  9731. <param name="numberStack">Formula number stack containing function arguments</param>
  9732. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  9733. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  9734. </member>
  9735. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionXBase2XBase.OriginalMinNumber">
  9736. <summary>
  9737. The minimum value that the number argument to this function will allow in the original number system.
  9738. </summary>
  9739. </member>
  9740. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionXBase2XBase.OriginalMaxNumber">
  9741. <summary>
  9742. The maximum value that the number argument to this function will allow in the original number system.
  9743. </summary>
  9744. </member>
  9745. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionXBase2XBase.NewMinNumber">
  9746. <summary>
  9747. The minimum value that the number argument to this function will allow in the new number system.
  9748. </summary>
  9749. </member>
  9750. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionXBase2XBase.NewMaxNumber">
  9751. <summary>
  9752. The maximum value that the number argument to this function will allow in the new number system.
  9753. </summary>
  9754. </member>
  9755. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionXBase2XBase.OriginalNumberSystem">
  9756. <summary>
  9757. The number system to convert from (2 = binary, 8 = octal, 16 = Hexadecimal, etc.)
  9758. </summary>
  9759. </member>
  9760. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionXBase2XBase.NewNumberSystem">
  9761. <summary>
  9762. The number system to convert to (2 = binary, 8 = octal, 16 = Hexadecimal, etc.)
  9763. </summary>
  9764. </member>
  9765. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionXBase2XBase.MaxLength">
  9766. <summary>
  9767. The maximum length of the number string.
  9768. </summary>
  9769. </member>
  9770. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionXBase2XBase.MinArgs">
  9771. <summary>
  9772. Minimum number of arguments required for the function
  9773. </summary>
  9774. </member>
  9775. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionXBase2XBase.MaxArgs">
  9776. <summary>
  9777. Maximum number of arguments required for the function
  9778. </summary>
  9779. </member>
  9780. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionBin2Oct">
  9781. <summary>
  9782. Converts a string representing a binary number to a string representing the same number in the octal number system.
  9783. </summary>
  9784. <remarks>
  9785. <p class="body">
  9786. Bin2Oct(number, places)
  9787. <br/>
  9788. Number is the value to be converted.
  9789. <br/>
  9790. Places is the number of characters to use in representing the value. If places is not specified, the mimumum number of characters neccessary to represent the value will be used. Places allows you to specify leading zeros.
  9791. </p>
  9792. </remarks>
  9793. </member>
  9794. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionBin2Oct.Name">
  9795. <summary>
  9796. Function name used to reference the function in a formula
  9797. </summary>
  9798. </member>
  9799. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionBin2Oct.OriginalMinNumber">
  9800. <summary>
  9801. The minimum value that the number argument to this function will allow.
  9802. </summary>
  9803. </member>
  9804. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionBin2Oct.OriginalMaxNumber">
  9805. <summary>
  9806. The maximum value that the number argument to this function will allow.
  9807. </summary>
  9808. </member>
  9809. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionBin2Oct.NewMinNumber">
  9810. <summary>
  9811. The minimum value that the number argument to this function will allow in the new number system.
  9812. </summary>
  9813. </member>
  9814. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionBin2Oct.NewMaxNumber">
  9815. <summary>
  9816. The maximum value that the number argument to this function will allow in the new number system.
  9817. </summary>
  9818. </member>
  9819. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionBin2Oct.OriginalNumberSystem">
  9820. <summary>
  9821. The number system to convert from (2 = binary, 8 = octal, 16 = Hexadecimal, etc.)
  9822. </summary>
  9823. </member>
  9824. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionBin2Oct.NewNumberSystem">
  9825. <summary>
  9826. The number system to convert to (2 = binary, 8 = octal, 16 = Hexadecimal, etc.)
  9827. </summary>
  9828. </member>
  9829. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionBin2Oct.MaxLength">
  9830. <summary>
  9831. The maximum length of the 'number' string.
  9832. </summary>
  9833. </member>
  9834. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionBin2Hex">
  9835. <summary>
  9836. Converts a string representing a binary number to a string representing the same number in the hexadecimal number system.
  9837. </summary>
  9838. <remarks>
  9839. <p class="body">
  9840. Bin2Hex(number, places)
  9841. <br/>
  9842. Number is the value to be converted.
  9843. <br/>
  9844. Places is the number of characters to use in representing the value. If places is not specified, the mimumum number of characters neccessary to represent the value will be used. Places allows you to specify leading zeros.
  9845. </p>
  9846. </remarks>
  9847. </member>
  9848. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionBin2Hex.Name">
  9849. <summary>
  9850. Function name used to reference the function in a formula
  9851. </summary>
  9852. </member>
  9853. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionBin2Hex.OriginalMinNumber">
  9854. <summary>
  9855. The minimum value that the number argument to this function will allow.
  9856. </summary>
  9857. </member>
  9858. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionBin2Hex.OriginalMaxNumber">
  9859. <summary>
  9860. The maximum value that the number argument to this function will allow.
  9861. </summary>
  9862. </member>
  9863. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionBin2Hex.NewMinNumber">
  9864. <summary>
  9865. The minimum value that the number argument to this function will allow in the new number system.
  9866. </summary>
  9867. </member>
  9868. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionBin2Hex.NewMaxNumber">
  9869. <summary>
  9870. The maximum value that the number argument to this function will allow in the new number system.
  9871. </summary>
  9872. </member>
  9873. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionBin2Hex.OriginalNumberSystem">
  9874. <summary>
  9875. The number system to convert from (2 = binary, 8 = octal, 16 = Hexadecimal, etc.)
  9876. </summary>
  9877. </member>
  9878. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionBin2Hex.NewNumberSystem">
  9879. <summary>
  9880. The number system to convert to (2 = binary, 8 = octal, 16 = Hexadecimal, etc.)
  9881. </summary>
  9882. </member>
  9883. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionBin2Hex.MaxLength">
  9884. <summary>
  9885. The maximum length of the 'number' string.
  9886. </summary>
  9887. </member>
  9888. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionOct2Bin">
  9889. <summary>
  9890. Converts a string representing an octal number to a string representing the same number in the binary number system.
  9891. </summary>
  9892. <remarks>
  9893. <p class="body">
  9894. Oct2Bin(number, places)
  9895. <br/>
  9896. Number is the value to be converted.
  9897. <br/>
  9898. Places is the number of characters to use in representing the value. If places is not specified, the mimumum number of characters neccessary to represent the value will be used. Places allows you to specify leading zeros.
  9899. </p>
  9900. </remarks>
  9901. </member>
  9902. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionOct2Bin.Name">
  9903. <summary>
  9904. Function name used to reference the function in a formula
  9905. </summary>
  9906. </member>
  9907. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionOct2Bin.OriginalMinNumber">
  9908. <summary>
  9909. The minimum value that the number argument to this function will allow.
  9910. </summary>
  9911. </member>
  9912. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionOct2Bin.OriginalMaxNumber">
  9913. <summary>
  9914. The maximum value that the number argument to this function will allow.
  9915. </summary>
  9916. </member>
  9917. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionOct2Bin.NewMinNumber">
  9918. <summary>
  9919. The minimum value that the number argument to this function will allow in the new number system.
  9920. </summary>
  9921. </member>
  9922. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionOct2Bin.NewMaxNumber">
  9923. <summary>
  9924. The maximum value that the number argument to this function will allow in the new number system.
  9925. </summary>
  9926. </member>
  9927. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionOct2Bin.OriginalNumberSystem">
  9928. <summary>
  9929. The number system to convert from (2 = binary, 8 = octal, 16 = Hexadecimal, etc.)
  9930. </summary>
  9931. </member>
  9932. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionOct2Bin.NewNumberSystem">
  9933. <summary>
  9934. The number system to convert to (2 = binary, 8 = octal, 16 = Hexadecimal, etc.)
  9935. </summary>
  9936. </member>
  9937. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionOct2Bin.MaxLength">
  9938. <summary>
  9939. The maximum length of the 'number' string.
  9940. </summary>
  9941. </member>
  9942. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionOct2Hex">
  9943. <summary>
  9944. Converts a string representing an octal number to a string representing the same number in the hexadecimal number system.
  9945. </summary>
  9946. <remarks>
  9947. <p class="body">
  9948. Oct2Hex(number, places)
  9949. <br/>
  9950. Number is the value to be converted.
  9951. <br/>
  9952. Places is the number of characters to use in representing the value. If places is not specified, the mimumum number of characters neccessary to represent the value will be used. Places allows you to specify leading zeros.
  9953. </p>
  9954. </remarks>
  9955. </member>
  9956. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionOct2Hex.Name">
  9957. <summary>
  9958. Function name used to reference the function in a formula
  9959. </summary>
  9960. </member>
  9961. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionOct2Hex.OriginalMinNumber">
  9962. <summary>
  9963. The minimum value that the number argument to this function will allow.
  9964. </summary>
  9965. </member>
  9966. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionOct2Hex.OriginalMaxNumber">
  9967. <summary>
  9968. The maximum value that the number argument to this function will allow.
  9969. </summary>
  9970. </member>
  9971. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionOct2Hex.NewMinNumber">
  9972. <summary>
  9973. The minimum value that the number argument to this function will allow in the new number system.
  9974. </summary>
  9975. </member>
  9976. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionOct2Hex.NewMaxNumber">
  9977. <summary>
  9978. The maximum value that the number argument to this function will allow in the new number system.
  9979. </summary>
  9980. </member>
  9981. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionOct2Hex.OriginalNumberSystem">
  9982. <summary>
  9983. The number system to convert from (2 = binary, 8 = octal, 16 = Hexadecimal, etc.)
  9984. </summary>
  9985. </member>
  9986. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionOct2Hex.NewNumberSystem">
  9987. <summary>
  9988. The number system to convert to (2 = binary, 8 = octal, 16 = Hexadecimal, etc.)
  9989. </summary>
  9990. </member>
  9991. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionOct2Hex.MaxLength">
  9992. <summary>
  9993. The maximum length of the 'number' string.
  9994. </summary>
  9995. </member>
  9996. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionHex2Bin">
  9997. <summary>
  9998. Converts a string representing an hexadecimal number to a string representing the same number in the binary number system.
  9999. </summary>
  10000. <remarks>
  10001. <p class="body">
  10002. Hex2Bin(number, places)
  10003. <br/>
  10004. Number is the value to be converted.
  10005. <br/>
  10006. Places is the number of characters to use in representing the value. If places is not specified, the mimumum number of characters neccessary to represent the value will be used. Places allows you to specify leading zeros.
  10007. </p>
  10008. </remarks>
  10009. </member>
  10010. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionHex2Bin.Name">
  10011. <summary>
  10012. Function name used to reference the function in a formula
  10013. </summary>
  10014. </member>
  10015. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionHex2Bin.OriginalMinNumber">
  10016. <summary>
  10017. The minimum value that the number argument to this function will allow.
  10018. </summary>
  10019. </member>
  10020. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionHex2Bin.OriginalMaxNumber">
  10021. <summary>
  10022. The maximum value that the number argument to this function will allow.
  10023. </summary>
  10024. </member>
  10025. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionHex2Bin.NewMinNumber">
  10026. <summary>
  10027. The minimum value that the number argument to this function will allow in the new number system.
  10028. </summary>
  10029. </member>
  10030. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionHex2Bin.NewMaxNumber">
  10031. <summary>
  10032. The maximum value that the number argument to this function will allow in the new number system.
  10033. </summary>
  10034. </member>
  10035. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionHex2Bin.OriginalNumberSystem">
  10036. <summary>
  10037. The number system to convert from (2 = binary, 8 = octal, 16 = Hexadecimal, etc.)
  10038. </summary>
  10039. </member>
  10040. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionHex2Bin.NewNumberSystem">
  10041. <summary>
  10042. The number system to convert to (2 = binary, 8 = octal, 16 = Hexadecimal, etc.)
  10043. </summary>
  10044. </member>
  10045. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionHex2Bin.MaxLength">
  10046. <summary>
  10047. The maximum length of the 'number' string.
  10048. </summary>
  10049. </member>
  10050. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionHex2Oct">
  10051. <summary>
  10052. Converts a string representing an hexadecimal number to a string representing the same number in the octal number system.
  10053. </summary>
  10054. <remarks>
  10055. <p class="body">
  10056. Hex2Oct(number, places)
  10057. <br/>
  10058. Number is the value to be converted.
  10059. <br/>
  10060. Places is the number of characters to use in representing the value. If places is not specified, the mimumum number of characters neccessary to represent the value will be used. Places allows you to specify leading zeros.
  10061. </p>
  10062. </remarks>
  10063. </member>
  10064. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionHex2Oct.Name">
  10065. <summary>
  10066. Function name used to reference the function in a formula
  10067. </summary>
  10068. </member>
  10069. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionHex2Oct.OriginalMinNumber">
  10070. <summary>
  10071. The minimum value that the number argument to this function will allow.
  10072. </summary>
  10073. </member>
  10074. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionHex2Oct.OriginalMaxNumber">
  10075. <summary>
  10076. The maximum value that the number argument to this function will allow.
  10077. </summary>
  10078. </member>
  10079. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionHex2Oct.NewMinNumber">
  10080. <summary>
  10081. The minimum value that the number argument to this function will allow in the new number system.
  10082. </summary>
  10083. </member>
  10084. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionHex2Oct.NewMaxNumber">
  10085. <summary>
  10086. The maximum value that the number argument to this function will allow in the new number system.
  10087. </summary>
  10088. </member>
  10089. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionHex2Oct.OriginalNumberSystem">
  10090. <summary>
  10091. The number system to convert from (2 = binary, 8 = octal, 16 = Hexadecimal, etc.)
  10092. </summary>
  10093. </member>
  10094. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionHex2Oct.NewNumberSystem">
  10095. <summary>
  10096. The number system to convert to (2 = binary, 8 = octal, 16 = Hexadecimal, etc.)
  10097. </summary>
  10098. </member>
  10099. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionHex2Oct.MaxLength">
  10100. <summary>
  10101. The maximum length of the 'number' string.
  10102. </summary>
  10103. </member>
  10104. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionConvert">
  10105. <summary>
  10106. Converts a value from one system of measurement to another. For example, meters to inches or hours to seconds.
  10107. </summary>
  10108. <remarks>
  10109. <p class="body">CONVERT(number, fromUnit, toUnit)
  10110. <br/>
  10111. Number is the value to convert.
  10112. <br/>
  10113. FromUnit is the unit in which the number is given.
  10114. <br/>
  10115. ToUnit is the units to convert to.
  10116. <br/>
  10117. Weight and mass units:
  10118. "g" = gram
  10119. "sg" = slug
  10120. "lbm" = pound mass (avoirdupois)
  10121. "u" = U (atomic mass unit)
  10122. "ozm" = Ounce mass (avoirdupois)
  10123. <br/>
  10124. Distance units:
  10125. "m" = Meter
  10126. "mi" = Statute mile
  10127. "Nmi" = Nautical mile
  10128. "in" = Inch
  10129. "ft" = Foot
  10130. "yd" = Yard
  10131. "ang" = Angstrom
  10132. "Pica" = Pica (1/72 in.)
  10133. <br/>
  10134. Time units:
  10135. "yr" = Year
  10136. "day" = Day
  10137. "hr" = Hour
  10138. "mn" = Minute
  10139. "sec" = Second
  10140. <br/>
  10141. Pressure units
  10142. "Pa" (or "p") = Pascal
  10143. "atm" (or "at") = Atmosphere
  10144. "mmHg" = mm of Mercury
  10145. <br/>
  10146. Force units
  10147. "N" = Newton
  10148. "dyn" (or "dy") = Dyne
  10149. "lbf" = Pound force
  10150. <br/>
  10151. Energy units:
  10152. "J" = Joule
  10153. "e" = Erg
  10154. "c" = Thermodynamic calorie
  10155. "cal" = IT calorie
  10156. "eV" (or "ev") = Electron volt
  10157. "HPh" (or "hh") = Horsepower-hour
  10158. "Wh" (or "wh") = Watt-hour
  10159. "flb" = Foot-pound
  10160. "BTU" (or "btu") = BTU
  10161. <br/>
  10162. Power units:
  10163. "HP" (or "h") = Horsepower
  10164. "W" (or "w") = Watt
  10165. <br/>
  10166. Magentism units:
  10167. "T" = Tesla
  10168. "ga" = Gauss
  10169. <br/>
  10170. Temperature units:
  10171. "C" (or "cel") = Degree Celsius
  10172. "F" (or "fah") = Degree Fahrenheit
  10173. "K" (or "kel") = Kelvin
  10174. <br/>
  10175. Liquid measure units:
  10176. "tsp" = Teaspoon
  10177. "tbs" = Tablespoon
  10178. "oz" = Fluid ounce
  10179. "cup" = Cup
  10180. "pt" (or "us_pt") = U.S. pint
  10181. "uk_pt" = U.K. pint
  10182. "qt" = Quart
  10183. "gal" = Gallon
  10184. "l" (or "lt") = Liter
  10185. <br/>
  10186. Any metric ToUnit or FromUnit may be prefixed with one of the following:
  10187. exa ("E") = 1E+18
  10188. peta ("P") = 1E+15
  10189. tera ("T") = 1E+12
  10190. giga ("G") = 1E+09
  10191. mega ("M") = 1E+06
  10192. kilo ("k") = 1E+03
  10193. hecto ("h") = 1E+02
  10194. dekao ("e") = 1E+01
  10195. deci ("d") = 1E-01
  10196. centi ("c") = 1E-02
  10197. milli ("m") = 1E-03
  10198. micro ("u") = 1E-06
  10199. nano ("n") = 1E-09
  10200. pico ("p") = 1E-12
  10201. femto ("f") = 1E-15
  10202. atto ("a") = 1E-18
  10203. </p>
  10204. </remarks>
  10205. </member>
  10206. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionConvert.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  10207. <summary>
  10208. Evaluates the function against the arguments on the number stack.
  10209. </summary>
  10210. <param name="numberStack">Formula number stack containing function arguments.</param>
  10211. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  10212. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  10213. </member>
  10214. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionConvert.Name">
  10215. <summary>
  10216. Function name used to reference the function in a formula.
  10217. </summary>
  10218. </member>
  10219. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionConvert.MinArgs">
  10220. <summary>
  10221. Minimum number of arguments required for the function.
  10222. </summary>
  10223. </member>
  10224. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionConvert.MaxArgs">
  10225. <summary>
  10226. Maximum number of arguments required for the function.
  10227. </summary>
  10228. </member>
  10229. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionDelta">
  10230. <summary>
  10231. Compares two numbers and returns 1 if they are equal or 0 if they are not.
  10232. </summary>
  10233. <remarks>
  10234. <p class="body">DELTA(number1, [number2])
  10235. <br/>
  10236. Number1 is a number.
  10237. <br/>
  10238. Number2 is a number. If Number2 is not specified, Number1 will be compared to 0.
  10239. </p>
  10240. </remarks>
  10241. </member>
  10242. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionDelta.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  10243. <summary>
  10244. Evaluates the function against the arguments on the number stack.
  10245. </summary>
  10246. <param name="numberStack">Formula number stack containing function arguments.</param>
  10247. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  10248. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  10249. </member>
  10250. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDelta.Name">
  10251. <summary>
  10252. Function name used to reference the function in a formula.
  10253. </summary>
  10254. </member>
  10255. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDelta.MinArgs">
  10256. <summary>
  10257. Minimum number of arguments required for the function.
  10258. </summary>
  10259. </member>
  10260. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDelta.MaxArgs">
  10261. <summary>
  10262. Maximum number of arguments required for the function.
  10263. </summary>
  10264. </member>
  10265. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionGeStep">
  10266. <summary>
  10267. Compares two numbers and returns 1 the first number is greater than or equal to the second or returns 0 if not.
  10268. </summary>
  10269. <remarks>
  10270. <p class="body">GESTEP(number, [step])
  10271. <br/>
  10272. Number is a number.
  10273. <br/>
  10274. Step is a number. If step is not specified, Number will be compared to 0.
  10275. </p>
  10276. </remarks>
  10277. </member>
  10278. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionGeStep.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  10279. <summary>
  10280. Evaluates the function against the arguments on the number stack.
  10281. </summary>
  10282. <param name="numberStack">Formula number stack containing function arguments.</param>
  10283. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  10284. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  10285. </member>
  10286. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionGeStep.Name">
  10287. <summary>
  10288. Function name used to reference the function in a formula.
  10289. </summary>
  10290. </member>
  10291. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionGeStep.MinArgs">
  10292. <summary>
  10293. Minimum number of arguments required for the function.
  10294. </summary>
  10295. </member>
  10296. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionGeStep.MaxArgs">
  10297. <summary>
  10298. Maximum number of arguments required for the function.
  10299. </summary>
  10300. </member>
  10301. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionComplex">
  10302. <summary>
  10303. Returns a complex number represented as a string in the format "x + yi" or "x + yj" by comining a real and imaginary number.
  10304. </summary>
  10305. <remarks>
  10306. <p class="body">COMPLEX(realNumber, imaginaryNumber, [suffix])
  10307. <br/>
  10308. RealNumber is the real coefficient of the complex number.
  10309. <br/>
  10310. ImaginaryNumber is the imaginary coefficient of the number.
  10311. <br/>
  10312. Suffix specifies the suffix to use. The acceptable values are "i" or "j". If omitted, "i" is used. Note that the suffix is case-sensitive; upper case "I" and "J" are not allowed and will result in a #VALUE error.
  10313. </p>
  10314. </remarks>
  10315. </member>
  10316. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionComplex.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  10317. <summary>
  10318. Evaluates the function against the arguments on the number stack.
  10319. </summary>
  10320. <param name="numberStack">Formula number stack containing function arguments.</param>
  10321. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  10322. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  10323. </member>
  10324. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionComplex.Name">
  10325. <summary>
  10326. Function name used to reference the function in a formula.
  10327. </summary>
  10328. </member>
  10329. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionComplex.MinArgs">
  10330. <summary>
  10331. Minimum number of arguments required for the function.
  10332. </summary>
  10333. </member>
  10334. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionComplex.MaxArgs">
  10335. <summary>
  10336. Maximum number of arguments required for the function.
  10337. </summary>
  10338. </member>
  10339. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionImAbs">
  10340. <summary>
  10341. Returns the absolute value of a complex number.
  10342. </summary>
  10343. <remarks>
  10344. <p class="body">IMABS(complexNumber)
  10345. <br/>
  10346. ComplexNumber is a complex number in the format: "x + yi" or "x + yj".
  10347. </p>
  10348. </remarks>
  10349. </member>
  10350. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionImAbs.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  10351. <summary>
  10352. Evaluates the function against the arguments on the number stack.
  10353. </summary>
  10354. <param name="numberStack">Formula number stack containing function arguments.</param>
  10355. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  10356. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  10357. </member>
  10358. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImAbs.Name">
  10359. <summary>
  10360. Function name used to reference the function in a formula.
  10361. </summary>
  10362. </member>
  10363. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImAbs.MinArgs">
  10364. <summary>
  10365. Minimum number of arguments required for the function.
  10366. </summary>
  10367. </member>
  10368. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImAbs.MaxArgs">
  10369. <summary>
  10370. Maximum number of arguments required for the function.
  10371. </summary>
  10372. </member>
  10373. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionImaginary">
  10374. <summary>
  10375. Returns the imaginary coefficient of a complex number.
  10376. </summary>
  10377. <remarks>
  10378. <p class="body">IMAGINARY(complexNumber)
  10379. <br/>
  10380. ComplexNumber is a complex number in the format: "x + yi" or "x + yj".
  10381. </p>
  10382. </remarks>
  10383. </member>
  10384. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionImaginary.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  10385. <summary>
  10386. Evaluates the function against the arguments on the number stack.
  10387. </summary>
  10388. <param name="numberStack">Formula number stack containing function arguments.</param>
  10389. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  10390. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  10391. </member>
  10392. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImaginary.Name">
  10393. <summary>
  10394. Function name used to reference the function in a formula.
  10395. </summary>
  10396. </member>
  10397. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImaginary.MinArgs">
  10398. <summary>
  10399. Minimum number of arguments required for the function.
  10400. </summary>
  10401. </member>
  10402. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImaginary.MaxArgs">
  10403. <summary>
  10404. Maximum number of arguments required for the function.
  10405. </summary>
  10406. </member>
  10407. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionImArgument">
  10408. <summary>
  10409. Returns the argument theta, and angle expressed in radians.
  10410. </summary>
  10411. <remarks>
  10412. <p class="body">IMARGUMENT(complexNumber)
  10413. <br/>
  10414. ComplexNumber is a complex number in the format: "x + yi" or "x + yj".
  10415. </p>
  10416. </remarks>
  10417. </member>
  10418. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionImArgument.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  10419. <summary>
  10420. Evaluates the function against the arguments on the number stack.
  10421. </summary>
  10422. <param name="numberStack">Formula number stack containing function arguments.</param>
  10423. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  10424. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  10425. </member>
  10426. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImArgument.Name">
  10427. <summary>
  10428. Function name used to reference the function in a formula.
  10429. </summary>
  10430. </member>
  10431. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImArgument.MinArgs">
  10432. <summary>
  10433. Minimum number of arguments required for the function.
  10434. </summary>
  10435. </member>
  10436. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImArgument.MaxArgs">
  10437. <summary>
  10438. Maximum number of arguments required for the function.
  10439. </summary>
  10440. </member>
  10441. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionImConjugate">
  10442. <summary>
  10443. Returns the conjugate of a complex number.
  10444. </summary>
  10445. <remarks>
  10446. <p class="body">IMCONJUGATE(complexNumber)
  10447. <br/>
  10448. ComplexNumber is a complex number in the format: "x + yi" or "x + yj".
  10449. </p>
  10450. </remarks>
  10451. </member>
  10452. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionImConjugate.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  10453. <summary>
  10454. Evaluates the function against the arguments on the number stack.
  10455. </summary>
  10456. <param name="numberStack">Formula number stack containing function arguments.</param>
  10457. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  10458. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  10459. </member>
  10460. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImConjugate.Name">
  10461. <summary>
  10462. Function name used to reference the function in a formula.
  10463. </summary>
  10464. </member>
  10465. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImConjugate.MinArgs">
  10466. <summary>
  10467. Minimum number of arguments required for the function.
  10468. </summary>
  10469. </member>
  10470. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImConjugate.MaxArgs">
  10471. <summary>
  10472. Maximum number of arguments required for the function.
  10473. </summary>
  10474. </member>
  10475. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionImCos">
  10476. <summary>
  10477. Returns the cosine of a complex number.
  10478. </summary>
  10479. <remarks>
  10480. <p class="body">IMCOS(complexNumber)
  10481. <br/>
  10482. ComplexNumber is a complex number in the format: "x + yi" or "x + yj".
  10483. </p>
  10484. </remarks>
  10485. </member>
  10486. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionImCos.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  10487. <summary>
  10488. Evaluates the function against the arguments on the number stack.
  10489. </summary>
  10490. <param name="numberStack">Formula number stack containing function arguments.</param>
  10491. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  10492. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  10493. </member>
  10494. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImCos.Name">
  10495. <summary>
  10496. Function name used to reference the function in a formula.
  10497. </summary>
  10498. </member>
  10499. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImCos.MinArgs">
  10500. <summary>
  10501. Minimum number of arguments required for the function.
  10502. </summary>
  10503. </member>
  10504. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImCos.MaxArgs">
  10505. <summary>
  10506. Maximum number of arguments required for the function.
  10507. </summary>
  10508. </member>
  10509. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionImDiv">
  10510. <summary>
  10511. Returns the quotient of two complex numbers.
  10512. </summary>
  10513. <remarks>
  10514. <p class="body">IMDIV(dividend, divisor)
  10515. <br/>
  10516. Dividend is a complex number in the format: "x + yi" or "x + yj".
  10517. <br/>
  10518. Divisor is a complex number in the format: "x + yi" or "x + yj".
  10519. </p>
  10520. </remarks>
  10521. </member>
  10522. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionImDiv.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  10523. <summary>
  10524. Evaluates the function against the arguments on the number stack.
  10525. </summary>
  10526. <param name="numberStack">Formula number stack containing function arguments.</param>
  10527. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  10528. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  10529. </member>
  10530. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImDiv.Name">
  10531. <summary>
  10532. Function name used to reference the function in a formula.
  10533. </summary>
  10534. </member>
  10535. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImDiv.MinArgs">
  10536. <summary>
  10537. Minimum number of arguments required for the function.
  10538. </summary>
  10539. </member>
  10540. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImDiv.MaxArgs">
  10541. <summary>
  10542. Maximum number of arguments required for the function.
  10543. </summary>
  10544. </member>
  10545. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionImExp">
  10546. <summary>
  10547. Returns the exponential of a complex number.
  10548. </summary>
  10549. <remarks>
  10550. <p class="body">IMEXP(complexNumber)
  10551. <br/>
  10552. ComplexNumber is a complex number in the format: "x + yi" or "x + yj".
  10553. </p>
  10554. </remarks>
  10555. </member>
  10556. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionImExp.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  10557. <summary>
  10558. Evaluates the function against the arguments on the number stack.
  10559. </summary>
  10560. <param name="numberStack">Formula number stack containing function arguments.</param>
  10561. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  10562. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  10563. </member>
  10564. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImExp.Name">
  10565. <summary>
  10566. Function name used to reference the function in a formula.
  10567. </summary>
  10568. </member>
  10569. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImExp.MinArgs">
  10570. <summary>
  10571. Minimum number of arguments required for the function.
  10572. </summary>
  10573. </member>
  10574. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImExp.MaxArgs">
  10575. <summary>
  10576. Maximum number of arguments required for the function.
  10577. </summary>
  10578. </member>
  10579. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionImLn">
  10580. <summary>
  10581. Returns the natural logarithm of a complex number.
  10582. </summary>
  10583. <remarks>
  10584. <p class="body">IMLN(complexNumber)
  10585. <br/>
  10586. ComplexNumber is a complex number in the format: "x + yi" or "x + yj".
  10587. </p>
  10588. </remarks>
  10589. </member>
  10590. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionImLn.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  10591. <summary>
  10592. Evaluates the function against the arguments on the number stack.
  10593. </summary>
  10594. <param name="numberStack">Formula number stack containing function arguments.</param>
  10595. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  10596. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  10597. </member>
  10598. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImLn.Name">
  10599. <summary>
  10600. Function name used to reference the function in a formula.
  10601. </summary>
  10602. </member>
  10603. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImLn.MinArgs">
  10604. <summary>
  10605. Minimum number of arguments required for the function.
  10606. </summary>
  10607. </member>
  10608. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImLn.MaxArgs">
  10609. <summary>
  10610. Maximum number of arguments required for the function.
  10611. </summary>
  10612. </member>
  10613. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionImReal">
  10614. <summary>
  10615. Returns the real coefficient of a complex number.
  10616. </summary>
  10617. <remarks>
  10618. <p class="body">IMREAL(complexNumber)
  10619. <br/>
  10620. ComplexNumber is a complex number in the format: "x + yi" or "x + yj".
  10621. </p>
  10622. </remarks>
  10623. </member>
  10624. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionImReal.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  10625. <summary>
  10626. Evaluates the function against the arguments on the number stack.
  10627. </summary>
  10628. <param name="numberStack">Formula number stack containing function arguments.</param>
  10629. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  10630. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  10631. </member>
  10632. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImReal.Name">
  10633. <summary>
  10634. Function name used to reference the function in a formula.
  10635. </summary>
  10636. </member>
  10637. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImReal.MinArgs">
  10638. <summary>
  10639. Minimum number of arguments required for the function.
  10640. </summary>
  10641. </member>
  10642. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImReal.MaxArgs">
  10643. <summary>
  10644. Maximum number of arguments required for the function.
  10645. </summary>
  10646. </member>
  10647. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionImSub">
  10648. <summary>
  10649. Returns the difference between two complex numbers.
  10650. </summary>
  10651. <remarks>
  10652. <p class="body">IMSUB(complexNumber1, complexNumber2)
  10653. <br/>
  10654. ComplexNumber1 is a complex number in the format: "x + yi" or "x + yj" from which ComplexNumber2 will be subtracted.
  10655. <br/>
  10656. ComplexNumber2 is a complex number in the format: "x + yi" or "x + yj" which will be subtracted from ComplexNumber1.
  10657. </p>
  10658. </remarks>
  10659. </member>
  10660. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionImSub.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  10661. <summary>
  10662. Evaluates the function against the arguments on the number stack.
  10663. </summary>
  10664. <param name="numberStack">Formula number stack containing function arguments.</param>
  10665. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  10666. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  10667. </member>
  10668. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImSub.Name">
  10669. <summary>
  10670. Function name used to reference the function in a formula.
  10671. </summary>
  10672. </member>
  10673. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImSub.MinArgs">
  10674. <summary>
  10675. Minimum number of arguments required for the function.
  10676. </summary>
  10677. </member>
  10678. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImSub.MaxArgs">
  10679. <summary>
  10680. Maximum number of arguments required for the function.
  10681. </summary>
  10682. </member>
  10683. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionImProduct">
  10684. <summary>
  10685. Returns the product of 1 to n complex numbers.
  10686. </summary>
  10687. <remarks>
  10688. <p class="body">IMPRODUCT(complexNumber1 [, complexNumber2, complexNumber3, ..., complexNumberN])
  10689. <br/>
  10690. ComplexNumber1, ComplexNumber2, ..., ComplexNumberN is any number of complex numbers in the format: "x + yi" or "x + yj" which will be multiplied together.
  10691. </p>
  10692. </remarks>
  10693. </member>
  10694. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionImProduct.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  10695. <summary>
  10696. Evaluates the function against the arguments on the number stack.
  10697. </summary>
  10698. <param name="numberStack">Formula number stack containing function arguments.</param>
  10699. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  10700. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  10701. </member>
  10702. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImProduct.Name">
  10703. <summary>
  10704. Function name used to reference the function in a formula.
  10705. </summary>
  10706. </member>
  10707. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImProduct.MinArgs">
  10708. <summary>
  10709. Minimum number of arguments required for the function.
  10710. </summary>
  10711. </member>
  10712. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImProduct.MaxArgs">
  10713. <summary>
  10714. Maximum number of arguments required for the function.
  10715. </summary>
  10716. </member>
  10717. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionImSum">
  10718. <summary>
  10719. Returns the sum of 1 to n complex numbers.
  10720. </summary>
  10721. <remarks>
  10722. <p class="body">IMSUM(complexNumber1 [, complexNumber2, complexNumber3, ..., complexNumberN])
  10723. <br/>
  10724. ComplexNumber1, ComplexNumber2, ..., ComplexNumberN is any number of complex numbers in the format: "x + yi" or "x + yj" which will be added together.
  10725. </p>
  10726. </remarks>
  10727. </member>
  10728. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionImSum.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  10729. <summary>
  10730. Evaluates the function against the arguments on the number stack.
  10731. </summary>
  10732. <param name="numberStack">Formula number stack containing function arguments.</param>
  10733. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  10734. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  10735. </member>
  10736. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImSum.Name">
  10737. <summary>
  10738. Function name used to reference the function in a formula.
  10739. </summary>
  10740. </member>
  10741. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImSum.MinArgs">
  10742. <summary>
  10743. Minimum number of arguments required for the function.
  10744. </summary>
  10745. </member>
  10746. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImSum.MaxArgs">
  10747. <summary>
  10748. Maximum number of arguments required for the function.
  10749. </summary>
  10750. </member>
  10751. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionImLog10">
  10752. <summary>
  10753. Returns the base-10 logarithm of a complex number.
  10754. </summary>
  10755. <remarks>
  10756. <p class="body">IMLOG10(complexNumber)
  10757. <br/>
  10758. ComplexNumber is a complex number in the format: "x + yi" or "x + yj".
  10759. </p>
  10760. </remarks>
  10761. </member>
  10762. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionImLog10.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  10763. <summary>
  10764. Evaluates the function against the arguments on the number stack.
  10765. </summary>
  10766. <param name="numberStack">Formula number stack containing function arguments.</param>
  10767. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  10768. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  10769. </member>
  10770. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImLog10.Name">
  10771. <summary>
  10772. Function name used to reference the function in a formula.
  10773. </summary>
  10774. </member>
  10775. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImLog10.MinArgs">
  10776. <summary>
  10777. Minimum number of arguments required for the function.
  10778. </summary>
  10779. </member>
  10780. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImLog10.MaxArgs">
  10781. <summary>
  10782. Maximum number of arguments required for the function.
  10783. </summary>
  10784. </member>
  10785. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionImLog2">
  10786. <summary>
  10787. Returns the base-2 logarithm of a complex number.
  10788. </summary>
  10789. <remarks>
  10790. <p class="body">IMLOG2(complexNumber)
  10791. <br/>
  10792. ComplexNumber is a complex number in the format: "x + yi" or "x + yj".
  10793. </p>
  10794. </remarks>
  10795. </member>
  10796. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionImLog2.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  10797. <summary>
  10798. Evaluates the function against the arguments on the number stack.
  10799. </summary>
  10800. <param name="numberStack">Formula number stack containing function arguments.</param>
  10801. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  10802. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  10803. </member>
  10804. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImLog2.Name">
  10805. <summary>
  10806. Function name used to reference the function in a formula.
  10807. </summary>
  10808. </member>
  10809. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImLog2.MinArgs">
  10810. <summary>
  10811. Minimum number of arguments required for the function.
  10812. </summary>
  10813. </member>
  10814. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImLog2.MaxArgs">
  10815. <summary>
  10816. Maximum number of arguments required for the function.
  10817. </summary>
  10818. </member>
  10819. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionImSin">
  10820. <summary>
  10821. Returns the sine of a complex number.
  10822. </summary>
  10823. <remarks>
  10824. <p class="body">IMSIN(complexNumber)
  10825. <br/>
  10826. ComplexNumber is a complex number in the format: "x + yi" or "x + yj".
  10827. </p>
  10828. </remarks>
  10829. </member>
  10830. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionImSin.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  10831. <summary>
  10832. Evaluates the function against the arguments on the number stack.
  10833. </summary>
  10834. <param name="numberStack">Formula number stack containing function arguments.</param>
  10835. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  10836. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  10837. </member>
  10838. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImSin.Name">
  10839. <summary>
  10840. Function name used to reference the function in a formula.
  10841. </summary>
  10842. </member>
  10843. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImSin.MinArgs">
  10844. <summary>
  10845. Minimum number of arguments required for the function.
  10846. </summary>
  10847. </member>
  10848. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImSin.MaxArgs">
  10849. <summary>
  10850. Maximum number of arguments required for the function.
  10851. </summary>
  10852. </member>
  10853. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionImSqrt">
  10854. <summary>
  10855. Returns the square root of a complex number.
  10856. </summary>
  10857. <remarks>
  10858. <p class="body">IMSQRT(complexNumber)
  10859. <br/>
  10860. ComplexNumber is a complex number in the format: "x + yi" or "x + yj".
  10861. </p>
  10862. </remarks>
  10863. </member>
  10864. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionImSqrt.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  10865. <summary>
  10866. Evaluates the function against the arguments on the number stack.
  10867. </summary>
  10868. <param name="numberStack">Formula number stack containing function arguments.</param>
  10869. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  10870. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  10871. </member>
  10872. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImSqrt.Name">
  10873. <summary>
  10874. Function name used to reference the function in a formula.
  10875. </summary>
  10876. </member>
  10877. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImSqrt.MinArgs">
  10878. <summary>
  10879. Minimum number of arguments required for the function.
  10880. </summary>
  10881. </member>
  10882. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImSqrt.MaxArgs">
  10883. <summary>
  10884. Maximum number of arguments required for the function.
  10885. </summary>
  10886. </member>
  10887. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionImPower">
  10888. <summary>
  10889. Returns the complex number raised to the specified power.
  10890. </summary>
  10891. <remarks>
  10892. <p class="body">IMPOWER(complexNumber, power)
  10893. <br/>
  10894. ComplexNumber is a complex number in the format: "x + yi" or "x + yj".
  10895. <br/>
  10896. Power is the power to which ComplexNumber will be raised.
  10897. </p>
  10898. </remarks>
  10899. </member>
  10900. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionImPower.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  10901. <summary>
  10902. Evaluates the function against the arguments on the number stack.
  10903. </summary>
  10904. <param name="numberStack">Formula number stack containing function arguments.</param>
  10905. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  10906. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  10907. </member>
  10908. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImPower.Name">
  10909. <summary>
  10910. Function name used to reference the function in a formula.
  10911. </summary>
  10912. </member>
  10913. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImPower.MinArgs">
  10914. <summary>
  10915. Minimum number of arguments required for the function.
  10916. </summary>
  10917. </member>
  10918. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionImPower.MaxArgs">
  10919. <summary>
  10920. Maximum number of arguments required for the function.
  10921. </summary>
  10922. </member>
  10923. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionDollarFr">
  10924. <summary>
  10925. Converts a dollary amount expressed as a decimal into a dollar amount expressed as a fraction.
  10926. </summary>
  10927. <remarks>
  10928. <p class="body">DollarFr(decimalDollarAmount, Fraction)
  10929. <br/>
  10930. DecimalDollarAmount is the dollar amount expressed as a decimal.
  10931. <br/>
  10932. Fraction is the value used as the denominator of the fraction. If this value is not an integer, it will be truncated.
  10933. </p>
  10934. </remarks>
  10935. </member>
  10936. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionDollarFr.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  10937. <summary>
  10938. Evaluates the function against the arguments on the number stack.
  10939. </summary>
  10940. <param name="numberStack">Formula number stack containing function arguments.</param>
  10941. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  10942. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  10943. </member>
  10944. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDollarFr.Name">
  10945. <summary>
  10946. Function name used to reference the function in a formula.
  10947. </summary>
  10948. </member>
  10949. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDollarFr.MinArgs">
  10950. <summary>
  10951. Minimum number of arguments required for the function.
  10952. </summary>
  10953. </member>
  10954. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDollarFr.MaxArgs">
  10955. <summary>
  10956. Maximum number of arguments required for the function.
  10957. </summary>
  10958. </member>
  10959. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionDollarDe">
  10960. <summary>
  10961. Converts a dollary amount expressed as a decimal into a dollar amount expressed as a fraction.
  10962. </summary>
  10963. <remarks>
  10964. <p class="body">DollarFr(decimalDollarAmount, Fraction)
  10965. <br/>
  10966. DecimalDollarAmount is the dollar amount expressed as a decimal.
  10967. <br/>
  10968. Fraction is the value used as the denominator of the fraction. If this value is not an integer, it will be truncated.
  10969. </p>
  10970. </remarks>
  10971. </member>
  10972. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionDollarDe.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  10973. <summary>
  10974. Evaluates the function against the arguments on the number stack.
  10975. </summary>
  10976. <param name="numberStack">Formula number stack containing function arguments.</param>
  10977. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  10978. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  10979. </member>
  10980. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDollarDe.Name">
  10981. <summary>
  10982. Function name used to reference the function in a formula.
  10983. </summary>
  10984. </member>
  10985. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDollarDe.MinArgs">
  10986. <summary>
  10987. Minimum number of arguments required for the function.
  10988. </summary>
  10989. </member>
  10990. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDollarDe.MaxArgs">
  10991. <summary>
  10992. Maximum number of arguments required for the function.
  10993. </summary>
  10994. </member>
  10995. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionInfo">
  10996. <summary>
  10997. Returns information about the current operating environment.
  10998. </summary>
  10999. <remarks>
  11000. <p class="body">INFO(type)
  11001. <br/>
  11002. Type is a string indicating the type of information to return.
  11003. <br/>
  11004. "directory" = The full path to the current folder.
  11005. "osversion" = The currently operating system version as a string.
  11006. "system" = The current operating system. This will always return "pcdos" which indicates Microsoft Windows. The corresponding function in Excel can also return "mac" for Macintosh, but since NetAdvantage is only supported in Windows, this function will always return "pcdos".
  11007. <br/>
  11008. The following are supported by Microsoft Excel, but have no correlation in UltraCalcManager: "numfile", "origin", "recalc", "release".
  11009. <br/>
  11010. The following are supported in older versions of Excel, but not Office2007, and have no correlation in UltraCalcManager: "memavail", "memused", "totmem".
  11011. </p>
  11012. </remarks>
  11013. </member>
  11014. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionInfo.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  11015. <summary>
  11016. Evaluates the function against the arguments on the number stack.
  11017. </summary>
  11018. <param name="numberStack">Formula number stack containing function arguments.</param>
  11019. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  11020. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  11021. </member>
  11022. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionInfo.Name">
  11023. <summary>
  11024. Function name used to reference the function in a formula.
  11025. </summary>
  11026. </member>
  11027. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionInfo.MinArgs">
  11028. <summary>
  11029. Minimum number of arguments required for the function.
  11030. </summary>
  11031. </member>
  11032. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionInfo.MaxArgs">
  11033. <summary>
  11034. Maximum number of arguments required for the function.
  11035. </summary>
  11036. </member>
  11037. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionN">
  11038. <summary>
  11039. Converts a value to a number.
  11040. </summary>
  11041. <remarks>
  11042. <p class="body">N(value)
  11043. <br/>
  11044. Value is the value to be converted to a number. The following are acceptable values:
  11045. <br/>
  11046. A number - returns the number.
  11047. A date - returns the date.
  11048. True - returns 1.
  11049. False - returns 0.
  11050. An error value - returns the error value.
  11051. Any other value - returns 0.
  11052. </p>
  11053. </remarks>
  11054. </member>
  11055. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionN.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  11056. <summary>
  11057. Evaluates the function against the arguments on the number stack.
  11058. </summary>
  11059. <param name="numberStack">Formula number stack containing function arguments.</param>
  11060. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  11061. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  11062. </member>
  11063. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionN.Name">
  11064. <summary>
  11065. Function name used to reference the function in a formula.
  11066. </summary>
  11067. </member>
  11068. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionN.MinArgs">
  11069. <summary>
  11070. Minimum number of arguments required for the function.
  11071. </summary>
  11072. </member>
  11073. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionN.MaxArgs">
  11074. <summary>
  11075. Maximum number of arguments required for the function.
  11076. </summary>
  11077. </member>
  11078. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionFact">
  11079. <summary>
  11080. Returns the factorial of a number.
  11081. </summary>
  11082. <remarks>
  11083. <p class="body">FACT(number)
  11084. <br/>
  11085. Number is a positive number for which the factorial will be calculated.
  11086. </p>
  11087. </remarks>
  11088. </member>
  11089. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionFact.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  11090. <summary>
  11091. Evaluates the function against the arguments on the number stack.
  11092. </summary>
  11093. <param name="numberStack">Formula number stack containing function arguments.</param>
  11094. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  11095. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  11096. </member>
  11097. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionFact.Name">
  11098. <summary>
  11099. Function name used to reference the function in a formula.
  11100. </summary>
  11101. </member>
  11102. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionFact.MinArgs">
  11103. <summary>
  11104. Minimum number of arguments required for the function.
  11105. </summary>
  11106. </member>
  11107. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionFact.MaxArgs">
  11108. <summary>
  11109. Maximum number of arguments required for the function.
  11110. </summary>
  11111. </member>
  11112. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionFactDouble">
  11113. <summary>
  11114. Returns the double factorial of a number.
  11115. </summary>
  11116. <remarks>
  11117. <p class="body">FACTDOUBLE(number)
  11118. <br/>
  11119. Number is a positive number for which the double factorial will be calculated.
  11120. </p>
  11121. </remarks>
  11122. </member>
  11123. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionFactDouble.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  11124. <summary>
  11125. Evaluates the function against the arguments on the number stack.
  11126. </summary>
  11127. <param name="numberStack">Formula number stack containing function arguments.</param>
  11128. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  11129. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  11130. </member>
  11131. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionFactDouble.Name">
  11132. <summary>
  11133. Function name used to reference the function in a formula.
  11134. </summary>
  11135. </member>
  11136. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionFactDouble.MinArgs">
  11137. <summary>
  11138. Minimum number of arguments required for the function.
  11139. </summary>
  11140. </member>
  11141. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionFactDouble.MaxArgs">
  11142. <summary>
  11143. Maximum number of arguments required for the function.
  11144. </summary>
  11145. </member>
  11146. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionCombin">
  11147. <summary>
  11148. Returns the number of possible combinations given a set of items and a number of chosen items from that set.
  11149. </summary>
  11150. <remarks>
  11151. <p class="body">Combin(number, numberChosen)
  11152. <br/>
  11153. Number is the number of items.
  11154. <br/>
  11155. NumberChosen is the number of items chosen in each combination.
  11156. </p>
  11157. </remarks>
  11158. </member>
  11159. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionCombin.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  11160. <summary>
  11161. Evaluates the function against the arguments on the number stack.
  11162. </summary>
  11163. <param name="numberStack">Formula number stack containing function arguments.</param>
  11164. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  11165. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  11166. </member>
  11167. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionCombin.Name">
  11168. <summary>
  11169. Function name used to reference the function in a formula.
  11170. </summary>
  11171. </member>
  11172. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionCombin.MinArgs">
  11173. <summary>
  11174. Minimum number of arguments required for the function.
  11175. </summary>
  11176. </member>
  11177. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionCombin.MaxArgs">
  11178. <summary>
  11179. Maximum number of arguments required for the function.
  11180. </summary>
  11181. </member>
  11182. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionDegrees">
  11183. <summary>
  11184. Converts radians to degrees.
  11185. </summary>
  11186. <remarks>
  11187. <p class="body">DEGREES(radians)
  11188. <br/>
  11189. Radians is a value in radians which will be converted to degrees.
  11190. </p>
  11191. </remarks>
  11192. </member>
  11193. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionDegrees.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  11194. <summary>
  11195. Evaluates the function against the arguments on the number stack.
  11196. </summary>
  11197. <param name="numberStack">Formula number stack containing function arguments.</param>
  11198. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  11199. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  11200. </member>
  11201. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDegrees.Name">
  11202. <summary>
  11203. Function name used to reference the function in a formula.
  11204. </summary>
  11205. </member>
  11206. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDegrees.MinArgs">
  11207. <summary>
  11208. Minimum number of arguments required for the function.
  11209. </summary>
  11210. </member>
  11211. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionDegrees.MaxArgs">
  11212. <summary>
  11213. Maximum number of arguments required for the function.
  11214. </summary>
  11215. </member>
  11216. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionRadians">
  11217. <summary>
  11218. Converts degrees to radians.
  11219. </summary>
  11220. <remarks>
  11221. <p class="body">RADIANS(degrees)
  11222. <br/>
  11223. Degrees is a value in degrees which will be converted to radians.
  11224. </p>
  11225. </remarks>
  11226. </member>
  11227. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionRadians.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  11228. <summary>
  11229. Evaluates the function against the arguments on the number stack.
  11230. </summary>
  11231. <param name="numberStack">Formula number stack containing function arguments.</param>
  11232. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  11233. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  11234. </member>
  11235. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRadians.Name">
  11236. <summary>
  11237. Function name used to reference the function in a formula.
  11238. </summary>
  11239. </member>
  11240. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRadians.MinArgs">
  11241. <summary>
  11242. Minimum number of arguments required for the function.
  11243. </summary>
  11244. </member>
  11245. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRadians.MaxArgs">
  11246. <summary>
  11247. Maximum number of arguments required for the function.
  11248. </summary>
  11249. </member>
  11250. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionGcd">
  11251. <summary>
  11252. Returns the greatest common divisor of integer values.
  11253. </summary>
  11254. <remarks>
  11255. <p class="body">GCD(number1, [number2, number3, ..., numberN])
  11256. <br/>
  11257. Number1, Number2, ..., NumberN is any number of integers.
  11258. </p>
  11259. </remarks>
  11260. </member>
  11261. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionGcd.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  11262. <summary>
  11263. Evaluates the function against the arguments on the number stack.
  11264. </summary>
  11265. <param name="numberStack">Formula number stack containing function arguments.</param>
  11266. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  11267. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  11268. </member>
  11269. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionGcd.Name">
  11270. <summary>
  11271. Function name used to reference the function in a formula.
  11272. </summary>
  11273. </member>
  11274. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionGcd.MinArgs">
  11275. <summary>
  11276. Minimum number of arguments required for the function.
  11277. </summary>
  11278. </member>
  11279. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionGcd.MaxArgs">
  11280. <summary>
  11281. Maximum number of arguments required for the function.
  11282. </summary>
  11283. </member>
  11284. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionLcm">
  11285. <summary>
  11286. Returns the least common multiple of integer values.
  11287. </summary>
  11288. <remarks>
  11289. <p class="body">LCM(number1, [number2, number3, ..., numberN])
  11290. <br/>
  11291. Number1, Number2, ..., NumberN is any number of integers.
  11292. </p>
  11293. </remarks>
  11294. </member>
  11295. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionLcm.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  11296. <summary>
  11297. Evaluates the function against the arguments on the number stack.
  11298. </summary>
  11299. <param name="numberStack">Formula number stack containing function arguments.</param>
  11300. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  11301. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  11302. </member>
  11303. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionLcm.Name">
  11304. <summary>
  11305. Function name used to reference the function in a formula.
  11306. </summary>
  11307. </member>
  11308. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionLcm.MinArgs">
  11309. <summary>
  11310. Minimum number of arguments required for the function.
  11311. </summary>
  11312. </member>
  11313. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionLcm.MaxArgs">
  11314. <summary>
  11315. Maximum number of arguments required for the function.
  11316. </summary>
  11317. </member>
  11318. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionMultinomial">
  11319. <summary>
  11320. Returns the multinomial of a set of numbers.
  11321. </summary>
  11322. <remarks>
  11323. <p class="body">MULTINOMIAL(number1, [number2, number3, ..., numberN])
  11324. <br/>
  11325. Number1, Number2, ..., NumberN is any number of numbers.
  11326. </p>
  11327. </remarks>
  11328. </member>
  11329. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionMultinomial.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  11330. <summary>
  11331. Evaluates the function against the arguments on the number stack.
  11332. </summary>
  11333. <param name="numberStack">Formula number stack containing function arguments.</param>
  11334. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  11335. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  11336. </member>
  11337. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMultinomial.Name">
  11338. <summary>
  11339. Function name used to reference the function in a formula.
  11340. </summary>
  11341. </member>
  11342. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMultinomial.MinArgs">
  11343. <summary>
  11344. Minimum number of arguments required for the function.
  11345. </summary>
  11346. </member>
  11347. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMultinomial.MaxArgs">
  11348. <summary>
  11349. Maximum number of arguments required for the function.
  11350. </summary>
  11351. </member>
  11352. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionMRound">
  11353. <summary>
  11354. Rounds a number to the nearest multiple of another number.
  11355. </summary>
  11356. <remarks>
  11357. <p class="body">MRound(number, multiple)
  11358. <br/>
  11359. Number is a number to be rounded.
  11360. <br/>
  11361. Multiple is a number indicating the multiple to which to round.
  11362. </p>
  11363. </remarks>
  11364. </member>
  11365. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionMRound.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  11366. <summary>
  11367. Evaluates the function against the arguments on the number stack.
  11368. </summary>
  11369. <param name="numberStack">Formula number stack containing function arguments.</param>
  11370. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  11371. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  11372. </member>
  11373. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMRound.Name">
  11374. <summary>
  11375. Function name used to reference the function in a formula.
  11376. </summary>
  11377. </member>
  11378. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMRound.MinArgs">
  11379. <summary>
  11380. Minimum number of arguments required for the function.
  11381. </summary>
  11382. </member>
  11383. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionMRound.MaxArgs">
  11384. <summary>
  11385. Maximum number of arguments required for the function.
  11386. </summary>
  11387. </member>
  11388. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionRandBetween">
  11389. <summary>
  11390. Generates a pseudorandom integer between two specified numbers.
  11391. </summary>
  11392. <remarks>
  11393. <p class="body">RANDBETWEEN(bottom, top)
  11394. <br/>
  11395. Bottom is the minumum value that will be returned.
  11396. <br/>
  11397. Top is the maximum value that will be returned.
  11398. </p>
  11399. </remarks>
  11400. </member>
  11401. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionRandBetween.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  11402. <summary>
  11403. Evaluates the function against the arguments on the number stack
  11404. </summary>
  11405. <param name="numberStack">Formula number stack containing function arguments</param>
  11406. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  11407. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  11408. </member>
  11409. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRandBetween.IsAlwaysDirty">
  11410. <summary>
  11411. Indicates whether the results of the function is always dirty.
  11412. </summary>
  11413. </member>
  11414. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRandBetween.Name">
  11415. <summary>
  11416. Function name used to reference the function in a formula
  11417. </summary>
  11418. </member>
  11419. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRandBetween.MinArgs">
  11420. <summary>
  11421. Minimum number of arguments required for the function
  11422. </summary>
  11423. </member>
  11424. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRandBetween.MaxArgs">
  11425. <summary>
  11426. Maximum number of arguments required for the function
  11427. </summary>
  11428. </member>
  11429. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionRoman">
  11430. <summary>
  11431. Converts a number into a roman number as a string.
  11432. </summary>
  11433. <remarks>
  11434. <p class="body">ROMAN(number, form)
  11435. <br/>
  11436. Number is the number to convert to roman numerals.
  11437. <br/>
  11438. Form is a number or boolean value indicating whether to use classic roman numerals or a more concise version.
  11439. <br/>
  11440. 0 = (Default) Classic. (499 = "CDXCIX")
  11441. 1 = More concise. (499 = "LDVLIV")
  11442. 2 = More concise. (499 = "XDIX")
  11443. 3 = More concise. (499 = "VDIV")
  11444. 4 = Simplified. (499 = "ID")
  11445. TRUE = Classic.
  11446. FALSE = Simplified.
  11447. </p>
  11448. </remarks>
  11449. </member>
  11450. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionRoman.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  11451. <summary>
  11452. Evaluates the function against the arguments on the number stack.
  11453. </summary>
  11454. <param name="numberStack">Formula number stack containing function arguments.</param>
  11455. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  11456. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  11457. </member>
  11458. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRoman.Name">
  11459. <summary>
  11460. Function name used to reference the function in a formula.
  11461. </summary>
  11462. </member>
  11463. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRoman.MinArgs">
  11464. <summary>
  11465. Minimum number of arguments required for the function.
  11466. </summary>
  11467. </member>
  11468. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRoman.MaxArgs">
  11469. <summary>
  11470. Maximum number of arguments required for the function.
  11471. </summary>
  11472. </member>
  11473. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionRoundDown">
  11474. <summary>
  11475. Rounds a number to down to the specified number of digits.
  11476. </summary>
  11477. <remarks>
  11478. <p class="body">ROUNDDOWN(number, digits)
  11479. <br/>
  11480. Number is a number to be rounded down.
  11481. <br/>
  11482. Digits indicates the number of decimal places to round to. Positive numbers indicates places after the decimal point, negative numbers indicate places before the decimal point.
  11483. </p>
  11484. </remarks>
  11485. </member>
  11486. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionRoundDown.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  11487. <summary>
  11488. Evaluates the function against the arguments on the number stack.
  11489. </summary>
  11490. <param name="numberStack">Formula number stack containing function arguments.</param>
  11491. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  11492. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  11493. </member>
  11494. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRoundDown.Name">
  11495. <summary>
  11496. Function name used to reference the function in a formula.
  11497. </summary>
  11498. </member>
  11499. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRoundDown.MinArgs">
  11500. <summary>
  11501. Minimum number of arguments required for the function.
  11502. </summary>
  11503. </member>
  11504. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRoundDown.MaxArgs">
  11505. <summary>
  11506. Maximum number of arguments required for the function.
  11507. </summary>
  11508. </member>
  11509. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionRoundUp">
  11510. <summary>
  11511. Rounds a number to up to the specified number of digits.
  11512. </summary>
  11513. <remarks>
  11514. <p class="body">ROUNDUP(number, digits)
  11515. <br/>
  11516. Number is a number to be rounded up.
  11517. <br/>
  11518. Digits indicates the number of decimal places to round to. Positive numbers indicates places after the decimal point, negative numbers indicate places before the decimal point.
  11519. </p>
  11520. </remarks>
  11521. </member>
  11522. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionRoundUp.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  11523. <summary>
  11524. Evaluates the function against the arguments on the number stack.
  11525. </summary>
  11526. <param name="numberStack">Formula number stack containing function arguments.</param>
  11527. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  11528. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  11529. </member>
  11530. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRoundUp.Name">
  11531. <summary>
  11532. Function name used to reference the function in a formula.
  11533. </summary>
  11534. </member>
  11535. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRoundUp.MinArgs">
  11536. <summary>
  11537. Minimum number of arguments required for the function.
  11538. </summary>
  11539. </member>
  11540. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionRoundUp.MaxArgs">
  11541. <summary>
  11542. Maximum number of arguments required for the function.
  11543. </summary>
  11544. </member>
  11545. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionSeriesSum">
  11546. <summary>
  11547. Returns the sum of a power series.
  11548. </summary>
  11549. <remarks>
  11550. <p class="body">SERIESSUM(inputValue, initialPower, step, coefficient1 [, coefficient2, coefficient3, ..., coefficientN])
  11551. <br/>
  11552. InputValue is the input value to the power series.
  11553. <br/>
  11554. InitialPower is the initial power to which X will be raised.
  11555. <br/>
  11556. Step is the step which will be used to increase N for each term in the series.
  11557. <br/>
  11558. Coefficient1, Coefficient2, ..., CoefficientN is a set of coefficients by which each successive power of X is multiplied.
  11559. </p>
  11560. </remarks>
  11561. </member>
  11562. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionSeriesSum.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  11563. <summary>
  11564. Evaluates the function against the arguments on the number stack.
  11565. </summary>
  11566. <param name="numberStack">Formula number stack containing function arguments.</param>
  11567. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  11568. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  11569. </member>
  11570. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSeriesSum.Name">
  11571. <summary>
  11572. Function name used to reference the function in a formula.
  11573. </summary>
  11574. </member>
  11575. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSeriesSum.MinArgs">
  11576. <summary>
  11577. Minimum number of arguments required for the function.
  11578. </summary>
  11579. </member>
  11580. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSeriesSum.MaxArgs">
  11581. <summary>
  11582. Maximum number of arguments required for the function.
  11583. </summary>
  11584. </member>
  11585. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionSign">
  11586. <summary>
  11587. Returns the sign of a number. (-1, 0, or 1)
  11588. </summary>
  11589. <remarks>
  11590. <p class="body">SIGN(number)
  11591. <br/>
  11592. The number whose sign wil be returned.
  11593. </p>
  11594. </remarks>
  11595. </member>
  11596. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionSign.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  11597. <summary>
  11598. Evaluates the function against the arguments on the number stack.
  11599. </summary>
  11600. <param name="numberStack">Formula number stack containing function arguments.</param>
  11601. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  11602. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  11603. </member>
  11604. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSign.Name">
  11605. <summary>
  11606. Function name used to reference the function in a formula.
  11607. </summary>
  11608. </member>
  11609. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSign.MinArgs">
  11610. <summary>
  11611. Minimum number of arguments required for the function.
  11612. </summary>
  11613. </member>
  11614. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSign.MaxArgs">
  11615. <summary>
  11616. Maximum number of arguments required for the function.
  11617. </summary>
  11618. </member>
  11619. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionSqrtPi">
  11620. <summary>
  11621. Returns the square root of the specified number times Pi.
  11622. </summary>
  11623. <remarks>
  11624. <p class="body">SQRTPI(number)
  11625. <br/>
  11626. The number which will be multiplied by Pi.
  11627. </p>
  11628. </remarks>
  11629. </member>
  11630. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionSqrtPi.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  11631. <summary>
  11632. Evaluates the function against the arguments on the number stack.
  11633. </summary>
  11634. <param name="numberStack">Formula number stack containing function arguments.</param>
  11635. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  11636. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  11637. </member>
  11638. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSqrtPi.Name">
  11639. <summary>
  11640. Function name used to reference the function in a formula.
  11641. </summary>
  11642. </member>
  11643. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSqrtPi.MinArgs">
  11644. <summary>
  11645. Minimum number of arguments required for the function.
  11646. </summary>
  11647. </member>
  11648. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionSqrtPi.MaxArgs">
  11649. <summary>
  11650. Maximum number of arguments required for the function.
  11651. </summary>
  11652. </member>
  11653. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionChoose">
  11654. <summary>
  11655. The CHOOSE function returns one of the values provided in its arguments based on the number in the first argument.
  11656. </summary>
  11657. <remarks>
  11658. <p class="body">CHOOSE(index_num, value1, [value2, ..., valueN])
  11659. </p>
  11660. </remarks>
  11661. </member>
  11662. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionChoose.Evaluate(Infragistics.Win.CalcEngine.UltraCalcNumberStack,System.Int32)">
  11663. <summary>
  11664. Evaluates the function against the arguments on the number stack.
  11665. </summary>
  11666. <param name="numberStack">Formula number stack containing function arguments.</param>
  11667. <param name="argumentCount">Denotes the number of function arguments pushed onto the number stack.</param>
  11668. <returns>An UltraCalcValue represents the result of the function evaluation.</returns>
  11669. </member>
  11670. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionChoose.Name">
  11671. <summary>
  11672. Function name used to reference the function in a formula.
  11673. </summary>
  11674. </member>
  11675. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionChoose.MinArgs">
  11676. <summary>
  11677. Minimum number of arguments required for the function.
  11678. </summary>
  11679. </member>
  11680. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionChoose.MaxArgs">
  11681. <summary>
  11682. Maximum number of arguments required for the function.
  11683. </summary>
  11684. </member>
  11685. <member name="T:Infragistics.Win.CalcEngine.UltraCalcFunctionFactory">
  11686. <summary>
  11687. Class used to manage the stock and user defined <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunction"/> instances
  11688. </summary>
  11689. </member>
  11690. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionFactory.#ctor">
  11691. <summary>
  11692. Initializes a new <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunctionFactory"/>
  11693. </summary>
  11694. </member>
  11695. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionFactory.Add(Infragistics.Win.CalcEngine.UltraCalcFunction)">
  11696. <summary>
  11697. Adds the specified function to the function list.
  11698. </summary>
  11699. <param name="function">Function to add</param>
  11700. <returns>A boolean indicating if the function was added.</returns>
  11701. </member>
  11702. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionFactory.AddLibrary(System.String)">
  11703. <summary>
  11704. Adds a library of user defined functions contained in an assembly specified by the given file path.
  11705. </summary>
  11706. <param name="pathAssembly">Path to assembly containing user defined functions</param>
  11707. <remarks>
  11708. <p class="body">
  11709. Once the assembly is loaded, any type that derives from <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunction"/> will be registered with the function factory
  11710. </p>
  11711. </remarks>
  11712. <returns>True if the function library was successfully loaded and its functions registered, else false</returns>
  11713. </member>
  11714. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionFactory.AddLibrary(System.Reflection.Assembly)">
  11715. <summary>
  11716. Adds a library of user defined functions contained in the given assembly.
  11717. </summary>
  11718. <param name="assembly">Loaded assembly containing a library of user defined functions</param>
  11719. <remarks>
  11720. <p class="body">
  11721. Once the assembly is loaded, any type that derives from <b>UltraCalcFunction</b> will be registered with the function factory
  11722. </p>
  11723. </remarks>
  11724. <returns>True if the function library was successfully loaded and its functions registered, else false</returns>
  11725. </member>
  11726. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionFactory.GetOperator(Infragistics.Win.CalcEngine.UltraCalcOperatorFunction)">
  11727. <summary>
  11728. Returns the <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunction"/> for the specified operator enumeration
  11729. </summary>
  11730. <param name="operatorType">Operator whose function should be returned.</param>
  11731. <returns>The <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunction"/> associated with the specified enumeration.</returns>
  11732. </member>
  11733. <member name="M:Infragistics.Win.CalcEngine.UltraCalcFunctionFactory.SetOperator(Infragistics.Win.CalcEngine.UltraCalcOperatorFunction,Infragistics.Win.CalcEngine.UltraCalcFunction)">
  11734. <summary>
  11735. Replaces the <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunction"/> for the specified operator enumeration with the specified function
  11736. </summary>
  11737. <param name="operatorType">Operator whose function should be returned.</param>
  11738. <param name="function">Function used when compiling that operator.</param>
  11739. </member>
  11740. <member name="P:Infragistics.Win.CalcEngine.UltraCalcFunctionFactory.Item(System.String)">
  11741. <summary>
  11742. Returns the function with the specified name
  11743. </summary>
  11744. </member>
  11745. <member name="T:Infragistics.Win.CalcEngine.UltraCalcNumberStack">
  11746. <summary>
  11747. Stack of <see cref="T:Infragistics.Win.CalcEngine.UltraCalcValue"/> instances used to evaluate formulas.
  11748. </summary>
  11749. <remarks>
  11750. <p class="body">
  11751. The number stack is used by the <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFormulaBase"/> class to evaluate formulas. When formulas are compiled, the formula tokens are
  11752. placed in a collection in post-fix, or Reverse Polish Notation (RPN) format. RPN format arranges the formula token list so each
  11753. sub-expressions's terms are placed before their operator, and sub-expressions are ordered to enforce correct operator precedence.
  11754. This format allows the formula evaluate method to loop through the formula token collection front to back pushing an operator's terms onto
  11755. the number stack until an operator is reached. Each time an operator is reached, it's subexpression is computed and resulting value pushed
  11756. onto the number stack. Once the end of the end of the formula collection is reached, the formulas calculated value is at the top of the
  11757. number stack.
  11758. </p>
  11759. </remarks>
  11760. </member>
  11761. <member name="M:Infragistics.Win.CalcEngine.UltraCalcNumberStack.#ctor">
  11762. <summary>
  11763. Initializes a new <see cref="T:Infragistics.Win.CalcEngine.UltraCalcNumberStack"/>
  11764. </summary>
  11765. </member>
  11766. <member name="M:Infragistics.Win.CalcEngine.UltraCalcNumberStack.Push(Infragistics.Win.CalcEngine.UltraCalcValue)">
  11767. <summary>
  11768. Push a value onto number stack.
  11769. </summary>
  11770. <param name="value">Value to push onto the number stack</param>
  11771. </member>
  11772. <member name="M:Infragistics.Win.CalcEngine.UltraCalcNumberStack.Pop">
  11773. <summary>
  11774. Pop value off top of the number stack.
  11775. </summary>
  11776. <returns>UltraCalcValue that was at the top of the number stack.</returns>
  11777. </member>
  11778. <member name="M:Infragistics.Win.CalcEngine.UltraCalcNumberStack.Peek">
  11779. <summary>
  11780. Return value off top of the number stack.
  11781. </summary>
  11782. <returns>UltraCalcValue that is at the top of the number stack.</returns>
  11783. </member>
  11784. <member name="M:Infragistics.Win.CalcEngine.UltraCalcNumberStack.Clear">
  11785. <summary>
  11786. Remove all values from number stack.
  11787. </summary>
  11788. </member>
  11789. <member name="M:Infragistics.Win.CalcEngine.UltraCalcNumberStack.Reset(System.Int32)">
  11790. <summary>
  11791. Clear elements off top of number stack until it contains given number of elements
  11792. </summary>
  11793. <param name="elements">Denotes the desired stack level</param>
  11794. </member>
  11795. <member name="M:Infragistics.Win.CalcEngine.UltraCalcNumberStack.Count">
  11796. <summary>
  11797. Return the number of values on number stack
  11798. </summary>
  11799. <returns>Number of stack values</returns>
  11800. </member>
  11801. <member name="T:Infragistics.Win.CalcEngine.UltraCalcReferenceCollection">
  11802. <summary>
  11803. Manages a collection of <see cref="T:Infragistics.Win.CalcEngine.IUltraCalcReference"/> objects
  11804. </summary>
  11805. </member>
  11806. <member name="M:Infragistics.Win.CalcEngine.UltraCalcReferenceCollection.#ctor">
  11807. <summary>
  11808. Initializes a new <see cref="T:Infragistics.Win.CalcEngine.UltraCalcReferenceCollection"/>
  11809. </summary>
  11810. </member>
  11811. <member name="M:Infragistics.Win.CalcEngine.UltraCalcReferenceCollection.#ctor(Infragistics.Win.CalcEngine.UltraCalcReferenceCollection)">
  11812. <summary>
  11813. Initializes a new <see cref="T:Infragistics.Win.CalcEngine.UltraCalcReferenceCollection"/> from another reference collection
  11814. </summary>
  11815. <param name="copy">The original collection from which to copy.</param>
  11816. </member>
  11817. <member name="M:Infragistics.Win.CalcEngine.UltraCalcReferenceCollection.Merge(Infragistics.Win.CalcEngine.UltraCalcReferenceCollection)">
  11818. <summary>
  11819. Adds the contents of the specified <see cref="T:Infragistics.Win.CalcEngine.UltraCalcReferenceCollection"/> into this instances collection.
  11820. </summary>
  11821. <param name="merge">Collection whose contents should be merged with this list.</param>
  11822. </member>
  11823. <member name="M:Infragistics.Win.CalcEngine.UltraCalcReferenceCollection.Add(Infragistics.Win.CalcEngine.IUltraCalcReference)">
  11824. <summary>
  11825. Add an <b>IUltraCalcReference> elements to the collection</b>
  11826. </summary>
  11827. <param name="reference">Element to add to collection</param>
  11828. <returns>Ordinal Position within collection where element was inserted </returns>
  11829. </member>
  11830. <member name="M:Infragistics.Win.CalcEngine.UltraCalcReferenceCollection.Insert(System.Int32,Infragistics.Win.CalcEngine.IUltraCalcReference)">
  11831. <summary>
  11832. Insert an <b>IUltraCalcReference> elements to the collection</b>
  11833. </summary>
  11834. <param name="pos">Ordinal postion to insert reference</param>
  11835. <param name="reference">Reference element to be inserted into collecction</param>
  11836. </member>
  11837. <member name="M:Infragistics.Win.CalcEngine.UltraCalcReferenceCollection.Remove(Infragistics.Win.CalcEngine.IUltraCalcReference)">
  11838. <summary>
  11839. Remove <b>IUltraCalcReference</b> element from collection
  11840. </summary>
  11841. <param name="reference">Element to be removed from collection</param>
  11842. </member>
  11843. <member name="M:Infragistics.Win.CalcEngine.UltraCalcReferenceCollection.RemoveAt(System.Int32)">
  11844. <summary>
  11845. Remove element at given postion from collection
  11846. </summary>
  11847. <param name="pos">Ordinal index denoting element to remove</param>
  11848. </member>
  11849. <member name="M:Infragistics.Win.CalcEngine.UltraCalcReferenceCollection.IndexOf(Infragistics.Win.CalcEngine.IUltraCalcReference)">
  11850. <summary>
  11851. Return ordinal index of given element
  11852. </summary>
  11853. <param name="reference">Element whose position is desired</param>
  11854. <returns>Ordinal index of reference</returns>
  11855. </member>
  11856. <member name="M:Infragistics.Win.CalcEngine.UltraCalcReferenceCollection.CopyTo(System.Array,System.Int32)">
  11857. <summary>
  11858. Copys the collection to an array.
  11859. </summary>
  11860. <param name="array">Array used for the desitnation of the copy.</param>
  11861. <param name="index">The zero-based index in array at which copying begins.</param>
  11862. </member>
  11863. <member name="M:Infragistics.Win.CalcEngine.UltraCalcReferenceCollection.GetEnumerator">
  11864. <summary>
  11865. Returns the collection enumerator.
  11866. </summary>
  11867. <returns>Collection enumerator.</returns>
  11868. </member>
  11869. <member name="P:Infragistics.Win.CalcEngine.UltraCalcReferenceCollection.Item(System.Int32)">
  11870. <summary>
  11871. Indexer method that returns a <b>IUltraCalcReference</b> by position
  11872. </summary>
  11873. </member>
  11874. <member name="P:Infragistics.Win.CalcEngine.UltraCalcReferenceCollection.IsSynchronized">
  11875. <summary>
  11876. Denotes whether the collection is thread-safe.
  11877. </summary>
  11878. </member>
  11879. <member name="P:Infragistics.Win.CalcEngine.UltraCalcReferenceCollection.Count">
  11880. <summary>
  11881. Returns a number of elements in the collection.
  11882. </summary>
  11883. </member>
  11884. <member name="P:Infragistics.Win.CalcEngine.UltraCalcReferenceCollection.SyncRoot">
  11885. <summary>
  11886. Returns an object that can be used to synchronize access to the collection.
  11887. </summary>
  11888. </member>
  11889. <member name="M:Infragistics.Win.CalcEngine.HashSet.#ctor">
  11890. <summary>
  11891. Constructor.
  11892. </summary>
  11893. </member>
  11894. <member name="M:Infragistics.Win.CalcEngine.HashSet.#ctor(System.Int32)">
  11895. <summary>
  11896. Constructor.
  11897. </summary>
  11898. </member>
  11899. <member name="M:Infragistics.Win.CalcEngine.HashSet.#ctor(System.Int32,System.Single)">
  11900. <summary>
  11901. Constructor.
  11902. </summary>
  11903. </member>
  11904. <member name="M:Infragistics.Win.CalcEngine.HashSet.Add(System.Object)">
  11905. <summary>
  11906. Adds the item to the set. If the item already exists in the set, does nothing.
  11907. </summary>
  11908. <param name="item"></param>
  11909. </member>
  11910. <member name="M:Infragistics.Win.CalcEngine.HashSet.Remove(System.Object)">
  11911. <summary>
  11912. Removes the specified item from the set. If the item doesn't exist in the set
  11913. does nothing.
  11914. </summary>
  11915. <param name="item"></param>
  11916. </member>
  11917. <member name="M:Infragistics.Win.CalcEngine.HashSet.Exists(System.Object)">
  11918. <summary>
  11919. Returns true if the specified item exists in this set.
  11920. </summary>
  11921. <param name="item"></param>
  11922. <returns></returns>
  11923. </member>
  11924. <member name="M:Infragistics.Win.CalcEngine.HashSet.AddItems(Infragistics.Win.CalcEngine.HashSet)">
  11925. <summary>
  11926. Adds items from the specified set to this set.
  11927. </summary>
  11928. <param name="source"></param>
  11929. </member>
  11930. <member name="M:Infragistics.Win.CalcEngine.HashSet.GetUnion(Infragistics.Win.CalcEngine.HashSet,Infragistics.Win.CalcEngine.HashSet)">
  11931. <summary>
  11932. Calculates the union of the specified sets.
  11933. </summary>
  11934. <param name="set1"></param>
  11935. <param name="set2"></param>
  11936. <returns></returns>
  11937. </member>
  11938. <member name="M:Infragistics.Win.CalcEngine.HashSet.GetIntersection(Infragistics.Win.CalcEngine.HashSet,Infragistics.Win.CalcEngine.HashSet)">
  11939. <summary>
  11940. Calculates the intersection of the specified sets.
  11941. </summary>
  11942. <param name="set1"></param>
  11943. <param name="set2"></param>
  11944. <returns></returns>
  11945. </member>
  11946. <member name="M:Infragistics.Win.CalcEngine.HashSet.DoesIntersect(Infragistics.Win.CalcEngine.HashSet)">
  11947. <summary>
  11948. Returns true of the specified set and this set intersect.
  11949. </summary>
  11950. <param name="s"></param>
  11951. <returns></returns>
  11952. </member>
  11953. <member name="M:Infragistics.Win.CalcEngine.HashSet.IsSubsetOf(Infragistics.Win.CalcEngine.HashSet)">
  11954. <summary>
  11955. Returns true if this set is a subset of the specified set.
  11956. </summary>
  11957. <param name="s"></param>
  11958. <returns></returns>
  11959. </member>
  11960. <member name="M:Infragistics.Win.CalcEngine.HashSet.Clear">
  11961. <summary>
  11962. Clears the set.
  11963. </summary>
  11964. </member>
  11965. <member name="M:Infragistics.Win.CalcEngine.HashSet.GetEnumerator">
  11966. <summary>
  11967. Returns a new enumerator that enumerates all the elements of this set.
  11968. </summary>
  11969. <returns></returns>
  11970. </member>
  11971. <member name="M:Infragistics.Win.CalcEngine.HashSet.CopyTo(System.Array,System.Int32)">
  11972. <summary>
  11973. Copies all the elements of this set to the spcified array starting at the specified index in the array.
  11974. </summary>
  11975. <param name="array"></param>
  11976. <param name="arrayIndex"></param>
  11977. </member>
  11978. <member name="M:Infragistics.Win.CalcEngine.HashSet.ToArray(System.Type)">
  11979. <summary>
  11980. Returns an array containing all the elements of this set.
  11981. </summary>
  11982. <param name="type"></param>
  11983. <returns></returns>
  11984. </member>
  11985. <member name="P:Infragistics.Win.CalcEngine.HashSet.Count">
  11986. <summary>
  11987. Returns the number of items contained in the set.
  11988. </summary>
  11989. </member>
  11990. <member name="P:Infragistics.Win.CalcEngine.HashSet.IsEmpty">
  11991. <summary>
  11992. Returns true if the set is empty, that is it has no elements.
  11993. </summary>
  11994. </member>
  11995. <member name="P:Infragistics.Win.CalcEngine.HashSet.IsSynchronized">
  11996. <summary>
  11997. Indicates whether this data structure is synchronized.
  11998. </summary>
  11999. </member>
  12000. <member name="P:Infragistics.Win.CalcEngine.HashSet.SyncRoot">
  12001. <summary>
  12002. Returns the object that can be used to synchronize the access to this data structure.
  12003. </summary>
  12004. </member>
  12005. <member name="M:Infragistics.Shared.UltraLicenseAttribute.GetLicensedWithProducts">
  12006. <summary>
  12007. Return the list of products that this control can be licensed with
  12008. </summary>
  12009. </member>
  12010. <member name="T:Infragistics.Win.UltraWinCalcManager.CalcSettings">
  12011. <summary>
  12012. Represents a control to the CalcManager component
  12013. </summary>
  12014. <remarks>
  12015. <p class="body">The CalcSettings object defines properties that determine how the <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/> deal with a particular control.</p>
  12016. <p class="body">In order for any control to be used in the Calculation Network, a CalcSettings must be created for that control. This can be done by creating a new CalcSettings and adding it to the network via the <see cref="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.SetCalcSettings(System.Windows.Forms.Control,Infragistics.Win.UltraWinCalcManager.CalcSettings)"/> method or by calling <see cref="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.GetCalcSettings(System.Windows.Forms.Control)"/>, which will automatically get the existing CalcSetting for a control or create one if none exists.</p>
  12017. <p class="body">Always be certain to set the <see cref="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.PropertyName"/> on the CalcSettings, to the <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/> knows which property of the control to use for calculations.</p>
  12018. </remarks>
  12019. </member>
  12020. <member name="M:Infragistics.Win.UltraWinCalcManager.CalcSettings.#ctor">
  12021. <summary>
  12022. Creates a new <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> object with default property values.
  12023. </summary>
  12024. <remarks>
  12025. <p class="body">You can create a new CalcSettings object and add it into the calculation network via the <see cref="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.SetCalcSettings(System.Windows.Forms.Control,Infragistics.Win.UltraWinCalcManager.CalcSettings)"/> method.</p>
  12026. </remarks>
  12027. </member>
  12028. <member name="M:Infragistics.Win.UltraWinCalcManager.CalcSettings.#ctor(System.String,System.Object,System.String,System.String,Infragistics.Win.UltraWinCalcManager.CalcErrorIconAlignment)">
  12029. <summary>
  12030. Creates a new <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> object and initializes it with the specified property values.
  12031. </summary>
  12032. <remarks>
  12033. <p class="body">You can create a new CalcSettings object and add it into the calculation network via the <see cref="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.SetCalcSettings(System.Windows.Forms.Control,Infragistics.Win.UltraWinCalcManager.CalcSettings)"/> method.</p>
  12034. </remarks>
  12035. <param name="alias">Specifies the <see cref="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.Alias"/> property of the <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/>.</param>
  12036. <param name="errorIconAlignment">Specifies the <see cref="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.ErrorIconAlignment"/> property of the <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/>.</param>
  12037. <param name="errorValue">Specifies the <see cref="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.ErrorValue"/> property of the <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/>.</param>
  12038. <param name="formula">Specifies the <see cref="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.Formula"/> property of the <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/>.</param>
  12039. <param name="propertyName">Specifies the <see cref="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.PropertyName"/> property of the <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/>.</param>
  12040. </member>
  12041. <member name="M:Infragistics.Win.UltraWinCalcManager.CalcSettings.#ctor(System.String,System.Object,System.String,System.String,Infragistics.Win.UltraWinCalcManager.CalcErrorIconAlignment,System.Type)">
  12042. <summary>
  12043. Creates a new <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> object and initializes it with the specified property values.
  12044. </summary>
  12045. <remarks>
  12046. <p class="body">You can create a new CalcSettings object and add it into the calculation network via the <see cref="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.SetCalcSettings(System.Windows.Forms.Control,Infragistics.Win.UltraWinCalcManager.CalcSettings)"/> method.</p>
  12047. </remarks>
  12048. <param name="alias">Specifies the <see cref="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.Alias"/> property of the <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/>.</param>
  12049. <param name="errorIconAlignment">Specifies the <see cref="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.ErrorIconAlignment"/> property of the <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/>.</param>
  12050. <param name="errorValue">Specifies the <see cref="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.ErrorValue"/> property of the <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/>.</param>
  12051. <param name="formula">Specifies the <see cref="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.Formula"/> property of the <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/>.</param>
  12052. <param name="propertyName">Specifies the <see cref="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.PropertyName"/> property of the <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/>.</param>
  12053. <param name="treatAsType">Specifies the <see cref="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.TreatAsType"/> property of the <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/>.</param>
  12054. </member>
  12055. <member name="M:Infragistics.Win.UltraWinCalcManager.CalcSettings.ShouldSerialize">
  12056. <summary>
  12057. Returns whether the CalcSettings object should be serialized
  12058. </summary>
  12059. <returns>Returns true if any property of the CalcSettings differs from the default.</returns>
  12060. </member>
  12061. <member name="M:Infragistics.Win.UltraWinCalcManager.CalcSettings.Reset">
  12062. <summary>
  12063. Resets all CalcSettings properties to their defaults.
  12064. </summary>
  12065. <remarks>
  12066. <p class="body">This method will reset all properties of the <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> to their default values.</p>
  12067. </remarks>
  12068. </member>
  12069. <member name="M:Infragistics.Win.UltraWinCalcManager.CalcSettings.ToString">
  12070. <summary>
  12071. Converts the CalcSettings to a string
  12072. </summary>
  12073. <remarks>
  12074. <p class="body">Returns a string containing the PropertyName and the Formula of the <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> object.</p>
  12075. </remarks>
  12076. <returns>A string representation of the <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> object.</returns>
  12077. </member>
  12078. <member name="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.Formula">
  12079. <summary>
  12080. The Formula which will be used to set the value of this object.
  12081. </summary>
  12082. <remarks>
  12083. <p class="body">The Formula property will be used to calculate a value and that value will be set on a property of the control as indicated by the <see cref="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.PropertyName"/> property. If <see cref="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.PropertyName"/> has not been set or is set to an invalid property, then no calculation will take place.</p>
  12084. <p class="note">It is strongly recommended that any control with a formula be marked ReadOnly. A control that is the target of a formula calculation should not be edited by the user, because any user-edited value will be overwritten by the calculated value. Also, if a control is used as both the target and the source of a formula, then the source value will always use the calculated value and not the value displayed in the control after a user edit.</p>
  12085. </remarks>
  12086. </member>
  12087. <member name="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.PropertyName">
  12088. <summary>
  12089. Gets/sets which property of the control is used as either the source or target of any calculations involving the control.
  12090. </summary>
  12091. <remarks>
  12092. <p class="body">PropertyName gets/sets the name of the property that is used as either the source or target (or both) of any calculations involving the control. If no PropertyName is set, or if the PropertyName is invalid, then the control will not participate in any calculations and a Reference Error may be generated.</p>
  12093. <p class="body">In order for the CalcManager to properly use a control's proeprty as the source value in a calculation the property must follow the same guidelines as a Bindable property. That is, the control must expose the property publicly and also expose a PropertyChanged event. For Example, if The <b>Text</b> property is being used, then the control must also have a <b>TextChanged</b> event. If there is no such event, the calculation will not function correctly. This applies only to source properties. If the control is only being used at the target for the calculated value of a formula, the event is not required.</p>
  12094. </remarks>
  12095. </member>
  12096. <member name="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.Alias">
  12097. <summary>
  12098. Gets/sets the Alias name of the control
  12099. </summary>
  12100. <remarks>
  12101. <p class="body">The Alias is use to identify a control in a formula by something other than it's Name. If no Alias has been set, then the control can be referred to by it's name in any calculation. If an Alias has been set, then the Alias must be used instead.</p>
  12102. </remarks>
  12103. </member>
  12104. <member name="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.AliasResolved">
  12105. <summary>
  12106. Resolves the Alias of the control which is used to reference the control in any formulas.
  12107. </summary>
  12108. <remarks>
  12109. <p class="body">Returns the name of the control if no <see cref="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.Alias"/> has been set, or the <see cref="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.Alias"/> if it has been set.</p>
  12110. </remarks>
  12111. </member>
  12112. <member name="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.ErrorIconAlignment">
  12113. <summary>
  12114. Gets/sets where to place the ErrorProvider icon when a Calculation or Reference error occurs on a formula.
  12115. </summary>
  12116. <remarks>
  12117. <p class="body">When a Calculation or Reference error occurs during the evaluation of a formula, the UltraCalcManager will display an ErrorProvider Icon adjacent to the target control. ErrorIconAlignment determines the location of the icon. When set to <b>Default</b>, the <see cref="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ErrorIconAlignment"/> property will be used. To turn off displaying ErrorProvider icons on a cotrol, use the <b>None</b> value</p>
  12118. </remarks>
  12119. </member>
  12120. <member name="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.ErrorIconAlignmentResolved">
  12121. <summary>
  12122. Gets the resolved ErrorIconAlignment for the control
  12123. </summary>
  12124. <remarks>
  12125. <p class="body">When a Calculation or Reference error occurs during the evaluation of a formula, the UltraCalcManager will display an ErrorProvider Icon adjacent to the target control. ErrorIconAlignment determines the location of the icon. The resolve process will look at the <see cref="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.ErrorIconAlignment"/> property first. If it is set to <b>Default</b> it will use the <see cref="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ErrorIconAlignment"/> setting. If that is also set to <b>Default</b>, <b>MiddleRight</b> will be used.</p>
  12126. </remarks>
  12127. </member>
  12128. <member name="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.ErrorValue">
  12129. <summary>
  12130. Gets/set what value to use when a Calculation or Reference error occurs.
  12131. </summary>
  12132. <remarks>
  12133. <p class="body">If a Calculation or Reference Error occurs during a calculation, ErrorValue can be used to specify a default value to be used for display or saving. When an error occurs in a calculation, this value will be assigned to the appropriate property of the Context object. For example, in the case of a TextBox's Text property, the property itself will be set to the error value so that it both displays in the TextBox and is saved if the Text property is bound. In the case of an UltraGrid cell, this value will not be displayed, but will be saved to the underlying data source. Objects that do not display or bind, such as a NamedReference, will ignore the ErrorValue.</p>
  12134. </remarks>
  12135. </member>
  12136. <member name="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.FormulaResult">
  12137. <summary>
  12138. Gets the value which will be used as the source in any calculations involving the control
  12139. </summary>
  12140. <remarks>
  12141. <p class="body">Value returns the current value that any calculations referencing the control will use. If the control is the target of a formula, then this will be the last calculated value.</p>
  12142. <p class="note">Note that the value may be an UltraCalcValueError.</p>
  12143. </remarks>
  12144. </member>
  12145. <member name="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.TreatAsType">
  12146. <summary>
  12147. Gets or sets a Type to use for conversion purposes when the UltraCalcManager interprets the value from the Control.
  12148. </summary>
  12149. <remarks>
  12150. <p class="body">TreatAsType is useful if you are using values in a Calculation that are not neccessarily in the native type for the formula. For example, if a TextBox control's Text property is being used to enter a numeric value, the CalcManager will, by default, convert that contents of the TextBox to a Double using the Invariant Culture. This may not always be the desired effect. Setting TreatAsType to double in this example would convert the Text of the TextBox to a Double using the Current (instead of Invariant) Culture before passing the value on to the CalcManager.</p>
  12151. <p class="body">Setting TreatAsType also allows the CalcManager to validate the data and display an error if it cannot be converted to the appropriate type. This means that if TreatAsType has been set and the property value of the control cannot be converted to the proper type, an ErrorIcon will be displayed. Without setting TreatAsType, only controls which are using the control as a source will be able to display an error.</p>
  12152. </remarks>
  12153. </member>
  12154. <member name="T:Infragistics.Win.UltraWinCalcManager.CalcSettingsConverter">
  12155. <summary>
  12156. Type converter for the <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> class.
  12157. </summary>
  12158. <remarks>
  12159. <p class="body">This is used to convert a <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> object to and from an InstanceDescriptor for the purposes of serialization / deserialization.</p>
  12160. <p class="body">It also allows expanding the properties of the object in the PropertyGrid.</p>
  12161. </remarks>
  12162. </member>
  12163. <member name="M:Infragistics.Win.UltraWinCalcManager.CalcSettingsConverter.CanConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Type)">
  12164. <summary>
  12165. Gets a value indicating whether this converter can convert an object to the given destination type using the context.
  12166. </summary>
  12167. <remarks></remarks>
  12168. <param name="context">An ITypeDescriptorContext that provides a format context.</param>
  12169. <param name="destinationType">A <see cref="T:System.Type"/> that represents the type you want to convert to.</param>
  12170. <returns>This method returns true if this converter can perform the conversion; otherwise, false.</returns>
  12171. </member>
  12172. <member name="M:Infragistics.Win.UltraWinCalcManager.CalcSettingsConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
  12173. <summary>
  12174. Converts the specified object to the specified type.
  12175. </summary>
  12176. <param name="context">A formatter context. This object can be used to get additional information about the environment this converter is being called from. This may be null, so you should always check. Also, properties on the context object may also return null.</param>
  12177. <param name="culture">An object that contains culture specific information, such as the language, calendar, and cultural conventions associated with a specific culture. It is based on the RFC 1766 standard.</param>
  12178. <param name="destinationType">The type to convert the object to.</param>
  12179. <param name="value">The object to convert.</param>
  12180. <returns>The converted object.</returns>
  12181. </member>
  12182. <member name="T:Infragistics.Win.UltraWinCalcManager.CalcSettingsPropertyNameUITypeEditor">
  12183. <summary>
  12184. UITypeEditor for the <see cref="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.PropertyName"/> property of a <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/>.
  12185. </summary>
  12186. <remarks>
  12187. <p class="body">This class is a UITypeEditor for the <see cref="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.PropertyName"/> property of a <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/>. The dropdown list of properties includes Bindable properties on the control.</p>
  12188. </remarks>
  12189. </member>
  12190. <member name="M:Infragistics.Win.UltraWinCalcManager.CalcSettingsPropertyNameUITypeEditor.GetObject(System.Object)">
  12191. <summary>
  12192. Returns the <see cref="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.Control"/> of the CalcSettings context.
  12193. </summary>
  12194. <param name="context">A <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/></param>
  12195. <returns></returns>
  12196. </member>
  12197. <member name="T:Infragistics.Win.UltraWinCalcManager.ConvertibleTypeEditor">
  12198. <summary>
  12199. UITypedEditor used to display a list of types for the <see cref="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.TreatAsType"/> property of a <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/>.
  12200. </summary>
  12201. <remarks>
  12202. <p class="body">This class provides a dropdown list of types for the <see cref="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.TreatAsType"/> property. This is not neccessarily a complete list of all possible types that are valid for the property, but it is a list of the most common types.</p>
  12203. </remarks>
  12204. </member>
  12205. <member name="P:Infragistics.Win.UltraWinCalcManager.ConvertibleTypeEditor.Types">
  12206. <summary>
  12207. Array of types the ui type editor should display in the drop down.
  12208. </summary>
  12209. </member>
  12210. <member name="T:Infragistics.Win.UltraWinCalcManager.DataGridViewColumnCalcSettings">
  12211. <summary>
  12212. Summary description for DataGridViewColumnCalcSettings.
  12213. </summary>
  12214. </member>
  12215. <member name="M:Infragistics.Win.UltraWinCalcManager.DataGridViewColumnCalcSettings.#ctor">
  12216. <summary>
  12217. DataGridViewColumnCalcSettings Constructor
  12218. </summary>
  12219. </member>
  12220. <member name="M:Infragistics.Win.UltraWinCalcManager.DataGridViewColumnCalcSettings.#ctor(System.Object,System.String)">
  12221. <summary>
  12222. DataGridViewColumnCalcSettings Contstructor
  12223. </summary>
  12224. <param name="errorValue">The value to use when a Calculation or Reference error occurs.</param>
  12225. <param name="formula">The Formula which will be used to set the value of this object.</param>
  12226. </member>
  12227. <member name="M:Infragistics.Win.UltraWinCalcManager.DataGridViewColumnCalcSettings.ShouldSerialize">
  12228. <summary>
  12229. Returns whether the DataGridViewColumnCalcSettings object should be serialized
  12230. </summary>
  12231. <returns>Returns true if any property of the DataGridViewColumnCalcSettings differs from the default.</returns>
  12232. </member>
  12233. <member name="M:Infragistics.Win.UltraWinCalcManager.DataGridViewColumnCalcSettings.Reset">
  12234. <summary>
  12235. Resets all DataGridViewColumnCalcSettings properties to their defaults.
  12236. </summary>
  12237. </member>
  12238. <member name="M:Infragistics.Win.UltraWinCalcManager.DataGridViewColumnCalcSettings.ToString">
  12239. <summary>
  12240. Returns a <see cref="T:System.String"/> that represents the current System.Object.
  12241. </summary>
  12242. <returns>A <see cref="T:System.String"/> that represents the current System.Object.</returns>
  12243. </member>
  12244. <member name="P:Infragistics.Win.UltraWinCalcManager.DataGridViewColumnCalcSettings.Formula">
  12245. <summary>
  12246. The Formula which will be used to set the value of this object.
  12247. </summary>
  12248. <remarks>
  12249. <p class="body">The Formula property will be used to calculate a value for the cells in this column.</p>
  12250. <p class="note">It is strongly recommended that any column with a formula be marked ReadOnly. A column that is the target of a formula calculation should not be edited by the user, because any user-edited value will be overwritten by the calculated value. Also, if a column is used as both the target and the source of a formula, then the source value will always use the calculated value and not the value displayed in the column after a user edit.</p>
  12251. </remarks>
  12252. </member>
  12253. <member name="P:Infragistics.Win.UltraWinCalcManager.DataGridViewColumnCalcSettings.FormulaValueConverter">
  12254. <summary>
  12255. Interface for providing custom logic for converting formula results and the formula source values.
  12256. </summary>
  12257. </member>
  12258. <member name="P:Infragistics.Win.UltraWinCalcManager.DataGridViewColumnCalcSettings.ErrorValue">
  12259. <summary>
  12260. Gets/set what value to use when a Calculation or Reference error occurs.
  12261. </summary>
  12262. <remarks>
  12263. <p class="body">If a Calculation or Reference Error occurs during a calculation, ErrorValue can be used to specify a default value to be used for display or saving. When an error occurs in a calculation, this value will be assigned to the appropriate property of the Context object. For example, in the case of a TextBox's Text property, the property itself will be set to the error value so that it both displays in the TextBox and is saved if the Text property is bound. In the case of an UltraGrid cell, this value will not be displayed, but will be saved to the underlying data source. Objects that do not display or bind, such as a NamedReference, will ignore the ErrorValue.</p>
  12264. </remarks>
  12265. </member>
  12266. <member name="T:Infragistics.Win.UltraWinCalcManager.DataGridViewCalcSettingsConverter">
  12267. <summary>
  12268. DataGridViewCalcSettingsConverter
  12269. </summary>
  12270. </member>
  12271. <member name="M:Infragistics.Win.UltraWinCalcManager.DataGridViewCalcSettingsConverter.CanConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Type)">
  12272. <summary>
  12273. Returns whether this converter can convert the object to the specified type, using the specified context.
  12274. </summary>
  12275. <param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext"/> that provides a format context.</param>
  12276. <param name="destinationType">A <see cref="T:System.Type"/> that represents the type you want to convert to.</param>
  12277. <returns>true if this converter can perform the conversion; otherwise, false.</returns>
  12278. </member>
  12279. <member name="M:Infragistics.Win.UltraWinCalcManager.DataGridViewCalcSettingsConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
  12280. <summary>
  12281. Converts the given value object to the specified type, using the specified context and culture information.
  12282. </summary>
  12283. <param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext"/> that provides a format context.</param>
  12284. <param name="culture">A <see cref="T:System.Globalization.CultureInfo"/>. If null is passed, the current culture is assumed.</param>
  12285. <param name="value">The <see cref="T:System.Object"/> to convert.</param>
  12286. <param name="destinationType">The <see cref="T:System.Type"/> to convert the value parameter to.</param>
  12287. <returns>An <see cref="T:System.Object"/> that represents the converted value.</returns>
  12288. <exception cref="T:System.NotSupportedException">The conversion cannot be performed.</exception>
  12289. <exception cref="T:System.ArgumentNullException">The destinationType parameter is null.</exception>
  12290. </member>
  12291. <member name="P:Infragistics.Win.UltraWinCalcManager.ColumnReference.Formula">
  12292. <summary>
  12293. The <b>IUltraCalcFormula</b>, if any, associated with this Reference.
  12294. </summary>
  12295. </member>
  12296. <member name="T:Infragistics.Win.UltraWinCalcManager.CalcFrequency">
  12297. <summary>
  12298. Determines how frequently the calculations are done by the UltraCalcManager.
  12299. </summary>
  12300. <remarks>
  12301. <p class="body">This enumeration is used by the <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/> component to determine when calculations are performed.</p>
  12302. </remarks>
  12303. <seealso cref="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.CalcFrequency"/>
  12304. <seealso cref="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.AsynchronousCalcDuration"/>
  12305. </member>
  12306. <member name="F:Infragistics.Win.UltraWinCalcManager.CalcFrequency.Asynchronous">
  12307. <summary>
  12308. Calculations will be performed on a timer. This frees the UI Thread, but means that calcuations may not always be current.
  12309. </summary>
  12310. </member>
  12311. <member name="F:Infragistics.Win.UltraWinCalcManager.CalcFrequency.Synchronous">
  12312. <summary>
  12313. Calculations are performed every time a change notifiation is recieved. That is, every time a value involved in a calculation is changed, all dirtied calculations are recalculated and the UI thread is locked until all calculations are complete.
  12314. </summary>
  12315. </member>
  12316. <member name="F:Infragistics.Win.UltraWinCalcManager.CalcFrequency.Manual">
  12317. <summary>
  12318. UltraCalcManager never performs any calculations until the <see cref="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ReCalc"/> method is explicitly invoked.
  12319. </summary>
  12320. </member>
  12321. <member name="T:Infragistics.Win.UltraWinCalcManager.CalcErrorIconAlignment">
  12322. <summary>
  12323. Determines if an ErrorIcon will be displayed for a control whose formula results in an error.
  12324. </summary>
  12325. <remarks>
  12326. <p class="body">This enumeration is used by the <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> object to determine the placement of the error icon relative to a control when a calculation error occurs.</p>
  12327. </remarks>
  12328. </member>
  12329. <member name="F:Infragistics.Win.UltraWinCalcManager.CalcErrorIconAlignment.Default">
  12330. <summary>
  12331. Default
  12332. </summary>
  12333. <remarks><p class="body">When set to Default, an individual CalcSettings will walk up to use the setting of the UltraCalcManager. If the UltraCalcManager is also set to Default, then MiddleRight will be used.</p></remarks>
  12334. </member>
  12335. <member name="F:Infragistics.Win.UltraWinCalcManager.CalcErrorIconAlignment.None">
  12336. <summary>
  12337. Do not display an error icon.
  12338. </summary>
  12339. </member>
  12340. <member name="F:Infragistics.Win.UltraWinCalcManager.CalcErrorIconAlignment.BottomLeft">
  12341. <summary>
  12342. Display an error icon at the Bottom Left of the control.
  12343. </summary>
  12344. </member>
  12345. <member name="F:Infragistics.Win.UltraWinCalcManager.CalcErrorIconAlignment.BottomRight">
  12346. <summary>
  12347. Display an error icon at the Bottom Right of the control.
  12348. </summary>
  12349. </member>
  12350. <member name="F:Infragistics.Win.UltraWinCalcManager.CalcErrorIconAlignment.MiddleLeft">
  12351. <summary>
  12352. Display an error icon at the Middle Left of the control.
  12353. </summary>
  12354. </member>
  12355. <member name="F:Infragistics.Win.UltraWinCalcManager.CalcErrorIconAlignment.MiddleRight">
  12356. <summary>
  12357. Display an error icon at the Middle Right of the control.
  12358. </summary>
  12359. </member>
  12360. <member name="F:Infragistics.Win.UltraWinCalcManager.CalcErrorIconAlignment.TopLeft">
  12361. <summary>
  12362. Display an error icon at the Top Left of the control.
  12363. </summary>
  12364. </member>
  12365. <member name="F:Infragistics.Win.UltraWinCalcManager.CalcErrorIconAlignment.TopRight">
  12366. <summary>
  12367. Display an error icon at the Top Right of the control.
  12368. </summary>
  12369. </member>
  12370. <member name="T:Infragistics.Win.UltraWinCalcManager.PropertyIds">
  12371. <summary>
  12372. Unique identifier for each property.
  12373. </summary>
  12374. <remarks>
  12375. <p class="body">This enumeration lists all of the possible properties of the objects in the UltraWinCalcManager namespace. These are used in the <see cref="E:Infragistics.Win.UltraComponentBase.PropertyChanged"/> event.</p>
  12376. </remarks>
  12377. </member>
  12378. <member name="F:Infragistics.Win.UltraWinCalcManager.PropertyIds.Added">
  12379. <summary>
  12380. Item was added to the collection
  12381. </summary>
  12382. </member>
  12383. <member name="F:Infragistics.Win.UltraWinCalcManager.PropertyIds.Removed">
  12384. <summary>
  12385. Item was removed to the collection
  12386. </summary>
  12387. </member>
  12388. <member name="F:Infragistics.Win.UltraWinCalcManager.PropertyIds.Cleared">
  12389. <summary>
  12390. Collection was cleared
  12391. </summary>
  12392. </member>
  12393. <member name="F:Infragistics.Win.UltraWinCalcManager.PropertyIds.Formula">
  12394. <summary>
  12395. Formula Property
  12396. </summary>
  12397. </member>
  12398. <member name="F:Infragistics.Win.UltraWinCalcManager.PropertyIds.Category">
  12399. <summary>
  12400. Category Property
  12401. </summary>
  12402. </member>
  12403. <member name="F:Infragistics.Win.UltraWinCalcManager.PropertyIds.NamedReferences">
  12404. <summary>
  12405. NamedReferences Collection Property
  12406. </summary>
  12407. </member>
  12408. <member name="F:Infragistics.Win.UltraWinCalcManager.PropertyIds.NamedReference">
  12409. <summary>
  12410. NamedReference Property
  12411. </summary>
  12412. </member>
  12413. <member name="F:Infragistics.Win.UltraWinCalcManager.PropertyIds.PropertyName">
  12414. <summary>
  12415. PropertyName Property
  12416. </summary>
  12417. </member>
  12418. <member name="F:Infragistics.Win.UltraWinCalcManager.PropertyIds.Alias">
  12419. <summary>
  12420. Alias Property
  12421. </summary>
  12422. </member>
  12423. <member name="F:Infragistics.Win.UltraWinCalcManager.PropertyIds.ErrorValue">
  12424. <summary>
  12425. ErrorValue Property
  12426. </summary>
  12427. </member>
  12428. <member name="F:Infragistics.Win.UltraWinCalcManager.PropertyIds.Key">
  12429. <summary>
  12430. Key Property
  12431. </summary>
  12432. </member>
  12433. <member name="F:Infragistics.Win.UltraWinCalcManager.PropertyIds.ErrorIconAlignment">
  12434. <summary>
  12435. ErrorIconAlignment Property
  12436. </summary>
  12437. </member>
  12438. <member name="F:Infragistics.Win.UltraWinCalcManager.PropertyIds.ErrorIcon">
  12439. <summary>
  12440. ErrorIcon Property
  12441. </summary>
  12442. </member>
  12443. <member name="F:Infragistics.Win.UltraWinCalcManager.PropertyIds.CalcFrequency">
  12444. <summary>
  12445. CalcFrequency Property
  12446. </summary>
  12447. </member>
  12448. <member name="F:Infragistics.Win.UltraWinCalcManager.PropertyIds.AsynchronousCalcDuration">
  12449. <summary>
  12450. AsynchronousCalcDuration Property
  12451. </summary>
  12452. </member>
  12453. <member name="F:Infragistics.Win.UltraWinCalcManager.PropertyIds.AsynchronousCalcInterval">
  12454. <summary>
  12455. AsynchronousCalcInterval Property
  12456. </summary>
  12457. </member>
  12458. <member name="F:Infragistics.Win.UltraWinCalcManager.PropertyIds.TreatAsType">
  12459. <summary>
  12460. TreatAsType Property
  12461. </summary>
  12462. </member>
  12463. <member name="T:Infragistics.Win.UltraWinCalcManager.CalcManagerEventIds">
  12464. <summary>
  12465. Uniquely identifies each UltraCalcManager event.
  12466. </summary>
  12467. <remarks>
  12468. <p class="body">This enumeration is used to specify an event when calling the <see cref="M:Infragistics.Win.UltraWinCalcManager.CalcManagerEventManager.SetEnabled(Infragistics.Win.UltraWinCalcManager.CalcManagerEventIds,System.Boolean)"/> method.</p>
  12469. </remarks>
  12470. </member>
  12471. <member name="F:Infragistics.Win.UltraWinCalcManager.CalcManagerEventIds.CalculationsCompleted">
  12472. <summary>
  12473. Event id that identifies <see cref="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.CalculationsCompleted"/> event.
  12474. </summary>
  12475. </member>
  12476. <member name="F:Infragistics.Win.UltraWinCalcManager.CalcManagerEventIds.FormulaSyntaxError">
  12477. <summary>
  12478. Event id that identifies <see cref="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.FormulaSyntaxError"/> event.
  12479. </summary>
  12480. </member>
  12481. <member name="F:Infragistics.Win.UltraWinCalcManager.CalcManagerEventIds.FormulaReferenceError">
  12482. <summary>
  12483. Event id that identifies <see cref="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.FormulaReferenceError"/> event.
  12484. </summary>
  12485. </member>
  12486. <member name="F:Infragistics.Win.UltraWinCalcManager.CalcManagerEventIds.FormulaCalculationError">
  12487. <summary>
  12488. Event id that identifies <see cref="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.FormulaCalculationError"/> event.
  12489. </summary>
  12490. </member>
  12491. <member name="F:Infragistics.Win.UltraWinCalcManager.CalcManagerEventIds.FormulaCircularityError">
  12492. <summary>
  12493. Event id that identifies <see cref="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.FormulaCircularityError"/> event.
  12494. </summary>
  12495. </member>
  12496. <member name="F:Infragistics.Win.UltraWinCalcManager.CalcManagerEventIds.ParseValue">
  12497. <summary>
  12498. Event id that identifies <see cref="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ParseValue"/> event.
  12499. </summary>
  12500. </member>
  12501. <member name="F:Infragistics.Win.UltraWinCalcManager.CalcManagerEventIds.FormatValue">
  12502. <summary>
  12503. Event id that identifies <see cref="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.FormatValue"/> event.
  12504. </summary>
  12505. </member>
  12506. <member name="F:Infragistics.Win.UltraWinCalcManager.CalcManagerEventIds.NamedReferenceResultChanged">
  12507. <summary>
  12508. Event id that identifies <see cref="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.NamedReferenceResultChanged"/> event.
  12509. </summary>
  12510. </member>
  12511. <member name="F:Infragistics.Win.UltraWinCalcManager.CalcManagerEventIds.ValueDirtied">
  12512. <summary>
  12513. Event id that identifies <see cref="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ValueDirtied"/> event.
  12514. </summary>
  12515. </member>
  12516. <member name="F:Infragistics.Win.UltraWinCalcManager.CalcManagerEventIds.LastEventId">
  12517. <summary>
  12518. Keep the last event id used.
  12519. </summary>
  12520. </member>
  12521. <member name="T:Infragistics.Win.UltraWinCalcManager.CalcManagerEventGroups">
  12522. <summary>
  12523. Identifies groups of UltraCalcManager specific events.
  12524. </summary>
  12525. <remarks>
  12526. <p class="body">This enumeration is used to specify a group of events when calling the <see cref="M:Infragistics.Win.UltraWinCalcManager.CalcManagerEventManager.SetEnabled(Infragistics.Win.UltraWinCalcManager.CalcManagerEventIds,System.Boolean)"/> method.</p>
  12527. </remarks>
  12528. </member>
  12529. <member name="F:Infragistics.Win.UltraWinCalcManager.CalcManagerEventGroups.AllEvents">
  12530. <summary>
  12531. All events
  12532. </summary>
  12533. </member>
  12534. <member name="F:Infragistics.Win.UltraWinCalcManager.CalcManagerEventGroups.ErrorEvents">
  12535. <summary>
  12536. FormulaSyntaxError, FormulaReferenceError, FormulaCalculationError and FormulaCircularityError events.
  12537. </summary>
  12538. </member>
  12539. <member name="T:Infragistics.Win.UltraWinCalcManager.ValueDirtiedAction">
  12540. <summary>
  12541. Indicates which type of action took place to dirty the Calculation Network
  12542. </summary>
  12543. </member>
  12544. <member name="F:Infragistics.Win.UltraWinCalcManager.ValueDirtiedAction.ReferenceAdded">
  12545. <summary>
  12546. A reference was added to the Calc Network
  12547. </summary>
  12548. </member>
  12549. <member name="F:Infragistics.Win.UltraWinCalcManager.ValueDirtiedAction.ReferenceRemoved">
  12550. <summary>
  12551. A reference was removed the Calc Network. Note that in this case the formula associated with the reference is also removed.
  12552. </summary>
  12553. </member>
  12554. <member name="F:Infragistics.Win.UltraWinCalcManager.ValueDirtiedAction.RowReferenceAdded">
  12555. <summary>
  12556. A row reference was added to the Calc Network. A row reference is differnet from a regular reference because it refer to an item in a collection such as an UltraGridRow.
  12557. </summary>
  12558. </member>
  12559. <member name="F:Infragistics.Win.UltraWinCalcManager.ValueDirtiedAction.RowReferenceRemoved">
  12560. <summary>
  12561. A row reference was removed the Calc Network. Note that in this case the formula associated with the reference is also removed. A row reference is differnet from a regular reference because it refer to an item in a collection such as an UltraGridRow.
  12562. </summary>
  12563. </member>
  12564. <member name="F:Infragistics.Win.UltraWinCalcManager.ValueDirtiedAction.RowsCollectionReferenceResynched">
  12565. <summary>
  12566. A rows collection reference was resynched.
  12567. </summary>
  12568. </member>
  12569. <member name="F:Infragistics.Win.UltraWinCalcManager.ValueDirtiedAction.RowsCollectionReferenceSorted">
  12570. <summary>
  12571. A rows collection reference was sorted.
  12572. </summary>
  12573. </member>
  12574. <member name="F:Infragistics.Win.UltraWinCalcManager.ValueDirtiedAction.RowsCollectionVisibilityChanged">
  12575. <summary>
  12576. The visibility of a row or rows in a rows collection has changed.
  12577. </summary>
  12578. </member>
  12579. <member name="F:Infragistics.Win.UltraWinCalcManager.ValueDirtiedAction.FormulaAdded">
  12580. <summary>
  12581. A Formula was added to the Calc Network
  12582. </summary>
  12583. </member>
  12584. <member name="F:Infragistics.Win.UltraWinCalcManager.ValueDirtiedAction.FormulaRemoved">
  12585. <summary>
  12586. A Formula was removed from the Calc Network
  12587. </summary>
  12588. </member>
  12589. <member name="F:Infragistics.Win.UltraWinCalcManager.ValueDirtiedAction.ValueChanged">
  12590. <summary>
  12591. A Value in the Calc Network has changed
  12592. </summary>
  12593. </member>
  12594. <member name="T:Infragistics.Win.UltraWinCalcManager.CalcManagerEventManager">
  12595. <summary>
  12596. Class for managing an <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/>'s events. It maintains an
  12597. enabled flag for each event as well as a nested 'in progress'
  12598. count and it exposes methods for firing each event.
  12599. </summary>
  12600. <remarks>
  12601. <p class="body">For internal use only.</p>
  12602. </remarks>
  12603. </member>
  12604. <member name="M:Infragistics.Win.UltraWinCalcManager.CalcManagerEventManager.#ctor(Infragistics.Win.UltraWinCalcManager.UltraCalcManager)">
  12605. <summary>
  12606. Initializes a new <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcManagerEventManager"/>.
  12607. </summary>
  12608. <param name="ultraCalcManager">UltraCalcManager that this event manager will be asociated with.</param>
  12609. </member>
  12610. <member name="M:Infragistics.Win.UltraWinCalcManager.CalcManagerEventManager.InProgress(Infragistics.Win.UltraWinCalcManager.CalcManagerEventIds)">
  12611. <summary>
  12612. Returns true if the event is in progress (in progress count > 0).
  12613. </summary>
  12614. <param name="eventid">A CalcManagerEventIds value which indicates which event is being examined.</param>
  12615. <remarks>
  12616. <p class="body">Determines if the specified event is currently in progress.</p>
  12617. </remarks>
  12618. <returns>True if the event is currently in progress. False if it is not.</returns>
  12619. </member>
  12620. <member name="M:Infragistics.Win.UltraWinCalcManager.CalcManagerEventManager.IsEnabled(Infragistics.Win.UltraWinCalcManager.CalcManagerEventIds)">
  12621. <summary>
  12622. Returns true if the event is enabled.
  12623. </summary>
  12624. <remarks>
  12625. <p class="body">Returns whether a particular event is enabled.</p>
  12626. </remarks>
  12627. <param name="eventid">A <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcManagerEventIds"/> value which indicates which event is being examined.</param>
  12628. <returns>True if the event is currently enabled. False if it is not enabled.</returns>
  12629. </member>
  12630. <member name="M:Infragistics.Win.UltraWinCalcManager.CalcManagerEventManager.SetEnabled(Infragistics.Win.UltraWinCalcManager.CalcManagerEventIds,System.Boolean)">
  12631. <summary>
  12632. Sets a specific event to enabled or disabled.
  12633. </summary>
  12634. <remarks>
  12635. <p class="body">This method can be used to enable or disable the firing of a specific event.</p>
  12636. <p class="body">Note that disabling an event does not prevent any internal processing by the component. It merely prevents the event handler from being called.</p>
  12637. </remarks>
  12638. <param name="enabled">A boolean indicating whether the event is to be enabled (true) or disabled (false).</param>
  12639. <param name="eventid">A <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcManagerEventIds"/> value which specifies the event to be enabled or disabled.</param>
  12640. </member>
  12641. <member name="M:Infragistics.Win.UltraWinCalcManager.CalcManagerEventManager.IsEnabled(Infragistics.Win.UltraWinCalcManager.CalcManagerEventGroups)">
  12642. <summary>
  12643. Returns true if all events in the group are enabled.
  12644. </summary>
  12645. <remarks>
  12646. <p class="body">Returns whether a group of events is enabled.</p>
  12647. </remarks>
  12648. <param name="group">A <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcManagerEventGroups"/> value which indicates which group of events being examined.</param>
  12649. <returns>True if the event group is currently enabled. False if it is not enabled.</returns>
  12650. </member>
  12651. <member name="M:Infragistics.Win.UltraWinCalcManager.CalcManagerEventManager.SetEnabled(Infragistics.Win.UltraWinCalcManager.CalcManagerEventGroups,System.Boolean)">
  12652. <summary>
  12653. Sets all events in the group to enabled or disabled.
  12654. </summary>
  12655. <remarks>
  12656. <p class="body">This method can be used to enable or disable the firing of a group of events.</p>
  12657. <p class="body">Note that disabling an event does not prevent any internal processing by the component. It merely prevents the event handler from being called.</p>
  12658. </remarks>
  12659. <param name="enabled">A boolean indicating whether the event group is to be enabled (true) or disabled (false).</param>
  12660. <param name="group">A <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcManagerEventGroups"/> value which specifies the group of events to be enabled or disabled.</param>
  12661. </member>
  12662. <member name="T:Infragistics.Win.UltraWinCalcManager.ValueDirtiedEventHandler">
  12663. <summary>
  12664. Delegate for <see cref="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ValueDirtied"/> event.
  12665. </summary>
  12666. </member>
  12667. <member name="T:Infragistics.Win.UltraWinCalcManager.FormulaCalculationErrorEventHandler">
  12668. <summary>
  12669. Delegate for Formula Error events of an IUltraCalcManager.
  12670. </summary>
  12671. </member>
  12672. <member name="T:Infragistics.Win.UltraWinCalcManager.FormulaSyntaxErrorEventHandler">
  12673. <summary>
  12674. Delegate for Formula Syntax Error event of an UltraCalcManager.
  12675. </summary>
  12676. </member>
  12677. <member name="T:Infragistics.Win.UltraWinCalcManager.FormulaCircularityErrorEventHandler">
  12678. <summary>
  12679. Delegate for FormulaCircularityError event of an UltraCalcManager.
  12680. </summary>
  12681. </member>
  12682. <member name="T:Infragistics.Win.UltraWinCalcManager.ParseValueEventHandler">
  12683. <summary>
  12684. Delegate for ParseValue event of an UltraCalcManager.
  12685. </summary>
  12686. </member>
  12687. <member name="T:Infragistics.Win.UltraWinCalcManager.FormatValueEventHandler">
  12688. <summary>
  12689. Delegate for FormatValue event of an UltraCalcManager.
  12690. </summary>
  12691. </member>
  12692. <member name="T:Infragistics.Win.UltraWinCalcManager.NamedReferenceResultChangedEventHandler">
  12693. <summary>
  12694. Delegate for NamedReferenceResultChanged event of an UltraCalcManager.
  12695. </summary>
  12696. </member>
  12697. <member name="T:Infragistics.Win.UltraWinCalcManager.ValueDirtiedEventArgs">
  12698. <summary>
  12699. Base class for event args that have an associated row.
  12700. </summary>
  12701. </member>
  12702. <member name="M:Infragistics.Win.UltraWinCalcManager.ValueDirtiedEventArgs.#ctor(System.Object,Infragistics.Win.UltraWinCalcManager.ValueDirtiedAction)">
  12703. <summary>
  12704. Initializes a new <see cref="T:Infragistics.Win.UltraWinCalcManager.ValueDirtiedEventArgs"/> object.
  12705. </summary>
  12706. <param name="context">Sets the <see cref="P:Infragistics.Win.UltraWinCalcManager.ValueDirtiedEventArgs.Context"/> property of the new <see cref="T:Infragistics.Win.UltraWinCalcManager.ValueDirtiedEventArgs"/>.</param>
  12707. <param name="action">Sets the <see cref="P:Infragistics.Win.UltraWinCalcManager.ValueDirtiedEventArgs.Action"/> property of the new <see cref="T:Infragistics.Win.UltraWinCalcManager.ValueDirtiedEventArgs"/>.</param>
  12708. </member>
  12709. <member name="P:Infragistics.Win.UltraWinCalcManager.ValueDirtiedEventArgs.Context">
  12710. <summary>
  12711. Gets the Context.
  12712. </summary>
  12713. <remarks><p class="body">The <b>Context</b> indicates the object which was changed. This can be any object that particpates in the calculation network such an UltraGridCell, NamedReference, Control, etc.</p></remarks>
  12714. </member>
  12715. <member name="P:Infragistics.Win.UltraWinCalcManager.ValueDirtiedEventArgs.Action">
  12716. <summary>
  12717. Gets a the action which occurred.
  12718. </summary>
  12719. <remarks>
  12720. <p class="body">The action indicates what type of change occurred. See the <see cref="T:Infragistics.Win.UltraWinCalcManager.ValueDirtiedAction"/> enumeration for the list of possible actions.</p>
  12721. </remarks>
  12722. </member>
  12723. <member name="T:Infragistics.Win.UltraWinCalcManager.FormulaSyntaxErrorEventArgs">
  12724. <summary>
  12725. Event args for <see cref="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.FormulaSyntaxError"/> event of an <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/>.
  12726. </summary>
  12727. </member>
  12728. <member name="M:Infragistics.Win.UltraWinCalcManager.FormulaSyntaxErrorEventArgs.#ctor(System.Object,System.String,System.Boolean)">
  12729. <summary>
  12730. Creates a new <see cref="T:Infragistics.Win.UltraWinCalcManager.FormulaSyntaxErrorEventArgs"/> and sets properties to the specified values.
  12731. </summary>
  12732. <param name="context">Sets the <see cref="P:Infragistics.Win.CalcEngine.FormulaErrorEventArgsBase.Context"/> property of the new <see cref="T:Infragistics.Win.UltraWinCalcManager.FormulaSyntaxErrorEventArgs"/>.</param>
  12733. <param name="displayErrorMessage">Sets the <see cref="P:Infragistics.Win.UltraWinCalcManager.FormulaSyntaxErrorEventArgs.DisplayErrorMessage"/> property of the new <see cref="T:Infragistics.Win.UltraWinCalcManager.FormulaSyntaxErrorEventArgs"/>.</param>
  12734. <param name="errorDisplayText">Sets the <see cref="P:Infragistics.Win.CalcEngine.FormulaErrorEventArgsBase.ErrorDisplayText"/> property of the new <see cref="T:Infragistics.Win.UltraWinCalcManager.FormulaSyntaxErrorEventArgs"/>.</param>
  12735. </member>
  12736. <member name="P:Infragistics.Win.UltraWinCalcManager.FormulaSyntaxErrorEventArgs.DisplayErrorMessage">
  12737. <summary>
  12738. Gets / set whether to display an error message to the user
  12739. </summary>
  12740. <remarks><p class="body">Gets / sets whether to display an error message to the user.</p></remarks>
  12741. </member>
  12742. <member name="T:Infragistics.Win.UltraWinCalcManager.FormulaCircularityErrorEventArgs">
  12743. <summary>
  12744. Event args for <see cref="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.FormulaCircularityError"/> event of an <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/>.
  12745. </summary>
  12746. </member>
  12747. <member name="M:Infragistics.Win.UltraWinCalcManager.FormulaCircularityErrorEventArgs.#ctor(System.Object,System.String,System.Boolean)">
  12748. <summary>
  12749. Creates a new <see cref="T:Infragistics.Win.UltraWinCalcManager.FormulaCircularityErrorEventArgs"/> and sets properties to the specified values.
  12750. </summary>
  12751. <param name="context">Sets the <see cref="P:Infragistics.Win.CalcEngine.FormulaErrorEventArgsBase.Context"/> property of the new <see cref="T:Infragistics.Win.UltraWinCalcManager.FormulaCircularityErrorEventArgs"/>.</param>
  12752. <param name="errorDisplayText">Sets the <see cref="P:Infragistics.Win.CalcEngine.FormulaErrorEventArgsBase.ErrorDisplayText"/> property of the new <see cref="T:Infragistics.Win.UltraWinCalcManager.FormulaCircularityErrorEventArgs"/>.</param>
  12753. <param name="displayErrorMessage">Sets the <see cref="P:Infragistics.Win.UltraWinCalcManager.FormulaCircularityErrorEventArgs.DisplayErrorMessage"/> property of the new <see cref="T:Infragistics.Win.UltraWinCalcManager.FormulaCircularityErrorEventArgs"/>.</param>
  12754. </member>
  12755. <member name="P:Infragistics.Win.UltraWinCalcManager.FormulaCircularityErrorEventArgs.DisplayErrorMessage">
  12756. <summary>
  12757. Gets / set whether to display an error message to the user
  12758. </summary>
  12759. <remarks><p class="body">Gets / sets whether to display an error message to the user.</p></remarks>
  12760. </member>
  12761. <member name="T:Infragistics.Win.UltraWinCalcManager.ControlValueEventArgsBase">
  12762. <summary>
  12763. Base class for event args used in the <see cref="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ParseValue"/> and <see cref="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.FormatValue"/> events.
  12764. </summary>
  12765. </member>
  12766. <member name="M:Infragistics.Win.UltraWinCalcManager.ControlValueEventArgsBase.#ctor(System.Windows.Forms.Control,System.Object)">
  12767. <summary>
  12768. Initializes a new <see cref="T:Infragistics.Win.UltraWinCalcManager.ControlValueEventArgsBase"/>
  12769. </summary>
  12770. <param name="control">Control whose value is being parsed/formatted</param>
  12771. <param name="originalValue">Original value</param>
  12772. </member>
  12773. <member name="P:Infragistics.Win.UltraWinCalcManager.ControlValueEventArgsBase.Control">
  12774. <summary>
  12775. Gets the Control whose property is being read or written.
  12776. </summary>
  12777. <remarks>
  12778. <p class="body">This property indicates the control whose value is being retrieved or set by the CalcManager.</p>
  12779. </remarks>
  12780. </member>
  12781. <member name="P:Infragistics.Win.UltraWinCalcManager.ControlValueEventArgsBase.Value">
  12782. <summary>
  12783. Gets/Sets the value which is being sent from the CalcManager to the control or the control to the CalcManager
  12784. </summary>
  12785. <remarks>
  12786. <p class="body">In the case of the ParseValue event, Value will return the value read from the control. Changing the Value in this event will change how the CalcManager interprets the value. For example, in order to use a formatting number like "$5.00", it must be converted into a numeric value like "5.0".</p>
  12787. <p class="body">In the case of the FormatValue event, Value will return the value from the Calcmanager that is about to be assigned to a property on the control. Changing the Value in this case will assign the newly changed value to the control instead. So this can be used to change the value, the datatype, or simply to format the value into a more user-friendly display.</p>
  12788. </remarks>
  12789. </member>
  12790. <member name="T:Infragistics.Win.UltraWinCalcManager.ParseValueEventArgs">
  12791. <summary>
  12792. Event args for the <see cref="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ParseValue"/> event of an <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/>.
  12793. </summary>
  12794. </member>
  12795. <member name="M:Infragistics.Win.UltraWinCalcManager.ParseValueEventArgs.#ctor(System.Windows.Forms.Control,System.Object)">
  12796. <summary>
  12797. Initializes a new <see cref="T:Infragistics.Win.UltraWinCalcManager.ParseValueEventArgs"/>
  12798. </summary>
  12799. <param name="control">Returns the control whose value is being parsed.</param>
  12800. <param name="originalValue">The original value of the control. This value will be the value of whatever property of the control is specified by the <see cref="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.PropertyName"/> property.</param>
  12801. </member>
  12802. <member name="P:Infragistics.Win.UltraWinCalcManager.ParseValueEventArgs.Handled">
  12803. <summary>
  12804. Gets / Sets whether the Parsing was handled.
  12805. </summary>
  12806. <remarks>
  12807. <p class="body">Set Handled to True to indicate that a parsing was handled. This means that the TreatAsType property will be ignored for this conversion.</p>
  12808. </remarks>
  12809. </member>
  12810. <member name="T:Infragistics.Win.UltraWinCalcManager.FormatValueEventArgs">
  12811. <summary>
  12812. Event args for the <see cref="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.FormatValue"/> event of an <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/>.
  12813. </summary>
  12814. </member>
  12815. <member name="M:Infragistics.Win.UltraWinCalcManager.FormatValueEventArgs.#ctor(System.Windows.Forms.Control,System.Object,System.Type,Infragistics.Win.CalcEngine.UltraCalcValue)">
  12816. <summary>
  12817. Initializes a new <see cref="T:Infragistics.Win.UltraWinCalcManager.FormatValueEventArgs"/>
  12818. </summary>
  12819. <param name="control">Control whose value is being formatted</param>
  12820. <param name="originalValue">Original value</param>
  12821. <param name="desiredType">Destination type</param>
  12822. <param name="CalcValue">Calculation value</param>
  12823. </member>
  12824. <member name="P:Infragistics.Win.UltraWinCalcManager.FormatValueEventArgs.DesiredType">
  12825. <summary>
  12826. Gets the type expected by property of the control which is being set.
  12827. </summary>
  12828. <remarks>
  12829. <p class="body">The DesiredType indicates the <see cref="T:System.Type"/> that the control is expecting.</p>
  12830. <p class="body">The <see cref="P:Infragistics.Win.UltraWinCalcManager.ControlValueEventArgsBase.Value"/> property should be assigned a value of this type.</p>
  12831. </remarks>
  12832. </member>
  12833. <member name="P:Infragistics.Win.UltraWinCalcManager.FormatValueEventArgs.CalcValue">
  12834. <summary>
  12835. Gets the IUltraCalcValue being used by the CalcManager to set the value of the control.
  12836. </summary>
  12837. <remarks>
  12838. <p class="body">CalcValue returns the UltraCalcValue being used by the CalcManager. This is provided so that the programmer can detect special situations like the occurance of a CalculationError.</p>
  12839. </remarks>
  12840. </member>
  12841. <member name="T:Infragistics.Win.UltraWinCalcManager.NamedReferenceResultChangedEventArgs">
  12842. <summary>
  12843. Event args for <see cref="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.NamedReferenceResultChanged"/> event of an <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/>.
  12844. </summary>
  12845. </member>
  12846. <member name="M:Infragistics.Win.UltraWinCalcManager.NamedReferenceResultChangedEventArgs.#ctor(Infragistics.Win.UltraWinCalcManager.NamedReference)">
  12847. <summary>
  12848. Initializes a new <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReferenceResultChangedEventArgs"/>.
  12849. </summary>
  12850. <param name="namedReference">Sets the <see cref="P:Infragistics.Win.UltraWinCalcManager.NamedReferenceResultChangedEventArgs.NamedReference"/> property of the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReferenceResultChangedEventArgs"/> object.</param>
  12851. </member>
  12852. <member name="P:Infragistics.Win.UltraWinCalcManager.NamedReferenceResultChangedEventArgs.NamedReference">
  12853. <summary>
  12854. Gets the NamedReference whose Value was changed.
  12855. </summary>
  12856. <remarks>
  12857. <p class="body">This property returns the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> whose <see cref="P:Infragistics.Win.UltraWinCalcManager.NamedReference.FormulaResult"/>has changed.</p>
  12858. </remarks>
  12859. </member>
  12860. <member name="T:Infragistics.Win.UltraWinCalcManager.FormulaBuilder.IFormulaBuilderInfo">
  12861. <summary>
  12862. Provides information about the UltraCalcManager to the Designer.
  12863. </summary>
  12864. <remarks>
  12865. <p class="body">This class is for internal infrastructure only and should not be used.</p>
  12866. </remarks>
  12867. </member>
  12868. <member name="M:Infragistics.Win.UltraWinCalcManager.FormulaBuilder.IFormulaBuilderInfo.GetReferenceTree">
  12869. <summary>
  12870. Returns a tree of ReferenceNodes which can be used for display in the Designer.
  12871. </summary>
  12872. <remarks>This property is for internal infrastrucure only and should not be used.</remarks>
  12873. <returns>Returns an array of ReferenceNode object in a tree structure representing the references as they should appear in the designer.</returns>
  12874. </member>
  12875. <member name="M:Infragistics.Win.UltraWinCalcManager.FormulaBuilder.IFormulaBuilderInfo.GetUltraCalcReference(Infragistics.Win.UltraWinCalcManager.NamedReference)">
  12876. <summary>
  12877. Returns the IUltraCalcReference associated with a <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> to the Designer.
  12878. </summary>
  12879. <remarks>This method is for internal infrastrucure only and should not be used.</remarks>
  12880. <param name="namedReference">The <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> whose IUltraCalcReference will be returned.</param>
  12881. <returns>An IUltraCalcReference associated with the specified <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/></returns>
  12882. </member>
  12883. <member name="M:Infragistics.Win.UltraWinCalcManager.FormulaBuilder.IFormulaBuilderInfo.GetUltraCalcReference(Infragistics.Win.UltraWinCalcManager.CalcSettings)">
  12884. <summary>
  12885. Returns the IUltraCalcReference associated with a <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> to the Designer.
  12886. </summary>
  12887. <param name="calcSettings">The <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> whose IUltraCalcReference will be returned.</param>
  12888. <remarks>This method is for internal infrastrucure only and should not be used.</remarks>
  12889. <returns>An IUltraCalcReference associated with the specified <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/></returns>
  12890. </member>
  12891. <member name="M:Infragistics.Win.UltraWinCalcManager.FormulaBuilder.IFormulaBuilderInfo.GetUniqueFunctionCategories">
  12892. <summary>
  12893. Returns a list of categories based on all known functions both built-in and user-defined.
  12894. </summary>
  12895. <remarks>This method is for internal infrastrucure only and should not be used.</remarks>
  12896. <returns>An array of strings containing the names of the function categories</returns>
  12897. </member>
  12898. <member name="M:Infragistics.Win.UltraWinCalcManager.FormulaBuilder.IFormulaBuilderInfo.GetAllFunctions">
  12899. <summary>
  12900. Returns the UltraCalcFunctions for all categories
  12901. </summary>
  12902. <remarks>This method is for internal infrastrucure only and should not be used.</remarks>
  12903. <returns>An array of <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunction"/> objects representing all functions in the calculation network."/&gt;</returns>
  12904. </member>
  12905. <member name="M:Infragistics.Win.UltraWinCalcManager.FormulaBuilder.IFormulaBuilderInfo.GetUnassignedFunctions">
  12906. <summary>
  12907. Returns the UltraCalcFunctions for unassigned functions (functions which have no category).
  12908. </summary>
  12909. <remarks>This method is for internal infrastrucure only and should not be used.</remarks>
  12910. <returns>Retuns an array of <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunction"/> objects that are not assigned to any category.</returns>
  12911. </member>
  12912. <member name="M:Infragistics.Win.UltraWinCalcManager.FormulaBuilder.IFormulaBuilderInfo.GetFunctions(System.String)">
  12913. <summary>
  12914. Returns the UltraCalcFunctions for the specified category
  12915. </summary>
  12916. <remarks>This method is for internal infrastrucure only and should not be used.</remarks>
  12917. <returns>An array of <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunction"/> objects that belong to the specified category.</returns>
  12918. </member>
  12919. <member name="T:Infragistics.Win.UltraWinCalcManager.NamedReference">
  12920. <summary>
  12921. Represents a calculated value with no associated control.
  12922. </summary>
  12923. <remarks>
  12924. <p class="body">A NamedReference is a reference in the calculation network with no associated control.</p>
  12925. <p class="body">By creating a NamedReference with a <see cref="P:Infragistics.Win.UltraWinCalcManager.NamedReference.Formula"/>, you can create constants to be used in other calculations, or store the results of a calculation which may not need to be displayed on-screen, but can be used in code or in other calculations.</p>
  12926. <p class="body">To get the calculated value of a NamedReference, use the <see cref="P:Infragistics.Win.UltraWinCalcManager.NamedReference.FormulaResult"/> property.</p>
  12927. </remarks>
  12928. </member>
  12929. <member name="M:Infragistics.Win.UltraWinCalcManager.NamedReference.#ctor">
  12930. <summary>
  12931. Creates a new <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> with default property settings.
  12932. </summary>
  12933. <remarks>
  12934. <p class="body">In order for a <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> to be part of the calculation network, it must be added to the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection"/> of the <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/>.</p>
  12935. </remarks>
  12936. </member>
  12937. <member name="M:Infragistics.Win.UltraWinCalcManager.NamedReference.#ctor(System.String)">
  12938. <summary>
  12939. Creates a new <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> with the specified property settings.
  12940. </summary>
  12941. <param name="key">Sets the <see cref="P:Infragistics.Win.UltraWinCalcManager.NamedReference.Key"/> property of the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/>.</param>
  12942. <remarks>
  12943. <p class="body">In order for a <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> to be part of the calculation network, it must be added to the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection"/> of the <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/>.</p>
  12944. </remarks>
  12945. </member>
  12946. <member name="M:Infragistics.Win.UltraWinCalcManager.NamedReference.#ctor(System.String,System.String)">
  12947. <summary>
  12948. Creates a new <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> with the specified property settings.
  12949. </summary>
  12950. <param name="key">Sets the <see cref="P:Infragistics.Win.UltraWinCalcManager.NamedReference.Key"/> property of the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/>.</param>
  12951. <param name="formula">Sets the <see cref="P:Infragistics.Win.UltraWinCalcManager.NamedReference.Formula"/> property of the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/>.</param>
  12952. <remarks>
  12953. <p class="body">In order for a <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> to be part of the calculation network, it must be added to the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection"/> of the <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/>.</p>
  12954. </remarks>
  12955. </member>
  12956. <member name="M:Infragistics.Win.UltraWinCalcManager.NamedReference.#ctor(System.String,System.String,System.String,System.Object)">
  12957. <summary>
  12958. Creates a new <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> with the specified property settings.
  12959. </summary>
  12960. <param name="key">Sets the <see cref="P:Infragistics.Win.UltraWinCalcManager.NamedReference.Key"/> property of the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/>.</param>
  12961. <param name="formula">Sets the <see cref="P:Infragistics.Win.UltraWinCalcManager.NamedReference.Formula"/> property of the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/>.</param>
  12962. <param name="category">Sets the <see cref="P:Infragistics.Win.UltraWinCalcManager.NamedReference.Category"/> property of the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/>.</param>
  12963. <param name="tag">Sets the <see cref="P:Infragistics.Shared.SubObjectBase.Tag"/> property of the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/>.</param>
  12964. <remarks>
  12965. <p class="body">In order for a <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> to be part of the calculation network, it must be added to the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection"/> of the <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/>.</p>
  12966. </remarks>
  12967. </member>
  12968. <member name="M:Infragistics.Win.UltraWinCalcManager.NamedReference.OnAddedToCollection(Infragistics.Shared.KeyedSubObjectsCollectionBase)">
  12969. <summary>
  12970. Occurs when the NamedReference is added to a NamedReferences collection
  12971. </summary>
  12972. <param name="primaryCollection">The parent collection to which the NamedReference is being added.</param>
  12973. </member>
  12974. <member name="M:Infragistics.Win.UltraWinCalcManager.NamedReference.OnRemovedFromCollection(Infragistics.Shared.KeyedSubObjectsCollectionBase)">
  12975. <summary>
  12976. Occurs when the NamedReference is removed from a NamedReferences collection
  12977. </summary>
  12978. <param name="primaryCollection">The parent collection from which the NamedReference is being removed.</param>
  12979. </member>
  12980. <member name="M:Infragistics.Win.UltraWinCalcManager.NamedReference.ToString">
  12981. <summary>
  12982. Converts the NamedReference to a string
  12983. </summary>
  12984. <returns>The Key and Formula of the NamedReference</returns>
  12985. </member>
  12986. <member name="M:Infragistics.Win.UltraWinCalcManager.NamedReference.Reset">
  12987. <summary>
  12988. Resets all NamedReference properties to their defaults
  12989. </summary>
  12990. </member>
  12991. <member name="P:Infragistics.Win.UltraWinCalcManager.NamedReference.AbsoluteName">
  12992. <summary>
  12993. Returns the absolute name of the NamedReference that can be used in a formula.
  12994. </summary>
  12995. <remarks>
  12996. <para class="body">The absolute name may differ from the Key of the NamedReference in cases where there are special characters in the Key that need escapement.</para>
  12997. </remarks>
  12998. </member>
  12999. <member name="P:Infragistics.Win.UltraWinCalcManager.NamedReference.Formula">
  13000. <summary>
  13001. The Formula which will be used to set the value of this object.
  13002. </summary>
  13003. <remarks>
  13004. <p class="body">The Formula property will be used to calculate a value and that value will be returned by the <see cref="P:Infragistics.Win.UltraWinCalcManager.NamedReference.FormulaResult"/> property of the NamedReference. This calculated Value will be used any time the NamedReference is used in a calculation.</p>
  13005. </remarks>
  13006. </member>
  13007. <member name="P:Infragistics.Win.UltraWinCalcManager.NamedReference.Category">
  13008. <summary>
  13009. Gets/Sets the category of the NamedReference
  13010. </summary>
  13011. <remarks>
  13012. <p class="body">Category is used to organize NamedReferences into groups in the Formula designer.</p>
  13013. </remarks>
  13014. </member>
  13015. <member name="P:Infragistics.Win.UltraWinCalcManager.NamedReference.ParentCollection">
  13016. <summary>
  13017. Returns the NamedReferences collection this NamedReference is associated with. Typically the returned NamedReferences collection would contain this NamedReference.
  13018. </summary>
  13019. </member>
  13020. <member name="P:Infragistics.Win.UltraWinCalcManager.NamedReference.FormulaResult">
  13021. <summary>
  13022. Gets the value which will be used as the source in any calculations involving the NamedReference
  13023. </summary>
  13024. <remarks>
  13025. <p class="body">Value returns the current value that any calculations referencing the NamedReference will use. If the NamedReference is the target of a formula, then this will be the last calculated value.</p>
  13026. <p class="note">Note that the value may be an UltraCalcValueError.</p>
  13027. </remarks>
  13028. </member>
  13029. <member name="P:Infragistics.Win.UltraWinCalcManager.NamedReference.Key">
  13030. <summary>
  13031. Get/Sets the unique key used to identify the NamedReference.
  13032. </summary>
  13033. <remarks>
  13034. Us the Key to reference this NamedReference in a formula. When referencing a NamedReference from a sub-object of a control, the syntax is "[//key]" where <b>key</b> is the Key of the NamedReference. Note that all NamedReferences and CalcSettings are sibling of each other. So to reference a NamedReference from the formula of another NamedReference, the double slashes are not neccessary. So "[key]" is acceptable.
  13035. </remarks>
  13036. </member>
  13037. <member name="T:Infragistics.Win.UltraWinCalcManager.NamedReference.NamedReferenceConverter">
  13038. <summary>
  13039. Type converter or the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> class.
  13040. </summary>
  13041. <remarks>
  13042. <p class="body">This is used to convert a <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> object to and from an InstanceDescriptor for the purposes of serialization / deserialization.</p>
  13043. <p class="body">It also allows expanding the properties of the object in the PropertyGrid.</p>
  13044. </remarks>
  13045. </member>
  13046. <member name="M:Infragistics.Win.UltraWinCalcManager.NamedReference.NamedReferenceConverter.CanConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Type)">
  13047. <summary>
  13048. Gets a value indicating whether this converter can convert an object to the given destination type using the context.
  13049. </summary>
  13050. <remarks></remarks>
  13051. <param name="context">An ITypeDescriptorContext that provides a format context.</param>
  13052. <param name="destinationType">A <see cref="T:System.Type"/> that represents the type you want to convert to.</param>
  13053. <returns>This method returns true if this converter can perform the conversion; otherwise, false.</returns>
  13054. </member>
  13055. <member name="M:Infragistics.Win.UltraWinCalcManager.NamedReference.NamedReferenceConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
  13056. <summary>
  13057. Converts the specified object to the specified type.
  13058. </summary>
  13059. <param name="context">A formatter context. This object can be used to get additional information about the environment this converter is being called from. This may be null, so you should always check. Also, properties on the context object may also return null.</param>
  13060. <param name="culture">An object that contains culture specific information, such as the language, calendar, and cultural conventions associated with a specific culture. It is based on the RFC 1766 standard.</param>
  13061. <param name="destinationType">The type to convert the object to.</param>
  13062. <param name="value">The object to convert.</param>
  13063. <returns>The converted object.</returns>
  13064. </member>
  13065. <member name="T:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection">
  13066. <summary>
  13067. A collection of <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> objects in the calculation network.
  13068. </summary>
  13069. <remarks>
  13070. <p class="body">Add <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> objects to the collection for use as constants or calculated values that have no associated control.</p>
  13071. </remarks>
  13072. </member>
  13073. <member name="M:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection.OnSubObjectPropChanged(Infragistics.Shared.PropChangeInfo)">
  13074. <summary>
  13075. handles certain property change events
  13076. </summary>
  13077. <param name="propChange"><see cref="T:Infragistics.Shared.PropChangeInfo"/></param>
  13078. </member>
  13079. <member name="M:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection.Add(System.String,System.String)">
  13080. <summary>
  13081. Adds a new <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> with the specified <see cref="P:Infragistics.Win.UltraWinCalcManager.NamedReference.Key"/> and specified <see cref="P:Infragistics.Win.UltraWinCalcManager.NamedReference.Formula"/>.
  13082. </summary>
  13083. <remarks>
  13084. <p class="body">This method creates a new new <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> with the specified <see cref="P:Infragistics.Win.UltraWinCalcManager.NamedReference.Key"/> and specified <see cref="P:Infragistics.Win.UltraWinCalcManager.NamedReference.Formula"/>. The new <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> is then added to the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection"/> and returned.</p>
  13085. </remarks>
  13086. <param name="namedReferenceKey"><see cref="P:Infragistics.Win.UltraWinCalcManager.NamedReference.Key"/> of the new <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/>.</param>
  13087. <param name="formula">The <see cref="P:Infragistics.Win.UltraWinCalcManager.NamedReference.Formula"/> (or constant) to be referenced by this name.</param>
  13088. <returns>Returns the new <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/>.</returns>
  13089. </member>
  13090. <member name="M:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection.Add(Infragistics.Win.UltraWinCalcManager.NamedReference)">
  13091. <summary>
  13092. Adds a <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> to the collection.
  13093. </summary>
  13094. <remarks>
  13095. <p class="body">This method adds a <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> object into the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection"/> and return the index of the item in the collection.</p>
  13096. </remarks>
  13097. <param name="namedReference">The <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> to add.</param>
  13098. <returns>Returns the index of the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> into the collection.</returns>
  13099. </member>
  13100. <member name="M:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection.Insert(System.Int32,Infragistics.Win.UltraWinCalcManager.NamedReference)">
  13101. <summary>
  13102. Inserts a new <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> at the specified index.
  13103. </summary>
  13104. <remarks>
  13105. <p class="body">This method will insert a <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> into the collection at a specified index.</p>
  13106. <p class="note">Note that the order of items in the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection"/> is completely irrelevant to the <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/>.</p>
  13107. </remarks>
  13108. <param name="namedReference">The <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> to insert.</param>
  13109. <param name="index">The index at which to insert the item.</param>
  13110. </member>
  13111. <member name="M:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection.Remove(System.String)">
  13112. <summary>
  13113. Removes the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> with the specified <see cref="P:Infragistics.Win.UltraWinCalcManager.NamedReference.Key"/> from the collection.
  13114. </summary>
  13115. <remarks>
  13116. <p class="body">This method removes the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> with the specified <see cref="P:Infragistics.Win.UltraWinCalcManager.NamedReference.Key"/> from the collection. It is also removed from the calculation network.</p>
  13117. <p class="body">If the specified <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> does not exist in the collection, this method will do nothing.</p>
  13118. </remarks>
  13119. <param name="namedReferenceKey">The <see cref="P:Infragistics.Win.UltraWinCalcManager.NamedReference.Key"/> of the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> to be removed.</param>
  13120. </member>
  13121. <member name="M:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection.Remove(Infragistics.Win.UltraWinCalcManager.NamedReference)">
  13122. <summary>
  13123. Removes the specified <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> from the collection.
  13124. </summary>
  13125. <remarks>
  13126. <p class="body">This method removes the specified <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> from the collection. It is also removed from the calculation network.</p>
  13127. <p class="body">If the specified <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> does not exist in the collection, this method will do nothing.</p>
  13128. </remarks>
  13129. <param name="namedReference">The <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> to be removed.</param>
  13130. </member>
  13131. <member name="M:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection.RemoveAt(System.Int32)">
  13132. <summary>
  13133. Removes <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> at the specified location from the collection.
  13134. </summary>
  13135. <remarks>
  13136. <p class="body">This method removes the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> at the specified index in the collection. The item is removed both from the collection and from the calculation network.</p>
  13137. </remarks>
  13138. <param name="index">The index of the item to be removed.</param>
  13139. </member>
  13140. <member name="M:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection.Clear">
  13141. <summary>
  13142. Removes all the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> items from the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection"/>.
  13143. </summary>
  13144. <remarks>
  13145. <p class="body">This method clears the collection, removing all of the items from the collection and from the calculation network.</p>
  13146. </remarks>
  13147. </member>
  13148. <member name="M:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection.AddRange(System.Object[])">
  13149. <summary>
  13150. AddRange method for serialization and deserialization.
  13151. </summary>
  13152. <remarks>
  13153. <p class="body">This method is intended for internal use only. It is used to add an array of <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> objects to the collection in one atomic operation for the purposes of deserialization.</p>
  13154. </remarks>
  13155. <param name="namedReferences">An array of <see cref="T:System.Object"/> objects containing <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> objects.</param>
  13156. </member>
  13157. <member name="P:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection.InitialCapacity">
  13158. <summary>
  13159. Specifies the initial capacity of the collection.
  13160. </summary>
  13161. </member>
  13162. <member name="P:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection.IsReadOnly">
  13163. <summary>
  13164. Overridden. Always returns false since the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection"/> is not read-only.
  13165. </summary>
  13166. </member>
  13167. <member name="P:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection.AllowDuplicateKeys">
  13168. <summary>
  13169. Overridden. Always returns false since the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection"/> collection does not allow having two <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> objects with the same <see cref="P:Infragistics.Win.UltraWinCalcManager.NamedReference.Key"/>.
  13170. </summary>
  13171. </member>
  13172. <member name="P:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection.AllowEmptyKeys">
  13173. <summary>
  13174. Overridden. Always returns false since the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection"/> collection does not allow <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> objects with empty <see cref="P:Infragistics.Win.UltraWinCalcManager.NamedReference.Key"/> properties.
  13175. </summary>
  13176. </member>
  13177. <member name="P:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection.Item(System.String)">
  13178. <summary>
  13179. Gets the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> with the specified key.
  13180. </summary>
  13181. <param name="namedReferenceKey">The key of the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> in the collection.</param>
  13182. </member>
  13183. <member name="P:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection.Item(System.Int32)">
  13184. <summary>
  13185. Gets the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> at the specified location in the collection.
  13186. </summary>
  13187. <param name="index">The index into the collection.</param>
  13188. </member>
  13189. <member name="P:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection.CalcManager">
  13190. <summary>
  13191. The <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/> that the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection"/> collection belongs to.
  13192. </summary>
  13193. <remarks>
  13194. <p class="body">This property returns the <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/> component that this <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection"/> belongs to.</p>
  13195. </remarks>
  13196. </member>
  13197. <member name="T:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection.NamedReferencesCollectionEditor">
  13198. <summary>
  13199. Collection Editor for the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection"/>
  13200. </summary>
  13201. <remarks>
  13202. <p class="body">This class provides a UITypeEditor for the <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection"/> which allows adding, remove, and editing <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> objects in the colletion through the property grid.</p>
  13203. </remarks>
  13204. </member>
  13205. <member name="M:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection.NamedReferencesCollectionEditor.#ctor">
  13206. <summary>
  13207. Initializes a new <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection.NamedReferencesCollectionEditor"/>.
  13208. </summary>
  13209. </member>
  13210. <member name="M:Infragistics.Win.UltraWinCalcManager.NamedReferencesCollection.NamedReferencesCollectionEditor.DestroyInstance(System.Object)">
  13211. <summary>
  13212. Remove an item from the collection.
  13213. </summary>
  13214. <param name="instance"></param>
  13215. </member>
  13216. <member name="T:Infragistics.Win.UltraWinCalcManager.Resources">
  13217. <summary>
  13218. Exposes a <see cref="T:Infragistics.Shared.ResourceCustomizer"/> instance for this assembly.
  13219. </summary>
  13220. <seealso cref="P:Infragistics.Win.UltraWinCalcManager.Resources.Customizer"/>
  13221. <seealso cref="T:Infragistics.Shared.ResourceCustomizer"/>
  13222. </member>
  13223. <member name="M:Infragistics.Win.UltraWinCalcManager.Resources.GetString(System.String,System.Object[])">
  13224. <summary>
  13225. Returns the resource string using the specified name and default culture.
  13226. </summary>
  13227. <param name="name">Name of the string resource to return.</param>
  13228. <param name="args">Arguments supplied to the string.Format method when formatting the string.</param>
  13229. <returns>The resource string using the specified resource name and default culture.</returns>
  13230. </member>
  13231. <member name="M:Infragistics.Win.UltraWinCalcManager.Resources.GetString(System.String)">
  13232. <summary>
  13233. Returns the resource string using the specified resource name and default culture. The string is then formatted using the arguments specified.
  13234. </summary>
  13235. <param name="name">Name of the string resource to return.</param>
  13236. <returns>The resource string using the specified resource name and default culture.</returns>
  13237. </member>
  13238. <member name="M:Infragistics.Win.UltraWinCalcManager.Resources.GetObject(System.String)">
  13239. <summary>
  13240. Returns the resource object using the specified name.
  13241. </summary>
  13242. <param name="name">Name of the resource item</param>
  13243. <returns>An object containing the specified resource</returns>
  13244. </member>
  13245. <member name="P:Infragistics.Win.UltraWinCalcManager.Resources.Customizer">
  13246. <summary>
  13247. Returns the <see cref="T:Infragistics.Shared.ResourceCustomizer"/> for this assembly.
  13248. </summary>
  13249. <seealso cref="T:Infragistics.Shared.ResourceCustomizer"/>
  13250. </member>
  13251. <member name="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager">
  13252. <summary>
  13253. A component for providing formula calculation functionality to controls.
  13254. </summary>
  13255. <remarks>
  13256. <p class="body">The UltraCalcManager component creates a calculation network which can include controls (via <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> and <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/>. This allows you to set up formulas that will be calculated based on other values.</p>
  13257. <p class="body">Each item in the network is called a reference. A reference can be a <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> object which represent a control, a <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> which is essentially a constant or calulcated value with no visual representation, or an object that represent part of a control, such as an UltraGridColumn. A reference may be the target of a formula or the source value used in a formula, or both.</p>
  13258. </remarks>
  13259. </member>
  13260. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.#ctor">
  13261. <summary>
  13262. Initializes a new <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/>
  13263. </summary>
  13264. </member>
  13265. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.#ctor(System.ComponentModel.IContainer)">
  13266. <summary>
  13267. Initializes a new <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/>
  13268. </summary>
  13269. <param name="container">An <see cref="T:System.ComponentModel.IContainer"/> that represents the container of the <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/></param>
  13270. </member>
  13271. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.Dispose(System.Boolean)">
  13272. <summary>
  13273. Releases the unmanaged resources used by the component and optionally releases the managed resources.
  13274. </summary>
  13275. <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
  13276. </member>
  13277. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ShouldSerializeNamedReferences">
  13278. <summary>
  13279. Indicates if the <see cref="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.NamedReferences"/> property needs to be serialized
  13280. </summary>
  13281. <returns>True if the <b>NamedReferences</b> collection contains any items</returns>
  13282. <seealso cref="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.NamedReferences"/>
  13283. </member>
  13284. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ResetNamedReferences">
  13285. <summary>
  13286. Clears the contents of the <see cref="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.NamedReferences"/> collection.
  13287. </summary>
  13288. <remarks>
  13289. <p class="body">This methods clears the <see cref="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.NamedReferences"/> collection, removing all references both from the collection and the calculation network.</p>
  13290. </remarks>
  13291. </member>
  13292. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ShouldSerializeContainingControl">
  13293. <summary>
  13294. Returns true if the ContainingControl property should be serialized
  13295. </summary>
  13296. <returns>Returns true if this property is not set to its default value</returns>
  13297. </member>
  13298. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ShouldSerializeErrorIcon">
  13299. <summary>
  13300. Returns whether or not the ErrorIcon is set to the default.
  13301. </summary>
  13302. <returns>Returns false if the ErrorIcon is set to the default</returns>
  13303. </member>
  13304. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ResetErrorIcon">
  13305. <summary>
  13306. Resets the ErrorIcon property to the default error icon.
  13307. </summary>
  13308. <remarks>
  13309. Resets the ErrorIcon property to the default error icon.
  13310. </remarks>
  13311. </member>
  13312. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.SuspendCalc">
  13313. <summary>
  13314. Suspends calculations until <see cref="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ResumeCalc"/> is called.
  13315. </summary>
  13316. <remarks>
  13317. <p class="body">Calling SuspendCalc will temporarily suspend any automatic calculations performed by the <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/> until a subsequent call to <see cref="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ResumeCalc"/> is made.</p>
  13318. <p class="note">Note that the suspension refers to automatic calculations only. This means that calculations that would normally be performed on a timer when <see cref="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.CalcFrequency"/> is set to <b>Asynchronous</b> or on a change notification when the value of a control is dirtied when <see cref="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.CalcFrequency"/> is set to <b>Synchronous</b> will not be performed. Explicitly calling the <see cref="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ReCalc"/> method or the <see cref="M:Infragistics.Win.CalcEngine.IUltraCalcManager.EnsureCalculated(Infragistics.Win.CalcEngine.IUltraCalcReference,System.Boolean)"/> method will still force a calculation.</p>
  13319. <p class="note">Note also that each time <b>SuspendCalc</b> is called, a counter is incremented. So the same number of <see cref="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ResumeCalc"/> calls must be made before calculations will resume.</p>
  13320. </remarks>
  13321. </member>
  13322. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ResumeCalc">
  13323. <summary>
  13324. Resumes automatic calculations after a preceding call to <see cref="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.SuspendCalc"/>.
  13325. </summary>
  13326. <remarks>
  13327. <p class="body">The ResumCalc method will resume automatic calculations after a preceding call to the <see cref="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.SuspendCalc"/> method was made.</p>
  13328. <p class="note">Note also that each time <b>SuspendCalc</b> is called, a counter is incremented. So the same number of <see cref="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ResumeCalc"/> calls must be made before calculations will resume. If the call to <b>ResumeCalc</b> results in the counter reaching 0, then calculations will resume immediately - the <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/> will not wait for a timer tick or change notification.</p>
  13329. </remarks>
  13330. <seealso cref="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.SuspendCalc"/>
  13331. </member>
  13332. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.SuspendNotificationProcessing">
  13333. <summary>
  13334. Suspends notification processing.
  13335. </summary>
  13336. <remarks>
  13337. <p class="body">This method is typically used when you are about to perform operations in
  13338. UltraWinGrid that will cause a large number of calculation-related notifications to be raised.
  13339. Sometimes processing a large number of notifications can take a very long time. This method
  13340. can be used to suspend such processing of notifications. <see cref="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ResumeNotificationProcessing(System.Boolean)"/>
  13341. must be called to resume the processing of notifications. Since not processing notifications
  13342. can cause the calc manager to not enque formulas that need to be recalculated, you should call
  13343. <b>ResumeNotificationProcessing</b> with <b>dirtyAllFormulas</b> parameter set to true to
  13344. recalculate all the formulas.</p>
  13345. <seealso cref="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ResumeNotificationProcessing(System.Boolean)"/>
  13346. </remarks>
  13347. </member>
  13348. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ResumeNotificationProcessing(System.Boolean)">
  13349. <summary>
  13350. Resumes notification processing after a preceding call to <see cref="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.SuspendNotificationProcessing"/>.
  13351. </summary>
  13352. <param name="dirtyAllFormulas">Specify true to dirty all formulas so they will all be recalculated.</param>
  13353. <remarks>
  13354. <seealso cref="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.SuspendNotificationProcessing"/>
  13355. </remarks>
  13356. </member>
  13357. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.DirtyAllFormulas">
  13358. <summary>
  13359. Dirties all the formulas so they get recalculated.
  13360. </summary>
  13361. <remarks>
  13362. <p class="body">This method will cause the <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/> to mark all existing formulas as dirty. This means that the next time a calculation operation is performed, all formula will be recalculated. When the calculation occurs depends on the <see cref="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.CalcFrequency"/> property.</p>
  13363. </remarks>
  13364. </member>
  13365. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ReCalc">
  13366. <summary>
  13367. Forces recalculation of all dirtied items in the Calcultion Network.
  13368. </summary>
  13369. <remarks>
  13370. <p class="body">The ReCalc method forces the synchronous recalculation of all formulas in the calculation network.</p>
  13371. <p class="body">When the <see cref="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.CalcFrequency"/> property is set to Manual, no calculations are performed unless this method or the <see cref="M:Infragistics.Win.CalcEngine.IUltraCalcManager.EnsureCalculated(Infragistics.Win.CalcEngine.IUltraCalcReference,System.Boolean)"/> method is called.</p>
  13372. <p class="body">When the <see cref="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.CalcFrequency"/> property is set to Asynchronous, this method can be called to force all calculations to be completed synchronously, so that calculated values can be depended upon to be correct. It is generally more efficient to use the <see cref="M:Infragistics.Win.CalcEngine.IUltraCalcManager.EnsureCalculated(Infragistics.Win.CalcEngine.IUltraCalcReference,System.Boolean)"/> method in this case, since it ensures the calculation of a single reference as opposed to all references in the calculation network.</p>
  13373. <p class="body">When the <see cref="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.CalcFrequency"/> property is set to Synchronous, this method is usually not neccessary, unless a control in the calculation network that is being used as the source of a calcatulion does not have a event for the property being used as its <see cref="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.PropertyName"/> In this case, it is generally more efficient to use <see cref="M:Infragistics.Win.CalcEngine.IUltraCalcManager.EnsureCalculated(Infragistics.Win.CalcEngine.IUltraCalcReference,System.Boolean)"/> instead of ReCalc.</p>
  13374. </remarks>
  13375. <returns>Returns a boolean indicating if anything in the Calculation Network is dirty. This should always return false.</returns>
  13376. </member>
  13377. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ReCalc(System.Int64)">
  13378. <summary>
  13379. Forces recalculation of all dirtied items in the Calculation Network.
  13380. </summary>
  13381. <param name="millis">Number of milliseconds to allow for calculations before control returns to the caller (to wait indefinitely, specify -1.)</param>
  13382. <returns>Returns a boolean indicating if anything in the calculation network remains dirty.</returns>
  13383. <remarks>
  13384. <p class="body">Developers can use this method to limit the amount of time in the time slice _CALCMANAGER_ spends
  13385. performing it's calculations. If all calculations have been completed before this time interval elapses, control
  13386. returns immediately to the caller. Setting this interval too small can lead to excessive task-switching that
  13387. would make the calculation complete more slowly than it ordinarily would have completed, therefore developers
  13388. are advised to allot as much time as the user-responsiveness of the application permits.</p>
  13389. <seealso cref="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ReCalc"/>
  13390. </remarks>
  13391. <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the value supplied for <i>millis</i>
  13392. is either less than -1, or too great to convert into a number of clock ticks. The precise upper bound
  13393. of <i>millis</i> may vary depending upon the granularity of the machine's hardware clock, but it exceeds
  13394. any amount of time which would be a sensible argument (instead, use -1 to indicate an indefinite wait).
  13395. </exception>
  13396. </member>
  13397. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.RegisterUserDefinedFunctionLibrary(System.Reflection.Assembly)">
  13398. <summary>
  13399. Registers an assembly containing <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunction"/> derived types.
  13400. </summary>
  13401. <param name="assembly">Loaded assembly to register</param>
  13402. <returns>Returns true if the assembly was registered successfully, else false if the registration failed</returns>
  13403. <remarks>
  13404. <p class="body">
  13405. All types within the registered assembly are enumerated and any that derive from <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunction"/> class are added to the list of available formula functions
  13406. </p>
  13407. </remarks>
  13408. </member>
  13409. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.RegisterUserDefinedFunction(Infragistics.Win.CalcEngine.UltraCalcFunction)">
  13410. <summary>
  13411. Registers a single <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunction"/> instance.
  13412. </summary>
  13413. <param name="userDefinedFunction">User defined function instance to register</param>
  13414. <returns>Returns true if the type was registered successfully, else false if the registration failed</returns>
  13415. <remarks>
  13416. <p class="body">
  13417. Users can build custom functions used in formulas by sub-classing the <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunction"/> class.
  13418. Once the derived class is instaniated it must be registered by using the <b>AddFunction</b> method before being avilable and referenced by a formulas.
  13419. Users can build a library of functions packaged in an assembly and register all the functions within the assembly by using the <b>AddFunctionLibrary</b> method.
  13420. </p>
  13421. </remarks>
  13422. </member>
  13423. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.NotifyValueChanged(System.Windows.Forms.Control)">
  13424. <summary>
  13425. Notifies the CalcManager that the value of a control that is used in a formula has changed.
  13426. </summary>
  13427. <remarks>
  13428. <p class="body">This method allows the programmer to manually mark the CalcSettings of a control dirty. This is usually not necessary, depending on the <see cref="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.PropertyName"/> property.
  13429. If the property being used has a corresponding PropertyChanged event, then the UltraCalcManager will automatically hook into this property changed notification. Likewise, if the control is being used as the target of a formula, and not the source, this notification is unneccessary.
  13430. For example, if the PropertyName is "Text", UltraCalcManager will hook the "TextChanged" event. If no such event exists on the control, then the CalcManager cannot detect a change in the Text of the control. In that case, the program will need to call NotifyValueChanged whenever the Text of the control is dirtied.</p>
  13431. </remarks>
  13432. <param name="control">The control whose value has changed.</param>
  13433. </member>
  13434. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.Calculate(System.String)">
  13435. <summary>
  13436. Calculates the specified formula and returns the value.
  13437. </summary>
  13438. <remarks>
  13439. <p class="body">The Calculate method allows you to calculate a formula once without creating a <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/>.</p>
  13440. <p class="body">This method does not ensure that any dependants of the specified formula are calculated. When using a <see cref="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.CalcFrequency"/> of <b>Asynchronous</b>, you should call the <see cref="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ReCalc"/> method before calling this method.</p>
  13441. <p class="body">This method throws an exception if the formula has a syntax error. Any other kind of error is returned as an instance of <see cref="T:Infragistics.Win.CalcEngine.UltraCalcValue"/> that represents the error that occurred.</p>
  13442. </remarks>
  13443. <param name="formula">Formula to calculate.</param>
  13444. <returns>The result of the formula.</returns>
  13445. </member>
  13446. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.OnSubObjectPropChanged(Infragistics.Shared.PropChangeInfo)">
  13447. <summary>
  13448. Invoked when a property on a sub object has changed.
  13449. </summary>
  13450. </member>
  13451. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.IsValidReferenceName(System.String)">
  13452. <summary>
  13453. Validates the Reference name for invalid characters
  13454. </summary>
  13455. </member>
  13456. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.OnCalculationsCompleted(System.EventArgs)">
  13457. <summary>
  13458. Fires the <see cref="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.CalculationsCompleted"/> event.
  13459. </summary>
  13460. <param name="e">The event args.</param>
  13461. </member>
  13462. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.OnValueDirtied(Infragistics.Win.UltraWinCalcManager.ValueDirtiedEventArgs)">
  13463. <summary>
  13464. Fires the <see cref="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ValueDirtied"/> event.
  13465. </summary>
  13466. <param name="e">The event args.</param>
  13467. </member>
  13468. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.OnParseValue(Infragistics.Win.UltraWinCalcManager.ParseValueEventArgs)">
  13469. <summary>
  13470. Fires the <see cref="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ParseValue"/> event.
  13471. </summary>
  13472. <param name="e">The event args.</param>
  13473. </member>
  13474. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.OnFormatValue(Infragistics.Win.UltraWinCalcManager.FormatValueEventArgs)">
  13475. <summary>
  13476. Fires the <see cref="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.FormatValue"/> event.
  13477. </summary>
  13478. <param name="e">The event args.</param>
  13479. </member>
  13480. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.OnNamedReferenceResultChanged(Infragistics.Win.UltraWinCalcManager.NamedReferenceResultChangedEventArgs)">
  13481. <summary>
  13482. Fires the <see cref="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.NamedReferenceResultChanged"/> event.
  13483. </summary>
  13484. <param name="e">The event args.</param>
  13485. </member>
  13486. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.OnFormulaSyntaxError(Infragistics.Win.UltraWinCalcManager.FormulaSyntaxErrorEventArgs)">
  13487. <summary>
  13488. Fires the <see cref="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.FormulaSyntaxError"/> event.
  13489. </summary>
  13490. <param name="e">The event args.</param>
  13491. </member>
  13492. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.OnFormulaCircularityError(Infragistics.Win.UltraWinCalcManager.FormulaCircularityErrorEventArgs)">
  13493. <summary>
  13494. Fires the <see cref="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.FormulaCircularityError"/> event.
  13495. </summary>
  13496. <param name="e">The event args.</param>
  13497. </member>
  13498. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.OnFormulaReferenceError(Infragistics.Win.CalcEngine.FormulaCalculationErrorEventArgs)">
  13499. <summary>
  13500. Fires the <see cref="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.FormulaReferenceError"/> event.
  13501. </summary>
  13502. <param name="e">The event args.</param>
  13503. </member>
  13504. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.OnFormulaCalculationError(Infragistics.Win.CalcEngine.FormulaCalculationErrorEventArgs)">
  13505. <summary>
  13506. Fires the <see cref="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.FormulaCalculationError"/> event.
  13507. </summary>
  13508. <param name="e">The event args.</param>
  13509. </member>
  13510. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.OnCalcEngineDirtyValue(Infragistics.Win.CalcEngine.UltraCalcReferenceEventArgs)">
  13511. <summary>
  13512. Fires the <see cref="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ValueDirtied"/> event.
  13513. </summary>
  13514. <param name="e">The event args.</param>
  13515. </member>
  13516. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.OnCalcEngineRecalcValue(Infragistics.Win.CalcEngine.UltraCalcReferenceEventArgs)">
  13517. <summary>
  13518. Fires the <see cref="E:Infragistics.Win.CalcEngine.IUltraCalcManager.CalcEngineRecalcValue"/> event.
  13519. </summary>
  13520. <param name="e">The event args.</param>
  13521. </member>
  13522. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.System#ComponentModel#IExtenderProvider#CanExtend(System.Object)">
  13523. <summary>
  13524. Indicates which controls can have a CalcSettings extender property.
  13525. </summary>
  13526. <param name="extendee">Object to check if it can be extended.</param>
  13527. <returns>True if the control can have a CalcSettings property.</returns>
  13528. </member>
  13529. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.GetCalcSettings(System.Windows.Forms.Control)">
  13530. <summary>
  13531. Gets the <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> for the specified control.
  13532. </summary>
  13533. <remarks>
  13534. <p class="body">Use this method to get the <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> for a particular control. If a <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> for the control already exists in the calculation network, then it will be returned. If it does not exist, a new <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> object will be created for the control and added into the calculation network.</p>
  13535. <p class="body">In order for any control to be part of the calculation network, the <see cref="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.PropertyName"/> property must be set.</p>
  13536. </remarks>
  13537. <param name="control">The control for which to obtain the CalcSettings setting.</param>
  13538. <returns>The <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> object for the specified control.</returns>
  13539. </member>
  13540. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.SetCalcSettings(System.Windows.Forms.Control,Infragistics.Win.UltraWinCalcManager.CalcSettings)">
  13541. <summary>
  13542. This sets the <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> extender property for the specified control.
  13543. </summary>
  13544. <remarks>
  13545. <p class="body">This method associates a <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> object with a particular control and adds it to the calculation network. If there is already an existing <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> associated with the specified control, then the existing <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> is removed from the calculation network and replaced by the new <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/>.</p>
  13546. </remarks>
  13547. <param name="control">The control whose <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> property is being set.</param>
  13548. <param name="calcSettings">A <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> object which will be associated with the control.</param>
  13549. </member>
  13550. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ShouldSerializeCalcSettings(System.Windows.Forms.Control)">
  13551. <summary>
  13552. Indicates whether the <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> property contains data that needs to be serialized.
  13553. </summary>
  13554. <returns>Returns true if the <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> property needs to be serialized.</returns>
  13555. <remarks>
  13556. <p class="body">Use this method to determine if a <b>CalcSettings</b> object has been created and contains data that needs to be serialized.</p>
  13557. </remarks>
  13558. <param name="control">The control whose <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> are being queried.</param>
  13559. </member>
  13560. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ResetCalcSettings(System.Windows.Forms.Control)">
  13561. <summary>
  13562. Resets the <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> of the passed in control.
  13563. </summary>
  13564. <remarks>
  13565. <p class="body">This method resets the <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> of a particular control. If the control does not have a <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> object in the calculation network, then this method does nothing.</p>
  13566. </remarks>
  13567. <param name="control">The control whose <see cref="T:Infragistics.Win.UltraWinCalcManager.CalcSettings"/> will be reset.</param>
  13568. </member>
  13569. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.Infragistics#Win#CalcEngine#IUltraCalcManager#EnsureCalculated(Infragistics.Win.CalcEngine.IUltraCalcReference,System.Boolean)">
  13570. <summary>
  13571. Checks to see if a reference is dirty, and optionally waits for it to be recalculated
  13572. </summary>
  13573. <param name="reference">Reference whose dirty state is requested</param>
  13574. <param name="wait">Denotes whether caller wants to wait until the reference is recalculated</param>
  13575. <returns>True if the reference is dirty</returns>
  13576. </member>
  13577. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.Infragistics#Win#UltraWinCalcManager#FormulaBuilder#IFormulaBuilderInfo#GetReferenceTree">
  13578. <summary>
  13579. Returns a reference tree for use in the Designer
  13580. </summary>
  13581. <remarks>This property is for internal infrastrucure only and should not be used.</remarks>
  13582. </member>
  13583. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.Infragistics#Win#UltraWinCalcManager#FormulaBuilder#IFormulaBuilderInfo#GetUltraCalcReference(Infragistics.Win.UltraWinCalcManager.NamedReference)">
  13584. <summary>
  13585. Returns the IUltraCalcReference associated with a NamedReferences to the Designer.
  13586. </summary>
  13587. <remarks>This method is for internal infrastrucure only and should not be used.</remarks>
  13588. </member>
  13589. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.Infragistics#Win#UltraWinCalcManager#FormulaBuilder#IFormulaBuilderInfo#GetUltraCalcReference(Infragistics.Win.UltraWinCalcManager.CalcSettings)">
  13590. <summary>
  13591. Returns the IUltraCalcReference associated with a NamedReferences to the Designer.
  13592. </summary>
  13593. <remarks>This method is for internal infrastrucure only and should not be used.</remarks>
  13594. </member>
  13595. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.Infragistics#Win#UltraWinCalcManager#FormulaBuilder#IFormulaBuilderInfo#GetUniqueFunctionCategories">
  13596. <summary>
  13597. Returns a list of categories based on all known functions both built-in and user-defined.
  13598. </summary>
  13599. <remarks>This method is for internal infrastrucure only and should not be used.</remarks>
  13600. </member>
  13601. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.Infragistics#Win#UltraWinCalcManager#FormulaBuilder#IFormulaBuilderInfo#GetAllFunctions">
  13602. <summary>
  13603. Returns the UltraCalcFunctions for all categories
  13604. </summary>
  13605. <remarks>This method is for internal infrastrucure only and should not be used.</remarks>
  13606. </member>
  13607. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.Infragistics#Win#UltraWinCalcManager#FormulaBuilder#IFormulaBuilderInfo#GetUnassignedFunctions">
  13608. <summary>
  13609. Returns the UltraCalcFunctions for unassigned functions (functions which have no category).
  13610. </summary>
  13611. <remarks>This method is for internal infrastrucure only and should not be used.</remarks>
  13612. </member>
  13613. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.Infragistics#Win#UltraWinCalcManager#FormulaBuilder#IFormulaBuilderInfo#GetFunctions(System.String)">
  13614. <summary>
  13615. Returns the UltraCalcFunctions for the specified category
  13616. </summary>
  13617. <remarks>This method is for internal infrastrucure only and should not be used.</remarks>
  13618. </member>
  13619. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.GetColumnCalcSettings(System.Windows.Forms.DataGridViewColumn)">
  13620. <summary>
  13621. Gets the CalcSettings for the specified control.
  13622. </summary>
  13623. <param name="column">The DataGridViewColumn for which to obtain the CalcSettings setting.</param>
  13624. <returns>The DataGridViewColumnCalcSettings associated with the column.</returns>
  13625. </member>
  13626. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.SetColumnCalcSettings(System.Windows.Forms.DataGridViewColumn,Infragistics.Win.UltraWinCalcManager.DataGridViewColumnCalcSettings)">
  13627. <summary>
  13628. This sets the CalcSettings extender property for the specified DataGridViewColumn.
  13629. </summary>
  13630. <param name="column">The DataGridViewColumn whose CalcSettings property is being set.</param>
  13631. <param name="calcSettings">The column settings to assign to the column.</param>
  13632. </member>
  13633. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ShouldSerializeColumnCalcSettings(System.Windows.Forms.DataGridViewColumn)">
  13634. <summary>
  13635. Indicates whether the <see cref="T:Infragistics.Win.UltraWinCalcManager.DataGridViewColumnCalcSettings"/> property contains data that needs to be serialized.
  13636. </summary>
  13637. <returns>Returns true if the <see cref="T:Infragistics.Win.UltraWinCalcManager.DataGridViewColumnCalcSettings"/> property needs to be serialized.</returns>
  13638. <remarks>
  13639. <p class="body">Use this method to determine if a <b>DataGridViewColumnCalcSettings</b> object has been created and contains data that needs to be serialized.</p>
  13640. </remarks>
  13641. <returns>Returns true if this property is not set to its default value</returns>
  13642. </member>
  13643. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ResetDataGridViewCalcSettings(System.Windows.Forms.DataGridViewColumn)">
  13644. Resets the DataGridViewColumnCalcSettings of the passed in column.
  13645. </member>
  13646. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.GetUseInCalcManager(System.Windows.Forms.DataGridView)">
  13647. <summary>
  13648. Gets the CalcSettings for the specified control.
  13649. </summary>
  13650. <param name="grid">The Grid whose UseInCalcManager property will be returned.</param>
  13651. <returns>A bool indicating whether the grid will participate in the calculation network of the CalcManager.</returns>
  13652. </member>
  13653. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.SetUseInCalcManager(System.Windows.Forms.DataGridView,System.Boolean)">
  13654. <summary>
  13655. This sets the UseInCalcManager extender property for the specified DataGridView.
  13656. </summary>
  13657. <param name="grid">The DataGridView whose UseInCalcManager extender property is being set.</param>
  13658. <param name="useInCalcManager">A setting of true will add the grid into the calculation network of the CalcManager so that columns can be used as the source or target of formulas. A setting of false indicates that the grid will not participate in the calculation network. It will not appear in the FormulaBuilder and any formulas that reference it's columns will return an error.</param>
  13659. </member>
  13660. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ShouldSerializeUseInCalcManager(System.Windows.Forms.DataGridView)">
  13661. <summary>
  13662. Indicates whether the UseInCalcManager extender property should be serialized.
  13663. </summary>
  13664. <param name="grid">The grid for which the UseInCalcManager extender property is being checked.</param>
  13665. <returns>Returns true if the UseInCalcManager extender property needs to be serialized.</returns>
  13666. </member>
  13667. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ResetDataGridViewCalcSettings(System.Windows.Forms.DataGridView)">
  13668. <summary>
  13669. Resets all CalcSettings for every column in the grid.
  13670. </summary>
  13671. <param name="grid">The grid whose column CalcSettings will be reset</param>
  13672. </member>
  13673. <member name="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.NamedReferences">
  13674. <summary>
  13675. A collection of NamedReferences
  13676. </summary>
  13677. <remarks>
  13678. <p class="body">NamedReferences are useful for creating formulas or constants that are used in other calculations but which will not be displayed to the user.</p>
  13679. </remarks>
  13680. </member>
  13681. <member name="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ContainingControl">
  13682. <summary>
  13683. Returns the Form or UserControl that this CalcManager component is servicing.
  13684. </summary>
  13685. </member>
  13686. <member name="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.CalcFrequency">
  13687. <summary>
  13688. Gets/sets the frequency with which the <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/> automatically performs calculations.
  13689. </summary>
  13690. <remarks>
  13691. <p class="body">The CalcFrequency property determines when calculations are performed. They can be performed asynchronously on a timer, synchronously every time a value changes, or manually only when the <see cref="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ReCalc"/> method is explicitly called in code.</p>
  13692. <p class="body">By default, calculations are done <b>Asynchronously</b> on a timer. This ensures that the UI thread is not locked up when long or complex calculations are performed. The disadvantage to this mode is that a particular value may not be calculated when it is requested in code. When retrieving a calculated value using Asynchronous mode, you should call the <see cref="M:Infragistics.Win.CalcEngine.IUltraCalcManager.EnsureCalculated(Infragistics.Win.CalcEngine.IUltraCalcReference,System.Boolean)"/> method to ensure the value has been calculated.</p>
  13693. <p class="body"><b>Synchronous</b> mode will updated all calculations immediately any time a source value of a calculation changes. Unlike Asynchronous mode, values can always be depended upon to be calculated when asked for. The disadvantage of this mode is that long or complex calculations may lock the UI thread until they are complete.</p>
  13694. <p class="body">In <b>Manual</b> mode, no calculations are performed by the <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/> until the code explicitly calls a method to do so, such as <see cref="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ReCalc"/> or <see cref="M:Infragistics.Win.CalcEngine.IUltraCalcManager.EnsureCalculated(Infragistics.Win.CalcEngine.IUltraCalcReference,System.Boolean)"/>. This allows you complete control over when calculations take place.</p>
  13695. </remarks>
  13696. <seealso cref="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.AsynchronousCalcDuration"/>
  13697. <seealso cref="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.AsynchronousCalcInterval"/>
  13698. </member>
  13699. <member name="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.EventManager">
  13700. <summary>
  13701. The object that enables, disables and controls firing of specific control events.
  13702. </summary>
  13703. <remarks>
  13704. <p class="body">The <b>EventManager</b> gives you a high degree of control over how the component invokes event procedures. You can use it to selectively enable and disable event procedures depending on the context of your application. You can also use the event manager to return information about the state of the component's events.</p>
  13705. <p class="body">The event manager's methods are used to determine the enabled state of an event (<see cref="M:Infragistics.Win.UltraWinCalcManager.CalcManagerEventManager.IsEnabled(Infragistics.Win.UltraWinCalcManager.CalcManagerEventIds)"/>), to selectively enable or disable events (<see cref="M:Infragistics.Win.UltraWinCalcManager.CalcManagerEventManager.SetEnabled(Infragistics.Win.UltraWinCalcManager.CalcManagerEventIds,System.Boolean)"/>), and to tell whether an event procedure is currently being processed (<see cref="M:Infragistics.Win.UltraWinCalcManager.CalcManagerEventManager.InProgress(Infragistics.Win.UltraWinCalcManager.CalcManagerEventIds)"/>). There is also an <seealso cref="P:Infragistics.Shared.EventManagerBase.AllEventsEnabled"/> property that you can check to quickly determine whether any events have been disabled by the event manager.</p>
  13706. </remarks>
  13707. </member>
  13708. <member name="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ErrorIconAlignment">
  13709. <summary>
  13710. Gets/sets where to place the ErrorProvider icon when a Calculation or Reference error occurs on a formula.
  13711. </summary>
  13712. <remarks>
  13713. <p class="body">When a Calculation or Reference error occurs during the evaluation of a formula, The UltraCalcManager will display an ErrorProvider Icon adjacent to the target control. ErrorIconAlignment determines the location of the icon. When set to <b>Default</b>, <b>MiddleRight</b> is used. This setting can be overridden on any individual control by setting the <see cref="P:Infragistics.Win.UltraWinCalcManager.CalcSettings.ErrorIconAlignment"/> property. To turn off displaying ErrorProvider icons, use the <b>None</b> value.</p>
  13714. </remarks>
  13715. </member>
  13716. <member name="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ErrorIcon">
  13717. <summary>
  13718. The Error Icon to display when a Calculation or Reference error occurs on a control.
  13719. </summary>
  13720. <remarks><p class="body">The display of the icon varies depending on the context. A control on a form will show the icon as part of an ErrorProvider. NamedReferences show no icons. UltraWinGrid will not show the icon.</p></remarks>
  13721. </member>
  13722. <member name="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.AsynchronousCalcDuration">
  13723. <summary>
  13724. The duration in milliseconds that the CalcManager will use to perform calculations each time the AsynchronousCalculationInterval passes.
  13725. </summary>
  13726. <remarks><p class="body">This property only applies when <see cref="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.CalcFrequency"/> is set to <b>Asynchronous</b>.</p></remarks>
  13727. <remarks><p class="body">AsynchronousCalcDuration determines how much time is used by the CalcManager to perform pending calculations. Each time the interval specified by <see cref="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.AsynchronousCalcInterval"/> passes, the CalcManager will begin performing any neccessary calculations. If there are still calculations pending when the time expires, then some calculations will be left in a dirty state until the next time ReCalc is called or the Interval passes again.</p></remarks>
  13728. <remarks><p class="body">To force all calculations to be completed each time the Interval passes, set this property to -1.</p></remarks>
  13729. </member>
  13730. <member name="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.AsynchronousCalcInterval">
  13731. <summary>
  13732. The interval in milliseconds that the CalcManager will wait between performing calculations.
  13733. </summary>
  13734. <remarks><p class="body">This property only applies when <see cref="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.CalcFrequency"/> is set to <b>Asynchronous</b>.</p></remarks>
  13735. <remarks><p class="body">AsynchronousCalcInterval determines how much time elapses between calculations. Each time the Interval passes the CalcManager will perform pending calculations for a period of time specified by <see cref="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.AsynchronousCalcDuration"/>.</p></remarks>
  13736. </member>
  13737. <member name="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.DeferredCalculationsEnabled">
  13738. <summary>
  13739. Gets / Sets whether certain calculations can be deferred to optimize calculation of visible objects.
  13740. </summary>
  13741. <remarks>
  13742. <p class="body">When true, certain calculations will be deffered if they are not visible. This is mainly used for iterated calculations, such as UltraGrid cells. If possible, cells that are in view will be calculated before cells that are out of view. </p>
  13743. <p class="note">Note that in some cases, deferring calcalations is not possible. For example, if there is a Summary on a column, then all the values in the column must be calculated before the summary can be calculated.</p>
  13744. </remarks>
  13745. </member>
  13746. <member name="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.UseExcelFormulaCompatibility">
  13747. <summary>
  13748. Determines if formula calculations are done in a way that is compatible with Microsoft Excel.
  13749. </summary>
  13750. <remarks>
  13751. <para class="body">Set this property to true to make the CalcManager perform calculations in a way that is compatible with Microsoft Excel. By default, CalcManager calculations are performed using DotNet standards and functions. Setting this property to true will make the CalcManager's results closer to those in Excel.</para>
  13752. </remarks>
  13753. </member>
  13754. <member name="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.SubObjectPropChangeHandler">
  13755. <summary>
  13756. Handler for a SubObjectPropChange event
  13757. </summary>
  13758. </member>
  13759. <member name="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.Site">
  13760. <summary>
  13761. The component's site (set at design time only).
  13762. </summary>
  13763. </member>
  13764. <member name="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.CalculationsCompleted">
  13765. <summary>
  13766. Fired after all calculations are complete.
  13767. </summary>
  13768. <remarks>
  13769. <p class="body"><b>CalculationsCompleted</b> event is fired when all calculations are completed. In Asynchronous mode, this even will fire only when all calculations have been computed and no references are dirty.</p>
  13770. </remarks>
  13771. </member>
  13772. <member name="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ValueDirtied">
  13773. <summary>
  13774. Fired any time a value referenced by a Formula is dirtied.
  13775. </summary>
  13776. <remarks>
  13777. <p class="body"><b>ValueDirtied</b> event is fired any time a value that is being used in a calculation is dirtied (changed). This even can be used in conjunction with a CalcFrequency setting of Manual to determine when to there are dirty calculations to be ReCalced.</p>
  13778. </remarks>
  13779. </member>
  13780. <member name="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.FormulaSyntaxError">
  13781. <summary>
  13782. Fired when parsing the formula expression fails because the expression contains typographical errors or uses operators incorrectly.
  13783. </summary>
  13784. <remarks>
  13785. <p class="body">This event fires any time the <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/> attempts to calculate a formula that is syntactically invalid.</p>
  13786. </remarks>
  13787. </member>
  13788. <member name="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.FormulaCircularityError">
  13789. <summary>
  13790. Fired any time a formula attempts to reference itself either directly or indirectly.
  13791. </summary>
  13792. <remarks>
  13793. <p class="body"><b>FormulaCircularityError</b> is fired any time a formula attempts to reference itself either directly or indirectly.</p>
  13794. <p class="body">Circular references cannot be resolved by the UltraCalcmanager and so no calculations involving circular references will be performed.</p>
  13795. </remarks>
  13796. </member>
  13797. <member name="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.FormulaReferenceError">
  13798. <summary>
  13799. Fired when calculating the formula involves referencing an object that could not be found.
  13800. </summary>
  13801. <remarks>
  13802. <p class="body">This event fires whenever the <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/> attemps to calculate a formula which refers to a reference that cannot be found in the calculation network.</p>
  13803. </remarks>
  13804. </member>
  13805. <member name="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.FormulaCalculationError">
  13806. <summary>
  13807. Fired any time the attempt to calculate a formula results in an error.
  13808. </summary>
  13809. <remarks>
  13810. <p class="body"><b>FormulaCalculationError</b> event is fired any time the attempt to calcuate a formula results in an error, whether it be a reference, syntax, or mathematical error..</p>
  13811. </remarks>
  13812. </member>
  13813. <member name="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.ParseValue">
  13814. <summary>
  13815. Fired when a CalcSetting retrieves a value from a control
  13816. </summary>
  13817. <remarks>
  13818. <p class="body"><b>ParseValue</b> event is fired any time a CalcSettings retrieves a value from a control. The Value can then be modified by before it passed back to the CalcManager for the purposes of formatting, type conversion, etc.</p>
  13819. <p class="note">Note that if a control is both the source and target of a formula, the ParseValue event will not fire because the CalcManager does not retrive the value from the control. Instead, the CalcManager uses the calculated result of the formula. This means that a control that is being used as both source and target can safely be Formatted using the <see cref="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.FormatValue"/> event without the need to reverse the formatting.</p>
  13820. </remarks>
  13821. </member>
  13822. <member name="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.FormatValue">
  13823. <summary>
  13824. Fired before a CalcSettings sets a value on a control
  13825. </summary>
  13826. <remarks>
  13827. <p class="body"><b>FormatValue</b> event is fired any time a CalcSettings is about to set a value on a control. The Value can then be modified by before it is assigned to the control for the purposes of formatting, type conversion, etc.</p>
  13828. </remarks>
  13829. </member>
  13830. <member name="E:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.NamedReferenceResultChanged">
  13831. <summary>
  13832. Fired after a <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> value has changed.
  13833. </summary>
  13834. <remarks>
  13835. <p class="body">This event fires any time the result of a <see cref="T:Infragistics.Win.UltraWinCalcManager.NamedReference"/> changes.</p>
  13836. </remarks>
  13837. </member>
  13838. <member name="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManager.About">
  13839. <summary>
  13840. Display the about dialog
  13841. </summary>
  13842. </member>
  13843. <member name="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManagerDesigner">
  13844. <summary>
  13845. The designer class for the <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/> component.
  13846. </summary>
  13847. <remarks>
  13848. <p class="body">For Internal use only.</p>
  13849. <p class="body">This class handles various design-time maintanence tasks such as trapping for when controls in the calculation network are removed or their names are changed.</p>
  13850. </remarks>
  13851. </member>
  13852. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManagerDesigner.Initialize(System.ComponentModel.IComponent)">
  13853. <summary>
  13854. Initializes the Designer
  13855. </summary>
  13856. <param name="component">The component being designed.</param>
  13857. </member>
  13858. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManagerDesigner.Dispose(System.Boolean)">
  13859. <summary>
  13860. Clean up any resources being used.
  13861. </summary>
  13862. <param name="disposing"><b>true</b> to release both managed and unmanaged resources; <b>false</b> to release only unmanaged resources.</param>
  13863. </member>
  13864. <member name="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManagerDesigner.ActionLists">
  13865. <summary>
  13866. Gets the <see cref="T:System.ComponentModel.Design.DesignerActionListCollection"/> for this designer's control/component.
  13867. </summary>
  13868. </member>
  13869. <member name="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManagerDesigner.UltraCalcManagerActionList">
  13870. <summary>
  13871. Provides DesignerActionItems for the SmartTag associated with the UltraCalcManager.
  13872. </summary>
  13873. </member>
  13874. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManagerDesigner.UltraCalcManagerActionList.#ctor(Infragistics.Win.UltraWinCalcManager.UltraCalcManager)">
  13875. <summary>
  13876. Constructor
  13877. </summary>
  13878. <param name="product">The UltraCalcManager component.</param>
  13879. </member>
  13880. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManagerDesigner.UltraCalcManagerActionList.CreateActionItems(System.ComponentModel.Design.DesignerActionItemCollection)">
  13881. <summary>
  13882. Overrides CreateActionItems.
  13883. </summary>
  13884. <param name="actionItems">The list to populate.</param>
  13885. </member>
  13886. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcManagerDesigner.UltraCalcManagerActionList.EditNamedReferences">
  13887. <summary>
  13888. Used by SmartTag Panel.
  13889. </summary>
  13890. </member>
  13891. <member name="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManagerDesigner.UltraCalcManagerActionList.CalcFrequency">
  13892. <summary>
  13893. Used by SmartTag Panel.
  13894. </summary>
  13895. </member>
  13896. <member name="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManagerDesigner.UltraCalcManagerActionList.ErrorIcon">
  13897. <summary>
  13898. Used by SmartTag Panel.
  13899. </summary>
  13900. </member>
  13901. <member name="P:Infragistics.Win.UltraWinCalcManager.UltraCalcManagerDesigner.UltraCalcManagerActionList.ErrorIconAlignment">
  13902. <summary>
  13903. Used by SmartTag Panel.
  13904. </summary>
  13905. </member>
  13906. <member name="T:Infragistics.Win.UltraWinCalcManager.CalcSettingsReferenceProxy">
  13907. <summary>
  13908. Summary description for CalcSettingsReferenceProxy.
  13909. </summary>
  13910. </member>
  13911. <member name="T:Infragistics.Win.UltraWinCalcManager.UltraCalcReferenceProxyBase">
  13912. <summary>
  13913. Summary description for UltraCalcReferenceProxy.
  13914. </summary>
  13915. </member>
  13916. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcReferenceProxyBase.FindAll(System.String)">
  13917. <summary>
  13918. Returns the named reference relative to this reference with scope "All".
  13919. </summary>
  13920. <param name="name">The element name.</param>
  13921. <returns>The referenced element</returns>
  13922. <see cref="M:Infragistics.Win.UltraWinCalcManager.UltraCalcReferenceProxyBase.BuildReference(Infragistics.Win.CalcEngine.RefParser,System.Boolean)"/>
  13923. </member>
  13924. <member name="T:Infragistics.Win.UltraWinCalcManager.UltraCalcNamedReferenceProxy">
  13925. <summary>
  13926. Summary description for UltraCalcNamedReferenceProxy.
  13927. </summary>
  13928. </member>
  13929. <member name="T:Infragistics.Win.UltraWinCalcManager.UltraCalcUserDefinedLibraryBase">
  13930. <summary>
  13931. Used as a base class for a component that registers all user defined function
  13932. in an assembly.
  13933. </summary>
  13934. <remarks>
  13935. Placing an instance of a class derived from this class on a form with an <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/> component
  13936. on it will cause all functions derived from <see cref="T:Infragistics.Win.CalcEngine.UltraCalcFunction"/>
  13937. in the same assmbly to be registered with that calc manager. The registration happens automaticlly at both design and run time.
  13938. </remarks>
  13939. </member>
  13940. <member name="M:Infragistics.Win.UltraWinCalcManager.UltraCalcUserDefinedLibraryBase.#ctor">
  13941. <summary>
  13942. Constructor
  13943. </summary>
  13944. </member>
  13945. <member name="P:Infragistics.Win.UltraWinCalcManager.UltraCalcUserDefinedLibraryBase.CalcManager">
  13946. <summary>
  13947. Gets/sets the <see cref="T:Infragistics.Win.UltraWinCalcManager.UltraCalcManager"/>
  13948. </summary>
  13949. <remarks>
  13950. Setting this property will register user-defined functions in this assembly with the calc manager.
  13951. </remarks>
  13952. </member>
  13953. <member name="P:Infragistics.Win.UltraWinCalcManager.UltraCalcUserDefinedLibraryBase.ConcreteCalcManager">
  13954. <summary>
  13955. Returns the CalcManager as a typed UltraCalcManager instead of an IUltraCalcManager
  13956. </summary>
  13957. </member>
  13958. <member name="T:Infragistics.Win.UltraWinCalcManager.UltraRefParser">
  13959. <summary>
  13960. Summary description for UltraRefParser.
  13961. </summary>
  13962. </member>
  13963. </members>
  13964. </doc>