NPOI.Core.xml 2.3 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>NPOI.Core</name>
  5. </assembly>
  6. <members>
  7. <member name="T:NPOI.DDF.AbstractEscherOptRecord">
  8. Common abstract class for {@link EscherOptRecord} and
  9. {@link EscherTertiaryOptRecord}
  10. @author Sergey Vladimirov (vlsergey {at} gmail {dot} com)
  11. @author Glen Stampoultzis
  12. </member>
  13. <member name="M:NPOI.DDF.AbstractEscherOptRecord.AddEscherProperty(NPOI.DDF.EscherProperty)">
  14. Add a property to this record.
  15. </member>
  16. <member name="P:NPOI.DDF.AbstractEscherOptRecord.EscherProperties">
  17. The list of properties stored by this record.
  18. </member>
  19. <member name="M:NPOI.DDF.AbstractEscherOptRecord.GetEscherProperty(System.Int32)">
  20. The list of properties stored by this record.
  21. </member>
  22. <member name="M:NPOI.DDF.AbstractEscherOptRecord.SortProperties">
  23. Records should be sorted by property number before being stored.
  24. </member>
  25. <member name="M:NPOI.DDF.AbstractEscherOptRecord.SetEscherProperty(NPOI.DDF.EscherProperty)">
  26. * Set an escher property. If a property with given propId already
  27. exists it is replaced.
  28. *
  29. * @param value the property to set.
  30. </member>
  31. <member name="M:NPOI.DDF.AbstractEscherOptRecord.ToString">
  32. Retrieve the string representation of this record.
  33. </member>
  34. <member name="T:NPOI.DDF.DefaultEscherRecordFactory">
  35. <summary>
  36. Generates escher records when provided the byte array containing those records.
  37. @author Glen Stampoultzis
  38. @author Nick Burch (nick at torchbox . com)
  39. </summary>
  40. </member>
  41. <member name="M:NPOI.DDF.DefaultEscherRecordFactory.#ctor">
  42. <summary>
  43. Initializes a new instance of the <see cref="T:NPOI.DDF.DefaultEscherRecordFactory"/> class.
  44. </summary>
  45. </member>
  46. <member name="M:NPOI.DDF.DefaultEscherRecordFactory.CreateRecord(System.Byte[],System.Int32)">
  47. <summary>
  48. Generates an escher record including the any children contained under that record.
  49. An exception is thrown if the record could not be generated.
  50. </summary>
  51. <param name="data">The byte array containing the records</param>
  52. <param name="offset">The starting offset into the byte array</param>
  53. <returns>The generated escher record</returns>
  54. </member>
  55. <member name="M:NPOI.DDF.DefaultEscherRecordFactory.RecordsToMap(System.Type[])">
  56. <summary>
  57. Converts from a list of classes into a map that Contains the record id as the key and
  58. the Constructor in the value part of the map. It does this by using reflection to look up
  59. the RECORD_ID field then using reflection again to find a reference to the constructor.
  60. </summary>
  61. <param name="records">The records to convert</param>
  62. <returns>The map containing the id/constructor pairs.</returns>
  63. </member>
  64. <member name="T:NPOI.DDF.EscherArrayProperty">
  65. <summary>
  66. Escher array properties are the most wierd construction ever invented
  67. with all sorts of special cases. I'm hopeful I've got them all.
  68. @author Glen Stampoultzis (glens at superlinksoftware.com)
  69. </summary>
  70. </member>
  71. <member name="F:NPOI.DDF.EscherArrayProperty.FIXED_SIZE">
  72. The size of the header that goes at the
  73. start of the array, before the data
  74. </member>
  75. <member name="F:NPOI.DDF.EscherArrayProperty.sizeIncludesHeaderSize">
  76. Normally, the size recorded in the simple data (for the complex
  77. data) includes the size of the header.
  78. There are a few cases when it doesn't though...
  79. </member>
  80. <member name="F:NPOI.DDF.EscherArrayProperty.emptyComplexPart">
  81. When Reading a property from data stream remeber if the complex part is empty and Set this flag.
  82. </member>
  83. <member name="M:NPOI.DDF.EscherArrayProperty.GetElement(System.Int32)">
  84. <summary>
  85. Gets the element.
  86. </summary>
  87. <param name="index">The index.</param>
  88. <returns></returns>
  89. </member>
  90. <member name="M:NPOI.DDF.EscherArrayProperty.SetElement(System.Int32,System.Byte[])">
  91. <summary>
  92. Sets the element.
  93. </summary>
  94. <param name="index">The index.</param>
  95. <param name="element">The element.</param>
  96. </member>
  97. <member name="M:NPOI.DDF.EscherArrayProperty.ToString">
  98. <summary>
  99. Retrieves the string representation for this property.
  100. </summary>
  101. <returns></returns>
  102. </member>
  103. <member name="M:NPOI.DDF.EscherArrayProperty.SetArrayData(System.Byte[],System.Int32)">
  104. <summary>
  105. We have this method because the way in which arrays in escher works
  106. is screwed for seemly arbitary reasons. While most properties are
  107. fairly consistent and have a predictable array size, escher arrays
  108. have special cases.
  109. </summary>
  110. <param name="data">The data array containing the escher array information</param>
  111. <param name="offset">The offset into the array to start Reading from.</param>
  112. <returns>the number of bytes used by this complex property.</returns>
  113. </member>
  114. <member name="M:NPOI.DDF.EscherArrayProperty.SerializeSimplePart(System.Byte[],System.Int32)">
  115. <summary>
  116. Serializes the simple part of this property. ie the first 6 bytes.
  117. Needs special code to handle the case when the size doesn't
  118. include the size of the header block
  119. </summary>
  120. <param name="data"></param>
  121. <param name="pos"></param>
  122. <returns></returns>
  123. </member>
  124. <member name="M:NPOI.DDF.EscherArrayProperty.GetActualSizeOfElements(System.Int16)">
  125. <summary>
  126. Sometimes the element size is stored as a negative number. We
  127. negate it and shift it to Get the real value.
  128. </summary>
  129. <param name="sizeOfElements">The size of elements.</param>
  130. <returns></returns>
  131. </member>
  132. <member name="T:NPOI.DDF.EscherBitmapBlip">
  133. <summary>
  134. @author Glen Stampoultzis
  135. @version $Id: EscherBitmapBlip.java 569827 2007-08-26 15:26:29Z yegor $
  136. </summary>
  137. </member>
  138. <member name="M:NPOI.DDF.EscherBitmapBlip.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  139. <summary>
  140. This method deSerializes the record from a byte array.
  141. </summary>
  142. <param name="data"> The byte array containing the escher record information</param>
  143. <param name="offset">The starting offset into </param>
  144. <param name="recordFactory">May be null since this is not a container record.</param>
  145. <returns>The number of bytes Read from the byte array.</returns>
  146. </member>
  147. <member name="M:NPOI.DDF.EscherBitmapBlip.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  148. <summary>
  149. Serializes the record to an existing byte array.
  150. </summary>
  151. <param name="offset">the offset within the byte array</param>
  152. <param name="data">the data array to Serialize to</param>
  153. <param name="listener">a listener for begin and end serialization events.</param>
  154. <returns>the number of bytes written.</returns>
  155. </member>
  156. <member name="P:NPOI.DDF.EscherBitmapBlip.RecordSize">
  157. <summary>
  158. Returns the number of bytes that are required to Serialize this record.
  159. </summary>
  160. <value> Number of bytes</value>
  161. </member>
  162. <member name="P:NPOI.DDF.EscherBitmapBlip.UID">
  163. <summary>
  164. Gets or sets the UID.
  165. </summary>
  166. <value>The UID.</value>
  167. </member>
  168. <member name="P:NPOI.DDF.EscherBitmapBlip.Marker">
  169. <summary>
  170. Gets or sets the marker.
  171. </summary>
  172. <value>The marker.</value>
  173. </member>
  174. <member name="M:NPOI.DDF.EscherBitmapBlip.ToString">
  175. <summary>
  176. Toes the string.
  177. </summary>
  178. <returns></returns>
  179. </member>
  180. <member name="T:NPOI.DDF.EscherBlipRecord">
  181. <summary>
  182. @author Glen Stampoultzis
  183. @version $Id: EscherBlipRecord.java 569827 2007-08-26 15:26:29Z yegor $
  184. </summary>
  185. </member>
  186. <member name="M:NPOI.DDF.EscherBlipRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  187. <summary>
  188. This method deSerializes the record from a byte array.
  189. </summary>
  190. <param name="data">The byte array containing the escher record information</param>
  191. <param name="offset">The starting offset into </param>
  192. <param name="recordFactory">May be null since this is not a container record.</param>
  193. <returns>The number of bytes Read from the byte array.</returns>
  194. </member>
  195. <member name="M:NPOI.DDF.EscherBlipRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  196. <summary>
  197. Serializes the record to an existing byte array.
  198. </summary>
  199. <param name="offset"> the offset within the byte array</param>
  200. <param name="data">the data array to Serialize to</param>
  201. <param name="listener">a listener for begin and end serialization events.</param>
  202. <returns>the number of bytes written.</returns>
  203. </member>
  204. <member name="P:NPOI.DDF.EscherBlipRecord.RecordSize">
  205. <summary>
  206. Returns the number of bytes that are required to Serialize this record.
  207. </summary>
  208. <value>Number of bytes</value>
  209. </member>
  210. <member name="P:NPOI.DDF.EscherBlipRecord.RecordName">
  211. <summary>
  212. The short name for this record
  213. </summary>
  214. <value></value>
  215. </member>
  216. <member name="P:NPOI.DDF.EscherBlipRecord.PictureData">
  217. <summary>
  218. Gets or sets the picture data.
  219. </summary>
  220. <value>The picture data.</value>
  221. </member>
  222. <member name="M:NPOI.DDF.EscherBlipRecord.ToString">
  223. <summary>
  224. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  225. </summary>
  226. <returns>
  227. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  228. </returns>
  229. </member>
  230. <member name="T:NPOI.DDF.EscherBlipWMFRecord">
  231. <summary>
  232. The blip record is used to hold details about large binary objects that occur in escher such
  233. as JPEG, GIF, PICT and WMF files. The contents of the stream is usually compressed. Inflate
  234. can be used to decompress the data.
  235. @author Glen Stampoultzis
  236. </summary>
  237. </member>
  238. <member name="M:NPOI.DDF.EscherBlipWMFRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  239. <summary>
  240. This method deserializes the record from a byte array.
  241. </summary>
  242. <param name="data">The byte array containing the escher record information</param>
  243. <param name="offset">The starting offset into</param>
  244. <param name="recordFactory">May be null since this is not a container record.</param>
  245. <returns>
  246. The number of bytes Read from the byte array.
  247. </returns>
  248. </member>
  249. <member name="M:NPOI.DDF.EscherBlipWMFRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  250. <summary>
  251. This method Serializes this escher record into a byte array.
  252. @param offset
  253. </summary>
  254. <param name="offset">The offset into data to start writing the record data to.</param>
  255. <param name="data">the data array to Serialize to</param>
  256. <param name="listener">a listener for begin and end serialization events.</param>
  257. <returns>the number of bytes written.</returns>
  258. </member>
  259. <member name="P:NPOI.DDF.EscherBlipWMFRecord.RecordSize">
  260. <summary>
  261. Returns the number of bytes that are required to Serialize this record.
  262. </summary>
  263. <value>Number of bytes</value>
  264. </member>
  265. <member name="P:NPOI.DDF.EscherBlipWMFRecord.RecordName">
  266. <summary>
  267. The short name for this record
  268. </summary>
  269. <value></value>
  270. </member>
  271. <member name="P:NPOI.DDF.EscherBlipWMFRecord.SecondaryUID">
  272. <summary>
  273. Gets or sets the secondary UID.
  274. </summary>
  275. <value>The secondary UID.</value>
  276. </member>
  277. <member name="P:NPOI.DDF.EscherBlipWMFRecord.CacheOfSize">
  278. <summary>
  279. Gets or sets the size of the cache of.
  280. </summary>
  281. <value>The size of the cache of.</value>
  282. </member>
  283. <member name="P:NPOI.DDF.EscherBlipWMFRecord.BoundaryTop">
  284. <summary>
  285. Gets or sets the top boundary of the metafile drawing commands
  286. </summary>
  287. <value>The boundary top.</value>
  288. </member>
  289. <member name="P:NPOI.DDF.EscherBlipWMFRecord.BoundaryLeft">
  290. <summary>
  291. Gets or sets the left boundary of the metafile drawing commands
  292. </summary>
  293. <value>The boundary left.</value>
  294. </member>
  295. <member name="P:NPOI.DDF.EscherBlipWMFRecord.BoundaryWidth">
  296. <summary>
  297. Gets or sets the boundary width of the metafile drawing commands
  298. </summary>
  299. <value>The width of the boundary.</value>
  300. </member>
  301. <member name="P:NPOI.DDF.EscherBlipWMFRecord.BoundaryHeight">
  302. <summary>
  303. Gets or sets the boundary height of the metafile drawing commands
  304. </summary>
  305. <value>The height of the boundary.</value>
  306. </member>
  307. <member name="P:NPOI.DDF.EscherBlipWMFRecord.Width">
  308. <summary>
  309. Gets or sets the width of the metafile in EMU's (English Metric Units).
  310. </summary>
  311. <value>The width.</value>
  312. </member>
  313. <member name="P:NPOI.DDF.EscherBlipWMFRecord.Height">
  314. <summary>
  315. Gets or sets the height of the metafile in EMU's (English Metric Units).
  316. </summary>
  317. <value>The height.</value>
  318. </member>
  319. <member name="P:NPOI.DDF.EscherBlipWMFRecord.CacheOfSavedSize">
  320. <summary>
  321. Gets or sets the cache of the saved size
  322. </summary>
  323. <value>the cache of the saved size.</value>
  324. </member>
  325. <member name="P:NPOI.DDF.EscherBlipWMFRecord.CompressionFlag">
  326. <summary>
  327. Is the contents of the blip compressed?
  328. </summary>
  329. <value>The compression flag.</value>
  330. </member>
  331. <member name="P:NPOI.DDF.EscherBlipWMFRecord.Filter">
  332. <summary>
  333. Gets or sets the filter.
  334. </summary>
  335. <value>The filter.</value>
  336. </member>
  337. <member name="P:NPOI.DDF.EscherBlipWMFRecord.Data">
  338. <summary>
  339. Gets or sets The BLIP data
  340. </summary>
  341. <value>The data.</value>
  342. </member>
  343. <member name="M:NPOI.DDF.EscherBlipWMFRecord.ToString">
  344. <summary>
  345. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  346. </summary>
  347. <returns>
  348. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  349. </returns>
  350. </member>
  351. <member name="M:NPOI.DDF.EscherBlipWMFRecord.Compress(System.Byte[])">
  352. <summary>
  353. Compress the contents of the provided array
  354. </summary>
  355. <param name="data">An uncompressed byte array</param>
  356. <returns></returns>
  357. </member>
  358. <member name="M:NPOI.DDF.EscherBlipWMFRecord.Decompress(System.Byte[],System.Int32,System.Int32)">
  359. <summary>
  360. Decompresses the specified data.
  361. </summary>
  362. <param name="data">The compressed byte array.</param>
  363. <param name="pos">The starting position into the byte array.</param>
  364. <param name="Length">The number of compressed bytes to decompress.</param>
  365. <returns>An uncompressed byte array</returns>
  366. </member>
  367. <member name="T:NPOI.DDF.EscherBoolProperty">
  368. <summary>
  369. Represents a bool property. The actual utility of this property is in doubt because many
  370. of the properties marked as bool seem to actually contain special values. In other words
  371. they're not true bools.
  372. @author Glen Stampoultzis
  373. </summary>
  374. </member>
  375. <member name="M:NPOI.DDF.EscherBoolProperty.#ctor(System.Int16,System.Int32)">
  376. <summary>
  377. Create an instance of an escher bool property.
  378. </summary>
  379. <param name="propertyNumber">The property number (or id)</param>
  380. <param name="value">The 32 bit value of this bool property</param>
  381. </member>
  382. <member name="P:NPOI.DDF.EscherBoolProperty.IsTrue">
  383. <summary>
  384. Whether this bool property is true
  385. </summary>
  386. <value><c>true</c> if this instance is true; otherwise, <c>false</c>.</value>
  387. </member>
  388. <member name="P:NPOI.DDF.EscherBoolProperty.IsFalse">
  389. <summary>
  390. Whether this bool property is false
  391. </summary>
  392. <value><c>true</c> if this instance is false; otherwise, <c>false</c>.</value>
  393. </member>
  394. <member name="T:NPOI.DDF.EscherBSERecord">
  395. <summary>
  396. The BSE record is related closely to the EscherBlipRecord and stores
  397. extra information about the blip. A blip record is actually stored inside
  398. the BSE record even though the BSE record isn't actually a container record.
  399. @author Glen Stampoultzis
  400. @see EscherBlipRecord
  401. </summary>
  402. </member>
  403. <member name="M:NPOI.DDF.EscherBSERecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  404. <summary>
  405. This method deSerializes the record from a byte array.
  406. </summary>
  407. <param name="data">The byte array containing the escher record information</param>
  408. <param name="offset">The starting offset into data</param>
  409. <param name="recordFactory">May be null since this is not a container record.</param>
  410. <returns>The number of bytes Read from the byte array.</returns>
  411. </member>
  412. <member name="M:NPOI.DDF.EscherBSERecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  413. <summary>
  414. This method Serializes this escher record into a byte array.
  415. </summary>
  416. <param name="offset">The offset into
  417. data to start writing the record data to</param>
  418. <param name="data">The byte array to Serialize to.</param>
  419. <param name="listener">a listener for begin and end serialization events.</param>
  420. <returns>The number of bytes written.</returns>
  421. </member>
  422. <member name="P:NPOI.DDF.EscherBSERecord.RecordSize">
  423. <summary>
  424. Returns the number of bytes that are required to Serialize this record.
  425. </summary>
  426. <value>Number of bytes</value>
  427. </member>
  428. <member name="P:NPOI.DDF.EscherBSERecord.RecordName">
  429. <summary>
  430. The short name for this record
  431. </summary>
  432. <value></value>
  433. </member>
  434. <member name="P:NPOI.DDF.EscherBSERecord.BlipTypeWin32">
  435. <summary>
  436. Gets or sets the expected blip type under windows (failure to match this blip type will result in
  437. Excel converting to this format).
  438. </summary>
  439. <value>The blip type win32.</value>
  440. </member>
  441. <member name="P:NPOI.DDF.EscherBSERecord.BlipTypeMacOS">
  442. <summary>
  443. Gets or sets the expected blip type under MacOS (failure to match this blip type will result in
  444. Excel converting to this format).
  445. </summary>
  446. <value>The blip type mac OS.</value>
  447. </member>
  448. <member name="P:NPOI.DDF.EscherBSERecord.UID">
  449. <summary>
  450. Gets or sets 16 byte MD4 checksum.
  451. </summary>
  452. <value>The UID.</value>
  453. </member>
  454. <member name="P:NPOI.DDF.EscherBSERecord.Tag">
  455. <summary>
  456. Gets or sets the tag. (Unused)
  457. </summary>
  458. <value>The tag.</value>
  459. </member>
  460. <member name="P:NPOI.DDF.EscherBSERecord.Size">
  461. <summary>
  462. Gets or sets Blip size in stream..
  463. </summary>
  464. <value>The size.</value>
  465. </member>
  466. <member name="P:NPOI.DDF.EscherBSERecord.Ref">
  467. <summary>
  468. Gets or sets the reference count of this blip.
  469. </summary>
  470. <value>The ref.</value>
  471. </member>
  472. <member name="P:NPOI.DDF.EscherBSERecord.Offset">
  473. <summary>
  474. Gets or sets the offset in the delay stream..
  475. </summary>
  476. <value>The offset.</value>
  477. </member>
  478. <member name="P:NPOI.DDF.EscherBSERecord.Usage">
  479. <summary>
  480. Defines the way this blip is used.
  481. </summary>
  482. <value>The usage.</value>
  483. </member>
  484. <member name="P:NPOI.DDF.EscherBSERecord.Name">
  485. <summary>
  486. Gets or sets the blip name.
  487. </summary>
  488. <value>The name.</value>
  489. </member>
  490. <member name="P:NPOI.DDF.EscherBSERecord.Unused2">
  491. <summary>
  492. Gets or sets the unused2.
  493. </summary>
  494. <value>The unused2.</value>
  495. </member>
  496. <member name="P:NPOI.DDF.EscherBSERecord.Unused3">
  497. <summary>
  498. Gets or sets the unused3.
  499. </summary>
  500. <value>The unused3.</value>
  501. </member>
  502. <member name="P:NPOI.DDF.EscherBSERecord.BlipRecord">
  503. <summary>
  504. Gets or sets the blip record.
  505. </summary>
  506. <value>The blip record.</value>
  507. </member>
  508. <member name="P:NPOI.DDF.EscherBSERecord.RemainingData">
  509. <summary>
  510. Gets or sets any remaining data in this record.
  511. </summary>
  512. <value>The remaining data.</value>
  513. </member>
  514. <member name="M:NPOI.DDF.EscherBSERecord.ToString">
  515. <summary>
  516. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  517. </summary>
  518. <returns>
  519. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  520. </returns>
  521. </member>
  522. <member name="M:NPOI.DDF.EscherBSERecord.GetBlipType(System.Byte)">
  523. <summary>
  524. Retrieve the string representation given a blip id.
  525. </summary>
  526. <param name="b">The b.</param>
  527. <returns></returns>
  528. </member>
  529. <member name="T:NPOI.DDF.EscherChildAnchorRecord">
  530. <summary>
  531. The escher child achor record is used to specify the position of a shape under an
  532. existing group. The first level of shape records use a EscherClientAnchor record instead.
  533. @author Glen Stampoultzis
  534. </summary>
  535. </member>
  536. <member name="M:NPOI.DDF.EscherChildAnchorRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  537. <summary>
  538. This method deSerializes the record from a byte array.
  539. </summary>
  540. <param name="data">The byte array containing the escher record information</param>
  541. <param name="offset">The starting offset into data</param>
  542. <param name="recordFactory">May be null since this is not a container record.</param>
  543. <returns>The number of bytes Read from the byte array.</returns>
  544. </member>
  545. <member name="M:NPOI.DDF.EscherChildAnchorRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  546. <summary>
  547. This method Serializes this escher record into a byte array.
  548. </summary>
  549. <param name="offset">The offset into data to start writing the record data to.</param>
  550. <param name="data">The byte array to Serialize to.</param>
  551. <param name="listener">a listener for begin and end serialization events.</param>
  552. <returns>The number of bytes written.</returns>
  553. </member>
  554. <member name="P:NPOI.DDF.EscherChildAnchorRecord.RecordSize">
  555. <summary>
  556. Returns the number of bytes that are required to Serialize this record.
  557. </summary>
  558. <value>Number of bytes</value>
  559. </member>
  560. <member name="P:NPOI.DDF.EscherChildAnchorRecord.RecordId">
  561. <summary>
  562. The record id for the EscherChildAnchorRecord.
  563. </summary>
  564. <value></value>
  565. </member>
  566. <member name="P:NPOI.DDF.EscherChildAnchorRecord.RecordName">
  567. <summary>
  568. The short name for this record
  569. </summary>
  570. <value></value>
  571. </member>
  572. <member name="M:NPOI.DDF.EscherChildAnchorRecord.ToString">
  573. <summary>
  574. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  575. </summary>
  576. <returns>
  577. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  578. </returns>
  579. </member>
  580. <member name="P:NPOI.DDF.EscherChildAnchorRecord.Dx1">
  581. <summary>
  582. Gets or sets offset within the parent coordinate space for the top left point.
  583. </summary>
  584. <value>The DX1.</value>
  585. </member>
  586. <member name="P:NPOI.DDF.EscherChildAnchorRecord.Dy1">
  587. <summary>
  588. Gets or sets the offset within the parent coordinate space for the top left point.
  589. </summary>
  590. <value>The dy1.</value>
  591. </member>
  592. <member name="P:NPOI.DDF.EscherChildAnchorRecord.Dx2">
  593. <summary>
  594. Gets or sets the offset within the parent coordinate space for the bottom right point.
  595. </summary>
  596. <value>The DX2.</value>
  597. </member>
  598. <member name="P:NPOI.DDF.EscherChildAnchorRecord.Dy2">
  599. <summary>
  600. Gets or sets the offset within the parent coordinate space for the bottom right point.
  601. </summary>
  602. <value>The dy2.</value>
  603. </member>
  604. <member name="T:NPOI.DDF.EscherClientAnchorRecord">
  605. <summary>
  606. The escher client anchor specifies which rows and cells the shape is bound to as well as
  607. the offsets within those cells. Each cell is 1024 units wide by 256 units long regardless
  608. of the actual size of the cell. The EscherClientAnchorRecord only applies to the top-most
  609. shapes. Shapes contained in groups are bound using the EscherChildAnchorRecords.
  610. @author Glen Stampoultzis
  611. </summary>
  612. </member>
  613. <member name="F:NPOI.DDF.EscherClientAnchorRecord.field_1_flag">
  614. bit[0] - fMove (1 bit): A bit that specifies whether the shape will be kept intact when the cells are moved.
  615. bit[1] - fSize (1 bit): A bit that specifies whether the shape will be kept intact when the cells are resized. If fMove is 1, the value MUST be 1.
  616. bit[2-4] - reserved, MUST be 0 and MUST be ignored
  617. bit[5-15]- Undefined and MUST be ignored.
  618. it can take values: 0, 2, 3
  619. </member>
  620. <member name="M:NPOI.DDF.EscherClientAnchorRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  621. <summary>
  622. This method deSerializes the record from a byte array.
  623. </summary>
  624. <param name="data">The byte array containing the escher record information</param>
  625. <param name="offset">The starting offset into data</param>
  626. <param name="recordFactory">May be null since this is not a container record.</param>
  627. <returns>The number of bytes Read from the byte array.</returns>
  628. </member>
  629. <member name="M:NPOI.DDF.EscherClientAnchorRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  630. <summary>
  631. This method Serializes this escher record into a byte array.
  632. </summary>
  633. <param name="offset">The offset into data to start writing the record data to.</param>
  634. <param name="data">The byte array to Serialize to.</param>
  635. <param name="listener">a listener for begin and end serialization events.</param>
  636. <returns>The number of bytes written.</returns>
  637. </member>
  638. <member name="P:NPOI.DDF.EscherClientAnchorRecord.RecordSize">
  639. <summary>
  640. Returns the number of bytes that are required to Serialize this record.
  641. </summary>
  642. <value>Number of bytes</value>
  643. </member>
  644. <member name="P:NPOI.DDF.EscherClientAnchorRecord.RecordId">
  645. <summary>
  646. The record id for this record.
  647. </summary>
  648. <value></value>
  649. </member>
  650. <member name="P:NPOI.DDF.EscherClientAnchorRecord.RecordName">
  651. <summary>
  652. The short name for this record
  653. </summary>
  654. <value></value>
  655. </member>
  656. <member name="M:NPOI.DDF.EscherClientAnchorRecord.ToString">
  657. <summary>
  658. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  659. </summary>
  660. <returns>
  661. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  662. </returns>
  663. </member>
  664. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Flag">
  665. <summary>
  666. Gets or sets the flag.
  667. </summary>
  668. <value>0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells.</value>
  669. </member>
  670. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Col1">
  671. <summary>
  672. Gets or sets The column number for the top-left position. 0 based.
  673. </summary>
  674. <value>The col1.</value>
  675. </member>
  676. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Dx1">
  677. <summary>
  678. Gets or sets The x offset within the top-left cell. Range is from 0 to 1023.
  679. </summary>
  680. <value>The DX1.</value>
  681. </member>
  682. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Row1">
  683. <summary>
  684. Gets or sets The row number for the top-left corner of the shape.
  685. </summary>
  686. <value>The row1.</value>
  687. </member>
  688. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Dy1">
  689. <summary>
  690. Gets or sets The y offset within the top-left corner of the current shape.
  691. </summary>
  692. <value>The dy1.</value>
  693. </member>
  694. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Col2">
  695. <summary>
  696. Gets or sets The column of the bottom right corner of this shape.
  697. </summary>
  698. <value>The col2.</value>
  699. </member>
  700. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Dx2">
  701. <summary>
  702. Gets or sets The x offset withing the cell for the bottom-right corner of this shape.
  703. </summary>
  704. <value>The DX2.</value>
  705. </member>
  706. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Row2">
  707. <summary>
  708. Gets or sets The row number for the bottom-right corner of the current shape.
  709. </summary>
  710. <value>The row2.</value>
  711. </member>
  712. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Dy2">
  713. <summary>
  714. Gets or sets The y offset withing the cell for the bottom-right corner of this shape.
  715. </summary>
  716. <value>The dy2.</value>
  717. </member>
  718. <member name="P:NPOI.DDF.EscherClientAnchorRecord.RemainingData">
  719. <summary>
  720. Gets or sets the remaining data.
  721. </summary>
  722. <value>The remaining data.</value>
  723. </member>
  724. <member name="T:NPOI.DDF.EscherClientDataRecord">
  725. <summary>
  726. The EscherClientDataRecord is used to store client specific data about the position of a
  727. shape within a container.
  728. @author Glen Stampoultzis
  729. </summary>
  730. </member>
  731. <member name="M:NPOI.DDF.EscherClientDataRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  732. <summary>
  733. This method deSerializes the record from a byte array.
  734. </summary>
  735. <param name="data">The byte array containing the escher record information</param>
  736. <param name="offset">The starting offset into data</param>
  737. <param name="recordFactory">May be null since this is not a container record.</param>
  738. <returns>The number of bytes Read from the byte array.</returns>
  739. </member>
  740. <member name="M:NPOI.DDF.EscherClientDataRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  741. This method Serializes this escher record into a byte array.
  742. @param offset The offset into <c>data</c> to start writing the record data to.
  743. @param data The byte array to Serialize to.
  744. @param listener A listener to retrieve start and end callbacks. Use a <c>NullEscherSerailizationListener</c> to ignore these events.
  745. @return The number of bytes written.
  746. @see NullEscherSerializationListener
  747. </member>
  748. <member name="P:NPOI.DDF.EscherClientDataRecord.RecordSize">
  749. Returns the number of bytes that are required to Serialize this record.
  750. @return Number of bytes
  751. </member>
  752. <member name="P:NPOI.DDF.EscherClientDataRecord.RecordId">
  753. Returns the identifier of this record.
  754. </member>
  755. <member name="P:NPOI.DDF.EscherClientDataRecord.RecordName">
  756. The short name for this record
  757. </member>
  758. <member name="M:NPOI.DDF.EscherClientDataRecord.ToString">
  759. Returns the string representation of this record.
  760. </member>
  761. <member name="P:NPOI.DDF.EscherClientDataRecord.RemainingData">
  762. Any data recording this record.
  763. </member>
  764. <member name="T:NPOI.DDF.SysIndexProcedure">
  765. The following enum specifies values that indicate special procedural properties that
  766. are used to modify the color components of another color. These values are combined with
  767. those of the {@link SysIndexSource} enum or with a user-specified color.
  768. The first six values are mutually exclusive.
  769. </member>
  770. <member name="T:NPOI.DDF.EscherColorRef">
  771. An OfficeArtCOLORREF structure entry which also handles color extension opid data
  772. </member>
  773. <member name="M:NPOI.DDF.EscherColorRef.GetSysIndexSource">
  774. @return {@link SysIndexSource} if {@link #hasSysIndexFlag()} is {@code true}, otherwise null
  775. </member>
  776. <member name="M:NPOI.DDF.EscherColorRef.GetSysIndexProcedure">
  777. Return the {@link SysIndexProcedure} - for invert flag use {@link #getSysIndexInvert()}
  778. @return {@link SysIndexProcedure} if {@link #hasSysIndexFlag()} is {@code true}, otherwise null
  779. </member>
  780. <member name="M:NPOI.DDF.EscherColorRef.GetSysIndexInvert">
  781. @return 0 for no invert flag, 1 for {@link SysIndexProcedure#INVERT_AFTER} and
  782. 2 for {@link SysIndexProcedure#INVERT_HIGHBIT_AFTER}
  783. </member>
  784. <member name="M:NPOI.DDF.EscherColorRef.GetSchemeIndex">
  785. @return index of the scheme color or -1 if {@link #hasSchemeIndexFlag()} is {@code false}
  786. @see NPOI.HSLF.Record.ColorSchemeAtom#getColor(int)
  787. </member>
  788. <member name="M:NPOI.DDF.EscherColorRef.GetPaletteIndex">
  789. @return index of current palette (color) or -1 if {@link #hasPaletteIndexFlag()} is {@code false}
  790. </member>
  791. <member name="T:NPOI.DDF.EscherComplexProperty">
  792. <summary>
  793. A complex property differs from a simple property in that the data can not fit inside a 32 bit
  794. integer. See the specification for more detailed information regarding exactly what is
  795. stored here.
  796. @author Glen Stampoultzis
  797. </summary>
  798. </member>
  799. <member name="M:NPOI.DDF.EscherComplexProperty.#ctor(System.Int16,System.Byte[])">
  800. <summary>
  801. Create a complex property using the property id and a byte array containing the complex
  802. data value.
  803. </summary>
  804. <param name="id"> The id consists of the property number, a flag indicating whether this is a blip id and a flag
  805. indicating that this is a complex property.</param>
  806. <param name="complexData">The value of this property.</param>
  807. </member>
  808. <member name="M:NPOI.DDF.EscherComplexProperty.#ctor(System.Int16,System.Boolean,System.Byte[])">
  809. <summary>
  810. Create a complex property using the property number, a flag to indicate whether this is a
  811. blip reference and the complex property data.
  812. </summary>
  813. <param name="propertyNumber">The property number.</param>
  814. <param name="isBlipId">Whether this is a blip id. Should be false.</param>
  815. <param name="complexData">The value of this complex property.</param>
  816. </member>
  817. <member name="M:NPOI.DDF.EscherComplexProperty.SerializeSimplePart(System.Byte[],System.Int32)">
  818. <summary>
  819. Serializes the simple part of this property. ie the first 6 bytes.
  820. </summary>
  821. <param name="data"></param>
  822. <param name="pos"></param>
  823. <returns></returns>
  824. </member>
  825. <member name="M:NPOI.DDF.EscherComplexProperty.SerializeComplexPart(System.Byte[],System.Int32)">
  826. <summary>
  827. Serializes the complex part of this property
  828. </summary>
  829. <param name="data">The data array to Serialize to</param>
  830. <param name="pos">The offset within data to start serializing to.</param>
  831. <returns>The number of bytes Serialized.</returns>
  832. </member>
  833. <member name="P:NPOI.DDF.EscherComplexProperty.ComplexData">
  834. <summary>
  835. Gets the complex data.
  836. </summary>
  837. <value>The complex data.</value>
  838. </member>
  839. <member name="M:NPOI.DDF.EscherComplexProperty.Equals(System.Object)">
  840. <summary>
  841. Determine whether this property is equal to another property.
  842. </summary>
  843. <param name="o">The object to compare to.</param>
  844. <returns>True if the objects are equal.</returns>
  845. </member>
  846. <member name="P:NPOI.DDF.EscherComplexProperty.PropertySize">
  847. <summary>
  848. Caclulates the number of bytes required to Serialize this property.
  849. </summary>
  850. <value>Number of bytes</value>
  851. </member>
  852. <member name="M:NPOI.DDF.EscherComplexProperty.GetHashCode">
  853. <summary>
  854. Serves as a hash function for a particular type.
  855. </summary>
  856. <returns>
  857. A hash code for the current <see cref="T:System.Object"/>.
  858. </returns>
  859. </member>
  860. <member name="M:NPOI.DDF.EscherComplexProperty.ToString">
  861. <summary>
  862. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  863. </summary>
  864. <returns>
  865. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  866. </returns>
  867. </member>
  868. <member name="T:NPOI.DDF.EscherContainerRecord">
  869. <summary>
  870. Escher container records store other escher records as children.
  871. The container records themselves never store any information beyond
  872. the standard header used by all escher records. This one record is
  873. used to represent many different types of records.
  874. @author Glen Stampoultzis
  875. </summary>
  876. </member>
  877. <member name="F:NPOI.DDF.EscherContainerRecord._remainingLength">
  878. in case if document contains any charts we have such document structure:
  879. BOF
  880. ...
  881. DrawingRecord
  882. ...
  883. ObjRecord|TxtObjRecord
  884. ...
  885. EOF
  886. ...
  887. BOF(Chart begin)
  888. ...
  889. DrawingRecord
  890. ...
  891. ObjRecord|TxtObjRecord
  892. ...
  893. EOF
  894. So, when we call EscherAggregate.createAggregate() we have not all needed data.
  895. When we got warning "WARNING: " + bytesRemaining + " bytes remaining but no space left"
  896. we should save value of bytesRemaining
  897. and add it to container size when we serialize it
  898. </member>
  899. <member name="M:NPOI.DDF.EscherContainerRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  900. <summary>
  901. The contract of this method is to deSerialize an escher record including
  902. it's children.
  903. </summary>
  904. <param name="data">The byte array containing the Serialized escher
  905. records.</param>
  906. <param name="offset">The offset into the byte array.</param>
  907. <param name="recordFactory">A factory for creating new escher records</param>
  908. <returns>The number of bytes written.</returns>
  909. </member>
  910. <member name="M:NPOI.DDF.EscherContainerRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  911. <summary>
  912. Serializes to an existing byte array without serialization listener.
  913. This is done by delegating to Serialize(int, byte[], EscherSerializationListener).
  914. </summary>
  915. <param name="offset">the offset within the data byte array.</param>
  916. <param name="data"> the data array to Serialize to.</param>
  917. <param name="listener">a listener for begin and end serialization events.</param>
  918. <returns>The number of bytes written.</returns>
  919. </member>
  920. <member name="P:NPOI.DDF.EscherContainerRecord.RecordSize">
  921. <summary>
  922. Subclasses should effeciently return the number of bytes required to
  923. Serialize the record.
  924. </summary>
  925. <value>number of bytes</value>
  926. </member>
  927. <member name="M:NPOI.DDF.EscherContainerRecord.HasChildOfType(System.Int16)">
  928. <summary>
  929. Do any of our (top level) children have the
  930. given recordId?
  931. </summary>
  932. <param name="recordId">The record id.</param>
  933. <returns>
  934. <c>true</c> if [has child of type] [the specified record id]; otherwise, <c>false</c>.
  935. </returns>
  936. </member>
  937. <member name="P:NPOI.DDF.EscherContainerRecord.ChildRecords">
  938. <summary>
  939. Returns a list of all the child (escher) records
  940. of the container.
  941. </summary>
  942. <value></value>
  943. </member>
  944. <member name="P:NPOI.DDF.EscherContainerRecord.ChildContainers">
  945. <summary>
  946. Returns all of our children which are also
  947. EscherContainers (may be 0, 1, or vary rarely
  948. 2 or 3)
  949. </summary>
  950. <value>The child containers.</value>
  951. </member>
  952. <member name="P:NPOI.DDF.EscherContainerRecord.RecordName">
  953. <summary>
  954. Subclasses should return the short name for this escher record.
  955. </summary>
  956. <value></value>
  957. </member>
  958. <member name="M:NPOI.DDF.EscherContainerRecord.Display(System.Int32)">
  959. <summary>
  960. The display methods allows escher variables to print the record names
  961. according to their hierarchy.
  962. </summary>
  963. <param name="indent">The current indent level.</param>
  964. </member>
  965. <member name="M:NPOI.DDF.EscherContainerRecord.AddChildRecord(NPOI.DDF.EscherRecord)">
  966. <summary>
  967. Adds the child record.
  968. </summary>
  969. <param name="record">The record.</param>
  970. </member>
  971. <member name="M:NPOI.DDF.EscherContainerRecord.ToString">
  972. <summary>
  973. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  974. </summary>
  975. <returns>
  976. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  977. </returns>
  978. </member>
  979. <member name="M:NPOI.DDF.EscherContainerRecord.GetChildById(System.Int16)">
  980. <summary>
  981. Gets the child by id.
  982. </summary>
  983. <param name="recordId">The record id.</param>
  984. <returns></returns>
  985. </member>
  986. <member name="M:NPOI.DDF.EscherContainerRecord.GetRecordsById(System.Int16,System.Collections.ArrayList@)">
  987. <summary>
  988. Recursively find records with the specified record ID
  989. </summary>
  990. <param name="recordId"></param>
  991. <param name="out1">list to store found records</param>
  992. </member>
  993. <member name="T:NPOI.DDF.EscherDggRecord">
  994. <summary>
  995. This record defines the drawing groups used for a particular sheet.
  996. </summary>
  997. </member>
  998. <member name="M:NPOI.DDF.EscherDggRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  999. <summary>
  1000. This method deSerializes the record from a byte array.
  1001. </summary>
  1002. <param name="data">The byte array containing the escher record information</param>
  1003. <param name="offset">The starting offset into data</param>
  1004. <param name="recordFactory">May be null since this is not a container record.</param>
  1005. <returns>The number of bytes Read from the byte array.</returns>
  1006. </member>
  1007. <member name="M:NPOI.DDF.EscherDggRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  1008. <summary>
  1009. This method Serializes this escher record into a byte array.
  1010. </summary>
  1011. <param name="offset">The offset into data to start writing the record data to.</param>
  1012. <param name="data">The byte array to Serialize to.</param>
  1013. <param name="listener">a listener for begin and end serialization events.</param>
  1014. <returns>The number of bytes written.</returns>
  1015. </member>
  1016. <member name="P:NPOI.DDF.EscherDggRecord.RecordSize">
  1017. <summary>
  1018. Returns the number of bytes that are required to Serialize this record.
  1019. </summary>
  1020. <value>Number of bytes</value>
  1021. </member>
  1022. <member name="P:NPOI.DDF.EscherDggRecord.RecordId">
  1023. <summary>
  1024. Return the current record id.
  1025. </summary>
  1026. <value>The 16 bit record id.</value>
  1027. </member>
  1028. <member name="P:NPOI.DDF.EscherDggRecord.RecordName">
  1029. <summary>
  1030. The short name for this record
  1031. </summary>
  1032. <value></value>
  1033. </member>
  1034. <member name="M:NPOI.DDF.EscherDggRecord.ToString">
  1035. <summary>
  1036. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1037. </summary>
  1038. <returns>
  1039. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1040. </returns>
  1041. </member>
  1042. <member name="P:NPOI.DDF.EscherDggRecord.ShapeIdMax">
  1043. <summary>
  1044. Gets or sets the shape id max.
  1045. </summary>
  1046. <value>The shape id max.</value>
  1047. </member>
  1048. <member name="P:NPOI.DDF.EscherDggRecord.NumIdClusters">
  1049. <summary>
  1050. Gets the Number of id clusters + 1
  1051. </summary>
  1052. <value>The num id clusters.</value>
  1053. </member>
  1054. <member name="P:NPOI.DDF.EscherDggRecord.NumShapesSaved">
  1055. <summary>
  1056. Gets or sets the num shapes saved.
  1057. </summary>
  1058. <value>The num shapes saved.</value>
  1059. </member>
  1060. <member name="P:NPOI.DDF.EscherDggRecord.DrawingsSaved">
  1061. <summary>
  1062. Gets or sets the drawings saved.
  1063. </summary>
  1064. <value>The drawings saved.</value>
  1065. </member>
  1066. <member name="P:NPOI.DDF.EscherDggRecord.MaxDrawingGroupId">
  1067. <summary>
  1068. Gets or sets the max drawing group id.
  1069. </summary>
  1070. <value>The max drawing group id.</value>
  1071. </member>
  1072. <member name="P:NPOI.DDF.EscherDggRecord.FileIdClusters">
  1073. <summary>
  1074. Gets or sets the file id clusters.
  1075. </summary>
  1076. <value>The file id clusters.</value>
  1077. </member>
  1078. <member name="M:NPOI.DDF.EscherDggRecord.AddCluster(System.Int32,System.Int32)">
  1079. <summary>
  1080. Adds the cluster.
  1081. </summary>
  1082. <param name="dgId">The dg id.</param>
  1083. <param name="numShapedUsed">The num shaped used.</param>
  1084. </member>
  1085. <member name="M:NPOI.DDF.EscherDggRecord.AddCluster(System.Int32,System.Int32,System.Boolean)">
  1086. <summary>
  1087. Adds the cluster.
  1088. </summary>
  1089. <param name="dgId">id of the drawing group (stored in the record options)</param>
  1090. <param name="numShapedUsed">initial value of the numShapedUsed field</param>
  1091. <param name="sort">if set to <c>true</c> if true then sort clusters by drawing group id.(
  1092. In Excel the clusters are sorted but in PPT they are not).</param>
  1093. </member>
  1094. <member name="T:NPOI.DDF.EscherDgRecord">
  1095. <summary>
  1096. This record simply holds the number of shapes in the drawing group and the
  1097. last shape id used for this drawing group.
  1098. @author Glen Stampoultzis
  1099. </summary>
  1100. </member>
  1101. <member name="M:NPOI.DDF.EscherDgRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  1102. <summary>
  1103. This method deSerializes the record from a byte array.
  1104. </summary>
  1105. <param name="data">The byte array containing the escher record information</param>
  1106. <param name="offset">The starting offset into data</param>
  1107. <param name="recordFactory">May be null since this is not a container record.</param>
  1108. <returns>The number of bytes Read from the byte array.</returns>
  1109. </member>
  1110. <member name="M:NPOI.DDF.EscherDgRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  1111. <summary>
  1112. This method Serializes this escher record into a byte array.
  1113. </summary>
  1114. <param name="offset"> The offset into data to start writing the record data to.</param>
  1115. <param name="data"> The byte array to Serialize to.</param>
  1116. <returns>The number of bytes written.</returns>
  1117. <param name="listener">a listener for begin and end serialization events.</param>
  1118. </member>
  1119. <member name="P:NPOI.DDF.EscherDgRecord.RecordSize">
  1120. <summary>
  1121. Returns the number of bytes that are required to Serialize this record.
  1122. </summary>
  1123. <value>Number of bytes</value>
  1124. </member>
  1125. <member name="P:NPOI.DDF.EscherDgRecord.RecordId">
  1126. <summary>
  1127. Return the current record id.
  1128. </summary>
  1129. <value>The 16 bit record id.</value>
  1130. </member>
  1131. <member name="P:NPOI.DDF.EscherDgRecord.RecordName">
  1132. <summary>
  1133. The short name for this record
  1134. </summary>
  1135. <value></value>
  1136. </member>
  1137. <member name="M:NPOI.DDF.EscherDgRecord.ToString">
  1138. <summary>
  1139. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1140. </summary>
  1141. <returns>
  1142. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1143. </returns>
  1144. </member>
  1145. <member name="P:NPOI.DDF.EscherDgRecord.NumShapes">
  1146. <summary>
  1147. Gets or sets The number of shapes in this drawing group.
  1148. </summary>
  1149. <value>The num shapes.</value>
  1150. </member>
  1151. <member name="P:NPOI.DDF.EscherDgRecord.LastMSOSPID">
  1152. <summary>
  1153. Gets or sets The last shape id used in this drawing group.
  1154. </summary>
  1155. <value>The last MSOSPID.</value>
  1156. </member>
  1157. <member name="P:NPOI.DDF.EscherDgRecord.DrawingGroupId">
  1158. <summary>
  1159. Gets the drawing group id for this record. This is encoded in the
  1160. instance part of the option record.
  1161. </summary>
  1162. <value>The drawing group id.</value>
  1163. </member>
  1164. <member name="M:NPOI.DDF.EscherDgRecord.IncrementShapeCount">
  1165. <summary>
  1166. Increments the shape count.
  1167. </summary>
  1168. </member>
  1169. <member name="T:NPOI.DDF.EscherDump">
  1170. <summary>
  1171. Used to dump the contents of escher records to a PrintStream.
  1172. @author Glen Stampoultzis (glens at apache.org)
  1173. </summary>
  1174. </member>
  1175. <member name="M:NPOI.DDF.EscherDump.Dump(System.Byte[],System.Int32,System.Int32)">
  1176. <summary>
  1177. Decodes the escher stream from a byte array and dumps the results to
  1178. a print stream.
  1179. </summary>
  1180. <param name="data">The data array containing the escher records.</param>
  1181. <param name="offset">The starting offset within the data array.</param>
  1182. <param name="size">The number of bytes to Read.</param>
  1183. </member>
  1184. <member name="M:NPOI.DDF.EscherDump.DumpOld(System.Int64,System.IO.Stream)">
  1185. <summary>
  1186. This version of dump is a translation from the open office escher dump routine.
  1187. </summary>
  1188. <param name="maxLength">The number of bytes to Read</param>
  1189. <param name="in1">An input stream to Read from.</param>
  1190. </member>
  1191. <member name="M:NPOI.DDF.EscherDump.PropertyName(System.Int16)">
  1192. <summary>
  1193. Returns a property name given a property id. This is used only by the
  1194. old escher dump routine.
  1195. </summary>
  1196. <param name="propertyId">The property number for the name</param>
  1197. <returns>A descriptive name.</returns>
  1198. </member>
  1199. <member name="M:NPOI.DDF.EscherDump.GetBlipType(System.Byte)">
  1200. <summary>
  1201. Returns the blip description given a blip id.
  1202. </summary>
  1203. <param name="b">blip id</param>
  1204. <returns> A description.</returns>
  1205. </member>
  1206. <member name="M:NPOI.DDF.EscherDump.Dec1616(System.Int32)">
  1207. <summary>
  1208. Straight conversion from OO. Converts a type of float.
  1209. </summary>
  1210. <param name="n32">The N32.</param>
  1211. <returns></returns>
  1212. </member>
  1213. <member name="M:NPOI.DDF.EscherDump.OutHex(System.Int32,System.IO.Stream)">
  1214. <summary>
  1215. Dumps out a hex value by Reading from a input stream.
  1216. </summary>
  1217. <param name="bytes">How many bytes this hex value consists of.</param>
  1218. <param name="in1">The stream to Read the hex value from.</param>
  1219. </member>
  1220. <member name="M:NPOI.DDF.EscherDump.Dump(System.Int32,System.Byte[])">
  1221. <summary>
  1222. Dumps the specified record size.
  1223. </summary>
  1224. <param name="recordSize">Size of the record.</param>
  1225. <param name="data">The data.</param>
  1226. </member>
  1227. <member name="T:NPOI.DDF.EscherMetafileBlip">
  1228. <summary>
  1229. @author Daniel Noll
  1230. </summary>
  1231. </member>
  1232. <member name="F:NPOI.DDF.EscherMetafileBlip.SIGNATURE_EMF">
  1233. BLIP signatures as defined in the escher spec
  1234. </member>
  1235. <member name="F:NPOI.DDF.EscherMetafileBlip.field_2_UID">
  1236. The primary UID is only saved to disk if (blip_instance ^ blip_signature == 1)
  1237. </member>
  1238. <member name="M:NPOI.DDF.EscherMetafileBlip.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  1239. <summary>
  1240. This method deSerializes the record from a byte array.
  1241. </summary>
  1242. <param name="data">The byte array containing the escher record information</param>
  1243. <param name="offset">The starting offset into</param>
  1244. <param name="recordFactory">May be null since this is not a container record.</param>
  1245. <returns>
  1246. The number of bytes Read from the byte array.
  1247. </returns>
  1248. </member>
  1249. <member name="M:NPOI.DDF.EscherMetafileBlip.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  1250. <summary>
  1251. Serializes the record to an existing byte array.
  1252. </summary>
  1253. <param name="offset">the offset within the byte array</param>
  1254. <param name="data">the data array to Serialize to</param>
  1255. <param name="listener">a listener for begin and end serialization events.</param>
  1256. <returns>the number of bytes written.</returns>
  1257. </member>
  1258. <member name="M:NPOI.DDF.EscherMetafileBlip.InflatePictureData(System.Byte[])">
  1259. <summary>
  1260. Decompresses the provided data, returning the inflated result.
  1261. </summary>
  1262. <param name="data">the deflated picture data.</param>
  1263. <returns>the inflated picture data.</returns>
  1264. </member>
  1265. <member name="P:NPOI.DDF.EscherMetafileBlip.RecordSize">
  1266. <summary>
  1267. Returns the number of bytes that are required to Serialize this record.
  1268. </summary>
  1269. <value>Number of bytes</value>
  1270. </member>
  1271. <member name="P:NPOI.DDF.EscherMetafileBlip.UID">
  1272. <summary>
  1273. Gets or sets the UID.
  1274. </summary>
  1275. <value>The UID.</value>
  1276. </member>
  1277. <member name="P:NPOI.DDF.EscherMetafileBlip.PrimaryUID">
  1278. <summary>
  1279. Gets or sets the primary UID.
  1280. </summary>
  1281. <value>The primary UID.</value>
  1282. </member>
  1283. <member name="P:NPOI.DDF.EscherMetafileBlip.UncompressedSize">
  1284. <summary>
  1285. Gets or sets the size of the uncompressed.
  1286. </summary>
  1287. <value>The size of the uncompressed.</value>
  1288. </member>
  1289. <member name="P:NPOI.DDF.EscherMetafileBlip.Bounds">
  1290. <summary>
  1291. Gets or sets the bounds.
  1292. </summary>
  1293. <value>The bounds.</value>
  1294. </member>
  1295. <member name="P:NPOI.DDF.EscherMetafileBlip.SizeEMU">
  1296. <summary>
  1297. Gets or sets the size EMU.
  1298. </summary>
  1299. <value>The size EMU.</value>
  1300. </member>
  1301. <member name="P:NPOI.DDF.EscherMetafileBlip.CompressedSize">
  1302. <summary>
  1303. Gets or sets the size of the compressed.
  1304. </summary>
  1305. <value>The size of the compressed.</value>
  1306. </member>
  1307. <member name="P:NPOI.DDF.EscherMetafileBlip.IsCompressed">
  1308. <summary>
  1309. Gets or sets a value indicating whether this instance is compressed.
  1310. </summary>
  1311. <value>
  1312. <c>true</c> if this instance is compressed; otherwise, <c>false</c>.
  1313. </value>
  1314. </member>
  1315. <member name="M:NPOI.DDF.EscherMetafileBlip.ToString">
  1316. <summary>
  1317. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1318. </summary>
  1319. <returns>
  1320. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1321. </returns>
  1322. </member>
  1323. <member name="P:NPOI.DDF.EscherMetafileBlip.Signature">
  1324. <summary>
  1325. Return the blip signature
  1326. </summary>
  1327. <value>the blip signature</value>
  1328. </member>
  1329. <member name="T:NPOI.DDF.EscherOptRecord">
  1330. <summary>
  1331. The opt record is used to store property values for a shape. It is the key to determining
  1332. the attributes of a shape. Properties can be of two types: simple or complex. Simple types
  1333. are fixed Length. Complex properties are variable Length.
  1334. @author Glen Stampoultzis
  1335. </summary>
  1336. </member>
  1337. <member name="P:NPOI.DDF.EscherOptRecord.Options">
  1338. <summary>
  1339. Automatically recalculate the correct option
  1340. </summary>
  1341. <value></value>
  1342. </member>
  1343. <member name="P:NPOI.DDF.EscherOptRecord.RecordName">
  1344. <summary>
  1345. The short name for this record
  1346. </summary>
  1347. <value></value>
  1348. </member>
  1349. <member name="T:NPOI.DDF.EscherPictBlip">
  1350. <summary>
  1351. @author Daniel Noll
  1352. </summary>
  1353. </member>
  1354. <member name="M:NPOI.DDF.EscherPictBlip.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  1355. <summary>
  1356. This method deSerializes the record from a byte array.
  1357. </summary>
  1358. <param name="data">The byte array containing the escher record information</param>
  1359. <param name="offset">The starting offset into</param>
  1360. <param name="recordFactory">May be null since this is not a container record.</param>
  1361. <returns>
  1362. The number of bytes Read from the byte array.
  1363. </returns>
  1364. </member>
  1365. <member name="M:NPOI.DDF.EscherPictBlip.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  1366. <summary>
  1367. Serializes the record to an existing byte array.
  1368. </summary>
  1369. <param name="offset">the offset within the byte array</param>
  1370. <param name="data">the data array to Serialize to</param>
  1371. <param name="listener">a listener for begin and end serialization events.</param>
  1372. <returns>the number of bytes written.</returns>
  1373. </member>
  1374. <member name="M:NPOI.DDF.EscherPictBlip.InflatePictureData(System.Byte[])">
  1375. <summary>
  1376. Decompresses the provided data, returning the inflated result.
  1377. </summary>
  1378. <param name="data">the deflated picture data.</param>
  1379. <returns>the inflated picture data.</returns>
  1380. </member>
  1381. <member name="P:NPOI.DDF.EscherPictBlip.RecordSize">
  1382. <summary>
  1383. Returns the number of bytes that are required to Serialize this record.
  1384. </summary>
  1385. <value>Number of bytes</value>
  1386. </member>
  1387. <member name="P:NPOI.DDF.EscherPictBlip.UID">
  1388. <summary>
  1389. Gets or sets the UID.
  1390. </summary>
  1391. <value>The UID.</value>
  1392. </member>
  1393. <member name="P:NPOI.DDF.EscherPictBlip.UncompressedSize">
  1394. <summary>
  1395. Gets or sets the size of the uncompressed.
  1396. </summary>
  1397. <value>The size of the uncompressed.</value>
  1398. </member>
  1399. <member name="P:NPOI.DDF.EscherPictBlip.Bounds">
  1400. <summary>
  1401. Gets or sets the bounds.
  1402. </summary>
  1403. <value>The bounds.</value>
  1404. </member>
  1405. <member name="P:NPOI.DDF.EscherPictBlip.SizeEMU">
  1406. <summary>
  1407. Gets or sets the size EMU.
  1408. </summary>
  1409. <value>The size EMU.</value>
  1410. </member>
  1411. <member name="P:NPOI.DDF.EscherPictBlip.CompressedSize">
  1412. <summary>
  1413. Gets or sets the size of the compressed.
  1414. </summary>
  1415. <value>The size of the compressed.</value>
  1416. </member>
  1417. <member name="P:NPOI.DDF.EscherPictBlip.IsCompressed">
  1418. <summary>
  1419. Gets a value indicating whether this instance is compressed.
  1420. </summary>
  1421. <value>
  1422. <c>true</c> if this instance is compressed; otherwise, <c>false</c>.
  1423. </value>
  1424. </member>
  1425. <member name="M:NPOI.DDF.EscherPictBlip.ToString">
  1426. <summary>
  1427. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1428. </summary>
  1429. <returns>
  1430. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1431. </returns>
  1432. </member>
  1433. <member name="T:NPOI.DDF.EscherProperties">
  1434. <summary>
  1435. Provides a list of all known escher properties including the description and
  1436. type.
  1437. @author Glen Stampoultzis (glens at apache.org)
  1438. </summary>
  1439. </member>
  1440. <member name="M:NPOI.DDF.EscherProperties.InitProps">
  1441. <summary>
  1442. Inits the props.
  1443. </summary>
  1444. </member>
  1445. <member name="M:NPOI.DDF.EscherProperties.AddProp(System.Int32,NPOI.DDF.EscherPropertyMetaData)">
  1446. <summary>
  1447. Adds the prop.
  1448. </summary>
  1449. <param name="s">The s.</param>
  1450. <param name="data">The data.</param>
  1451. </member>
  1452. <member name="M:NPOI.DDF.EscherProperties.GetData(System.String,System.Byte)">
  1453. <summary>
  1454. Gets the data.
  1455. </summary>
  1456. <param name="propName">Name of the prop.</param>
  1457. <param name="type">The type.</param>
  1458. <returns></returns>
  1459. </member>
  1460. <member name="M:NPOI.DDF.EscherProperties.GetData(System.String)">
  1461. <summary>
  1462. Gets the data.
  1463. </summary>
  1464. <param name="propName">Name of the prop.</param>
  1465. <returns></returns>
  1466. </member>
  1467. <member name="M:NPOI.DDF.EscherProperties.GetPropertyName(System.Int16)">
  1468. <summary>
  1469. Gets the name of the property.
  1470. </summary>
  1471. <param name="propertyId">The property id.</param>
  1472. <returns></returns>
  1473. </member>
  1474. <member name="M:NPOI.DDF.EscherProperties.GetPropertyType(System.Int16)">
  1475. <summary>
  1476. Gets the type of the property.
  1477. </summary>
  1478. <param name="propertyId">The property id.</param>
  1479. <returns></returns>
  1480. </member>
  1481. <member name="T:NPOI.DDF.EscherProperty">
  1482. <summary>
  1483. This is the abstract base class for all escher properties.
  1484. @see EscherOptRecord
  1485. @author Glen Stampoultzis (glens at apache.org)
  1486. </summary>
  1487. </member>
  1488. <member name="M:NPOI.DDF.EscherProperty.#ctor(System.Int16)">
  1489. <summary>
  1490. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherProperty"/> class.
  1491. </summary>
  1492. <param name="id">The id is distinct from the actual property number. The id includes the property number the blip id
  1493. flag and an indicator whether the property is complex or not.</param>
  1494. </member>
  1495. <member name="M:NPOI.DDF.EscherProperty.#ctor(System.Int16,System.Boolean,System.Boolean)">
  1496. <summary>
  1497. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherProperty"/> class.The three parameters are combined to form a property
  1498. id.
  1499. </summary>
  1500. <param name="propertyNumber">The property number.</param>
  1501. <param name="isComplex">if set to <c>true</c> [is complex].</param>
  1502. <param name="isBlipId">if set to <c>true</c> [is blip id].</param>
  1503. </member>
  1504. <member name="P:NPOI.DDF.EscherProperty.Id">
  1505. <summary>
  1506. Gets the id.
  1507. </summary>
  1508. <value>The id.</value>
  1509. </member>
  1510. <member name="P:NPOI.DDF.EscherProperty.PropertyNumber">
  1511. <summary>
  1512. Gets the property number.
  1513. </summary>
  1514. <value>The property number.</value>
  1515. </member>
  1516. <member name="P:NPOI.DDF.EscherProperty.IsComplex">
  1517. <summary>
  1518. Gets a value indicating whether this instance is complex.
  1519. </summary>
  1520. <value>
  1521. <c>true</c> if this instance is complex; otherwise, <c>false</c>.
  1522. </value>
  1523. </member>
  1524. <member name="P:NPOI.DDF.EscherProperty.IsBlipId">
  1525. <summary>
  1526. Gets a value indicating whether this instance is blip id.
  1527. </summary>
  1528. <value>
  1529. <c>true</c> if this instance is blip id; otherwise, <c>false</c>.
  1530. </value>
  1531. </member>
  1532. <member name="P:NPOI.DDF.EscherProperty.Name">
  1533. <summary>
  1534. Gets the name.
  1535. </summary>
  1536. <value>The name.</value>
  1537. </member>
  1538. <member name="P:NPOI.DDF.EscherProperty.PropertySize">
  1539. <summary>
  1540. Most properties are just 6 bytes in Length. Override this if we're
  1541. dealing with complex properties.
  1542. </summary>
  1543. <value>The size of the property.</value>
  1544. </member>
  1545. <member name="M:NPOI.DDF.EscherProperty.SerializeSimplePart(System.Byte[],System.Int32)">
  1546. <summary>
  1547. Escher properties consist of a simple fixed Length part and a complex variable Length part.
  1548. The fixed Length part is Serialized first.
  1549. </summary>
  1550. <param name="data">The data.</param>
  1551. <param name="pos">The pos.</param>
  1552. <returns></returns>
  1553. </member>
  1554. <member name="M:NPOI.DDF.EscherProperty.SerializeComplexPart(System.Byte[],System.Int32)">
  1555. <summary>
  1556. Escher properties consist of a simple fixed Length part and a complex variable Length part.
  1557. The fixed Length part is Serialized first.
  1558. </summary>
  1559. <param name="data">The data.</param>
  1560. <param name="pos">The pos.</param>
  1561. <returns></returns>
  1562. </member>
  1563. <member name="T:NPOI.DDF.EscherPropertyFactory">
  1564. <summary>
  1565. Generates a property given a reference into the byte array storing that property.
  1566. @author Glen Stampoultzis
  1567. </summary>
  1568. </member>
  1569. <member name="M:NPOI.DDF.EscherPropertyFactory.CreateProperties(System.Byte[],System.Int32,System.Int16)">
  1570. <summary>
  1571. Create new properties from a byte array.
  1572. </summary>
  1573. <param name="data">The byte array containing the property</param>
  1574. <param name="offset">The starting offset into the byte array</param>
  1575. <param name="numProperties">The new properties</param>
  1576. <returns></returns>
  1577. </member>
  1578. <member name="T:NPOI.DDF.EscherPropertyMetaData">
  1579. <summary>
  1580. This class stores the type and description of an escher property.
  1581. @author Glen Stampoultzis (glens at apache.org)
  1582. </summary>
  1583. </member>
  1584. <member name="M:NPOI.DDF.EscherPropertyMetaData.#ctor(System.String)">
  1585. <summary>
  1586. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherPropertyMetaData"/> class.
  1587. </summary>
  1588. <param name="description">The description of the escher property.</param>
  1589. </member>
  1590. <member name="M:NPOI.DDF.EscherPropertyMetaData.#ctor(System.String,System.Byte)">
  1591. <summary>
  1592. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherPropertyMetaData"/> class.
  1593. </summary>
  1594. <param name="description">The description of the escher property.</param>
  1595. <param name="type">The type of the property.</param>
  1596. </member>
  1597. <member name="P:NPOI.DDF.EscherPropertyMetaData.Description">
  1598. <summary>
  1599. Gets the description.
  1600. </summary>
  1601. <value>The description.</value>
  1602. </member>
  1603. <member name="P:NPOI.DDF.EscherPropertyMetaData.Type">
  1604. <summary>
  1605. Gets the type.
  1606. </summary>
  1607. <value>The type.</value>
  1608. </member>
  1609. <member name="T:NPOI.DDF.EscherRecord">
  1610. <summary>
  1611. The base abstract record from which all escher records are defined. Subclasses will need
  1612. to define methods for serialization/deserialization and for determining the record size.
  1613. </summary>
  1614. </member>
  1615. <member name="M:NPOI.DDF.EscherRecord.#ctor">
  1616. <summary>
  1617. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherRecord"/> class.
  1618. </summary>
  1619. </member>
  1620. <member name="M:NPOI.DDF.EscherRecord.FillFields(System.Byte[],NPOI.DDF.IEscherRecordFactory)">
  1621. <summary>
  1622. Delegates to FillFields(byte[], int, EscherRecordFactory)
  1623. </summary>
  1624. <param name="data">the bytes to serialize from</param>
  1625. <param name="f">the escher record factory</param>
  1626. <returns>The number of bytes written.</returns>
  1627. </member>
  1628. <member name="M:NPOI.DDF.EscherRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  1629. <summary>
  1630. The contract of this method is to deSerialize an escher record including
  1631. it's children.
  1632. </summary>
  1633. <param name="data">The byte array containing the Serialized escher
  1634. records.</param>
  1635. <param name="offset">The offset into the byte array.</param>
  1636. <param name="recordFactory">A factory for creating new escher records.</param>
  1637. <returns>The number of bytes written.</returns>
  1638. </member>
  1639. <member name="M:NPOI.DDF.EscherRecord.ReadHeader(System.Byte[],System.Int32)">
  1640. <summary>
  1641. Reads the 8 byte header information and populates the
  1642. <c>options</c>
  1643. and
  1644. <c>recordId</c>
  1645. records.
  1646. </summary>
  1647. <param name="data">the byte array to Read from</param>
  1648. <param name="offset">the offset to start Reading from</param>
  1649. <returns>the number of bytes remaining in this record. This</returns>
  1650. </member>
  1651. <member name="M:NPOI.DDF.EscherRecord.ReadInstance(System.Byte[],System.Int32)">
  1652. <summary>
  1653. Read the options field from header and return instance part of it.
  1654. </summary>
  1655. <param name="data">the byte array to read from</param>
  1656. <param name="offset">the offset to start reading from</param>
  1657. <returns>value of instance part of options field</returns>
  1658. </member>
  1659. <member name="P:NPOI.DDF.EscherRecord.IsContainerRecord">
  1660. <summary>
  1661. Determine whether this is a container record by inspecting the option
  1662. field.
  1663. </summary>
  1664. <value>
  1665. <c>true</c> if this instance is container record; otherwise, <c>false</c>.
  1666. </value>
  1667. </member>
  1668. <member name="P:NPOI.DDF.EscherRecord.Options">
  1669. <summary>
  1670. Gets or sets the options field for this record. All records have one
  1671. </summary>
  1672. <value>The options.</value>
  1673. </member>
  1674. <member name="M:NPOI.DDF.EscherRecord.Serialize">
  1675. <summary>
  1676. Serializes to a new byte array. This is done by delegating to
  1677. Serialize(int, byte[]);
  1678. </summary>
  1679. <returns>the Serialized record.</returns>
  1680. </member>
  1681. <member name="M:NPOI.DDF.EscherRecord.Serialize(System.Int32,System.Byte[])">
  1682. <summary>
  1683. Serializes to an existing byte array without serialization listener.
  1684. This is done by delegating to Serialize(int, byte[], EscherSerializationListener).
  1685. </summary>
  1686. <param name="offset">the offset within the data byte array.</param>
  1687. <param name="data">the data array to Serialize to.</param>
  1688. <returns>The number of bytes written.</returns>
  1689. </member>
  1690. <member name="M:NPOI.DDF.EscherRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  1691. <summary>
  1692. Serializes the record to an existing byte array.
  1693. </summary>
  1694. <param name="offset">the offset within the byte array.</param>
  1695. <param name="data">the offset within the byte array</param>
  1696. <param name="listener">a listener for begin and end serialization events. This.
  1697. is useful because the serialization is
  1698. hierarchical/recursive and sometimes you need to be able
  1699. break into that.
  1700. </param>
  1701. <returns></returns>
  1702. </member>
  1703. <member name="P:NPOI.DDF.EscherRecord.RecordSize">
  1704. <summary>
  1705. Subclasses should effeciently return the number of bytes required to
  1706. Serialize the record.
  1707. </summary>
  1708. <value>number of bytes</value>
  1709. </member>
  1710. <member name="P:NPOI.DDF.EscherRecord.RecordId">
  1711. <summary>
  1712. Return the current record id.
  1713. </summary>
  1714. <value>The 16 bit record id.</value>
  1715. </member>
  1716. <member name="P:NPOI.DDF.EscherRecord.ChildRecords">
  1717. <summary>
  1718. Gets or sets the child records.
  1719. </summary>
  1720. <value>Returns the children of this record. By default this will
  1721. be an empty list. EscherCotainerRecord is the only record that may contain children.</value>
  1722. </member>
  1723. <member name="M:NPOI.DDF.EscherRecord.Clone">
  1724. <summary>
  1725. Creates a new object that is a copy of the current instance.
  1726. </summary>
  1727. <returns>
  1728. A new object that is a copy of this instance.
  1729. </returns>
  1730. </member>
  1731. <member name="M:NPOI.DDF.EscherRecord.GetChild(System.Int32)">
  1732. <summary>
  1733. Returns the indexed child record.
  1734. </summary>
  1735. <param name="index">The index.</param>
  1736. <returns></returns>
  1737. </member>
  1738. <member name="M:NPOI.DDF.EscherRecord.Display(System.Int32)">
  1739. <summary>
  1740. The display methods allows escher variables to print the record names
  1741. according to their hierarchy.
  1742. </summary>
  1743. <param name="indent">The current indent level.</param>
  1744. </member>
  1745. <member name="P:NPOI.DDF.EscherRecord.RecordName">
  1746. <summary>
  1747. Gets the name of the record.
  1748. </summary>
  1749. <value>The name of the record.</value>
  1750. </member>
  1751. <member name="T:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader">
  1752. <summary>
  1753. This class Reads the standard escher header.
  1754. </summary>
  1755. </member>
  1756. <member name="M:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader.ReadHeader(System.Byte[],System.Int32)">
  1757. <summary>
  1758. Reads the header.
  1759. </summary>
  1760. <param name="data">The data.</param>
  1761. <param name="offset">The off set.</param>
  1762. <returns></returns>
  1763. </member>
  1764. <member name="P:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader.Options">
  1765. <summary>
  1766. Gets the options.
  1767. </summary>
  1768. <value>The options.</value>
  1769. </member>
  1770. <member name="P:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader.RecordId">
  1771. <summary>
  1772. Gets the record id.
  1773. </summary>
  1774. <value>The record id.</value>
  1775. </member>
  1776. <member name="P:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader.RemainingBytes">
  1777. <summary>
  1778. Gets the remaining bytes.
  1779. </summary>
  1780. <value>The remaining bytes.</value>
  1781. </member>
  1782. <member name="M:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader.ToString">
  1783. <summary>
  1784. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1785. </summary>
  1786. <returns>
  1787. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1788. </returns>
  1789. </member>
  1790. <member name="P:NPOI.DDF.EscherRecord.Instance">
  1791. <summary>
  1792. Get or set the instance part of the option record.
  1793. </summary>
  1794. </member>
  1795. <member name="P:NPOI.DDF.EscherRecord.Version">
  1796. <summary>
  1797. Get or set the version part of the option record.
  1798. </summary>
  1799. </member>
  1800. <member name="M:NPOI.DDF.EscherRecord.ToXml(System.String)">
  1801. @param tab - each children must be a right of his parent
  1802. @return xml representation of this record
  1803. </member>
  1804. <member name="T:NPOI.DDF.IEscherRecordFactory">
  1805. <summary>
  1806. The escher record factory interface allows for the creation of escher
  1807. records from a pointer into a data array.
  1808. @author Glen Stampoultzis (glens at apache.org)
  1809. </summary>
  1810. </member>
  1811. <member name="M:NPOI.DDF.IEscherRecordFactory.CreateRecord(System.Byte[],System.Int32)">
  1812. <summary>
  1813. Create a new escher record from the data provided. Does not attempt
  1814. to Fill the contents of the record however.
  1815. </summary>
  1816. <param name="data">The data.</param>
  1817. <param name="offset">The off set.</param>
  1818. <returns></returns>
  1819. </member>
  1820. <member name="T:NPOI.DDF.EscherRGBProperty">
  1821. <summary>
  1822. A color property.
  1823. @author Glen Stampoultzis (glens at apache.org)
  1824. </summary>
  1825. </member>
  1826. <member name="M:NPOI.DDF.EscherRGBProperty.#ctor(System.Int16,System.Int32)">
  1827. <summary>
  1828. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherRGBProperty"/> class.
  1829. </summary>
  1830. <param name="propertyNumber">The property number.</param>
  1831. <param name="rgbColor">Color of the RGB.</param>
  1832. </member>
  1833. <member name="P:NPOI.DDF.EscherRGBProperty.RgbColor">
  1834. <summary>
  1835. Gets the color of the RGB.
  1836. </summary>
  1837. <value>The color of the RGB.</value>
  1838. </member>
  1839. <member name="P:NPOI.DDF.EscherRGBProperty.Red">
  1840. <summary>
  1841. Gets the red.
  1842. </summary>
  1843. <value>The red.</value>
  1844. </member>
  1845. <member name="P:NPOI.DDF.EscherRGBProperty.Green">
  1846. <summary>
  1847. Gets the green.
  1848. </summary>
  1849. <value>The green.</value>
  1850. </member>
  1851. <member name="P:NPOI.DDF.EscherRGBProperty.Blue">
  1852. <summary>
  1853. Gets the blue.
  1854. </summary>
  1855. <value>The blue.</value>
  1856. </member>
  1857. <member name="T:NPOI.DDF.EscherSerializationListener">
  1858. Interface for listening to escher serialization events.
  1859. @author Glen Stampoultzis (glens at apache.org)
  1860. </member>
  1861. <member name="M:NPOI.DDF.EscherSerializationListener.BeforeRecordSerialize(System.Int32,System.Int16,NPOI.DDF.EscherRecord)">
  1862. Fired before a given escher record is Serialized.
  1863. @param offset The position in the data array at which the record will be Serialized.
  1864. @param recordId The id of the record about to be Serialized.
  1865. </member>
  1866. <member name="M:NPOI.DDF.EscherSerializationListener.AfterRecordSerialize(System.Int32,System.Int16,System.Int32,NPOI.DDF.EscherRecord)">
  1867. Fired after a record has been Serialized.
  1868. @param offset The position of the end of the Serialized record + 1
  1869. @param recordId The id of the record about to be Serialized
  1870. @param size The number of bytes written for this record. If it is a container
  1871. record then this will include the size of any included records.
  1872. </member>
  1873. <member name="T:NPOI.DDF.EscherShapePathProperty">
  1874. <summary>
  1875. Defines the constants for the various possible shape paths.
  1876. @author Glen Stampoultzis (glens at apache.org)
  1877. </summary>
  1878. </member>
  1879. <member name="M:NPOI.DDF.EscherShapePathProperty.#ctor(System.Int16,System.Int32)">
  1880. <summary>
  1881. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherShapePathProperty"/> class.
  1882. </summary>
  1883. <param name="propertyNumber">The property number.</param>
  1884. <param name="shapePath">The shape path.</param>
  1885. </member>
  1886. <member name="T:NPOI.DDF.EscherSimpleProperty">
  1887. <summary>
  1888. A simple property is of fixed Length and as a property number in Addition
  1889. to a 32-bit value. Properties that can't be stored in only 32-bits are
  1890. stored as EscherComplexProperty objects.
  1891. @author Glen Stampoultzis (glens at apache.org)
  1892. </summary>
  1893. </member>
  1894. <member name="M:NPOI.DDF.EscherSimpleProperty.#ctor(System.Int16,System.Int32)">
  1895. <summary>
  1896. The id is distinct from the actual property number. The id includes the property number the blip id
  1897. flag and an indicator whether the property is complex or not.
  1898. </summary>
  1899. <param name="id">The id.</param>
  1900. <param name="propertyValue">The property value.</param>
  1901. </member>
  1902. <member name="M:NPOI.DDF.EscherSimpleProperty.#ctor(System.Int16,System.Boolean,System.Boolean,System.Int32)">
  1903. <summary>
  1904. Constructs a new escher property. The three parameters are combined to form a property
  1905. id.
  1906. </summary>
  1907. <param name="propertyNumber">The property number.</param>
  1908. <param name="isComplex">if set to <c>true</c> [is complex].</param>
  1909. <param name="isBlipId">if set to <c>true</c> [is blip id].</param>
  1910. <param name="propertyValue">The property value.</param>
  1911. </member>
  1912. <member name="M:NPOI.DDF.EscherSimpleProperty.SerializeSimplePart(System.Byte[],System.Int32)">
  1913. <summary>
  1914. Serialize the simple part of the escher record.
  1915. </summary>
  1916. <param name="data">The data.</param>
  1917. <param name="offset">The off set.</param>
  1918. <returns>the number of bytes Serialized.</returns>
  1919. </member>
  1920. <member name="M:NPOI.DDF.EscherSimpleProperty.SerializeComplexPart(System.Byte[],System.Int32)">
  1921. <summary>
  1922. Escher properties consist of a simple fixed Length part and a complex variable Length part.
  1923. The fixed Length part is Serialized first.
  1924. </summary>
  1925. <param name="data"></param>
  1926. <param name="pos"></param>
  1927. <returns></returns>
  1928. </member>
  1929. <member name="P:NPOI.DDF.EscherSimpleProperty.PropertyValue">
  1930. <summary>
  1931. Return the 32 bit value of this property.
  1932. </summary>
  1933. <value>The property value.</value>
  1934. </member>
  1935. <member name="M:NPOI.DDF.EscherSimpleProperty.Equals(System.Object)">
  1936. <summary>
  1937. Returns true if one escher property is equal to another.
  1938. </summary>
  1939. <param name="o">The o.</param>
  1940. <returns></returns>
  1941. </member>
  1942. <member name="M:NPOI.DDF.EscherSimpleProperty.GetHashCode">
  1943. <summary>
  1944. Serves as a hash function for a particular type.
  1945. </summary>
  1946. <returns>
  1947. A hash code for the current <see cref="T:System.Object"/>.
  1948. </returns>
  1949. </member>
  1950. <member name="M:NPOI.DDF.EscherSimpleProperty.ToString">
  1951. <summary>
  1952. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1953. </summary>
  1954. <returns>
  1955. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1956. </returns>
  1957. </member>
  1958. <member name="T:NPOI.DDF.EscherSpgrRecord">
  1959. <summary>
  1960. The spgr record defines information about a shape group. Groups in escher
  1961. are simply another form of shape that you can't physically see.
  1962. @author Glen Stampoultzis (glens at apache.org)
  1963. </summary>
  1964. </member>
  1965. <member name="M:NPOI.DDF.EscherSpgrRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  1966. <summary>
  1967. This method deSerializes the record from a byte array.
  1968. </summary>
  1969. <param name="data">The byte array containing the escher record information</param>
  1970. <param name="offset">The starting offset into data</param>
  1971. <param name="recordFactory">May be null since this is not a container record.</param>
  1972. <returns>The number of bytes Read from the byte array.</returns>
  1973. </member>
  1974. <member name="M:NPOI.DDF.EscherSpgrRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  1975. <summary>
  1976. This method Serializes this escher record into a byte array
  1977. </summary>
  1978. <param name="offset">The offset into data
  1979. to start writing the record data to.</param>
  1980. <param name="data">The byte array to Serialize to.</param>
  1981. <param name="listener">a listener for begin and end serialization events.</param>
  1982. <returns>The number of bytes written.</returns>
  1983. </member>
  1984. <member name="P:NPOI.DDF.EscherSpgrRecord.RecordSize">
  1985. <summary>
  1986. Returns the number of bytes that are required to Serialize this record.
  1987. </summary>
  1988. <value>Number of bytes</value>
  1989. </member>
  1990. <member name="P:NPOI.DDF.EscherSpgrRecord.RecordId">
  1991. <summary>
  1992. Return the current record id.
  1993. </summary>
  1994. <value>The 16 bit identifier of this shape group record.</value>
  1995. </member>
  1996. <member name="P:NPOI.DDF.EscherSpgrRecord.RecordName">
  1997. <summary>
  1998. The short name for this record
  1999. </summary>
  2000. <value></value>
  2001. </member>
  2002. <member name="M:NPOI.DDF.EscherSpgrRecord.ToString">
  2003. <summary>
  2004. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2005. </summary>
  2006. <returns>
  2007. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2008. </returns>
  2009. </member>
  2010. <member name="P:NPOI.DDF.EscherSpgrRecord.RectX1">
  2011. <summary>
  2012. Gets or sets the starting top-left coordinate of child records.
  2013. </summary>
  2014. <value>The rect x1.</value>
  2015. </member>
  2016. <member name="P:NPOI.DDF.EscherSpgrRecord.RectX2">
  2017. <summary>
  2018. Gets or sets the starting bottom-right coordinate of child records.
  2019. </summary>
  2020. <value>The rect x2.</value>
  2021. </member>
  2022. <member name="P:NPOI.DDF.EscherSpgrRecord.RectY1">
  2023. <summary>
  2024. Gets or sets the starting top-left coordinate of child records.
  2025. </summary>
  2026. <value>The rect y1.</value>
  2027. </member>
  2028. <member name="P:NPOI.DDF.EscherSpgrRecord.RectY2">
  2029. <summary>
  2030. Gets or sets the starting bottom-right coordinate of child records.
  2031. </summary>
  2032. <value>The rect y2.</value>
  2033. </member>
  2034. <member name="T:NPOI.DDF.EscherSplitMenuColorsRecord">
  2035. <summary>
  2036. A list of the most recently used colours for the drawings contained in
  2037. this document.
  2038. @author Glen Stampoultzis (glens at apache.org)
  2039. </summary>
  2040. </member>
  2041. <member name="M:NPOI.DDF.EscherSplitMenuColorsRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  2042. <summary>
  2043. This method deSerializes the record from a byte array.
  2044. </summary>
  2045. <param name="data">The byte array containing the escher record information</param>
  2046. <param name="offset">The starting offset into data</param>
  2047. <param name="recordFactory">May be null since this is not a container record.</param>
  2048. <returns>The number of bytes Read from the byte array.</returns>
  2049. </member>
  2050. <member name="M:NPOI.DDF.EscherSplitMenuColorsRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  2051. <summary>
  2052. This method Serializes this escher record into a byte array
  2053. </summary>
  2054. <param name="offset">The offset into data
  2055. to start writing the record data to.</param>
  2056. <param name="data">The byte array to Serialize to.</param>
  2057. <param name="listener">a listener for begin and end serialization events.</param>
  2058. <returns>The number of bytes written.</returns>
  2059. </member>
  2060. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.RecordSize">
  2061. <summary>
  2062. Returns the number of bytes that are required to Serialize this record.
  2063. </summary>
  2064. <value>number of bytes</value>
  2065. </member>
  2066. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.RecordId">
  2067. <summary>
  2068. Return the current record id.
  2069. </summary>
  2070. <value>the 16 bit identifer for this record.</value>
  2071. </member>
  2072. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.RecordName">
  2073. <summary>
  2074. Gets the short name for this record
  2075. </summary>
  2076. <value>The name of the record.</value>
  2077. </member>
  2078. <member name="M:NPOI.DDF.EscherSplitMenuColorsRecord.ToString">
  2079. <summary>
  2080. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2081. </summary>
  2082. <returns>
  2083. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2084. </returns>
  2085. @return a string representation of this record.
  2086. </member>
  2087. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.Color1">
  2088. <summary>
  2089. Gets or sets the color1.
  2090. </summary>
  2091. <value>The color1.</value>
  2092. </member>
  2093. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.Color2">
  2094. <summary>
  2095. Gets or sets the color2.
  2096. </summary>
  2097. <value>The color2.</value>
  2098. </member>
  2099. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.Color3">
  2100. <summary>
  2101. Gets or sets the color3.
  2102. </summary>
  2103. <value>The color3.</value>
  2104. </member>
  2105. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.Color4">
  2106. <summary>
  2107. Gets or sets the color4.
  2108. </summary>
  2109. <value>The color4.</value>
  2110. </member>
  2111. <member name="T:NPOI.DDF.EscherSpRecord">
  2112. <summary>
  2113. ToGether the the EscherOptRecord this record defines some of the basic
  2114. properties of a shape.
  2115. @author Glen Stampoultzis (glens at apache.org)
  2116. </summary>
  2117. </member>
  2118. <member name="M:NPOI.DDF.EscherSpRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  2119. <summary>
  2120. The contract of this method is to deSerialize an escher record including
  2121. it's children.
  2122. </summary>
  2123. <param name="data">The byte array containing the Serialized escher
  2124. records.</param>
  2125. <param name="offset">The offset into the byte array.</param>
  2126. <param name="recordFactory">A factory for creating new escher records</param>
  2127. <returns>The number of bytes written.</returns>
  2128. </member>
  2129. <member name="M:NPOI.DDF.EscherSpRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  2130. <summary>
  2131. Serializes to an existing byte array without serialization listener.
  2132. This is done by delegating to Serialize(int, byte[], EscherSerializationListener).
  2133. </summary>
  2134. <param name="offset">the offset within the data byte array.</param>
  2135. <param name="data"> the data array to Serialize to.</param>
  2136. <param name="listener">a listener for begin and end serialization events.</param>
  2137. <returns>The number of bytes written.</returns>
  2138. </member>
  2139. <member name="P:NPOI.DDF.EscherSpRecord.RecordSize">
  2140. <summary>
  2141. Returns the number of bytes that are required to Serialize this record.
  2142. </summary>
  2143. <value>Number of bytes</value>
  2144. </member>
  2145. <member name="P:NPOI.DDF.EscherSpRecord.RecordId">
  2146. <summary>
  2147. @return the 16 bit identifier for this record.
  2148. </summary>
  2149. <value></value>
  2150. </member>
  2151. <member name="P:NPOI.DDF.EscherSpRecord.RecordName">
  2152. <summary>
  2153. The short name for this record
  2154. </summary>
  2155. <value></value>
  2156. </member>
  2157. <member name="M:NPOI.DDF.EscherSpRecord.ToString">
  2158. <summary>
  2159. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2160. </summary>
  2161. <returns>
  2162. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2163. </returns>
  2164. </member>
  2165. <member name="M:NPOI.DDF.EscherSpRecord.DecodeFlags(System.Int32)">
  2166. <summary>
  2167. Converts the shape flags into a more descriptive name.
  2168. </summary>
  2169. <param name="flags">The flags.</param>
  2170. <returns></returns>
  2171. </member>
  2172. <member name="P:NPOI.DDF.EscherSpRecord.ShapeId">
  2173. <summary>
  2174. Gets or sets A number that identifies this shape
  2175. </summary>
  2176. <value>The shape id.</value>
  2177. </member>
  2178. <member name="P:NPOI.DDF.EscherSpRecord.Flags">
  2179. <summary>
  2180. The flags that apply to this shape.
  2181. </summary>
  2182. <value>The flags.</value>
  2183. </member>
  2184. <member name="P:NPOI.DDF.EscherSpRecord.ShapeType">
  2185. <summary>
  2186. Get or set shape type. Must be one of MSOSPT values (see [MS-ODRAW] for details).
  2187. </summary>
  2188. </member>
  2189. <member name="T:NPOI.DDF.EscherTertiaryOptRecord">
  2190. "The OfficeArtTertiaryFOPT record specifies a table of OfficeArtRGFOPTE properties, as defined in section 2.3.1."
  2191. -- [MS-ODRAW] -- v20110608; Office Drawing Binary File Format
  2192. @author Sergey Vladimirov (vlsergey {at} gmail {dot} com)
  2193. </member>
  2194. <member name="T:NPOI.DDF.EscherTextboxRecord">
  2195. <summary>
  2196. Holds data from the parent application. Most commonly used to store
  2197. text in the format of the parent application, rather than in
  2198. Escher format. We don't attempt to understand the contents, since
  2199. they will be in the parent's format, not Escher format.
  2200. @author Glen Stampoultzis (glens at apache.org)
  2201. @author Nick Burch (nick at torchbox dot com)
  2202. </summary>
  2203. </member>
  2204. <member name="F:NPOI.DDF.EscherTextboxRecord._thedata">
  2205. The data for this record not including the the 8 byte header
  2206. </member>
  2207. <member name="M:NPOI.DDF.EscherTextboxRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  2208. This method deserializes the record from a byte array.
  2209. @param data The byte array containing the escher record information
  2210. @param offset The starting offset into <c>data</c>.
  2211. @param recordFactory May be null since this is not a container record.
  2212. @return The number of bytes Read from the byte array.
  2213. </member>
  2214. <member name="M:NPOI.DDF.EscherTextboxRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  2215. <summary>
  2216. Writes this record and any contained records to the supplied byte
  2217. </summary>
  2218. <param name="offset"></param>
  2219. <param name="data"></param>
  2220. <param name="listener">a listener for begin and end serialization events.</param>
  2221. <returns>the number of bytes written.</returns>
  2222. </member>
  2223. <member name="P:NPOI.DDF.EscherTextboxRecord.Data">
  2224. <summary>
  2225. Returns any extra data associated with this record. In practice excel
  2226. does not seem to put anything here, but with PowerPoint this will
  2227. contain the bytes that make up a TextHeaderAtom followed by a
  2228. TextBytesAtom/TextCharsAtom
  2229. </summary>
  2230. <value>The data.</value>
  2231. </member>
  2232. <member name="M:NPOI.DDF.EscherTextboxRecord.SetData(System.Byte[],System.Int32,System.Int32)">
  2233. <summary>
  2234. Sets the extra data (in the parent application's format) to be
  2235. contained by the record. Used when the parent application changes
  2236. the contents.
  2237. </summary>
  2238. <param name="b">The b.</param>
  2239. <param name="start">The start.</param>
  2240. <param name="length">The length.</param>
  2241. </member>
  2242. <member name="M:NPOI.DDF.EscherTextboxRecord.SetData(System.Byte[])">
  2243. <summary>
  2244. Sets the data.
  2245. </summary>
  2246. <param name="b">The b.</param>
  2247. </member>
  2248. <member name="P:NPOI.DDF.EscherTextboxRecord.RecordSize">
  2249. <summary>
  2250. Returns the number of bytes that are required to serialize this record.
  2251. </summary>
  2252. <value>Number of bytes</value>
  2253. </member>
  2254. <member name="P:NPOI.DDF.EscherTextboxRecord.RecordName">
  2255. <summary>
  2256. The short name for this record
  2257. </summary>
  2258. <value></value>
  2259. </member>
  2260. <member name="M:NPOI.DDF.EscherTextboxRecord.ToString">
  2261. <summary>
  2262. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2263. </summary>
  2264. <returns>
  2265. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2266. </returns>
  2267. </member>
  2268. <member name="T:NPOI.DDF.UnknownEscherRecord">
  2269. <summary>
  2270. This record is used whenever a escher record is encountered that
  2271. we do not explicitly support.
  2272. @author Glen Stampoultzis (glens at apache.org)
  2273. </summary>
  2274. </member>
  2275. <member name="F:NPOI.DDF.UnknownEscherRecord._thedata">
  2276. The data for this record not including the the 8 byte header
  2277. </member>
  2278. <member name="M:NPOI.DDF.UnknownEscherRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  2279. <summary>
  2280. This method deSerializes the record from a byte array.
  2281. </summary>
  2282. <param name="data"> The byte array containing the escher record information</param>
  2283. <param name="offset">The starting offset into data </param>
  2284. <param name="recordFactory">May be null since this is not a container record.</param>
  2285. <returns>The number of bytes Read from the byte array.</returns>
  2286. </member>
  2287. <member name="M:NPOI.DDF.UnknownEscherRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  2288. <summary>
  2289. Writes this record and any contained records to the supplied byte
  2290. array.
  2291. </summary>
  2292. <param name="offset"></param>
  2293. <param name="data"></param>
  2294. <param name="listener">a listener for begin and end serialization events.</param>
  2295. <returns>the number of bytes written.</returns>
  2296. </member>
  2297. <member name="P:NPOI.DDF.UnknownEscherRecord.Data">
  2298. <summary>
  2299. Gets the data.
  2300. </summary>
  2301. <value>The data.</value>
  2302. </member>
  2303. <member name="P:NPOI.DDF.UnknownEscherRecord.RecordSize">
  2304. <summary>
  2305. Returns the number of bytes that are required to Serialize this record.
  2306. </summary>
  2307. <value>Number of bytes</value>
  2308. </member>
  2309. <member name="P:NPOI.DDF.UnknownEscherRecord.ChildRecords">
  2310. <summary>
  2311. Returns the children of this record. By default this will
  2312. be an empty list. EscherCotainerRecord is the only record
  2313. that may contain children.
  2314. </summary>
  2315. <value></value>
  2316. </member>
  2317. <member name="P:NPOI.DDF.UnknownEscherRecord.RecordName">
  2318. <summary>
  2319. The short name for this record
  2320. </summary>
  2321. <value></value>
  2322. </member>
  2323. <member name="M:NPOI.DDF.UnknownEscherRecord.ToString">
  2324. <summary>
  2325. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2326. </summary>
  2327. <returns>
  2328. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2329. </returns>
  2330. </member>
  2331. <member name="M:NPOI.DDF.UnknownEscherRecord.AddChildRecord(NPOI.DDF.EscherRecord)">
  2332. <summary>
  2333. Adds the child record.
  2334. </summary>
  2335. <param name="childRecord">The child record.</param>
  2336. </member>
  2337. <member name="T:NPOI.HPSF.CustomProperties">
  2338. <summary>
  2339. Maintains the instances of {@link CustomProperty} that belong To a
  2340. {@link DocumentSummaryInformation}. The class maintains the names of the
  2341. custom properties in a dictionary. It implements the {@link Map} interface
  2342. and by this provides a simplified view on custom properties: A property's
  2343. name is the key that maps To a typed value. This implementation hides
  2344. property IDs from the developer and regards the property names as keys To
  2345. typed values.
  2346. While this class provides a simple API To custom properties, it ignores
  2347. the fact that not names, but IDs are the real keys To properties. Under the
  2348. hood this class maintains a 1:1 relationship between IDs and names. Therefore
  2349. you should not use this class To process property Sets with several IDs
  2350. mapping To the same name or with properties without a name: the result will
  2351. contain only a subSet of the original properties. If you really need To deal
  2352. such property Sets, use HPSF's low-level access methods.
  2353. An application can call the {@link #isPure} method To check whether a
  2354. property Set parsed by {@link CustomProperties} is still pure (i.e.
  2355. unmodified) or whether one or more properties have been dropped.
  2356. This class is not thRead-safe; concurrent access To instances of this
  2357. class must be syncronized.
  2358. @author Rainer Klute
  2359. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  2360. @since 2006-02-09
  2361. </summary>
  2362. </member>
  2363. <member name="F:NPOI.HPSF.CustomProperties.dictionaryIDToName">
  2364. Maps property IDs To property names.
  2365. </member>
  2366. <member name="F:NPOI.HPSF.CustomProperties.dictionaryNameToID">
  2367. Maps property names To property IDs.
  2368. </member>
  2369. <member name="F:NPOI.HPSF.CustomProperties.isPure">
  2370. Tells whether this object is pure or not.
  2371. </member>
  2372. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,NPOI.HPSF.CustomProperty)">
  2373. <summary>
  2374. Puts a {@link CustomProperty} into this map. It is assumed that the
  2375. {@link CustomProperty} alReady has a valid ID. Otherwise use
  2376. {@link #Put(CustomProperty)}.
  2377. </summary>
  2378. <param name="name">The name.</param>
  2379. <param name="cp">The custom property.</param>
  2380. <returns></returns>
  2381. </member>
  2382. <member name="M:NPOI.HPSF.CustomProperties.KeySet">
  2383. Returns a set of all the names of our
  2384. custom properties. Equivalent to
  2385. {@link #nameSet()}
  2386. </member>
  2387. <member name="M:NPOI.HPSF.CustomProperties.NameSet">
  2388. Returns a set of all the names of our
  2389. custom properties
  2390. </member>
  2391. <member name="M:NPOI.HPSF.CustomProperties.IdSet">
  2392. Returns a set of all the IDs of our
  2393. custom properties
  2394. </member>
  2395. <member name="M:NPOI.HPSF.CustomProperties.Put(NPOI.HPSF.CustomProperty)">
  2396. <summary>
  2397. Puts a {@link CustomProperty} that has not yet a valid ID into this
  2398. map. The method will allocate a suitable ID for the custom property:
  2399. <ul>
  2400. <li>If there is alReady a property with the same name, take the ID
  2401. of that property.</li>
  2402. <li>Otherwise Find the highest ID and use its value plus one.</li>
  2403. </ul>
  2404. </summary>
  2405. <param name="customProperty">The custom property.</param>
  2406. <returns>If the was alReady a property with the same name, the</returns>
  2407. </member>
  2408. <member name="M:NPOI.HPSF.CustomProperties.Remove(System.String)">
  2409. <summary>
  2410. Removes a custom property.
  2411. </summary>
  2412. <param name="name">The name of the custom property To Remove</param>
  2413. <returns>The Removed property or
  2414. <c>null</c>
  2415. if the specified property was not found.</returns>
  2416. </member>
  2417. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.String)">
  2418. <summary>
  2419. Adds a named string property.
  2420. </summary>
  2421. <param name="name">The property's name.</param>
  2422. <param name="value">The property's value.</param>
  2423. <returns>the property that was stored under the specified name before, or
  2424. <c>null</c>
  2425. if there was no such property before.</returns>
  2426. </member>
  2427. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.Int64)">
  2428. <summary>
  2429. Adds a named long property
  2430. </summary>
  2431. <param name="name">The property's name.</param>
  2432. <param name="value">The property's value.</param>
  2433. <returns>the property that was stored under the specified name before, or
  2434. <c>null</c>
  2435. if there was no such property before.</returns>
  2436. </member>
  2437. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.Double)">
  2438. <summary>
  2439. Adds a named double property.
  2440. </summary>
  2441. <param name="name">The property's name.</param>
  2442. <param name="value">The property's value.</param>
  2443. <returns>the property that was stored under the specified name before, or
  2444. <c>null</c>
  2445. if there was no such property before.</returns>
  2446. </member>
  2447. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.Int32)">
  2448. <summary>
  2449. Adds a named integer property.
  2450. </summary>
  2451. <param name="name">The property's name.</param>
  2452. <param name="value">The property's value.</param>
  2453. <returns>the property that was stored under the specified name before, or
  2454. <c>null</c>
  2455. if there was no such property before.</returns>
  2456. </member>
  2457. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.Boolean)">
  2458. <summary>
  2459. Adds a named bool property.
  2460. </summary>
  2461. <param name="name">The property's name.</param>
  2462. <param name="value">The property's value.</param>
  2463. <returns>the property that was stored under the specified name before, or
  2464. <c>null</c>
  2465. if there was no such property before.</returns>
  2466. </member>
  2467. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.DateTime)">
  2468. <summary>
  2469. Adds a named date property.
  2470. </summary>
  2471. <param name="name">The property's name.</param>
  2472. <param name="value">The property's value.</param>
  2473. <returns>the property that was stored under the specified name before, or
  2474. <c>null</c>
  2475. if there was no such property before.</returns>
  2476. </member>
  2477. <member name="P:NPOI.HPSF.CustomProperties.Item(System.String)">
  2478. <summary>
  2479. Gets the <see cref="T:System.Object"/> with the specified name.
  2480. </summary>
  2481. <value>the value or
  2482. <c>null</c>
  2483. if a value with the specified
  2484. name is not found in the custom properties.</value>
  2485. </member>
  2486. <member name="M:NPOI.HPSF.CustomProperties.ContainsKey(System.Object)">
  2487. Checks against both String Name and Long ID
  2488. </member>
  2489. <member name="M:NPOI.HPSF.CustomProperties.ContainsValue(System.Object)">
  2490. Checks against both the property, and its values.
  2491. </member>
  2492. <member name="P:NPOI.HPSF.CustomProperties.Dictionary">
  2493. <summary>
  2494. Gets the dictionary which Contains IDs and names of the named custom
  2495. properties.
  2496. </summary>
  2497. <value>The dictionary.</value>
  2498. </member>
  2499. <member name="P:NPOI.HPSF.CustomProperties.Codepage">
  2500. <summary>
  2501. Gets or sets the codepage.
  2502. </summary>
  2503. <value>The codepage.</value>
  2504. </member>
  2505. <member name="P:NPOI.HPSF.CustomProperties.IsPure">
  2506. <summary>
  2507. Tells whether this {@link CustomProperties} instance is pure or one or
  2508. more properties of the underlying low-level property Set has been
  2509. dropped.
  2510. </summary>
  2511. <value><c>true</c> if this instance is pure; otherwise, <c>false</c>.</value>
  2512. </member>
  2513. <member name="T:NPOI.HPSF.CustomProperty">
  2514. <summary>
  2515. This class represents custum properties in the document summary
  2516. information stream. The difference To normal properties is that custom
  2517. properties have an optional name. If the name is not <c>null</c> it
  2518. will be maintained in the section's dictionary.
  2519. @author Rainer Klute
  2520. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  2521. @since 2006-02-09
  2522. </summary>
  2523. </member>
  2524. <member name="M:NPOI.HPSF.CustomProperty.#ctor">
  2525. <summary>
  2526. Initializes a new instance of the <see cref="T:NPOI.HPSF.CustomProperty"/> class.
  2527. </summary>
  2528. </member>
  2529. <member name="M:NPOI.HPSF.CustomProperty.#ctor(NPOI.HPSF.Property)">
  2530. <summary>
  2531. Initializes a new instance of the <see cref="T:NPOI.HPSF.CustomProperty"/> class.
  2532. </summary>
  2533. <param name="property">the property To copy</param>
  2534. </member>
  2535. <member name="M:NPOI.HPSF.CustomProperty.#ctor(NPOI.HPSF.Property,System.String)">
  2536. <summary>
  2537. Initializes a new instance of the <see cref="T:NPOI.HPSF.CustomProperty"/> class.
  2538. </summary>
  2539. <param name="property">This property's attributes are copied To the new custom
  2540. property.</param>
  2541. <param name="name">The new custom property's name.</param>
  2542. </member>
  2543. <member name="P:NPOI.HPSF.CustomProperty.Name">
  2544. <summary>
  2545. Gets or sets the property's name.
  2546. </summary>
  2547. <value>the property's name.</value>
  2548. </member>
  2549. <member name="M:NPOI.HPSF.CustomProperty.EqualsContents(System.Object)">
  2550. <summary>
  2551. Compares two custom properties for equality. The method returns
  2552. <c>true</c> if all attributes of the two custom properties are
  2553. equal.
  2554. </summary>
  2555. <param name="o">The custom property To Compare with.</param>
  2556. <returns><c>true</c>
  2557. if both custom properties are equal, else
  2558. <c>false</c></returns>
  2559. </member>
  2560. <member name="M:NPOI.HPSF.CustomProperty.GetHashCode">
  2561. <summary>
  2562. </summary>
  2563. <returns></returns>
  2564. @see Object#GetHashCode()
  2565. </member>
  2566. <member name="T:NPOI.HPSF.DocumentSummaryInformation">
  2567. <summary>
  2568. Convenience class representing a DocumentSummary Information stream in a
  2569. Microsoft Office document.
  2570. @author Rainer Klute
  2571. klute@rainer-klute.de
  2572. @author Drew Varner (Drew.Varner cloSeto sc.edu)
  2573. @author robert_flaherty@hyperion.com
  2574. @since 2002-02-09
  2575. </summary>
  2576. </member>
  2577. <member name="F:NPOI.HPSF.DocumentSummaryInformation.DEFAULT_STREAM_NAME">
  2578. The document name a document summary information stream
  2579. usually has in a POIFS filesystem.
  2580. </member>
  2581. <member name="M:NPOI.HPSF.DocumentSummaryInformation.#ctor(NPOI.HPSF.PropertySet)">
  2582. <summary>
  2583. Initializes a new instance of the <see cref="T:NPOI.HPSF.DocumentSummaryInformation"/> class.
  2584. </summary>
  2585. <param name="ps">A property Set which should be Created from a
  2586. document summary information stream.</param>
  2587. </member>
  2588. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Category">
  2589. <summary>
  2590. Gets or sets the category.
  2591. </summary>
  2592. <value>The category value</value>
  2593. </member>
  2594. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveCategory">
  2595. <summary>
  2596. Removes the category.
  2597. </summary>
  2598. </member>
  2599. <member name="P:NPOI.HPSF.DocumentSummaryInformation.PresentationFormat">
  2600. <summary>
  2601. Gets or sets the presentation format (or null).
  2602. </summary>
  2603. <value>The presentation format value</value>
  2604. </member>
  2605. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemovePresentationFormat">
  2606. <summary>
  2607. Removes the presentation format.
  2608. </summary>
  2609. </member>
  2610. <member name="P:NPOI.HPSF.DocumentSummaryInformation.ByteCount">
  2611. <summary>
  2612. Gets or sets the byte count or 0 if the {@link
  2613. DocumentSummaryInformation} does not contain a byte count.
  2614. </summary>
  2615. <value>The byteCount value</value>
  2616. </member>
  2617. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveByteCount">
  2618. <summary>
  2619. Removes the byte count.
  2620. </summary>
  2621. </member>
  2622. <member name="P:NPOI.HPSF.DocumentSummaryInformation.LineCount">
  2623. <summary>
  2624. Gets or sets the line count or 0 if the {@link
  2625. DocumentSummaryInformation} does not contain a line count.
  2626. </summary>
  2627. <value>The line count value.</value>
  2628. </member>
  2629. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveLineCount">
  2630. <summary>
  2631. Removes the line count.
  2632. </summary>
  2633. </member>
  2634. <member name="P:NPOI.HPSF.DocumentSummaryInformation.ParCount">
  2635. <summary>
  2636. Gets or sets the par count or 0 if the {@link
  2637. DocumentSummaryInformation} does not contain a par count.
  2638. </summary>
  2639. <value>The par count value</value>
  2640. </member>
  2641. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveParCount">
  2642. <summary>
  2643. Removes the par count.
  2644. </summary>
  2645. </member>
  2646. <member name="P:NPOI.HPSF.DocumentSummaryInformation.SlideCount">
  2647. <summary>
  2648. Gets or sets the slide count or 0 if the {@link
  2649. DocumentSummaryInformation} does not contain a slide count.
  2650. </summary>
  2651. <value>The slide count value</value>
  2652. </member>
  2653. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveSlideCount">
  2654. <summary>
  2655. Removes the slide count.
  2656. </summary>
  2657. </member>
  2658. <member name="P:NPOI.HPSF.DocumentSummaryInformation.NoteCount">
  2659. <summary>
  2660. Gets or sets the note count or 0 if the {@link
  2661. DocumentSummaryInformation} does not contain a note count
  2662. </summary>
  2663. <value>The note count value</value>
  2664. </member>
  2665. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveNoteCount">
  2666. <summary>
  2667. Removes the note count.
  2668. </summary>
  2669. </member>
  2670. <member name="P:NPOI.HPSF.DocumentSummaryInformation.HiddenCount">
  2671. <summary>
  2672. Gets or sets the hidden count or 0 if the {@link
  2673. DocumentSummaryInformation} does not contain a hidden
  2674. count.
  2675. </summary>
  2676. <value>The hidden count value.</value>
  2677. </member>
  2678. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveHiddenCount">
  2679. <summary>
  2680. Removes the hidden count.
  2681. </summary>
  2682. </member>
  2683. <member name="P:NPOI.HPSF.DocumentSummaryInformation.MMClipCount">
  2684. <summary>
  2685. Returns the mmclip count or 0 if the {@link
  2686. DocumentSummaryInformation} does not contain a mmclip
  2687. count.
  2688. </summary>
  2689. <value>The mmclip count value.</value>
  2690. </member>
  2691. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveMMClipCount">
  2692. <summary>
  2693. Removes the MMClip count.
  2694. </summary>
  2695. </member>
  2696. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Scale">
  2697. <summary>
  2698. Gets or sets a value indicating whether this <see cref="T:NPOI.HPSF.DocumentSummaryInformation"/> is scale.
  2699. </summary>
  2700. <value><c>true</c> if cropping is desired; otherwise, <c>false</c>.</value>
  2701. </member>
  2702. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveScale">
  2703. <summary>
  2704. Removes the scale.
  2705. </summary>
  2706. </member>
  2707. <member name="P:NPOI.HPSF.DocumentSummaryInformation.HeadingPair">
  2708. <summary>
  2709. Gets or sets the heading pair (or null)
  2710. </summary>
  2711. <value>The heading pair value.</value>
  2712. </member>
  2713. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveHeadingPair">
  2714. <summary>
  2715. Removes the heading pair.
  2716. </summary>
  2717. </member>
  2718. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Docparts">
  2719. <summary>
  2720. Gets or sets the doc parts.
  2721. </summary>
  2722. <value>The doc parts value</value>
  2723. </member>
  2724. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveDocparts">
  2725. <summary>
  2726. Removes the doc parts.
  2727. </summary>
  2728. </member>
  2729. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Manager">
  2730. <summary>
  2731. Gets or sets the manager (or <c>null</c>).
  2732. </summary>
  2733. <value>The manager value</value>
  2734. </member>
  2735. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveManager">
  2736. <summary>
  2737. Removes the manager.
  2738. </summary>
  2739. </member>
  2740. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Company">
  2741. <summary>
  2742. Gets or sets the company (or <c>null</c>).
  2743. </summary>
  2744. <value>The company value</value>
  2745. </member>
  2746. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveCompany">
  2747. <summary>
  2748. Removes the company.
  2749. </summary>
  2750. </member>
  2751. <member name="P:NPOI.HPSF.DocumentSummaryInformation.LinksDirty">
  2752. <summary>
  2753. Gets or sets a value indicating whether [links dirty].
  2754. </summary>
  2755. <value><c>true</c> if the custom links are dirty.; otherwise, <c>false</c>.</value>
  2756. </member>
  2757. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveLinksDirty">
  2758. <summary>
  2759. Removes the links dirty.
  2760. </summary>
  2761. </member>
  2762. <member name="P:NPOI.HPSF.DocumentSummaryInformation.CharCountWithSpaces">
  2763. <p>Returns the character count including whitespace, or 0 if the
  2764. {@link DocumentSummaryInformation} does not contain this char count.</p>
  2765. This is the whitespace-including version of {@link SummaryInformation#getCharCount()}
  2766. @return The character count or <code>null</code>
  2767. </member>
  2768. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveCharCountWithSpaces">
  2769. Removes the character count
  2770. </member>
  2771. <member name="P:NPOI.HPSF.DocumentSummaryInformation.HyperlinksChanged">
  2772. <p>Get if the User Defined Property Set has been updated outside of the
  2773. Application.</p>
  2774. <p>If it has (true), the hyperlinks should be updated on document load.</p>
  2775. </member>
  2776. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveHyperlinksChanged">
  2777. Removes the flag for if the User Defined Property Set has been updated
  2778. outside of the Application.
  2779. </member>
  2780. <member name="P:NPOI.HPSF.DocumentSummaryInformation.ApplicationVersion">
  2781. <p>Gets the version of the Application which wrote the
  2782. Property set, stored with the two high order bytes having the major
  2783. version number, and the two low order bytes the minor version number.</p>
  2784. <p>This will be 0 if no version is set.</p>
  2785. </member>
  2786. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveApplicationVersion">
  2787. Removes the Application Version
  2788. </member>
  2789. <member name="P:NPOI.HPSF.DocumentSummaryInformation.VBADigitalSignature">
  2790. <p>Returns the VBA digital signature for the VBA project
  2791. embedded in the document (or <code>null</code>).</p>
  2792. </member>
  2793. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveVBADigitalSignature">
  2794. Removes the VBA Digital Signature
  2795. </member>
  2796. <member name="P:NPOI.HPSF.DocumentSummaryInformation.ContentType">
  2797. <p>Gets the content type of the file (or <code>null</code>).</p>
  2798. </member>
  2799. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveContentType">
  2800. Removes the content type of the file
  2801. </member>
  2802. <member name="P:NPOI.HPSF.DocumentSummaryInformation.ContentStatus">
  2803. <p>Gets the content status of the file (or <code>null</code>).</p>
  2804. </member>
  2805. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveContentStatus">
  2806. Removes the content status of the file
  2807. </member>
  2808. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Language">
  2809. <p>Gets the document language, which is normally unset and empty
  2810. (or <code>null</code>).</p>
  2811. </member>
  2812. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveLanguage">
  2813. Removes the document language
  2814. </member>
  2815. <member name="P:NPOI.HPSF.DocumentSummaryInformation.DocumentVersion">
  2816. <p>Gets the document version as a string, which is normally unset and empty
  2817. (or <code>null</code>).</p>
  2818. </member>
  2819. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveDocumentVersion">
  2820. Removes the document version string
  2821. </member>
  2822. <member name="P:NPOI.HPSF.DocumentSummaryInformation.CustomProperties">
  2823. <summary>
  2824. Gets or sets the custom properties.
  2825. </summary>
  2826. <value>The custom properties.</value>
  2827. </member>
  2828. <member name="M:NPOI.HPSF.DocumentSummaryInformation.EnsureSection2">
  2829. <summary>
  2830. Creates section 2 if it is not alReady present.
  2831. </summary>
  2832. </member>
  2833. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveCustomProperties">
  2834. <summary>
  2835. Removes the custom properties.
  2836. </summary>
  2837. </member>
  2838. <member name="T:NPOI.HPSF.Extractor.HPSFPropertiesExtractor">
  2839. <summary>
  2840. Extracts all of the HPSF properties, both
  2841. build in and custom, returning them in
  2842. textual form.
  2843. </summary>
  2844. </member>
  2845. <member name="P:NPOI.HPSF.Extractor.HPSFPropertiesExtractor.DocumentSummaryInformationText">
  2846. <summary>
  2847. Gets the document summary information text.
  2848. </summary>
  2849. <value>The document summary information text.</value>
  2850. </member>
  2851. <member name="P:NPOI.HPSF.Extractor.HPSFPropertiesExtractor.SummaryInformationText">
  2852. <summary>
  2853. Gets the summary information text.
  2854. </summary>
  2855. <value>The summary information text.</value>
  2856. </member>
  2857. <member name="M:NPOI.HPSF.Extractor.HPSFPropertiesExtractor.GetPropertiesText(NPOI.HPSF.SpecialPropertySet)">
  2858. <summary>
  2859. Gets the properties text.
  2860. </summary>
  2861. <param name="ps">The ps.</param>
  2862. <returns></returns>
  2863. </member>
  2864. <member name="P:NPOI.HPSF.Extractor.HPSFPropertiesExtractor.Text">
  2865. <summary>
  2866. Return the text of all the properties defined in
  2867. the document.
  2868. </summary>
  2869. <value>All the text from the document.</value>
  2870. </member>
  2871. <member name="P:NPOI.HPSF.Extractor.HPSFPropertiesExtractor.MetadataTextExtractor">
  2872. <summary>
  2873. Returns another text extractor, which is able to
  2874. output the textual content of the document
  2875. metadata / properties, such as author and title.
  2876. </summary>
  2877. <value>The metadata text extractor.</value>
  2878. </member>
  2879. <member name="T:NPOI.HPSF.HPSFException">
  2880. <summary>
  2881. This exception is the superclass of all other checked exceptions thrown
  2882. in this package. It supports a nested "reason" throwable, i.e. an exception
  2883. that caused this one To be thrown.
  2884. @author Rainer Klute
  2885. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  2886. @since 2002-02-09
  2887. </summary>
  2888. </member>
  2889. <member name="M:NPOI.HPSF.HPSFException.#ctor">
  2890. <summary>
  2891. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFException"/> class.
  2892. </summary>
  2893. </member>
  2894. <member name="M:NPOI.HPSF.HPSFException.#ctor(System.String)">
  2895. <summary>
  2896. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFException"/> class.
  2897. </summary>
  2898. <param name="msg">The message string.</param>
  2899. </member>
  2900. <member name="M:NPOI.HPSF.HPSFException.#ctor(System.Exception)">
  2901. <summary>
  2902. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFException"/> class.
  2903. </summary>
  2904. <param name="reason">The reason, i.e. a throwable that indirectly
  2905. caused this exception.</param>
  2906. </member>
  2907. <member name="M:NPOI.HPSF.HPSFException.#ctor(System.String,System.Exception)">
  2908. <summary>
  2909. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFException"/> class.
  2910. </summary>
  2911. <param name="msg">The message string.</param>
  2912. <param name="reason">The reason, i.e. a throwable that indirectly
  2913. caused this exception.</param>
  2914. </member>
  2915. <member name="P:NPOI.HPSF.HPSFException.Reason">
  2916. <summary>
  2917. Returns the {@link Exception} that caused this exception To
  2918. be thrown or null if there was no such {@link
  2919. Exception}.
  2920. </summary>
  2921. <value>The reason.</value>
  2922. </member>
  2923. <member name="T:NPOI.HPSF.HPSFPropertiesOnlyDocument">
  2924. A version of {@link POIDocument} which allows access to the
  2925. HPSF Properties, but no other document contents.
  2926. Normally used when you want to read or alter the Document Properties,
  2927. without affecting the rest of the file
  2928. </member>
  2929. <member name="M:NPOI.HPSF.HPSFPropertiesOnlyDocument.Write">
  2930. Write out to the currently open file the properties changes, but nothing else
  2931. </member>
  2932. <member name="M:NPOI.HPSF.HPSFPropertiesOnlyDocument.Write(System.IO.FileInfo)">
  2933. Write out, with any properties changes, but nothing else
  2934. </member>
  2935. <member name="M:NPOI.HPSF.HPSFPropertiesOnlyDocument.Write(System.IO.Stream)">
  2936. Write out, with any properties changes, but nothing else
  2937. </member>
  2938. <member name="T:NPOI.HPSF.HPSFRuntimeException">
  2939. <summary>
  2940. This exception is the superclass of all other unchecked
  2941. exceptions thrown in this package. It supports a nested "reason"
  2942. throwable, i.e. an exception that caused this one To be thrown.
  2943. @author Rainer Klute
  2944. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  2945. @since 2002-02-09
  2946. </summary>
  2947. </member>
  2948. <member name="M:NPOI.HPSF.HPSFRuntimeException.#ctor">
  2949. <summary>
  2950. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFRuntimeException"/> class.
  2951. </summary>
  2952. </member>
  2953. <member name="M:NPOI.HPSF.HPSFRuntimeException.#ctor(System.String)">
  2954. <summary>
  2955. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFRuntimeException"/> class.
  2956. </summary>
  2957. <param name="msg">The message string.</param>
  2958. </member>
  2959. <member name="M:NPOI.HPSF.HPSFRuntimeException.#ctor(System.Exception)">
  2960. <summary>
  2961. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFRuntimeException"/> class.
  2962. </summary>
  2963. <param name="reason">The reason, i.e. a throwable that indirectly
  2964. caused this exception.</param>
  2965. </member>
  2966. <member name="M:NPOI.HPSF.HPSFRuntimeException.#ctor(System.String,System.Exception)">
  2967. <summary>
  2968. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFRuntimeException"/> class.
  2969. </summary>
  2970. <param name="msg">The message string.</param>
  2971. <param name="reason">The reason, i.e. a throwable that indirectly
  2972. caused this exception.</param>
  2973. </member>
  2974. <member name="T:NPOI.HPSF.IllegalPropertySetDataException">
  2975. <summary>
  2976. This exception is thrown when there is an illegal value Set in a
  2977. {@link PropertySet}. For example, a {@link Variant#VT_BOOL} must
  2978. have a value of <c>-1 (true)</c> or <c>0 (false)</c>.
  2979. Any other value would trigger this exception. It supports a nested
  2980. "reason" throwable, i.e. an exception that caused this one To be
  2981. thrown.
  2982. @author Drew Varner(Drew.Varner atDomain sc.edu)
  2983. @since 2002-05-26
  2984. </summary>
  2985. </member>
  2986. <member name="M:NPOI.HPSF.IllegalPropertySetDataException.#ctor">
  2987. <summary>
  2988. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalPropertySetDataException"/> class.
  2989. </summary>
  2990. </member>
  2991. <member name="M:NPOI.HPSF.IllegalPropertySetDataException.#ctor(System.String)">
  2992. <summary>
  2993. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalPropertySetDataException"/> class.
  2994. </summary>
  2995. <param name="msg">The exception's message string</param>
  2996. </member>
  2997. <member name="M:NPOI.HPSF.IllegalPropertySetDataException.#ctor(System.Exception)">
  2998. <summary>
  2999. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalPropertySetDataException"/> class.
  3000. </summary>
  3001. <param name="reason">This exception's underlying reason</param>
  3002. </member>
  3003. <member name="M:NPOI.HPSF.IllegalPropertySetDataException.#ctor(System.String,System.Exception)">
  3004. <summary>
  3005. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalPropertySetDataException"/> class.
  3006. </summary>
  3007. <param name="msg"> The exception's message string</param>
  3008. <param name="reason">This exception's underlying reason</param>
  3009. </member>
  3010. <member name="T:NPOI.HPSF.IllegalVariantTypeException">
  3011. <summary>
  3012. This exception is thrown if HPSF encounters a variant type that is illegal
  3013. in the current context.
  3014. @author Rainer Klute
  3015. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3016. @since 2004-06-21
  3017. </summary>
  3018. </member>
  3019. <member name="M:NPOI.HPSF.IllegalVariantTypeException.#ctor(System.Int64,System.Object,System.String)">
  3020. <summary>
  3021. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalVariantTypeException"/> class.
  3022. </summary>
  3023. <param name="variantType">The unsupported variant type</param>
  3024. <param name="value">The value</param>
  3025. <param name="msg">A message string</param>
  3026. </member>
  3027. <member name="M:NPOI.HPSF.IllegalVariantTypeException.#ctor(System.Int64,System.Object)">
  3028. <summary>
  3029. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalVariantTypeException"/> class.
  3030. </summary>
  3031. <param name="variantType">The unsupported variant type</param>
  3032. <param name="value">The value.</param>
  3033. </member>
  3034. <member name="T:NPOI.HPSF.MarkUnsupportedException">
  3035. <summary>
  3036. This exception is thrown if an {@link java.io.InputStream} does
  3037. not support the {@link java.io.InputStream#mark} operation.
  3038. @author Rainer Klute
  3039. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3040. @since 2002-02-09
  3041. </summary>
  3042. </member>
  3043. <member name="M:NPOI.HPSF.MarkUnsupportedException.#ctor">
  3044. <summary>
  3045. Initializes a new instance of the <see cref="T:NPOI.HPSF.MarkUnsupportedException"/> class.
  3046. </summary>
  3047. </member>
  3048. <member name="M:NPOI.HPSF.MarkUnsupportedException.#ctor(System.String)">
  3049. <summary>
  3050. Initializes a new instance of the <see cref="T:NPOI.HPSF.MarkUnsupportedException"/> class.
  3051. </summary>
  3052. <param name="msg">The exception's message string.</param>
  3053. </member>
  3054. <member name="M:NPOI.HPSF.MarkUnsupportedException.#ctor(System.Exception)">
  3055. <summary>
  3056. Initializes a new instance of the <see cref="T:NPOI.HPSF.MarkUnsupportedException"/> class.
  3057. </summary>
  3058. <param name="reason">This exception's underlying reason.</param>
  3059. </member>
  3060. <member name="M:NPOI.HPSF.MarkUnsupportedException.#ctor(System.String,System.Exception)">
  3061. <summary>
  3062. Initializes a new instance of the <see cref="T:NPOI.HPSF.MarkUnsupportedException"/> class.
  3063. </summary>
  3064. <param name="msg">The exception's message string</param>
  3065. <param name="reason">This exception's underlying reason</param>
  3066. </member>
  3067. <member name="T:NPOI.HPSF.MissingSectionException">
  3068. <summary>
  3069. This exception is thrown if one of the {@link PropertySet}'s
  3070. convenience methods does not Find a required {@link Section}.
  3071. The constructors of this class are analogous To those of its
  3072. superclass and documented there.
  3073. @author Rainer Klute
  3074. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3075. @since 2006-02-08
  3076. </summary>
  3077. </member>
  3078. <member name="M:NPOI.HPSF.MissingSectionException.#ctor">
  3079. <summary>
  3080. Initializes a new instance of the <see cref="T:NPOI.HPSF.MissingSectionException"/> class.
  3081. </summary>
  3082. </member>
  3083. <member name="M:NPOI.HPSF.MissingSectionException.#ctor(System.String)">
  3084. <summary>
  3085. Initializes a new instance of the <see cref="T:NPOI.HPSF.MissingSectionException"/> class.
  3086. </summary>
  3087. <param name="msg">The exception's message string</param>
  3088. </member>
  3089. <member name="M:NPOI.HPSF.MissingSectionException.#ctor(System.Exception)">
  3090. <summary>
  3091. Initializes a new instance of the <see cref="T:NPOI.HPSF.MissingSectionException"/> class.
  3092. </summary>
  3093. <param name="reason">This exception's underlying reason.</param>
  3094. </member>
  3095. <member name="M:NPOI.HPSF.MissingSectionException.#ctor(System.String,System.Exception)">
  3096. <summary>
  3097. Initializes a new instance of the <see cref="T:NPOI.HPSF.MissingSectionException"/> class.
  3098. </summary>
  3099. <param name="msg">The exception's message string</param>
  3100. <param name="reason">This exception's underlying reason</param>
  3101. </member>
  3102. <member name="T:NPOI.HPSF.MutableProperty">
  3103. <summary>
  3104. Adds writing capability To the {@link Property} class.
  3105. Please be aware that this class' functionality will be merged into the
  3106. {@link Property} class at a later time, so the API will Change.
  3107. @author Rainer Klute
  3108. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3109. @since 2003-08-03
  3110. </summary>
  3111. </member>
  3112. <member name="M:NPOI.HPSF.MutableProperty.#ctor">
  3113. <summary>
  3114. Creates an empty property. It must be Filled using the Set method To
  3115. be usable.
  3116. </summary>
  3117. </member>
  3118. <member name="M:NPOI.HPSF.MutableProperty.#ctor(NPOI.HPSF.Property)">
  3119. <summary>
  3120. Initializes a new instance of the <see cref="T:NPOI.HPSF.MutableProperty"/> class.
  3121. </summary>
  3122. <param name="p">The property To copy.</param>
  3123. </member>
  3124. <member name="M:NPOI.HPSF.MutableProperty.Write(System.IO.Stream,System.Int32)">
  3125. <summary>
  3126. Writes the property To an output stream.
  3127. </summary>
  3128. <param name="out1">The output stream To Write To.</param>
  3129. <param name="codepage">The codepage To use for writing non-wide strings</param>
  3130. <returns>the number of bytes written To the stream</returns>
  3131. </member>
  3132. <member name="T:NPOI.HPSF.MutablePropertySet">
  3133. <summary>
  3134. Adds writing support To the {@link PropertySet} class.
  3135. Please be aware that this class' functionality will be merged into the
  3136. {@link PropertySet} class at a later time, so the API will Change.
  3137. @author Rainer Klute
  3138. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3139. @since 2003-02-19
  3140. </summary>
  3141. </member>
  3142. <member name="M:NPOI.HPSF.MutablePropertySet.#ctor">
  3143. <summary>
  3144. Initializes a new instance of the <see cref="T:NPOI.HPSF.MutablePropertySet"/> class.
  3145. Its primary task is To initialize the immutable field with their proper
  3146. values. It also Sets fields that might Change To reasonable defaults.
  3147. </summary>
  3148. </member>
  3149. <member name="M:NPOI.HPSF.MutablePropertySet.#ctor(NPOI.HPSF.PropertySet)">
  3150. <summary>
  3151. Initializes a new instance of the <see cref="T:NPOI.HPSF.MutablePropertySet"/> class.
  3152. All nested elements, i.e.<c>Section</c>s and <c>Property</c> instances, will be their
  3153. mutable counterparts in the new <c>MutablePropertySet</c>.
  3154. </summary>
  3155. <param name="ps">The property Set To copy</param>
  3156. </member>
  3157. <member name="F:NPOI.HPSF.MutablePropertySet.OFFSET_HEADER">
  3158. The Length of the property Set stream header.
  3159. </member>
  3160. <member name="P:NPOI.HPSF.MutablePropertySet.ByteOrder">
  3161. <summary>
  3162. Gets or sets the "byteOrder" property.
  3163. </summary>
  3164. <value>the byteOrder value To Set</value>
  3165. </member>
  3166. <member name="P:NPOI.HPSF.MutablePropertySet.Format">
  3167. <summary>
  3168. Gets or sets the "format" property.
  3169. </summary>
  3170. <value>the format value To Set</value>
  3171. </member>
  3172. <member name="P:NPOI.HPSF.MutablePropertySet.OSVersion">
  3173. <summary>
  3174. Gets or sets the "osVersion" property
  3175. </summary>
  3176. <value>the osVersion value To Set.</value>
  3177. </member>
  3178. <member name="P:NPOI.HPSF.MutablePropertySet.ClassID">
  3179. <summary>
  3180. Gets or sets the property Set stream's low-level "class ID"
  3181. </summary>
  3182. <value>The property Set stream's low-level "class ID" field.</value>
  3183. </member>
  3184. <member name="M:NPOI.HPSF.MutablePropertySet.ClearSections">
  3185. <summary>
  3186. Removes all sections from this property Set.
  3187. </summary>
  3188. </member>
  3189. <member name="M:NPOI.HPSF.MutablePropertySet.AddSection(NPOI.HPSF.Section)">
  3190. <summary>
  3191. Adds a section To this property Set.
  3192. </summary>
  3193. <param name="section">section The {@link Section} To Add. It will be Appended
  3194. after any sections that are alReady present in the property Set
  3195. and thus become the last section.</param>
  3196. </member>
  3197. <member name="M:NPOI.HPSF.MutablePropertySet.Write(System.IO.Stream)">
  3198. <summary>
  3199. Writes the property Set To an output stream.
  3200. </summary>
  3201. <param name="out1">the output stream To Write the section To</param>
  3202. </member>
  3203. <member name="M:NPOI.HPSF.MutablePropertySet.ToInputStream">
  3204. <summary>
  3205. Returns the contents of this property set stream as an input stream.
  3206. The latter can be used for example to write the property set into a POIFS
  3207. document. The input stream represents a snapshot of the property set.
  3208. If the latter is modified while the input stream is still being
  3209. read, the modifications will not be reflected in the input stream but in
  3210. the {@link MutablePropertySet} only.
  3211. </summary>
  3212. <returns>the contents of this property set stream</returns>
  3213. </member>
  3214. <member name="M:NPOI.HPSF.MutablePropertySet.Write(NPOI.POIFS.FileSystem.DirectoryEntry,System.String)">
  3215. <summary>
  3216. Writes a property Set To a document in a POI filesystem directory
  3217. </summary>
  3218. <param name="dir">The directory in the POI filesystem To Write the document To.</param>
  3219. <param name="name">The document's name. If there is alReady a document with the
  3220. same name in the directory the latter will be overwritten.</param>
  3221. </member>
  3222. <member name="T:NPOI.HPSF.MutableSection">
  3223. <summary>
  3224. Adds writing capability To the {@link Section} class.
  3225. Please be aware that this class' functionality will be merged into the
  3226. {@link Section} class at a later time, so the API will Change.
  3227. @since 2002-02-20
  3228. </summary>
  3229. </member>
  3230. <member name="F:NPOI.HPSF.MutableSection.dirty">
  3231. If the "dirty" flag is true, the section's size must be
  3232. (re-)calculated before the section is written.
  3233. </member>
  3234. <member name="F:NPOI.HPSF.MutableSection.preprops">
  3235. List To assemble the properties. Unfortunately a wrong
  3236. decision has been taken when specifying the "properties" field
  3237. as an Property[]. It should have been a {@link java.util.List}.
  3238. </member>
  3239. <member name="F:NPOI.HPSF.MutableSection.sectionBytes">
  3240. Contains the bytes making out the section. This byte array is
  3241. established when the section's size is calculated and can be reused
  3242. later. It is valid only if the "dirty" flag is false.
  3243. </member>
  3244. <member name="M:NPOI.HPSF.MutableSection.#ctor">
  3245. <summary>
  3246. Initializes a new instance of the <see cref="T:NPOI.HPSF.MutableSection"/> class.
  3247. </summary>
  3248. </member>
  3249. <member name="M:NPOI.HPSF.MutableSection.#ctor(NPOI.HPSF.Section)">
  3250. <summary>
  3251. Constructs a <c>MutableSection</c> by doing a deep copy of an
  3252. existing <c>Section</c>. All nested <c>Property</c>
  3253. instances, will be their mutable counterparts in the new
  3254. <c>MutableSection</c>.
  3255. </summary>
  3256. <param name="s">The section Set To copy</param>
  3257. </member>
  3258. <member name="M:NPOI.HPSF.MutableSection.SetFormatID(NPOI.Util.ClassID)">
  3259. <summary>
  3260. Sets the section's format ID.
  3261. </summary>
  3262. <param name="formatID">The section's format ID</param>
  3263. </member>
  3264. <member name="M:NPOI.HPSF.MutableSection.SetFormatID(System.Byte[])">
  3265. <summary>
  3266. Sets the section's format ID.
  3267. </summary>
  3268. <param name="formatID">The section's format ID as a byte array. It components
  3269. are in big-endian format.</param>
  3270. </member>
  3271. <member name="M:NPOI.HPSF.MutableSection.SetProperties(NPOI.HPSF.Property[])">
  3272. <summary>
  3273. Sets this section's properties. Any former values are overwritten.
  3274. </summary>
  3275. <param name="properties">This section's new properties.</param>
  3276. </member>
  3277. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.String)">
  3278. <summary>
  3279. Sets the string value of the property with the specified ID.
  3280. </summary>
  3281. <param name="id">The property's ID</param>
  3282. <param name="value">The property's value. It will be written as a Unicode
  3283. string.</param>
  3284. </member>
  3285. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Int32)">
  3286. <summary>
  3287. Sets the int value of the property with the specified ID.
  3288. </summary>
  3289. <param name="id">The property's ID</param>
  3290. <param name="value">The property's value.</param>
  3291. </member>
  3292. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Int64)">
  3293. <summary>
  3294. Sets the long value of the property with the specified ID.
  3295. </summary>
  3296. <param name="id">The property's ID</param>
  3297. <param name="value">The property's value.</param>
  3298. </member>
  3299. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Boolean)">
  3300. <summary>
  3301. Sets the bool value of the property with the specified ID.
  3302. </summary>
  3303. <param name="id">The property's ID</param>
  3304. <param name="value">The property's value.</param>
  3305. </member>
  3306. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Int64,System.Object)">
  3307. <summary>
  3308. Sets the value and the variant type of the property with the
  3309. specified ID. If a property with this ID is not yet present in
  3310. the section, it will be Added. An alReady present property with
  3311. the specified ID will be overwritten. A default mapping will be
  3312. used To choose the property's type.
  3313. </summary>
  3314. <param name="id">The property's ID.</param>
  3315. <param name="variantType">The property's variant type.</param>
  3316. <param name="value">The property's value.</param>
  3317. </member>
  3318. <member name="M:NPOI.HPSF.MutableSection.SetProperty(NPOI.HPSF.Property)">
  3319. <summary>
  3320. Sets the property.
  3321. </summary>
  3322. <param name="p">The property To be Set.</param>
  3323. </member>
  3324. <member name="M:NPOI.HPSF.MutableSection.RemoveProperty(System.Int64)">
  3325. <summary>
  3326. Removes the property.
  3327. </summary>
  3328. <param name="id">The ID of the property To be Removed</param>
  3329. </member>
  3330. <member name="M:NPOI.HPSF.MutableSection.SetPropertyBooleanValue(System.Int32,System.Boolean)">
  3331. <summary>
  3332. Sets the value of the bool property with the specified
  3333. ID.
  3334. </summary>
  3335. <param name="id">The property's ID</param>
  3336. <param name="value">The property's value</param>
  3337. </member>
  3338. <member name="P:NPOI.HPSF.MutableSection.Size">
  3339. <summary>
  3340. Returns the section's size in bytes.
  3341. </summary>
  3342. <value>The section's size in bytes.</value>
  3343. </member>
  3344. <member name="M:NPOI.HPSF.MutableSection.CalcSize">
  3345. <summary>
  3346. Calculates the section's size. It is the sum of the Lengths of the
  3347. section's header (8), the properties list (16 times the number of
  3348. properties) and the properties themselves.
  3349. </summary>
  3350. <returns>the section's Length in bytes.</returns>
  3351. </member>
  3352. <member name="M:NPOI.HPSF.MutableSection.Write(System.IO.Stream)">
  3353. <summary>
  3354. Writes this section into an output stream.
  3355. Internally this is done by writing into three byte array output
  3356. streams: one for the properties, one for the property list and one for
  3357. the section as such. The two former are Appended To the latter when they
  3358. have received all their data.
  3359. </summary>
  3360. <param name="out1">The stream To Write into.</param>
  3361. <returns>The number of bytes written, i.e. the section's size.</returns>
  3362. </member>
  3363. <member name="M:NPOI.HPSF.MutableSection.WriteDictionary(System.IO.Stream,System.Collections.IDictionary,System.Int32)">
  3364. <summary>
  3365. Writes the section's dictionary
  3366. </summary>
  3367. <param name="out1">The output stream To Write To.</param>
  3368. <param name="dictionary">The dictionary.</param>
  3369. <param name="codepage">The codepage to be used to Write the dictionary items.</param>
  3370. <returns>The number of bytes written</returns>
  3371. <remarks>
  3372. see MSDN KB: http://msdn.microsoft.com/en-us/library/aa380065(VS.85).aspx
  3373. </remarks>
  3374. </member>
  3375. <member name="P:NPOI.HPSF.MutableSection.PropertyCount">
  3376. <summary>
  3377. OverWrites the base class' method To cope with a redundancy:
  3378. the property count is maintained in a separate member variable, but
  3379. shouldn't.
  3380. </summary>
  3381. <value>The number of properties in this section.</value>
  3382. </member>
  3383. <member name="P:NPOI.HPSF.MutableSection.Properties">
  3384. <summary>
  3385. Returns this section's properties.
  3386. </summary>
  3387. <value>This section's properties.</value>
  3388. </member>
  3389. <member name="M:NPOI.HPSF.MutableSection.EnsureProperties">
  3390. <summary>
  3391. Ensures the properties.
  3392. </summary>
  3393. </member>
  3394. <member name="M:NPOI.HPSF.MutableSection.GetProperty(System.Int64)">
  3395. <summary>
  3396. Gets a property.
  3397. </summary>
  3398. <param name="id">The ID of the property To Get</param>
  3399. <returns>The property or null if there is no such property</returns>
  3400. </member>
  3401. <member name="P:NPOI.HPSF.MutableSection.Dictionary">
  3402. <summary>
  3403. Sets the section's dictionary. All keys in the dictionary must be
  3404. {@link java.lang.long} instances, all values must be
  3405. {@link java.lang.String}s. This method overWrites the properties with IDs
  3406. 0 and 1 since they are reserved for the dictionary and the dictionary's
  3407. codepage. Setting these properties explicitly might have surprising
  3408. effects. An application should never do this but always use this
  3409. method.
  3410. </summary>
  3411. <value>
  3412. the dictionary
  3413. </value>
  3414. </member>
  3415. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Object)">
  3416. <summary>
  3417. Sets the property.
  3418. </summary>
  3419. <param name="id">The property ID.</param>
  3420. <param name="value">The property's value. The value's class must be one of those
  3421. supported by HPSF.</param>
  3422. </member>
  3423. <member name="M:NPOI.HPSF.MutableSection.Clear">
  3424. <summary>
  3425. Removes all properties from the section including 0 (dictionary) and
  3426. 1 (codepage).
  3427. </summary>
  3428. </member>
  3429. <member name="P:NPOI.HPSF.MutableSection.Codepage">
  3430. <summary>
  3431. Gets the section's codepage, if any.
  3432. </summary>
  3433. <value>The section's codepage if one is defined, else -1.</value>
  3434. </member>
  3435. <member name="T:NPOI.HPSF.NoFormatIDException">
  3436. <summary>
  3437. This exception is thrown if a {@link MutablePropertySet} is To be written
  3438. but does not have a formatID Set (see {@link
  3439. MutableSection#SetFormatID(ClassID)} or
  3440. {@link org.apache.poi.hpsf.MutableSection#SetFormatID(byte[])}.
  3441. @author Rainer Klute
  3442. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3443. @since 2002-09-03
  3444. </summary>
  3445. </member>
  3446. <member name="M:NPOI.HPSF.NoFormatIDException.#ctor">
  3447. <summary>
  3448. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoFormatIDException"/> class.
  3449. </summary>
  3450. </member>
  3451. <member name="M:NPOI.HPSF.NoFormatIDException.#ctor(System.String)">
  3452. <summary>
  3453. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoFormatIDException"/> class.
  3454. </summary>
  3455. <param name="msg">The exception's message string</param>
  3456. </member>
  3457. <member name="M:NPOI.HPSF.NoFormatIDException.#ctor(System.Exception)">
  3458. <summary>
  3459. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoFormatIDException"/> class.
  3460. </summary>
  3461. <param name="reason">This exception's underlying reason</param>
  3462. </member>
  3463. <member name="M:NPOI.HPSF.NoFormatIDException.#ctor(System.String,System.Exception)">
  3464. <summary>
  3465. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoFormatIDException"/> class.
  3466. </summary>
  3467. <param name="msg">The exception's message string</param>
  3468. <param name="reason">This exception's underlying reason</param>
  3469. </member>
  3470. <member name="T:NPOI.HPSF.NoPropertySetStreamException">
  3471. <summary>
  3472. This exception is thrown if a format error in a property Set stream Is
  3473. detected or when the input data do not constitute a property Set stream.
  3474. The constructors of this class are analogous To those of its superclass
  3475. and are documented there.
  3476. @author Rainer Klute
  3477. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3478. @since 2002-02-09
  3479. </summary>
  3480. </member>
  3481. <member name="M:NPOI.HPSF.NoPropertySetStreamException.#ctor">
  3482. <summary>
  3483. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoPropertySetStreamException"/> class.
  3484. </summary>
  3485. </member>
  3486. <member name="M:NPOI.HPSF.NoPropertySetStreamException.#ctor(System.String)">
  3487. <summary>
  3488. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoPropertySetStreamException"/> class.
  3489. </summary>
  3490. <param name="msg">The exception's message string</param>
  3491. </member>
  3492. <member name="M:NPOI.HPSF.NoPropertySetStreamException.#ctor(System.Exception)">
  3493. <summary>
  3494. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoPropertySetStreamException"/> class.
  3495. </summary>
  3496. <param name="reason">This exception's underlying reason</param>
  3497. </member>
  3498. <member name="M:NPOI.HPSF.NoPropertySetStreamException.#ctor(System.String,System.Exception)">
  3499. <summary>
  3500. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoPropertySetStreamException"/> class.
  3501. </summary>
  3502. <param name="msg">The exception's message string</param>
  3503. <param name="reason">This exception's underlying reason</param>
  3504. </member>
  3505. <member name="T:NPOI.HPSF.NoSingleSectionException">
  3506. <summary>
  3507. This exception is thrown if one of the {@link PropertySet}'s
  3508. convenience methods that require a single {@link Section} is called
  3509. and the {@link PropertySet} does not contain exactly one {@link
  3510. Section}.
  3511. The constructors of this class are analogous To those of its
  3512. superclass and documented there.
  3513. @author Rainer Klute
  3514. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3515. @since 2002-02-09
  3516. </summary>
  3517. </member>
  3518. <member name="M:NPOI.HPSF.NoSingleSectionException.#ctor">
  3519. <summary>
  3520. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoSingleSectionException"/> class.
  3521. </summary>
  3522. </member>
  3523. <member name="M:NPOI.HPSF.NoSingleSectionException.#ctor(System.String)">
  3524. <summary>
  3525. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoSingleSectionException"/> class.
  3526. </summary>
  3527. <param name="msg">The exception's message string</param>
  3528. </member>
  3529. <member name="M:NPOI.HPSF.NoSingleSectionException.#ctor(System.Exception)">
  3530. <summary>
  3531. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoSingleSectionException"/> class.
  3532. </summary>
  3533. <param name="reason">This exception's underlying reason</param>
  3534. </member>
  3535. <member name="M:NPOI.HPSF.NoSingleSectionException.#ctor(System.String,System.Exception)">
  3536. <summary>
  3537. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoSingleSectionException"/> class.
  3538. </summary>
  3539. <param name="msg">The exception's message string</param>
  3540. <param name="reason">This exception's underlying reason</param>
  3541. </member>
  3542. <member name="T:NPOI.HPSF.Property">
  3543. <summary>
  3544. A property in a {@link Section} of a {@link PropertySet}.
  3545. The property's ID gives the property a meaning
  3546. in the context of its {@link Section}. Each {@link Section} spans
  3547. its own name space of property IDs.
  3548. The property's type determines how its
  3549. value is interpreted. For example, if the type Is
  3550. {@link Variant#VT_LPSTR} (byte string), the value consists of a
  3551. DWord telling how many bytes the string Contains. The bytes follow
  3552. immediately, including any null bytes that terminate the
  3553. string. The type {@link Variant#VT_I4} denotes a four-byte integer
  3554. value, {@link Variant#VT_FILETIME} some DateTime and time (of a
  3555. file).
  3556. Please note that not all {@link Variant} types yet. This might Change
  3557. over time but largely depends on your feedback so that the POI team knows
  3558. which variant types are really needed. So please feel free To submit error
  3559. reports or patches for the types you need.
  3560. Microsoft documentation:
  3561. <a href="http://msdn.microsoft.com/library/en-us/stg/stg/property_Set_display_name_dictionary.asp?frame=true">
  3562. Property Set Display Name Dictionary</a>
  3563. .
  3564. @author Rainer Klute
  3565. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3566. @author Drew Varner (Drew.Varner InAndAround sc.edu)
  3567. @see Section
  3568. @see Variant
  3569. @since 2002-02-09
  3570. </summary>
  3571. </member>
  3572. <member name="F:NPOI.HPSF.Property.id">
  3573. The property's ID.
  3574. </member>
  3575. <member name="P:NPOI.HPSF.Property.ID">
  3576. Returns the property's ID.
  3577. @return The ID value
  3578. </member>
  3579. <member name="F:NPOI.HPSF.Property.type">
  3580. The property's type.
  3581. </member>
  3582. <member name="P:NPOI.HPSF.Property.Type">
  3583. Returns the property's type.
  3584. @return The type value
  3585. </member>
  3586. <member name="F:NPOI.HPSF.Property.value">
  3587. The property's value.
  3588. </member>
  3589. <member name="P:NPOI.HPSF.Property.Value">
  3590. <summary>
  3591. Gets the property's value.
  3592. </summary>
  3593. <value>The property's value</value>
  3594. </member>
  3595. <member name="M:NPOI.HPSF.Property.#ctor(System.Int64,System.Int64,System.Object)">
  3596. <summary>
  3597. Initializes a new instance of the <see cref="T:NPOI.HPSF.Property"/> class.
  3598. </summary>
  3599. <param name="id">the property's ID.</param>
  3600. <param name="type">the property's type, see {@link Variant}.</param>
  3601. <param name="value">the property's value. Only certain types are allowed, see
  3602. {@link Variant}.</param>
  3603. </member>
  3604. <member name="M:NPOI.HPSF.Property.#ctor(System.Int64,System.Byte[],System.Int64,System.Int32,System.Int32)">
  3605. <summary>
  3606. Initializes a new instance of the <see cref="T:NPOI.HPSF.Property"/> class.
  3607. </summary>
  3608. <param name="id">The property's ID.</param>
  3609. <param name="src">The bytes the property Set stream consists of.</param>
  3610. <param name="offset">The property's type/value pair's offset in the
  3611. section.</param>
  3612. <param name="Length">The property's type/value pair's Length in bytes.</param>
  3613. <param name="codepage">The section's and thus the property's
  3614. codepage. It is needed only when Reading string values</param>
  3615. </member>
  3616. <member name="M:NPOI.HPSF.Property.#ctor">
  3617. <summary>
  3618. Initializes a new instance of the <see cref="T:NPOI.HPSF.Property"/> class.
  3619. </summary>
  3620. </member>
  3621. <member name="M:NPOI.HPSF.Property.ReadDictionary(System.Byte[],System.Int64,System.Int32,System.Int32)">
  3622. <summary>
  3623. Reads the dictionary.
  3624. </summary>
  3625. <param name="src">The byte array containing the bytes making out the dictionary.</param>
  3626. <param name="offset">At this offset within src the dictionary starts.</param>
  3627. <param name="Length">The dictionary Contains at most this many bytes.</param>
  3628. <param name="codepage">The codepage of the string values.</param>
  3629. <returns>The dictonary</returns>
  3630. </member>
  3631. <member name="P:NPOI.HPSF.Property.Count">
  3632. <summary>
  3633. Gets the property's size in bytes. This is always a multiple of
  3634. 4.
  3635. </summary>
  3636. <value>the property's size in bytes</value>
  3637. </member>
  3638. <member name="M:NPOI.HPSF.Property.Equals(System.Object)">
  3639. <summary>
  3640. Compares two properties.
  3641. Please beware that a property with
  3642. ID == 0 is a special case: It does not have a type, and its value is the
  3643. section's dictionary. Another special case are strings: Two properties
  3644. may have the different types Variant.VT_LPSTR and Variant.VT_LPWSTR;
  3645. </summary>
  3646. <param name="o">The o.</param>
  3647. <returns></returns>
  3648. </member>
  3649. <member name="M:NPOI.HPSF.Property.TypesAreEqual(System.Int64,System.Int64)">
  3650. <summary>
  3651. Typeses the are equal.
  3652. </summary>
  3653. <param name="t1">The t1.</param>
  3654. <param name="t2">The t2.</param>
  3655. <returns></returns>
  3656. </member>
  3657. <member name="M:NPOI.HPSF.Property.GetHashCode">
  3658. <summary>
  3659. Serves as a hash function for a particular type.
  3660. </summary>
  3661. <returns>
  3662. A hash code for the current <see cref="T:System.Object"/>.
  3663. </returns>
  3664. </member>
  3665. <member name="M:NPOI.HPSF.Property.ToString">
  3666. <summary>
  3667. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  3668. </summary>
  3669. <returns>
  3670. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  3671. </returns>
  3672. </member>
  3673. <member name="T:NPOI.HPSF.PropertySet">
  3674. <summary>
  3675. Represents a property Set in the Horrible Property Set Format
  3676. (HPSF). These are usually metadata of a Microsoft Office
  3677. document.
  3678. An application that wants To access these metadata should Create
  3679. an instance of this class or one of its subclasses by calling the
  3680. factory method {@link PropertySetFactory#Create} and then retrieve
  3681. the information its needs by calling appropriate methods.
  3682. {@link PropertySetFactory#Create} does its work by calling one
  3683. of the constructors {@link PropertySet#PropertySet(InputStream)} or
  3684. {@link PropertySet#PropertySet(byte[])}. If the constructor's
  3685. argument is not in the Horrible Property Set Format, i.e. not a
  3686. property Set stream, or if any other error occurs, an appropriate
  3687. exception is thrown.
  3688. A {@link PropertySet} has a list of {@link Section}s, and each
  3689. {@link Section} has a {@link Property} array. Use {@link
  3690. #GetSections} To retrieve the {@link Section}s, then call {@link
  3691. Section#GetProperties} for each {@link Section} To Get hold of the
  3692. {@link Property} arrays. Since the vast majority of {@link
  3693. PropertySet}s Contains only a single {@link Section}, the
  3694. convenience method {@link #GetProperties} returns the properties of
  3695. a {@link PropertySet}'s {@link Section} (throwing a {@link
  3696. NoSingleSectionException} if the {@link PropertySet} Contains more
  3697. (or less) than exactly one {@link Section}).
  3698. @author Rainer Klute
  3699. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3700. @author Drew Varner (Drew.Varner hanginIn sc.edu)
  3701. @since 2002-02-09
  3702. </summary>
  3703. </member>
  3704. <member name="F:NPOI.HPSF.PropertySet.BYTE_ORDER_ASSERTION">
  3705. The "byteOrder" field must equal this value.
  3706. </member>
  3707. <member name="F:NPOI.HPSF.PropertySet.byteOrder">
  3708. Specifies this {@link PropertySet}'s byte order. See the
  3709. HPFS documentation for details!
  3710. </member>
  3711. <member name="P:NPOI.HPSF.PropertySet.ByteOrder">
  3712. <summary>
  3713. Gets or sets the property Set stream's low-level "byte order"
  3714. field. It is always <c>0xFFFE</c>
  3715. </summary>
  3716. <value>The property Set stream's low-level "byte order" field..</value>
  3717. </member>
  3718. <member name="F:NPOI.HPSF.PropertySet.FORMAT_ASSERTION">
  3719. The "format" field must equal this value.
  3720. </member>
  3721. <member name="F:NPOI.HPSF.PropertySet.format">
  3722. Specifies this {@link PropertySet}'s format. See the HPFS
  3723. documentation for details!
  3724. </member>
  3725. <member name="P:NPOI.HPSF.PropertySet.Format">
  3726. <summary>
  3727. Gets or sets the property Set stream's low-level "format"
  3728. field. It is always <c>0x0000</c>
  3729. </summary>
  3730. <value>The property Set stream's low-level "format" field.</value>
  3731. </member>
  3732. <member name="F:NPOI.HPSF.PropertySet.osVersion">
  3733. Specifies the version of the operating system that Created
  3734. this {@link PropertySet}. See the HPFS documentation for
  3735. details!
  3736. </member>
  3737. <member name="F:NPOI.HPSF.PropertySet.OS_WIN16">
  3738. If the OS version field holds this value the property Set stream Was
  3739. Created on a 16-bit Windows system.
  3740. </member>
  3741. <member name="F:NPOI.HPSF.PropertySet.OS_MACINTOSH">
  3742. If the OS version field holds this value the property Set stream Was
  3743. Created on a Macintosh system.
  3744. </member>
  3745. <member name="F:NPOI.HPSF.PropertySet.OS_WIN32">
  3746. If the OS version field holds this value the property Set stream Was
  3747. Created on a 32-bit Windows system.
  3748. </member>
  3749. <member name="P:NPOI.HPSF.PropertySet.OSVersion">
  3750. <summary>
  3751. Returns the property Set stream's low-level "OS version"
  3752. field.
  3753. </summary>
  3754. <value>The property Set stream's low-level "OS version" field.</value>
  3755. </member>
  3756. <member name="F:NPOI.HPSF.PropertySet.classID">
  3757. Specifies this {@link PropertySet}'s "classID" field. See
  3758. the HPFS documentation for details!
  3759. </member>
  3760. <member name="P:NPOI.HPSF.PropertySet.ClassID">
  3761. <summary>
  3762. Gets or sets the property Set stream's low-level "class ID"
  3763. </summary>
  3764. <value>The property Set stream's low-level "class ID" field.</value>
  3765. </member>
  3766. <member name="P:NPOI.HPSF.PropertySet.SectionCount">
  3767. <summary>
  3768. Returns the number of {@link Section}s in the property
  3769. Set.
  3770. </summary>
  3771. <value>The number of {@link Section}s in the property Set.</value>
  3772. </member>
  3773. <member name="F:NPOI.HPSF.PropertySet.sections">
  3774. The sections in this {@link PropertySet}.
  3775. </member>
  3776. <member name="P:NPOI.HPSF.PropertySet.Sections">
  3777. <summary>
  3778. Returns the {@link Section}s in the property Set.
  3779. </summary>
  3780. <value>{@link Section}s in the property Set.</value>
  3781. </member>
  3782. <member name="M:NPOI.HPSF.PropertySet.#ctor">
  3783. <summary>
  3784. Creates an empty (uninitialized) {@link PropertySet}
  3785. Please note: For the time being this
  3786. constructor is protected since it is used for internal purposes
  3787. only, but expect it To become public once the property Set's
  3788. writing functionality is implemented.
  3789. </summary>
  3790. </member>
  3791. <member name="M:NPOI.HPSF.PropertySet.#ctor(System.IO.Stream)">
  3792. <summary>
  3793. Creates a {@link PropertySet} instance from an {@link
  3794. InputStream} in the Horrible Property Set Format.
  3795. The constructor Reads the first few bytes from the stream
  3796. and determines whether it is really a property Set stream. If
  3797. it Is, it parses the rest of the stream. If it is not, it
  3798. Resets the stream To its beginning in order To let other
  3799. components mess around with the data and throws an
  3800. exception.
  3801. </summary>
  3802. <param name="stream">Holds the data making out the property Set
  3803. stream.</param>
  3804. </member>
  3805. <member name="M:NPOI.HPSF.PropertySet.#ctor(System.Byte[],System.Int32,System.Int32)">
  3806. <summary>
  3807. Creates a {@link PropertySet} instance from a byte array
  3808. that represents a stream in the Horrible Property Set
  3809. Format.
  3810. </summary>
  3811. <param name="stream">The byte array holding the stream data.</param>
  3812. <param name="offset">The offset in stream where the stream data begin.
  3813. If the stream data begin with the first byte in the
  3814. array, the offset is 0.</param>
  3815. <param name="Length"> The Length of the stream data.</param>
  3816. </member>
  3817. <member name="M:NPOI.HPSF.PropertySet.#ctor(System.Byte[])">
  3818. <summary>
  3819. Creates a {@link PropertySet} instance from a byte array
  3820. that represents a stream in the Horrible Property Set
  3821. Format.
  3822. </summary>
  3823. <param name="stream">The byte array holding the stream data. The
  3824. complete byte array contents is the stream data.</param>
  3825. </member>
  3826. <member name="M:NPOI.HPSF.PropertySet.IsPropertySetStream(System.IO.Stream)">
  3827. <summary>
  3828. Checks whether an {@link InputStream} is in the Horrible
  3829. Property Set Format.
  3830. </summary>
  3831. <param name="stream">The {@link InputStream} To check. In order To
  3832. perform the check, the method Reads the first bytes from the
  3833. stream. After Reading, the stream is Reset To the position it
  3834. had before Reading. The {@link InputStream} must support the
  3835. {@link InputStream#mark} method.</param>
  3836. <returns>
  3837. <c>true</c> if the stream is a property Set
  3838. stream; otherwise, <c>false</c>.
  3839. </returns>
  3840. </member>
  3841. <member name="M:NPOI.HPSF.PropertySet.IsPropertySetStream(System.Byte[],System.Int32,System.Int32)">
  3842. <summary>
  3843. Checks whether a byte array is in the Horrible Property Set
  3844. Format.
  3845. </summary>
  3846. <param name="src">The byte array To check.</param>
  3847. <param name="offset">The offset in the byte array.</param>
  3848. <param name="Length">The significant number of bytes in the byte
  3849. array. Only this number of bytes will be checked.</param>
  3850. <returns>
  3851. <c>true</c> if the byte array is a property Set
  3852. stream; otherwise, <c>false</c>.
  3853. </returns>
  3854. </member>
  3855. <member name="M:NPOI.HPSF.PropertySet.init(System.Byte[],System.Int32,System.Int32)">
  3856. <summary>
  3857. Initializes this {@link PropertySet} instance from a byte
  3858. array. The method assumes that it has been checked alReady that
  3859. the byte array indeed represents a property Set stream. It does
  3860. no more checks on its own.
  3861. </summary>
  3862. <param name="src">Byte array containing the property Set stream</param>
  3863. <param name="offset">The property Set stream starts at this offset</param>
  3864. <param name="Length">Length of the property Set stream.</param>
  3865. </member>
  3866. <member name="P:NPOI.HPSF.PropertySet.IsSummaryInformation">
  3867. <summary>
  3868. Checks whether this {@link PropertySet} represents a Summary
  3869. Information.
  3870. </summary>
  3871. <value>
  3872. <c>true</c> Checks whether this {@link PropertySet} represents a Summary
  3873. Information; otherwise, <c>false</c>.
  3874. </value>
  3875. </member>
  3876. <member name="P:NPOI.HPSF.PropertySet.IsDocumentSummaryInformation">
  3877. <summary>
  3878. Gets a value indicating whether this instance is document summary information.
  3879. </summary>
  3880. <value>
  3881. <c>true</c> if this instance is document summary information; otherwise, <c>false</c>.
  3882. </value>
  3883. Checks whether this {@link PropertySet} is a Document
  3884. Summary Information.
  3885. @return
  3886. <c>true</c>
  3887. if this {@link PropertySet}
  3888. represents a Document Summary Information, else
  3889. <c>false</c>
  3890. </member>
  3891. <member name="P:NPOI.HPSF.PropertySet.Properties">
  3892. <summary>
  3893. Convenience method returning the {@link Property} array
  3894. contained in this property Set. It is a shortcut for Getting
  3895. the {@link PropertySet}'s {@link Section}s list and then
  3896. Getting the {@link Property} array from the first {@link
  3897. Section}.
  3898. </summary>
  3899. <value>The properties of the only {@link Section} of this
  3900. {@link PropertySet}.</value>
  3901. </member>
  3902. <member name="M:NPOI.HPSF.PropertySet.GetProperty(System.Int32)">
  3903. <summary>
  3904. Convenience method returning the value of the property with
  3905. the specified ID. If the property is not available,
  3906. <c>null</c> is returned and a subsequent call To {@link
  3907. #WasNull} will return <c>true</c> .
  3908. </summary>
  3909. <param name="id">The property ID</param>
  3910. <returns>The property value</returns>
  3911. </member>
  3912. <member name="M:NPOI.HPSF.PropertySet.GetPropertyBooleanValue(System.Int32)">
  3913. <summary>
  3914. Convenience method returning the value of a bool property
  3915. with the specified ID. If the property is not available,
  3916. <c>false</c> is returned. A subsequent call To {@link
  3917. #WasNull} will return <c>true</c> To let the caller
  3918. distinguish that case from a real property value of
  3919. <c>false</c>.
  3920. </summary>
  3921. <param name="id">The property ID</param>
  3922. <returns>The property value</returns>
  3923. </member>
  3924. <member name="M:NPOI.HPSF.PropertySet.GetPropertyIntValue(System.Int32)">
  3925. <summary>
  3926. Convenience method returning the value of the numeric
  3927. property with the specified ID. If the property is not
  3928. available, 0 is returned. A subsequent call To {@link #WasNull}
  3929. will return <c>true</c> To let the caller distinguish
  3930. that case from a real property value of 0.
  3931. </summary>
  3932. <param name="id">The property ID</param>
  3933. <returns>The propertyIntValue value</returns>
  3934. </member>
  3935. <member name="P:NPOI.HPSF.PropertySet.WasNull">
  3936. <summary>
  3937. Checks whether the property which the last call To {@link
  3938. #GetPropertyIntValue} or {@link #GetProperty} tried To access
  3939. Was available or not. This information might be important for
  3940. callers of {@link #GetPropertyIntValue} since the latter
  3941. returns 0 if the property does not exist. Using {@link
  3942. #WasNull}, the caller can distiguish this case from a
  3943. property's real value of 0.
  3944. </summary>
  3945. <value><c>true</c> if the last call To {@link
  3946. #GetPropertyIntValue} or {@link #GetProperty} tried To access a
  3947. property that Was not available; otherwise, <c>false</c>.</value>
  3948. </member>
  3949. <member name="P:NPOI.HPSF.PropertySet.FirstSection">
  3950. <summary>
  3951. Gets the first section.
  3952. </summary>
  3953. <value>The first section.</value>
  3954. </member>
  3955. <member name="P:NPOI.HPSF.PropertySet.SingleSection">
  3956. <summary>
  3957. If the {@link PropertySet} has only a single section this
  3958. method returns it.
  3959. </summary>
  3960. <value>The singleSection value</value>
  3961. </member>
  3962. <member name="M:NPOI.HPSF.PropertySet.Equals(System.Object)">
  3963. <summary>
  3964. Returns <c>true</c> if the <c>PropertySet</c> is equal
  3965. To the specified parameter, else <c>false</c>.
  3966. </summary>
  3967. <param name="o">the object To Compare this
  3968. <c>PropertySet</c>
  3969. with</param>
  3970. <returns><c>true</c>
  3971. if the objects are equal,
  3972. <c>false</c>
  3973. if not</returns>
  3974. </member>
  3975. <member name="M:NPOI.HPSF.PropertySet.GetHashCode">
  3976. <summary>
  3977. Serves as a hash function for a particular type.
  3978. </summary>
  3979. <returns>
  3980. A hash code for the current <see cref="T:System.Object"/>.
  3981. </returns>
  3982. </member>
  3983. <member name="M:NPOI.HPSF.PropertySet.ToString">
  3984. <summary>
  3985. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  3986. </summary>
  3987. <returns>
  3988. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  3989. </returns>
  3990. </member>
  3991. <member name="T:NPOI.HPSF.PropertySetFactory">
  3992. <summary>
  3993. Factory class To Create instances of {@link SummaryInformation},
  3994. {@link DocumentSummaryInformation} and {@link PropertySet}.
  3995. @author Rainer Klute
  3996. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3997. @since 2002-02-09
  3998. </summary>
  3999. </member>
  4000. <member name="M:NPOI.HPSF.PropertySetFactory.Create(NPOI.POIFS.FileSystem.DirectoryEntry,System.String)">
  4001. <p>Creates the most specific {@link PropertySet} from an entry
  4002. in the specified POIFS Directory. This is preferrably a {@link
  4003. DocumentSummaryInformation} or a {@link SummaryInformation}. If
  4004. the specified entry does not contain a property Set stream, an
  4005. exception is thrown. If no entry is found with the given name,
  4006. an exception is thrown.</p>
  4007. @param dir The directory to find the PropertySet in
  4008. @param name The name of the entry Containing the PropertySet
  4009. @return The Created {@link PropertySet}.
  4010. @if there is no entry with that name
  4011. @if the stream does not
  4012. contain a property Set.
  4013. @if some I/O problem occurs.
  4014. @exception EncoderFallbackException if the specified codepage is not
  4015. supported.
  4016. </member>
  4017. <member name="M:NPOI.HPSF.PropertySetFactory.Create(System.IO.Stream)">
  4018. <summary>
  4019. Creates the most specific {@link PropertySet} from an {@link
  4020. InputStream}. This is preferrably a {@link
  4021. DocumentSummaryInformation} or a {@link SummaryInformation}. If
  4022. the specified {@link InputStream} does not contain a property
  4023. Set stream, an exception is thrown and the {@link InputStream}
  4024. is repositioned at its beginning.
  4025. </summary>
  4026. <param name="stream">Contains the property set stream's data.</param>
  4027. <returns>The Created {@link PropertySet}.</returns>
  4028. </member>
  4029. <member name="M:NPOI.HPSF.PropertySetFactory.CreateSummaryInformation">
  4030. <summary>
  4031. Creates a new summary information
  4032. </summary>
  4033. <returns>the new summary information.</returns>
  4034. </member>
  4035. <member name="M:NPOI.HPSF.PropertySetFactory.CreateDocumentSummaryInformation">
  4036. <summary>
  4037. Creates a new document summary information.
  4038. </summary>
  4039. <returns>the new document summary information.</returns>
  4040. </member>
  4041. <member name="T:NPOI.HPSF.ReadingNotSupportedException">
  4042. <summary>
  4043. This exception is thrown when HPSF tries To Read a (yet) unsupported
  4044. variant type.
  4045. @see WritingNotSupportedException
  4046. @see UnsupportedVariantTypeException
  4047. @author Rainer Klute
  4048. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  4049. @since 2003-08-08
  4050. </summary>
  4051. </member>
  4052. <member name="M:NPOI.HPSF.ReadingNotSupportedException.#ctor(System.Int64,System.Object)">
  4053. <summary>
  4054. Initializes a new instance of the <see cref="T:NPOI.HPSF.ReadingNotSupportedException"/> class.
  4055. </summary>
  4056. <param name="variantType">The unsupported variant type</param>
  4057. <param name="value">The value who's variant type is not yet supported</param>
  4058. </member>
  4059. <member name="T:NPOI.HPSF.Section">
  4060. <summary>
  4061. Represents a section in a {@link PropertySet}.
  4062. @author Rainer Klute
  4063. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  4064. @author Drew Varner (Drew.Varner allUpIn sc.edu)
  4065. @since 2002-02-09
  4066. </summary>
  4067. </member>
  4068. <member name="F:NPOI.HPSF.Section.dictionary">
  4069. Maps property IDs To section-private PID strings. These
  4070. strings can be found in the property with ID 0.
  4071. </member>
  4072. <member name="F:NPOI.HPSF.Section.formatID">
  4073. The section's format ID, {@link #GetFormatID}.
  4074. </member>
  4075. <member name="P:NPOI.HPSF.Section.FormatID">
  4076. <summary>
  4077. Returns the format ID. The format ID is the "type" of the
  4078. section. For example, if the format ID of the first {@link
  4079. Section} Contains the bytes specified by
  4080. <c>org.apache.poi.hpsf.wellknown.SectionIDMap.SUMMARY_INFORMATION_ID</c>
  4081. the section (and thus the property Set) is a SummaryInformation.
  4082. </summary>
  4083. <value>The format ID.</value>
  4084. </member>
  4085. <member name="P:NPOI.HPSF.Section.OffSet">
  4086. <summary>
  4087. Gets the offset of the section in the stream.
  4088. </summary>
  4089. <value>The offset of the section in the stream</value>
  4090. </member>
  4091. <member name="P:NPOI.HPSF.Section.Size">
  4092. <summary>
  4093. Returns the section's size in bytes.
  4094. </summary>
  4095. <value>The section's size in bytes.</value>
  4096. </member>
  4097. <member name="P:NPOI.HPSF.Section.PropertyCount">
  4098. <summary>
  4099. Returns the number of properties in this section.
  4100. </summary>
  4101. <value>The number of properties in this section.</value>
  4102. </member>
  4103. <member name="P:NPOI.HPSF.Section.Properties">
  4104. <summary>
  4105. Returns this section's properties.
  4106. </summary>
  4107. <value>This section's properties.</value>
  4108. </member>
  4109. <member name="M:NPOI.HPSF.Section.#ctor">
  4110. <summary>
  4111. Creates an empty and uninitialized {@link Section}.
  4112. </summary>
  4113. </member>
  4114. <member name="M:NPOI.HPSF.Section.#ctor(System.Byte[],System.Int32)">
  4115. <summary>
  4116. Creates a {@link Section} instance from a byte array.
  4117. </summary>
  4118. <param name="src">Contains the complete property Set stream.</param>
  4119. <param name="offset">The position in the stream that points To the
  4120. section's format ID.</param>
  4121. </member>
  4122. <member name="T:NPOI.HPSF.Section.PropertyListEntry">
  4123. Represents an entry in the property list and holds a property's ID and
  4124. its offset from the section's beginning.
  4125. </member>
  4126. <member name="M:NPOI.HPSF.Section.PropertyListEntry.CompareTo(System.Object)">
  4127. Compares this {@link PropertyListEntry} with another one by their
  4128. offsets. A {@link PropertyListEntry} is "smaller" than another one if
  4129. its offset from the section's begin is smaller.
  4130. @see Comparable#CompareTo(java.lang.Object)
  4131. </member>
  4132. <member name="M:NPOI.HPSF.Section.GetProperty(System.Int64)">
  4133. Returns the value of the property with the specified ID. If
  4134. the property is not available, <c>null</c> is returned
  4135. and a subsequent call To {@link #wasNull} will return
  4136. <c>true</c>.
  4137. @param id The property's ID
  4138. @return The property's value
  4139. </member>
  4140. <member name="M:NPOI.HPSF.Section.GetPropertyIntValue(System.Int64)">
  4141. Returns the value of the numeric property with the specified
  4142. ID. If the property is not available, 0 is returned. A
  4143. subsequent call To {@link #wasNull} will return
  4144. <c>true</c> To let the caller distinguish that case from
  4145. a real property value of 0.
  4146. @param id The property's ID
  4147. @return The property's value
  4148. </member>
  4149. <member name="M:NPOI.HPSF.Section.GetPropertyBooleanValue(System.Int32)">
  4150. Returns the value of the bool property with the specified
  4151. ID. If the property is not available, <c>false</c> Is
  4152. returned. A subsequent call To {@link #wasNull} will return
  4153. <c>true</c> To let the caller distinguish that case from
  4154. a real property value of <c>false</c>.
  4155. @param id The property's ID
  4156. @return The property's value
  4157. </member>
  4158. <member name="F:NPOI.HPSF.Section.wasNull">
  4159. This member is <c>true</c> if the last call To {@link
  4160. #GetPropertyIntValue} or {@link #GetProperty} tried To access a
  4161. property that was not available, else <c>false</c>.
  4162. </member>
  4163. <member name="P:NPOI.HPSF.Section.WasNull">
  4164. <summary>
  4165. Checks whether the property which the last call To {@link
  4166. #GetPropertyIntValue} or {@link #GetProperty} tried To access
  4167. was available or not. This information might be important for
  4168. callers of {@link #GetPropertyIntValue} since the latter
  4169. returns 0 if the property does not exist. Using {@link
  4170. #wasNull} the caller can distiguish this case from a property's
  4171. real value of 0.
  4172. </summary>
  4173. <value><c>true</c> if the last call To {@link
  4174. #GetPropertyIntValue} or {@link #GetProperty} tried To access a
  4175. property that was not available; otherwise, <c>false</c>.</value>
  4176. </member>
  4177. <member name="M:NPOI.HPSF.Section.GetPIDString(System.Int64)">
  4178. <summary>
  4179. Returns the PID string associated with a property ID. The ID
  4180. is first looked up in the {@link Section}'s private
  4181. dictionary. If it is not found there, the method calls {@link
  4182. SectionIDMap#GetPIDString}.
  4183. </summary>
  4184. <param name="pid">The property ID.</param>
  4185. <returns>The property ID's string value</returns>
  4186. </member>
  4187. <member name="M:NPOI.HPSF.Section.Equals(System.Object)">
  4188. Checks whether this section is equal To another object. The result Is
  4189. <c>false</c> if one of the the following conditions holds:
  4190. <ul>
  4191. <li>The other object is not a {@link Section}.</li>
  4192. <li>The format IDs of the two sections are not equal.</li>
  4193. <li>The sections have a different number of properties. However,
  4194. properties with ID 1 (codepage) are not counted.</li>
  4195. <li>The other object is not a {@link Section}.</li>
  4196. <li>The properties have different values. The order of the properties
  4197. is irrelevant.</li>
  4198. </ul>
  4199. @param o The object To Compare this section with
  4200. @return <c>true</c> if the objects are equal, <c>false</c> if
  4201. not
  4202. </member>
  4203. <member name="M:NPOI.HPSF.Section.Remove(NPOI.HPSF.Property[],System.Int32)">
  4204. <summary>
  4205. Removes a field from a property array. The resulting array Is
  4206. compactified and returned.
  4207. </summary>
  4208. <param name="pa">The property array.</param>
  4209. <param name="i">The index of the field To be Removed.</param>
  4210. <returns>the compactified array.</returns>
  4211. </member>
  4212. <member name="M:NPOI.HPSF.Section.GetHashCode">
  4213. <summary>
  4214. Serves as a hash function for a particular type.
  4215. </summary>
  4216. <returns>
  4217. A hash code for the current <see cref="T:System.Object"/>.
  4218. </returns>
  4219. </member>
  4220. <member name="M:NPOI.HPSF.Section.ToString">
  4221. <summary>
  4222. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4223. </summary>
  4224. <returns>
  4225. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4226. </returns>
  4227. </member>
  4228. <member name="P:NPOI.HPSF.Section.Dictionary">
  4229. <summary>
  4230. Gets the section's dictionary. A dictionary allows an application To
  4231. use human-Readable property names instead of numeric property IDs. It
  4232. Contains mappings from property IDs To their associated string
  4233. values. The dictionary is stored as the property with ID 0. The codepage
  4234. for the strings in the dictionary is defined by property with ID 1.
  4235. </summary>
  4236. <value>the dictionary or null
  4237. if the section does not have
  4238. a dictionary.</value>
  4239. </member>
  4240. <member name="P:NPOI.HPSF.Section.Codepage">
  4241. <summary>
  4242. Gets the section's codepage, if any.
  4243. </summary>
  4244. <value>The section's codepage if one is defined, else -1.</value>
  4245. </member>
  4246. <member name="T:NPOI.HPSF.SpecialPropertySet">
  4247. <summary>
  4248. Abstract superclass for the convenience classes {@link
  4249. SummaryInformation} and {@link DocumentSummaryInformation}.
  4250. The motivation behind this class is quite nasty if you look
  4251. behind the scenes, but it serves the application programmer well by
  4252. providing him with the easy-to-use {@link SummaryInformation} and
  4253. {@link DocumentSummaryInformation} classes. When parsing the data a
  4254. property Set stream consists of (possibly coming from an {@link
  4255. java.io.Stream}) we want To Read and process each byte only
  4256. once. Since we don't know in advance which kind of property Set we
  4257. have, we can expect only the most general {@link
  4258. PropertySet}. Creating a special subclass should be as easy as
  4259. calling the special subclass' constructor and pass the general
  4260. {@link PropertySet} in. To make things easy internally, the special
  4261. class just holds a reference To the general {@link PropertySet} and
  4262. delegates all method calls To it.
  4263. A cleaner implementation would have been like this: The {@link
  4264. PropertySetFactory} parses the stream data into some internal
  4265. object first. Then it Finds out whether the stream is a {@link
  4266. SummaryInformation}, a {@link DocumentSummaryInformation} or a
  4267. general {@link PropertySet}. However, the current implementation
  4268. went the other way round historically: the convenience classes came
  4269. only late To my mind.
  4270. @author Rainer Klute
  4271. klute@rainer-klute.de
  4272. @since 2002-02-09
  4273. </summary>
  4274. </member>
  4275. <member name="P:NPOI.HPSF.SpecialPropertySet.PropertySetIDMap">
  4276. The id to name mapping of the properties
  4277. in this set.
  4278. </member>
  4279. <member name="F:NPOI.HPSF.SpecialPropertySet.delegate1">
  4280. The "real" property Set <c>SpecialPropertySet</c>
  4281. delegates To.
  4282. </member>
  4283. <member name="M:NPOI.HPSF.SpecialPropertySet.#ctor(NPOI.HPSF.PropertySet)">
  4284. <summary>
  4285. Initializes a new instance of the <see cref="T:NPOI.HPSF.SpecialPropertySet"/> class.
  4286. </summary>
  4287. <param name="ps">The property Set To be encapsulated by the <c>SpecialPropertySet</c></param>
  4288. </member>
  4289. <member name="M:NPOI.HPSF.SpecialPropertySet.#ctor(NPOI.HPSF.MutablePropertySet)">
  4290. <summary>
  4291. Initializes a new instance of the <see cref="T:NPOI.HPSF.SpecialPropertySet"/> class.
  4292. </summary>
  4293. <param name="ps">The mutable property Set To be encapsulated by the <c>SpecialPropertySet</c></param>
  4294. </member>
  4295. <member name="P:NPOI.HPSF.SpecialPropertySet.ByteOrder">
  4296. <summary>
  4297. gets or sets the "byteOrder" property.
  4298. </summary>
  4299. <value>the byteOrder value To Set</value>
  4300. </member>
  4301. <member name="P:NPOI.HPSF.SpecialPropertySet.Format">
  4302. <summary>
  4303. gets or sets the "format" property
  4304. </summary>
  4305. <value>the format value To Set</value>
  4306. </member>
  4307. <member name="P:NPOI.HPSF.SpecialPropertySet.ClassID">
  4308. <summary>
  4309. gets or sets the property Set stream's low-level "class ID"
  4310. field.
  4311. </summary>
  4312. <value>The property Set stream's low-level "class ID" field</value>
  4313. </member>
  4314. <member name="P:NPOI.HPSF.SpecialPropertySet.SectionCount">
  4315. <summary>
  4316. Returns the number of {@link Section}s in the property
  4317. Set.
  4318. </summary>
  4319. <value>The number of {@link Section}s in the property Set.</value>
  4320. </member>
  4321. <member name="P:NPOI.HPSF.SpecialPropertySet.IsSummaryInformation">
  4322. <summary>
  4323. Checks whether this {@link PropertySet} represents a Summary
  4324. Information.
  4325. </summary>
  4326. <value>
  4327. <c>true</c> Checks whether this {@link PropertySet} represents a Summary
  4328. Information; otherwise, <c>false</c>.
  4329. </value>
  4330. </member>
  4331. <member name="P:NPOI.HPSF.SpecialPropertySet.IsDocumentSummaryInformation">
  4332. <summary>
  4333. Gets a value indicating whether this instance is document summary information.
  4334. </summary>
  4335. <value>
  4336. <c>true</c> if this instance is document summary information; otherwise, <c>false</c>.
  4337. </value>
  4338. Checks whether this {@link PropertySet} is a Document
  4339. Summary Information.
  4340. @return
  4341. <c>true</c>
  4342. if this {@link PropertySet}
  4343. represents a Document Summary Information, else
  4344. <c>false</c>
  4345. </member>
  4346. <member name="P:NPOI.HPSF.SpecialPropertySet.FirstSection">
  4347. <summary>
  4348. Gets the PropertySet's first section.
  4349. </summary>
  4350. <value>The {@link PropertySet}'s first section.</value>
  4351. </member>
  4352. <member name="M:NPOI.HPSF.SpecialPropertySet.AddSection(NPOI.HPSF.Section)">
  4353. <summary>
  4354. Adds a section To this property set.
  4355. </summary>
  4356. <param name="section">The {@link Section} To Add. It will be Appended
  4357. after any sections that are alReady present in the property Set
  4358. and thus become the last section.</param>
  4359. </member>
  4360. <member name="M:NPOI.HPSF.SpecialPropertySet.ClearSections">
  4361. <summary>
  4362. Removes all sections from this property Set.
  4363. </summary>
  4364. </member>
  4365. <member name="P:NPOI.HPSF.SpecialPropertySet.OSVersion">
  4366. <summary>
  4367. gets or sets the "osVersion" property
  4368. </summary>
  4369. <value> the osVersion value To Set</value>
  4370. </member>
  4371. <member name="M:NPOI.HPSF.SpecialPropertySet.Write(NPOI.POIFS.FileSystem.DirectoryEntry,System.String)">
  4372. <summary>
  4373. Writes a property Set To a document in a POI filesystem directory.
  4374. </summary>
  4375. <param name="dir">The directory in the POI filesystem To Write the document To</param>
  4376. <param name="name">The document's name. If there is alReady a document with the
  4377. same name in the directory the latter will be overwritten.</param>
  4378. </member>
  4379. <member name="M:NPOI.HPSF.SpecialPropertySet.Write(System.IO.Stream)">
  4380. <summary>
  4381. Writes the property Set To an output stream.
  4382. </summary>
  4383. <param name="out1">the output stream To Write the section To</param>
  4384. </member>
  4385. <member name="M:NPOI.HPSF.SpecialPropertySet.Equals(System.Object)">
  4386. <summary>
  4387. Returns <c>true</c> if the <c>PropertySet</c> is equal
  4388. To the specified parameter, else <c>false</c>.
  4389. </summary>
  4390. <param name="o">the object To Compare this
  4391. <c>PropertySet</c>
  4392. with</param>
  4393. <returns>
  4394. <c>true</c>
  4395. if the objects are equal,
  4396. <c>false</c>
  4397. if not
  4398. </returns>
  4399. </member>
  4400. <member name="P:NPOI.HPSF.SpecialPropertySet.Properties">
  4401. <summary>
  4402. Convenience method returning the {@link Property} array
  4403. contained in this property Set. It is a shortcut for Getting
  4404. the {@link PropertySet}'s {@link Section}s list and then
  4405. Getting the {@link Property} array from the first {@link
  4406. Section}.
  4407. </summary>
  4408. <value>
  4409. The properties of the only {@link Section} of this
  4410. {@link PropertySet}.
  4411. </value>
  4412. </member>
  4413. <member name="M:NPOI.HPSF.SpecialPropertySet.GetProperty(System.Int32)">
  4414. <summary>
  4415. Convenience method returning the value of the property with
  4416. the specified ID. If the property is not available,
  4417. <c>null</c> is returned and a subsequent call To {@link
  4418. #WasNull} will return <c>true</c> .
  4419. </summary>
  4420. <param name="id">The property ID</param>
  4421. <returns>The property value</returns>
  4422. </member>
  4423. <member name="M:NPOI.HPSF.SpecialPropertySet.GetPropertyBooleanValue(System.Int32)">
  4424. <summary>
  4425. Convenience method returning the value of a bool property
  4426. with the specified ID. If the property is not available,
  4427. <c>false</c> is returned. A subsequent call To {@link
  4428. #WasNull} will return <c>true</c> To let the caller
  4429. distinguish that case from a real property value of
  4430. <c>false</c>.
  4431. </summary>
  4432. <param name="id">The property ID</param>
  4433. <returns>The property value</returns>
  4434. </member>
  4435. <member name="M:NPOI.HPSF.SpecialPropertySet.GetPropertyIntValue(System.Int32)">
  4436. <summary>
  4437. Convenience method returning the value of the numeric
  4438. property with the specified ID. If the property is not
  4439. available, 0 is returned. A subsequent call To {@link #WasNull}
  4440. will return <c>true</c> To let the caller distinguish
  4441. that case from a real property value of 0.
  4442. </summary>
  4443. <param name="id">The property ID</param>
  4444. <returns>The propertyIntValue value</returns>
  4445. </member>
  4446. <member name="M:NPOI.HPSF.SpecialPropertySet.GetPropertyStringValue(System.Int32)">
  4447. Fetches the property with the given ID, then does its
  4448. best to return it as a String
  4449. @return The property as a String, or null if unavailable
  4450. </member>
  4451. <member name="M:NPOI.HPSF.SpecialPropertySet.GetHashCode">
  4452. <summary>
  4453. Serves as a hash function for a particular type.
  4454. </summary>
  4455. <returns>
  4456. A hash code for the current <see cref="T:System.Object"/>.
  4457. </returns>
  4458. </member>
  4459. <member name="M:NPOI.HPSF.SpecialPropertySet.ToString">
  4460. <summary>
  4461. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4462. </summary>
  4463. <returns>
  4464. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4465. </returns>
  4466. </member>
  4467. <member name="P:NPOI.HPSF.SpecialPropertySet.WasNull">
  4468. <summary>
  4469. Checks whether the property which the last call To {@link
  4470. #GetPropertyIntValue} or {@link #GetProperty} tried To access
  4471. Was available or not. This information might be important for
  4472. callers of {@link #GetPropertyIntValue} since the latter
  4473. returns 0 if the property does not exist. Using {@link
  4474. #WasNull}, the caller can distiguish this case from a
  4475. property's real value of 0.
  4476. </summary>
  4477. <value>
  4478. <c>true</c> if the last call To {@link
  4479. #GetPropertyIntValue} or {@link #GetProperty} tried To access a
  4480. property that Was not available; otherwise, <c>false</c>.
  4481. </value>
  4482. </member>
  4483. <member name="T:NPOI.HPSF.SummaryInformation">
  4484. <summary>
  4485. Convenience class representing a Summary Information stream in a
  4486. Microsoft Office document.
  4487. @author Rainer Klute
  4488. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  4489. @see DocumentSummaryInformation
  4490. @since 2002-02-09
  4491. </summary>
  4492. </member>
  4493. <member name="F:NPOI.HPSF.SummaryInformation.DEFAULT_STREAM_NAME">
  4494. The document name a summary information stream usually has in a POIFS
  4495. filesystem.
  4496. </member>
  4497. <member name="M:NPOI.HPSF.SummaryInformation.#ctor(NPOI.HPSF.PropertySet)">
  4498. <summary>
  4499. Initializes a new instance of the <see cref="T:NPOI.HPSF.SummaryInformation"/> class.
  4500. </summary>
  4501. <param name="ps">A property Set which should be Created from a summary
  4502. information stream.</param>
  4503. </member>
  4504. <member name="P:NPOI.HPSF.SummaryInformation.Title">
  4505. <summary>
  4506. Gets or sets the title.
  4507. </summary>
  4508. <value>The title.</value>
  4509. </member>
  4510. <member name="M:NPOI.HPSF.SummaryInformation.RemoveTitle">
  4511. <summary>
  4512. Removes the title.
  4513. </summary>
  4514. </member>
  4515. <member name="P:NPOI.HPSF.SummaryInformation.Subject">
  4516. <summary>
  4517. Gets or sets the subject.
  4518. </summary>
  4519. <value>The subject.</value>
  4520. </member>
  4521. <member name="M:NPOI.HPSF.SummaryInformation.RemoveSubject">
  4522. <summary>
  4523. Removes the subject.
  4524. </summary>
  4525. </member>
  4526. <member name="P:NPOI.HPSF.SummaryInformation.Author">
  4527. <summary>
  4528. Gets or sets the author.
  4529. </summary>
  4530. <value>The author.</value>
  4531. </member>
  4532. <member name="M:NPOI.HPSF.SummaryInformation.RemoveAuthor">
  4533. <summary>
  4534. Removes the author.
  4535. </summary>
  4536. </member>
  4537. <member name="P:NPOI.HPSF.SummaryInformation.Keywords">
  4538. <summary>
  4539. Gets or sets the keywords.
  4540. </summary>
  4541. <value>The keywords.</value>
  4542. </member>
  4543. <member name="M:NPOI.HPSF.SummaryInformation.RemoveKeywords">
  4544. <summary>
  4545. Removes the keywords.
  4546. </summary>
  4547. </member>
  4548. <member name="P:NPOI.HPSF.SummaryInformation.Comments">
  4549. <summary>
  4550. Gets or sets the comments.
  4551. </summary>
  4552. <value>The comments.</value>
  4553. </member>
  4554. <member name="M:NPOI.HPSF.SummaryInformation.RemoveComments">
  4555. <summary>
  4556. Removes the comments.
  4557. </summary>
  4558. </member>
  4559. <member name="P:NPOI.HPSF.SummaryInformation.Template">
  4560. <summary>
  4561. Gets or sets the template.
  4562. </summary>
  4563. <value>The template.</value>
  4564. </member>
  4565. <member name="M:NPOI.HPSF.SummaryInformation.RemoveTemplate">
  4566. <summary>
  4567. Removes the template.
  4568. </summary>
  4569. </member>
  4570. <member name="P:NPOI.HPSF.SummaryInformation.LastAuthor">
  4571. <summary>
  4572. Gets or sets the last author.
  4573. </summary>
  4574. <value>The last author.</value>
  4575. </member>
  4576. <member name="M:NPOI.HPSF.SummaryInformation.RemoveLastAuthor">
  4577. <summary>
  4578. Removes the last author.
  4579. </summary>
  4580. </member>
  4581. <member name="P:NPOI.HPSF.SummaryInformation.RevNumber">
  4582. <summary>
  4583. Gets or sets the rev number.
  4584. </summary>
  4585. <value>The rev number.</value>
  4586. </member>
  4587. <member name="M:NPOI.HPSF.SummaryInformation.RemoveRevNumber">
  4588. <summary>
  4589. Removes the rev number.
  4590. </summary>
  4591. </member>
  4592. <member name="P:NPOI.HPSF.SummaryInformation.EditTime">
  4593. <summary>
  4594. Returns the Total time spent in editing the document (or 0).
  4595. </summary>
  4596. <value>The Total time spent in editing the document or 0 if the {@link
  4597. SummaryInformation} does not contain this information.</value>
  4598. </member>
  4599. <member name="M:NPOI.HPSF.SummaryInformation.RemoveEditTime">
  4600. <summary>
  4601. Removes the edit time.
  4602. </summary>
  4603. </member>
  4604. <member name="P:NPOI.HPSF.SummaryInformation.LastPrinted">
  4605. <summary>
  4606. Gets or sets the last printed time
  4607. </summary>
  4608. <value>The last printed time</value>
  4609. Returns the last printed time (or <c>null</c>).
  4610. </member>
  4611. <member name="M:NPOI.HPSF.SummaryInformation.RemoveLastPrinted">
  4612. <summary>
  4613. Removes the last printed.
  4614. </summary>
  4615. </member>
  4616. <member name="P:NPOI.HPSF.SummaryInformation.CreateDateTime">
  4617. <summary>
  4618. Gets or sets the create date time.
  4619. </summary>
  4620. <value>The create date time.</value>
  4621. </member>
  4622. <member name="M:NPOI.HPSF.SummaryInformation.RemoveCreateDateTime">
  4623. <summary>
  4624. Removes the create date time.
  4625. </summary>
  4626. </member>
  4627. <member name="P:NPOI.HPSF.SummaryInformation.LastSaveDateTime">
  4628. <summary>
  4629. Gets or sets the last save date time.
  4630. </summary>
  4631. <value>The last save date time.</value>
  4632. </member>
  4633. <member name="M:NPOI.HPSF.SummaryInformation.RemoveLastSaveDateTime">
  4634. <summary>
  4635. Removes the last save date time.
  4636. </summary>
  4637. </member>
  4638. <member name="P:NPOI.HPSF.SummaryInformation.PageCount">
  4639. <summary>
  4640. Gets or sets the page count or 0 if the {@link SummaryInformation} does
  4641. not contain a page count.
  4642. </summary>
  4643. <value>The page count or 0 if the {@link SummaryInformation} does not
  4644. contain a page count.</value>
  4645. </member>
  4646. <member name="M:NPOI.HPSF.SummaryInformation.RemovePageCount">
  4647. <summary>
  4648. Removes the page count.
  4649. </summary>
  4650. </member>
  4651. <member name="P:NPOI.HPSF.SummaryInformation.WordCount">
  4652. <summary>
  4653. Gets or sets the word count or 0 if the {@link SummaryInformation} does
  4654. not contain a word count.
  4655. </summary>
  4656. <value>The word count.</value>
  4657. </member>
  4658. <member name="M:NPOI.HPSF.SummaryInformation.RemoveWordCount">
  4659. <summary>
  4660. Removes the word count.
  4661. </summary>
  4662. </member>
  4663. <member name="P:NPOI.HPSF.SummaryInformation.CharCount">
  4664. <summary>
  4665. Gets or sets the character count or 0 if the {@link SummaryInformation}
  4666. does not contain a char count.
  4667. </summary>
  4668. <value>The character count.</value>
  4669. </member>
  4670. <member name="M:NPOI.HPSF.SummaryInformation.RemoveCharCount">
  4671. <summary>
  4672. Removes the char count.
  4673. </summary>
  4674. </member>
  4675. <member name="P:NPOI.HPSF.SummaryInformation.Thumbnail">
  4676. <summary>
  4677. Gets or sets the thumbnail (or <c>null</c>) <strong>when this
  4678. method is implemented. Please note that the return type is likely To
  4679. Change!</strong>
  4680. <p>To process this data, you may wish to make use of the
  4681. {@link Thumbnail} class. The raw data is generally
  4682. an image in WMF or Clipboard (BMP?) format</p>
  4683. </summary>
  4684. <value>The thumbnail.</value>
  4685. </member>
  4686. <member name="P:NPOI.HPSF.SummaryInformation.ThumbnailThumbnail">
  4687. <summary>
  4688. Returns the thumbnail or null, processed as an object
  4689. which is (largely) able to unpack the thumbnail image data.
  4690. </summary>
  4691. </member>
  4692. <member name="M:NPOI.HPSF.SummaryInformation.RemoveThumbnail">
  4693. <summary>
  4694. Removes the thumbnail.
  4695. </summary>
  4696. </member>
  4697. <member name="P:NPOI.HPSF.SummaryInformation.ApplicationName">
  4698. <summary>
  4699. Gets or sets the name of the application.
  4700. </summary>
  4701. <value>The name of the application.</value>
  4702. </member>
  4703. <member name="M:NPOI.HPSF.SummaryInformation.RemoveApplicationName">
  4704. <summary>
  4705. Removes the name of the application.
  4706. </summary>
  4707. </member>
  4708. <member name="P:NPOI.HPSF.SummaryInformation.Security">
  4709. <summary>
  4710. Gets or sets a security code which is one of the following values:
  4711. <ul>
  4712. <li>0 if the {@link SummaryInformation} does not contain a
  4713. security field or if there is no security on the document. Use
  4714. {@link PropertySet#wasNull()} To distinguish between the two
  4715. cases!</li>
  4716. <li>1 if the document is password protected</li>
  4717. <li>2 if the document is Read-only recommended</li>
  4718. <li>4 if the document is Read-only enforced</li>
  4719. <li>8 if the document is locked for annotations</li>
  4720. </ul>
  4721. </summary>
  4722. <value>The security code</value>
  4723. </member>
  4724. <member name="M:NPOI.HPSF.SummaryInformation.RemoveSecurity">
  4725. <summary>
  4726. Removes the security code.
  4727. </summary>
  4728. </member>
  4729. <member name="T:NPOI.HPSF.Thumbnail">
  4730. <summary>
  4731. Class To manipulate data in the Clipboard Variant (Variant#VT_CF VT_CF) format.
  4732. @author Drew Varner (Drew.Varner inOrAround sc.edu)
  4733. @since 2002-04-29
  4734. </summary>
  4735. </member>
  4736. <member name="F:NPOI.HPSF.Thumbnail.OFFSet_CFTAG">
  4737. <summary>
  4738. OffSet in bytes where the Clipboard Format Tag starts in the <c>byte[]</c> returned by SummaryInformation#GetThumbnail()
  4739. </summary>
  4740. </member>
  4741. <member name="F:NPOI.HPSF.Thumbnail.OFFSet_CF">
  4742. <summary>
  4743. OffSet in bytes where the Clipboard Format starts in the <c>byte[]</c> returned by SummaryInformation#GetThumbnail()
  4744. </summary>
  4745. <remarks>This is only valid if the Clipboard Format Tag is CFTAG_WINDOWS</remarks>
  4746. </member>
  4747. <member name="F:NPOI.HPSF.Thumbnail.OFFSet_WMFDATA">
  4748. <summary>
  4749. OffSet in bytes where the Windows Metafile (WMF) image data starts in the <c>byte[]</c> returned by SummaryInformation#GetThumbnail()
  4750. There is only WMF data at this point in the
  4751. <c>byte[]</c> if the Clipboard Format Tag is
  4752. CFTAG_WINDOWS and the Clipboard Format is
  4753. CF_METAFILEPICT.
  4754. </summary>
  4755. <remarks>Note: The <c>byte[]</c> that starts at
  4756. <c>OFFSet_WMFDATA</c> and ends at
  4757. <c>GetThumbnail().Length - 1</c> forms a complete WMF
  4758. image. It can be saved To disk with a <c>.wmf</c> file
  4759. type and Read using a WMF-capable image viewer.</remarks>
  4760. </member>
  4761. <member name="F:NPOI.HPSF.Thumbnail.CFTAG_WINDOWS">
  4762. <summary>
  4763. Clipboard Format Tag - Windows clipboard format
  4764. </summary>
  4765. <remarks>A <c>DWORD</c> indicating a built-in Windows clipboard format value</remarks>
  4766. </member>
  4767. <member name="F:NPOI.HPSF.Thumbnail.CFTAG_MACINTOSH">
  4768. <summary>
  4769. Clipboard Format Tag - Macintosh clipboard format
  4770. </summary>
  4771. <remarks>A <c>DWORD</c> indicating a Macintosh clipboard format value</remarks>
  4772. </member>
  4773. <member name="F:NPOI.HPSF.Thumbnail.CFTAG_FMTID">
  4774. <summary>
  4775. Clipboard Format Tag - Format ID
  4776. </summary>
  4777. <remarks>A GUID containing a format identifier (FMTID). This is rarely used.</remarks>
  4778. </member>
  4779. <member name="F:NPOI.HPSF.Thumbnail.CFTAG_NODATA">
  4780. <summary>
  4781. Clipboard Format Tag - No Data
  4782. </summary>
  4783. <remarks>A <c>DWORD</c> indicating No data. This is rarely used.</remarks>
  4784. </member>
  4785. <member name="F:NPOI.HPSF.Thumbnail.CF_METAFILEPICT">
  4786. <summary>
  4787. Clipboard Format - Windows metafile format. This is the recommended way To store thumbnails in Property Streams.
  4788. </summary>
  4789. <remarks>Note:This is not the same format used in
  4790. regular WMF images. The clipboard version of this format has an
  4791. extra clipboard-specific header.</remarks>
  4792. </member>
  4793. <member name="F:NPOI.HPSF.Thumbnail.CF_DIB">
  4794. <summary>
  4795. Clipboard Format - Device Independent Bitmap
  4796. </summary>
  4797. </member>
  4798. <member name="F:NPOI.HPSF.Thumbnail.CF_ENHMETAFILE">
  4799. <summary>
  4800. Clipboard Format - Enhanced Windows metafile format
  4801. </summary>
  4802. </member>
  4803. <member name="F:NPOI.HPSF.Thumbnail.CF_BITMAP">
  4804. <summary>
  4805. Clipboard Format - Bitmap
  4806. </summary>
  4807. <remarks>see msdn.microsoft.com/library/en-us/dnw98bk/html/clipboardoperations.asp</remarks>
  4808. </member>
  4809. <member name="F:NPOI.HPSF.Thumbnail.thumbnailData">
  4810. A <c>byte[]</c> To hold a thumbnail image in (
  4811. Variant#VT_CF VT_CF) format.
  4812. </member>
  4813. <member name="M:NPOI.HPSF.Thumbnail.#ctor">
  4814. <summary>
  4815. Default Constructor. If you use it then one you'll have To Add
  4816. the thumbnail <c>byte[]</c> from {@link
  4817. SummaryInformation#GetThumbnail()} To do any useful
  4818. manipulations, otherwise you'll Get a
  4819. <c>NullPointerException</c>.
  4820. </summary>
  4821. </member>
  4822. <member name="M:NPOI.HPSF.Thumbnail.#ctor(System.Byte[])">
  4823. <summary>
  4824. Initializes a new instance of the <see cref="T:NPOI.HPSF.Thumbnail"/> class.
  4825. </summary>
  4826. <param name="thumbnailData">The thumbnail data.</param>
  4827. </member>
  4828. <member name="P:NPOI.HPSF.Thumbnail.ThumbnailData">
  4829. <summary>
  4830. Gets or sets the thumbnail as a <c>byte[]</c> in {@link
  4831. Variant#VT_CF VT_CF} format.
  4832. </summary>
  4833. <value>The thumbnail value</value>
  4834. </member>
  4835. <member name="P:NPOI.HPSF.Thumbnail.ClipboardFormatTag">
  4836. <summary>
  4837. Returns an <c>int</c> representing the Clipboard
  4838. Format Tag
  4839. Possible return values are:
  4840. <ul>
  4841. <li>{@link #CFTAG_WINDOWS CFTAG_WINDOWS}</li>
  4842. <li>{@link #CFTAG_MACINTOSH CFTAG_MACINTOSH}</li>
  4843. <li>{@link #CFTAG_FMTID CFTAG_FMTID}</li>
  4844. <li>{@link #CFTAG_NODATA CFTAG_NODATA}</li>
  4845. </ul>
  4846. </summary>
  4847. <returns>A flag indicating the Clipboard Format Tag</returns>
  4848. </member>
  4849. <member name="M:NPOI.HPSF.Thumbnail.GetClipboardFormat">
  4850. <summary>
  4851. Returns an <c>int</c> representing the Clipboard
  4852. Format
  4853. Will throw an exception if the Thumbnail's Clipboard Format
  4854. Tag is not {@link Thumbnail#CFTAG_WINDOWS CFTAG_WINDOWS}.
  4855. Possible return values are:
  4856. <ul>
  4857. <li>{@link #CF_METAFILEPICT CF_METAFILEPICT}</li>
  4858. <li>{@link #CF_DIB CF_DIB}</li>
  4859. <li>{@link #CF_ENHMETAFILE CF_ENHMETAFILE}</li>
  4860. <li>{@link #CF_BITMAP CF_BITMAP}</li>
  4861. </ul>
  4862. </summary>
  4863. <returns>a flag indicating the Clipboard Format</returns>
  4864. </member>
  4865. <member name="M:NPOI.HPSF.Thumbnail.GetThumbnailAsWMF">
  4866. <summary>
  4867. Returns the Thumbnail as a <c>byte[]</c> of WMF data
  4868. if the Thumbnail's Clipboard Format Tag is {@link
  4869. #CFTAG_WINDOWS CFTAG_WINDOWS} and its Clipboard Format is
  4870. {@link #CF_METAFILEPICT CF_METAFILEPICT}
  4871. This
  4872. <c>byte[]</c> is in the traditional WMF file, not the
  4873. clipboard-specific version with special headers.
  4874. See <a href="http://www.wvware.com/caolan/ora-wmf.html" tarGet="_blank">http://www.wvware.com/caolan/ora-wmf.html</a>
  4875. for more information on the WMF image format.
  4876. @return A WMF image of the Thumbnail
  4877. @throws HPSFException if the Thumbnail isn't CFTAG_WINDOWS and
  4878. CF_METAFILEPICT
  4879. </summary>
  4880. <returns></returns>
  4881. </member>
  4882. <member name="T:NPOI.HPSF.TypeWriter">
  4883. <summary>
  4884. Class for writing little-endian data and more.
  4885. @author Rainer Klute
  4886. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  4887. @since 2003-02-20
  4888. </summary>
  4889. </member>
  4890. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.Int16)">
  4891. <summary>
  4892. Writes a two-byte value (short) To an output stream.
  4893. </summary>
  4894. <param name="out1">The stream To Write To..</param>
  4895. <param name="n">The number of bytes that have been written.</param>
  4896. <returns></returns>
  4897. </member>
  4898. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.Int32)">
  4899. Writes a four-byte value To an output stream.
  4900. @param out The stream To Write To.
  4901. @param n The value To Write.
  4902. @exception IOException if an I/O error occurs
  4903. @return The number of bytes written To the output stream.
  4904. </member>
  4905. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.UInt32)">
  4906. Writes a four-byte value To an output stream.
  4907. @param out The stream To Write To.
  4908. @param n The value To Write.
  4909. @exception IOException if an I/O error occurs
  4910. @return The number of bytes written To the output stream.
  4911. </member>
  4912. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.Int64)">
  4913. Writes a eight-byte value To an output stream.
  4914. @param out The stream To Write To.
  4915. @param n The value To Write.
  4916. @exception IOException if an I/O error occurs
  4917. @return The number of bytes written To the output stream.
  4918. </member>
  4919. <member name="M:NPOI.HPSF.TypeWriter.WriteUShortToStream(System.IO.Stream,System.Int32)">
  4920. Writes an unsigned two-byte value To an output stream.
  4921. @param out The stream To Write To
  4922. @param n The value To Write
  4923. @exception IOException if an I/O error occurs
  4924. </member>
  4925. <member name="M:NPOI.HPSF.TypeWriter.WriteUIntToStream(System.IO.Stream,System.UInt32)">
  4926. Writes an unsigned four-byte value To an output stream.
  4927. @param out The stream To Write To.
  4928. @param n The value To Write.
  4929. @return The number of bytes that have been written To the output stream.
  4930. @exception IOException if an I/O error occurs
  4931. </member>
  4932. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,NPOI.Util.ClassID)">
  4933. Writes a 16-byte {@link ClassID} To an output stream.
  4934. @param out The stream To Write To
  4935. @param n The value To Write
  4936. @return The number of bytes written
  4937. @exception IOException if an I/O error occurs
  4938. </member>
  4939. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,NPOI.HPSF.Property[],System.Int32)">
  4940. Writes an array of {@link Property} instances To an output stream
  4941. according To the Horrible Property Format.
  4942. @param out The stream To Write To
  4943. @param properties The array To Write To the stream
  4944. @param codepage The codepage number To use for writing strings
  4945. @exception IOException if an I/O error occurs
  4946. @throws UnsupportedVariantTypeException if HPSF does not support some
  4947. variant type.
  4948. </member>
  4949. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.Double)">
  4950. Writes a double value value To an output stream.
  4951. @param out The stream To Write To.
  4952. @param n The value To Write.
  4953. @exception IOException if an I/O error occurs
  4954. @return The number of bytes written To the output stream.
  4955. </member>
  4956. <member name="T:NPOI.HPSF.UnexpectedPropertySetTypeException">
  4957. <summary>
  4958. This exception is thrown if a certain type of property Set Is
  4959. expected (e.g. a Document Summary Information) but the provided
  4960. property Set is not of that type.
  4961. The constructors of this class are analogous To those of its
  4962. superclass and documented there.
  4963. @author Rainer Klute
  4964. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  4965. @since 2002-02-09
  4966. </summary>
  4967. </member>
  4968. <member name="M:NPOI.HPSF.UnexpectedPropertySetTypeException.#ctor">
  4969. <summary>
  4970. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnexpectedPropertySetTypeException"/> class.
  4971. </summary>
  4972. </member>
  4973. <member name="M:NPOI.HPSF.UnexpectedPropertySetTypeException.#ctor(System.String)">
  4974. <summary>
  4975. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnexpectedPropertySetTypeException"/> class.
  4976. </summary>
  4977. <param name="msg">The message string.</param>
  4978. </member>
  4979. <member name="M:NPOI.HPSF.UnexpectedPropertySetTypeException.#ctor(System.Exception)">
  4980. <summary>
  4981. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnexpectedPropertySetTypeException"/> class.
  4982. </summary>
  4983. <param name="reason">The reason, i.e. a throwable that indirectly
  4984. caused this exception.</param>
  4985. </member>
  4986. <member name="M:NPOI.HPSF.UnexpectedPropertySetTypeException.#ctor(System.String,System.Exception)">
  4987. <summary>
  4988. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnexpectedPropertySetTypeException"/> class.
  4989. </summary>
  4990. <param name="msg">The message string.</param>
  4991. <param name="reason">The reason, i.e. a throwable that indirectly
  4992. caused this exception.</param>
  4993. </member>
  4994. <member name="M:NPOI.HPSF.UnicodeString.validLength(System.Int32,System.Byte[],System.Int32)">
  4995. Checks to see if the specified length seems valid,
  4996. given the amount of data available still to read,
  4997. and the requirement that the string be NULL-terminated
  4998. </member>
  4999. <member name="T:NPOI.HPSF.UnsupportedEncodingException">
  5000. The Character Encoding is not supported.
  5001. @author Asmus Freytag
  5002. @since JDK1.1
  5003. </member>
  5004. <member name="M:NPOI.HPSF.UnsupportedEncodingException.#ctor">
  5005. Constructs an UnsupportedEncodingException without a detail message.
  5006. </member>
  5007. <member name="M:NPOI.HPSF.UnsupportedEncodingException.#ctor(System.String)">
  5008. Constructs an UnsupportedEncodingException with a detail message.
  5009. @param s Describes the reason for the exception.
  5010. </member>
  5011. <member name="T:NPOI.HPSF.UnsupportedVariantTypeException">
  5012. <summary>
  5013. This exception is thrown if HPSF encounters a variant type that isn't
  5014. supported yet. Although a variant type is unsupported the value can still be
  5015. retrieved using the {@link VariantTypeException#GetValue} method.
  5016. Obviously this class should disappear some day.
  5017. @author Rainer Klute
  5018. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  5019. @since 2003-08-05
  5020. </summary>
  5021. </member>
  5022. <member name="M:NPOI.HPSF.UnsupportedVariantTypeException.#ctor(System.Int64,System.Object)">
  5023. <summary>
  5024. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnsupportedVariantTypeException"/> class.
  5025. </summary>
  5026. <param name="variantType">The unsupported variant type</param>
  5027. <param name="value">The value who's variant type is not yet supported</param>
  5028. </member>
  5029. <member name="T:NPOI.HPSF.Util">
  5030. <summary>
  5031. Provides various static utility methods.
  5032. @author Rainer Klute (klute@rainer-klute.de)
  5033. @since 2002-02-09
  5034. </summary>
  5035. </member>
  5036. <member name="M:NPOI.HPSF.Util.Copy(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
  5037. <summary>
  5038. Copies a part of a byte array into another byte array.
  5039. </summary>
  5040. <param name="src">The source byte array.</param>
  5041. <param name="srcOffSet">OffSet in the source byte array.</param>
  5042. <param name="Length">The number of bytes To Copy.</param>
  5043. <param name="dst">The destination byte array.</param>
  5044. <param name="dstOffSet">OffSet in the destination byte array.</param>
  5045. </member>
  5046. <member name="M:NPOI.HPSF.Util.Cat(System.Byte[][])">
  5047. <summary>
  5048. Concatenates the contents of several byte arrays into a
  5049. single one.
  5050. </summary>
  5051. <param name="byteArrays">The byte arrays To be conCatened.</param>
  5052. <returns>A new byte array containing the conCatenated byte arrays.</returns>
  5053. </member>
  5054. <member name="M:NPOI.HPSF.Util.Copy(System.Byte[],System.Int32,System.Int32)">
  5055. <summary>
  5056. Copies bytes from a source byte array into a new byte
  5057. array.
  5058. </summary>
  5059. <param name="src">Copy from this byte array.</param>
  5060. <param name="offset">Start Copying here.</param>
  5061. <param name="Length">Copy this many bytes.</param>
  5062. <returns>The new byte array. Its Length is number of copied bytes.</returns>
  5063. </member>
  5064. <member name="F:NPOI.HPSF.Util.EPOCH_DIFF">
  5065. The difference between the Windows epoch (1601-01-01
  5066. 00:00:00) and the Unix epoch (1970-01-01 00:00:00) in
  5067. milliseconds: 11644473600000L. (Use your favorite spReadsheet
  5068. program To verify the correctness of this value. By the way,
  5069. did you notice that you can tell from the epochs which
  5070. operating system is the modern one? :-))
  5071. </member>
  5072. <member name="M:NPOI.HPSF.Util.FiletimeToDate(System.Int32,System.Int32)">
  5073. <summary>
  5074. Converts a Windows FILETIME into a {@link DateTime}. The Windows
  5075. FILETIME structure holds a DateTime and time associated with a
  5076. file. The structure identifies a 64-bit integer specifying the
  5077. number of 100-nanosecond intervals which have passed since
  5078. January 1, 1601. This 64-bit value is split into the two double
  5079. words stored in the structure.
  5080. </summary>
  5081. <param name="high">The higher double word of the FILETIME structure.</param>
  5082. <param name="low">The lower double word of the FILETIME structure.</param>
  5083. <returns>The Windows FILETIME as a {@link DateTime}.</returns>
  5084. </member>
  5085. <member name="M:NPOI.HPSF.Util.FiletimeToDate(System.Int64)">
  5086. <summary>
  5087. Converts a Windows FILETIME into a {@link DateTime}. The Windows
  5088. FILETIME structure holds a DateTime and time associated with a
  5089. file. The structure identifies a 64-bit integer specifying the
  5090. number of 100-nanosecond intervals which have passed since
  5091. January 1, 1601.
  5092. </summary>
  5093. <param name="filetime">The filetime To Convert.</param>
  5094. <returns>The Windows FILETIME as a {@link DateTime}.</returns>
  5095. </member>
  5096. <member name="M:NPOI.HPSF.Util.DateToFileTime(System.DateTime)">
  5097. <summary>
  5098. Converts a {@link DateTime} into a filetime.
  5099. </summary>
  5100. <param name="dateTime">The DateTime To be Converted</param>
  5101. <returns>The filetime</returns>
  5102. </member>
  5103. <member name="M:NPOI.HPSF.Util.AreEqual(System.Collections.IList,System.Collections.IList)">
  5104. <summary>
  5105. Compares To object arrays with regarding the objects' order. For
  5106. example, [1, 2, 3] and [2, 1, 3] are equal.
  5107. </summary>
  5108. <param name="c1">The first object array.</param>
  5109. <param name="c2">The second object array.</param>
  5110. <returns><c>true</c>
  5111. if the object arrays are equal,
  5112. <c>false</c>
  5113. if they are not.</returns>
  5114. </member>
  5115. <member name="M:NPOI.HPSF.Util.internalEquals(System.Collections.IList,System.Collections.IList)">
  5116. <summary>
  5117. Internals the equals.
  5118. </summary>
  5119. <param name="c1">The c1.</param>
  5120. <param name="c2">The c2.</param>
  5121. <returns></returns>
  5122. </member>
  5123. <member name="M:NPOI.HPSF.Util.Pad4(System.Byte[])">
  5124. <summary>
  5125. Pads a byte array with 0x00 bytes so that its Length is a multiple of
  5126. 4.
  5127. </summary>
  5128. <param name="ba">The byte array To pad.</param>
  5129. <returns>The padded byte array.</returns>
  5130. </member>
  5131. <member name="M:NPOI.HPSF.Util.Pad4(System.Char[])">
  5132. <summary>
  5133. Pads a character array with 0x0000 characters so that its Length is a
  5134. multiple of 4.
  5135. </summary>
  5136. <param name="ca">The character array To pad.</param>
  5137. <returns>The padded character array.</returns>
  5138. </member>
  5139. <member name="M:NPOI.HPSF.Util.Pad4(System.String)">
  5140. <summary>
  5141. Pads a string with 0x0000 characters so that its Length is a
  5142. multiple of 4.
  5143. </summary>
  5144. <param name="s">The string To pad.</param>
  5145. <returns> The padded string as a character array.</returns>
  5146. </member>
  5147. <member name="T:NPOI.HPSF.Variant">
  5148. <summary>
  5149. The <em>Variant</em> types as defined by Microsoft's COM. I
  5150. found this information in <a href="http://www.marin.clara.net/COM/variant_type_definitions.htm">
  5151. http://www.marin.clara.net/COM/variant_type_definitions.htm</a>.
  5152. In the variant types descriptions the following shortcuts are
  5153. used: <strong> [V]</strong> - may appear in a VARIANT,
  5154. <strong>[T]</strong> - may appear in a TYPEDESC,
  5155. <strong>[P]</strong> - may appear in an OLE property Set,
  5156. <strong>[S]</strong> - may appear in a Safe Array.
  5157. @author Rainer Klute (klute@rainer-klute.de)
  5158. @since 2002-02-09
  5159. </summary>
  5160. </member>
  5161. <member name="F:NPOI.HPSF.Variant.VT_EMPTY">
  5162. [V][P] Nothing, i.e. not a single byte of data.
  5163. </member>
  5164. <member name="F:NPOI.HPSF.Variant.VT_NULL">
  5165. [V][P] SQL style Null.
  5166. </member>
  5167. <member name="F:NPOI.HPSF.Variant.VT_I2">
  5168. [V][T][P][S] 2 byte signed int.
  5169. </member>
  5170. <member name="F:NPOI.HPSF.Variant.VT_I4">
  5171. [V][T][P][S] 4 byte signed int.
  5172. </member>
  5173. <member name="F:NPOI.HPSF.Variant.VT_R4">
  5174. [V][T][P][S] 4 byte real.
  5175. </member>
  5176. <member name="F:NPOI.HPSF.Variant.VT_R8">
  5177. [V][T][P][S] 8 byte real.
  5178. </member>
  5179. <member name="F:NPOI.HPSF.Variant.VT_CY">
  5180. [V][T][P][S] currency. <span style="background-color:
  5181. #ffff00">How long is this? How is it To be
  5182. interpreted?</span>
  5183. </member>
  5184. <member name="F:NPOI.HPSF.Variant.VT_DATE">
  5185. [V][T][P][S] DateTime. <span style="background-color:
  5186. #ffff00">How long is this? How is it To be
  5187. interpreted?</span>
  5188. </member>
  5189. <member name="F:NPOI.HPSF.Variant.VT_BSTR">
  5190. [V][T][P][S] OLE Automation string. <span
  5191. style="background-color: #ffff00">How long is this? How is it
  5192. To be interpreted?</span>
  5193. </member>
  5194. <member name="F:NPOI.HPSF.Variant.VT_DISPATCH">
  5195. [V][T][P][S] IDispatch *. <span style="background-color:
  5196. #ffff00">How long is this? How is it To be
  5197. interpreted?</span>
  5198. </member>
  5199. <member name="F:NPOI.HPSF.Variant.VT_ERROR">
  5200. [V][T][S] SCODE. <span style="background-color: #ffff00">How
  5201. long is this? How is it To be interpreted?</span>
  5202. </member>
  5203. <member name="F:NPOI.HPSF.Variant.VT_BOOL">
  5204. [V][T][P][S] True=-1, False=0.
  5205. </member>
  5206. <member name="F:NPOI.HPSF.Variant.VT_VARIANT">
  5207. [V][T][P][S] VARIANT *. <span style="background-color:
  5208. #ffff00">How long is this? How is it To be
  5209. interpreted?</span>
  5210. </member>
  5211. <member name="F:NPOI.HPSF.Variant.VT_UNKNOWN">
  5212. [V][T][S] IUnknown *. <span style="background-color:
  5213. #ffff00">How long is this? How is it To be
  5214. interpreted?</span>
  5215. </member>
  5216. <member name="F:NPOI.HPSF.Variant.VT_DECIMAL">
  5217. [V][T][S] 16 byte fixed point.
  5218. </member>
  5219. <member name="F:NPOI.HPSF.Variant.VT_I1">
  5220. [T] signed char.
  5221. </member>
  5222. <member name="F:NPOI.HPSF.Variant.VT_UI1">
  5223. [V][T][P][S] unsigned char.
  5224. </member>
  5225. <member name="F:NPOI.HPSF.Variant.VT_UI2">
  5226. [T][P] unsigned short.
  5227. </member>
  5228. <member name="F:NPOI.HPSF.Variant.VT_UI4">
  5229. [T][P] unsigned int.
  5230. </member>
  5231. <member name="F:NPOI.HPSF.Variant.VT_I8">
  5232. [T][P] signed 64-bit int.
  5233. </member>
  5234. <member name="F:NPOI.HPSF.Variant.VT_UI8">
  5235. [T][P] unsigned 64-bit int.
  5236. </member>
  5237. <member name="F:NPOI.HPSF.Variant.VT_INT">
  5238. [T] signed machine int.
  5239. </member>
  5240. <member name="F:NPOI.HPSF.Variant.VT_UINT">
  5241. [T] unsigned machine int.
  5242. </member>
  5243. <member name="F:NPOI.HPSF.Variant.VT_VOID">
  5244. [T] C style void.
  5245. </member>
  5246. <member name="F:NPOI.HPSF.Variant.VT_HRESULT">
  5247. [T] Standard return type. <span style="background-color:
  5248. #ffff00">How long is this? How is it To be
  5249. interpreted?</span>
  5250. </member>
  5251. <member name="F:NPOI.HPSF.Variant.VT_PTR">
  5252. [T] pointer type. <span style="background-color:
  5253. #ffff00">How long is this? How is it To be
  5254. interpreted?</span>
  5255. </member>
  5256. <member name="F:NPOI.HPSF.Variant.VT_SAFEARRAY">
  5257. [T] (use VT_ARRAY in VARIANT).
  5258. </member>
  5259. <member name="F:NPOI.HPSF.Variant.VT_CARRAY">
  5260. [T] C style array. <span style="background-color:
  5261. #ffff00">How long is this? How is it To be
  5262. interpreted?</span>
  5263. </member>
  5264. <member name="F:NPOI.HPSF.Variant.VT_USERDEFINED">
  5265. [T] user defined type. <span style="background-color:
  5266. #ffff00">How long is this? How is it To be
  5267. interpreted?</span>
  5268. </member>
  5269. <member name="F:NPOI.HPSF.Variant.VT_LPSTR">
  5270. [T][P] null terminated string.
  5271. </member>
  5272. <member name="F:NPOI.HPSF.Variant.VT_LPWSTR">
  5273. [T][P] wide (Unicode) null terminated string.
  5274. </member>
  5275. <member name="F:NPOI.HPSF.Variant.VT_FILETIME">
  5276. [P] FILETIME. The FILETIME structure holds a DateTime and time
  5277. associated with a file. The structure identifies a 64-bit
  5278. integer specifying the number of 100-nanosecond intervals which
  5279. have passed since January 1, 1601. This 64-bit value is split
  5280. into the two dwords stored in the structure.
  5281. </member>
  5282. <member name="F:NPOI.HPSF.Variant.VT_BLOB">
  5283. [P] Length prefixed bytes.
  5284. </member>
  5285. <member name="F:NPOI.HPSF.Variant.VT_STREAM">
  5286. [P] Name of the stream follows.
  5287. </member>
  5288. <member name="F:NPOI.HPSF.Variant.VT_STORAGE">
  5289. [P] Name of the storage follows.
  5290. </member>
  5291. <member name="F:NPOI.HPSF.Variant.VT_STREAMED_OBJECT">
  5292. [P] Stream Contains an object. <span
  5293. style="background-color: #ffff00"> How long is this? How is it
  5294. To be interpreted?</span>
  5295. </member>
  5296. <member name="F:NPOI.HPSF.Variant.VT_STORED_OBJECT">
  5297. [P] Storage Contains an object. <span
  5298. style="background-color: #ffff00"> How long is this? How is it
  5299. To be interpreted?</span>
  5300. </member>
  5301. <member name="F:NPOI.HPSF.Variant.VT_BLOB_OBJECT">
  5302. [P] Blob Contains an object. <span style="background-color:
  5303. #ffff00">How long is this? How is it To be
  5304. interpreted?</span>
  5305. </member>
  5306. <member name="F:NPOI.HPSF.Variant.VT_CF">
  5307. [P] Clipboard format. <span style="background-color:
  5308. #ffff00">How long is this? How is it To be
  5309. interpreted?</span>
  5310. </member>
  5311. <member name="F:NPOI.HPSF.Variant.VT_CLSID">
  5312. [P] A Class ID.
  5313. It consists of a 32 bit unsigned integer indicating the size
  5314. of the structure, a 32 bit signed integer indicating (Clipboard
  5315. Format Tag) indicating the type of data that it Contains, and
  5316. then a byte array containing the data.
  5317. The valid Clipboard Format Tags are:
  5318. <ul>
  5319. <li>{@link Thumbnail#CFTAG_WINDOWS}</li>
  5320. <li>{@link Thumbnail#CFTAG_MACINTOSH}</li>
  5321. <li>{@link Thumbnail#CFTAG_NODATA}</li>
  5322. <li>{@link Thumbnail#CFTAG_FMTID}</li>
  5323. </ul>
  5324. <pre>typedef struct tagCLIPDATA {
  5325. // cbSize is the size of the buffer pointed To
  5326. // by pClipData, plus sizeof(ulClipFmt)
  5327. ULONG cbSize;
  5328. long ulClipFmt;
  5329. BYTE* pClipData;
  5330. } CLIPDATA;</pre>
  5331. See <a
  5332. href="msdn.microsoft.com/library/en-us/com/stgrstrc_0uwk.asp"
  5333. tarGet="_blank">
  5334. msdn.microsoft.com/library/en-us/com/stgrstrc_0uwk.asp</a>.
  5335. </member>
  5336. <member name="F:NPOI.HPSF.Variant.VT_VERSIONED_STREAM">
  5337. "MUST be a VersionedStream. The storage representing the (non-simple)
  5338. property set MUST have a stream element with the name in the StreamName
  5339. field." -- [MS-OLEPS] -- v20110920; Object Linking and Embedding (OLE)
  5340. Property Set Data Structures; page 24 / 63
  5341. </member>
  5342. <member name="F:NPOI.HPSF.Variant.VT_VECTOR">
  5343. [P] simple counted array. <span style="background-color:
  5344. #ffff00">How long is this? How is it To be
  5345. interpreted?</span>
  5346. </member>
  5347. <member name="F:NPOI.HPSF.Variant.VT_ARRAY">
  5348. [V] SAFEARRAY*. <span style="background-color: #ffff00">How
  5349. long is this? How is it To be interpreted?</span>
  5350. </member>
  5351. <member name="F:NPOI.HPSF.Variant.VT_BYREF">
  5352. [V] void* for local use. <span style="background-color:
  5353. #ffff00">How long is this? How is it To be
  5354. interpreted?</span>
  5355. </member>
  5356. <member name="F:NPOI.HPSF.Variant.VT_RESERVED">
  5357. FIXME (3): Document this!
  5358. </member>
  5359. <member name="F:NPOI.HPSF.Variant.VT_ILLEGAL">
  5360. FIXME (3): Document this!
  5361. </member>
  5362. <member name="F:NPOI.HPSF.Variant.VT_ILLEGALMASKED">
  5363. FIXME (3): Document this!
  5364. </member>
  5365. <member name="F:NPOI.HPSF.Variant.VT_TYPEMASK">
  5366. FIXME (3): Document this!
  5367. </member>
  5368. <member name="F:NPOI.HPSF.Variant.numberToName">
  5369. Maps the numbers denoting the variant types To their corresponding
  5370. variant type names.
  5371. </member>
  5372. <member name="F:NPOI.HPSF.Variant.Length_UNKNOWN">
  5373. Denotes a variant type with a Length that is unknown To HPSF yet.
  5374. </member>
  5375. <member name="F:NPOI.HPSF.Variant.Length_VARIABLE">
  5376. Denotes a variant type with a variable Length.
  5377. </member>
  5378. <member name="F:NPOI.HPSF.Variant.Length_0">
  5379. Denotes a variant type with a Length of 0 bytes.
  5380. </member>
  5381. <member name="F:NPOI.HPSF.Variant.Length_2">
  5382. Denotes a variant type with a Length of 2 bytes.
  5383. </member>
  5384. <member name="F:NPOI.HPSF.Variant.Length_4">
  5385. Denotes a variant type with a Length of 4 bytes.
  5386. </member>
  5387. <member name="F:NPOI.HPSF.Variant.Length_8">
  5388. Denotes a variant type with a Length of 8 bytes.
  5389. </member>
  5390. <member name="M:NPOI.HPSF.Variant.GetVariantName(System.Int64)">
  5391. <summary>
  5392. Returns the variant type name associated with a variant type
  5393. number.
  5394. </summary>
  5395. <param name="variantType">The variant type number.</param>
  5396. <returns>The variant type name or the string "unknown variant type"</returns>
  5397. </member>
  5398. <member name="M:NPOI.HPSF.Variant.GetVariantLength(System.Int64)">
  5399. <summary>
  5400. Returns a variant type's Length.
  5401. </summary>
  5402. <param name="variantType">The variant type number.</param>
  5403. <returns>The Length of the variant type's data in bytes. If the Length Is
  5404. variable, i.e. the Length of a string, -1 is returned. If HPSF does not
  5405. know the Length, -2 is returned. The latter usually indicates an
  5406. unsupported variant type.</returns>
  5407. </member>
  5408. <member name="T:NPOI.HPSF.VariantSupport">
  5409. <summary>
  5410. Supports Reading and writing of variant data.
  5411. <strong>FIXME (3):</strong>
  5412. Reading and writing should be made more
  5413. uniform than it is now. The following items should be resolved:
  5414. Reading requires a Length parameter that is 4 byte greater than the
  5415. actual data, because the variant type field is included.
  5416. Reading Reads from a byte array while writing Writes To an byte array
  5417. output stream.
  5418. @author Rainer Klute
  5419. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  5420. @since 2003-08-08
  5421. </summary>
  5422. </member>
  5423. <member name="P:NPOI.HPSF.VariantSupport.IsLogUnsupportedTypes">
  5424. <summary>
  5425. Checks whether logging of unsupported variant types warning is turned
  5426. on or off.
  5427. </summary>
  5428. <value>
  5429. <c>true</c> if logging is turned on; otherwise, <c>false</c>.
  5430. </value>
  5431. </member>
  5432. <member name="F:NPOI.HPSF.VariantSupport.unsupportedMessage">
  5433. Keeps a list of the variant types an "unsupported" message has alReady
  5434. been issued for.
  5435. </member>
  5436. <member name="M:NPOI.HPSF.VariantSupport.WriteUnsupportedTypeMessage(NPOI.HPSF.UnsupportedVariantTypeException)">
  5437. <summary>
  5438. Writes a warning To System.err that a variant type Is
  5439. unsupported by HPSF. Such a warning is written only once for each variant
  5440. type. Log messages can be turned on or off by
  5441. </summary>
  5442. <param name="ex">The exception To log</param>
  5443. </member>
  5444. <member name="F:NPOI.HPSF.VariantSupport.SUPPORTED_TYPES">
  5445. HPSF is able To Read these {@link Variant} types.
  5446. </member>
  5447. <member name="M:NPOI.HPSF.VariantSupport.IsSupportedType(System.Int32)">
  5448. <summary>
  5449. Checks whether HPSF supports the specified variant type. Unsupported
  5450. types should be implemented included in the {@link #SUPPORTED_TYPES}
  5451. array.
  5452. </summary>
  5453. <param name="variantType">the variant type To check</param>
  5454. <returns>
  5455. <c>true</c> if HPFS supports this type,otherwise, <c>false</c>.
  5456. </returns>
  5457. </member>
  5458. <member name="M:NPOI.HPSF.VariantSupport.Read(System.Byte[],System.Int32,System.Int32,System.Int64,System.Int32)">
  5459. <summary>
  5460. Reads a variant type from a byte array
  5461. </summary>
  5462. <param name="src">The byte array</param>
  5463. <param name="offset">The offset in the byte array where the variant starts</param>
  5464. <param name="length">The Length of the variant including the variant type field</param>
  5465. <param name="type">The variant type To Read</param>
  5466. <param name="codepage">The codepage To use for non-wide strings</param>
  5467. <returns>A Java object that corresponds best To the variant field. For
  5468. example, a VT_I4 is returned as a {@link long}, a VT_LPSTR as a
  5469. {@link String}.</returns>
  5470. </member>
  5471. <member name="M:NPOI.HPSF.VariantSupport.CodepageToEncoding(System.Int32)">
  5472. <p>Turns a codepage number into the equivalent character encoding's
  5473. name.</p>
  5474. @param codepage The codepage number
  5475. @return The character encoding's name. If the codepage number is 65001,
  5476. the encoding name is "UTF-8". All other positive numbers are mapped to
  5477. "cp" followed by the number, e.g. if the codepage number is 1252 the
  5478. returned character encoding name will be "cp1252".
  5479. @exception UnsupportedEncodingException if the specified codepage is
  5480. less than zero.
  5481. </member>
  5482. <member name="M:NPOI.HPSF.VariantSupport.Write(System.IO.Stream,System.Int64,System.Object,System.Int32)">
  5483. <summary>
  5484. Writes a variant value To an output stream. This method ensures that
  5485. always a multiple of 4 bytes is written.
  5486. If the codepage is UTF-16, which is encouraged, strings
  5487. <strong>must</strong> always be written as {@link Variant#VT_LPWSTR}
  5488. strings, not as {@link Variant#VT_LPSTR} strings. This method ensure this
  5489. by Converting strings appropriately, if needed.
  5490. </summary>
  5491. <param name="out1">The stream To Write the value To.</param>
  5492. <param name="type">The variant's type.</param>
  5493. <param name="value">The variant's value.</param>
  5494. <param name="codepage">The codepage To use To Write non-wide strings</param>
  5495. <returns>The number of entities that have been written. In many cases an
  5496. "entity" is a byte but this is not always the case.</returns>
  5497. </member>
  5498. <member name="T:NPOI.HPSF.VariantTypeException">
  5499. <summary>
  5500. This exception is thrown if HPSF encounters a problem with a variant type.
  5501. Concrete subclasses specifiy the problem further.
  5502. @author Rainer Klute
  5503. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  5504. @since 2004-06-21
  5505. </summary>
  5506. </member>
  5507. <member name="M:NPOI.HPSF.VariantTypeException.#ctor(System.Int64,System.Object,System.String)">
  5508. <summary>
  5509. Initializes a new instance of the <see cref="T:NPOI.HPSF.VariantTypeException"/> class.
  5510. </summary>
  5511. <param name="variantType">The variant type causing the problem</param>
  5512. <param name="value">The value who's variant type causes the problem</param>
  5513. <param name="msg">A message text describing the problem</param>
  5514. </member>
  5515. <member name="P:NPOI.HPSF.VariantTypeException.VariantType">
  5516. <summary>
  5517. Gets the offending variant type
  5518. </summary>
  5519. <value>the offending variant type.</value>
  5520. </member>
  5521. <member name="P:NPOI.HPSF.VariantTypeException.Value">
  5522. <summary>
  5523. Returns the value who's variant type caused the problem.
  5524. </summary>
  5525. <value>the value who's variant type caused the problem.</value>
  5526. </member>
  5527. <member name="T:NPOI.HPSF.Wellknown.PropertyIDMap">
  5528. <summary>
  5529. This is a dictionary which maps property ID values To property
  5530. ID strings.
  5531. The methods {@link #GetSummaryInformationProperties} and {@link
  5532. #GetDocumentSummaryInformationProperties} return singleton {@link
  5533. PropertyIDMap}s. An application that wants To extend these maps
  5534. should treat them as unmodifiable, copy them and modifiy the
  5535. copies.
  5536. @author Rainer Klute
  5537. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  5538. @since 2002-02-09
  5539. </summary>
  5540. </member>
  5541. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_TITLE">
  5542. ID of the property that denotes the document's title
  5543. </member>
  5544. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_SUBJECT">
  5545. ID of the property that denotes the document's subject
  5546. </member>
  5547. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_AUTHOR">
  5548. ID of the property that denotes the document's author
  5549. </member>
  5550. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_KEYWORDS">
  5551. ID of the property that denotes the document's keywords
  5552. </member>
  5553. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_COMMENTS">
  5554. ID of the property that denotes the document's comments
  5555. </member>
  5556. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_TEMPLATE">
  5557. ID of the property that denotes the document's template
  5558. </member>
  5559. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LASTAUTHOR">
  5560. ID of the property that denotes the document's last author
  5561. </member>
  5562. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_REVNUMBER">
  5563. ID of the property that denotes the document's revision number
  5564. </member>
  5565. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_EDITTIME">
  5566. ID of the property that denotes the document's edit time
  5567. </member>
  5568. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LASTPRINTED">
  5569. ID of the property that denotes the DateTime and time the document was
  5570. last printed
  5571. </member>
  5572. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_Create_DTM">
  5573. ID of the property that denotes the DateTime and time the document was
  5574. Created.
  5575. </member>
  5576. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LASTSAVE_DTM">
  5577. ID of the property that denotes the DateTime and time the document was
  5578. saved
  5579. </member>
  5580. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_PAGECOUNT">
  5581. ID of the property that denotes the number of pages in the
  5582. document
  5583. </member>
  5584. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_WORDCOUNT">
  5585. ID of the property that denotes the number of words in the
  5586. document
  5587. </member>
  5588. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_CHARCOUNT">
  5589. ID of the property that denotes the number of characters in the
  5590. document
  5591. </member>
  5592. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_THUMBNAIL">
  5593. ID of the property that denotes the document's thumbnail
  5594. </member>
  5595. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_APPNAME">
  5596. ID of the property that denotes the application that Created the
  5597. document
  5598. </member>
  5599. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_SECURITY">
  5600. ID of the property that denotes whether Read/Write access To the
  5601. document is allowed or whether is should be opened as Read-only. It can
  5602. have the following values:
  5603. <table>
  5604. <tbody>
  5605. <tr>
  5606. <th>Value</th>
  5607. <th>Description</th>
  5608. </tr>
  5609. <tr>
  5610. <th>0</th>
  5611. <th>No restriction</th>
  5612. </tr>
  5613. <tr>
  5614. <th>2</th>
  5615. <th>Read-only recommended</th>
  5616. </tr>
  5617. <tr>
  5618. <th>4</th>
  5619. <th>Read-only enforced</th>
  5620. </tr>
  5621. </tbody>
  5622. </table>
  5623. </member>
  5624. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_DICTIONARY">
  5625. The entry is a dictionary.
  5626. </member>
  5627. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_CODEPAGE">
  5628. The entry denotes a code page.
  5629. </member>
  5630. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_CATEGORY">
  5631. The entry is a string denoting the category the file belongs
  5632. To, e.g. review, memo, etc. This is useful To Find documents of
  5633. same type.
  5634. </member>
  5635. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_PRESFORMAT">
  5636. TarGet format for power point presentation, e.g. 35mm,
  5637. printer, video etc.
  5638. </member>
  5639. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_BYTECOUNT">
  5640. Number of bytes.
  5641. </member>
  5642. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LINECOUNT">
  5643. Number of lines.
  5644. </member>
  5645. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_PARCOUNT">
  5646. Number of paragraphs.
  5647. </member>
  5648. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_SLIDECOUNT">
  5649. Number of slides in a power point presentation.
  5650. </member>
  5651. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_NOTECOUNT">
  5652. Number of slides with notes.
  5653. </member>
  5654. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_HIDDENCOUNT">
  5655. Number of hidden slides.
  5656. </member>
  5657. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_MMCLIPCOUNT">
  5658. Number of multimedia clips, e.g. sound or video.
  5659. </member>
  5660. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_SCALE">
  5661. This entry is Set To -1 when scaling of the thumbnail Is
  5662. desired. Otherwise the thumbnail should be cropped.
  5663. </member>
  5664. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_HEADINGPAIR">
  5665. This entry denotes an internally used property. It is a
  5666. vector of variants consisting of pairs of a string (VT_LPSTR)
  5667. and a number (VT_I4). The string is a heading name, and the
  5668. number tells how many document parts are under that
  5669. heading.
  5670. </member>
  5671. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_DOCPARTS">
  5672. This entry Contains the names of document parts (word: names
  5673. of the documents in the master document, excel: sheet names,
  5674. power point: slide titles, binder: document names).
  5675. </member>
  5676. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_MANAGER">
  5677. This entry Contains the name of the project manager.
  5678. </member>
  5679. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_COMPANY">
  5680. This entry Contains the company name.
  5681. </member>
  5682. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LINKSDIRTY">
  5683. If this entry is -1 the links are dirty and should be
  5684. re-evaluated.
  5685. </member>
  5686. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_CCHWITHSPACES">
  5687. The entry specifies an estimate of the number of characters
  5688. in the document, including whitespace, as an integer
  5689. </member>
  5690. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_HYPERLINKSCHANGED">
  5691. This entry contains a boolean which marks if the User Defined
  5692. Property Set has been updated outside of the Application, if so the
  5693. hyperlinks should be updated on document load.
  5694. </member>
  5695. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_VERSION">
  5696. This entry contains the version of the Application which wrote the
  5697. Property set, stored with the two high order bytes having the major
  5698. version number, and the two low order bytes the minor version number.
  5699. </member>
  5700. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_DIGSIG">
  5701. This entry contains the VBA digital signature for the VBA project
  5702. embedded in the document.
  5703. </member>
  5704. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_CONTENTTYPE">
  5705. This entry contains a string of the content type of the file.
  5706. </member>
  5707. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_CONTENTSTATUS">
  5708. This entry contains a string of the document status.
  5709. </member>
  5710. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LANGUAGE">
  5711. This entry contains a string of the document language, but
  5712. normally should be empty.
  5713. </member>
  5714. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_DOCVERSION">
  5715. This entry contains a string of the document version, but
  5716. normally should be empty
  5717. </member>
  5718. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_MAX">
  5719. <p>The highest well-known property ID. Applications are free to use
  5720. higher values for custom purposes. (This value is based on Office 12,
  5721. earlier versions of Office had lower values)</p>
  5722. </member>
  5723. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.summaryInformationProperties">
  5724. Contains the summary information property ID values and
  5725. associated strings. See the overall HPSF documentation for
  5726. details!
  5727. </member>
  5728. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.documentSummaryInformationProperties">
  5729. Contains the summary information property ID values and
  5730. associated strings. See the overall HPSF documentation for
  5731. details!
  5732. </member>
  5733. <member name="M:NPOI.HPSF.Wellknown.PropertyIDMap.#ctor(System.Int32,System.Single)">
  5734. <summary>
  5735. Initializes a new instance of the <see cref="T:NPOI.HPSF.Wellknown.PropertyIDMap"/> class.
  5736. </summary>
  5737. <param name="initialCapacity">initialCapacity The initial capacity as defined for
  5738. {@link HashMap}</param>
  5739. <param name="loadFactor">The load factor as defined for {@link HashMap}</param>
  5740. </member>
  5741. <member name="M:NPOI.HPSF.Wellknown.PropertyIDMap.#ctor(System.Collections.IDictionary)">
  5742. <summary>
  5743. Initializes a new instance of the <see cref="T:NPOI.HPSF.Wellknown.PropertyIDMap"/> class.
  5744. </summary>
  5745. <param name="map">The instance To be Created is backed by this map.</param>
  5746. </member>
  5747. <member name="M:NPOI.HPSF.Wellknown.PropertyIDMap.Put(System.Int64,System.String)">
  5748. <summary>
  5749. Puts a ID string for an ID into the {@link
  5750. PropertyIDMap}.
  5751. </summary>
  5752. <param name="id">The ID string.</param>
  5753. <param name="idString">The id string.</param>
  5754. <returns>As specified by the {@link java.util.Map} interface, this method
  5755. returns the previous value associated with the specified id</returns>
  5756. </member>
  5757. <member name="M:NPOI.HPSF.Wellknown.PropertyIDMap.Get(System.Int64)">
  5758. <summary>
  5759. Gets the ID string for an ID from the {@link
  5760. PropertyIDMap}.
  5761. </summary>
  5762. <param name="id">The ID.</param>
  5763. <returns>The ID string associated with id</returns>
  5764. </member>
  5765. <member name="P:NPOI.HPSF.Wellknown.PropertyIDMap.SummaryInformationProperties">
  5766. <summary>
  5767. Gets the Summary Information properties singleton
  5768. </summary>
  5769. <returns></returns>
  5770. </member>
  5771. <member name="P:NPOI.HPSF.Wellknown.PropertyIDMap.DocumentSummaryInformationProperties">
  5772. <summary>
  5773. Gets the Document Summary Information properties
  5774. singleton.
  5775. </summary>
  5776. <returns>The Document Summary Information properties singleton.</returns>
  5777. </member>
  5778. <member name="T:NPOI.HPSF.Wellknown.SectionIDMap">
  5779. <summary>
  5780. Maps section format IDs To {@link PropertyIDMap}s. It Is
  5781. initialized with two well-known section format IDs: those of the
  5782. <c>\005SummaryInformation</c> stream and the
  5783. <c>\005DocumentSummaryInformation</c> stream.
  5784. If you have a section format ID you can use it as a key To query
  5785. this map. If you Get a {@link PropertyIDMap} returned your section
  5786. is well-known and you can query the {@link PropertyIDMap} for PID
  5787. strings. If you Get back <c>null</c> you are on your own.
  5788. This {@link java.util.Map} expects the byte arrays of section format IDs
  5789. as keys. A key maps To a {@link PropertyIDMap} describing the
  5790. property IDs in sections with the specified section format ID.
  5791. @author Rainer Klute (klute@rainer-klute.de)
  5792. @since 2002-02-09
  5793. </summary>
  5794. </member>
  5795. <member name="F:NPOI.HPSF.Wellknown.SectionIDMap.SUMMARY_INFORMATION_ID">
  5796. The SummaryInformation's section's format ID.
  5797. </member>
  5798. <member name="F:NPOI.HPSF.Wellknown.SectionIDMap.DOCUMENT_SUMMARY_INFORMATION_ID1">
  5799. The DocumentSummaryInformation's first and second sections' format
  5800. ID.
  5801. </member>
  5802. <member name="F:NPOI.HPSF.Wellknown.SectionIDMap.UNDEFINED">
  5803. A property without a known name is described by this string.
  5804. </member>
  5805. <member name="F:NPOI.HPSF.Wellknown.SectionIDMap.defaultMap">
  5806. The default section ID map. It maps section format IDs To
  5807. {@link PropertyIDMap}s.
  5808. </member>
  5809. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.GetInstance">
  5810. <summary>
  5811. Returns the singleton instance of the default {@link
  5812. SectionIDMap}.
  5813. </summary>
  5814. <returns>The instance value</returns>
  5815. </member>
  5816. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.GetPIDString(System.Byte[],System.Int64)">
  5817. <summary>
  5818. Returns the property ID string that is associated with a
  5819. given property ID in a section format ID's namespace.
  5820. </summary>
  5821. <param name="sectionFormatID">Each section format ID has its own name
  5822. space of property ID strings and thus must be specified.</param>
  5823. <param name="pid">The property ID</param>
  5824. <returns>The well-known property ID string associated with the
  5825. property ID pid in the name space spanned by sectionFormatID If the pid
  5826. sectionFormatID combination is not well-known, the
  5827. string "[undefined]" is returned.
  5828. </returns>
  5829. </member>
  5830. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.Get(System.Byte[])">
  5831. <summary>
  5832. Returns the {@link PropertyIDMap} for a given section format
  5833. ID.
  5834. </summary>
  5835. <param name="sectionFormatID">The section format ID.</param>
  5836. <returns>the property ID map</returns>
  5837. </member>
  5838. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.Put(System.Byte[],NPOI.HPSF.Wellknown.PropertyIDMap)">
  5839. <summary>
  5840. Associates a section format ID with a {@link
  5841. PropertyIDMap}.
  5842. </summary>
  5843. <param name="sectionFormatID">the section format ID</param>
  5844. <param name="propertyIDMap">The property ID map.</param>
  5845. <returns></returns>
  5846. </member>
  5847. <member name="T:NPOI.HPSF.WritingNotSupportedException">
  5848. <summary>
  5849. This exception is thrown when trying To Write a (yet) unsupported variant
  5850. type.
  5851. @see ReadingNotSupportedException
  5852. @see UnsupportedVariantTypeException
  5853. @author Rainer Klute
  5854. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  5855. @since 2003-08-08
  5856. </summary>
  5857. </member>
  5858. <member name="M:NPOI.HPSF.WritingNotSupportedException.#ctor(System.Int64,System.Object)">
  5859. <summary>
  5860. Initializes a new instance of the <see cref="T:NPOI.HPSF.WritingNotSupportedException"/> class.
  5861. </summary>
  5862. <param name="variantType">The unsupported variant type.</param>
  5863. <param name="value">The value</param>
  5864. </member>
  5865. <member name="T:NPOI.HSSF.EventModel.IERFListener">
  5866. An ERFListener Is registered with the EventRecordFactory.
  5867. An ERFListener listens for Records coming from the stream
  5868. via the EventRecordFactory
  5869. @see EventRecordFactory
  5870. @author Andrew C. Oliver acoliver@apache.org
  5871. </member>
  5872. <member name="M:NPOI.HSSF.EventModel.IERFListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  5873. Process a Record. This method Is called by the
  5874. EventRecordFactory when a record Is returned.
  5875. @return bool specifying whether the effort was a success.
  5876. </member>
  5877. <member name="T:NPOI.HSSF.EventModel.EventRecordFactory">
  5878. Event-based record factory. As opposed to RecordFactory
  5879. this refactored version throws record events as it comes
  5880. accross the records. I throws the "lazily" one record behind
  5881. to ensure that ContinueRecords are Processed first.
  5882. @author Andrew C. Oliver (acoliver@apache.org) - probably to blame for the bugs (so yank his chain on the list)
  5883. @author Marc Johnson (mjohnson at apache dot org) - methods taken from RecordFactory
  5884. @author Glen Stampoultzis (glens at apache.org) - methods taken from RecordFactory
  5885. @author Csaba Nagy (ncsaba at yahoo dot com)
  5886. </member>
  5887. <member name="M:NPOI.HSSF.EventModel.EventRecordFactory.#ctor(NPOI.HSSF.EventModel.IERFListener,System.Collections.ArrayList)">
  5888. Create an EventRecordFactory
  5889. @param abortable specifies whether the return from the listener
  5890. handler functions are obeyed. False means they are ignored. True
  5891. means the event loop exits on error.
  5892. </member>
  5893. <member name="M:NPOI.HSSF.EventModel.EventRecordFactory.ProcessRecord(NPOI.HSSF.Record.Record)">
  5894. sends the record event to all registered listeners.
  5895. @param record the record to be thrown.
  5896. @return <c>false</c> to abort. This aborts
  5897. out of the event loop should the listener return false
  5898. </member>
  5899. <member name="M:NPOI.HSSF.EventModel.EventRecordFactory.ProcessRecords(System.IO.Stream)">
  5900. Create an array of records from an input stream
  5901. @param in the InputStream from which the records will be
  5902. obtained
  5903. @exception RecordFormatException on error Processing the
  5904. InputStream
  5905. </member>
  5906. <member name="T:NPOI.HSSF.EventUserModel.AbortableHSSFListener">
  5907. Interface for use with the HSSFRequest and HSSFEventFactory. Users should Create
  5908. a listener supporting this interface and register it with the HSSFRequest (associating
  5909. it with Record SID's).
  5910. @see org.apache.poi.hssf.eventusermodel.HSSFEventFactory
  5911. @see org.apache.poi.hssf.eventusermodel.HSSFRequest
  5912. @see org.apache.poi.hssf.eventusermodel.HSSFUserException
  5913. @author Carey Sublette (careysub@earthling.net)
  5914. </member>
  5915. <member name="M:NPOI.HSSF.EventUserModel.AbortableHSSFListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  5916. This method, inherited from HSSFListener Is implemented as a stub.
  5917. It Is never called by HSSFEventFActory or HSSFRequest.
  5918. </member>
  5919. <member name="M:NPOI.HSSF.EventUserModel.AbortableHSSFListener.AbortableProcessRecord(NPOI.HSSF.Record.Record)">
  5920. Process an HSSF Record. Called when a record occurs in an HSSF file.
  5921. Provides two options for halting the Processing of the HSSF file.
  5922. The return value provides a means of non-error termination with a
  5923. user-defined result code. A value of zero must be returned to
  5924. continue Processing, any other value will halt Processing by
  5925. <c>HSSFEventFactory</c> with the code being passed back by
  5926. its abortable Process events methods.
  5927. Error termination can be done by throwing the HSSFUserException.
  5928. Note that HSSFEventFactory will not call the inherited Process
  5929. @return result code of zero for continued Processing.
  5930. @throws HSSFUserException User code can throw this to abort
  5931. file Processing by HSSFEventFactory and return diagnostic information.
  5932. </member>
  5933. <member name="T:NPOI.HSSF.EventUserModel.DummyRecord.DummyRecordBase">
  5934. </member>
  5935. <member name="T:NPOI.HSSF.EventUserModel.DummyRecord.LastCellOfRowDummyRecord">
  5936. A dummy record to indicate that we've now had the last
  5937. cell record for this row.
  5938. </member>
  5939. <member name="P:NPOI.HSSF.EventUserModel.DummyRecord.LastCellOfRowDummyRecord.Row">
  5940. Returns the (0 based) number of the row we are
  5941. currently working on.
  5942. </member>
  5943. <member name="P:NPOI.HSSF.EventUserModel.DummyRecord.LastCellOfRowDummyRecord.LastColumnNumber">
  5944. Returns the (0 based) number of the last column
  5945. seen for this row. You should have alReady been
  5946. called with that record.
  5947. This Is -1 in the case of there being no columns
  5948. for the row.
  5949. </member>
  5950. <member name="T:NPOI.HSSF.EventUserModel.DummyRecord.MissingCellDummyRecord">
  5951. A dummy record for when we're missing a cell in a row,
  5952. but still want to trigger something
  5953. </member>
  5954. <member name="T:NPOI.HSSF.EventUserModel.DummyRecord.MissingRowDummyRecord">
  5955. A dummy record for when we're missing a row, but still
  5956. want to trigger something
  5957. </member>
  5958. <member name="T:NPOI.HSSF.EventUserModel.EventWorkbookBuilder">
  5959. <summary>
  5960. When working with the EventUserModel, if you want to
  5961. Process formulas, you need an instance of
  5962. Workbook to pass to a HSSFWorkbook,
  5963. to finally give to HSSFFormulaParser,
  5964. and this will build you stub ones.
  5965. Since you're working with the EventUserModel, you
  5966. wouldn't want to Get a full Workbook and
  5967. HSSFWorkbook, as they would eat too much memory.
  5968. Instead, you should collect a few key records as they
  5969. go past, then call this once you have them to build a
  5970. stub Workbook, and from that a stub
  5971. HSSFWorkbook, to use with the HSSFFormulaParser.
  5972. The records you should collect are:
  5973. ExternSheetRecord
  5974. BoundSheetRecord
  5975. You should probably also collect SSTRecord,
  5976. but it's not required to pass this in.
  5977. To help, this class includes a HSSFListener wrapper
  5978. that will do the collecting for you.
  5979. </summary>
  5980. </member>
  5981. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.CreateStubWorkbook(NPOI.HSSF.Record.ExternSheetRecord[],NPOI.HSSF.Record.BoundSheetRecord[],NPOI.HSSF.Record.SSTRecord)">
  5982. <summary>
  5983. Creates a stub Workbook from the supplied records,
  5984. suitable for use with the {@link HSSFFormulaParser}
  5985. </summary>
  5986. <param name="externs">The ExternSheetRecords in your file</param>
  5987. <param name="bounds">The BoundSheetRecords in your file</param>
  5988. <param name="sst">TThe SSTRecord in your file.</param>
  5989. <returns>A stub Workbook suitable for use with HSSFFormulaParser</returns>
  5990. </member>
  5991. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.CreateStubWorkbook(NPOI.HSSF.Record.ExternSheetRecord[],NPOI.HSSF.Record.BoundSheetRecord[])">
  5992. <summary>
  5993. Creates a stub workbook from the supplied records,
  5994. suitable for use with the HSSFFormulaParser
  5995. </summary>
  5996. <param name="externs">The ExternSheetRecords in your file</param>
  5997. <param name="bounds">A stub Workbook suitable for use with HSSFFormulaParser</param>
  5998. <returns>A stub Workbook suitable for use with {@link HSSFFormulaParser}</returns>
  5999. </member>
  6000. <member name="T:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener">
  6001. <summary>
  6002. A wrapping HSSFListener which will collect
  6003. BoundSheetRecords and {@link ExternSheetRecord}s as
  6004. they go past, so you can Create a Stub {@link Workbook} from
  6005. them once required.
  6006. </summary>
  6007. </member>
  6008. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.#ctor(NPOI.HSSF.EventUserModel.IHSSFListener)">
  6009. <summary>
  6010. Initializes a new instance of the <see cref="T:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener"/> class.
  6011. </summary>
  6012. <param name="childListener">The child listener.</param>
  6013. </member>
  6014. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.GetBoundSheetRecords">
  6015. <summary>
  6016. Gets the bound sheet records.
  6017. </summary>
  6018. <returns></returns>
  6019. </member>
  6020. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.GetExternSheetRecords">
  6021. <summary>
  6022. Gets the extern sheet records.
  6023. </summary>
  6024. <returns></returns>
  6025. </member>
  6026. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.GetSSTRecord">
  6027. <summary>
  6028. Gets the SST record.
  6029. </summary>
  6030. <returns></returns>
  6031. </member>
  6032. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.GetStubHSSFWorkbook">
  6033. <summary>
  6034. Gets the stub HSSF workbook.
  6035. </summary>
  6036. <returns></returns>
  6037. </member>
  6038. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.GetStubWorkbook">
  6039. <summary>
  6040. Gets the stub workbook.
  6041. </summary>
  6042. <returns></returns>
  6043. </member>
  6044. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  6045. <summary>
  6046. Process this record ourselves, and then
  6047. pass it on to our child listener
  6048. </summary>
  6049. <param name="record">The record.</param>
  6050. </member>
  6051. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.ProcessRecordInternally(NPOI.HSSF.Record.Record)">
  6052. <summary>
  6053. Process the record ourselves, but do not
  6054. pass it on to the child Listener.
  6055. </summary>
  6056. <param name="record">The record.</param>
  6057. </member>
  6058. <member name="T:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener">
  6059. A proxy HSSFListener that keeps track of the document
  6060. formatting records, and provides an easy way to look
  6061. up the format strings used by cells from their ids.
  6062. </member>
  6063. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  6064. Process this record ourselves, and then
  6065. pass it on to our child listener
  6066. </member>
  6067. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.ProcessRecordInternally(NPOI.HSSF.Record.Record)">
  6068. Process the record ourselves, but do not
  6069. pass it on to the child Listener.
  6070. @param record
  6071. </member>
  6072. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.FormatNumberDateCell(NPOI.HSSF.Record.CellValueRecordInterface)">
  6073. Formats the given numeric of date Cell's contents
  6074. as a String, in as close as we can to the way
  6075. that Excel would do so.
  6076. Uses the various format records to manage this.
  6077. TODO - move this to a central class in such a
  6078. way that hssf.usermodel can make use of it too
  6079. </member>
  6080. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.GetFormatString(System.Int32)">
  6081. Returns the format string, eg $##.##, for the
  6082. given number format index.
  6083. </member>
  6084. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.GetFormatString(NPOI.HSSF.Record.CellValueRecordInterface)">
  6085. Returns the format string, eg $##.##, used
  6086. by your cell
  6087. </member>
  6088. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.GetFormatIndex(NPOI.HSSF.Record.CellValueRecordInterface)">
  6089. Returns the index of the format string, used by your cell,
  6090. or -1 if none found
  6091. </member>
  6092. <member name="T:NPOI.HSSF.EventUserModel.HSSFEventFactory">
  6093. <summary>
  6094. Low level event based HSSF Reader. Pass either a DocumentInputStream to
  6095. Process events along with a request object or pass a POIFS POIFSFileSystem to
  6096. ProcessWorkbookEvents along with a request.
  6097. This will cause your file to be Processed a record at a time. Each record with
  6098. a static id matching one that you have registed in your HSSFRequest will be passed
  6099. to your associated HSSFListener.
  6100. @author Andrew C. Oliver (acoliver at apache dot org)
  6101. @author Carey Sublette (careysub@earthling.net)
  6102. </summary>
  6103. </member>
  6104. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.#ctor">
  6105. <summary>
  6106. Creates a new instance of HSSFEventFactory
  6107. </summary>
  6108. </member>
  6109. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.ProcessWorkbookEvents(NPOI.HSSF.EventUserModel.HSSFRequest,NPOI.POIFS.FileSystem.POIFSFileSystem)">
  6110. <summary>
  6111. Processes a file into essentially record events.
  6112. </summary>
  6113. <param name="req">an Instance of HSSFRequest which has your registered listeners</param>
  6114. <param name="fs">a POIFS filesystem containing your workbook</param>
  6115. </member>
  6116. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.AbortableProcessWorkbookEvents(NPOI.HSSF.EventUserModel.HSSFRequest,NPOI.POIFS.FileSystem.POIFSFileSystem)">
  6117. <summary>
  6118. Processes a file into essentially record events.
  6119. </summary>
  6120. <param name="req">an Instance of HSSFRequest which has your registered listeners</param>
  6121. <param name="fs">a POIFS filesystem containing your workbook</param>
  6122. <returns>numeric user-specified result code.</returns>
  6123. </member>
  6124. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.ProcessEvents(NPOI.HSSF.EventUserModel.HSSFRequest,System.IO.Stream)">
  6125. <summary>
  6126. Processes a DocumentInputStream into essentially Record events.
  6127. If an
  6128. <c>AbortableHSSFListener</c>
  6129. causes a halt to Processing during this call
  6130. the method will return just as with
  6131. <c>abortableProcessEvents</c>
  6132. , but no
  6133. user code or
  6134. <c>HSSFUserException</c>
  6135. will be passed back.
  6136. </summary>
  6137. <param name="req">an Instance of HSSFRequest which has your registered listeners</param>
  6138. <param name="in1">a DocumentInputStream obtained from POIFS's POIFSFileSystem object</param>
  6139. </member>
  6140. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.AbortableProcessEvents(NPOI.HSSF.EventUserModel.HSSFRequest,System.IO.Stream)">
  6141. <summary>
  6142. Processes a DocumentInputStream into essentially Record events.
  6143. </summary>
  6144. <param name="req">an Instance of HSSFRequest which has your registered listeners</param>
  6145. <param name="in1">a DocumentInputStream obtained from POIFS's POIFSFileSystem object</param>
  6146. <returns>numeric user-specified result code.</returns>
  6147. </member>
  6148. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.GenericProcessEvents(NPOI.HSSF.EventUserModel.HSSFRequest,NPOI.HSSF.Record.RecordInputStream)">
  6149. <summary>
  6150. Processes a DocumentInputStream into essentially Record events.
  6151. </summary>
  6152. <param name="req">an Instance of HSSFRequest which has your registered listeners</param>
  6153. <param name="in1">a DocumentInputStream obtained from POIFS's POIFSFileSystem object</param>
  6154. <returns>numeric user-specified result code.</returns>
  6155. </member>
  6156. <member name="T:NPOI.HSSF.EventUserModel.IHSSFListener">
  6157. <summary>
  6158. Interface for use with the HSSFRequest and HSSFEventFactory. Users should Create
  6159. a listener supporting this interface and register it with the HSSFRequest (associating
  6160. it with Record SID's).
  6161. @author acoliver@apache.org
  6162. </summary>
  6163. </member>
  6164. <member name="M:NPOI.HSSF.EventUserModel.IHSSFListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  6165. <summary>
  6166. Process an HSSF Record. Called when a record occurs in an HSSF file.
  6167. </summary>
  6168. <param name="record">The record.</param>
  6169. </member>
  6170. <member name="T:NPOI.HSSF.EventUserModel.HSSFRecordStream">
  6171. <summary>
  6172. A stream based way to Get at complete records, with
  6173. as low a memory footprint as possible.
  6174. This handles Reading from a RecordInputStream, turning
  6175. the data into full records, Processing continue records
  6176. etc.
  6177. Most users should use HSSFEventFactory
  6178. HSSFListener and have new records pushed to
  6179. them, but this does allow for a "pull" style of coding.
  6180. </summary>
  6181. </member>
  6182. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.hitEOS">
  6183. Have we run out of records on the stream?
  6184. </member>
  6185. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.complete">
  6186. Have we returned all the records there are?
  6187. </member>
  6188. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.bonusRecords">
  6189. Sometimes we end up with a bunch of
  6190. records. When we do, these should
  6191. be returned before the next normal
  6192. record Processing occurs (i.e. before
  6193. we Check for continue records and
  6194. return rec)
  6195. </member>
  6196. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.rec">
  6197. The next record to return, which may need to have its
  6198. continue records passed to it before we do
  6199. </member>
  6200. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.lastRec">
  6201. The most recent record that we gave to the user
  6202. </member>
  6203. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.lastDrawingRecord">
  6204. The most recent DrawingRecord seen
  6205. </member>
  6206. <member name="M:NPOI.HSSF.EventUserModel.HSSFRecordStream.NextRecord">
  6207. <summary>
  6208. Returns the next (complete) record from the
  6209. stream, or null if there are no more.
  6210. </summary>
  6211. <returns></returns>
  6212. </member>
  6213. <member name="M:NPOI.HSSF.EventUserModel.HSSFRecordStream.GetBonusRecord">
  6214. <summary>
  6215. If there are any "bonus" records, that should
  6216. be returned before Processing new ones,
  6217. grabs the next and returns it.
  6218. If not, returns null;
  6219. </summary>
  6220. <returns></returns>
  6221. </member>
  6222. <member name="M:NPOI.HSSF.EventUserModel.HSSFRecordStream.GetNextRecord">
  6223. <summary>
  6224. Returns the next available record, or null if
  6225. this pass didn't return a record that's
  6226. suitable for returning (eg was a continue record).
  6227. </summary>
  6228. <returns></returns>
  6229. </member>
  6230. <member name="T:NPOI.HSSF.EventUserModel.HSSFRequest">
  6231. <summary>
  6232. An HSSFRequest object should be constructed registering an instance or multiple
  6233. instances of HSSFListener with each Record.sid you wish to listen for.
  6234. @author Andrew C. Oliver (acoliver at apache dot org)
  6235. @author Carey Sublette (careysub@earthling.net)
  6236. </summary>
  6237. </member>
  6238. <member name="M:NPOI.HSSF.EventUserModel.HSSFRequest.#ctor">
  6239. <summary>
  6240. Creates a new instance of HSSFRequest
  6241. </summary>
  6242. </member>
  6243. <member name="M:NPOI.HSSF.EventUserModel.HSSFRequest.AddListener(NPOI.HSSF.EventUserModel.IHSSFListener,System.Int16)">
  6244. <summary>
  6245. Add an event listener for a particular record type. The trick Is you have to know
  6246. what the records are for or just start with our examples and build on them. Alternatively,
  6247. you CAN call AddListenerForAllRecords and you'll recieve ALL record events in one listener,
  6248. but if you like to squeeze every last byte of efficiency out of life you my not like this.
  6249. (its sure as heck what I plan to do)
  6250. </summary>
  6251. <param name="lsnr">for the event</param>
  6252. <param name="sid">identifier for the record type this Is the .sid static member on the individual records</param>
  6253. </member>
  6254. <member name="M:NPOI.HSSF.EventUserModel.HSSFRequest.AddListenerForAllRecords(NPOI.HSSF.EventUserModel.IHSSFListener)">
  6255. <summary>
  6256. This Is the equivilent of calling AddListener(myListener, sid) for EVERY
  6257. record in the org.apache.poi.hssf.record package. This Is for lazy
  6258. people like me. You can call this more than once with more than one listener, but
  6259. that seems like a bad thing to do from a practice-perspective Unless you have a
  6260. compelling reason to do so (like maybe you send the event two places or log it or
  6261. something?).
  6262. </summary>
  6263. <param name="lsnr">a single listener to associate with ALL records</param>
  6264. </member>
  6265. <member name="M:NPOI.HSSF.EventUserModel.HSSFRequest.ProcessRecord(NPOI.HSSF.Record.Record)">
  6266. <summary>
  6267. Called by HSSFEventFactory, passes the Record to each listener associated with
  6268. a record.sid.
  6269. Exception and return value Added 2002-04-19 by Carey Sublette
  6270. </summary>
  6271. <param name="rec">The record.</param>
  6272. <returns>numeric user-specified result code. If zero continue Processing.</returns>
  6273. </member>
  6274. <member name="T:NPOI.HSSF.EventUserModel.HSSFUserException">
  6275. <summary>
  6276. This exception Is provided as a way for API users to throw
  6277. exceptions from their event handling code. By doing so they
  6278. abort file Processing by the HSSFEventFactory and by
  6279. catching it from outside the HSSFEventFactory.ProcessEvents
  6280. method they can diagnose the cause for the abort.
  6281. The HSSFUserException supports a nested "reason"
  6282. throwable, i.e. an exception that caused this one to be thrown.
  6283. The HSSF package does not itself throw any of these
  6284. exceptions.
  6285. </summary>
  6286. <remarks>
  6287. @author Rainer Klute (klute@rainer-klute.de)
  6288. @author Carey Sublette (careysub@earthling.net)
  6289. </remarks>
  6290. </member>
  6291. <member name="M:NPOI.HSSF.EventUserModel.HSSFUserException.#ctor">
  6292. <summary>
  6293. Creates a new HSSFUserException
  6294. </summary>
  6295. </member>
  6296. <member name="M:NPOI.HSSF.EventUserModel.HSSFUserException.#ctor(System.String)">
  6297. <summary>
  6298. Creates a new HSSFUserException with a message
  6299. string.
  6300. </summary>
  6301. <param name="msg">The MSG.</param>
  6302. </member>
  6303. <member name="M:NPOI.HSSF.EventUserModel.HSSFUserException.#ctor(System.Exception)">
  6304. <summary>
  6305. Creates a new HSSFUserException with a reason.
  6306. </summary>
  6307. <param name="reason">The reason.</param>
  6308. </member>
  6309. <member name="M:NPOI.HSSF.EventUserModel.HSSFUserException.#ctor(System.String,System.Exception)">
  6310. <summary>
  6311. Creates a new HSSFUserException with a message string
  6312. and a reason.
  6313. </summary>
  6314. <param name="msg">The MSG.</param>
  6315. <param name="reason">The reason.</param>
  6316. </member>
  6317. <member name="T:NPOI.HSSF.EventUserModel.MissingRecordAwareHSSFListener">
  6318. <summary>
  6319. A HSSFListener which tracks rows and columns, and will
  6320. trigger your HSSFListener for all rows and cells,
  6321. even the ones that aren't actually stored in the file.
  6322. This allows your code to have a more "Excel" like
  6323. view of the data in the file, and not have to worry
  6324. (as much) about if a particular row/cell Is in the
  6325. file, or was skipped from being written as it was
  6326. blank.
  6327. </summary>
  6328. </member>
  6329. <member name="M:NPOI.HSSF.EventUserModel.MissingRecordAwareHSSFListener.#ctor(NPOI.HSSF.EventUserModel.IHSSFListener)">
  6330. <summary>
  6331. Constructs a new MissingRecordAwareHSSFListener, which
  6332. will fire ProcessRecord on the supplied child
  6333. HSSFListener for all Records, and missing records.
  6334. </summary>
  6335. <param name="listener">The HSSFListener to pass records on to</param>
  6336. </member>
  6337. <member name="M:NPOI.HSSF.EventUserModel.MissingRecordAwareHSSFListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  6338. <summary>
  6339. Process an HSSF Record. Called when a record occurs in an HSSF file.
  6340. </summary>
  6341. <param name="record"></param>
  6342. </member>
  6343. <member name="T:NPOI.HSSF.Extractor.EventBasedExcelExtractor">
  6344. <summary>
  6345. A text extractor for Excel files, that is based
  6346. on the hssf eventusermodel api.
  6347. It will typically use less memory than
  6348. ExcelExtractor, but may not provide
  6349. the same richness of formatting.
  6350. Returns the textual content of the file, suitable for
  6351. indexing by something like Lucene, but not really
  6352. intended for display to the user.
  6353. </summary>
  6354. </member>
  6355. <member name="P:NPOI.HSSF.Extractor.EventBasedExcelExtractor.DocSummaryInformation">
  6356. <summary>
  6357. Would return the document information metadata for the document,
  6358. if we supported it
  6359. </summary>
  6360. <value>The doc summary information.</value>
  6361. </member>
  6362. <member name="P:NPOI.HSSF.Extractor.EventBasedExcelExtractor.SummaryInformation">
  6363. <summary>
  6364. Would return the summary information metadata for the document,
  6365. if we supported it
  6366. </summary>
  6367. <value>The summary information.</value>
  6368. </member>
  6369. <member name="P:NPOI.HSSF.Extractor.EventBasedExcelExtractor.IncludeSheetNames">
  6370. <summary>
  6371. Should sheet names be included? Default is true
  6372. </summary>
  6373. <value>if set to <c>true</c> [include sheet names].</value>
  6374. </member>
  6375. <member name="P:NPOI.HSSF.Extractor.EventBasedExcelExtractor.FormulasNotResults">
  6376. <summary>
  6377. Should we return the formula itself, and not
  6378. the result it produces? Default is false
  6379. </summary>
  6380. <value>if set to <c>true</c> [formulas not results].</value>
  6381. </member>
  6382. <member name="P:NPOI.HSSF.Extractor.EventBasedExcelExtractor.Text">
  6383. <summary>
  6384. Retreives the text contents of the file
  6385. </summary>
  6386. <value>All the text from the document.</value>
  6387. </member>
  6388. <member name="M:NPOI.HSSF.Extractor.EventBasedExcelExtractor.TriggerExtraction">
  6389. <summary>
  6390. Triggers the extraction.
  6391. </summary>
  6392. <returns></returns>
  6393. </member>
  6394. <member name="M:NPOI.HSSF.Extractor.EventBasedExcelExtractor.TextListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  6395. <summary>
  6396. Process an HSSF Record. Called when a record occurs in an HSSF file.
  6397. </summary>
  6398. <param name="record"></param>
  6399. </member>
  6400. <member name="M:NPOI.HSSF.Extractor.EventBasedExcelExtractor.TextListener.FormatNumberDateCell(NPOI.HSSF.Record.CellValueRecordInterface,System.Double)">
  6401. <summary>
  6402. Formats a number or date cell, be that a real number, or the
  6403. answer to a formula
  6404. </summary>
  6405. <param name="cell">The cell.</param>
  6406. <param name="value">The value.</param>
  6407. <returns></returns>
  6408. </member>
  6409. <member name="T:NPOI.HSSF.Extractor.ExcelExtractor">
  6410. <summary>
  6411. A text extractor for Excel files.
  6412. Returns the textual content of the file, suitable for
  6413. indexing by something like Lucene, but not really
  6414. intended for display to the user.
  6415. </summary>
  6416. </member>
  6417. <member name="M:NPOI.HSSF.Extractor.ExcelExtractor.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook)">
  6418. <summary>
  6419. Initializes a new instance of the <see cref="T:NPOI.HSSF.Extractor.ExcelExtractor"/> class.
  6420. </summary>
  6421. <param name="wb">The wb.</param>
  6422. </member>
  6423. <member name="M:NPOI.HSSF.Extractor.ExcelExtractor.#ctor(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  6424. <summary>
  6425. Initializes a new instance of the <see cref="T:NPOI.HSSF.Extractor.ExcelExtractor"/> class.
  6426. </summary>
  6427. <param name="fs">The fs.</param>
  6428. </member>
  6429. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.IncludeHeaderFooter">
  6430. <summary>
  6431. Should header and footer be included? Default is true
  6432. </summary>
  6433. </member>
  6434. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.IncludeSheetNames">
  6435. <summary>
  6436. Should sheet names be included? Default is true
  6437. </summary>
  6438. <value>if set to <c>true</c> [include sheet names].</value>
  6439. </member>
  6440. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.FormulasNotResults">
  6441. <summary>
  6442. Should we return the formula itself, and not
  6443. the result it produces? Default is false
  6444. </summary>
  6445. <value>if set to <c>true</c> [formulas not results].</value>
  6446. </member>
  6447. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.IncludeCellComments">
  6448. <summary>
  6449. Should cell comments be included? Default is false
  6450. </summary>
  6451. <value>if set to <c>true</c> [include cell comments].</value>
  6452. </member>
  6453. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.IncludeBlankCells">
  6454. <summary>
  6455. Should blank cells be output? Default is to only
  6456. output cells that are present in the file and are
  6457. non-blank.
  6458. </summary>
  6459. <value>if set to <c>true</c> [include blank cells].</value>
  6460. </member>
  6461. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.Text">
  6462. <summary>
  6463. Retreives the text contents of the file
  6464. </summary>
  6465. <value>All the text from the document.</value>
  6466. </member>
  6467. <member name="M:NPOI.HSSF.Extractor.ExcelExtractor.ExtractHeaderFooter(NPOI.SS.UserModel.IHeaderFooter)">
  6468. <summary>
  6469. Extracts the header footer.
  6470. </summary>
  6471. <param name="hf">The header or footer</param>
  6472. <returns></returns>
  6473. </member>
  6474. <member name="T:NPOI.HSSF.Extractor.OldExcelExtractor">
  6475. A text extractor for old Excel files, which are too old for
  6476. HSSFWorkbook to handle. This includes Excel 95, and very old
  6477. (pre-OLE2) Excel files, such as Excel 4 files.
  6478. <p>
  6479. Returns much (but not all) of the textual content of the file,
  6480. suitable for indexing by something like Apache Lucene, or used
  6481. by Apache Tika, but not really intended for display to the user.
  6482. </p>
  6483. </member>
  6484. <member name="P:NPOI.HSSF.Extractor.OldExcelExtractor.BiffVersion">
  6485. The Biff version, largely corresponding to the Excel version
  6486. </member>
  6487. <member name="P:NPOI.HSSF.Extractor.OldExcelExtractor.FileType">
  6488. The kind of the file, one of {@link BOFRecord#TYPE_WORKSHEET},
  6489. {@link BOFRecord#TYPE_CHART}, {@link BOFRecord#TYPE_EXCEL_4_MACRO}
  6490. or {@link BOFRecord#TYPE_WORKSPACE_FILE}
  6491. </member>
  6492. <member name="P:NPOI.HSSF.Extractor.OldExcelExtractor.Text">
  6493. Retrieves the text contents of the file, as best we can
  6494. for these old file formats
  6495. </member>
  6496. <member name="M:NPOI.HSSF.Model.ConvertAnchor.CreateAnchor(NPOI.HSSF.UserModel.HSSFAnchor)">
  6497. <summary>
  6498. Creates the anchor.
  6499. </summary>
  6500. <param name="userAnchor">The user anchor.</param>
  6501. <returns></returns>
  6502. </member>
  6503. <member name="M:NPOI.HSSF.Model.DrawingManager.AllocateShapeId(System.Int16)">
  6504. Allocates new shape id for the new drawing Group id.
  6505. @return a new shape id.
  6506. </member>
  6507. <member name="T:NPOI.HSSF.Model.DrawingManager2">
  6508. <summary>
  6509. Provides utilities to manage drawing Groups.
  6510. </summary>
  6511. <remarks>
  6512. Glen Stampoultzis (glens at apache.org)
  6513. </remarks>
  6514. </member>
  6515. <member name="M:NPOI.HSSF.Model.DrawingManager2.ClearDrawingGroups">
  6516. <summary>
  6517. Clears the cached list of drawing Groups
  6518. </summary>
  6519. </member>
  6520. <member name="M:NPOI.HSSF.Model.DrawingManager2.AllocateShapeId(System.Int16)">
  6521. <summary>
  6522. Allocates new shape id for the new drawing Group id.
  6523. </summary>
  6524. <param name="drawingGroupId"></param>
  6525. <returns>a new shape id.</returns>
  6526. </member>
  6527. <member name="M:NPOI.HSSF.Model.DrawingManager2.AllocateShapeId(System.Int16,NPOI.DDF.EscherDgRecord)">
  6528. <summary>
  6529. Allocates new shape id for the new drawing group id.
  6530. </summary>
  6531. <param name="drawingGroupId"></param>
  6532. <param name="dg"></param>
  6533. <returns>a new shape id.</returns>
  6534. </member>
  6535. <member name="M:NPOI.HSSF.Model.DrawingManager2.FindNewDrawingGroupId">
  6536. <summary>
  6537. Finds the next available (1 based) drawing Group id
  6538. </summary>
  6539. <returns></returns>
  6540. </member>
  6541. <member name="T:NPOI.HSSF.Model.HSSFFormulaParser">
  6542. HSSF wrapper for the {@link FormulaParser} and {@link FormulaRenderer}
  6543. @author Josh Micich
  6544. </member>
  6545. <member name="M:NPOI.HSSF.Model.HSSFFormulaParser.Parse(System.String,NPOI.HSSF.UserModel.HSSFWorkbook)">
  6546. Convenience method for parsing cell formulas. see {@link #parse(String, HSSFWorkbook, int)}
  6547. </member>
  6548. <member name="M:NPOI.HSSF.Model.HSSFFormulaParser.Parse(System.String,NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.SS.Formula.FormulaType)">
  6549. @param formulaType a constant from {@link FormulaType}
  6550. @return the parsed formula tokens
  6551. </member>
  6552. <member name="M:NPOI.HSSF.Model.HSSFFormulaParser.Parse(System.String,NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.SS.Formula.FormulaType,System.Int32)">
  6553. @param formula the formula to parse
  6554. @param workbook the parent workbook
  6555. @param formulaType a constant from {@link FormulaType}
  6556. @param sheetIndex the 0-based index of the sheet this formula belongs to.
  6557. The sheet index is required to resolve sheet-level names. <code>-1</code> means that
  6558. the scope of the name will be ignored and the parser will match named ranges only by name
  6559. @return the parsed formula tokens
  6560. </member>
  6561. <member name="M:NPOI.HSSF.Model.HSSFFormulaParser.ToFormulaString(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.SS.Formula.PTG.Ptg[])">
  6562. Static method to convert an array of {@link Ptg}s in RPN order
  6563. to a human readable string format in infix mode.
  6564. @param book used for defined names and 3D references
  6565. @param ptgs must not be <c>null</c>
  6566. @return a human readable String
  6567. </member>
  6568. <member name="M:NPOI.HSSF.Model.InternalChart.GetMargin(NPOI.SS.UserModel.MarginType)">
  6569. Gets the size of the margin in inches.
  6570. @param margin which margin to Get
  6571. @return the size of the margin
  6572. </member>
  6573. <member name="M:NPOI.HSSF.Model.InternalChart.SetMargin(NPOI.SS.UserModel.MarginType,System.Double)">
  6574. Sets the size of the margin in inches.
  6575. @param margin which margin to Get
  6576. @param size the size of the margin
  6577. </member>
  6578. <member name="M:NPOI.HSSF.Model.InternalChart.CreateRuleSERIESDATA(System.Collections.Generic.List{NPOI.HSSF.Record.Record})">
  6579. <summary>
  6580. SERIESDATA = Dimensions 3(SIIndex *(Number / BoolErr / Blank / Label))
  6581. </summary>
  6582. <param name="records"></param>
  6583. </member>
  6584. <member name="M:NPOI.HSSF.Model.InternalChart.CreateRuleAXES">
  6585. <summary>
  6586. AXES = [IVAXIS DVAXIS [SERIESAXIS] / DVAXIS DVAXIS] *3ATTACHEDLABEL [PlotArea FRAME]
  6587. </summary>
  6588. </member>
  6589. <member name="M:NPOI.HSSF.Model.InternalChart.CreateRuleAXISPARENT(System.Collections.Generic.List{NPOI.HSSF.Record.Record})">
  6590. <summary>
  6591. AXISPARENT = AxisParent Begin Pos [AXES] 1*4CRT End
  6592. CRT = ChartFormat Begin (Bar / Line / (BopPop [BopPopCustom]) / Pie / Area / Scatter / Radar / RadarArea / Surf)
  6593. CrtLink [SeriesList] [Chart3d] [LD] [2DROPBAR] *4(CrtLine LineFormat) *2DFTTEXT [DataLabExtContents] [SS] *4SHAPEPROPS End
  6594. LD = Legend Begin Pos ATTACHEDLABEL [FRAME] [CrtLayout12] [TEXTPROPS] [CRTMLFRT] End
  6595. </summary>
  6596. <param name="records"></param>
  6597. </member>
  6598. <member name="M:NPOI.HSSF.Model.InternalChart.CreateRuleDFTTEXT(System.Collections.Generic.List{NPOI.HSSF.Record.Record})">
  6599. <summary>
  6600. DFTTEXT = [DataLabExt StartObject] DefaultText ATTACHEDLABEL [EndObject]
  6601. </summary>
  6602. <param name="records"></param>
  6603. </member>
  6604. <member name="M:NPOI.HSSF.Model.InternalChart.CreateRuleATTACHEDLABEL(System.Collections.Generic.List{NPOI.HSSF.Record.Record})">
  6605. <summary>
  6606. ATTACHEDLABEL = Text Begin Pos [FontX] [AlRuns] AI [FRAME] [ObjectLink] [DataLabExtContents] [CrtLayout12] [TEXTPROPS] [CRTMLFRT] End
  6607. </summary>
  6608. </member>
  6609. <member name="T:NPOI.HSSF.Model.InternalSheet">
  6610. <summary>
  6611. Low level model implementation of a Sheet (one workbook Contains many sheets)
  6612. This file Contains the low level binary records starting at the sheets BOF and
  6613. ending with the sheets EOF. Use HSSFSheet for a high level representation.
  6614. The structures of the highlevel API use references to this to perform most of their
  6615. operations. Its probably Unwise to use these low level structures directly Unless you
  6616. really know what you're doing. I recommend you Read the Microsoft Excel 97 Developer's
  6617. Kit (Microsoft Press) and the documentation at http://sc.openoffice.org/excelfileformat.pdf
  6618. before even attempting to use this.
  6619. </summary>
  6620. <remarks>
  6621. @author Andrew C. Oliver (acoliver at apache dot org)
  6622. @author Glen Stampoultzis (glens at apache.org)
  6623. @author Shawn Laubach (slaubach at apache dot org) Gridlines, Headers, Footers, PrintSetup, and Setting Default Column Styles
  6624. @author Jason Height (jheight at chariot dot net dot au) Clone support. DBCell and Index Record writing support
  6625. @author Brian Sanders (kestrel at burdell dot org) Active Cell support
  6626. @author Jean-Pierre Paris (jean-pierre.paris at m4x dot org) (Just a little)
  6627. </remarks>
  6628. </member>
  6629. <member name="F:NPOI.HSSF.Model.InternalSheet._mergedCellsTable">
  6630. java object always present, but if empty no BIFF records are written
  6631. </member>
  6632. <member name="F:NPOI.HSSF.Model.InternalSheet._dimensions">
  6633. the DimensionsRecord is always present
  6634. </member>
  6635. <member name="F:NPOI.HSSF.Model.InternalSheet._isUncalced">
  6636. Add an UncalcedRecord if not true indicating formulas have not been calculated
  6637. </member>
  6638. <member name="M:NPOI.HSSF.Model.InternalSheet.CloneSheet">
  6639. <summary>
  6640. Clones the low level records of this sheet and returns the new sheet instance.
  6641. This method is implemented by Adding methods for deep cloning to all records that
  6642. can be Added to a sheet. The Record object does not implement Cloneable.
  6643. When Adding a new record, implement a public Clone method if and only if the record
  6644. belongs to a sheet.
  6645. </summary>
  6646. <returns></returns>
  6647. </member>
  6648. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSheet(NPOI.HSSF.Model.RecordStream)">
  6649. <summary>
  6650. Creates the sheet.
  6651. </summary>
  6652. <param name="rs">The stream.</param>
  6653. <returns></returns>
  6654. </member>
  6655. <member name="M:NPOI.HSSF.Model.InternalSheet.#ctor(NPOI.HSSF.Model.RecordStream)">
  6656. <summary>
  6657. Initializes a new instance of the <see cref="T:NPOI.HSSF.Model.InternalSheet"/> class.
  6658. </summary>
  6659. <param name="rs">The stream.</param>
  6660. </member>
  6661. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSheet">
  6662. <summary>
  6663. Creates a sheet with all the usual records minus values and the "index"
  6664. record (not required). Sets the location pointer to where the first value
  6665. records should go. Use this to Create a sheet from "scratch".
  6666. </summary>
  6667. <returns>Sheet object with all values Set to defaults</returns>
  6668. </member>
  6669. <member name="M:NPOI.HSSF.Model.InternalSheet.AddMergedRegion(System.Int32,System.Int32,System.Int32,System.Int32)">
  6670. <summary>
  6671. Adds the merged region.
  6672. </summary>
  6673. <param name="rowFrom">the row index From </param>
  6674. <param name="colFrom">The column index From.</param>
  6675. <param name="rowTo">The row index To</param>
  6676. <param name="colTo">The column To.</param>
  6677. <returns></returns>
  6678. </member>
  6679. <member name="M:NPOI.HSSF.Model.InternalSheet.RemoveMergedRegion(System.Int32)">
  6680. <summary>
  6681. Removes the merged region.
  6682. </summary>
  6683. <param name="index">The index.</param>
  6684. </member>
  6685. <member name="P:NPOI.HSSF.Model.InternalSheet.ColumnInfos">
  6686. <summary>
  6687. Gets the column infos.
  6688. </summary>
  6689. <value>The column infos.</value>
  6690. </member>
  6691. <member name="M:NPOI.HSSF.Model.InternalSheet.GetMergedRegionAt(System.Int32)">
  6692. <summary>
  6693. Gets the merged region at.
  6694. </summary>
  6695. <param name="index">The index.</param>
  6696. <returns></returns>
  6697. </member>
  6698. <member name="P:NPOI.HSSF.Model.InternalSheet.NumMergedRegions">
  6699. <summary>
  6700. Gets the number of merged regions.
  6701. </summary>
  6702. <value>The number merged regions.</value>
  6703. </member>
  6704. <member name="P:NPOI.HSSF.Model.InternalSheet.NumConditionalFormattings">
  6705. <summary>
  6706. Gets the number of conditional formattings.
  6707. </summary>
  6708. <value>The number of conditional formattings.</value>
  6709. </member>
  6710. <member name="M:NPOI.HSSF.Model.InternalSheet.SetDimensions(System.Int32,System.Int16,System.Int32,System.Int16)">
  6711. <summary>
  6712. Per an earlier reported bug in working with Andy Khan's excel Read library. This
  6713. Sets the values in the sheet's DimensionsRecord object to be correct. Excel doesn't
  6714. really care, but we want to play nice with other libraries.
  6715. </summary>
  6716. <param name="firstrow">The first row.</param>
  6717. <param name="firstcol">The first column.</param>
  6718. <param name="lastrow">The last row.</param>
  6719. <param name="lastcol">The last column.</param>
  6720. </member>
  6721. <member name="P:NPOI.HSSF.Model.InternalSheet.PreOffset">
  6722. <summary>
  6723. Gets or Sets the preoffset when using DBCELL records (currently Unused) - this Is
  6724. the position of this sheet within the whole file.
  6725. </summary>
  6726. <value>the offset of the sheet's BOF within the file.</value>
  6727. </member>
  6728. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateRow(System.Int32)">
  6729. <summary>
  6730. Create a row record. (does not Add it to the records contained in this sheet)
  6731. </summary>
  6732. <param name="row">row number</param>
  6733. <returns>RowRecord Created for the passed in row number</returns>
  6734. </member>
  6735. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateLabelSST(System.Int32,System.Int16,System.Int32)">
  6736. <summary>
  6737. Create a LABELSST Record (does not Add it to the records contained in this sheet)
  6738. </summary>
  6739. <param name="row">the row the LabelSST Is a member of</param>
  6740. <param name="col">the column the LabelSST defines</param>
  6741. <param name="index">the index of the string within the SST (use workbook AddSSTString method)</param>
  6742. <returns>LabelSSTRecord newly Created containing your SST Index, row,col.</returns>
  6743. </member>
  6744. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateNumber(System.Int32,System.Int16,System.Double)">
  6745. <summary>
  6746. Create a NUMBER Record (does not Add it to the records contained in this sheet)
  6747. </summary>
  6748. <param name="row">the row the NumberRecord is a member of</param>
  6749. <param name="col">the column the NumberRecord defines</param>
  6750. <param name="value">value for the number record</param>
  6751. <returns>NumberRecord for that row, col containing that value as Added to the sheet</returns>
  6752. </member>
  6753. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateBlank(System.Int32,System.Int16)">
  6754. <summary>
  6755. Create a BLANK record (does not Add it to the records contained in this sheet)
  6756. </summary>
  6757. <param name="row">the row the BlankRecord is a member of</param>
  6758. <param name="col">the column the BlankRecord is a member of</param>
  6759. <returns></returns>
  6760. </member>
  6761. <member name="M:NPOI.HSSF.Model.InternalSheet.AddValueRecord(System.Int32,NPOI.HSSF.Record.CellValueRecordInterface)">
  6762. <summary>
  6763. Adds a value record to the sheet's contained binary records
  6764. (i.e. LabelSSTRecord or NumberRecord).
  6765. This method is "loc" sensitive. Meaning you need to Set LOC to where you
  6766. want it to start searching. If you don't know do this: SetLoc(GetDimsLoc).
  6767. When Adding several rows you can just start at the last one by leaving loc
  6768. at what this Sets it to.
  6769. </summary>
  6770. <param name="row">the row to Add the cell value to</param>
  6771. <param name="col">the cell value record itself.</param>
  6772. </member>
  6773. <member name="M:NPOI.HSSF.Model.InternalSheet.RemoveValueRecord(System.Int32,NPOI.HSSF.Record.CellValueRecordInterface)">
  6774. <summary>
  6775. Remove a value record from the records array.
  6776. This method is not loc sensitive, it Resets loc to = dimsloc so no worries.
  6777. </summary>
  6778. <param name="row">the row of the value record you wish to Remove</param>
  6779. <param name="col">a record supporting the CellValueRecordInterface.</param>
  6780. </member>
  6781. <member name="M:NPOI.HSSF.Model.InternalSheet.ReplaceValueRecord(NPOI.HSSF.Record.CellValueRecordInterface)">
  6782. <summary>
  6783. Replace a value record from the records array.
  6784. This method is not loc sensitive, it Resets loc to = dimsloc so no worries.
  6785. </summary>
  6786. <param name="newval">a record supporting the CellValueRecordInterface. this will Replace
  6787. the cell value with the same row and column. If there Isn't one, one will
  6788. be Added.</param>
  6789. </member>
  6790. <member name="M:NPOI.HSSF.Model.InternalSheet.AddRow(NPOI.HSSF.Record.RowRecord)">
  6791. <summary>
  6792. Adds a row record to the sheet
  6793. This method is "loc" sensitive. Meaning you need to Set LOC to where you
  6794. want it to start searching. If you don't know do this: SetLoc(GetDimsLoc).
  6795. When Adding several rows you can just start at the last one by leaving loc
  6796. at what this Sets it to.
  6797. </summary>
  6798. <param name="row">the row record to be Added</param>
  6799. </member>
  6800. <member name="M:NPOI.HSSF.Model.InternalSheet.RemoveRow(NPOI.HSSF.Record.RowRecord)">
  6801. <summary>
  6802. Removes a row record
  6803. This method is not loc sensitive, it Resets loc to = dimsloc so no worries.
  6804. </summary>
  6805. <param name="row">the row record to Remove</param>
  6806. </member>
  6807. <member name="M:NPOI.HSSF.Model.InternalSheet.GetCellValueIterator">
  6808. Get all the value records (from LOC). Records will be returned from the first
  6809. record (starting at LOC) which is a value record.
  6810. This method is "loc" sensitive. Meaning you need to set LOC to where you
  6811. want it to start searching. If you don't know do this: setLoc(getDimsLoc).
  6812. When adding several rows you can just start at the last one by leaving loc
  6813. at what this sets it to. For this method, set loc to dimsloc to start with,
  6814. subsequent calls will return values in (physical) sequence or NULL when you get to the end.
  6815. @return Iterator of CellValueRecordInterface representing the value records
  6816. </member>
  6817. <member name="P:NPOI.HSSF.Model.InternalSheet.NextRow">
  6818. <summary>
  6819. Get the NEXT RowRecord (from LOC). The first record that is a Row record
  6820. (starting at LOC) will be returned.
  6821. This method is "loc" sensitive. Meaning you need to Set LOC to where you
  6822. want it to start searching. If you don't know do this: SetLoc(GetDimsLoc).
  6823. When Adding several rows you can just start at the last one by leaving loc
  6824. at what this Sets it to. For this method, Set loc to dimsloc to start with.
  6825. subsequent calls will return rows in (physical) sequence or NULL when you Get to the end.
  6826. </summary>
  6827. <value>RowRecord representing the next row record or NULL if there are no more</value>
  6828. </member>
  6829. <member name="M:NPOI.HSSF.Model.InternalSheet.GetRow(System.Int32)">
  6830. <summary>
  6831. Get the NEXT (from LOC) RowRecord where rownumber matches the given rownum.
  6832. The first record that is a Row record (starting at LOC) that has the
  6833. same rownum as the given rownum will be returned.
  6834. This method is "loc" sensitive. Meaning you need to Set LOC to where you
  6835. want it to start searching. If you don't know do this: SetLoc(GetDimsLoc).
  6836. When Adding several rows you can just start at the last one by leaving loc
  6837. at what this Sets it to. For this method, Set loc to dimsloc to start with.
  6838. subsequent calls will return rows in (physical) sequence or NULL when you Get to the end.
  6839. </summary>
  6840. <param name="rownum">which row to return (careful with LOC)</param>
  6841. <returns>RowRecord representing the next row record or NULL if there are no more</returns>
  6842. </member>
  6843. <member name="P:NPOI.HSSF.Model.InternalSheet.PageSettings">
  6844. <summary>
  6845. Gets the page settings.
  6846. </summary>
  6847. <returns></returns>
  6848. </member>
  6849. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateBOF">
  6850. <summary>
  6851. Creates the BOF record
  6852. </summary>
  6853. <returns>record containing a BOFRecord</returns>
  6854. </member>
  6855. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateIndex">
  6856. <summary>
  6857. Creates the Index record - not currently used
  6858. </summary>
  6859. <returns>record containing a IndexRecord</returns>
  6860. </member>
  6861. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateCalcMode">
  6862. <summary>
  6863. Creates the CalcMode record and Sets it to 1 (automatic formula caculation)
  6864. </summary>
  6865. <returns>record containing a CalcModeRecord</returns>
  6866. </member>
  6867. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateCalcCount">
  6868. <summary>
  6869. Creates the CalcCount record and Sets it to 0x64 (default number of iterations)
  6870. </summary>
  6871. <returns>record containing a CalcCountRecord</returns>
  6872. </member>
  6873. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateRefMode">
  6874. <summary>
  6875. Creates the RefMode record and Sets it to A1 Mode (default reference mode)
  6876. </summary>
  6877. <returns>record containing a RefModeRecord</returns>
  6878. </member>
  6879. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateIteration">
  6880. <summary>
  6881. Creates the Iteration record and Sets it to false (don't iteratively calculate formulas)
  6882. </summary>
  6883. <returns>record containing a IterationRecord</returns>
  6884. </member>
  6885. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateDelta">
  6886. <summary>
  6887. Creates the Delta record and Sets it to 0.0010 (default accuracy)
  6888. </summary>
  6889. <returns>record containing a DeltaRecord</returns>
  6890. </member>
  6891. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSaveRecalc">
  6892. <summary>
  6893. Creates the SaveRecalc record and Sets it to true (recalculate before saving)
  6894. </summary>
  6895. <returns>record containing a SaveRecalcRecord</returns>
  6896. </member>
  6897. <member name="M:NPOI.HSSF.Model.InternalSheet.CreatePrintHeaders">
  6898. <summary>
  6899. Creates the PrintHeaders record and Sets it to false (we don't Create headers yet so why print them)
  6900. </summary>
  6901. <returns>record containing a PrintHeadersRecord</returns>
  6902. </member>
  6903. <member name="M:NPOI.HSSF.Model.InternalSheet.CreatePrintGridlines">
  6904. <summary>
  6905. Creates the PrintGridlines record and Sets it to false (that makes for ugly sheets). As far as I can
  6906. tell this does the same thing as the GridsetRecord
  6907. </summary>
  6908. <returns>record containing a PrintGridlinesRecord</returns>
  6909. </member>
  6910. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateGridset">
  6911. <summary>
  6912. Creates the GridSet record and Sets it to true (user has mucked with the gridlines)
  6913. </summary>
  6914. <returns>record containing a GridsetRecord</returns>
  6915. </member>
  6916. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateGuts">
  6917. <summary>
  6918. Creates the Guts record and Sets leftrow/topcol guttter and rowlevelmax/collevelmax to 0
  6919. </summary>
  6920. <returns>record containing a GutsRecordRecord</returns>
  6921. </member>
  6922. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateDefaultRowHeight">
  6923. <summary>
  6924. Creates the DefaultRowHeight Record and Sets its options to 0 and rowheight to 0xff
  6925. </summary>
  6926. <see cref="T:NPOI.HSSF.Record.DefaultRowHeightRecord"/>
  6927. <see cref="T:NPOI.HSSF.Record.Record"/>
  6928. <returns>record containing a DefaultRowHeightRecord</returns>
  6929. </member>
  6930. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateWSBool">
  6931. Creates the WSBoolRecord and Sets its values to defaults
  6932. @see org.apache.poi.hssf.record.WSBoolRecord
  6933. @see org.apache.poi.hssf.record.Record
  6934. @return record containing a WSBoolRecord
  6935. </member>
  6936. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateHCenter">
  6937. Creates the HCenter Record and Sets it to false (don't horizontally center)
  6938. @see org.apache.poi.hssf.record.HCenterRecord
  6939. @see org.apache.poi.hssf.record.Record
  6940. @return record containing a HCenterRecord
  6941. </member>
  6942. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateVCenter">
  6943. Creates the VCenter Record and Sets it to false (don't horizontally center)
  6944. @see org.apache.poi.hssf.record.VCenterRecord
  6945. @see org.apache.poi.hssf.record.Record
  6946. @return record containing a VCenterRecord
  6947. </member>
  6948. <member name="M:NPOI.HSSF.Model.InternalSheet.CreatePrintSetup">
  6949. Creates the PrintSetup Record and Sets it to defaults and marks it invalid
  6950. @see org.apache.poi.hssf.record.PrintSetupRecord
  6951. @see org.apache.poi.hssf.record.Record
  6952. @return record containing a PrintSetupRecord
  6953. </member>
  6954. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateDefaultColWidth">
  6955. Creates the DefaultColWidth Record and Sets it to 8
  6956. @see org.apache.poi.hssf.record.DefaultColWidthRecord
  6957. @see org.apache.poi.hssf.record.Record
  6958. @return record containing a DefaultColWidthRecord
  6959. </member>
  6960. <member name="P:NPOI.HSSF.Model.InternalSheet.DefaultColumnWidth">
  6961. Get the default column width for the sheet (if the columns do not define their own width)
  6962. @return default column width
  6963. </member>
  6964. <member name="P:NPOI.HSSF.Model.InternalSheet.DefaultRowHeight">
  6965. Get the default row height for the sheet (if the rows do not define their own height)
  6966. @return default row height
  6967. </member>
  6968. <member name="M:NPOI.HSSF.Model.InternalSheet.GetColumnWidth(System.Int32)">
  6969. Get the width of a given column in Units of 1/256th of a Char width
  6970. @param column index
  6971. @see org.apache.poi.hssf.record.DefaultColWidthRecord
  6972. @see org.apache.poi.hssf.record.ColumnInfoRecord
  6973. @see #SetColumnWidth(short,short)
  6974. @return column width in Units of 1/256th of a Char width
  6975. </member>
  6976. <member name="M:NPOI.HSSF.Model.InternalSheet.GetXFIndexForColAt(System.Int16)">
  6977. Get the index to the ExtendedFormatRecord "associated" with
  6978. the column at specified 0-based index. (In this case, an
  6979. ExtendedFormatRecord index is actually associated with a
  6980. ColumnInfoRecord which spans 1 or more columns)
  6981. <br/>
  6982. Returns the index to the default ExtendedFormatRecord (0xF)
  6983. if no ColumnInfoRecord exists that includes the column
  6984. index specified.
  6985. @param column
  6986. @return index of ExtendedFormatRecord associated with
  6987. ColumnInfoRecord that includes the column index or the
  6988. index of the default ExtendedFormatRecord (0xF)
  6989. </member>
  6990. <member name="M:NPOI.HSSF.Model.InternalSheet.SetColumnWidth(System.Int32,System.Int32)">
  6991. Set the width for a given column in 1/256th of a Char width Units
  6992. @param column - the column number
  6993. @param width (in Units of 1/256th of a Char width)
  6994. </member>
  6995. <member name="M:NPOI.HSSF.Model.InternalSheet.IsColumnHidden(System.Int32)">
  6996. Get the hidden property for a given column.
  6997. @param column index
  6998. @see org.apache.poi.hssf.record.DefaultColWidthRecord
  6999. @see org.apache.poi.hssf.record.ColumnInfoRecord
  7000. @see #SetColumnHidden(short,bool)
  7001. @return whether the column is hidden or not.
  7002. </member>
  7003. <member name="M:NPOI.HSSF.Model.InternalSheet.SetColumnHidden(System.Int32,System.Boolean)">
  7004. Get the hidden property for a given column.
  7005. @param column - the column number
  7006. @param hidden - whether the column is hidden or not
  7007. </member>
  7008. <member name="M:NPOI.HSSF.Model.InternalSheet.GroupColumnRange(System.Int32,System.Int32,System.Boolean)">
  7009. Creates an outline Group for the specified columns.
  7010. @param fromColumn Group from this column (inclusive)
  7011. @param toColumn Group to this column (inclusive)
  7012. @param indent if true the Group will be indented by one level,
  7013. if false indenting will be Removed by one level.
  7014. </member>
  7015. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateDimensions">
  7016. Creates the Dimensions Record and Sets it to bogus values (you should Set this yourself
  7017. or let the high level API do it for you)
  7018. @see org.apache.poi.hssf.record.DimensionsRecord
  7019. @see org.apache.poi.hssf.record.Record
  7020. @return record containing a DimensionsRecord
  7021. </member>
  7022. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateWindowTwo">
  7023. Creates the WindowTwo Record and Sets it to:
  7024. options = 0x6b6
  7025. toprow = 0
  7026. leftcol = 0
  7027. headercolor = 0x40
  7028. pagebreakzoom = 0x0
  7029. normalzoom = 0x0
  7030. @see org.apache.poi.hssf.record.WindowTwoRecord
  7031. @see org.apache.poi.hssf.record.Record
  7032. @return record containing a WindowTwoRecord
  7033. </member>
  7034. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSelection">
  7035. <summary>
  7036. Creates the Selection record and Sets it to nothing selected
  7037. </summary>
  7038. <returns>record containing a SelectionRecord</returns>
  7039. </member>
  7040. <member name="P:NPOI.HSSF.Model.InternalSheet.TopRow">
  7041. <summary>
  7042. Gets or sets the top row.
  7043. </summary>
  7044. <value>The top row.</value>
  7045. </member>
  7046. <member name="P:NPOI.HSSF.Model.InternalSheet.LeftCol">
  7047. <summary>
  7048. Gets or sets the left col.
  7049. </summary>
  7050. <value>The left col.</value>
  7051. </member>
  7052. <member name="M:NPOI.HSSF.Model.InternalSheet.SetActiveCell(System.Int32,System.Int32)">
  7053. <summary>
  7054. Sets the active cell.
  7055. </summary>
  7056. <param name="row">The row.</param>
  7057. <param name="column">The column.</param>
  7058. </member>
  7059. <member name="M:NPOI.HSSF.Model.InternalSheet.SetActiveCellRange(System.Int32,System.Int32,System.Int32,System.Int32)">
  7060. <summary>
  7061. Sets the active cell range.
  7062. </summary>
  7063. <param name="firstRow">The firstrow.</param>
  7064. <param name="lastRow">The lastrow.</param>
  7065. <param name="firstColumn">The firstcolumn.</param>
  7066. <param name="lastColumn">The lastcolumn.</param>
  7067. </member>
  7068. <member name="M:NPOI.HSSF.Model.InternalSheet.SetActiveCellRange(System.Collections.Generic.List{NPOI.SS.Util.CellRangeAddress8Bit},System.Int32,System.Int32,System.Int32)">
  7069. <summary>
  7070. Sets the active cell range.
  7071. </summary>
  7072. <param name="cellranges">The cellranges.</param>
  7073. <param name="activeRange">The index of the active range.</param>
  7074. <param name="activeRow">The active row in the active range</param>
  7075. <param name="activeColumn">The active column in the active range</param>
  7076. </member>
  7077. <member name="P:NPOI.HSSF.Model.InternalSheet.ActiveCellRow">
  7078. <summary>
  7079. Returns the active row
  7080. </summary>
  7081. <value>the active row index</value>
  7082. @see org.apache.poi.hssf.record.SelectionRecord
  7083. </member>
  7084. <member name="P:NPOI.HSSF.Model.InternalSheet.ActiveCellCol">
  7085. <summary>
  7086. Gets the active cell col.
  7087. </summary>
  7088. <value>the active column index</value>
  7089. @see org.apache.poi.hssf.record.SelectionRecord
  7090. </member>
  7091. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateEOF">
  7092. <summary>
  7093. Creates the EOF record
  7094. </summary>
  7095. <returns>record containing a EOFRecord</returns>
  7096. </member>
  7097. <member name="P:NPOI.HSSF.Model.InternalSheet.GridsetRecord">
  7098. <summary>
  7099. Gets the gridset record for this sheet.
  7100. </summary>
  7101. <value>The gridset record.</value>
  7102. </member>
  7103. <member name="M:NPOI.HSSF.Model.InternalSheet.FindFirstRecordBySid(System.Int16)">
  7104. <summary>
  7105. Returns the first occurance of a record matching a particular sid.
  7106. </summary>
  7107. <param name="sid">The sid.</param>
  7108. <returns></returns>
  7109. </member>
  7110. <member name="M:NPOI.HSSF.Model.InternalSheet.SetSCLRecord(NPOI.HSSF.Record.SCLRecord)">
  7111. <summary>
  7112. Sets the SCL record or Creates it in the correct place if it does not
  7113. already exist.
  7114. </summary>
  7115. <param name="sclRecord">The record to set.</param>
  7116. </member>
  7117. <member name="M:NPOI.HSSF.Model.InternalSheet.FindFirstRecordLocBySid(System.Int16)">
  7118. Finds the first occurance of a record matching a particular sid and
  7119. returns it's position.
  7120. @param sid the sid to search for
  7121. @return the record position of the matching record or -1 if no match
  7122. is made.
  7123. </member>
  7124. <member name="P:NPOI.HSSF.Model.InternalSheet.Header">
  7125. <summary>
  7126. Gets or sets the header.
  7127. </summary>
  7128. <value>the HeaderRecord.</value>
  7129. </member>
  7130. <member name="P:NPOI.HSSF.Model.InternalSheet.IsAutoTabColor">
  7131. <summary>
  7132. Gets or sets a value indicating whether this instance is auto tab color.
  7133. </summary>
  7134. <value>
  7135. <c>true</c> if this instance is auto tab color; otherwise, <c>false</c>.
  7136. </value>
  7137. </member>
  7138. <member name="P:NPOI.HSSF.Model.InternalSheet.Footer">
  7139. <summary>
  7140. Gets or sets the footer.
  7141. </summary>
  7142. <value>FooterRecord for the sheet.</value>
  7143. </member>
  7144. <member name="P:NPOI.HSSF.Model.InternalSheet.PrintSetup">
  7145. Returns the PrintSetupRecord.
  7146. @return PrintSetupRecord for the sheet.
  7147. </member>
  7148. <member name="P:NPOI.HSSF.Model.InternalSheet.IsGridsPrinted">
  7149. @return <c>true</c> if gridlines are printed
  7150. </member>
  7151. <member name="P:NPOI.HSSF.Model.InternalSheet.PrintGridlines">
  7152. Returns the PrintGridlinesRecord.
  7153. @return PrintGridlinesRecord for the sheet.
  7154. </member>
  7155. <member name="P:NPOI.HSSF.Model.InternalSheet.PrintHeaders">
  7156. Returns the PrintHeadersRecord.
  7157. @return PrintHeadersRecord for the sheet.
  7158. </member>
  7159. <member name="M:NPOI.HSSF.Model.InternalSheet.SetSelected(System.Boolean)">
  7160. Sets whether the sheet is selected
  7161. @param sel True to select the sheet, false otherwise.
  7162. </member>
  7163. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateFreezePane(System.Int32,System.Int32,System.Int32,System.Int32)">
  7164. Creates a split (freezepane). Any existing freezepane or split pane Is overwritten.
  7165. @param colSplit Horizonatal position of split.
  7166. @param rowSplit Vertical position of split.
  7167. @param topRow Top row visible in bottom pane
  7168. @param leftmostColumn Left column visible in right pane.
  7169. </member>
  7170. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSplitPane(System.Int32,System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.PanePosition)">
  7171. Creates a split pane. Any existing freezepane or split pane is overwritten.
  7172. @param xSplitPos Horizonatal position of split (in 1/20th of a point).
  7173. @param ySplitPos Vertical position of split (in 1/20th of a point).
  7174. @param topRow Top row visible in bottom pane
  7175. @param leftmostColumn Left column visible in right pane.
  7176. @param activePane Active pane. One of: PANE_LOWER_RIGHT,
  7177. PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT
  7178. @see #PANE_LOWER_LEFT
  7179. @see #PANE_LOWER_RIGHT
  7180. @see #PANE_UPPER_LEFT
  7181. @see #PANE_UPPER_RIGHT
  7182. </member>
  7183. <member name="P:NPOI.HSSF.Model.InternalSheet.PaneInformation">
  7184. Returns the information regarding the currently configured pane (split or freeze).
  7185. @return null if no pane configured, or the pane information.
  7186. </member>
  7187. <member name="M:NPOI.HSSF.Model.InternalSheet.CreatePassword">
  7188. creates a Password record with password set to 00.
  7189. </member>
  7190. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateProtect">
  7191. creates a Protect record with protect set to false.
  7192. </member>
  7193. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateObjectProtect">
  7194. Creates an ObjectProtect record with protect Set to false.
  7195. @see org.apache.poi.hssf.record.ObjectProtectRecord
  7196. @see org.apache.poi.hssf.record.Record
  7197. @return an ObjectProtectRecord
  7198. </member>
  7199. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateScenarioProtect">
  7200. Creates a ScenarioProtect record with protect Set to false.
  7201. @see org.apache.poi.hssf.record.ScenarioProtectRecord
  7202. @see org.apache.poi.hssf.record.Record
  7203. @return a ScenarioProtectRecord
  7204. </member>
  7205. <member name="P:NPOI.HSSF.Model.InternalSheet.DisplayGridlines">
  7206. Returns if gridlines are Displayed.
  7207. @return whether gridlines are Displayed
  7208. </member>
  7209. <member name="P:NPOI.HSSF.Model.InternalSheet.DisplayFormulas">
  7210. Returns if formulas are Displayed.
  7211. @return whether formulas are Displayed
  7212. </member>
  7213. <member name="P:NPOI.HSSF.Model.InternalSheet.DisplayRowColHeadings">
  7214. Returns if RowColHeadings are Displayed.
  7215. @return whether RowColHeadings are Displayed
  7216. </member>
  7217. <member name="P:NPOI.HSSF.Model.InternalSheet.IsPrintRowColHeadings">
  7218. Returns if RowColHeadings are displayed.
  7219. @return whether RowColHeadings are displayed
  7220. </member>
  7221. <member name="P:NPOI.HSSF.Model.InternalSheet.IsUncalced">
  7222. @return whether an Uncalced record must be Inserted or not at generation
  7223. </member>
  7224. <member name="M:NPOI.HSSF.Model.InternalSheet.AggregateDrawingRecords(NPOI.HSSF.Model.DrawingManager2,System.Boolean)">
  7225. <summary>
  7226. Finds the DrawingRecord for our sheet, and attaches it to the DrawingManager (which knows about
  7227. the overall DrawingGroup for our workbook).
  7228. If requested, will Create a new DrawRecord if none currently exist
  7229. </summary>
  7230. <param name="drawingManager">The DrawingManager2 for our workbook</param>
  7231. <param name="CreateIfMissing">Should one be Created if missing?</param>
  7232. <returns>location of EscherAggregate record. if no EscherAggregate record is found return -1</returns>
  7233. </member>
  7234. <member name="M:NPOI.HSSF.Model.InternalSheet.Preserialize">
  7235. Perform any work necessary before the sheet is about to be Serialized.
  7236. For instance the escher aggregates size needs to be calculated before
  7237. serialization so that the dgg record (which occurs first) can be written.
  7238. </member>
  7239. <member name="M:NPOI.HSSF.Model.InternalSheet.ShiftBreaks(NPOI.HSSF.Record.PageBreakRecord,System.Int16,System.Int16,System.Int32)">
  7240. Shifts all the page breaks in the range "count" number of rows/columns
  7241. @param breaks The page record to be Shifted
  7242. @param start Starting "main" value to Shift breaks
  7243. @param stop Ending "main" value to Shift breaks
  7244. @param count number of Units (rows/columns) to Shift by
  7245. </member>
  7246. <member name="M:NPOI.HSSF.Model.InternalSheet.ShiftRowBreaks(System.Int32,System.Int32,System.Int32)">
  7247. Shifts the horizontal page breaks for the indicated count
  7248. @param startingRow
  7249. @param endingRow
  7250. @param count
  7251. </member>
  7252. <member name="M:NPOI.HSSF.Model.InternalSheet.ShiftColumnBreaks(System.Int16,System.Int16,System.Int16)">
  7253. Shifts the vertical page breaks for the indicated count
  7254. @param startingCol
  7255. @param endingCol
  7256. @param count
  7257. </member>
  7258. <member name="M:NPOI.HSSF.Model.InternalSheet.UpdateFormulasAfterCellShift(NPOI.SS.Formula.FormulaShifter,System.Int32)">
  7259. Updates formulas in cells and conditional formats due to moving of cells
  7260. @param externSheetIndex the externSheet index of this sheet
  7261. </member>
  7262. <member name="M:NPOI.HSSF.Model.InternalSheet.GetSizeOfInitialSheetRecords(System.Int32)">
  7263. 'initial sheet records' are between INDEX and the 'Row Blocks'
  7264. @param bofRecordIndex index of record after which INDEX record is to be placed
  7265. @return count of bytes from end of INDEX record to first ROW record.
  7266. </member>
  7267. <member name="M:NPOI.HSSF.Model.InternalSheet.GetNoteRecords">
  7268. Get the {@link NoteRecord}s (related to cell comments) for this sheet
  7269. @return never <code>null</code>, typically empty array
  7270. </member>
  7271. <member name="T:NPOI.HSSF.Model.InternalWorkbook">
  7272. Low level model implementation of a Workbook. Provides creational methods
  7273. for Settings and objects contained in the workbook object.
  7274. This file Contains the low level binary records starting at the workbook's BOF and
  7275. ending with the workbook's EOF. Use HSSFWorkbook for a high level representation.
  7276. The structures of the highlevel API use references to this to perform most of their
  7277. operations. Its probably Unwise to use these low level structures directly Unless you
  7278. really know what you're doing. I recommend you Read the Microsoft Excel 97 Developer's
  7279. Kit (Microsoft Press) and the documentation at http://sc.openoffice.org/excelfileformat.pdf
  7280. before even attempting to use this.
  7281. @author Luc Girardin (luc dot girardin at macrofocus dot com)
  7282. @author Sergei Kozello (sergeikozello at mail.ru)
  7283. @author Shawn Laubach (slaubach at apache dot org) (Data Formats)
  7284. @author Andrew C. Oliver (acoliver at apache dot org)
  7285. @author Brian Sanders (bsanders at risklabs dot com) - custom palette
  7286. @author Dan Sherman (dsherman at Isisph.com)
  7287. @author Glen Stampoultzis (glens at apache.org)
  7288. @see org.apache.poi.hssf.usermodel.HSSFWorkbook
  7289. @version 1.0-pre
  7290. </member>
  7291. <member name="F:NPOI.HSSF.Model.InternalWorkbook.MAX_SENSITIVE_SHEET_NAME_LEN">
  7292. Excel silently truncates long sheet names to 31 chars.
  7293. This constant is used to ensure uniqueness in the first 31 chars
  7294. </member>
  7295. <member name="F:NPOI.HSSF.Model.InternalWorkbook.WORKBOOK_DIR_ENTRY_NAMES">
  7296. Normally, the Workbook will be in a POIFS Stream
  7297. called "Workbook". However, some weird XLS generators use "WORKBOOK"
  7298. </member>
  7299. <member name="F:NPOI.HSSF.Model.InternalWorkbook.OLD_WORKBOOK_DIR_ENTRY_NAME">
  7300. Name of older (pre-Excel 97) Workbook streams, which
  7301. aren't supported by HSSFWorkbook, only by
  7302. {@link OldExcelExtractor}
  7303. </member>
  7304. <member name="F:NPOI.HSSF.Model.InternalWorkbook.CODEPAGE">
  7305. constant used to Set the "codepage" wherever "codepage" is Set in records
  7306. (which is duplciated in more than one record)
  7307. </member>
  7308. <member name="F:NPOI.HSSF.Model.InternalWorkbook.records">
  7309. this Contains the Worksheet record objects
  7310. </member>
  7311. <member name="F:NPOI.HSSF.Model.InternalWorkbook.sst">
  7312. this Contains a reference to the SSTRecord so that new stings can be Added
  7313. to it.
  7314. </member>
  7315. <member name="F:NPOI.HSSF.Model.InternalWorkbook.boundsheets">
  7316. holds the "boundsheet" records (aka bundlesheet) so that they can have their
  7317. reference to their "BOF" marker
  7318. </member>
  7319. <member name="M:NPOI.HSSF.Model.InternalWorkbook.#ctor">
  7320. Creates new Workbook with no intitialization --useless right now
  7321. @see #CreateWorkbook(List)
  7322. </member>
  7323. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWorkbook(System.Collections.Generic.List{NPOI.HSSF.Record.Record})">
  7324. Read support for low level
  7325. API. Pass in an array of Record objects, A Workbook
  7326. object is constructed and passed back with all of its initialization Set
  7327. to the passed in records and references to those records held. Unlike Sheet
  7328. workbook does not use an offset (its assumed to be 0) since its first in a file.
  7329. If you need an offset then construct a new array with a 0 offset or Write your
  7330. own ;-p.
  7331. @param recs an array of Record objects
  7332. @return Workbook object
  7333. </member>
  7334. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetNameCommentRecord(NPOI.HSSF.Record.NameRecord)">
  7335. gets the name comment record
  7336. @param nameRecord name record who's comment is required.
  7337. @return name comment record or <code>null</code> if there isn't one for the given name.
  7338. </member>
  7339. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWorkbook">
  7340. Creates an empty workbook object with three blank sheets and all the empty
  7341. fields. Use this to Create a workbook from scratch.
  7342. </member>
  7343. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetSpecificBuiltinRecord(System.Byte,System.Int32)">
  7344. Retrieves the Builtin NameRecord that matches the name and index
  7345. There shouldn't be too many names to make the sequential search too slow
  7346. @param name byte representation of the builtin name to match
  7347. @param sheetIndex Index to match
  7348. @return null if no builtin NameRecord matches
  7349. </member>
  7350. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveBuiltinRecord(System.Byte,System.Int32)">
  7351. Removes the specified Builtin NameRecord that matches the name and index
  7352. @param name byte representation of the builtin to match
  7353. @param sheetIndex zero-based sheet reference
  7354. </member>
  7355. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetFontRecordAt(System.Int32)">
  7356. Gets the font record at the given index in the font table. Remember
  7357. "There is No Four" (someone at M$ must have gone to Rocky Horror one too
  7358. many times)
  7359. @param idx the index to look at (0 or greater but NOT 4)
  7360. @return FontRecord located at the given index
  7361. </member>
  7362. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateNewFont">
  7363. Creates a new font record and Adds it to the "font table". This causes the
  7364. boundsheets to move down one, extended formats to move down (so this function moves
  7365. those pointers as well)
  7366. @return FontRecord that was just Created
  7367. </member>
  7368. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CloneDrawings(NPOI.HSSF.Model.InternalSheet)">
  7369. Check if the cloned sheet has drawings. If yes, then allocate a new drawing group ID and
  7370. re-generate shape IDs
  7371. @param sheet the cloned sheet
  7372. </member>
  7373. <member name="P:NPOI.HSSF.Model.InternalWorkbook.NumberOfFontRecords">
  7374. Gets the number of font records
  7375. @return number of font records in the "font table"
  7376. </member>
  7377. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetBof(System.Int32,System.Int32)">
  7378. Sets the BOF for a given sheet
  7379. @param sheetnum the number of the sheet to Set the positing of the bof for
  7380. @param pos the actual bof position
  7381. </member>
  7382. <member name="P:NPOI.HSSF.Model.InternalWorkbook.BackupRecord">
  7383. Returns the position of the backup record.
  7384. </member>
  7385. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetName(System.Int32,System.String)">
  7386. Sets the name for a given sheet. If the boundsheet record doesn't exist and
  7387. its only one more than we have, go ahead and Create it. If its > 1 more than
  7388. we have, except
  7389. @param sheetnum the sheet number (0 based)
  7390. @param sheetname the name for the sheet
  7391. </member>
  7392. <member name="M:NPOI.HSSF.Model.InternalWorkbook.ContainsSheetName(System.String,System.Int32)">
  7393. Determines whether a workbook Contains the provided sheet name.
  7394. @param name the name to test (case insensitive match)
  7395. @param excludeSheetIdx the sheet to exclude from the Check or -1 to include all sheets in the Check.
  7396. @return true if the sheet Contains the name, false otherwise.
  7397. </member>
  7398. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetName(System.Int32,System.String,System.Int16)">
  7399. Sets the name for a given sheet forcing the encoding. This is STILL A BAD IDEA.
  7400. Poi now automatically detects Unicode
  7401. @deprecated 3-Jan-06 Simply use SetSheetNam e(int sheetnum, String sheetname)
  7402. @param sheetnum the sheet number (0 based)
  7403. @param sheetname the name for the sheet
  7404. </member>
  7405. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetOrder(System.String,System.Int32)">
  7406. Sets the order of appearance for a given sheet.
  7407. @param sheetname the name of the sheet to reorder
  7408. @param pos the position that we want to Insert the sheet into (0 based)
  7409. </member>
  7410. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetSheetName(System.Int32)">
  7411. Gets the name for a given sheet.
  7412. @param sheetnum the sheet number (0 based)
  7413. @return sheetname the name for the sheet
  7414. </member>
  7415. <member name="M:NPOI.HSSF.Model.InternalWorkbook.IsSheetHidden(System.Int32)">
  7416. Gets the hidden flag for a given sheet.
  7417. @param sheetnum the sheet number (0 based)
  7418. @return True if sheet is hidden
  7419. </member>
  7420. <member name="M:NPOI.HSSF.Model.InternalWorkbook.IsSheetVeryHidden(System.Int32)">
  7421. Gets the hidden flag for a given sheet.
  7422. Note that a sheet could instead be
  7423. set to be very hidden, which is different
  7424. ({@link #isSheetVeryHidden(int)})
  7425. @param sheetnum the sheet number (0 based)
  7426. @return True if sheet is hidden
  7427. </member>
  7428. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetHidden(System.Int32,System.Boolean)">
  7429. Hide or Unhide a sheet
  7430. @param sheetnum The sheet number
  7431. @param hidden True to mark the sheet as hidden, false otherwise
  7432. </member>
  7433. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetHidden(System.Int32,System.Int32)">
  7434. Hide or unhide a sheet.
  7435. 0 = not hidden
  7436. 1 = hidden
  7437. 2 = very hidden.
  7438. @param sheetnum The sheet number
  7439. @param hidden 0 for not hidden, 1 for hidden, 2 for very hidden
  7440. </member>
  7441. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetSheetIndex(System.String)">
  7442. Get the sheet's index
  7443. @param name sheet name
  7444. @return sheet index or -1 if it was not found.
  7445. </member>
  7446. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CheckSheets(System.Int32)">
  7447. if we're trying to Address one more sheet than we have, go ahead and Add it! if we're
  7448. trying to Address >1 more than we have throw an exception!
  7449. </member>
  7450. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FixTabIdRecord">
  7451. <summary>
  7452. make the tabid record look like the current situation.
  7453. </summary>
  7454. <returns>number of bytes written in the TabIdRecord</returns>
  7455. </member>
  7456. <member name="P:NPOI.HSSF.Model.InternalWorkbook.NumSheets">
  7457. returns the number of boundsheet objects contained in this workbook.
  7458. @return number of BoundSheet records
  7459. </member>
  7460. <member name="P:NPOI.HSSF.Model.InternalWorkbook.NumExFormats">
  7461. Get the number of ExtendedFormat records contained in this workbook.
  7462. @return int count of ExtendedFormat records
  7463. </member>
  7464. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetFontIndex(NPOI.HSSF.Record.FontRecord)">
  7465. Retrieves the index of the given font
  7466. </member>
  7467. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetStyleRecord(System.Int32)">
  7468. Returns the StyleRecord for the given
  7469. xfIndex, or null if that ExtendedFormat doesn't
  7470. have a Style set.
  7471. </member>
  7472. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetExFormatAt(System.Int32)">
  7473. Gets the ExtendedFormatRecord at the given 0-based index
  7474. @param index of the Extended format record (0-based)
  7475. @return ExtendedFormatRecord at the given index
  7476. </member>
  7477. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateCellXF">
  7478. Creates a new Cell-type Extneded Format Record and Adds it to the end of
  7479. ExtendedFormatRecords collection
  7480. @return ExtendedFormatRecord that was Created
  7481. </member>
  7482. <member name="M:NPOI.HSSF.Model.InternalWorkbook.AddSSTString(NPOI.HSSF.Record.UnicodeString)">
  7483. Adds a string to the SST table and returns its index (if its a duplicate
  7484. just returns its index and update the counts) ASSUMES compressed Unicode
  7485. (meaning 8bit)
  7486. @param string the string to be Added to the SSTRecord
  7487. @return index of the string within the SSTRecord
  7488. </member>
  7489. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetSSTString(System.Int32)">
  7490. given an index into the SST table, this function returns the corresponding String value
  7491. @return String containing the SST String
  7492. </member>
  7493. <member name="M:NPOI.HSSF.Model.InternalWorkbook.InsertSST">
  7494. use this function to Add a Shared String Table to an existing sheet (say
  7495. generated by a different java api) without an sst....
  7496. @see #CreateSST()
  7497. @see org.apache.poi.hssf.record.SSTRecord
  7498. </member>
  7499. <member name="M:NPOI.HSSF.Model.InternalWorkbook.Serialize(System.Int32,System.Byte[])">
  7500. Serializes all records int the worksheet section into a big byte array. Use
  7501. this to Write the Workbook out.
  7502. @param offset of the data to be written
  7503. @param data array of bytes to Write this to
  7504. </member>
  7505. <member name="M:NPOI.HSSF.Model.InternalWorkbook.PreSerialize">
  7506. Perform any work necessary before the workbook is about to be serialized.
  7507. Include in it ant code that modifies the workbook record stream and affects its size.
  7508. </member>
  7509. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBOF">
  7510. Creates the BOF record
  7511. @see org.apache.poi.hssf.record.BOFRecord
  7512. @see org.apache.poi.hssf.record.Record
  7513. @return record containing a BOFRecord
  7514. </member>
  7515. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateInterfaceHdr">
  7516. Creates the InterfaceHdr record
  7517. @see org.apache.poi.hssf.record.InterfaceHdrRecord
  7518. @see org.apache.poi.hssf.record.Record
  7519. @return record containing a InterfaceHdrRecord
  7520. </member>
  7521. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateMMS">
  7522. Creates an MMS record
  7523. @see org.apache.poi.hssf.record.MMSRecord
  7524. @see org.apache.poi.hssf.record.Record
  7525. @return record containing a MMSRecord
  7526. </member>
  7527. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateInterfaceEnd">
  7528. Creates the InterfaceEnd record
  7529. @see org.apache.poi.hssf.record.InterfaceEndRecord
  7530. @see org.apache.poi.hssf.record.Record
  7531. @return record containing a InterfaceEndRecord
  7532. </member>
  7533. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWriteAccess">
  7534. Creates the WriteAccess record containing the logged in user's name
  7535. @see org.apache.poi.hssf.record.WriteAccessRecord
  7536. @see org.apache.poi.hssf.record.Record
  7537. @return record containing a WriteAccessRecord
  7538. </member>
  7539. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateCodepage">
  7540. Creates the Codepage record containing the constant stored in CODEPAGE
  7541. @see org.apache.poi.hssf.record.CodepageRecord
  7542. @see org.apache.poi.hssf.record.Record
  7543. @return record containing a CodepageRecord
  7544. </member>
  7545. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateDSF">
  7546. Creates the DSF record containing a 0 since HSSF can't even Create Dual Stream Files
  7547. @see org.apache.poi.hssf.record.DSFRecord
  7548. @see org.apache.poi.hssf.record.Record
  7549. @return record containing a DSFRecord
  7550. </member>
  7551. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateTabId">
  7552. Creates the TabId record containing an array of 0,1,2. This release of HSSF
  7553. always has the default three sheets, no less, no more.
  7554. @see org.apache.poi.hssf.record.TabIdRecord
  7555. @see org.apache.poi.hssf.record.Record
  7556. @return record containing a TabIdRecord
  7557. </member>
  7558. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateFnGroupCount">
  7559. Creates the FnGroupCount record containing the Magic number constant of 14.
  7560. @see org.apache.poi.hssf.record.FnGroupCountRecord
  7561. @see org.apache.poi.hssf.record.Record
  7562. @return record containing a FnGroupCountRecord
  7563. </member>
  7564. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWindowProtect">
  7565. Creates the WindowProtect record with protect Set to false.
  7566. @see org.apache.poi.hssf.record.WindowProtectRecord
  7567. @see org.apache.poi.hssf.record.Record
  7568. @return record containing a WindowProtectRecord
  7569. </member>
  7570. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateProtect">
  7571. Creates the Protect record with protect Set to false.
  7572. @see org.apache.poi.hssf.record.ProtectRecord
  7573. @see org.apache.poi.hssf.record.Record
  7574. @return record containing a ProtectRecord
  7575. </member>
  7576. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreatePassword">
  7577. Creates the Password record with password Set to 0.
  7578. @see org.apache.poi.hssf.record.PasswordRecord
  7579. @see org.apache.poi.hssf.record.Record
  7580. @return record containing a PasswordRecord
  7581. </member>
  7582. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateProtectionRev4">
  7583. Creates the ProtectionRev4 record with protect Set to false.
  7584. @see org.apache.poi.hssf.record.ProtectionRev4Record
  7585. @see org.apache.poi.hssf.record.Record
  7586. @return record containing a ProtectionRev4Record
  7587. </member>
  7588. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreatePasswordRev4">
  7589. Creates the PasswordRev4 record with password Set to 0.
  7590. @see org.apache.poi.hssf.record.PasswordRev4Record
  7591. @see org.apache.poi.hssf.record.Record
  7592. @return record containing a PasswordRev4Record
  7593. </member>
  7594. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWindowOne">
  7595. Creates the WindowOne record with the following magic values:
  7596. horizontal hold - 0x168
  7597. vertical hold - 0x10e
  7598. width - 0x3a5c
  7599. height - 0x23be
  7600. options - 0x38
  7601. selected tab - 0
  7602. Displayed tab - 0
  7603. num selected tab- 0
  7604. tab width ratio - 0x258
  7605. @see org.apache.poi.hssf.record.WindowOneRecord
  7606. @see org.apache.poi.hssf.record.Record
  7607. @return record containing a WindowOneRecord
  7608. </member>
  7609. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBackup">
  7610. Creates the Backup record with backup Set to 0. (loose the data, who cares)
  7611. @see org.apache.poi.hssf.record.BackupRecord
  7612. @see org.apache.poi.hssf.record.Record
  7613. @return record containing a BackupRecord
  7614. </member>
  7615. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateHideObj">
  7616. Creates the HideObj record with hide object Set to 0. (don't hide)
  7617. @see org.apache.poi.hssf.record.HideObjRecord
  7618. @see org.apache.poi.hssf.record.Record
  7619. @return record containing a HideObjRecord
  7620. </member>
  7621. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateDateWindow1904">
  7622. Creates the DateWindow1904 record with windowing Set to 0. (don't window)
  7623. @see org.apache.poi.hssf.record.DateWindow1904Record
  7624. @see org.apache.poi.hssf.record.Record
  7625. @return record containing a DateWindow1904Record
  7626. </member>
  7627. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreatePrecision">
  7628. Creates the Precision record with precision Set to true. (full precision)
  7629. @see org.apache.poi.hssf.record.PrecisionRecord
  7630. @see org.apache.poi.hssf.record.Record
  7631. @return record containing a PrecisionRecord
  7632. </member>
  7633. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateRefreshAll">
  7634. Creates the RefreshAll record with refreshAll Set to true. (refresh all calcs)
  7635. @see org.apache.poi.hssf.record.RefreshAllRecord
  7636. @see org.apache.poi.hssf.record.Record
  7637. @return record containing a RefreshAllRecord
  7638. </member>
  7639. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBookBool">
  7640. Creates the BookBool record with saveLinkValues Set to 0. (don't save link values)
  7641. @see org.apache.poi.hssf.record.BookBoolRecord
  7642. @see org.apache.poi.hssf.record.Record
  7643. @return record containing a BookBoolRecord
  7644. </member>
  7645. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateFont">
  7646. Creates a Font record with the following magic values:
  7647. fontheight = 0xc8
  7648. attributes = 0x0
  7649. color palette index = 0x7fff
  7650. bold weight = 0x190
  7651. Font Name Length = 5
  7652. Font Name = Arial
  7653. @see org.apache.poi.hssf.record.FontRecord
  7654. @see org.apache.poi.hssf.record.Record
  7655. @return record containing a FontRecord
  7656. </member>
  7657. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateExtendedFormat(System.Int32)">
  7658. Creates an ExtendedFormatRecord object
  7659. @param id the number of the extended format record to Create (meaning its position in
  7660. a file as MS Excel would Create it.)
  7661. @return record containing an ExtendedFormatRecord
  7662. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  7663. @see org.apache.poi.hssf.record.Record
  7664. </member>
  7665. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateExtendedFormat">
  7666. Creates an default cell type ExtendedFormatRecord object.
  7667. @return ExtendedFormatRecord with intial defaults (cell-type)
  7668. </member>
  7669. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateStyleRecord(System.Int32)">
  7670. Creates a new StyleRecord, for the given Extended
  7671. Format index, and adds it onto the end of the
  7672. records collection
  7673. </member>
  7674. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateStyle(System.Int32)">
  7675. Creates a StyleRecord object
  7676. @param id the number of the style record to Create (meaning its position in
  7677. a file as MS Excel would Create it.
  7678. @return record containing a StyleRecord
  7679. @see org.apache.poi.hssf.record.StyleRecord
  7680. @see org.apache.poi.hssf.record.Record
  7681. </member>
  7682. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreatePalette">
  7683. Creates a palette record initialized to the default palette
  7684. @return a PaletteRecord instance populated with the default colors
  7685. @see org.apache.poi.hssf.record.PaletteRecord
  7686. </member>
  7687. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateUseSelFS">
  7688. Creates the UseSelFS object with the use natural language flag Set to 0 (false)
  7689. @return record containing a UseSelFSRecord
  7690. @see org.apache.poi.hssf.record.UseSelFSRecord
  7691. @see org.apache.poi.hssf.record.Record
  7692. </member>
  7693. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBoundSheet(System.Int32)">
  7694. Create a "bound sheet" or "bundlesheet" (depending who you ask) record
  7695. Always Sets the sheet's bof to 0. You'll need to Set that yourself.
  7696. @param id either sheet 0,1 or 2.
  7697. @return record containing a BoundSheetRecord
  7698. @see org.apache.poi.hssf.record.BoundSheetRecord
  7699. @see org.apache.poi.hssf.record.Record
  7700. </member>
  7701. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateCountry">
  7702. Creates the Country record with the default country Set to 1
  7703. and current country Set to 7 in case of russian locale ("ru_RU") and 1 otherwise
  7704. @return record containing a CountryRecord
  7705. @see org.apache.poi.hssf.record.CountryRecord
  7706. @see org.apache.poi.hssf.record.Record
  7707. </member>
  7708. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateExtendedSST">
  7709. Creates the ExtendedSST record with numstrings per bucket Set to 0x8. HSSF
  7710. doesn't yet know what to do with this thing, but we Create it with nothing in
  7711. it hardly just to make Excel happy and our sheets look like Excel's
  7712. @return record containing an ExtSSTRecord
  7713. @see org.apache.poi.hssf.record.ExtSSTRecord
  7714. @see org.apache.poi.hssf.record.Record
  7715. </member>
  7716. <member name="P:NPOI.HSSF.Model.InternalWorkbook.OrCreateLinkTable">
  7717. lazy initialization
  7718. Note - creating the link table causes creation of 1 EXTERNALBOOK and 1 EXTERNALSHEET record
  7719. </member>
  7720. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindSheetFirstNameFromExternSheet(System.Int32)">
  7721. Finds the first sheet name by his extern sheet index
  7722. @param externSheetIndex extern sheet index
  7723. @return first sheet name.
  7724. </member>
  7725. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetFirstSheetIndexFromExternSheetIndex(System.Int32)">
  7726. Finds the (first) sheet index for a particular external sheet number.
  7727. @param externSheetNumber The external sheet number to convert
  7728. @return The index to the sheet found.
  7729. </member>
  7730. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetLastSheetIndexFromExternSheetIndex(System.Int32)">
  7731. Finds the last sheet index for a particular external sheet number,
  7732. which may be the same as the first (except for multi-sheet references)
  7733. @param externSheetNumber The external sheet number to convert
  7734. @return The index to the sheet found.
  7735. </member>
  7736. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CheckExternSheet(System.Int32)">
  7737. Returns the extern sheet number for specific sheet number.
  7738. If this sheet doesn't exist in extern sheet, add it
  7739. @param sheetNumber local sheet number
  7740. @return index to extern sheet
  7741. </member>
  7742. <member name="M:NPOI.HSSF.Model.InternalWorkbook.checkExternSheet(System.Int32,System.Int32)">
  7743. Returns the extern sheet number for specific range of sheets.
  7744. If this sheet range doesn't exist in extern sheet, add it
  7745. @param firstSheetNumber first local sheet number
  7746. @param lastSheetNumber last local sheet number
  7747. @return index to extern sheet
  7748. </member>
  7749. <member name="P:NPOI.HSSF.Model.InternalWorkbook.NumNames">
  7750. Gets the total number of names
  7751. @return number of names
  7752. </member>
  7753. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetNameXPtg(System.String,System.Int32,NPOI.SS.Formula.UDF.UDFFinder)">
  7754. @param name the name of an external function, typically a name of a UDF
  7755. @param sheetRefIndex the sheet ref index, or -1 if not known
  7756. @param udf locator of user-defiend functions to resolve names of VBA and Add-In functions
  7757. @return the external name or null
  7758. </member>
  7759. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetNameRecord(System.Int32)">
  7760. Gets the name record
  7761. @param index name index
  7762. @return name record
  7763. </member>
  7764. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateName">
  7765. Creates new name
  7766. @return new name record
  7767. </member>
  7768. <member name="M:NPOI.HSSF.Model.InternalWorkbook.AddName(NPOI.HSSF.Record.NameRecord)">
  7769. Creates new name
  7770. @return new name record
  7771. </member>
  7772. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBuiltInName(System.Byte,System.Int32)">
  7773. Generates a NameRecord to represent a built-in region
  7774. @return a new NameRecord Unless the index is invalid
  7775. </member>
  7776. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveName(System.Int32)">
  7777. Removes the name
  7778. @param namenum name index
  7779. </member>
  7780. <member name="M:NPOI.HSSF.Model.InternalWorkbook.UpdateNameCommentRecordCache(NPOI.HSSF.Record.NameCommentRecord)">
  7781. If a {@link NameCommentRecord} is added or the name it references
  7782. is renamed, then this will update the lookup cache for it.
  7783. </member>
  7784. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetFormat(System.String,System.Boolean)">
  7785. Returns a format index that matches the passed in format. It does not tie into HSSFDataFormat.
  7786. @param format the format string
  7787. @param CreateIfNotFound Creates a new format if format not found
  7788. @return the format id of a format that matches or -1 if none found and CreateIfNotFound
  7789. </member>
  7790. <member name="P:NPOI.HSSF.Model.InternalWorkbook.Formats">
  7791. Returns the list of FormatRecords in the workbook.
  7792. @return ArrayList of FormatRecords in the notebook
  7793. </member>
  7794. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateFormat(System.String)">
  7795. Creates a FormatRecord, Inserts it, and returns the index code.
  7796. @param format the format string
  7797. @return the index code of the format record.
  7798. @see org.apache.poi.hssf.record.FormatRecord
  7799. @see org.apache.poi.hssf.record.Record
  7800. </member>
  7801. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateFormat(System.Int32)">
  7802. Creates a FormatRecord object
  7803. @param id the number of the format record to create (meaning its position in
  7804. a file as M$ Excel would create it.)
  7805. </member>
  7806. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindFirstRecordBySid(System.Int16)">
  7807. Returns the first occurance of a record matching a particular sid.
  7808. </member>
  7809. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindFirstRecordLocBySid(System.Int16)">
  7810. Returns the index of a record matching a particular sid.
  7811. @param sid The sid of the record to match
  7812. @return The index of -1 if no match made.
  7813. </member>
  7814. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindNextRecordBySid(System.Int16,System.Int32)">
  7815. Returns the next occurance of a record matching a particular sid.
  7816. </member>
  7817. <member name="P:NPOI.HSSF.Model.InternalWorkbook.IsUsing1904DateWindowing">
  7818. Whether date windowing is based on 1/2/1904 or 1/1/1900.
  7819. Some versions of Excel (Mac) can save workbooks using 1904 date windowing.
  7820. @return true if using 1904 date windowing
  7821. </member>
  7822. <member name="P:NPOI.HSSF.Model.InternalWorkbook.CustomPalette">
  7823. Returns the custom palette in use for this workbook; if a custom palette record
  7824. does not exist, then it is Created.
  7825. </member>
  7826. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindDrawingGroup">
  7827. Finds the primary drawing Group, if one already exists
  7828. </member>
  7829. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateDrawingGroup">
  7830. Creates a primary drawing Group record. If it already
  7831. exists then it's modified.
  7832. </member>
  7833. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveFontRecord(NPOI.HSSF.Record.FontRecord)">
  7834. Removes the given font record from the
  7835. file's list. This will make all
  7836. subsequent font indicies drop by one,
  7837. so you'll need to update those yourself!
  7838. </member>
  7839. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveExFormatRecord(NPOI.HSSF.Record.ExtendedFormatRecord)">
  7840. Removes the given ExtendedFormatRecord record from the
  7841. file's list. This will make all
  7842. subsequent font indicies drop by one,
  7843. so you'll need to update those yourself!
  7844. </member>
  7845. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveExFormatRecord(System.Int32)">
  7846. <summary>
  7847. Removes ExtendedFormatRecord record with given index from the file's list. This will make all
  7848. subsequent font indicies drop by one,so you'll need to update those yourself!
  7849. </summary>
  7850. <param name="index">index of the Extended format record (0-based)</param>
  7851. </member>
  7852. <member name="P:NPOI.HSSF.Model.InternalWorkbook.IsWriteProtected">
  7853. is the workbook protected with a password (not encrypted)?
  7854. </member>
  7855. <member name="M:NPOI.HSSF.Model.InternalWorkbook.WriteProtectWorkbook(System.String,System.String)">
  7856. protect a workbook with a password (not encypted, just Sets Writeprotect
  7857. flags and the password.
  7858. @param password to Set
  7859. </member>
  7860. <member name="M:NPOI.HSSF.Model.InternalWorkbook.UnwriteProtectWorkbook">
  7861. Removes the Write protect flag
  7862. </member>
  7863. <member name="M:NPOI.HSSF.Model.InternalWorkbook.ResolveNameXText(System.Int32,System.Int32)">
  7864. @param reFindex Index to REF entry in EXTERNSHEET record in the Link Table
  7865. @param definedNameIndex zero-based to DEFINEDNAME or EXTERNALNAME record
  7866. @return the string representation of the defined or external name
  7867. </member>
  7868. <member name="M:NPOI.HSSF.Model.InternalWorkbook.UpdateNamesAfterCellShift(NPOI.SS.Formula.FormulaShifter)">
  7869. Updates named ranges due to moving of cells
  7870. </member>
  7871. <member name="P:NPOI.HSSF.Model.InternalWorkbook.RecalcId">
  7872. Get or create RecalcIdRecord
  7873. @see org.apache.poi.hssf.usermodel.HSSFWorkbook#setForceFormulaRecalculation(boolean)
  7874. </member>
  7875. <member name="M:NPOI.HSSF.Model.InternalWorkbook.ChangeExternalReference(System.String,System.String)">
  7876. Changes an external referenced file to another file.
  7877. A formular in Excel which refers a cell in another file is saved in two parts:
  7878. The referenced file is stored in an reference table. the row/cell information is saved separate.
  7879. This method invokation will only change the reference in the lookup-table itself.
  7880. @param oldUrl The old URL to search for and which is to be replaced
  7881. @param newUrl The URL replacement
  7882. @return true if the oldUrl was found and replaced with newUrl. Otherwise false
  7883. </member>
  7884. <member name="T:NPOI.HSSF.Model.LinkTable">
  7885. Link Table (OOO pdf reference: 4.10.3 ) <p/>
  7886. The main data of all types of references is stored in the Link Table inside the Workbook Globals
  7887. Substream (4.2.5). The Link Table itself is optional and occurs only, if there are any
  7888. references in the document.
  7889. <p/>
  7890. In BIFF8 the Link Table consists of
  7891. <ul>
  7892. <li>zero or more EXTERNALBOOK Blocks<p/>
  7893. each consisting of
  7894. <ul>
  7895. <li>exactly one EXTERNALBOOK (0x01AE) record</li>
  7896. <li>zero or more EXTERNALNAME (0x0023) records</li>
  7897. <li>zero or more CRN Blocks<p/>
  7898. each consisting of
  7899. <ul>
  7900. <li>exactly one XCT (0x0059)record</li>
  7901. <li>zero or more CRN (0x005A) records (documentation says one or more)</li>
  7902. </ul>
  7903. </li>
  7904. </ul>
  7905. </li>
  7906. <li>zero or one EXTERNSHEET (0x0017) record</li>
  7907. <li>zero or more DEFINEDNAME (0x0018) records</li>
  7908. </ul>
  7909. @author Josh Micich
  7910. </member>
  7911. <member name="M:NPOI.HSSF.Model.LinkTable.ExternalBookBlock.#ctor">
  7912. Create a new block for registering add-in functions
  7913. @see org.apache.poi.hssf.model.LinkTable#addNameXPtg(String)
  7914. </member>
  7915. <member name="M:NPOI.HSSF.Model.LinkTable.ExternalBookBlock.#ctor(System.String,System.String[])">
  7916. Create a new block for external references.
  7917. </member>
  7918. <member name="M:NPOI.HSSF.Model.LinkTable.ExternalBookBlock.#ctor(System.Int32)">
  7919. Create a new block for internal references. It is called when constructing a new LinkTable.
  7920. @see org.apache.poi.hssf.model.LinkTable#LinkTable(int, WorkbookRecordList)
  7921. </member>
  7922. <member name="M:NPOI.HSSF.Model.LinkTable.ExternalBookBlock.GetIndexOfName(System.String)">
  7923. Performs case-insensitive search
  7924. @return -1 if not found
  7925. </member>
  7926. <member name="P:NPOI.HSSF.Model.LinkTable.RecordCount">
  7927. TODO - would not be required if calling code used RecordStream or similar
  7928. </member>
  7929. <member name="M:NPOI.HSSF.Model.LinkTable.GetFirstInternalSheetIndexForExtIndex(System.Int32)">
  7930. @param extRefIndex as from a {@link Ref3DPtg} or {@link Area3DPtg}
  7931. @return -1 if the reference is to an external book
  7932. </member>
  7933. <member name="M:NPOI.HSSF.Model.LinkTable.GetLastInternalSheetIndexForExtIndex(System.Int32)">
  7934. @param extRefIndex as from a {@link Ref3DPtg} or {@link Area3DPtg}
  7935. @return -1 if the reference is to an external book
  7936. </member>
  7937. <member name="M:NPOI.HSSF.Model.LinkTable.GetNameXPtg(System.String,System.Int32)">
  7938. Finds the external name definition for the given name,
  7939. optionally restricted by externsheet index, and returns
  7940. (if found) as a NameXPtg.
  7941. @param sheetRefIndex The Extern Sheet Index to look for, or -1 if any
  7942. </member>
  7943. <member name="M:NPOI.HSSF.Model.LinkTable.AddNameXPtg(System.String)">
  7944. Register an external name in this workbook
  7945. @param name the name to register
  7946. @return a NameXPtg describing this name
  7947. </member>
  7948. <member name="M:NPOI.HSSF.Model.LinkTable.FindFirstRecordLocBySid(System.Int16)">
  7949. copied from Workbook
  7950. </member>
  7951. <member name="M:NPOI.HSSF.Model.LinkTable.ChangeExternalReference(System.String,System.String)">
  7952. Changes an external referenced file to another file.
  7953. A formular in Excel which refers a cell in another file is saved in two parts:
  7954. The referenced file is stored in an reference table. the row/cell information is saved separate.
  7955. This method invokation will only change the reference in the lookup-table itself.
  7956. @param oldUrl The old URL to search for and which is to be replaced
  7957. @param newUrl The URL replacement
  7958. @return true if the oldUrl was found and replaced with newUrl. Otherwise false
  7959. </member>
  7960. <member name="T:NPOI.HSSF.Model.ParseNode">
  7961. Represents a syntactic element from a formula by encapsulating the corresponding <c>Ptg</c>
  7962. token. Each <c>ParseNode</c> may have child <c>ParseNode</c>s in the case when the wrapped
  7963. <c>Ptg</c> is non-atomic.
  7964. @author Josh Micich
  7965. </member>
  7966. <member name="M:NPOI.HSSF.Model.ParseNode.ToTokenArray(NPOI.HSSF.Model.ParseNode)">
  7967. <summary>
  7968. Collects the array of Ptg
  7969. tokens for the specified tree.
  7970. </summary>
  7971. <param name="rootNode">The root node.</param>
  7972. <returns></returns>
  7973. </member>
  7974. <member name="M:NPOI.HSSF.Model.ParseNode.CollectIfPtgs(NPOI.HSSF.Model.ParseNode.TokenCollector)">
  7975. <summary>
  7976. The IF() function Gets marked up with two or three tAttr tokens.
  7977. Similar logic will be required for CHOOSE() when it is supported
  7978. See excelfileformat.pdf sec 3.10.5 "tAttr (19H)
  7979. </summary>
  7980. <param name="temp">The temp.</param>
  7981. </member>
  7982. <member name="T:NPOI.HSSF.Model.RecordOrderer">
  7983. Finds correct insert positions for records in workbook streams<p/>
  7984. See OOO excelfileformat.pdf sec. 4.2.5 'Record Order in a BIFF8 Workbook Stream'
  7985. @author Josh Micich
  7986. </member>
  7987. <member name="M:NPOI.HSSF.Model.RecordOrderer.AddNewSheetRecord(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase},NPOI.HSSF.Record.RecordBase)">
  7988. Adds the specified new record in the correct place in sheet records list
  7989. </member>
  7990. <member name="M:NPOI.HSSF.Model.RecordOrderer.GetWorksheetProtectionBlockInsertPos(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  7991. <summary>
  7992. Finds the index where the protection block should be inserted
  7993. </summary>
  7994. <param name="records">the records for this sheet</param>
  7995. <returns></returns>
  7996. <remark>
  7997. + BOF
  7998. o INDEX
  7999. o Calculation Settings Block
  8000. o PRINTHEADERS
  8001. o PRINTGRIDLINES
  8002. o GRIDSET
  8003. o GUTS
  8004. o DEFAULTROWHEIGHT
  8005. o SHEETPR
  8006. o Page Settings Block
  8007. o Worksheet Protection Block
  8008. o DEFCOLWIDTH
  8009. oo COLINFO
  8010. o SORT
  8011. + DIMENSION
  8012. </remark>
  8013. </member>
  8014. <member name="M:NPOI.HSSF.Model.RecordOrderer.IsProtectionSubsequentRecord(System.Object)">
  8015. <summary>
  8016. These records may occur between the 'Worksheet Protection Block' and DIMENSION:
  8017. </summary>
  8018. <param name="rb"></param>
  8019. <returns></returns>
  8020. <remarks>
  8021. o DEFCOLWIDTH
  8022. oo COLINFO
  8023. o SORT
  8024. </remarks>
  8025. </member>
  8026. <member name="M:NPOI.HSSF.Model.RecordOrderer.FindInsertPosForNewCondFormatTable(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  8027. <summary>
  8028. Find correct position to add new CFHeader record
  8029. </summary>
  8030. <param name="records"></param>
  8031. <returns></returns>
  8032. </member>
  8033. <member name="M:NPOI.HSSF.Model.RecordOrderer.FindDataValidationTableInsertPos(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  8034. Finds the index where the sheet validations header record should be inserted
  8035. @param records the records for this sheet
  8036. + WINDOW2
  8037. o SCL
  8038. o PANE
  8039. oo SELECTION
  8040. o STANDARDWIDTH
  8041. oo MERGEDCELLS
  8042. o LABELRANGES
  8043. o PHONETICPR
  8044. o Conditional Formatting Table
  8045. o Hyperlink Table
  8046. o Data Validity Table
  8047. o SHEETLAYOUT
  8048. o SHEETPROTECTION
  8049. o RANGEPROTECTION
  8050. + EOF
  8051. </member>
  8052. <member name="M:NPOI.HSSF.Model.RecordOrderer.GetDimensionsIndex(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  8053. DIMENSIONS record is always present
  8054. </member>
  8055. <member name="M:NPOI.HSSF.Model.RecordOrderer.IsEndOfRowBlock(System.Int32)">
  8056. <summary>
  8057. if the specified record ID terminates a sequence of Row block records
  8058. It is assumed that at least one row or cell value record has been found prior to the current
  8059. record
  8060. </summary>
  8061. <param name="sid"></param>
  8062. <returns></returns>
  8063. </member>
  8064. <member name="M:NPOI.HSSF.Model.RecordOrderer.IsRowBlockRecord(System.Int32)">
  8065. <summary>
  8066. Whether the specified record id normally appears in the row blocks section of the sheet records
  8067. </summary>
  8068. <param name="sid"></param>
  8069. <returns></returns>
  8070. </member>
  8071. <member name="T:NPOI.HSSF.Model.RecordStream">
  8072. <summary>
  8073. Simplifies iteration over a sequence of Record objects.
  8074. @author Josh Micich
  8075. </summary>
  8076. </member>
  8077. <member name="M:NPOI.HSSF.Model.RecordStream.HasNext">
  8078. <summary>
  8079. Determines whether this instance has next.
  8080. </summary>
  8081. <returns>
  8082. <c>true</c> if this instance has next; otherwise, <c>false</c>.
  8083. </returns>
  8084. </member>
  8085. <member name="M:NPOI.HSSF.Model.RecordStream.GetNext">
  8086. <summary>
  8087. Gets the next record
  8088. </summary>
  8089. <returns></returns>
  8090. </member>
  8091. <member name="M:NPOI.HSSF.Model.RecordStream.PeekNextSid">
  8092. <summary>
  8093. Peeks the next sid.
  8094. </summary>
  8095. <returns>-1 if at end of records</returns>
  8096. </member>
  8097. <member name="M:NPOI.HSSF.Model.RecordStream.PeekNextClass">
  8098. <summary>
  8099. Peeks the next class.
  8100. </summary>
  8101. <returns>the class of the next Record.return null if this stream Is exhausted.</returns>
  8102. </member>
  8103. <member name="T:NPOI.HSSF.Model.RowBlocksReader">
  8104. Segregates the 'Row Blocks' section of a single sheet into plain row/cell records and
  8105. shared formula records.
  8106. @author Josh Micich
  8107. </member>
  8108. <member name="M:NPOI.HSSF.Model.RowBlocksReader.#ctor(NPOI.HSSF.Model.RecordStream)">
  8109. Also collects any loose MergeCellRecords and puts them in the supplied
  8110. mergedCellsTable
  8111. </member>
  8112. <member name="P:NPOI.HSSF.Model.RowBlocksReader.LooseMergedCells">
  8113. Some unconventional apps place {@link MergeCellsRecord}s within the row block. They
  8114. actually should be in the {@link MergedCellsTable} which is much later (see bug 45699).
  8115. @return any loose <c>MergeCellsRecord</c>s found
  8116. </member>
  8117. <member name="P:NPOI.HSSF.Model.RowBlocksReader.PlainRecordStream">
  8118. @return a {@link RecordStream} containing all the non-{@link SharedFormulaRecord}
  8119. non-{@link ArrayRecord} and non-{@link TableRecord} Records.
  8120. </member>
  8121. <member name="T:NPOI.HSSF.Model.WorkbookRecordList">
  8122. <summary>
  8123. List for records in Workbook
  8124. </summary>
  8125. </member>
  8126. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Records">
  8127. <summary>
  8128. Gets or sets the records.
  8129. </summary>
  8130. <value>The records.</value>
  8131. </member>
  8132. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Count">
  8133. <summary>
  8134. Gets the count.
  8135. </summary>
  8136. <value>The count.</value>
  8137. </member>
  8138. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Item(System.Int32)">
  8139. <summary>
  8140. Gets the <see cref="T:NPOI.HSSF.Record.Record"/> at the specified index.
  8141. </summary>
  8142. <value></value>
  8143. </member>
  8144. <member name="M:NPOI.HSSF.Model.WorkbookRecordList.Add(System.Int32,NPOI.HSSF.Record.Record)">
  8145. <summary>
  8146. Adds the specified pos.
  8147. </summary>
  8148. <param name="pos">The pos.</param>
  8149. <param name="r">The r.</param>
  8150. </member>
  8151. <member name="M:NPOI.HSSF.Model.WorkbookRecordList.Remove(NPOI.HSSF.Record.Record)">
  8152. <summary>
  8153. Removes the specified record.
  8154. </summary>
  8155. <param name="record">The record.</param>
  8156. </member>
  8157. <member name="M:NPOI.HSSF.Model.WorkbookRecordList.Remove(System.Int32)">
  8158. <summary>
  8159. Removes the specified position.
  8160. </summary>
  8161. <param name="pos">The position.</param>
  8162. </member>
  8163. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Protpos">
  8164. <summary>
  8165. Gets or sets the protpos.
  8166. </summary>
  8167. <value>The protpos.</value>
  8168. </member>
  8169. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Bspos">
  8170. <summary>
  8171. Gets or sets the bspos.
  8172. </summary>
  8173. <value>The bspos.</value>
  8174. </member>
  8175. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Tabpos">
  8176. <summary>
  8177. Gets or sets the tabpos.
  8178. </summary>
  8179. <value>The tabpos.</value>
  8180. </member>
  8181. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Fontpos">
  8182. <summary>
  8183. Gets or sets the fontpos.
  8184. </summary>
  8185. <value>The fontpos.</value>
  8186. </member>
  8187. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Xfpos">
  8188. <summary>
  8189. Gets or sets the xfpos.
  8190. </summary>
  8191. <value>The xfpos.</value>
  8192. </member>
  8193. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Backuppos">
  8194. <summary>
  8195. Gets or sets the backuppos.
  8196. </summary>
  8197. <value>The backuppos.</value>
  8198. </member>
  8199. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Palettepos">
  8200. <summary>
  8201. Gets or sets the palettepos.
  8202. </summary>
  8203. <value>The palettepos.</value>
  8204. </member>
  8205. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Namepos">
  8206. <summary>
  8207. Gets or sets the namepos.
  8208. </summary>
  8209. <value>The namepos.</value>
  8210. </member>
  8211. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Supbookpos">
  8212. <summary>
  8213. Gets or sets the supbookpos.
  8214. </summary>
  8215. <value>The supbookpos.</value>
  8216. </member>
  8217. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.ExternsheetPos">
  8218. <summary>
  8219. Gets or sets the externsheet pos.
  8220. </summary>
  8221. <value>The externsheet pos.</value>
  8222. </member>
  8223. <member name="T:NPOI.HSSF.Record.AbstractEscherHolderRecord">
  8224. The escher container record is used to hold escher records. It is abstract and
  8225. must be subclassed for maximum benefit.
  8226. @author Glen Stampoultzis (glens at apache.org)
  8227. @author Michael Zalewski (zalewski at optonline.net)
  8228. </member>
  8229. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8230. Constructs a Bar record and Sets its fields appropriately.
  8231. @param in the RecordInputstream to Read the record from
  8232. </member>
  8233. <member name="P:NPOI.HSSF.Record.AbstractEscherHolderRecord.RecordSize">
  8234. Size of record (including 4 byte header)
  8235. </member>
  8236. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.AddEscherRecord(System.Int32,NPOI.DDF.EscherRecord)">
  8237. Clone the current record, via a call to serialise
  8238. it, and another to Create a new record from the
  8239. bytes.
  8240. May only be used for classes which don't have
  8241. internal counts / ids in them. For those which
  8242. do, a full record-aware serialise is needed, which
  8243. allocates new ids / counts as needed.
  8244. </member>
  8245. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.GetEscherContainer">
  8246. If we have a EscherContainerRecord as one of our
  8247. children (and most top level escher holders do),
  8248. then return that.
  8249. </member>
  8250. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.FindFirstWithId(System.Int16)">
  8251. Descends into all our children, returning the
  8252. first EscherRecord with the given id, or null
  8253. if none found
  8254. </member>
  8255. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.Join(NPOI.HSSF.Record.AbstractEscherHolderRecord)">
  8256. Big drawing Group records are split but it's easier to deal with them
  8257. as a whole Group so we need to join them toGether.
  8258. </member>
  8259. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.Decode">
  8260. Convert raw data to escher records.
  8261. </member>
  8262. <member name="T:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate">
  8263. <summary>
  8264. </summary>
  8265. CFRecordsAggregate - aggregates Conditional Formatting records CFHeaderRecord
  8266. and number of up to three CFRuleRecord records toGether to simplify
  8267. access to them.
  8268. @author Dmitriy Kumshayev
  8269. </member>
  8270. <member name="F:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.MAX_97_2003_CONDTIONAL_FORMAT_RULES">
  8271. Excel allows up to 3 conditional formating rules
  8272. </member>
  8273. <member name="F:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.rules">
  8274. List of CFRuleRecord objects
  8275. </member>
  8276. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.CreateCFAggregate(NPOI.HSSF.Model.RecordStream)">
  8277. <summary>
  8278. Create CFRecordsAggregate from a list of CF Records
  8279. </summary>
  8280. <param name="rs">list of Record objects</param>
  8281. </member>
  8282. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.CreateCFAggregate(System.Collections.IList,System.Int32)">
  8283. <summary>
  8284. Create CFRecordsAggregate from a list of CF Records
  8285. </summary>
  8286. <param name="recs">list of Record objects</param>
  8287. <param name="pOffset">position of CFHeaderRecord object in the list of Record objects</param>
  8288. </member>
  8289. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.CloneCFAggregate">
  8290. <summary>
  8291. Create a deep Clone of the record
  8292. </summary>
  8293. </member>
  8294. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.Serialize(System.Int32,System.Byte[])">
  8295. <summary>
  8296. called by the class that is responsible for writing this sucker.
  8297. Subclasses should implement this so that their data is passed back in a
  8298. byte array.
  8299. </summary>
  8300. <param name="offset">The offset to begin writing at</param>
  8301. <param name="data">The data byte array containing instance data</param>
  8302. <returns> number of bytes written</returns>
  8303. </member>
  8304. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.UpdateFormulasAfterCellShift(NPOI.SS.Formula.FormulaShifter,System.Int32)">
  8305. @return <c>false</c> if this whole {@link CFHeaderRecord} / {@link CFRuleRecord}s should be deleted
  8306. </member>
  8307. <member name="T:NPOI.HSSF.Record.Aggregates.ChartSubstreamRecordAggregate">
  8308. Manages the all the records associated with a chart sub-stream.<br/>
  8309. Includes the Initial {@link BOFRecord} and {@link EOFRecord}.
  8310. @author Josh Micich
  8311. </member>
  8312. <member name="F:NPOI.HSSF.Record.Aggregates.ChartSubstreamRecordAggregate._recs">
  8313. All the records between BOF and EOF
  8314. </member>
  8315. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AttachedLabelAggregate">
  8316. <summary>
  8317. ATTACHEDLABEL = Text Begin Pos [FontX] [AlRuns] AI [FRAME] [ObjectLink] [DataLabExtContents] [CrtLayout12] [TEXTPROPS] [CRTMLFRT] End
  8318. AI = BRAI [SeriesText]
  8319. </summary>
  8320. </member>
  8321. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AxesAggregate">
  8322. <summary>
  8323. AXES = [IVAXIS DVAXIS [SERIESAXIS] / DVAXIS DVAXIS] *3ATTACHEDLABEL [PlotArea FRAME]
  8324. </summary>
  8325. </member>
  8326. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AxisParentAggregate">
  8327. <summary>
  8328. AXISPARENT = AxisParent Begin Pos [AXES] 1*4CRT End
  8329. </summary>
  8330. </member>
  8331. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AXMAggregate">
  8332. <summary>
  8333. AXM = YMult StartObject ATTACHEDLABEL EndObject
  8334. </summary>
  8335. </member>
  8336. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AXSAggregate">
  8337. <summary>
  8338. AXS = [IFmtRecord] [Tick] [FontX] *4(AxisLine LineFormat) [AreaFormat]
  8339. [GELFRAME] *4SHAPEPROPS [TextPropsStream *ContinueFrt12]
  8340. </summary>
  8341. </member>
  8342. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.ChartFormatsAggregate">
  8343. <summary>
  8344. CHARTFOMATS = Chart Begin *2FONTLIST Scl PlotGrowth [FRAME] *SERIESFORMAT *SS ShtProps
  8345. *2DFTTEXT AxesUsed 1*2AXISPARENT [CrtLayout12A] [DAT] *ATTACHEDLABEL [CRTMLFRT]
  8346. *([DataLabExt StartObject] ATTACHEDLABEL [EndObject]) [TEXTPROPS] *2CRTMLFRT End
  8347. </summary>
  8348. </member>
  8349. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.ChartSheetAggregate">
  8350. <summary>
  8351. CHARTSHEET = BOF CHARTSHEETCONTENT
  8352. CHARTSHEETCONTENT = [WriteProtect] [SheetExt] [WebPub] *HFPicture PAGESETUP PrintSize
  8353. [HeaderFooter] [BACKGROUND] *Fbi *Fbi2 [ClrtClient] [PROTECTION] [Palette] [SXViewLink]
  8354. [PivotChartBits] [SBaseRef] [MsoDrawingGroup] OBJECTS Units CHARTFOMATS SERIESDATA
  8355. *WINDOW *CUSTOMVIEW [CodeName] [CRTMLFRT] EOF
  8356. </summary>
  8357. </member>
  8358. <member name="F:NPOI.HSSF.Record.Aggregates.Chart.ChartSheetAggregate._recs">
  8359. All the records between BOF and EOF
  8360. </member>
  8361. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.CRTAggregate">
  8362. <summary>
  8363. CRT = ChartFormat Begin (Bar / Line / (BopPop [BopPopCustom]) / Pie / Area / Scatter / Radar /
  8364. RadarArea / Surf) CrtLink [SeriesList] [Chart3d] [LD] [2DROPBAR] *4(CrtLine LineFormat)
  8365. *2DFTTEXT [DataLabExtContents] [SS] *4SHAPEPROPS End
  8366. </summary>
  8367. </member>
  8368. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.CrtMlFrtAggregate">
  8369. <summary>
  8370. CRTMLFRT = CrtMlFrt *CrtMlFrtContinue
  8371. </summary>
  8372. </member>
  8373. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.DatAggregate">
  8374. <summary>
  8375. DAT = Dat Begin LD End
  8376. </summary>
  8377. </member>
  8378. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.DFTTextAggregate">
  8379. <summary>
  8380. DFTTEXT = [DataLabExt StartObject] DefaultText ATTACHEDLABEL [EndObject]
  8381. </summary>
  8382. </member>
  8383. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.DropBarAggregate">
  8384. <summary>
  8385. DROPBAR = DropBar Begin LineFormat AreaFormat [GELFRAME] [SHAPEPROPS] End
  8386. </summary>
  8387. </member>
  8388. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.DVAxisAggregate">
  8389. <summary>
  8390. DVAXIS = Axis Begin [ValueRange] [AXM] AXS [CRTMLFRT] End
  8391. </summary>
  8392. </member>
  8393. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.FontListAggregate">
  8394. <summary>
  8395. FONTLIST = FrtFontList StartObject *(Font [Fbi]) EndObject
  8396. </summary>
  8397. </member>
  8398. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.FrameAggregate">
  8399. <summary>
  8400. FRAME = Frame Begin LineFormat AreaFormat [GELFRAME] [SHAPEPROPS] End
  8401. </summary>
  8402. </member>
  8403. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.GelFrameAggregate">
  8404. <summary>
  8405. GELFRAME = 1*2GelFrame *Continue [PICF]
  8406. PICF = Begin PicF End
  8407. </summary>
  8408. </member>
  8409. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.IVAxisAggregate">
  8410. <summary>
  8411. IVAXIS = Axis Begin [CatSerRange] AxcExt [CatLab] AXS [CRTMLFRT] End
  8412. </summary>
  8413. </member>
  8414. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.LDAggregate">
  8415. <summary>
  8416. LD = Legend Begin Pos ATTACHEDLABEL [FRAME] [CrtLayout12] [TEXTPROPS] [CRTMLFRT] End
  8417. </summary>
  8418. </member>
  8419. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SeriesAxisAggregate">
  8420. <summary>
  8421. SERIESAXIS = Axis Begin [CatSerRange] AXS [CRTMLFRT] End
  8422. </summary>
  8423. </member>
  8424. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SeriesDataAggregate">
  8425. <summary>
  8426. SERIESDATA = Dimensions 3(SIIndex *(Number / BoolErr / Blank / Label))
  8427. </summary>
  8428. </member>
  8429. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SeriesFormatAggregate">
  8430. <summary>
  8431. SERIESFORMAT = Series Begin 4AI *SS (SerToCrt / (SerParent (SerAuxTrend / SerAuxErrBar)))
  8432. *(LegendException [Begin ATTACHEDLABEL [TEXTPROPS] End]) End
  8433. </summary>
  8434. </member>
  8435. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SeriesFormatAggregate.LegendExceptionAggregate">
  8436. <summary>
  8437. LegendException [Begin ATTACHEDLABEL [TEXTPROPS] End]
  8438. </summary>
  8439. </member>
  8440. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.ShapePropsAggregate">
  8441. <summary>
  8442. SHAPEPROPS = ShapePropsStream *ContinueFrt12
  8443. </summary>
  8444. </member>
  8445. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SSAggregate">
  8446. <summary>
  8447. SS = DataFormat Begin [Chart3DBarShape] [LineFormat AreaFormat PieFormat] [SerFmt]
  8448. [GELFRAME] [MarkerFormat] [AttachedLabel] *2SHAPEPROPS [CRTMLFRT] End
  8449. </summary>
  8450. </member>
  8451. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.TextPropsAggregate">
  8452. <summary>
  8453. TEXTPROPS = (RichTextStream / TextPropsStream) *ContinueFrt12
  8454. </summary>
  8455. </member>
  8456. <member name="T:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate">
  8457. <summary>
  8458. @author Glen Stampoultzis
  8459. </summary>
  8460. </member>
  8461. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.#ctor">
  8462. <summary>
  8463. Initializes a new instance of the <see cref="T:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate"/> class.
  8464. </summary>
  8465. </member>
  8466. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.#ctor(NPOI.HSSF.Model.RecordStream)">
  8467. <summary>
  8468. Initializes a new instance of the <see cref="T:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate"/> class.
  8469. </summary>
  8470. <param name="rs">The rs.</param>
  8471. </member>
  8472. <member name="P:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.Sid">
  8473. It's an aggregate... just made something up
  8474. </member>
  8475. <member name="P:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.NumColumns">
  8476. <summary>
  8477. Gets the num columns.
  8478. </summary>
  8479. <value>The num columns.</value>
  8480. </member>
  8481. <member name="P:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.RecordSize">
  8482. <summary>
  8483. Gets the size of the record.
  8484. </summary>
  8485. <value>The size of the record.</value>
  8486. </member>
  8487. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.Clone">
  8488. Performs a deep Clone of the record
  8489. </member>
  8490. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.InsertColumn(NPOI.HSSF.Record.ColumnInfoRecord)">
  8491. <summary>
  8492. Inserts a column into the aggregate (at the end of the list).
  8493. </summary>
  8494. <param name="col">The column.</param>
  8495. </member>
  8496. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.InsertColumn(System.Int32,NPOI.HSSF.Record.ColumnInfoRecord)">
  8497. <summary>
  8498. Inserts a column into the aggregate (at the position specified
  8499. by index
  8500. </summary>
  8501. <param name="idx">The index.</param>
  8502. <param name="col">The columninfo.</param>
  8503. </member>
  8504. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.Serialize(System.Int32,System.Byte[])">
  8505. <summary>
  8506. called by the class that is responsible for writing this sucker.
  8507. Subclasses should implement this so that their data is passed back in a
  8508. byte array.
  8509. </summary>
  8510. <param name="offset">offset to begin writing at</param>
  8511. <param name="data">byte array containing instance data</param>
  8512. <returns>number of bytes written</returns>
  8513. </member>
  8514. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.VisitContainedRecords(NPOI.HSSF.Record.Aggregates.RecordVisitor)">
  8515. <summary>
  8516. Visit each of the atomic BIFF records contained in this {@link RecordAggregate} in the order
  8517. that they should be written to file. Implementors may or may not return the actual
  8518. Records being used to manage POI's internal implementation. Callers should not
  8519. assume either way, and therefore only attempt to modify those Records after cloning
  8520. </summary>
  8521. <param name="rv"></param>
  8522. </member>
  8523. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.FindStartOfColumnOutlineGroup(System.Int32)">
  8524. <summary>
  8525. Finds the start of column outline group.
  8526. </summary>
  8527. <param name="idx">The idx.</param>
  8528. <returns></returns>
  8529. </member>
  8530. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.FindEndOfColumnOutlineGroup(System.Int32)">
  8531. <summary>
  8532. Finds the end of column outline group.
  8533. </summary>
  8534. <param name="idx">The idx.</param>
  8535. <returns></returns>
  8536. </member>
  8537. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.GetColInfo(System.Int32)">
  8538. <summary>
  8539. Gets the col info.
  8540. </summary>
  8541. <param name="idx">The idx.</param>
  8542. <returns></returns>
  8543. </member>
  8544. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.IsColumnGroupCollapsed(System.Int32)">
  8545. <summary>
  8546. Determines whether [is column group collapsed] [the specified idx].
  8547. </summary>
  8548. <param name="idx">The idx.</param>
  8549. <returns>
  8550. <c>true</c> if [is column group collapsed] [the specified idx]; otherwise, <c>false</c>.
  8551. </returns>
  8552. </member>
  8553. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.IsColumnGroupHiddenByParent(System.Int32)">
  8554. <summary>
  8555. Determines whether [is column group hidden by parent] [the specified idx].
  8556. </summary>
  8557. <param name="idx">The idx.</param>
  8558. <returns>
  8559. <c>true</c> if [is column group hidden by parent] [the specified idx]; otherwise, <c>false</c>.
  8560. </returns>
  8561. </member>
  8562. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.CollapseColumn(System.Int32)">
  8563. <summary>
  8564. Collapses the column.
  8565. </summary>
  8566. <param name="columnNumber">The column number.</param>
  8567. </member>
  8568. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.ExpandColumn(System.Int32)">
  8569. <summary>
  8570. Expands the column.
  8571. </summary>
  8572. <param name="columnNumber">The column number.</param>
  8573. </member>
  8574. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.SetColumnInfoFields(NPOI.HSSF.Record.ColumnInfoRecord,System.Nullable{System.Int16},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean})">
  8575. Sets all non null fields into the <c>ci</c> parameter.
  8576. </member>
  8577. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.AttemptMergeColInfoRecords(System.Int32)">
  8578. <summary>
  8579. Attempts to merge the col info record at the specified index
  8580. with either or both of its neighbours
  8581. </summary>
  8582. <param name="colInfoIx">The col info ix.</param>
  8583. </member>
  8584. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.MergeColInfoRecords(NPOI.HSSF.Record.ColumnInfoRecord,NPOI.HSSF.Record.ColumnInfoRecord)">
  8585. merges two column info records (if they are adjacent and have the same formatting, etc)
  8586. @return <c>false</c> if the two column records could not be merged
  8587. </member>
  8588. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.SetGroupHidden(System.Int32,System.Int32,System.Boolean)">
  8589. <summary>
  8590. Sets all adjacent columns of the same outline level to the specified hidden status.
  8591. </summary>
  8592. <param name="pIdx">the col info index of the start of the outline group.</param>
  8593. <param name="level">The level.</param>
  8594. <param name="hidden">The hidden.</param>
  8595. <returns>the column index of the last column in the outline group</returns>
  8596. </member>
  8597. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.SetColumn(System.Int32,System.Nullable{System.Int16},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean})">
  8598. <summary>
  8599. Sets the column.
  8600. </summary>
  8601. <param name="targetColumnIx">The target column ix.</param>
  8602. <param name="xfIndex">Index of the xf.</param>
  8603. <param name="width">The width.</param>
  8604. <param name="level">The level.</param>
  8605. <param name="hidden">The hidden.</param>
  8606. <param name="collapsed">The collapsed.</param>
  8607. </member>
  8608. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.SetColumnInfoFields(NPOI.HSSF.Record.ColumnInfoRecord,System.Int16,System.Int16,System.Int32,System.Boolean,System.Boolean)">
  8609. Sets all non null fields into the <c>ci</c> parameter.
  8610. </member>
  8611. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.CollapseColInfoRecords(System.Int32)">
  8612. <summary>
  8613. Collapses the col info records.
  8614. </summary>
  8615. <param name="columnIdx">The column index.</param>
  8616. </member>
  8617. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.GroupColumnRange(System.Int32,System.Int32,System.Boolean)">
  8618. <summary>
  8619. Creates an outline Group for the specified columns.
  8620. </summary>
  8621. <param name="fromColumnIx">Group from this column (inclusive)</param>
  8622. <param name="toColumnIx">Group to this column (inclusive)</param>
  8623. <param name="indent">if true the Group will be indented by one level;if false indenting will be Removed by one level.</param>
  8624. </member>
  8625. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.FindColumnInfo(System.Int32)">
  8626. <summary>
  8627. Finds the ColumnInfoRecord
  8628. which contains the specified columnIndex
  8629. </summary>
  8630. <param name="columnIndex">index of the column (not the index of the ColumnInfoRecord)</param>
  8631. <returns> /// <c>null</c>
  8632. if no column info found for the specified column
  8633. </returns>
  8634. </member>
  8635. <member name="P:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.MaxOutlineLevel">
  8636. <summary>
  8637. Gets the max outline level.
  8638. </summary>
  8639. <value>The max outline level.</value>
  8640. </member>
  8641. <member name="T:NPOI.HSSF.Record.Aggregates.ConditionalFormattingTable">
  8642. Holds all the conditional formatting for a workbook sheet.<p/>
  8643. See OOO exelfileformat.pdf sec 4.12 'Conditional Formatting Table'
  8644. @author Josh Micich
  8645. </member>
  8646. <member name="M:NPOI.HSSF.Record.Aggregates.ConditionalFormattingTable.#ctor">
  8647. Creates an empty ConditionalFormattingTable
  8648. </member>
  8649. <member name="M:NPOI.HSSF.Record.Aggregates.ConditionalFormattingTable.Add(NPOI.HSSF.Record.Aggregates.CFRecordsAggregate)">
  8650. @return index of the newly added CF header aggregate
  8651. </member>
  8652. <member name="T:NPOI.HSSF.Record.Aggregates.CustomViewSettingsRecordAggregate">
  8653. Manages the all the records associated with a 'Custom View Settings' sub-stream.<br/>
  8654. Includes the Initial USERSVIEWBEGIN(0x01AA) and USERSVIEWEND(0x01AB).
  8655. @author Josh Micich
  8656. </member>
  8657. <member name="F:NPOI.HSSF.Record.Aggregates.CustomViewSettingsRecordAggregate._recs">
  8658. All the records between BOF and EOF
  8659. </member>
  8660. <member name="T:NPOI.HSSF.Record.Aggregates.DataValidityTable">
  8661. <summary>
  8662. Manages the DVALRecord and DVRecords for a single sheet
  8663. See OOO excelfileformat.pdf section 4.14
  8664. @author Josh Micich
  8665. </summary>
  8666. </member>
  8667. <member name="F:NPOI.HSSF.Record.Aggregates.DataValidityTable._validationList">
  8668. The list of data validations for the current sheet.
  8669. Note - this may be empty (contrary to OOO documentation)
  8670. </member>
  8671. <member name="T:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate">
  8672. <summary>
  8673. The formula record aggregate is used to join toGether the formula record and it's
  8674. (optional) string record and (optional) Shared Formula Record (template Reads, excel optimization).
  8675. @author Glen Stampoultzis (glens at apache.org)
  8676. </summary>
  8677. </member>
  8678. <member name="F:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate._stringRecord">
  8679. caches the calculated result of the formula
  8680. </member>
  8681. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.#ctor(NPOI.HSSF.Record.FormulaRecord,NPOI.HSSF.Record.StringRecord,NPOI.HSSF.Record.Aggregates.SharedValueManager)">
  8682. <summary>
  8683. Initializes a new instance of the <see cref="T:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate"/> class.
  8684. </summary>
  8685. <param name="formulaRec">The formula rec.</param>
  8686. <param name="stringRec">The string rec.</param>
  8687. <param name="svm">The SVM.</param>
  8688. </member>
  8689. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.NotifyFormulaChanging">
  8690. Should be called by any code which is either deleting this formula cell, or changing
  8691. its type. This method gives the aggregate a chance to unlink any shared formula
  8692. that may be involved with this cell formula.
  8693. </member>
  8694. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.Serialize(System.Int32,System.Byte[])">
  8695. <summary>
  8696. called by the class that is responsible for writing this sucker.
  8697. Subclasses should implement this so that their data is passed back in a
  8698. byte array.
  8699. </summary>
  8700. <param name="offset">offset to begin writing at</param>
  8701. <param name="data">byte array containing instance data.</param>
  8702. <returns>number of bytes written</returns>
  8703. </member>
  8704. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.VisitContainedRecords(NPOI.HSSF.Record.Aggregates.RecordVisitor)">
  8705. <summary>
  8706. Visit each of the atomic BIFF records contained in this {@link RecordAggregate} in the order
  8707. that they should be written to file. Implementors may or may not return the actual
  8708. {@link Record}s being used to manage POI's internal implementation. Callers should not
  8709. assume either way, and therefore only attempt to modify those {@link Record}s after cloning
  8710. </summary>
  8711. <param name="rv"></param>
  8712. </member>
  8713. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.RecordSize">
  8714. <summary>
  8715. Get the current Serialized size of the record. Should include the sid and recLength (4 bytes).
  8716. </summary>
  8717. <value>The size of the record.</value>
  8718. </member>
  8719. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.Sid">
  8720. <summary>
  8721. return the non static version of the id for this record.
  8722. </summary>
  8723. <value>The sid.</value>
  8724. </member>
  8725. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.HandleMissingSharedFormulaRecord(NPOI.HSSF.Record.FormulaRecord)">
  8726. <summary>
  8727. Sometimes the shared formula flag "seems" to be erroneously set (because the corresponding
  8728. SharedFormulaRecord does not exist). Normally this would leave no way of determining
  8729. the Ptg tokens for the formula. However as it turns out in these
  8730. cases, Excel encodes the unshared Ptg tokens in the right place (inside the FormulaRecord).
  8731. So the the only thing that needs to be done is to ignore the erroneous
  8732. shared formula flag.
  8733. This method may also be used for setting breakpoints to help diagnose issues regarding the
  8734. abnormally-set 'shared formula' flags.
  8735. </summary>
  8736. <param name="formula">The formula.</param>
  8737. </member>
  8738. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.FormulaRecord">
  8739. <summary>
  8740. Gets or sets the formula record.
  8741. </summary>
  8742. <value>The formula record.</value>
  8743. </member>
  8744. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.StringRecord">
  8745. <summary>
  8746. Gets or sets the string record.
  8747. </summary>
  8748. <value>The string record.</value>
  8749. </member>
  8750. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.Equals(System.Object)">
  8751. <summary>
  8752. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
  8753. </summary>
  8754. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
  8755. <returns>
  8756. true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
  8757. </returns>
  8758. <exception cref="T:System.NullReferenceException">
  8759. The <paramref name="obj"/> parameter is null.
  8760. </exception>
  8761. </member>
  8762. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.ToString">
  8763. <summary>
  8764. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  8765. </summary>
  8766. <returns>
  8767. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  8768. </returns>
  8769. </member>
  8770. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.StringValue">
  8771. <summary>
  8772. Gets the string value.
  8773. </summary>
  8774. <value>The string value.</value>
  8775. </member>
  8776. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.SetCachedStringResult(System.String)">
  8777. <summary>
  8778. Sets the cached string result.
  8779. </summary>
  8780. <param name="value">The value.</param>
  8781. </member>
  8782. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.SetCachedBooleanResult(System.Boolean)">
  8783. <summary>
  8784. Sets the cached boolean result.
  8785. </summary>
  8786. <param name="value">if set to <c>true</c> [value].</param>
  8787. </member>
  8788. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.SetCachedErrorResult(System.Int32)">
  8789. <summary>
  8790. Sets the cached error result.
  8791. </summary>
  8792. <param name="errorCode">The error code.</param>
  8793. </member>
  8794. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.SetParsedExpression(NPOI.SS.Formula.PTG.Ptg[])">
  8795. Also checks for a related shared formula and unlinks it if found
  8796. </member>
  8797. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.RemoveArrayFormula(System.Int32,System.Int32)">
  8798. Removes an array formula
  8799. @return the range of the array formula containing the specified cell. Never <code>null</code>
  8800. </member>
  8801. <member name="T:NPOI.HSSF.Record.Aggregates.MergedCellsTable">
  8802. @author Josh Micich
  8803. </member>
  8804. <member name="M:NPOI.HSSF.Record.Aggregates.MergedCellsTable.#ctor">
  8805. <summary>
  8806. Creates an empty aggregate
  8807. </summary>
  8808. </member>
  8809. <member name="M:NPOI.HSSF.Record.Aggregates.MergedCellsTable.Read(NPOI.HSSF.Model.RecordStream)">
  8810. Reads zero or more consecutive {@link MergeCellsRecord}s
  8811. @param rs
  8812. </member>
  8813. <member name="T:NPOI.HSSF.Record.Aggregates.PageSettingsBlock">
  8814. Groups the page settings records for a worksheet.<p/>
  8815. See OOO excelfileformat.pdf sec 4.4 'Page Settings Block'
  8816. @author Josh Micich
  8817. </member>
  8818. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.#ctor">
  8819. Creates a PageSettingsBlock with default settings
  8820. </member>
  8821. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.IsComponentRecord(System.Int32)">
  8822. @return <c>true</c> if the specified Record sid is one belonging to the
  8823. 'Page Settings Block'.
  8824. </member>
  8825. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.SetColumnBreak(System.Int32,System.Int32,System.Int32)">
  8826. Sets a page break at the indicated column
  8827. </member>
  8828. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.RemoveColumnBreak(System.Int32)">
  8829. Removes a page break at the indicated column
  8830. </member>
  8831. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.CreateHCenter">
  8832. Creates the HCenter Record and sets it to false (don't horizontally center)
  8833. </member>
  8834. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.CreateVCenter">
  8835. Creates the VCenter Record and sets it to false (don't horizontally center)
  8836. </member>
  8837. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.CreatePrintSetup">
  8838. Creates the PrintSetup Record and sets it to defaults and marks it invalid
  8839. @see org.apache.poi.hssf.record.PrintSetupRecord
  8840. @see org.apache.poi.hssf.record.Record
  8841. @return record containing a PrintSetupRecord
  8842. </member>
  8843. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.Header">
  8844. Returns the HeaderRecord.
  8845. @return HeaderRecord for the sheet.
  8846. </member>
  8847. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.Footer">
  8848. Returns the FooterRecord.
  8849. @return FooterRecord for the sheet.
  8850. </member>
  8851. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.PrintSetup">
  8852. Returns the PrintSetupRecord.
  8853. @return PrintSetupRecord for the sheet.
  8854. </member>
  8855. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.GetMargin(NPOI.SS.UserModel.MarginType)">
  8856. Gets the size of the margin in inches.
  8857. @param margin which margin to Get
  8858. @return the size of the margin
  8859. </member>
  8860. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.SetMargin(NPOI.SS.UserModel.MarginType,System.Double)">
  8861. Sets the size of the margin in inches.
  8862. @param margin which margin to Get
  8863. @param size the size of the margin
  8864. </member>
  8865. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.ShiftBreaks(NPOI.HSSF.Record.PageBreakRecord,System.Int32,System.Int32,System.Int32)">
  8866. Shifts all the page breaks in the range "count" number of rows/columns
  8867. @param breaks The page record to be shifted
  8868. @param start Starting "main" value to shift breaks
  8869. @param stop Ending "main" value to shift breaks
  8870. @param count number of units (rows/columns) to shift by
  8871. </member>
  8872. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.SetRowBreak(System.Int32,System.Int16,System.Int16)">
  8873. Sets a page break at the indicated row
  8874. @param row
  8875. </member>
  8876. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.RemoveRowBreak(System.Int32)">
  8877. Removes a page break at the indicated row
  8878. @param row
  8879. </member>
  8880. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.IsRowBroken(System.Int32)">
  8881. Queries if the specified row has a page break
  8882. @param row
  8883. @return true if the specified row has a page break
  8884. </member>
  8885. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.IsColumnBroken(System.Int32)">
  8886. Queries if the specified column has a page break
  8887. @return <c>true</c> if the specified column has a page break
  8888. </member>
  8889. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.ShiftRowBreaks(System.Int32,System.Int32,System.Int32)">
  8890. Shifts the horizontal page breaks for the indicated count
  8891. @param startingRow
  8892. @param endingRow
  8893. @param count
  8894. </member>
  8895. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.ShiftColumnBreaks(System.Int16,System.Int16,System.Int16)">
  8896. Shifts the vertical page breaks for the indicated count
  8897. @param startingCol
  8898. @param endingCol
  8899. @param count
  8900. </member>
  8901. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.RowBreaks">
  8902. @return all the horizontal page breaks, never <c>null</c>
  8903. </member>
  8904. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.NumRowBreaks">
  8905. @return the number of row page breaks
  8906. </member>
  8907. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.ColumnBreaks">
  8908. @return all the column page breaks, never <c>null</c>
  8909. </member>
  8910. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.NumColumnBreaks">
  8911. @return the number of column page breaks
  8912. </member>
  8913. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.AddLateHeaderFooter(NPOI.HSSF.Record.HeaderFooterRecord)">
  8914. <summary>
  8915. HEADERFOOTER is new in 2007. Some apps seem to have scattered this record long after
  8916. the PageSettingsBlock where it belongs.
  8917. </summary>
  8918. <param name="rec"></param>
  8919. </member>
  8920. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.AddLateRecords(NPOI.HSSF.Model.RecordStream)">
  8921. <summary>
  8922. This method reads PageSettingsBlock records from the supplied RecordStream until the first non-PageSettingsBlock record is encountered.
  8923. As each record is read, it is incorporated into this PageSettingsBlock.
  8924. </summary>
  8925. <param name="rs"></param>
  8926. </member>
  8927. <member name="F:NPOI.HSSF.Record.Aggregates.PLSAggregate._plsContinues">
  8928. holds any continue records found after the PLS record.<br/>
  8929. This would not be required if PLS was properly interpreted.
  8930. Currently, PLS is an {@link UnknownRecord} and does not automatically
  8931. include any trailing {@link ContinueRecord}s.
  8932. </member>
  8933. <member name="M:NPOI.HSSF.Record.Aggregates.RecordVisitor.VisitRecord(NPOI.HSSF.Record.Record)">
  8934. Implementors may call non-mutating methods on Record r.
  8935. @param r must not be <c>null</c>
  8936. </member>
  8937. <member name="T:NPOI.HSSF.Record.Aggregates.RecordAggregate">
  8938. <c>RecordAggregate</c>s are groups of of BIFF <c>Record</c>s that are typically stored
  8939. together and/or updated together. Workbook / Sheet records are typically stored in a sequential
  8940. list, which does not provide much structure to coordinate updates.
  8941. @author Josh Micich
  8942. </member>
  8943. <member name="M:NPOI.HSSF.Record.Aggregates.RecordAggregate.VisitContainedRecords(NPOI.HSSF.Record.Aggregates.RecordVisitor)">
  8944. Visit each of the atomic BIFF records contained in this {@link RecordAggregate} in the order
  8945. that they should be written to file. Implementors may or may not return the actual
  8946. {@link Record}s being used to manage POI's internal implementation. Callers should not
  8947. assume either way, and therefore only attempt to modify those {@link Record}s after cloning
  8948. </member>
  8949. <member name="T:NPOI.HSSF.Record.Aggregates.PositionTrackingVisitor">
  8950. A wrapper for {@link RecordVisitor} which accumulates the sizes of all
  8951. records visited.
  8952. </member>
  8953. <member name="T:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate">
  8954. @author andy
  8955. @author Jason Height (jheight at chariot dot net dot au)
  8956. </member>
  8957. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.#ctor">
  8958. Creates a new instance of ValueRecordsAggregate
  8959. </member>
  8960. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.#ctor(NPOI.HSSF.Model.RecordStream,NPOI.HSSF.Record.Aggregates.SharedValueManager)">
  8961. @param rs record stream with all {@link SharedFormulaRecord}
  8962. {@link ArrayRecord}, {@link TableRecord} {@link MergeCellsRecord} Records removed
  8963. </member>
  8964. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.AddUnknownRecord(NPOI.HSSF.Record.Record)">
  8965. Handles UnknownRecords which appear within the row/cell records
  8966. </member>
  8967. <member name="P:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.RowBlockCount">
  8968. Returns the number of row blocks.
  8969. <p/>The row blocks are goupings of rows that contain the DBCell record
  8970. after them
  8971. </member>
  8972. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.GetRowCountForBlock(System.Int32)">
  8973. Returns the number of physical rows within a block
  8974. </member>
  8975. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.GetStartRowNumberForBlock(System.Int32)">
  8976. Returns the physical row number of the first row in a block
  8977. </member>
  8978. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.GetEndRowNumberForBlock(System.Int32)">
  8979. Returns the physical row number of the end row in a block
  8980. </member>
  8981. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.CreateRow(System.Int32)">
  8982. Create a row record.
  8983. @param row number
  8984. @return RowRecord Created for the passed in row number
  8985. @see org.apache.poi.hssf.record.RowRecord
  8986. </member>
  8987. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.GetCellValueEnumerator">
  8988. Returns an iterator for the cell values
  8989. </member>
  8990. <member name="T:NPOI.HSSF.Record.Aggregates.SharedValueManager">
  8991. <summary>
  8992. Manages various auxiliary records while constructing a RowRecordsAggregate
  8993. @author Josh Micich
  8994. </summary>
  8995. </member>
  8996. <member name="F:NPOI.HSSF.Record.Aggregates.SharedValueManager.SharedFormulaGroup._firstCell">
  8997. Coordinates of the first cell having a formula that uses this shared formula.
  8998. This is often <i>but not always</i> the top left cell in the range covered by
  8999. {@link #_sfr}
  9000. </member>
  9001. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.SharedFormulaGroup.IsFirstCell(System.Int32,System.Int32)">
  9002. Note - the 'first cell' of a shared formula group is not always the top-left cell
  9003. of the enclosing range.
  9004. @return <c>true</c> if the specified coordinates correspond to the 'first cell'
  9005. of this shared formula group.
  9006. </member>
  9007. <member name="F:NPOI.HSSF.Record.Aggregates.SharedValueManager._groupsCache">
  9008. cached for optimization purposes
  9009. </member>
  9010. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.Create(NPOI.HSSF.Record.SharedFormulaRecord[],NPOI.SS.Util.CellReference[],System.Collections.Generic.List{NPOI.HSSF.Record.ArrayRecord},System.Collections.Generic.List{NPOI.HSSF.Record.TableRecord})">
  9011. @param firstCells
  9012. @param recs list of sheet records (possibly Contains records for other parts of the Excel file)
  9013. @param startIx index of first row/cell record for current sheet
  9014. @param endIx one past index of last row/cell record for current sheet. It is important
  9015. that this code does not inadvertently collect <c>SharedFormulaRecord</c>s from any other
  9016. sheet (which could happen if endIx is chosen poorly). (see bug 44449)
  9017. </member>
  9018. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.LinkSharedFormulaRecord(NPOI.SS.Util.CellReference,NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate)">
  9019. @param firstCell as extracted from the {@link ExpPtg} from the cell's formula.
  9020. @return never <code>null</code>
  9021. </member>
  9022. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.GetRecordForFirstCell(NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate)">
  9023. Gets the {@link SharedValueRecordBase} record if it should be encoded immediately after the
  9024. formula record Contained in the specified {@link FormulaRecordAggregate} agg. Note - the
  9025. shared value record always appears after the first formula record in the group. For arrays
  9026. and tables the first formula is always the in the top left cell. However, since shared
  9027. formula groups can be sparse and/or overlap, the first formula may not actually be in the
  9028. top left cell.
  9029. @return the SHRFMLA, TABLE or ARRAY record for the formula cell, if it is the first cell of
  9030. a table or array region. <code>null</code> if the formula cell is not shared/array/table,
  9031. or if the specified formula is not the the first in the group.
  9032. </member>
  9033. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.Unlink(NPOI.HSSF.Record.SharedFormulaRecord)">
  9034. Converts all {@link FormulaRecord}s handled by <c>sharedFormulaRecord</c>
  9035. to plain unshared formulas
  9036. </member>
  9037. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.AddArrayRecord(NPOI.HSSF.Record.ArrayRecord)">
  9038. Add specified Array Record.
  9039. </member>
  9040. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.RemoveArrayFormula(System.Int32,System.Int32)">
  9041. Removes the {@link ArrayRecord} for the cell group containing the specified cell.
  9042. The caller should clear (set blank) all cells in the returned range.
  9043. @return the range of the array formula which was just removed. Never <code>null</code>.
  9044. </member>
  9045. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.GetArrayRecord(System.Int32,System.Int32)">
  9046. @return the shared ArrayRecord identified by (firstRow, firstColumn). never <code>null</code>.
  9047. </member>
  9048. <member name="T:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate">
  9049. Aggregate value records toGether. Things are easier to handle that way.
  9050. @author andy
  9051. @author Glen Stampoultzis (glens at apache.org)
  9052. @author Jason Height (jheight at chariot dot net dot au)
  9053. </member>
  9054. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.#ctor">
  9055. Creates a new instance of ValueRecordsAggregate
  9056. </member>
  9057. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.HandleMissingSharedFormulaRecord(NPOI.HSSF.Record.FormulaRecord)">
  9058. Sometimes the shared formula flag "seems" to be erroneously Set, in which case there is no
  9059. call to <c>SharedFormulaRecord.ConvertSharedFormulaRecord</c> and hence the
  9060. <c>ParsedExpression</c> field of this <c>FormulaRecord</c> will not Get updated.<br/>
  9061. As it turns out, this is not a problem, because in these circumstances, the existing value
  9062. for <c>ParsedExpression</c> is perfectly OK.<p/>
  9063. This method may also be used for Setting breakpoints to help diagnose Issues regarding the
  9064. abnormally-Set 'shared formula' flags.
  9065. (see TestValueRecordsAggregate.testSpuriousSharedFormulaFlag()).<p/>
  9066. The method currently does nothing but do not delete it without Finding a nice home for this
  9067. comment.
  9068. </member>
  9069. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.GetRowCellBlockSize(System.Int32,System.Int32)">
  9070. Tallies a count of the size of the cell records
  9071. that are attached to the rows in the range specified.
  9072. </member>
  9073. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.RowHasCells(System.Int32)">
  9074. Returns true if the row has cells attached to it
  9075. </member>
  9076. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.SerializeCellRow(System.Int32,System.Int32,System.Byte[])">
  9077. Serializes the cells that are allocated to a certain row range
  9078. </member>
  9079. <member name="T:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock">
  9080. Groups the sheet protection records for a worksheet.
  9081. <p/>
  9082. See OOO excelfileformat.pdf sec 4.18.2 'Sheet Protection in a Workbook
  9083. (BIFF5-BIFF8)'
  9084. @author Josh Micich
  9085. </member>
  9086. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.#ctor">
  9087. Creates an empty WorksheetProtectionBlock
  9088. </member>
  9089. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.IsComponentRecord(System.Int32)">
  9090. @return <c>true</c> if the specified Record sid is one belonging to
  9091. the 'Page Settings Block'.
  9092. </member>
  9093. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.AddRecords(NPOI.HSSF.Model.RecordStream)">
  9094. This method Reads {@link WorksheetProtectionBlock} records from the supplied RecordStream
  9095. until the first non-WorksheetProtectionBlock record is encountered. As each record is Read,
  9096. it is incorporated into this WorksheetProtectionBlock.
  9097. <p/>
  9098. As per the OOO documentation, the protection block records can be expected to be written
  9099. toGether (with no intervening records), but earlier versions of POI (prior to Jun 2009)
  9100. didn't do this. Workbooks with sheet protection Created by those earlier POI versions
  9101. seemed to be valid (Excel opens them OK). So PO allows continues to support Reading of files
  9102. with non continuous worksheet protection blocks.
  9103. <p/>
  9104. <b>Note</b> - when POI Writes out this WorksheetProtectionBlock, the records will always be
  9105. written in one consolidated block (in the standard ordering) regardless of how scattered the
  9106. records were when they were originally Read.
  9107. </member>
  9108. <member name="P:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.Protect">
  9109. <summary>
  9110. the ProtectRecord. If one is not contained in the sheet, then one is created.
  9111. </summary>
  9112. </member>
  9113. <member name="P:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.Password">
  9114. <summary>
  9115. the PasswordRecord. If one is not Contained in the sheet, then one is Created.
  9116. </summary>
  9117. </member>
  9118. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.ProtectSheet(System.String,System.Boolean,System.Boolean)">
  9119. <summary>
  9120. protect a spreadsheet with a password (not encrypted, just sets protect flags and the password.)
  9121. </summary>
  9122. <param name="password">password to set;Pass <code>null</code> to remove all protection</param>
  9123. <param name="shouldProtectObjects">shouldProtectObjects are protected</param>
  9124. <param name="shouldProtectScenarios">shouldProtectScenarios are protected</param>
  9125. </member>
  9126. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.CreateObjectProtect">
  9127. <summary>
  9128. Creates an ObjectProtect record with protect set to false.
  9129. </summary>
  9130. <returns></returns>
  9131. </member>
  9132. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.CreateScenarioProtect">
  9133. <summary>
  9134. Creates a ScenarioProtect record with protect set to false.
  9135. </summary>
  9136. <returns></returns>
  9137. </member>
  9138. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.CreatePassword">
  9139. <summary>
  9140. Creates a Password record with password set to 0x0000.
  9141. </summary>
  9142. <returns></returns>
  9143. </member>
  9144. <member name="T:NPOI.HSSF.Record.ArrayRecord">
  9145. ARRAY (0x0221)<p/>
  9146. Treated in a similar way to SharedFormulaRecord
  9147. @author Josh Micich
  9148. </member>
  9149. <member name="T:NPOI.HSSF.Record.AutoFilter.DOPERRecord">
  9150. <summary>
  9151. DOPER Structure for AutoFilter record
  9152. </summary>
  9153. <remarks>author: Tony Qu</remarks>
  9154. </member>
  9155. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.RK">
  9156. <summary>
  9157. get or set the RK record
  9158. </summary>
  9159. </member>
  9160. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.LengthOfString">
  9161. <summary>
  9162. Gets or sets Length of the string (the string is stored in the rgch field that follows the DOPER structures)
  9163. </summary>
  9164. </member>
  9165. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.IsBooleanValue">
  9166. <summary>
  9167. Whether the bBoolErr field contains a Boolean value
  9168. </summary>
  9169. </member>
  9170. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.IsErrorValue">
  9171. <summary>
  9172. Whether the bBoolErr field contains a Error value
  9173. </summary>
  9174. </member>
  9175. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.BooleanValue">
  9176. <summary>
  9177. Get or sets the boolean value
  9178. </summary>
  9179. </member>
  9180. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.ErrorValue">
  9181. <summary>
  9182. Get or sets the boolean value
  9183. </summary>
  9184. </member>
  9185. <member name="T:NPOI.HSSF.Record.BackupRecord">
  9186. Title: Backup Record
  9187. Description: bool specifying whether
  9188. the GUI should store a backup of the file.
  9189. REFERENCE: PG 287 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  9190. @author Andrew C. Oliver (acoliver at apache dot org)
  9191. @version 2.0-pre
  9192. </member>
  9193. <member name="M:NPOI.HSSF.Record.BackupRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9194. Constructs a BackupRecord and Sets its fields appropriately
  9195. @param in the RecordInputstream to Read the record from
  9196. </member>
  9197. <member name="P:NPOI.HSSF.Record.BackupRecord.Backup">
  9198. Get the backup flag
  9199. @return short 0/1 (off/on)
  9200. </member>
  9201. <member name="M:NPOI.HSSF.Record.BiffHeaderInput.ReadRecordSID">
  9202. Read an unsigned short from the stream without decrypting
  9203. </member>
  9204. <member name="M:NPOI.HSSF.Record.BiffHeaderInput.ReadDataSize">
  9205. Read an unsigned short from the stream without decrypting
  9206. </member>
  9207. <member name="T:NPOI.HSSF.Record.BlankRecord">
  9208. Title: Blank cell record
  9209. Description: Represents a column in a row with no value but with styling.
  9210. REFERENCE: PG 287 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  9211. @author Andrew C. Oliver (acoliver at apache dot org)
  9212. @author Jason Height (jheight at chariot dot net dot au)
  9213. @version 2.0-pre
  9214. </member>
  9215. <member name="M:NPOI.HSSF.Record.BlankRecord.#ctor">
  9216. Creates a new instance of BlankRecord
  9217. </member>
  9218. <member name="M:NPOI.HSSF.Record.BlankRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9219. Constructs a BlankRecord and Sets its fields appropriately
  9220. @param in the RecordInputstream to Read the record from
  9221. </member>
  9222. <member name="P:NPOI.HSSF.Record.BlankRecord.Row">
  9223. Get the row this cell occurs on
  9224. @return the row
  9225. </member>
  9226. <member name="P:NPOI.HSSF.Record.BlankRecord.Column">
  9227. Get the column this cell defines within the row
  9228. @return the column
  9229. </member>
  9230. <member name="P:NPOI.HSSF.Record.BlankRecord.XFIndex">
  9231. Set the index of the extended format record to style this cell with
  9232. @param xf - the 0-based index of the extended format
  9233. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  9234. </member>
  9235. <member name="P:NPOI.HSSF.Record.BlankRecord.Sid">
  9236. return the non static version of the id for this record.
  9237. </member>
  9238. <member name="M:NPOI.HSSF.Record.BlankRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  9239. called by the class that is responsible for writing this sucker.
  9240. Subclasses should implement this so that their data is passed back in a
  9241. byte array.
  9242. @return byte array containing instance data
  9243. </member>
  9244. <member name="T:NPOI.HSSF.Record.BOFRecord">
  9245. Title: Beginning Of File
  9246. Description: Somewhat of a misnomer, its used for the beginning of a Set of
  9247. records that have a particular pupose or subject.
  9248. Used in sheets and workbooks.
  9249. REFERENCE: PG 289 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  9250. @author Andrew C. Oliver
  9251. @author Jason Height (jheight at chariot dot net dot au)
  9252. @version 2.0-pre
  9253. </member>
  9254. <member name="F:NPOI.HSSF.Record.BOFRecord.sid">
  9255. for BIFF8 files the BOF is 0x809. For earlier versions see
  9256. {@link #biff2_sid} {@link #biff3_sid} {@link #biff4_sid}
  9257. {@link #biff5_sid}
  9258. </member>
  9259. <member name="F:NPOI.HSSF.Record.BOFRecord.VERSION">
  9260. suggested default (0x06 - BIFF8)
  9261. </member>
  9262. <member name="F:NPOI.HSSF.Record.BOFRecord.BUILD">
  9263. suggested default 0x10d3
  9264. </member>
  9265. <member name="F:NPOI.HSSF.Record.BOFRecord.BUILD_YEAR">
  9266. suggested default 0x07CC (1996)
  9267. </member>
  9268. <member name="F:NPOI.HSSF.Record.BOFRecord.HISTORY_MASK">
  9269. suggested default for a normal sheet (0x41)
  9270. </member>
  9271. <member name="M:NPOI.HSSF.Record.BOFRecord.#ctor">
  9272. Constructs an empty BOFRecord with no fields Set.
  9273. </member>
  9274. <member name="M:NPOI.HSSF.Record.BOFRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9275. Constructs a BOFRecord and Sets its fields appropriately
  9276. @param in the RecordInputstream to Read the record from
  9277. </member>
  9278. <member name="P:NPOI.HSSF.Record.BOFRecord.Version">
  9279. Version number - for BIFF8 should be 0x06
  9280. @see #VERSION
  9281. @param version version to be Set
  9282. </member>
  9283. <member name="P:NPOI.HSSF.Record.BOFRecord.HistoryBitMask">
  9284. Set the history bit mask (not very useful)
  9285. @see #HISTORY_MASK
  9286. @param bitmask bitmask to Set for the history
  9287. </member>
  9288. <member name="P:NPOI.HSSF.Record.BOFRecord.RequiredVersion">
  9289. Set the minimum version required to Read this file
  9290. @see #VERSION
  9291. @param version version to Set
  9292. </member>
  9293. <member name="P:NPOI.HSSF.Record.BOFRecord.Type">
  9294. type of object this marks
  9295. @see #TYPE_WORKBOOK
  9296. @see #TYPE_VB_MODULE
  9297. @see #TYPE_WORKSHEET
  9298. @see #TYPE_CHART
  9299. @see #TYPE_EXCEL_4_MACRO
  9300. @see #TYPE_WORKSPACE_FILE
  9301. @return short type of object
  9302. </member>
  9303. <member name="P:NPOI.HSSF.Record.BOFRecord.Build">
  9304. Get the build that wrote this file
  9305. @see #BUILD
  9306. @return short build number of the generator of this file
  9307. </member>
  9308. <member name="P:NPOI.HSSF.Record.BOFRecord.BuildYear">
  9309. Year of the build that wrote this file
  9310. @see #BUILD_YEAR
  9311. @return short build year of the generator of this file
  9312. </member>
  9313. <member name="T:NPOI.HSSF.Record.BookBoolRecord">
  9314. Title: Save External Links record (BookBool)
  9315. Description: Contains a flag specifying whether the Gui should save externally
  9316. linked values from other workbooks.
  9317. REFERENCE: PG 289 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  9318. @author Andrew C. Oliver (acoliver at apache dot org)
  9319. @version 2.0-pre
  9320. </member>
  9321. <member name="M:NPOI.HSSF.Record.BookBoolRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9322. Constructs a BookBoolRecord and Sets its fields appropriately
  9323. @param in the RecordInputstream to Read the record from
  9324. </member>
  9325. <member name="P:NPOI.HSSF.Record.BookBoolRecord.SaveLinkValues">
  9326. Get the save ext links flag
  9327. @return short 0/1 (off/on)
  9328. </member>
  9329. <member name="T:NPOI.HSSF.Record.BoolErrRecord">
  9330. Creates new BoolErrRecord.
  9331. REFERENCE: PG ??? Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  9332. @author Michael P. Harhen
  9333. @author Jason Height (jheight at chariot dot net dot au)
  9334. @version 2.0-pre
  9335. </member>
  9336. <member name="F:NPOI.HSSF.Record.BoolErrRecord._isError">
  9337. If <code>true</code>, this record represents an error cell value, otherwise this record represents a boolean cell value
  9338. </member>
  9339. <member name="M:NPOI.HSSF.Record.BoolErrRecord.#ctor">
  9340. Creates new BoolErrRecord
  9341. </member>
  9342. <member name="M:NPOI.HSSF.Record.BoolErrRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9343. Constructs a BoolErr record and Sets its fields appropriately.
  9344. @param in the RecordInputstream to Read the record from
  9345. </member>
  9346. <member name="M:NPOI.HSSF.Record.BoolErrRecord.SetValue(System.Boolean)">
  9347. Set the bool value for the cell
  9348. @param value representing the bool value
  9349. </member>
  9350. <member name="M:NPOI.HSSF.Record.BoolErrRecord.SetValue(System.Byte)">
  9351. set the error value for the cell. See {@link FormulaError} for valid codes.
  9352. @param value error representing the error value
  9353. this value can only be 0,7,15,23,29,36 or 42
  9354. see bugzilla bug 16560 for an explanation
  9355. </member>
  9356. <member name="M:NPOI.HSSF.Record.BoolErrRecord.SetValue(NPOI.SS.UserModel.FormulaError)">
  9357. Set the error value for the cell
  9358. @param value error representing the error value
  9359. this value can only be 0,7,15,23,29,36 or 42
  9360. see bugzilla bug 16560 for an explanation
  9361. </member>
  9362. <member name="P:NPOI.HSSF.Record.BoolErrRecord.BooleanValue">
  9363. Get the value for the cell
  9364. @return bool representing the bool value
  9365. </member>
  9366. <member name="P:NPOI.HSSF.Record.BoolErrRecord.ErrorValue">
  9367. Get the error value for the cell
  9368. @return byte representing the error value
  9369. </member>
  9370. <member name="P:NPOI.HSSF.Record.BoolErrRecord.IsBoolean">
  9371. Indicates whether the call holds a boolean value
  9372. @return boolean true if the cell holds a boolean value
  9373. </member>
  9374. <member name="P:NPOI.HSSF.Record.BoolErrRecord.IsError">
  9375. Indicates whether the call holds an error value
  9376. @return bool true if the cell holds an error value
  9377. </member>
  9378. <member name="T:NPOI.HSSF.Record.BottomMarginRecord">
  9379. Record for the bottom margin.
  9380. NOTE: This source was automatically generated.
  9381. @author Shawn Laubach (slaubach at apache dot org)
  9382. </member>
  9383. <member name="M:NPOI.HSSF.Record.BottomMarginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9384. Constructs a BottomMargin record and Sets its fields appropriately.
  9385. @param in the RecordInputstream to Read the record from
  9386. </member>
  9387. <member name="P:NPOI.HSSF.Record.BottomMarginRecord.Margin">
  9388. Get the margin field for the BottomMargin record.
  9389. </member>
  9390. <member name="T:NPOI.HSSF.Record.BoundSheetRecord">
  9391. Title: Bound Sheet Record (aka BundleSheet)
  9392. Description: Defines a sheet within a workbook. Basically stores the sheetname
  9393. and tells where the Beginning of file record Is within the HSSF
  9394. file.
  9395. REFERENCE: PG 291 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  9396. @author Andrew C. Oliver (acoliver at apache dot org)
  9397. @author Sergei Kozello (sergeikozello at mail.ru)
  9398. </member>
  9399. <member name="M:NPOI.HSSF.Record.BoundSheetRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9400. Constructs a BoundSheetRecord and Sets its fields appropriately
  9401. @param in the RecordInputstream to Read the record from
  9402. </member>
  9403. <member name="P:NPOI.HSSF.Record.BoundSheetRecord.PositionOfBof">
  9404. Get the offset in bytes of the Beginning of File Marker within the HSSF Stream part of the POIFS file
  9405. @return offset in bytes
  9406. </member>
  9407. <member name="P:NPOI.HSSF.Record.BoundSheetRecord.IsVeryHidden">
  9408. Is the sheet very hidden? Different from (normal) hidden
  9409. </member>
  9410. <member name="P:NPOI.HSSF.Record.BoundSheetRecord.Sheetname">
  9411. Get the sheetname for this sheet. (this appears in the tabs at the bottom)
  9412. @return sheetname the name of the sheet
  9413. </member>
  9414. <member name="M:NPOI.HSSF.Record.BoundSheetRecord.OrderByBofPosition(System.Collections.Generic.List{NPOI.HSSF.Record.BoundSheetRecord})">
  9415. Converts a List of {@link BoundSheetRecord}s to an array and sorts by the position of their
  9416. BOFs.
  9417. </member>
  9418. <member name="T:NPOI.HSSF.Record.CalcCountRecord">
  9419. Title: Calc Count Record
  9420. Description: Specifies the maximum times the gui should perform a formula
  9421. recalculation. For instance: in the case a formula includes
  9422. cells that are themselves a result of a formula and a value
  9423. Changes. This Is essentially a failsafe against an infinate
  9424. loop in the event the formulas are not independant.
  9425. REFERENCE: PG 292 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  9426. @author Andrew C. Oliver (acoliver at apache dot org)
  9427. @author Jason Height (jheight at chariot dot net dot au)
  9428. @version 2.0-pre
  9429. @see org.apache.poi.hssf.record.CalcModeRecord
  9430. </member>
  9431. <member name="M:NPOI.HSSF.Record.CalcCountRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9432. Constructs a CalcCountRecord and Sets its fields appropriately
  9433. @param in the RecordInputstream to Read the record from
  9434. </member>
  9435. <member name="P:NPOI.HSSF.Record.CalcCountRecord.Iterations">
  9436. Get the number of iterations to perform
  9437. @return iterations
  9438. </member>
  9439. <member name="T:NPOI.HSSF.Record.CalcModeRecord">
  9440. Title: Calc Mode Record
  9441. Description: Tells the gui whether to calculate formulas
  9442. automatically, manually or automatically
  9443. except for tables.
  9444. REFERENCE: PG 292 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  9445. @author Andrew C. Oliver (acoliver at apache dot org)
  9446. @author Jason Height (jheight at chariot dot net dot au)
  9447. @version 2.0-pre
  9448. @see org.apache.poi.hssf.record.CalcCountRecord
  9449. </member>
  9450. <member name="F:NPOI.HSSF.Record.CalcModeRecord.MANUAL">
  9451. manually calculate formulas (0)
  9452. </member>
  9453. <member name="F:NPOI.HSSF.Record.CalcModeRecord.AUTOMATIC">
  9454. automatically calculate formulas (1)
  9455. </member>
  9456. <member name="F:NPOI.HSSF.Record.CalcModeRecord.AUTOMATIC_EXCEPT_TABLES">
  9457. automatically calculate formulas except for tables (-1)
  9458. </member>
  9459. <member name="M:NPOI.HSSF.Record.CalcModeRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9460. Constructs a CalcModeRecord and Sets its fields appropriately
  9461. @param in the RecordInputstream to Read the record from
  9462. </member>
  9463. <member name="M:NPOI.HSSF.Record.CalcModeRecord.SetCalcMode(System.Int16)">
  9464. Set the calc mode flag for formulas
  9465. @see #MANUAL
  9466. @see #AUTOMATIC
  9467. @see #AUTOMATIC_EXCEPT_TABLES
  9468. @param calcmode one of the three flags above
  9469. </member>
  9470. <member name="M:NPOI.HSSF.Record.CalcModeRecord.GetCalcMode">
  9471. Get the calc mode flag for formulas
  9472. @see #MANUAL
  9473. @see #AUTOMATIC
  9474. @see #AUTOMATIC_EXCEPT_TABLES
  9475. @return calcmode one of the three flags above
  9476. </member>
  9477. <member name="P:NPOI.HSSF.Record.CellRecord.XFIndex">
  9478. get the index to the ExtendedFormat
  9479. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  9480. @return index to the XF record
  9481. </member>
  9482. <member name="M:NPOI.HSSF.Record.CellRecord.AppendValueText(System.Text.StringBuilder)">
  9483. Append specific debug info (used by {@link #toString()} for the value
  9484. contained in this record. Trailing new-line should not be Appended
  9485. (superclass does that).
  9486. </member>
  9487. <member name="P:NPOI.HSSF.Record.CellRecord.RecordName">
  9488. Gets the debug info BIFF record type name (used by {@link #toString()}.
  9489. </member>
  9490. <member name="M:NPOI.HSSF.Record.CellRecord.SerializeValue(NPOI.Util.ILittleEndianOutput)">
  9491. writes out the value data for this cell record
  9492. </member>
  9493. <member name="P:NPOI.HSSF.Record.CellRecord.ValueDataSize">
  9494. @return the size (in bytes) of the value data for this cell record
  9495. </member>
  9496. <member name="T:NPOI.HSSF.Record.CellValueRecordInterface">
  9497. The cell value record interface Is implemented by all classes of type Record that
  9498. contain cell values. It allows the containing sheet to move through them and Compare
  9499. them.
  9500. @author Andrew C. Oliver (acoliver at apache dot org)
  9501. @author Jason Height (jheight at chariot dot net dot au)
  9502. @see org.apache.poi.hssf.model.Sheet
  9503. @see org.apache.poi.hssf.record.Record
  9504. @see org.apache.poi.hssf.record.RecordFactory
  9505. </member>
  9506. <member name="P:NPOI.HSSF.Record.CellValueRecordInterface.Row">
  9507. Get the row this cell occurs on
  9508. @return the row
  9509. </member>
  9510. <member name="P:NPOI.HSSF.Record.CellValueRecordInterface.Column">
  9511. Get the column this cell defines within the row
  9512. @return the column
  9513. </member>
  9514. <member name="T:NPOI.HSSF.Record.CFHeader12Record">
  9515. Conditional Formatting Header v12 record CFHEADER12 (0x0879),
  9516. for conditional formattings introduced in Excel 2007 and newer.
  9517. </member>
  9518. <member name="M:NPOI.HSSF.Record.CFHeader12Record.#ctor">
  9519. Creates new CFHeaderRecord
  9520. </member>
  9521. <member name="T:NPOI.HSSF.Record.CFHeaderBase">
  9522. Parent of Conditional Formatting Header records,
  9523. {@link CFHeaderRecord} and {@link CFHeader12Record}.
  9524. </member>
  9525. <member name="M:NPOI.HSSF.Record.CFHeaderBase.#ctor">
  9526. Creates new CFHeaderBase
  9527. </member>
  9528. <member name="P:NPOI.HSSF.Record.CFHeaderBase.CellRanges">
  9529. Set cell ranges list to a single cell range and
  9530. modify the enclosing cell range accordingly.
  9531. @param cellRanges - list of CellRange objects
  9532. </member>
  9533. <member name="T:NPOI.HSSF.Record.CFHeaderRecord">
  9534. Conditional Formatting Header record CFHEADER (0x01B0).
  9535. Used to describe a {@link CFRuleRecord}.
  9536. @see CFHeader12Record
  9537. </member>
  9538. <member name="M:NPOI.HSSF.Record.CFHeaderRecord.#ctor">
  9539. Creates new CFHeaderRecord
  9540. </member>
  9541. <!-- Badly formed XML comment ignored for member "T:NPOI.HSSF.Record.CFRule12Record" -->
  9542. <member name="M:NPOI.HSSF.Record.CFRule12Record.#ctor(System.Byte,System.Byte)">
  9543. Creates new CFRuleRecord
  9544. </member>
  9545. <member name="M:NPOI.HSSF.Record.CFRule12Record.Create(NPOI.HSSF.UserModel.HSSFSheet,System.String)">
  9546. Creates a new comparison operation rule
  9547. </member>
  9548. <member name="M:NPOI.HSSF.Record.CFRule12Record.Create(NPOI.HSSF.UserModel.HSSFSheet,System.Byte,System.String,System.String)">
  9549. Creates a new comparison operation rule
  9550. </member>
  9551. <member name="M:NPOI.HSSF.Record.CFRule12Record.Create(NPOI.HSSF.UserModel.HSSFSheet,System.Byte,System.String,System.String,System.String)">
  9552. Creates a new comparison operation rule
  9553. </member>
  9554. <member name="M:NPOI.HSSF.Record.CFRule12Record.Create(NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.Record.Common.ExtendedColor)">
  9555. <summary>
  9556. Creates a new Data Bar formatting
  9557. </summary>
  9558. <param name="sheet"></param>
  9559. <param name="color"></param>
  9560. <returns></returns>
  9561. </member>
  9562. <member name="M:NPOI.HSSF.Record.CFRule12Record.Create(NPOI.HSSF.UserModel.HSSFSheet,NPOI.SS.UserModel.IconSet)">
  9563. <summary>
  9564. Creates a new Icon Set / Multi-State formatting
  9565. </summary>
  9566. <param name="sheet"></param>
  9567. <param name="iconSet"></param>
  9568. <returns></returns>
  9569. </member>
  9570. <member name="M:NPOI.HSSF.Record.CFRule12Record.CreateColorScale(NPOI.HSSF.UserModel.HSSFSheet)">
  9571. <summary>
  9572. Creates a new Color Scale / Color Gradient formatting
  9573. </summary>
  9574. <param name="sheet"></param>
  9575. <returns></returns>
  9576. </member>
  9577. <member name="P:NPOI.HSSF.Record.CFRule12Record.ParsedExpressionScale">
  9578. Get the stack of the scale expression as a list
  9579. @return list of tokens (casts stack to a list and returns it!)
  9580. this method can return null is we are unable to create Ptgs from
  9581. existing excel file
  9582. callers should check for null!
  9583. </member>
  9584. <member name="M:NPOI.HSSF.Record.CFRule12Record.Serialize(NPOI.Util.ILittleEndianOutput)">
  9585. called by the class that is responsible for writing this sucker.
  9586. Subclasses should implement this so that their data is passed back in a
  9587. byte array.
  9588. @param out the stream to write to
  9589. </member>
  9590. <!-- Badly formed XML comment ignored for member "T:NPOI.HSSF.Record.CFRuleBase" -->
  9591. <member name="M:NPOI.HSSF.Record.CFRuleBase.#ctor(System.Byte,System.Byte)">
  9592. Creates new CFRuleRecord
  9593. </member>
  9594. <member name="P:NPOI.HSSF.Record.CFRuleBase.Options">
  9595. Get the option flags
  9596. @return bit mask
  9597. </member>
  9598. <member name="P:NPOI.HSSF.Record.CFRuleBase.ParsedExpression1">
  9599. Get the stack of the 1st expression as a list
  9600. @return list of tokens (casts stack to a list and returns it!)
  9601. this method can return null is we are unable to create Ptgs from
  9602. existing excel file
  9603. callers should check for null!
  9604. </member>
  9605. <member name="P:NPOI.HSSF.Record.CFRuleBase.ParsedExpression2">
  9606. Get the stack of the 2nd expression as a list
  9607. @return array of {@link Ptg}s, possibly <code>null</code>
  9608. </member>
  9609. <member name="M:NPOI.HSSF.Record.CFRuleBase.GetFormulaSize(NPOI.SS.Formula.Formula)">
  9610. @param formula must not be <code>null</code>
  9611. @return encoded size of the formula tokens (does not include 2 bytes for ushort length)
  9612. </member>
  9613. <!-- Badly formed XML comment ignored for member "M:NPOI.HSSF.Record.CFRuleBase.ParseFormula(System.String,NPOI.HSSF.UserModel.HSSFSheet)" -->
  9614. <!-- Badly formed XML comment ignored for member "T:NPOI.HSSF.Record.CFRuleRecord" -->
  9615. <member name="M:NPOI.HSSF.Record.CFRuleRecord.#ctor(System.Byte,System.Byte)">
  9616. Creates new CFRuleRecord
  9617. </member>
  9618. <member name="M:NPOI.HSSF.Record.CFRuleRecord.Create(NPOI.HSSF.UserModel.HSSFSheet,System.String)">
  9619. Creates a new comparison operation rule
  9620. </member>
  9621. <member name="M:NPOI.HSSF.Record.CFRuleRecord.Create(NPOI.HSSF.UserModel.HSSFSheet,System.Byte,System.String,System.String)">
  9622. Creates a new comparison operation rule
  9623. </member>
  9624. <member name="M:NPOI.HSSF.Record.CFRuleRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  9625. called by the class that is responsible for writing this sucker.
  9626. Subclasses should implement this so that their data is passed back in a
  9627. byte array.
  9628. @param out the stream to write to
  9629. </member>
  9630. <member name="T:NPOI.HSSF.Record.CF.BorderFormatting">
  9631. Border Formatting Block of the Conditional Formatting Rule Record.
  9632. @author Dmitriy Kumshayev
  9633. </member>
  9634. <member name="M:NPOI.HSSF.Record.CF.BorderFormatting.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9635. Creates new FontFormatting
  9636. </member>
  9637. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderLeft">
  9638. <summary>
  9639. Get the type of border to use for the left border of the cell
  9640. </summary>
  9641. </member>
  9642. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderRight">
  9643. <summary>
  9644. Get the type of border to use for the right border of the cell
  9645. </summary>
  9646. </member>
  9647. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderTop">
  9648. <summary>
  9649. Get the type of border to use for the top border of the cell
  9650. </summary>
  9651. </member>
  9652. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderBottom">
  9653. <summary>
  9654. Get the type of border to use for the bottom border of the cell
  9655. </summary>
  9656. </member>
  9657. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderDiagonal">
  9658. <summary>
  9659. Get the type of border to use for the diagonal border of the cell
  9660. </summary>
  9661. </member>
  9662. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.LeftBorderColor">
  9663. <summary>
  9664. Get the color to use for the left border
  9665. </summary>
  9666. </member>
  9667. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.RightBorderColor">
  9668. <summary>
  9669. Get the color to use for the right border
  9670. </summary>
  9671. </member>
  9672. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.TopBorderColor">
  9673. <summary>
  9674. Get the color to use for the top border
  9675. </summary>
  9676. </member>
  9677. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BottomBorderColor">
  9678. <summary>
  9679. Get the color to use for the bottom border
  9680. </summary>
  9681. </member>
  9682. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.DiagonalBorderColor">
  9683. <summary>
  9684. Get the color to use for the diagonal border
  9685. </summary>
  9686. </member>
  9687. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.IsForwardDiagonalOn">
  9688. <summary>
  9689. true if forward diagonal is on
  9690. </summary>
  9691. </member>
  9692. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.IsBackwardDiagonalOn">
  9693. <summary>
  9694. true if backward diagonal Is on
  9695. </summary>
  9696. </member>
  9697. <member name="T:NPOI.HSSF.Record.CF.ColorGradientFormatting">
  9698. Color Gradient / Color Scale Conditional Formatting Rule Record.
  9699. (Called Color Gradient in the file format docs, but more commonly
  9700. Color Scale in the UI)
  9701. </member>
  9702. <member name="T:NPOI.HSSF.Record.CF.ColorGradientThreshold">
  9703. Color Gradient / Color Scale specific Threshold / value (CFVO),
  9704. for Changes in Conditional Formatting
  9705. </member>
  9706. <member name="M:NPOI.HSSF.Record.CF.ColorGradientThreshold.#ctor(NPOI.Util.ILittleEndianInput)">
  9707. Creates new Color Gradient Threshold
  9708. </member>
  9709. <member name="T:NPOI.HSSF.Record.CF.DataBarFormatting">
  9710. Data Bar Conditional Formatting Rule Record.
  9711. </member>
  9712. <member name="T:NPOI.HSSF.Record.CF.DataBarThreshold">
  9713. Data Bar specific Threshold / value (CFVO),
  9714. for Changes in Conditional Formatting
  9715. </member>
  9716. <member name="M:NPOI.HSSF.Record.CF.DataBarThreshold.#ctor(NPOI.Util.ILittleEndianInput)">
  9717. Creates new Data Bar Threshold
  9718. </member>
  9719. <member name="T:NPOI.HSSF.Record.CF.FontFormatting">
  9720. Font Formatting Block of the Conditional Formatting Rule Record.
  9721. @author Dmitriy Kumshayev
  9722. </member>
  9723. <member name="F:NPOI.HSSF.Record.CF.FontFormatting.FONT_WEIGHT_NORMAL">
  9724. Normal boldness (not bold)
  9725. </member>
  9726. <member name="F:NPOI.HSSF.Record.CF.FontFormatting.FONT_WEIGHT_BOLD">
  9727. Bold boldness (bold)
  9728. </member>
  9729. <member name="M:NPOI.HSSF.Record.CF.FontFormatting.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9730. Creates new FontFormatting
  9731. </member>
  9732. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.FontHeight">
  9733. Gets the height of the font in 1/20th point Units
  9734. @return fontheight (in points/20); or -1 if not modified
  9735. </member>
  9736. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.IsItalic">
  9737. Get whether the font Is to be italics or not
  9738. @return italics - whether the font Is italics or not
  9739. @see #GetAttributes()
  9740. </member>
  9741. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.IsStruckout">
  9742. Get whether the font Is to be stricken out or not
  9743. @return strike - whether the font Is stricken out or not
  9744. @see #GetAttributes()
  9745. </member>
  9746. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.FontWeight">
  9747. <summary>
  9748. Get or set the font weight for this font (100-1000dec or 0x64-0x3e8).
  9749. Default Is 0x190 for normal and 0x2bc for bold
  9750. </summary>
  9751. </member>
  9752. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.IsBold">
  9753. <summary>
  9754. Get or set whether the font weight is set to bold or not
  9755. </summary>
  9756. </member>
  9757. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.EscapementType">
  9758. Get the type of base or subscript for the font
  9759. @return base or subscript option
  9760. @see org.apache.poi.hssf.usermodel.HSSFFontFormatting#SS_NONE
  9761. @see org.apache.poi.hssf.usermodel.HSSFFontFormatting#SS_SUPER
  9762. @see org.apache.poi.hssf.usermodel.HSSFFontFormatting#SS_SUB
  9763. </member>
  9764. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.UnderlineType">
  9765. Get the type of Underlining for the font
  9766. @return font Underlining type
  9767. </member>
  9768. <member name="T:NPOI.HSSF.Record.CF.IconMultiStateFormatting">
  9769. Icon / Multi-State Conditional Formatting Rule Record.
  9770. </member>
  9771. <member name="T:NPOI.HSSF.Record.CF.IconMultiStateThreshold">
  9772. Icon / Multi-State specific Threshold / value (CFVO),
  9773. for Changes in Conditional Formatting
  9774. </member>
  9775. <member name="F:NPOI.HSSF.Record.CF.IconMultiStateThreshold.EQUALS_EXCLUDE">
  9776. Cell values that are equal to the threshold value do not pass the threshold
  9777. </member>
  9778. <member name="F:NPOI.HSSF.Record.CF.IconMultiStateThreshold.EQUALS_INCLUDE">
  9779. Cell values that are equal to the threshold value pass the threshold.
  9780. </member>
  9781. <member name="M:NPOI.HSSF.Record.CF.IconMultiStateThreshold.#ctor(NPOI.Util.ILittleEndianInput)">
  9782. Creates new Ico Multi-State Threshold
  9783. </member>
  9784. <member name="T:NPOI.HSSF.Record.CF.PatternFormatting">
  9785. Pattern Formatting Block of the Conditional Formatting Rule Record.
  9786. @author Dmitriy Kumshayev
  9787. </member>
  9788. <member name="M:NPOI.HSSF.Record.CF.PatternFormatting.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9789. Creates new FontFormatting
  9790. </member>
  9791. <member name="P:NPOI.HSSF.Record.CF.PatternFormatting.FillPattern">
  9792. Get the Fill pattern
  9793. @return Fill pattern
  9794. </member>
  9795. <member name="P:NPOI.HSSF.Record.CF.PatternFormatting.FillBackgroundColor">
  9796. Get the background Fill color
  9797. @see org.apache.poi.hssf.usermodel.HSSFPalette#GetColor(short)
  9798. @return Fill color
  9799. </member>
  9800. <member name="P:NPOI.HSSF.Record.CF.PatternFormatting.FillForegroundColor">
  9801. Get the foreground Fill color
  9802. @see org.apache.poi.hssf.usermodel.HSSFPalette#GetColor(short)
  9803. @return Fill color
  9804. </member>
  9805. <member name="T:NPOI.HSSF.Record.CF.Threshold">
  9806. Threshold / value (CFVO) for Changes in Conditional Formatting
  9807. </member>
  9808. <member name="M:NPOI.HSSF.Record.CF.Threshold.#ctor(NPOI.Util.ILittleEndianInput)">
  9809. Creates new Threshold
  9810. </member>
  9811. <member name="T:NPOI.HSSF.Record.Chart.AlRunsRecord">
  9812. <summary>
  9813. The AlRuns record specifies Rich Text Formatting within chart
  9814. titles (section 2.2.3.3), trendline (section 2.2.3.12), and
  9815. data labels (section 2.2.3.11).
  9816. </summary>
  9817. </member>
  9818. <member name="T:NPOI.HSSF.Record.Chart.AreaFormatRecord">
  9819. * The area format record is used to define the colours and patterns for an area.
  9820. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  9821. * Remove the record in src/records/definitions.
  9822. * @author Glen Stampoultzis (glens at apache.org)
  9823. </member>
  9824. <member name="M:NPOI.HSSF.Record.Chart.AreaFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9825. Constructs a AreaFormat record and s its fields appropriately.
  9826. @param in the RecordInputstream to Read the record from
  9827. </member>
  9828. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.DataSize">
  9829. Size of record (exluding 4 byte header)
  9830. </member>
  9831. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.ForegroundColor">
  9832. the foreground color field for the AreaFormat record.
  9833. </member>
  9834. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.BackgroundColor">
  9835. the background color field for the AreaFormat record.
  9836. </member>
  9837. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.Pattern">
  9838. the pattern field for the AreaFormat record.
  9839. </member>
  9840. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.FormatFlags">
  9841. the format flags field for the AreaFormat record.
  9842. </member>
  9843. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.ForecolorIndex">
  9844. the forecolor index field for the AreaFormat record.
  9845. </member>
  9846. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.BackcolorIndex">
  9847. the backcolor index field for the AreaFormat record.
  9848. </member>
  9849. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.IsAutomatic">
  9850. automatic formatting
  9851. @return the automatic field value.
  9852. </member>
  9853. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.IsInvert">
  9854. swap foreground and background colours when data is negative
  9855. @return the invert field value.
  9856. </member>
  9857. <member name="T:NPOI.HSSF.Record.Chart.AreaRecord">
  9858. * The area record is used to define a area chart.
  9859. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  9860. * Remove the record in src/records/definitions.
  9861. * @author Glen Stampoultzis (glens at apache.org)
  9862. </member>
  9863. <member name="M:NPOI.HSSF.Record.Chart.AreaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9864. Constructs a Area record and s its fields appropriately.
  9865. @param in the RecordInputstream to Read the record from
  9866. </member>
  9867. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.DataSize">
  9868. Size of record (exluding 4 byte header)
  9869. </member>
  9870. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.FormatFlags">
  9871. the format flags field for the Area record.
  9872. </member>
  9873. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.IsStacked">
  9874. series is stacked
  9875. @return the stacked field value.
  9876. </member>
  9877. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.IsDisplayAsPercentage">
  9878. results Displayed as percentages
  9879. @return the Display as percentage field value.
  9880. </member>
  9881. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.IsShadow">
  9882. Display a shadow for the chart
  9883. @return the shadow field value.
  9884. </member>
  9885. <member name="T:NPOI.HSSF.Record.Chart.AttachedLabelRecord">
  9886. * The series label record defines the type of label associated with the data format record.
  9887. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  9888. * Remove the record in src/records/definitions.
  9889. * @author Glen Stampoultzis (glens at apache.org)
  9890. </member>
  9891. <member name="M:NPOI.HSSF.Record.Chart.AttachedLabelRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9892. Constructs a SeriesLabels record and Sets its fields appropriately.
  9893. @param in the RecordInputstream to Read the record from
  9894. </member>
  9895. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.DataSize">
  9896. Size of record (exluding 4 byte header)
  9897. </member>
  9898. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.FormatFlags">
  9899. Get the format flags field for the SeriesLabels record.
  9900. </member>
  9901. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsShowActual">
  9902. show actual value of the data point
  9903. @return the show actual field value.
  9904. </member>
  9905. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsShowPercent">
  9906. show value as percentage of total (pie charts only)
  9907. @return the show percent field value.
  9908. </member>
  9909. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsLabelAsPercentage">
  9910. show category label/value as percentage (pie charts only)
  9911. @return the label as percentage field value.
  9912. </member>
  9913. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsSmoothedLine">
  9914. show smooth line
  9915. @return the smoothed line field value.
  9916. </member>
  9917. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsShowLabel">
  9918. Display category label
  9919. @return the show label field value.
  9920. </member>
  9921. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsShowBubbleSizes">
  9922. ??
  9923. @return the show bubble sizes field value.
  9924. </member>
  9925. <member name="T:NPOI.HSSF.Record.Chart.AxcExtRecord">
  9926. <summary>
  9927. The AxcExt record specifies additional extension properties of a date axis (section 2.2.3.6),
  9928. along with a CatSerRange record (section 2.4.39).
  9929. </summary>
  9930. </member>
  9931. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.MajorInterval">
  9932. <summary>
  9933. specifies the interval at which the major tick marks are displayed on the axis (section 2.2.3.6),
  9934. in the unit defined by duMajor.
  9935. </summary>
  9936. </member>
  9937. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.MajorUnit">
  9938. <summary>
  9939. specifies the unit of time to use for catMajor when the axis (section 2.2.3.6) is a date axis (section 2.2.3.6).
  9940. If fDateAxis is set to 0, MUST be ignored.
  9941. </summary>
  9942. </member>
  9943. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.MinorInterval">
  9944. <summary>
  9945. specifies the interval at which the minor tick marks are displayed on the axis (section 2.2.3.6),
  9946. in a unit defined by duMinor.
  9947. </summary>
  9948. </member>
  9949. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.BaseUnit">
  9950. <summary>
  9951. specifies the smallest unit of time used by the axis (section 2.2.3.6).
  9952. </summary>
  9953. </member>
  9954. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.CrossDate">
  9955. <summary>
  9956. specifies at which date, as a date in the date system specified by the Date1904 record (section 2.4.77),
  9957. in the units defined by duBase, the value axis (section 2.2.3.6) crosses this axis (section 2.2.3.6).
  9958. </summary>
  9959. </member>
  9960. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.IsAutoMin">
  9961. <summary>
  9962. specifies whether MinimumDate is calculated automatically.
  9963. </summary>
  9964. </member>
  9965. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.IsAutoMax">
  9966. <summary>
  9967. specifies whether MaximumDate is calculated automatically.
  9968. </summary>
  9969. </member>
  9970. <member name="T:NPOI.HSSF.Record.Chart.AxesUsedRecord">
  9971. * The number of axes used on a chart.
  9972. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  9973. * Remove the record in src/records/definitions.
  9974. * @author Glen Stampoultzis (glens at apache.org)
  9975. </member>
  9976. <member name="M:NPOI.HSSF.Record.Chart.AxesUsedRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9977. Constructs a AxisUsed record and Sets its fields appropriately.
  9978. @param in the RecordInputstream to Read the record from
  9979. </member>
  9980. <member name="P:NPOI.HSSF.Record.Chart.AxesUsedRecord.DataSize">
  9981. Size of record (exluding 4 byte header)
  9982. </member>
  9983. <member name="P:NPOI.HSSF.Record.Chart.AxesUsedRecord.NumAxis">
  9984. Get the num axis field for the AxisUsed record.
  9985. </member>
  9986. <member name="F:NPOI.HSSF.Record.Chart.AxisLineType.AxisLine">
  9987. <summary>
  9988. The axis (section 2.2.3.6) line itself.
  9989. </summary>
  9990. </member>
  9991. <member name="F:NPOI.HSSF.Record.Chart.AxisLineType.MajorGridLine">
  9992. <summary>
  9993. The major gridlines along the axis
  9994. </summary>
  9995. </member>
  9996. <member name="F:NPOI.HSSF.Record.Chart.AxisLineType.MinorGridLine">
  9997. <summary>
  9998. The minor gridlines along the axis
  9999. </summary>
  10000. </member>
  10001. <member name="F:NPOI.HSSF.Record.Chart.AxisLineType.WallsOrFloorOf3D">
  10002. <summary>
  10003. The walls or floor of a 3-D chart
  10004. </summary>
  10005. </member>
  10006. <member name="T:NPOI.HSSF.Record.Chart.AxisLineFormatRecord">
  10007. <summary>
  10008. The AxisLine record specifies which part of the axis (section 2.2.3.6) is
  10009. specified by the LineFormat record (section 2.4.156) that follows.
  10010. Excel Binary File Format (.xls) Structure Specification
  10011. </summary>
  10012. </member>
  10013. <member name="M:NPOI.HSSF.Record.Chart.AxisLineFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10014. Constructs a AxisLineFormat record and Sets its fields appropriately.
  10015. @param in the RecordInputstream to Read the record from
  10016. </member>
  10017. <member name="P:NPOI.HSSF.Record.Chart.AxisLineFormatRecord.DataSize">
  10018. Size of record (exluding 4 byte header)
  10019. </member>
  10020. <member name="P:NPOI.HSSF.Record.Chart.AxisLineFormatRecord.AxisType">
  10021. <summary>
  10022. </summary>
  10023. </member>
  10024. <member name="T:NPOI.HSSF.Record.Chart.AxisOptionsRecord">
  10025. The axis options record provides unit information and other various tidbits about the axis.<p/>
  10026. @author Andrew C. Oliver(acoliver at apache.org)
  10027. </member>
  10028. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.MinimumCategory">
  10029. Get the minimum category field for the AxisOptions record.
  10030. </member>
  10031. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.MaximumCategory">
  10032. Get the maximum category field for the AxisOptions record.
  10033. </member>
  10034. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.MajorUnitValue">
  10035. Get the major unit value field for the AxisOptions record.
  10036. </member>
  10037. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.MajorUnit">
  10038. Get the major unit field for the AxisOptions record.
  10039. </member>
  10040. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.MinorUnitValue">
  10041. Get the minor unit value field for the AxisOptions record.
  10042. </member>
  10043. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.MinorUnit">
  10044. Get the minor unit field for the AxisOptions record.
  10045. </member>
  10046. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.BaseUnit">
  10047. Get the base unit field for the AxisOptions record.
  10048. </member>
  10049. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.CrossingPoint">
  10050. Get the crossing point field for the AxisOptions record.
  10051. </member>
  10052. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.Options">
  10053. Get the options field for the AxisOptions record.
  10054. </member>
  10055. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.IsDefaultMinimum">
  10056. use the default minimum category
  10057. @return the default minimum field value.
  10058. </member>
  10059. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.IsDefaultMaximum">
  10060. use the default maximum category
  10061. @return the default maximum field value.
  10062. </member>
  10063. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.IsDefaultMajor">
  10064. use the default major unit
  10065. @return the default major field value.
  10066. </member>
  10067. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.IsDefaultMinorUnit">
  10068. use the default minor unit
  10069. @return the default minor unit field value.
  10070. </member>
  10071. <member name="M:NPOI.HSSF.Record.Chart.AxisOptionsRecord.SetIsDate(System.Boolean)">
  10072. Sets the isDate field value.
  10073. this is a date axis
  10074. </member>
  10075. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.IsIsDate">
  10076. this is a date axis
  10077. @return the isDate field value.
  10078. </member>
  10079. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.IsDefaultBase">
  10080. use the default base unit
  10081. @return the default base field value.
  10082. </member>
  10083. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.IsDefaultCross">
  10084. use the default crossing point
  10085. @return the default cross field value.
  10086. </member>
  10087. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.IsDefaultDateSettings">
  10088. use default date Setttings for this axis
  10089. @return the default date Settings field value.
  10090. </member>
  10091. <member name="T:NPOI.HSSF.Record.Chart.AxisParentRecord">
  10092. * The axis size and location
  10093. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10094. * Remove the record in src/records/definitions.
  10095. * @author Glen Stampoultzis (glens at apache.org)
  10096. </member>
  10097. <member name="M:NPOI.HSSF.Record.Chart.AxisParentRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10098. Constructs a AxisParent record and s its fields appropriately.
  10099. @param in the RecordInputstream to Read the record from
  10100. </member>
  10101. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.DataSize">
  10102. Size of record (exluding 4 byte header)
  10103. </member>
  10104. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.AxisType">
  10105. the axis type field for the AxisParent record.
  10106. @return One of
  10107. AXIS_TYPE_MAIN
  10108. AXIS_TYPE_SECONDARY
  10109. </member>
  10110. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.X">
  10111. the x field for the AxisParent record.
  10112. </member>
  10113. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.Y">
  10114. the y field for the AxisParent record.
  10115. </member>
  10116. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.Width">
  10117. the width field for the AxisParent record.
  10118. </member>
  10119. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.Height">
  10120. the height field for the AxisParent record.
  10121. </member>
  10122. <member name="T:NPOI.HSSF.Record.Chart.AxisRecord">
  10123. * The axis record defines the type of an axis.
  10124. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10125. * Remove the record in src/records/definitions.
  10126. * @author Glen Stampoultzis (glens at apache.org)
  10127. </member>
  10128. <member name="M:NPOI.HSSF.Record.Chart.AxisRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10129. Constructs a Axis record and Sets its fields appropriately.
  10130. @param in the RecordInputstream to Read the record from
  10131. </member>
  10132. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.DataSize">
  10133. Size of record (exluding 4 byte header)
  10134. </member>
  10135. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.AxisType">
  10136. Get the axis type field for the Axis record.
  10137. @return One of
  10138. AXIS_TYPE_CATEGORY_OR_X_AXIS
  10139. AXIS_TYPE_VALUE_AXIS
  10140. AXIS_TYPE_SERIES_AXIS
  10141. </member>
  10142. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.Reserved1">
  10143. Get the reserved1 field for the Axis record.
  10144. </member>
  10145. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.Reserved2">
  10146. Get the reserved2 field for the Axis record.
  10147. </member>
  10148. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.Reserved3">
  10149. Get the reserved3 field for the Axis record.
  10150. </member>
  10151. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.Reserved4">
  10152. Get the reserved4 field for the Axis record.
  10153. </member>
  10154. <member name="T:NPOI.HSSF.Record.Chart.AxisUsedRecord">
  10155. * The number of axes used on a chart.
  10156. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10157. * Remove the record in src/records/definitions.
  10158. * @author Glen Stampoultzis (glens at apache.org)
  10159. </member>
  10160. <member name="M:NPOI.HSSF.Record.Chart.AxisUsedRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10161. Constructs a AxisUsed record and Sets its fields appropriately.
  10162. @param in the RecordInputstream to Read the record from
  10163. </member>
  10164. <member name="P:NPOI.HSSF.Record.Chart.AxisUsedRecord.DataSize">
  10165. Size of record (exluding 4 byte header)
  10166. </member>
  10167. <member name="P:NPOI.HSSF.Record.Chart.AxisUsedRecord.NumAxis">
  10168. Get the num axis field for the AxisUsed record.
  10169. </member>
  10170. <member name="T:NPOI.HSSF.Record.Chart.BarRecord">
  10171. * The bar record is used to define a bar chart.
  10172. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10173. * Remove the record in src/records/definitions.
  10174. * @author Glen Stampoultzis (glens at apache.org)
  10175. </member>
  10176. <member name="M:NPOI.HSSF.Record.Chart.BarRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10177. Constructs a Bar record and s its fields appropriately.
  10178. @param in the RecordInputstream to Read the record from
  10179. </member>
  10180. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.DataSize">
  10181. Size of record (exluding 4 byte header)
  10182. </member>
  10183. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.BarSpace">
  10184. the bar space field for the Bar record.
  10185. </member>
  10186. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.CategorySpace">
  10187. the category space field for the Bar record.
  10188. </member>
  10189. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.FormatFlags">
  10190. the format flags field for the Bar record.
  10191. </member>
  10192. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.IsHorizontal">
  10193. true to Display horizontal bar charts, false for vertical
  10194. @return the horizontal field value.
  10195. </member>
  10196. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.IsStacked">
  10197. stack Displayed values
  10198. @return the stacked field value.
  10199. </member>
  10200. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.IsDisplayAsPercentage">
  10201. Display chart values as a percentage
  10202. @return the Display as percentage field value.
  10203. </member>
  10204. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.IsShadow">
  10205. Display a shadow for the chart
  10206. @return the shadow field value.
  10207. </member>
  10208. <member name="T:NPOI.HSSF.Record.Chart.BeginRecord">
  10209. The begin record defines the start of a block of records for a (grpahing
  10210. data object. This record is matched with a corresponding EndRecord.
  10211. @see EndRecord
  10212. @author Glen Stampoultzis (glens at apache.org)
  10213. </member>
  10214. <member name="M:NPOI.HSSF.Record.Chart.BeginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10215. Constructs a BeginRecord record and Sets its fields appropriately.
  10216. @param in the RecordInputstream to Read the record from
  10217. </member>
  10218. <member name="T:NPOI.HSSF.Record.Chart.BopPopCustomRecord">
  10219. <summary>
  10220. The BopPopCustom record specifies which data points in the series are contained
  10221. in the secondary bar/pie instead of the primary pie. MUST follow a BopPop record
  10222. that has its split field set to Custom (0x0003).
  10223. </summary>
  10224. <remarks>
  10225. author: Antony liu (antony.apollo at gmail.com)
  10226. </remarks>
  10227. </member>
  10228. <member name="T:NPOI.HSSF.Record.Chart.BopPopRecord">
  10229. <summary>
  10230. The BopPop record specifies that the chart group is a bar of pie chart group or
  10231. a pie of pie chart group and specifies the chart group attributes.
  10232. </summary>
  10233. <remarks>
  10234. author: Antony liu (antony.apollo at gmail.com)
  10235. </remarks>
  10236. </member>
  10237. <member name="T:NPOI.HSSF.Record.Chart.BRAIRecord">
  10238. <summary>
  10239. The BRAI record specifies a reference to data in a sheet (1) that is used by a part of a series,
  10240. legend entry, trendline or error bars.
  10241. </summary>
  10242. </member>
  10243. <member name="F:NPOI.HSSF.Record.Chart.BRAIRecord.field_5_formulaOfLink">
  10244. <summary>
  10245. A ChartParsedFormula structure that specifies the formula (section 2.2.2) that specifies the reference.
  10246. </summary>
  10247. </member>
  10248. <member name="M:NPOI.HSSF.Record.Chart.BRAIRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10249. Constructs a LinkedData record and Sets its fields appropriately.
  10250. @param in the RecordInputstream to Read the record from
  10251. </member>
  10252. <member name="P:NPOI.HSSF.Record.Chart.BRAIRecord.DataSize">
  10253. Size of record (exluding 4 byte header)
  10254. </member>
  10255. <member name="P:NPOI.HSSF.Record.Chart.BRAIRecord.LinkType">
  10256. <summary>
  10257. specifies the part of the series, trendline, or error bars the referenced data specifies.
  10258. </summary>
  10259. </member>
  10260. <member name="P:NPOI.HSSF.Record.Chart.BRAIRecord.IndexNumberFmtRecord">
  10261. <summary>
  10262. specifies the number format to use for the data.
  10263. </summary>
  10264. </member>
  10265. <member name="T:NPOI.HSSF.Record.Chart.CategorySeriesAxisRecord">
  10266. This record refers to a category or series axis and is used to specify label/tickmark frequency.<p/>
  10267. @author Glen Stampoultzis (glens at apache.org)
  10268. </member>
  10269. <member name="P:NPOI.HSSF.Record.Chart.CategorySeriesAxisRecord.CrossingPoint">
  10270. Get the crossing point field for the CategorySeriesAxis record.
  10271. </member>
  10272. <member name="P:NPOI.HSSF.Record.Chart.CategorySeriesAxisRecord.LabelFrequency">
  10273. Get the label frequency field for the CategorySeriesAxis record.
  10274. </member>
  10275. <member name="P:NPOI.HSSF.Record.Chart.CategorySeriesAxisRecord.TickMarkFrequency">
  10276. Get the tick mark frequency field for the CategorySeriesAxis record.
  10277. </member>
  10278. <member name="P:NPOI.HSSF.Record.Chart.CategorySeriesAxisRecord.Options">
  10279. Get the options field for the CategorySeriesAxis record.
  10280. </member>
  10281. <member name="P:NPOI.HSSF.Record.Chart.CategorySeriesAxisRecord.IsValueAxisCrossing">
  10282. Set true to indicate axis crosses between categories and false to cross axis midway
  10283. @return the value axis crossing field value.
  10284. </member>
  10285. <member name="P:NPOI.HSSF.Record.Chart.CategorySeriesAxisRecord.IsCrossesFarRight">
  10286. axis crosses at the far right
  10287. @return the crosses far right field value.
  10288. </member>
  10289. <member name="P:NPOI.HSSF.Record.Chart.CategorySeriesAxisRecord.IsReversed">
  10290. categories are displayed in reverse order
  10291. @return the reversed field value.
  10292. </member>
  10293. <member name="T:NPOI.HSSF.Record.Chart.CatLabRecord">
  10294. CATLAB - Category Labels (0x0856)<br/>
  10295. @author Patrick Cheng
  10296. </member>
  10297. <member name="T:NPOI.HSSF.Record.Chart.CatSerRangeRecord">
  10298. <summary>
  10299. specifies the properties of a category (3) axis, a date axis, or a series axis.
  10300. </summary>
  10301. </member>
  10302. <member name="M:NPOI.HSSF.Record.Chart.CatSerRangeRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10303. Constructs a CategorySeriesAxis record and Sets its fields appropriately.
  10304. @param in the RecordInputstream to Read the record from
  10305. </member>
  10306. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.DataSize">
  10307. Size of record (exluding 4 byte header)
  10308. </member>
  10309. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.CrossPoint">
  10310. <summary>
  10311. specifies where the value axis crosses this axis, based on the following table.
  10312. If fMaxCross is set to 1, the value this field MUST be ignored.
  10313. Category (3) axis This field specifies the category (3) at which the value axis crosses.
  10314. For example, if this field is 2, the value axis crosses this axis at the second category (3)
  10315. on this axis. MUST be greater than or equal to 1 and less than or equal to 31999.
  10316. Series axis MUST be 0.
  10317. Date axis catCross MUST be equal to the value given by the following formula:
  10318. catCross = catCrossDate – catMin + 1
  10319. Where catCrossDate is the catCrossDate field of the AxcExt record
  10320. and catMin is the catMin field of the AxcExt record.
  10321. </summary>
  10322. </member>
  10323. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.LabelInterval">
  10324. <summary>
  10325. specifies the interval between axis labels on this axis. MUST be greater than or equal to 1 and
  10326. less than or equal to 31999. MUST be ignored for a date axis.
  10327. </summary>
  10328. </member>
  10329. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.MarkInterval">
  10330. <summary>
  10331. specifies the interval at which major tick marks and minor tick marks are displayed on the axis.
  10332. Major tick marks and minor tick marks that would have been visible are hidden unless they are
  10333. located at a multiple of this field.
  10334. </summary>
  10335. </member>
  10336. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.IsBetween">
  10337. <summary>
  10338. specifies whether the value axis crosses this axis between major tick marks. MUST be a value from to following table:
  10339. 0 The value axis crosses this axis on a major tick mark.
  10340. 1 The value axis crosses this axis between major tick marks.
  10341. </summary>
  10342. </member>
  10343. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.IsMaxCross">
  10344. <summary>
  10345. specifies whether the value axis crosses this axis at the last category (3), the last series,
  10346. or the maximum date. MUST be a value from the following table:
  10347. 0 The value axis crosses this axis at the value specified by catCross.
  10348. 1 The value axis crosses this axis at the last category (3), the last series, or the maximum date.
  10349. </summary>
  10350. </member>
  10351. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.IsReverse">
  10352. <summary>
  10353. specifies whether the axis is displayed in reverse order. MUST be a value from the following table:
  10354. 0 The axis is displayed in order.
  10355. 1 The axis is display in reverse order.
  10356. </summary>
  10357. </member>
  10358. <member name="P:NPOI.HSSF.Record.Chart.Chart3DBarShapeRecord.Riser">
  10359. <summary>
  10360. the shape of the base of the data points in a bar or column chart group.
  10361. MUST be a value from the following table
  10362. 0x00 The base of the data point is a rectangle.
  10363. 0x01 The base of the data point is an ellipse.
  10364. </summary>
  10365. </member>
  10366. <member name="P:NPOI.HSSF.Record.Chart.Chart3DBarShapeRecord.Taper">
  10367. <summary>
  10368. how the data points in a bar or column chart group taper from base to tip.
  10369. MUST be a value from the following
  10370. 0x00 The data points of the bar or column chart group do not taper.
  10371. The shape at the maximum value of the data point is the same as the shape at the base.:
  10372. 0x01 The data points of the bar or column chart group taper to a point at the maximum value of each data point.
  10373. 0x02 The data points of the bar or column chart group taper towards a projected point at the position of
  10374. the maximum value of all of the data points in the chart group, but are clipped at the value of each data point.
  10375. </summary>
  10376. </member>
  10377. <member name="T:NPOI.HSSF.Record.Chart.Chart3dRecord">
  10378. <summary>
  10379. The Chart3d record specifies that the plot area of the chart group is rendered in a 3-D scene
  10380. and also specifies the attributes of the 3-D plot area. The preceding chart group type MUST be
  10381. of type bar, pie, line, area, or surface.
  10382. </summary>
  10383. <remarks>
  10384. author: Antony liu (antony.apollo at gmail.com)
  10385. </remarks>
  10386. </member>
  10387. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Rotation">
  10388. <summary>
  10389. A signed integer that specifies the clockwise rotation, in degrees, of the 3-D plot area
  10390. around a vertical line through the center of the 3-D plot area. MUST be greater than or
  10391. equal to 0 and MUST be less than or equal to 360.
  10392. </summary>
  10393. </member>
  10394. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Elev">
  10395. <summary>
  10396. A signed integer that specifies the rotation, in degrees, of the 3-D plot area around
  10397. a horizontal line through the center of the 3-D plot area.MUST be greater than or equal
  10398. to -90 and MUST be less than or equal to 90.
  10399. </summary>
  10400. </member>
  10401. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Dist">
  10402. <summary>
  10403. A signed integer that specifies the field of view angle for the 3-D plot area.
  10404. MUST be greater than or equal to zero and less than 200.
  10405. </summary>
  10406. </member>
  10407. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Height">
  10408. <summary>
  10409. If fNotPieChart is 0, then this is an unsigned integer that specifies the thickness of the pie for a pie chart group.
  10410. If fNotPieChart is 1, then this is a signed integer that specifies the height of the 3-D plot area as a percentage of its width.
  10411. </summary>
  10412. </member>
  10413. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Depth">
  10414. <summary>
  10415. A signed integer that specifies the depth of the 3-D plot area as a percentage of its width.
  10416. MUST be greater than or equal to 1 and less than or equal to 2000.
  10417. </summary>
  10418. </member>
  10419. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Gap">
  10420. <summary>
  10421. An unsigned integer that specifies the width of the gap between the series and the front and
  10422. back edges of the 3-D plot area as a percentage of the data point depth divided by 2.
  10423. If fCluster is not 1 and chart group type is not a bar then pcGap also specifies distance
  10424. between adjacent series as a percentage of the data point depth. MUST be less than or equal to 500.
  10425. </summary>
  10426. </member>
  10427. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.IsPerspective">
  10428. <summary>
  10429. A bit that specifies whether the 3-D plot area is rendered with a vanishing point.
  10430. If fNotPieChart is 0 the value MUST be 0. If fNotPieChart is 1 then the value
  10431. MUST be a value from the following
  10432. true Perspective vanishing point applied based on value of pcDist.
  10433. false No vanishing point applied.
  10434. </summary>
  10435. </member>
  10436. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.IsCluster">
  10437. <summary>
  10438. specifies whether data points are clustered together in a bar chart group.
  10439. If chart group type is not bar or pie, value MUST be ignored. If chart group type is pie,
  10440. value MUST be 0. If chart group type is bar, then the value MUST be a value from the following
  10441. true Data points are clustered.
  10442. false Data points are not clustered.
  10443. </summary>
  10444. </member>
  10445. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Is3DScaling">
  10446. <summary>
  10447. A bit that specifies whether the height of the 3-D plot area is automatically determined.
  10448. If fNotPieChart is 0 then this MUST be 0. If fNotPieChart is 1 then the value MUST be a value from the following table:
  10449. false The value of pcHeight is used to determine the height of the 3-D plot area
  10450. true The height of the 3-D plot area is automatically determined
  10451. </summary>
  10452. </member>
  10453. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.IsNotPieChart">
  10454. <summary>
  10455. A bit that specifies whether the chart group type is pie. MUST be a value from the following :
  10456. false Chart group type MUST be pie.
  10457. true Chart group type MUST not be pie.
  10458. </summary>
  10459. </member>
  10460. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.IsWalls2D">
  10461. <summary>
  10462. Whether the walls are rendered in 2-D. If fPerspective is 1 then this MUST be ignored.
  10463. If the chart group type is not bar, area or pie this MUST be ignored.
  10464. If the chart group is of type bar and fCluster is 0, then this MUST be ignored.
  10465. If the chart group type is pie this MUST be 0 and MUST be ignored.
  10466. If the chart group type is bar or area, then the value MUST be a value from the following
  10467. false Chart walls and floor are rendered in 3D.
  10468. true Chart walls are rendered in 2D and the chart floor is not rendered.
  10469. </summary>
  10470. </member>
  10471. <member name="T:NPOI.HSSF.Record.Chart.ChartEndBlockRecord">
  10472. ENDBLOCK - Chart Future Record Type End Block (0x0853)<br/>
  10473. @author Patrick Cheng
  10474. </member>
  10475. <member name="T:NPOI.HSSF.Record.Chart.ChartEndObjectRecord">
  10476. ENDOBJECT - Chart Future Record Type End Object (0x0855)<br/>
  10477. @author Patrick Cheng
  10478. </member>
  10479. <member name="T:NPOI.HSSF.Record.Chart.ChartFRTInfoRecord">
  10480. <summary>
  10481. The ChartFrtInfo record specifies the versions of the application that originally created and last saved the file.
  10482. </summary>
  10483. </member>
  10484. <member name="T:NPOI.HSSF.Record.Chart.ChartRecord">
  10485. * The chart record is used to define the location and size of a chart.
  10486. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10487. * Remove the record in src/records/definitions.
  10488. * @author Glen Stampoultzis (glens at apache.org)
  10489. </member>
  10490. <member name="M:NPOI.HSSF.Record.Chart.ChartRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10491. Constructs a Chart record and Sets its fields appropriately.
  10492. @param in the RecordInputstream to Read the record from
  10493. </member>
  10494. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.DataSize">
  10495. Size of record (exluding 4 byte header)
  10496. </member>
  10497. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.X">
  10498. Get the x field for the Chart record.
  10499. </member>
  10500. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.Y">
  10501. Get the y field for the Chart record.
  10502. </member>
  10503. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.Width">
  10504. Get the width field for the Chart record.
  10505. </member>
  10506. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.Height">
  10507. Get the height field for the Chart record.
  10508. </member>
  10509. <member name="T:NPOI.HSSF.Record.Chart.ChartStartBlockRecord">
  10510. STARTBLOCK - Chart Future Record Type Start Block (0x0852)<br/>
  10511. @author Patrick Cheng
  10512. </member>
  10513. <member name="T:NPOI.HSSF.Record.Chart.ChartStartObjectRecord">
  10514. STARTOBJECT - Chart Future Record Type Start Object (0x0854)<br/>
  10515. @author Patrick Cheng
  10516. </member>
  10517. <member name="T:NPOI.HSSF.Record.Chart.ChartTitleFormatRecord">
  10518. Describes the formatting runs associated with a chart title.
  10519. </member>
  10520. <member name="T:NPOI.HSSF.Record.Chart.CrtLayout12ARecord">
  10521. <summary>
  10522. The CrtLayout12A record specifies layout information for a plot area.
  10523. </summary>
  10524. <remarks>
  10525. author: Antony liu (antony.apollo at gmail.com)
  10526. </remarks>
  10527. </member>
  10528. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.IsLayoutTargetInner">
  10529. <summary>
  10530. specifies the type of plot area for the layout target.
  10531. false Outer plot area - The bounding rectangle that includes the axis labels, axis titles, data table (2) and plot area of the chart.
  10532. true Inner plot area – The rectangle bounded by the chart axes.
  10533. </summary>
  10534. </member>
  10535. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.CheckSum">
  10536. <summary>
  10537. specifies the checksum
  10538. </summary>
  10539. </member>
  10540. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.XTL">
  10541. <summary>
  10542. specifies the horizontal offset of the plot area’s upper-left corner, relative to the upper-left corner of the chart area
  10543. </summary>
  10544. </member>
  10545. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.YTL">
  10546. <summary>
  10547. specifies the vertical offset of the plot area’s upper-left corner, relative to the upper-left corner of the chart area
  10548. </summary>
  10549. </member>
  10550. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.XBR">
  10551. <summary>
  10552. specifies the width of the plot area
  10553. </summary>
  10554. </member>
  10555. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.YBR">
  10556. <summary>
  10557. specifies the height of the plot area
  10558. </summary>
  10559. </member>
  10560. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.XMode">
  10561. <summary>
  10562. A CrtLayout12Mode structure that specifies the meaning of x.
  10563. </summary>
  10564. </member>
  10565. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.YMode">
  10566. <summary>
  10567. A CrtLayout12Mode structure that specifies the meaning of y.
  10568. </summary>
  10569. </member>
  10570. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.WidthMode">
  10571. <summary>
  10572. A CrtLayout12Mode structure that specifies the meaning of dx.
  10573. </summary>
  10574. </member>
  10575. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.HeightMode">
  10576. <summary>
  10577. A CrtLayout12Mode structure that specifies the meaning of dy.
  10578. </summary>
  10579. </member>
  10580. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.X">
  10581. <summary>
  10582. An Xnum (section 2.5.342) value that specifies a horizontal offset. The meaning is determined by wXMode.
  10583. </summary>
  10584. </member>
  10585. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.Y">
  10586. <summary>
  10587. An Xnum value that specifies a vertical offset. The meaning is determined by wYMode.
  10588. </summary>
  10589. </member>
  10590. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.DX">
  10591. <summary>
  10592. An Xnum value that specifies a width or an horizontal offset. The meaning is determined by wWidthMode.
  10593. </summary>
  10594. </member>
  10595. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.DY">
  10596. <summary>
  10597. An Xnum value that specifies a height or an vertical offset. The meaning is determined by wHeightMode.
  10598. </summary>
  10599. </member>
  10600. <member name="T:NPOI.HSSF.Record.Chart.CrtLayout12Mode">
  10601. <summary>
  10602. The CrtLayout12Mode specifies a layout mode. Each layout mode specifies a different
  10603. meaning of the x, y, dx, and dy fields of CrtLayout12 and CrtLayout12A.
  10604. </summary>
  10605. </member>
  10606. <member name="F:NPOI.HSSF.Record.Chart.CrtLayout12Mode.L12MAUTO">
  10607. <summary>
  10608. Position and dimension (2) are determined by the application. x, y, dx and dy MUST be ignored.
  10609. </summary>
  10610. </member>
  10611. <member name="F:NPOI.HSSF.Record.Chart.CrtLayout12Mode.L12MFACTOR">
  10612. <summary>
  10613. x and y specify the offset of the top left corner, relative to its default position,
  10614. as a fraction of the chart area. MUST be greater than or equal to -1.0 and MUST be
  10615. less than or equal to 1.0. dx and dy specify the width and height, as a fraction of
  10616. the chart area, MUST be greater than or equal to 0.0, and MUST be less than or equal to 1.0.
  10617. </summary>
  10618. </member>
  10619. <member name="F:NPOI.HSSF.Record.Chart.CrtLayout12Mode.L12MEDGE">
  10620. <summary>
  10621. x and y specify the offset of the upper-left corner; dx and dy specify the offset of the bottom-right corner.
  10622. x, y, dx and dy are specified relative to the upper-left corner of the chart area as a fraction of the chart area.
  10623. x, y, dx and dy MUST be greater than or equal to 0.0, and MUST be less than or equal to 1.0.
  10624. </summary>
  10625. </member>
  10626. <member name="T:NPOI.HSSF.Record.Chart.CrtLayout12Record">
  10627. <summary>
  10628. The CrtLayout12 record specifies the layout information for attached label, when contained
  10629. in the sequence of records that conforms to the ATTACHEDLABEL rule,
  10630. or legend, when contained in the sequence of records that conforms to the LD rule.
  10631. </summary>
  10632. </member>
  10633. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.AutoLayoutType">
  10634. <summary>
  10635. automatic layout type of the legend.
  10636. MUST be ignored when this record is in the sequence of records that conforms to the ATTACHEDLABEL rule.
  10637. MUST be a value from the following table:
  10638. 0x0 Align to the bottom
  10639. 0x1 Align to top right corner
  10640. 0x2 Align to the top
  10641. 0x3 Align to the right
  10642. 0x4 Align to the left
  10643. </summary>
  10644. </member>
  10645. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.CheckSum">
  10646. <summary>
  10647. specifies the checksum of the values in the order as follows,
  10648. </summary>
  10649. </member>
  10650. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.XMode">
  10651. <summary>
  10652. A CrtLayout12Mode structure that specifies the meaning of x.
  10653. </summary>
  10654. </member>
  10655. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.YMode">
  10656. <summary>
  10657. A CrtLayout12Mode structure that specifies the meaning of y.
  10658. </summary>
  10659. </member>
  10660. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.WidthMode">
  10661. <summary>
  10662. A CrtLayout12Mode structure that specifies the meaning of dx.
  10663. </summary>
  10664. </member>
  10665. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.HeightMode">
  10666. <summary>
  10667. A CrtLayout12Mode structure that specifies the meaning of dy.
  10668. </summary>
  10669. </member>
  10670. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.X">
  10671. <summary>
  10672. An Xnum (section 2.5.342) value that specifies a horizontal offset. The meaning is determined by wXMode.
  10673. </summary>
  10674. </member>
  10675. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.Y">
  10676. <summary>
  10677. An Xnum value that specifies a vertical offset. The meaning is determined by wYMode.
  10678. </summary>
  10679. </member>
  10680. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.DX">
  10681. <summary>
  10682. An Xnum value that specifies a width or an horizontal offset. The meaning is determined by wWidthMode.
  10683. </summary>
  10684. </member>
  10685. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.DY">
  10686. <summary>
  10687. An Xnum value that specifies a height or an vertical offset. The meaning is determined by wHeightMode.
  10688. </summary>
  10689. </member>
  10690. <member name="T:NPOI.HSSF.Record.Chart.CrtLineRecord">
  10691. <summary>
  10692. The CrtLine record specifies the presence of drop lines, high-low lines, series lines
  10693. or leader lines on the chart group. This record is followed by a LineFormat record
  10694. which specifies the format of the lines.
  10695. </summary>
  10696. <remarks>
  10697. author: Antony liu (antony.apollo at gmail.com)
  10698. </remarks>
  10699. </member>
  10700. <member name="T:NPOI.HSSF.Record.Chart.CrtLinkRecord">
  10701. <summary>
  10702. The CrtLink record is written but unused.
  10703. </summary>
  10704. </member>
  10705. <member name="T:NPOI.HSSF.Record.Chart.CrtMlFrtContinueRecord">
  10706. <summary>
  10707. The CrtMlFrtContinue record specifies additional data for a CrtMlFrt record, as specified in the CrtMlFrt record.
  10708. </summary>
  10709. <remarks>
  10710. author: Antony liu (antony.apollo at gmail.com)
  10711. </remarks>
  10712. </member>
  10713. <member name="T:NPOI.HSSF.Record.Chart.CrtMlFrtRecord">
  10714. <summary>
  10715. The CrtMlFrt record specifies additional properties for chart elements, as specified by
  10716. the Chart Sheet Substream ABNF. These properties complement the record to which they
  10717. correspond, and are stored as a structure chain defined in XmlTkChain. An application
  10718. can ignore this record without loss of functionality, except for the additional properties.
  10719. If this record is longer than 8224 bytes, it MUST be split into several records. The first
  10720. section of the data appears in this record and subsequent sections appear in one or more
  10721. CrtMlFrtContinue records that follow this record.
  10722. </summary>
  10723. <remarks>
  10724. author: Antony liu (antony.apollo at gmail.com)
  10725. </remarks>
  10726. </member>
  10727. <member name="T:NPOI.HSSF.Record.Chart.DataFormatRecord">
  10728. * The data format record is used to index into a series.
  10729. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10730. * Remove the record in src/records/definitions.
  10731. * @author Glen Stampoultzis (glens at apache.org)
  10732. </member>
  10733. <member name="M:NPOI.HSSF.Record.Chart.DataFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10734. Constructs a DataFormat record and Sets its fields appropriately.
  10735. @param in the RecordInputstream to Read the record from
  10736. </member>
  10737. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.DataSize">
  10738. Size of record (exluding 4 byte header)
  10739. </member>
  10740. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.PointNumber">
  10741. Get the point number field for the DataFormat record.
  10742. </member>
  10743. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.SeriesIndex">
  10744. Get the series index field for the DataFormat record.
  10745. </member>
  10746. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.SeriesNumber">
  10747. Get the series number field for the DataFormat record.
  10748. </member>
  10749. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.FormatFlags">
  10750. Get the format flags field for the DataFormat record.
  10751. </member>
  10752. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.UseExcel4Colors">
  10753. Set true to use excel 4 colors.
  10754. @return the use excel 4 colors field value.
  10755. </member>
  10756. <member name="T:NPOI.HSSF.Record.Chart.DataLabelExtensionRecord">
  10757. DATALABEXT - Chart Data Label Extension (0x086A) <br/>
  10758. @author Patrick Cheng
  10759. </member>
  10760. <member name="T:NPOI.HSSF.Record.Chart.DataLabExtContentsRecord">
  10761. <summary>
  10762. The DataLabExtContents record specifies the contents of an extended data label.
  10763. </summary>
  10764. </member>
  10765. <member name="T:NPOI.HSSF.Record.Chart.DataLabExtRecord">
  10766. DATALABEXT - Chart Data Label Extension (0x086A) <br/>
  10767. @author Patrick Cheng
  10768. </member>
  10769. <member name="T:NPOI.HSSF.Record.Chart.DatRecord">
  10770. * The dat record is used to store options for the chart.
  10771. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10772. * Remove the record in src/records/definitions.
  10773. * @author Glen Stampoultzis (glens at apache.org)
  10774. </member>
  10775. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10776. Constructs a Dat record and Sets its fields appropriately.
  10777. @param in the RecordInputstream to Read the record from
  10778. </member>
  10779. <member name="P:NPOI.HSSF.Record.Chart.DatRecord.DataSize">
  10780. Size of record (exluding 4 byte header)
  10781. </member>
  10782. <member name="P:NPOI.HSSF.Record.Chart.DatRecord.Options">
  10783. Get the options field for the Dat record.
  10784. </member>
  10785. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.SetHorizontalBorder(System.Boolean)">
  10786. Sets the horizontal border field value.
  10787. has a horizontal border
  10788. </member>
  10789. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.IsHorizontalBorder">
  10790. has a horizontal border
  10791. @return the horizontal border field value.
  10792. </member>
  10793. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.SetVerticalBorder(System.Boolean)">
  10794. Sets the vertical border field value.
  10795. has vertical border
  10796. </member>
  10797. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.IsVerticalBorder">
  10798. has vertical border
  10799. @return the vertical border field value.
  10800. </member>
  10801. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.SetBorder(System.Boolean)">
  10802. Sets the border field value.
  10803. data table has a border
  10804. </member>
  10805. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.IsBorder">
  10806. data table has a border
  10807. @return the border field value.
  10808. </member>
  10809. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.SetShowSeriesKey(System.Boolean)">
  10810. Sets the show series key field value.
  10811. shows the series key
  10812. </member>
  10813. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.IsShowSeriesKey">
  10814. shows the series key
  10815. @return the show series key field value.
  10816. </member>
  10817. <member name="T:NPOI.HSSF.Record.Chart.DefaultDataLabelTextPropertiesRecord">
  10818. The default data label text properties record identifies the text characteristics of the preceding text record.<p/>
  10819. @author Glen Stampoultzis (glens at apache.org)
  10820. </member>
  10821. <member name="P:NPOI.HSSF.Record.Chart.DefaultDataLabelTextPropertiesRecord.CategoryDataType">
  10822. Get the category data type field for the DefaultDataLabelTextProperties record.
  10823. @return One of
  10824. CATEGORY_DATA_TYPE_SHOW_LABELS_CHARACTERISTIC
  10825. CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CHARACTERISTIC
  10826. CATEGORY_DATA_TYPE_ALL_TEXT_CHARACTERISTIC
  10827. </member>
  10828. <member name="T:NPOI.HSSF.Record.Chart.TextFormatInfo">
  10829. <summary>
  10830. specifies the text elements that are formatted using the position and appearance information
  10831. specified by the Text record immediately following this record.
  10832. </summary>
  10833. </member>
  10834. <member name="F:NPOI.HSSF.Record.Chart.TextFormatInfo.ShowPercentOrValueNotSet">
  10835. <summary>
  10836. Format all Text records in the chart group where fShowPercent is equal to 0 or fShowValue is equal to 0.
  10837. </summary>
  10838. </member>
  10839. <member name="F:NPOI.HSSF.Record.Chart.TextFormatInfo.ShowPercentOrValueSet">
  10840. <summary>
  10841. Format all Text records in the chart group where fShowPercent is equal to 1 or fShowValue is equal to 1.
  10842. </summary>
  10843. </member>
  10844. <member name="F:NPOI.HSSF.Record.Chart.TextFormatInfo.FontScaleNotSet">
  10845. <summary>
  10846. Format all Text records in the chart where the value of fScaled of the associated FontInfo structure is equal to 0.
  10847. </summary>
  10848. </member>
  10849. <member name="F:NPOI.HSSF.Record.Chart.TextFormatInfo.FontScaleSet">
  10850. <summary>
  10851. Format all Text records in the chart where the value of fScaled of the associated FontInfo structure is equal to 1.
  10852. </summary>
  10853. </member>
  10854. <member name="T:NPOI.HSSF.Record.Chart.DefaultTextRecord">
  10855. <summary>
  10856. specifies the text elements that are formatted using the information specified by
  10857. the Text record immediately following this record.
  10858. </summary>
  10859. </member>
  10860. <member name="M:NPOI.HSSF.Record.Chart.DefaultTextRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10861. Constructs a DefaultDataLabelTextProperties record and Sets its fields appropriately.
  10862. @param in the RecordInputstream to Read the record from
  10863. </member>
  10864. <member name="P:NPOI.HSSF.Record.Chart.DefaultTextRecord.DataSize">
  10865. Size of record (exluding 4 byte header)
  10866. </member>
  10867. <member name="P:NPOI.HSSF.Record.Chart.DefaultTextRecord.FormatType">
  10868. <summary>
  10869. specifies the text elements that are formatted using the position and appearance
  10870. information specified by the Text record immediately following this record.
  10871. </summary>
  10872. </member>
  10873. <member name="T:NPOI.HSSF.Record.Chart.DropBarRecord">
  10874. <summary>
  10875. The DropBar record specifies the attributes of the up bars or the down bars between multiple
  10876. series of a line chart group and specifies the beginning of a collection of records as
  10877. defined by the Chart Sheet Substream ABNF. The first of these collections in the line chart
  10878. group specifies the attributes of the up bars. The second specifies the attributes of the
  10879. down bars. If this record exists, then the chart group type MUST be line and the field cSer
  10880. in the record SeriesList MUST be greater than 1.
  10881. </summary>
  10882. <remarks>
  10883. author: Antony liu (antony.apollo at gmail.com)
  10884. </remarks>
  10885. </member>
  10886. <member name="T:NPOI.HSSF.Record.Chart.EndBlockRecord">
  10887. ENDBLOCK - Chart Future Record Type End Block (0x0853)<br/>
  10888. @author Patrick Cheng
  10889. </member>
  10890. <member name="T:NPOI.HSSF.Record.Chart.EndRecord">
  10891. The end record defines the end of a block of records for a (Graphing)
  10892. data object. This record is matched with a corresponding BeginRecord.
  10893. @see BeginRecord
  10894. @author Glen Stampoultzis (glens at apache.org)
  10895. </member>
  10896. <member name="M:NPOI.HSSF.Record.Chart.EndRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10897. Constructs a EndRecord record and Sets its fields appropriately.
  10898. @param in the RecordInputstream to Read the record from
  10899. </member>
  10900. <member name="T:NPOI.HSSF.Record.Chart.Fbi2Record">
  10901. <summary>
  10902. The Fbi2 record specifies the font information at the time the scalable font is added to the chart.
  10903. </summary>
  10904. <remarks>
  10905. author: Antony liu (antony.apollo at gmail.com)
  10906. </remarks>
  10907. </member>
  10908. <member name="T:NPOI.HSSF.Record.Chart.FbiRecord">
  10909. <summary>
  10910. The Fbi record specifies the font information at the time the scalable font is added to the chart.
  10911. </summary>
  10912. </member>
  10913. <member name="M:NPOI.HSSF.Record.Chart.FbiRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10914. Constructs a FontBasis record and Sets its fields appropriately.
  10915. @param in the RecordInputstream to Read the record from
  10916. </member>
  10917. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.DataSize">
  10918. Size of record (exluding 4 byte header)
  10919. </member>
  10920. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.XBasis">
  10921. Get the x Basis field for the FontBasis record.
  10922. </member>
  10923. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.YBasis">
  10924. Get the y Basis field for the FontBasis record.
  10925. </member>
  10926. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.HeightBasis">
  10927. Get the height basis field for the FontBasis record.
  10928. </member>
  10929. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.Scale">
  10930. Get the scale field for the FontBasis record.
  10931. </member>
  10932. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.IndexToFontTable">
  10933. Get the index to font table field for the FontBasis record.
  10934. </member>
  10935. <member name="T:NPOI.HSSF.Record.Chart.FontBasisRecord">
  10936. * The font basis record stores various font metrics.
  10937. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10938. * Remove the record in src/records/definitions.
  10939. * @author Glen Stampoultzis (glens at apache.org)
  10940. </member>
  10941. <member name="M:NPOI.HSSF.Record.Chart.FontBasisRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10942. Constructs a FontBasis record and Sets its fields appropriately.
  10943. @param in the RecordInputstream to Read the record from
  10944. </member>
  10945. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.DataSize">
  10946. Size of record (exluding 4 byte header)
  10947. </member>
  10948. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.XBasis">
  10949. Get the x Basis field for the FontBasis record.
  10950. </member>
  10951. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.YBasis">
  10952. Get the y Basis field for the FontBasis record.
  10953. </member>
  10954. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.HeightBasis">
  10955. Get the height basis field for the FontBasis record.
  10956. </member>
  10957. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.Scale">
  10958. Get the scale field for the FontBasis record.
  10959. </member>
  10960. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.IndexToFontTable">
  10961. Get the index to font table field for the FontBasis record.
  10962. </member>
  10963. <member name="T:NPOI.HSSF.Record.Chart.FontIndexRecord">
  10964. <summary>
  10965. The FontX record specifies the font for a given text element.
  10966. The Font record referenced by iFont can exist in this chart sheet substream or the workbook.
  10967. </summary>
  10968. </member>
  10969. <member name="M:NPOI.HSSF.Record.Chart.FontIndexRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10970. Constructs a FontIndex record and Sets its fields appropriately.
  10971. @param in the RecordInputstream to Read the record from
  10972. </member>
  10973. <member name="P:NPOI.HSSF.Record.Chart.FontIndexRecord.DataSize">
  10974. Size of record (exluding 4 byte header)
  10975. </member>
  10976. <member name="P:NPOI.HSSF.Record.Chart.FontIndexRecord.FontIndex">
  10977. <summary>
  10978. specifies the font to use for subsequent records.
  10979. This font can either be the default font of the chart, part of the collection of Font records following
  10980. the FrtFontList record, or part of the collection of Font records in the globals substream.
  10981. If iFont is 0x0000, this record specifies the default font of the chart.
  10982. If iFont is less than or equal to the number of Font records in the globals substream,
  10983. iFont is a one-based index to a Font record in the globals substream.
  10984. Otherwise iFont is a one-based index into the collection of Font records in this chart sheet substream
  10985. where the index is equal to iFont – n, where n is the number of Font records in the globals substream.
  10986. </summary>
  10987. </member>
  10988. <member name="T:NPOI.HSSF.Record.Chart.FrameRecord">
  10989. * The frame record indicates whether there is a border around the Displayed text of a chart.
  10990. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10991. * Remove the record in src/records/definitions.
  10992. * @author Glen Stampoultzis (glens at apache.org)
  10993. </member>
  10994. <member name="M:NPOI.HSSF.Record.Chart.FrameRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10995. Constructs a Frame record and Sets its fields appropriately.
  10996. @param in the RecordInputstream to Read the record from
  10997. </member>
  10998. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.DataSize">
  10999. Size of record (exluding 4 byte header)
  11000. </member>
  11001. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.BorderType">
  11002. Get the border type field for the Frame record.
  11003. @return One of
  11004. BORDER_TYPE_REGULAR
  11005. BORDER_TYPE_SHADOW
  11006. </member>
  11007. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.Options">
  11008. Get the options field for the Frame record.
  11009. </member>
  11010. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.IsAutoSize">
  11011. excel calculates the size automatically if true
  11012. @return the auto size field value.
  11013. </member>
  11014. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.IsAutoPosition">
  11015. excel calculates the position automatically
  11016. @return the auto position field value.
  11017. </member>
  11018. <member name="T:NPOI.HSSF.Record.Chart.FrtFontListRecord">
  11019. <summary>
  11020. The FrtFontList record specifies font information used on the chart and specifies the
  11021. beginning of a collection of Font records as defined by the Chart Sheet Substream ABNF.
  11022. </summary>
  11023. <remarks>
  11024. author: Antony liu (antony.apollo at gmail.com)
  11025. </remarks>
  11026. </member>
  11027. <member name="T:NPOI.HSSF.Record.Chart.GelFrameRecord">
  11028. <summary>
  11029. specifies the properties of a fill pattern for parts of a chart.
  11030. </summary>
  11031. <remarks>
  11032. author: Antony liu (antony.apollo at gmail.com)
  11033. </remarks>
  11034. </member>
  11035. <member name="T:NPOI.HSSF.Record.Chart.IFmtRecordRecord">
  11036. <summary>
  11037. The IFmtRecord record specifies the number format to use for the text on an axis.
  11038. </summary>
  11039. </member>
  11040. <member name="M:NPOI.HSSF.Record.Chart.IFmtRecordRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11041. Constructs a NumberFormatIndex record and Sets its fields appropriately.
  11042. @param in the RecordInputstream to Read the record from
  11043. </member>
  11044. <member name="P:NPOI.HSSF.Record.Chart.IFmtRecordRecord.DataSize">
  11045. Size of record (exluding 4 byte header)
  11046. </member>
  11047. <member name="P:NPOI.HSSF.Record.Chart.IFmtRecordRecord.FormatIndex">
  11048. Get the format index field for the NumberFormatIndex record.
  11049. </member>
  11050. <member name="T:NPOI.HSSF.Record.Chart.LegendExceptionRecord">
  11051. <summary>
  11052. The LegendException record specifies information about a legend entry which was
  11053. changed from the default legend entry settings, and specifies the beginning of
  11054. a collection of records as defined by the Chart Sheet Substream ABNF.
  11055. The collection of records specifies legend entry formatting. On a chart where
  11056. the legend contains legend entries for the series and trendlines, as defined
  11057. in the legend overview, there MUST be zero instances or one instance of this
  11058. record in the sequence of records that conform to the SERIESFORMAT rule.
  11059. </summary>
  11060. <remarks>
  11061. author: Antony liu (antony.apollo at gmail.com)
  11062. </remarks>
  11063. </member>
  11064. <member name="T:NPOI.HSSF.Record.Chart.LegendRecord">
  11065. * Defines a legend for a chart.
  11066. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11067. * Remove the record in src/records/definitions.
  11068. * @author Andrew C. Oliver (acoliver at apache.org)
  11069. </member>
  11070. <member name="M:NPOI.HSSF.Record.Chart.LegendRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11071. Constructs a Legend record and Sets its fields appropriately.
  11072. @param in the RecordInputstream to Read the record from
  11073. </member>
  11074. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.DataSize">
  11075. Size of record (exluding 4 byte header)
  11076. </member>
  11077. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.XAxisUpperLeft">
  11078. Get the x axis upper left field for the Legend record.
  11079. </member>
  11080. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.YAxisUpperLeft">
  11081. Get the y axis upper left field for the Legend record.
  11082. </member>
  11083. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.XSize">
  11084. Get the x size field for the Legend record.
  11085. </member>
  11086. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.YSize">
  11087. Get the y size field for the Legend record.
  11088. </member>
  11089. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.Type">
  11090. Get the type field for the Legend record.
  11091. @return One of
  11092. TYPE_BOTTOM
  11093. TYPE_CORNER
  11094. TYPE_TOP
  11095. TYPE_RIGHT
  11096. TYPE_LEFT
  11097. TYPE_UNDOCKED
  11098. </member>
  11099. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.Spacing">
  11100. Get the spacing field for the Legend record.
  11101. @return One of
  11102. SPACING_CLOSE
  11103. SPACING_MEDIUM
  11104. SPACING_OPEN
  11105. </member>
  11106. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.Options">
  11107. Get the options field for the Legend record.
  11108. </member>
  11109. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsAutoPosition">
  11110. automatic positioning (1=docked)
  11111. @return the auto position field value.
  11112. </member>
  11113. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsAutoSeries">
  11114. excel 5 only (true)
  11115. @return the auto series field value.
  11116. </member>
  11117. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsAutoXPositioning">
  11118. position of legend on the x axis is automatic
  11119. @return the auto x positioning field value.
  11120. </member>
  11121. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsAutoYPositioning">
  11122. position of legend on the y axis is automatic
  11123. @return the auto y positioning field value.
  11124. </member>
  11125. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsVertical">
  11126. vertical or horizontal legend (1 or 0 respectively). Always 0 if not automatic.
  11127. @return the vertical field value.
  11128. </member>
  11129. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsDataTable">
  11130. 1 if chart Contains data table
  11131. @return the data table field value.
  11132. </member>
  11133. <member name="T:NPOI.HSSF.Record.Chart.LineFormatRecord">
  11134. * Describes a line format record. The line format record controls how a line on a chart appears.
  11135. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11136. * Remove the record in src/records/definitions.
  11137. * @author Glen Stampoultzis (glens at apache.org)
  11138. </member>
  11139. <member name="M:NPOI.HSSF.Record.Chart.LineFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11140. Constructs a LineFormat record and Sets its fields appropriately.
  11141. @param in the RecordInputstream to Read the record from
  11142. </member>
  11143. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.DataSize">
  11144. Size of record (exluding 4 byte header)
  11145. </member>
  11146. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.LineColor">
  11147. Get the line color field for the LineFormat record.
  11148. </member>
  11149. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.LinePattern">
  11150. Get the line pattern field for the LineFormat record.
  11151. @return One of
  11152. LINE_PATTERN_SOLID
  11153. LINE_PATTERN_DASH
  11154. LINE_PATTERN_DOT
  11155. LINE_PATTERN_DASH_DOT
  11156. LINE_PATTERN_DASH_DOT_DOT
  11157. LINE_PATTERN_NONE
  11158. LINE_PATTERN_DARK_GRAY_PATTERN
  11159. LINE_PATTERN_MEDIUM_GRAY_PATTERN
  11160. LINE_PATTERN_LIGHT_GRAY_PATTERN
  11161. </member>
  11162. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.Weight">
  11163. Get the weight field for the LineFormat record.
  11164. specifies the thickness of the line.
  11165. @return One of
  11166. WEIGHT_HAIRLINE
  11167. WEIGHT_NARROW
  11168. WEIGHT_MEDIUM
  11169. WEIGHT_WIDE
  11170. </member>
  11171. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.Format">
  11172. Get the format field for the LineFormat record.
  11173. </member>
  11174. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.ColourPaletteIndex">
  11175. Get the colour palette index field for the LineFormat record.
  11176. </member>
  11177. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.IsAuto">
  11178. automatic format
  11179. @return the auto field value.
  11180. </member>
  11181. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.IsDrawTicks">
  11182. draw tick marks
  11183. @return the draw ticks field value.
  11184. </member>
  11185. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.IsUnknown">
  11186. book marks this as reserved = 0 but it seems to do something
  11187. @return the Unknown field value.
  11188. </member>
  11189. <member name="T:NPOI.HSSF.Record.Chart.LinkedDataRecord">
  11190. Describes a linked data record. This record refers to the series data or text.<p/>
  11191. @author Glen Stampoultzis (glens at apache.org)
  11192. </member>
  11193. <member name="P:NPOI.HSSF.Record.Chart.LinkedDataRecord.LinkType">
  11194. Get the link type field for the LinkedData record.
  11195. @return One of
  11196. LINK_TYPE_TITLE_OR_TEXT
  11197. LINK_TYPE_VALUES
  11198. LINK_TYPE_CATEGORIES
  11199. </member>
  11200. <member name="P:NPOI.HSSF.Record.Chart.LinkedDataRecord.ReferenceType">
  11201. Get the reference type field for the LinkedData record.
  11202. @return One of
  11203. REFERENCE_TYPE_DEFAULT_CATEGORIES
  11204. REFERENCE_TYPE_DIRECT
  11205. REFERENCE_TYPE_WORKSHEET
  11206. REFERENCE_TYPE_NOT_USED
  11207. REFERENCE_TYPE_ERROR_REPORTED
  11208. </member>
  11209. <member name="P:NPOI.HSSF.Record.Chart.LinkedDataRecord.Options">
  11210. Get the options field for the LinkedData record.
  11211. </member>
  11212. <member name="P:NPOI.HSSF.Record.Chart.LinkedDataRecord.IndexNumberFmtRecord">
  11213. Get the index number fmt record field for the LinkedData record.
  11214. </member>
  11215. <member name="P:NPOI.HSSF.Record.Chart.LinkedDataRecord.FormulaOfLink">
  11216. Get the formula of link field for the LinkedData record.
  11217. </member>
  11218. <member name="P:NPOI.HSSF.Record.Chart.LinkedDataRecord.IsCustomNumberFormat">
  11219. true if this object has a custom number format
  11220. @return the custom number format field value.
  11221. </member>
  11222. <member name="T:NPOI.HSSF.Record.Chart.MarkerFormatRecord">
  11223. <summary>
  11224. specifies the color, size, and shape of the associated data markers that appear on line, radar,
  11225. and scatter chart groups. The associated data markers are specified by the preceding DataFormat record.
  11226. </summary>
  11227. <remarks>
  11228. author: Antony liu (antony.apollo at gmail.com)
  11229. </remarks>
  11230. </member>
  11231. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.RGBFore">
  11232. <summary>
  11233. the border color of the data marker.
  11234. </summary>
  11235. </member>
  11236. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.RGBBack">
  11237. <summary>
  11238. the interior color of the data marker.
  11239. </summary>
  11240. </member>
  11241. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.DataMarkerType">
  11242. <summary>
  11243. the type of data marker.
  11244. </summary>
  11245. </member>
  11246. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.Auto">
  11247. <summary>
  11248. whether the data marker is automatically generated.
  11249. false The data marker is not automatically generated.
  11250. true The data marker type, size, and color are automatically generated and the values are set accordingly in this record.
  11251. </summary>
  11252. </member>
  11253. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.NotShowInt">
  11254. <summary>
  11255. whether to show the data marker interior.
  11256. false The data marker interior is shown.
  11257. true The data marker interior is not shown.
  11258. </summary>
  11259. </member>
  11260. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.NotShowBorder">
  11261. <summary>
  11262. whether to show the data marker border.
  11263. false The data marker border is shown.
  11264. true The data marker border is not shown.
  11265. </summary>
  11266. </member>
  11267. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.IcvFore">
  11268. <summary>
  11269. the border color of the data marker.
  11270. </summary>
  11271. </member>
  11272. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.IcvBack">
  11273. <summary>
  11274. the interior color of the data marker.
  11275. </summary>
  11276. </member>
  11277. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.Size">
  11278. <summary>
  11279. specifies the size in twips of the data marker.
  11280. </summary>
  11281. </member>
  11282. <member name="T:NPOI.HSSF.Record.Chart.NumberFormatIndexRecord">
  11283. * The number format index record indexes format table. This applies to an axis.
  11284. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11285. * Remove the record in src/records/definitions.
  11286. * @author Glen Stampoultzis (glens at apache.org)
  11287. </member>
  11288. <member name="M:NPOI.HSSF.Record.Chart.NumberFormatIndexRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11289. Constructs a NumberFormatIndex record and Sets its fields appropriately.
  11290. @param in the RecordInputstream to Read the record from
  11291. </member>
  11292. <member name="P:NPOI.HSSF.Record.Chart.NumberFormatIndexRecord.DataSize">
  11293. Size of record (exluding 4 byte header)
  11294. </member>
  11295. <member name="P:NPOI.HSSF.Record.Chart.NumberFormatIndexRecord.FormatIndex">
  11296. Get the format index field for the NumberFormatIndex record.
  11297. </member>
  11298. <member name="T:NPOI.HSSF.Record.Chart.ObjectLinkRecord">
  11299. * Links text to an object on the chart or identifies it as the title.
  11300. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11301. * Remove the record in src/records/definitions.
  11302. * @author Andrew C. Oliver (acoliver at apache.org)
  11303. </member>
  11304. <member name="M:NPOI.HSSF.Record.Chart.ObjectLinkRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11305. Constructs a ObjectLink record and Sets its fields appropriately.
  11306. @param in the RecordInputstream to Read the record from
  11307. </member>
  11308. <member name="P:NPOI.HSSF.Record.Chart.ObjectLinkRecord.DataSize">
  11309. Size of record (exluding 4 byte header)
  11310. </member>
  11311. <member name="P:NPOI.HSSF.Record.Chart.ObjectLinkRecord.AnchorId">
  11312. Get the anchor id field for the ObjectLink record.
  11313. @return One of
  11314. ANCHOR_ID_CHART_TITLE
  11315. ANCHOR_ID_Y_AXIS
  11316. ANCHOR_ID_X_AXIS
  11317. ANCHOR_ID_SERIES_OR_POINT
  11318. ANCHOR_ID_Z_AXIS
  11319. </member>
  11320. <member name="P:NPOI.HSSF.Record.Chart.ObjectLinkRecord.Link1">
  11321. Get the link 1 field for the ObjectLink record.
  11322. </member>
  11323. <member name="P:NPOI.HSSF.Record.Chart.ObjectLinkRecord.Link2">
  11324. Get the link 2 field for the ObjectLink record.
  11325. </member>
  11326. <member name="T:NPOI.HSSF.Record.Chart.PicFRecord">
  11327. <summary>
  11328. The PicF record specifies the layout of a picture that is attached to a picture-filled chart element.
  11329. </summary>
  11330. <remarks>
  11331. author: Antony liu (antony.apollo at gmail.com)
  11332. </remarks>
  11333. </member>
  11334. <member name="T:NPOI.HSSF.Record.Chart.PieFormatRecord">
  11335. <summary>
  11336. The PieFormat record specifies the distance of a data point or data points in a series from the center of one of the following:
  11337. The plot area for a doughnut or pie chart group.
  11338. The primary pie in a pie of pie or bar of pie chart group.
  11339. The secondary bar/pie of a pie of pie chart group.
  11340. </summary>
  11341. <remarks>
  11342. author: Antony liu (antony.apollo at gmail.com)
  11343. </remarks>
  11344. </member>
  11345. <member name="P:NPOI.HSSF.Record.Chart.PieFormatRecord.Explode">
  11346. <summary>
  11347. A signed integer that specifies the distance of a data point or data points in a series from the center of one of the following:
  11348. The plot area for a doughnut or pie chart group.
  11349. The primary pie in a pie of pie or bar of pie chart group.
  11350. The secondary bar/pie of a pie of pie chart group.
  11351. </summary>
  11352. </member>
  11353. <member name="T:NPOI.HSSF.Record.Chart.PieRecord">
  11354. <summary>
  11355. The Pie record specifies that the chart group is a pie chart group or
  11356. a doughnut chart group, and specifies the chart group attributes.
  11357. </summary>
  11358. <remarks>
  11359. author: Antony liu (antony.apollo at gmail.com)
  11360. </remarks>
  11361. </member>
  11362. <member name="P:NPOI.HSSF.Record.Chart.PieRecord.Start">
  11363. <summary>
  11364. An unsigned integer that specifies the starting angle of the first data point,
  11365. clockwise from the top of the circle. MUST be less than or equal to 360.
  11366. </summary>
  11367. </member>
  11368. <member name="P:NPOI.HSSF.Record.Chart.PieRecord.Dount">
  11369. <summary>
  11370. An unsigned integer that specifies the size of the center hole in a doughnut chart group
  11371. as a percentage of the plot area size. MUST be a value from the following table:
  11372. 0 Pie chart group.
  11373. 10 to 90 Doughnut chart group.
  11374. </summary>
  11375. </member>
  11376. <member name="P:NPOI.HSSF.Record.Chart.PieRecord.HasShadow">
  11377. <summary>
  11378. A bit that specifies whether one data point or more data points in the chart group have shadows.
  11379. </summary>
  11380. </member>
  11381. <member name="P:NPOI.HSSF.Record.Chart.PieRecord.ShowLdrLines">
  11382. <summary>
  11383. A bit that specifies whether the leader lines to the data labels are shown.
  11384. </summary>
  11385. </member>
  11386. <member name="T:NPOI.HSSF.Record.Chart.PlotAreaRecord">
  11387. * preceeds and identifies a frame as belonging to the plot area.
  11388. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11389. * Remove the record in src/records/definitions.
  11390. * @author Andrew C. Oliver (acoliver at apache.org)
  11391. </member>
  11392. <member name="M:NPOI.HSSF.Record.Chart.PlotAreaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11393. Constructs a PlotArea record and Sets its fields appropriately.
  11394. @param in the RecordInputstream to Read the record from
  11395. </member>
  11396. <member name="P:NPOI.HSSF.Record.Chart.PlotAreaRecord.DataSize">
  11397. Size of record (exluding 4 byte header)
  11398. </member>
  11399. <member name="T:NPOI.HSSF.Record.Chart.PlotGrowthRecord">
  11400. * The plot growth record specifies the scaling factors used when a font is scaled.
  11401. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11402. * Remove the record in src/records/definitions.
  11403. * @author Glen Stampoultzis (glens at apache.org)
  11404. </member>
  11405. <member name="M:NPOI.HSSF.Record.Chart.PlotGrowthRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11406. Constructs a PlotGrowth record and Sets its fields appropriately.
  11407. @param in the RecordInputstream to Read the record from
  11408. </member>
  11409. <member name="P:NPOI.HSSF.Record.Chart.PlotGrowthRecord.DataSize">
  11410. Size of record (exluding 4 byte header)
  11411. </member>
  11412. <member name="P:NPOI.HSSF.Record.Chart.PlotGrowthRecord.HorizontalScale">
  11413. Get the horizontalScale field for the PlotGrowth record.
  11414. </member>
  11415. <member name="P:NPOI.HSSF.Record.Chart.PlotGrowthRecord.VerticalScale">
  11416. Get the verticalScale field for the PlotGrowth record.
  11417. </member>
  11418. <member name="T:NPOI.HSSF.Record.Chart.PositionMode">
  11419. <summary>
  11420. pecifies positioning mode for position information saved in a Pos record.
  11421. </summary>
  11422. </member>
  11423. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDFX">
  11424. <summary>
  11425. Relative position to the chart, in points.
  11426. </summary>
  11427. </member>
  11428. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDABS">
  11429. <summary>
  11430. Absolute width and height in points. It can only be applied to the mdBotRt field of Pos.
  11431. </summary>
  11432. </member>
  11433. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDPARENT">
  11434. <summary>
  11435. Owner of Pos determines how to interpret the position data.
  11436. </summary>
  11437. </member>
  11438. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDKTH">
  11439. <summary>
  11440. Offset to default position, in 1/1000th of the plot area size.
  11441. </summary>
  11442. </member>
  11443. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDCHART">
  11444. <summary>
  11445. Relative position to the chart, in SPRC.
  11446. </summary>
  11447. </member>
  11448. <member name="T:NPOI.HSSF.Record.Chart.PosRecord">
  11449. <summary>
  11450. specifies the size and position for a legend, an attached label, or the plot area, as specified by the primary axis group.
  11451. </summary>
  11452. </member>
  11453. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.MDTopLt">
  11454. <summary>
  11455. specifies the positioning mode for the upper-left corner of a legend, an attached label, or the plot area.
  11456. </summary>
  11457. </member>
  11458. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.MdBotRt">
  11459. <summary>
  11460. specifies the positioning mode for the lower-right corner of a legend, an attached label, or the plot area
  11461. </summary>
  11462. </member>
  11463. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.X1">
  11464. <summary>
  11465. specifies a position. The meaning is specified in the earlier table showing the valid combinations mdTopLt and mdBotRt by type.
  11466. </summary>
  11467. </member>
  11468. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.X2">
  11469. <summary>
  11470. specifies a width. The meaning is specified in the earlier table showing the valid combinations mdTopLt and mdBotRt by type.
  11471. </summary>
  11472. </member>
  11473. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.Y1">
  11474. <summary>
  11475. specifies a position. The meaning is specified in the earlier table showing the valid combinations mdTopLt and mdBotRt by type.
  11476. </summary>
  11477. </member>
  11478. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.Y2">
  11479. <summary>
  11480. specifies a height. The meaning is specified in the earlier table showing the valid combinations mdTopLt and mdBotRt by type.
  11481. </summary>
  11482. </member>
  11483. <member name="T:NPOI.HSSF.Record.Chart.RadarAreaRecord">
  11484. <summary>
  11485. The RadarArea record specifies that the chart group is a filled radar chart group and specifies the chart group attributes.
  11486. </summary>
  11487. <remarks>
  11488. author: Antony liu (antony.apollo at gmail.com)
  11489. </remarks>
  11490. </member>
  11491. <member name="T:NPOI.HSSF.Record.Chart.RadarRecord">
  11492. <summary>
  11493. The Radar record specifies that the chart group is a radar chart group and specifies the chart group attributes.
  11494. </summary>
  11495. <remarks>
  11496. author: Antony liu (antony.apollo at gmail.com)
  11497. </remarks>
  11498. </member>
  11499. <member name="T:NPOI.HSSF.Record.Chart.RichTextStreamRecord">
  11500. <summary>
  11501. The RichTextStream record specifies additional text properties for the text in
  11502. the entire chart, text in the current legend, text in the current legend entry,
  11503. or text in the attached label. These text properties are a superset of the
  11504. properties stored in the Text, Font, FontX, BRAI, and ObjectLink records based
  11505. on the following table, as specified by the Chart Sheet Substream ABNF. In each
  11506. case, the associated Font record is specified by the associated FontX record.
  11507. </summary>
  11508. <remarks>
  11509. author: Antony liu (antony.apollo at gmail.com)
  11510. </remarks>
  11511. </member>
  11512. <member name="T:NPOI.HSSF.Record.Chart.ScatterRecord">
  11513. <summary>
  11514. The Scatter record specifies that the chart group is a scatter chart group or
  11515. a bubble chart group, and specifies the chart group attributes.
  11516. </summary>
  11517. <remarks>
  11518. author: Antony liu (antony.apollo at gmail.com)
  11519. </remarks>
  11520. </member>
  11521. <member name="T:NPOI.HSSF.Record.Chart.SerAuxErrBarRecord">
  11522. <summary>
  11523. The SerAuxErrBar record specifies properties of an error bar.
  11524. </summary>
  11525. <remarks>
  11526. author: Antony liu (antony.apollo at gmail.com)
  11527. </remarks>
  11528. </member>
  11529. <member name="T:NPOI.HSSF.Record.Chart.SerAuxTrendRecord">
  11530. <summary>
  11531. The SerAuxTrend record specifies a trendline.
  11532. </summary>
  11533. <remarks>
  11534. author: Antony liu (antony.apollo at gmail.com)
  11535. </remarks>
  11536. </member>
  11537. <member name="T:NPOI.HSSF.Record.Chart.SerFmtRecord">
  11538. <summary>
  11539. The SerFmt record specifies properties of the associated data points, data markers,
  11540. or lines of the series. The associated data points, data markers, or lines of the
  11541. series are specified by the preceding DataFormat record. If this record is not
  11542. present in the sequence of records that conforms to the SS rule of the Chart Sheet
  11543. Substream ABNF, then the properties of the associated data points, data markers,
  11544. or lines of the series are specified by the default values of the fields of this record.
  11545. </summary>
  11546. <remarks>
  11547. author: Antony liu (antony.apollo at gmail.com)
  11548. </remarks>
  11549. </member>
  11550. <member name="T:NPOI.HSSF.Record.Chart.SeriesChartGroupIndexRecord">
  11551. * The series chart Group index record stores the index to the CHARTFORMAT record (0 based).
  11552. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11553. * Remove the record in src/records/definitions.
  11554. * @author Glen Stampoultzis (glens at apache.org)
  11555. </member>
  11556. <member name="M:NPOI.HSSF.Record.Chart.SeriesChartGroupIndexRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11557. Constructs a SeriesChartGroupIndex record and Sets its fields appropriately.
  11558. @param in the RecordInputstream to Read the record from
  11559. </member>
  11560. <member name="P:NPOI.HSSF.Record.Chart.SeriesChartGroupIndexRecord.DataSize">
  11561. Size of record (exluding 4 byte header)
  11562. </member>
  11563. <member name="P:NPOI.HSSF.Record.Chart.SeriesChartGroupIndexRecord.ChartGroupIndex">
  11564. Get the chart Group index field for the SeriesChartGroupIndex record.
  11565. </member>
  11566. <member name="T:NPOI.HSSF.Record.Chart.SeriesIndexRecord">
  11567. * links a series to its position in the series list.
  11568. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11569. * Remove the record in src/records/definitions.
  11570. * @author Andrew C. Oliver (acoliver at apache.org)
  11571. </member>
  11572. <member name="M:NPOI.HSSF.Record.Chart.SeriesIndexRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11573. Constructs a SeriesIndex record and Sets its fields appropriately.
  11574. @param in the RecordInputstream to Read the record from
  11575. </member>
  11576. <member name="P:NPOI.HSSF.Record.Chart.SeriesIndexRecord.DataSize">
  11577. Size of record (exluding 4 byte header)
  11578. </member>
  11579. <member name="P:NPOI.HSSF.Record.Chart.SeriesIndexRecord.Index">
  11580. Get the index field for the SeriesIndex record.
  11581. </member>
  11582. <member name="T:NPOI.HSSF.Record.Chart.SeriesLabelsRecord">
  11583. * The series label record defines the type of label associated with the data format record.
  11584. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11585. * Remove the record in src/records/definitions.
  11586. * @author Glen Stampoultzis (glens at apache.org)
  11587. </member>
  11588. <member name="M:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11589. Constructs a SeriesLabels record and Sets its fields appropriately.
  11590. @param in the RecordInputstream to Read the record from
  11591. </member>
  11592. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.DataSize">
  11593. Size of record (exluding 4 byte header)
  11594. </member>
  11595. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.FormatFlags">
  11596. Get the format flags field for the SeriesLabels record.
  11597. </member>
  11598. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsShowActual">
  11599. show actual value of the data point
  11600. @return the show actual field value.
  11601. </member>
  11602. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsShowPercent">
  11603. show value as percentage of total (pie charts only)
  11604. @return the show percent field value.
  11605. </member>
  11606. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsLabelAsPercentage">
  11607. show category label/value as percentage (pie charts only)
  11608. @return the label as percentage field value.
  11609. </member>
  11610. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsSmoothedLine">
  11611. show smooth line
  11612. @return the smoothed line field value.
  11613. </member>
  11614. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsShowLabel">
  11615. Display category label
  11616. @return the show label field value.
  11617. </member>
  11618. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsShowBubbleSizes">
  11619. ??
  11620. @return the show bubble sizes field value.
  11621. </member>
  11622. <member name="T:NPOI.HSSF.Record.Chart.SeriesListRecord">
  11623. * The series list record defines the series Displayed as an overlay to the main chart record.
  11624. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11625. * Remove the record in src/records/definitions.
  11626. * @author Glen Stampoultzis (glens at apache.org)
  11627. </member>
  11628. <member name="M:NPOI.HSSF.Record.Chart.SeriesListRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11629. Constructs a SeriesList record and Sets its fields appropriately.
  11630. @param in the RecordInputstream to Read the record from
  11631. </member>
  11632. <member name="P:NPOI.HSSF.Record.Chart.SeriesListRecord.DataSize">
  11633. Size of record (exluding 4 byte header)
  11634. </member>
  11635. <member name="P:NPOI.HSSF.Record.Chart.SeriesListRecord.SeriesNumbers">
  11636. Get the series numbers field for the SeriesList record.
  11637. </member>
  11638. <member name="T:NPOI.HSSF.Record.Chart.SeriesRecord">
  11639. * The series record describes the overall data for a series.
  11640. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11641. * Remove the record in src/records/definitions.
  11642. * @author Glen Stampoultzis (glens at apache.org)
  11643. </member>
  11644. <member name="M:NPOI.HSSF.Record.Chart.SeriesRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11645. Constructs a Series record and Sets its fields appropriately.
  11646. @param in the RecordInputstream to Read the record from
  11647. </member>
  11648. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.DataSize">
  11649. Size of record (exluding 4 byte header)
  11650. </member>
  11651. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.CategoryDataType">
  11652. Get the category data type field for the Series record.
  11653. @return One of
  11654. CATEGORY_DATA_TYPE_DATES
  11655. CATEGORY_DATA_TYPE_NUMERIC
  11656. CATEGORY_DATA_TYPE_SEQUENCE
  11657. CATEGORY_DATA_TYPE_TEXT
  11658. </member>
  11659. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.ValuesDataType">
  11660. Get the values data type field for the Series record.
  11661. @return One of
  11662. VALUES_DATA_TYPE_DATES
  11663. VALUES_DATA_TYPE_NUMERIC
  11664. VALUES_DATA_TYPE_SEQUENCE
  11665. VALUES_DATA_TYPE_TEXT
  11666. </member>
  11667. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.NumCategories">
  11668. Get the num categories field for the Series record.
  11669. </member>
  11670. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.NumValues">
  11671. Get the num values field for the Series record.
  11672. </member>
  11673. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.BubbleSeriesType">
  11674. Get the bubble series type field for the Series record.
  11675. @return One of
  11676. BUBBLE_SERIES_TYPE_DATES
  11677. BUBBLE_SERIES_TYPE_NUMERIC
  11678. BUBBLE_SERIES_TYPE_SEQUENCE
  11679. BUBBLE_SERIES_TYPE_TEXT
  11680. </member>
  11681. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.NumBubbleValues">
  11682. Get the num bubble values field for the Series record.
  11683. </member>
  11684. <member name="T:NPOI.HSSF.Record.Chart.SeriesTextRecord">
  11685. * Defines a series name
  11686. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11687. * Remove the record in src/records/definitions.
  11688. * @author Andrew C. Oliver (acoliver at apache.org)
  11689. </member>
  11690. <member name="F:NPOI.HSSF.Record.Chart.SeriesTextRecord.MAX_LEN">
  11691. the actual text cannot be longer than 255 characters
  11692. </member>
  11693. <member name="M:NPOI.HSSF.Record.Chart.SeriesTextRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11694. Constructs a SeriesText record and Sets its fields appropriately.
  11695. @param in the RecordInputstream to Read the record from
  11696. </member>
  11697. <member name="P:NPOI.HSSF.Record.Chart.SeriesTextRecord.DataSize">
  11698. Size of record (exluding 4 byte header)
  11699. </member>
  11700. <member name="P:NPOI.HSSF.Record.Chart.SeriesTextRecord.Id">
  11701. Get the id field for the SeriesText record.
  11702. </member>
  11703. <member name="P:NPOI.HSSF.Record.Chart.SeriesTextRecord.Text">
  11704. Get the text field for the SeriesText record.
  11705. </member>
  11706. <member name="T:NPOI.HSSF.Record.Chart.SeriesToChartGroupRecord">
  11707. * Indicates the chart-group index for a series. The order probably defines the mapping. So the 0th record probably means the 0th series. The only field in this of course defines which chart Group the 0th series (for instance) would map to. Confusing? Well thats because it Is. (p 522 BCG)
  11708. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11709. * Remove the record in src/records/definitions.
  11710. * @author Andrew C. Oliver (acoliver at apache.org)
  11711. </member>
  11712. <member name="M:NPOI.HSSF.Record.Chart.SeriesToChartGroupRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11713. Constructs a SeriesToChartGroup record and Sets its fields appropriately.
  11714. @param in the RecordInputstream to Read the record from
  11715. </member>
  11716. <member name="P:NPOI.HSSF.Record.Chart.SeriesToChartGroupRecord.DataSize">
  11717. Size of record (exluding 4 byte header)
  11718. </member>
  11719. <member name="P:NPOI.HSSF.Record.Chart.SeriesToChartGroupRecord.ChartGroupIndex">
  11720. Get the chart Group index field for the SeriesToChartGroup record.
  11721. </member>
  11722. <member name="T:NPOI.HSSF.Record.Chart.SerParentRecord">
  11723. <summary>
  11724. The SerParent record specifies the series to which the current trendline or error bar corresponds.
  11725. </summary>
  11726. <remarks>
  11727. author: Antony liu (antony.apollo at gmail.com)
  11728. </remarks>
  11729. </member>
  11730. <member name="T:NPOI.HSSF.Record.Chart.SerToCrtRecord">
  11731. <summary>
  11732. The SerToCrt record specifies the chart group for the current series.
  11733. </summary>
  11734. </member>
  11735. <member name="M:NPOI.HSSF.Record.Chart.SerToCrtRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11736. Constructs a SeriesChartGroupIndex record and Sets its fields appropriately.
  11737. @param in the RecordInputstream to Read the record from
  11738. </member>
  11739. <member name="P:NPOI.HSSF.Record.Chart.SerToCrtRecord.DataSize">
  11740. Size of record (exluding 4 byte header)
  11741. </member>
  11742. <member name="P:NPOI.HSSF.Record.Chart.SerToCrtRecord.ChartGroupIndex">
  11743. Get the chart Group index field for the SeriesChartGroupIndex record.
  11744. </member>
  11745. <member name="T:NPOI.HSSF.Record.Chart.ShapePropsStreamRecord">
  11746. <summary>
  11747. The ShapePropsStream record specifies the shape formatting properties for chart elements.
  11748. These shape formatting properties are a superset of the properties stored in the LineFormat,
  11749. AreaFormat, MarkerFormat, and GelFrame records. They are stored in the rgb field, which is an
  11750. XML stream (section 2.1.7.22), as defined in [ECMA-376] Part 4, section 5.7.2.198.
  11751. </summary>
  11752. <remarks>
  11753. author: Antony liu (antony.apollo at gmail.com)
  11754. </remarks>
  11755. </member>
  11756. <member name="T:NPOI.HSSF.Record.Chart.ShtPropsRecord">
  11757. * Describes a chart sheet properties record.
  11758. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11759. * Remove the record in src/records/definitions.
  11760. * @author Glen Stampoultzis (glens at apache.org)
  11761. <summary>
  11762. specifies properties of a chart as defined by the Chart Sheet Substream ABNF
  11763. </summary>
  11764. </member>
  11765. <member name="M:NPOI.HSSF.Record.Chart.ShtPropsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11766. Constructs a SheetProperties record and Sets its fields appropriately.
  11767. @param in the RecordInputstream to Read the record from
  11768. </member>
  11769. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.DataSize">
  11770. Size of record (exluding 4 byte header)
  11771. </member>
  11772. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.Flags">
  11773. Get the flags field for the SheetProperties record.
  11774. </member>
  11775. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.Blank">
  11776. Get the empty field for the SheetProperties record.
  11777. @return One of
  11778. EMPTY_NOT_PLOTTED
  11779. EMPTY_ZERO
  11780. EMPTY_INTERPOLATED
  11781. <summary>
  11782. specifies how the empty cells are plotted be a value from the following table:
  11783. 0x00 Empty cells are not plotted.
  11784. 0x01 Empty cells are plotted as zero.
  11785. 0x02 Empty cells are plotted as interpolated.
  11786. </summary>
  11787. </member>
  11788. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsManSerAlloc">
  11789. <summary>
  11790. whether series are automatically allocated for the chart.
  11791. </summary>
  11792. </member>
  11793. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsPlotVisibleOnly">
  11794. <summary>
  11795. whether to plot visible cells only.
  11796. </summary>
  11797. </member>
  11798. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsNotSizeWithWindow">
  11799. <summary>
  11800. whether to size the chart with the window.
  11801. </summary>
  11802. </member>
  11803. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsManPlotArea">
  11804. <summary>
  11805. If fAlwaysAutoPlotArea is 1, then this field MUST be 1.
  11806. If fAlwaysAutoPlotArea is 0, then this field MUST be ignored.
  11807. </summary>
  11808. </member>
  11809. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsAlwaysAutoPlotArea">
  11810. <summary>
  11811. specifies whether the default plot area dimension (2) is used.
  11812. 0 Use the default plot area dimension (2) regardless of the Pos record information.
  11813. 1 Use the plot area dimension (2) of the Pos record; and fManPlotArea MUST be 1.
  11814. </summary>
  11815. </member>
  11816. <member name="T:NPOI.HSSF.Record.Chart.StartBlockRecord">
  11817. STARTBLOCK - Chart Future Record Type Start Block (0x0852)<br/>
  11818. @author Patrick Cheng
  11819. </member>
  11820. <member name="T:NPOI.HSSF.Record.Chart.SurfRecord">
  11821. <summary>
  11822. The Surf record specifies that the chart group is a surface chart group and specifies the chart group attributes.
  11823. </summary>
  11824. <remarks>
  11825. author: Antony liu (antony.apollo at gmail.com)
  11826. </remarks>
  11827. </member>
  11828. <member name="T:NPOI.HSSF.Record.Chart.TextPropsStreamRecord">
  11829. <summary>
  11830. The RichTextStream record specifies additional text properties for the text
  11831. in the entire chart, text in the current legend, text in the current legend
  11832. entry, or text in the attached label. These text properties are a superset
  11833. of the properties stored in the Text, Font, FontX, BRAI, and ObjectLink records
  11834. based on the following table, as specified by the Chart Sheet Substream ABNF.
  11835. In each case, the associated Font record is specified by the associated FontX record.
  11836. </summary>
  11837. <remarks>
  11838. author: Antony liu (antony.apollo at gmail.com)
  11839. </remarks>
  11840. </member>
  11841. <member name="T:NPOI.HSSF.Record.Chart.ValueRangeRecord">
  11842. * The value range record defines the range of the value axis.
  11843. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11844. * Remove the record in src/records/definitions.
  11845. * @author Glen Stampoultzis (glens at apache.org)
  11846. </member>
  11847. <member name="M:NPOI.HSSF.Record.Chart.ValueRangeRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11848. Constructs a ValueRange record and Sets its fields appropriately.
  11849. @param in the RecordInputstream to Read the record from
  11850. </member>
  11851. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.DataSize">
  11852. Size of record (exluding 4 byte header)
  11853. </member>
  11854. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.MinimumAxisValue">
  11855. Get the minimum axis value field for the ValueRange record.
  11856. </member>
  11857. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.MaximumAxisValue">
  11858. Get the maximum axis value field for the ValueRange record.
  11859. </member>
  11860. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.MajorIncrement">
  11861. Get the major increment field for the ValueRange record.
  11862. </member>
  11863. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.MinorIncrement">
  11864. Get the minor increment field for the ValueRange record.
  11865. </member>
  11866. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.CategoryAxisCross">
  11867. Get the category axis cross field for the ValueRange record.
  11868. </member>
  11869. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.Options">
  11870. Get the options field for the ValueRange record.
  11871. </member>
  11872. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticMinimum">
  11873. automatic minimum value selected
  11874. @return the automatic minimum field value.
  11875. </member>
  11876. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticMaximum">
  11877. automatic maximum value selected
  11878. @return the automatic maximum field value.
  11879. </member>
  11880. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticMajor">
  11881. automatic major Unit selected
  11882. @return the automatic major field value.
  11883. </member>
  11884. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticMinor">
  11885. automatic minor Unit selected
  11886. @return the automatic minor field value.
  11887. </member>
  11888. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticCategoryCrossing">
  11889. category crossing point is automatically selected
  11890. @return the automatic category crossing field value.
  11891. </member>
  11892. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsLogarithmicScale">
  11893. use logarithmic scale
  11894. @return the logarithmic scale field value.
  11895. </member>
  11896. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsValuesInReverse">
  11897. values are reverses in graph
  11898. @return the values in reverse field value.
  11899. </member>
  11900. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsCrossCategoryAxisAtMaximum">
  11901. category axis to cross at maximum value
  11902. @return the cross category axis at maximum field value.
  11903. </member>
  11904. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsReserved">
  11905. reserved, must equal 1 (excel dev. guide says otherwise)
  11906. @return the reserved field value.
  11907. </member>
  11908. <member name="T:NPOI.HSSF.Record.Chart.YMultRecord">
  11909. <summary>
  11910. The YMult record specifies properties of the value multiplier for a value axis and
  11911. that specifies the beginning of a collection of records as defined by the Chart Sheet
  11912. substream ABNF. The collection of records specifies a display units label.
  11913. </summary>
  11914. <remarks>
  11915. author: Antony liu (antony.apollo at gmail.com)
  11916. </remarks>
  11917. </member>
  11918. <member name="T:NPOI.HSSF.Record.ChartFormatRecord">
  11919. Class ChartFormatRecord
  11920. @author Glen Stampoultzis (glens at apache.org)
  11921. @version %I%, %G%
  11922. </member>
  11923. <member name="M:NPOI.HSSF.Record.ChartFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11924. Constructs a ChartFormatRecord record and Sets its fields appropriately.
  11925. @param in the RecordInputstream to Read the record from
  11926. </member>
  11927. <member name="T:NPOI.HSSF.Record.TextRecord">
  11928. <summary>
  11929. Section [2.4.324]. The Text record specifies the properties of an attached label and specifies the beginning of
  11930. a collection of records as defined by the chart sheet substream ABNF. This collection of records specifies an attached label.
  11931. </summary>
  11932. </member>
  11933. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_LEFT">
  11934. <summary>
  11935. Left-alignment if iReadingOrder specifies left-to-right reading order; otherwise, right-alignment
  11936. </summary>
  11937. </member>
  11938. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_CENTER">
  11939. <summary>
  11940. Center-alignment
  11941. </summary>
  11942. </member>
  11943. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_BOTTOM">
  11944. <summary>
  11945. Right-alignment if iReadingOrder specifies left-to-right reading order; otherwise, left-alignment
  11946. </summary>
  11947. </member>
  11948. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_JUSTIFY">
  11949. <summary>
  11950. Justify-alignment
  11951. </summary>
  11952. </member>
  11953. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_DISTRIBUTED">
  11954. <summary>
  11955. distributed alignment
  11956. </summary>
  11957. </member>
  11958. <member name="F:NPOI.HSSF.Record.TextRecord.VERTICAL_ALIGNMENT_DISTRIBUTED">
  11959. <summary>
  11960. distributed alignment
  11961. </summary>
  11962. </member>
  11963. <member name="F:NPOI.HSSF.Record.TextRecord.DISPLAY_MODE_TRANSPARENT">
  11964. <summary>
  11965. Transparent background
  11966. </summary>
  11967. </member>
  11968. <member name="F:NPOI.HSSF.Record.TextRecord.DISPLAY_MODE_OPAQUE">
  11969. <summary>
  11970. Opaque background
  11971. </summary>
  11972. </member>
  11973. <member name="M:NPOI.HSSF.Record.TextRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11974. Constructs a Text record and Sets its fields appropriately.
  11975. @param in the RecordInputstream to Read the record from
  11976. </member>
  11977. <member name="P:NPOI.HSSF.Record.TextRecord.DataSize">
  11978. Size of record (exluding 4 byte header)
  11979. </member>
  11980. <member name="P:NPOI.HSSF.Record.TextRecord.HorizontalAlignment">
  11981. Get the horizontal alignment field for the Text record.
  11982. @return One of
  11983. HORIZONTAL_ALIGNMENT_LEFT
  11984. HORIZONTAL_ALIGNMENT_CENTER
  11985. HORIZONTAL_ALIGNMENT_BOTTOM
  11986. HORIZONTAL_ALIGNMENT_JUSTIFY
  11987. </member>
  11988. <member name="P:NPOI.HSSF.Record.TextRecord.VerticalAlignment">
  11989. Get the vertical alignment field for the Text record.
  11990. @return One of
  11991. VERTICAL_ALIGNMENT_TOP
  11992. VERTICAL_ALIGNMENT_CENTER
  11993. VERTICAL_ALIGNMENT_BOTTOM
  11994. VERTICAL_ALIGNMENT_JUSTIFY
  11995. </member>
  11996. <member name="P:NPOI.HSSF.Record.TextRecord.DisplayMode">
  11997. Get the Display mode field for the Text record.
  11998. @return One of
  11999. DISPLAY_MODE_TRANSPARENT
  12000. DISPLAY_MODE_OPAQUE
  12001. </member>
  12002. <member name="P:NPOI.HSSF.Record.TextRecord.RgbColor">
  12003. Get the rgbColor field for the Text record.
  12004. </member>
  12005. <member name="P:NPOI.HSSF.Record.TextRecord.X">
  12006. Get the x field for the Text record.
  12007. </member>
  12008. <member name="P:NPOI.HSSF.Record.TextRecord.Y">
  12009. Get the y field for the Text record.
  12010. </member>
  12011. <member name="P:NPOI.HSSF.Record.TextRecord.Width">
  12012. Set the width field for the Text record.
  12013. </member>
  12014. <member name="P:NPOI.HSSF.Record.TextRecord.Height">
  12015. Get the height field for the Text record.
  12016. </member>
  12017. <member name="P:NPOI.HSSF.Record.TextRecord.Options1">
  12018. Get the options1 field for the Text record.
  12019. </member>
  12020. <member name="P:NPOI.HSSF.Record.TextRecord.IndexOfColorValue">
  12021. Get the index of color value field for the Text record.
  12022. </member>
  12023. <member name="P:NPOI.HSSF.Record.TextRecord.Options2">
  12024. Get the options2 field for the Text record.
  12025. </member>
  12026. <member name="P:NPOI.HSSF.Record.TextRecord.TextRotation">
  12027. Get the text rotation field for the Text record.
  12028. </member>
  12029. <member name="P:NPOI.HSSF.Record.TextRecord.IsAutoColor">
  12030. true = automaticly selected colour, false = user-selected
  12031. @return the auto color field value.
  12032. </member>
  12033. <member name="P:NPOI.HSSF.Record.TextRecord.ShowKey">
  12034. true = draw legend
  12035. @return the show key field value.
  12036. </member>
  12037. <member name="P:NPOI.HSSF.Record.TextRecord.ShowValue">
  12038. false = text is category label
  12039. @return the show value field value.
  12040. </member>
  12041. <member name="P:NPOI.HSSF.Record.TextRecord.IsAutoGeneratedText">
  12042. @return the auto generated text field value.
  12043. </member>
  12044. <member name="P:NPOI.HSSF.Record.TextRecord.IsGenerated">
  12045. @return the generated field value.
  12046. </member>
  12047. <member name="P:NPOI.HSSF.Record.TextRecord.IsAutoLabelDeleted">
  12048. @return the auto label deleted field value.
  12049. </member>
  12050. <member name="P:NPOI.HSSF.Record.TextRecord.IsAutoBackground">
  12051. @return the auto background field value.
  12052. </member>
  12053. <member name="P:NPOI.HSSF.Record.TextRecord.ShowCategoryLabelAsPercentage">
  12054. @return the show category label as percentage field value.
  12055. </member>
  12056. <member name="P:NPOI.HSSF.Record.TextRecord.ShowValueAsPercentage">
  12057. @return the show value as percentage field value.
  12058. </member>
  12059. <member name="P:NPOI.HSSF.Record.TextRecord.ShowBubbleSizes">
  12060. @return the show bubble sizes field value.
  12061. </member>
  12062. <member name="P:NPOI.HSSF.Record.TextRecord.ShowLabel">
  12063. @return the show label field value.
  12064. </member>
  12065. <member name="P:NPOI.HSSF.Record.TextRecord.DataLabelPlacement">
  12066. @return the data label placement field value.
  12067. </member>
  12068. <member name="T:NPOI.HSSF.Record.TickRecord">
  12069. * The Tick record defines how tick marks and label positioning/formatting
  12070. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  12071. * Remove the record in src/records/definitions.
  12072. * @author Andrew C. Oliver(acoliver at apache.org)
  12073. </member>
  12074. <member name="M:NPOI.HSSF.Record.TickRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12075. Constructs a Tick record and Sets its fields appropriately.
  12076. @param in the RecordInputstream to Read the record from
  12077. </member>
  12078. <member name="P:NPOI.HSSF.Record.TickRecord.DataSize">
  12079. Size of record (exluding 4 byte header)
  12080. </member>
  12081. <member name="P:NPOI.HSSF.Record.TickRecord.MajorTickType">
  12082. Get the major tick type field for the Tick record.
  12083. </member>
  12084. <member name="P:NPOI.HSSF.Record.TickRecord.MinorTickType">
  12085. Get the minor tick type field for the Tick record.
  12086. </member>
  12087. <member name="P:NPOI.HSSF.Record.TickRecord.LabelPosition">
  12088. Get the label position field for the Tick record.
  12089. </member>
  12090. <member name="P:NPOI.HSSF.Record.TickRecord.Background">
  12091. Get the background field for the Tick record.
  12092. </member>
  12093. <member name="P:NPOI.HSSF.Record.TickRecord.LabelColorRgb">
  12094. Get the label color rgb field for the Tick record.
  12095. </member>
  12096. <member name="P:NPOI.HSSF.Record.TickRecord.Zero1">
  12097. Get the zero 1 field for the Tick record.
  12098. </member>
  12099. <member name="P:NPOI.HSSF.Record.TickRecord.Zero2">
  12100. Get the zero 2 field for the Tick record.
  12101. </member>
  12102. <member name="P:NPOI.HSSF.Record.TickRecord.Options">
  12103. Get the options field for the Tick record.
  12104. </member>
  12105. <member name="P:NPOI.HSSF.Record.TickRecord.TickColor">
  12106. Get the tick color field for the Tick record.
  12107. </member>
  12108. <member name="P:NPOI.HSSF.Record.TickRecord.Zero3">
  12109. Get the zero 3 field for the Tick record.
  12110. </member>
  12111. <member name="P:NPOI.HSSF.Record.TickRecord.IsAutoTextColor">
  12112. use the quote Unquote automatic color for text
  12113. @return the auto text color field value.
  12114. </member>
  12115. <member name="P:NPOI.HSSF.Record.TickRecord.IsAutoTextBackground">
  12116. use the quote Unquote automatic color for text background
  12117. @return the auto text background field value.
  12118. </member>
  12119. <member name="P:NPOI.HSSF.Record.TickRecord.Rotation">
  12120. rotate text (0=none, 1=normal, 2=90 degrees counterclockwise, 3=90 degrees clockwise)
  12121. @return the rotation field value.
  12122. </member>
  12123. <member name="P:NPOI.HSSF.Record.TickRecord.IsAutorotate">
  12124. automatically rotate the text
  12125. @return the autorotate field value.
  12126. </member>
  12127. <member name="T:NPOI.HSSF.Record.UnitsRecord">
  12128. * The Units record describes Units.
  12129. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  12130. * Remove the record in src/records/definitions.
  12131. * @author Glen Stampoultzis (glens at apache.org)
  12132. </member>
  12133. <member name="M:NPOI.HSSF.Record.UnitsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12134. Constructs a Units record and Sets its fields appropriately.
  12135. @param in the RecordInputstream to Read the record from
  12136. </member>
  12137. <member name="P:NPOI.HSSF.Record.UnitsRecord.DataSize">
  12138. Size of record (exluding 4 byte header)
  12139. </member>
  12140. <member name="P:NPOI.HSSF.Record.UnitsRecord.Units">
  12141. Get the Units field for the Units record.
  12142. </member>
  12143. <member name="T:NPOI.HSSF.Record.CodepageRecord">
  12144. Title: Codepage Record
  12145. <p>Description: the default characterset. for the workbook</p>
  12146. <p>REFERENCE: PG 293 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)</p>
  12147. <p>Use {@link CodePageUtil} to turn these values into Java code pages
  12148. to encode/decode strings.</p>
  12149. @version 2.0-pre
  12150. </member>
  12151. <member name="F:NPOI.HSSF.Record.CodepageRecord.CODEPAGE">
  12152. Excel 97+ (Biff 8) should always store strings as UTF-16LE or
  12153. compressed versions of that. As such, this should always be
  12154. 0x4b0 = UTF_16, except for files coming from older versions.
  12155. </member>
  12156. <member name="M:NPOI.HSSF.Record.CodepageRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12157. Constructs a CodepageRecord and Sets its fields appropriately
  12158. @param in the RecordInputstream to Read the record from
  12159. </member>
  12160. <member name="P:NPOI.HSSF.Record.CodepageRecord.Codepage">
  12161. Get the codepage for this workbook
  12162. @see #CODEPAGE
  12163. @return codepage - the codepage to Set
  12164. </member>
  12165. <member name="T:NPOI.HSSF.Record.ColumnInfoRecord">
  12166. Title: COLINFO Record<p/>
  12167. Description: Defines with width and formatting for a range of columns<p/>
  12168. REFERENCE: PG 293 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<p/>
  12169. @author Andrew C. Oliver (acoliver at apache dot org)
  12170. @version 2.0-pre
  12171. </member>
  12172. <member name="M:NPOI.HSSF.Record.ColumnInfoRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12173. Constructs a ColumnInfo record and Sets its fields appropriately
  12174. @param in the RecordInputstream to Read the record from
  12175. </member>
  12176. <member name="M:NPOI.HSSF.Record.ColumnInfoRecord.FormatMatches(NPOI.HSSF.Record.ColumnInfoRecord)">
  12177. @return true if the format, options and column width match
  12178. </member>
  12179. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.FirstColumn">
  12180. Get the first column this record defines formatting info for
  12181. @return the first column index (0-based)
  12182. </member>
  12183. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.LastColumn">
  12184. Get the last column this record defines formatting info for
  12185. @return the last column index (0-based)
  12186. </member>
  12187. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.ColumnWidth">
  12188. Get the columns' width in 1/256 of a Char width
  12189. @return column width
  12190. </member>
  12191. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.XFIndex">
  12192. Get the columns' default format info
  12193. @return the extended format index
  12194. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  12195. </member>
  12196. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.Options">
  12197. Get the options bitfield - use the bitSetters instead
  12198. @return the bitfield raw value
  12199. </member>
  12200. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.IsHidden">
  12201. Get whether or not these cells are hidden
  12202. @return whether the cells are hidden.
  12203. @see #SetOptions(short)
  12204. </member>
  12205. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.OutlineLevel">
  12206. Get the outline level for the cells
  12207. @see #SetOptions(short)
  12208. @return outline level for the cells
  12209. </member>
  12210. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.IsCollapsed">
  12211. Get whether the cells are collapsed
  12212. @return wether the cells are collapsed
  12213. @see #SetOptions(short)
  12214. </member>
  12215. <member name="T:NPOI.HSSF.Record.CommonObjectType">
  12216. * The common object data record is used to store all common preferences for an excel object.
  12217. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  12218. * Remove the record in src/records/definitions.
  12219. * @author Glen Stampoultzis (glens at apache.org)
  12220. </member>
  12221. <member name="M:NPOI.HSSF.Record.CommonObjectDataSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  12222. Constructs a CommonObjectData record and Sets its fields appropriately.
  12223. @param in the RecordInputstream to Read the record from
  12224. </member>
  12225. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.DataSize">
  12226. Size of record (exluding 4 byte header)
  12227. </member>
  12228. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.ObjectType">
  12229. Get the object type field for the CommonObjectData record.
  12230. </member>
  12231. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.ObjectId">
  12232. Get the object id field for the CommonObjectData record.
  12233. </member>
  12234. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.Option">
  12235. Get the option field for the CommonObjectData record.
  12236. </member>
  12237. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.Reserved1">
  12238. Get the reserved1 field for the CommonObjectData record.
  12239. </member>
  12240. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.Reserved2">
  12241. Get the reserved2 field for the CommonObjectData record.
  12242. </member>
  12243. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.Reserved3">
  12244. Get the reserved3 field for the CommonObjectData record.
  12245. </member>
  12246. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.IsLocked">
  12247. true if object is locked when sheet has been protected
  12248. @return the locked field value.
  12249. </member>
  12250. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.IsPrintable">
  12251. object appears when printed
  12252. @return the printable field value.
  12253. </member>
  12254. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.IsAutoFill">
  12255. whether object uses an automatic Fill style
  12256. @return the autoFill field value.
  12257. </member>
  12258. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.IsAutoline">
  12259. whether object uses an automatic line style
  12260. @return the autoline field value.
  12261. </member>
  12262. <!-- Badly formed XML comment ignored for member "T:NPOI.HSSF.Record.Common.ExtendedColor" -->
  12263. <member name="P:NPOI.HSSF.Record.Common.ExtendedColor.ColorIndex">
  12264. @return Palette color index, if type is {@link #TYPE_INDEXED}
  12265. </member>
  12266. <member name="P:NPOI.HSSF.Record.Common.ExtendedColor.RGBA">
  12267. @return Red Green Blue Alpha, if type is {@link #TYPE_RGB}
  12268. </member>
  12269. <member name="P:NPOI.HSSF.Record.Common.ExtendedColor.ThemeIndex">
  12270. @return Theme color type index, eg {@link #THEME_DARK_1}, if type is {@link #TYPE_THEMED}
  12271. </member>
  12272. <member name="P:NPOI.HSSF.Record.Common.ExtendedColor.Tint">
  12273. @return Tint and Shade value, between -1 and +1
  12274. </member>
  12275. <member name="T:NPOI.HSSF.Record.Common.FeatFormulaErr2">
  12276. FeatFormulaErr2 (Formula Evaluation Shared Feature) common record part
  12277. This record part specifies Formula Evaluation &amp; Error Ignoring data
  12278. for a sheet, stored as part of a Shared Feature. It can be found in
  12279. records such as {@link FeatRecord}.
  12280. For the full meanings of the flags, see pages 669 and 670
  12281. of the Excel binary file format documentation.
  12282. </member>
  12283. <member name="F:NPOI.HSSF.Record.Common.FeatFormulaErr2.errorCheck">
  12284. What errors we should ignore
  12285. </member>
  12286. <member name="T:NPOI.HSSF.Record.Common.FeatProtection">
  12287. Title: FeatProtection (Protection Shared Feature) common record part
  12288. This record part specifies Protection data for a sheet, stored
  12289. as part of a Shared Feature. It can be found in records such
  12290. as {@link FeatRecord}
  12291. </member>
  12292. <member name="F:NPOI.HSSF.Record.Common.FeatProtection.passwordVerifier">
  12293. 0 means no password. Otherwise indicates the
  12294. password verifier algorithm (same kind as
  12295. {@link PasswordRecord} and
  12296. {@link PasswordRev4Record})
  12297. </member>
  12298. <member name="T:NPOI.HSSF.Record.Common.FeatSmartTag">
  12299. Title: FeatSmartTag (Smart Tag Shared Feature) common record part
  12300. This record part specifies Smart Tag data for a sheet, stored as part
  12301. of a Shared Feature. It can be found in records such as {@link FeatRecord}.
  12302. It is made up of a hash, and a Set of Factoid Data that Makes up
  12303. the smart tags.
  12304. For more details, see page 669 of the Excel binary file
  12305. format documentation.
  12306. </member>
  12307. <member name="T:NPOI.HSSF.Record.Common.FtrHeader">
  12308. Title: FtrHeader (Future Record Header) common record part
  12309. This record part specifies a header for a Ftr (Future)
  12310. style record, which includes extra attributes above and
  12311. beyond those of a traditional record.
  12312. </member>
  12313. <member name="F:NPOI.HSSF.Record.Common.FtrHeader.recordType">
  12314. This MUST match the type on the Containing record
  12315. </member>
  12316. <member name="F:NPOI.HSSF.Record.Common.FtrHeader.grbitFrt">
  12317. This is a FrtFlags
  12318. </member>
  12319. <member name="F:NPOI.HSSF.Record.Common.FtrHeader.associatedRange">
  12320. The range of cells the parent record applies to, or 0 if N/A
  12321. </member>
  12322. <member name="T:NPOI.HSSF.Record.Common.IFutureRecord">
  12323. Title: Future Record, a newer (largely Excel 2007+) record
  12324. which Contains a Future Record Header ({@link FtrHeader})
  12325. </member>
  12326. <member name="T:NPOI.HSSF.Record.Common.SharedFeature">
  12327. Common Interface for all Shared Features
  12328. </member>
  12329. <member name="T:NPOI.HSSF.Record.UnicodeString">
  12330. Title: Unicode String<p/>
  12331. Description: Unicode String - just standard fields that are in several records.
  12332. It is considered more desirable then repeating it in all of them.<p/>
  12333. This is often called a XLUnicodeRichExtendedString in MS documentation.<p/>
  12334. REFERENCE: PG 264 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<p/>
  12335. REFERENCE: PG 951 Excel Binary File Format (.xls) Structure Specification v20091214
  12336. </member>
  12337. <member name="P:NPOI.HSSF.Record.UnicodeString.ExtRst.DataSize">
  12338. Returns our size, excluding our
  12339. 4 byte header
  12340. </member>
  12341. <member name="M:NPOI.HSSF.Record.UnicodeString.Equals(System.Object)">
  12342. Our handling of Equals is inconsistent with CompareTo. The trouble is because we don't truely understand
  12343. rich text fields yet it's difficult to make a sound comparison.
  12344. @param o The object to Compare.
  12345. @return true if the object is actually Equal.
  12346. </member>
  12347. <member name="M:NPOI.HSSF.Record.UnicodeString.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12348. construct a unicode string record and fill its fields, ID is ignored
  12349. @param in the RecordInputstream to read the record from
  12350. </member>
  12351. <member name="P:NPOI.HSSF.Record.UnicodeString.CharCount">
  12352. get the number of characters in the string,
  12353. as an un-wrapped int
  12354. @return number of characters
  12355. </member>
  12356. <member name="P:NPOI.HSSF.Record.UnicodeString.OptionFlags">
  12357. Get the option flags which among other things return if this is a 16-bit or
  12358. 8 bit string
  12359. @return optionflags bitmask
  12360. </member>
  12361. <member name="P:NPOI.HSSF.Record.UnicodeString.String">
  12362. @return the actual string this Contains as a java String object
  12363. </member>
  12364. <member name="M:NPOI.HSSF.Record.UnicodeString.AddFormatRun(NPOI.HSSF.Record.UnicodeString.FormatRun)">
  12365. Adds a font run to the formatted string.
  12366. If a font run exists at the current charcter location, then it is
  12367. Replaced with the font run to be Added.
  12368. </member>
  12369. <member name="M:NPOI.HSSF.Record.UnicodeString.SwapFontUse(System.Int16,System.Int16)">
  12370. Swaps all use in the string of one font index
  12371. for use of a different font index.
  12372. Normally only called when fonts have been
  12373. Removed / re-ordered
  12374. </member>
  12375. <member name="M:NPOI.HSSF.Record.UnicodeString.ToString">
  12376. unlike the real records we return the same as "getString()" rather than debug info
  12377. @see #getDebugInfo()
  12378. @return String value of the record
  12379. </member>
  12380. <member name="M:NPOI.HSSF.Record.UnicodeString.GetDebugInfo">
  12381. return a character representation of the fields of this record
  12382. @return String of output for biffviewer etc.
  12383. </member>
  12384. <member name="M:NPOI.HSSF.Record.UnicodeString.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  12385. Serialises out the String. There are special rules
  12386. about where we can and can't split onto
  12387. Continue records.
  12388. </member>
  12389. <member name="T:NPOI.HSSF.Record.ContinueFrt12Record">
  12390. <summary>
  12391. The ContinueFrt12 record specifies a continuation of the data in a preceding Future Record
  12392. Type record that has data longer than 8,224 bytes. Such records are split into several records.
  12393. The first section of the data appears in the base record and subsequent sections appear in
  12394. one or more ContinueFrt12 records that appear after the base record. The preceding base record
  12395. MUST contain a FrtRefHeader or a FrtHeader field.
  12396. </summary>
  12397. <remarks>
  12398. author: Antony liu (antony.apollo at gmail.com)
  12399. </remarks>
  12400. </member>
  12401. <member name="T:NPOI.HSSF.Record.ContinueRecord">
  12402. Title: Continue Record - Helper class used primarily for SST Records
  12403. Description: handles overflow for prior record in the input
  12404. stream; content Is tailored to that prior record
  12405. @author Marc Johnson (mjohnson at apache dot org)
  12406. @author Andrew C. Oliver (acoliver at apache dot org)
  12407. @author Csaba Nagy (ncsaba at yahoo dot com)
  12408. @version 2.0-pre
  12409. </member>
  12410. <member name="M:NPOI.HSSF.Record.ContinueRecord.#ctor">
  12411. default constructor
  12412. </member>
  12413. <member name="M:NPOI.HSSF.Record.ContinueRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12414. Main constructor -- kinda dummy because we don't validate or fill fields
  12415. @param in the RecordInputstream to Read the record from
  12416. </member>
  12417. <member name="M:NPOI.HSSF.Record.ContinueRecord.Write(System.Byte[],System.Int32,System.Nullable{System.Byte},System.Byte[])">
  12418. Writes the full encoding of a Continue record without making an instance
  12419. </member>
  12420. <member name="M:NPOI.HSSF.Record.ContinueRecord.Write(System.Byte[],System.Int32,System.Nullable{System.Byte},System.Byte[],System.Int32,System.Int32)">
  12421. @param initialDataByte (optional - often used for unicode flag).
  12422. If supplied, this will be written before srcData
  12423. @return the total number of bytes written
  12424. </member>
  12425. <member name="P:NPOI.HSSF.Record.ContinueRecord.Data">
  12426. Get the data for continuation
  12427. @return byte array containing all of the continued data
  12428. </member>
  12429. <member name="M:NPOI.HSSF.Record.ContinueRecord.ToString">
  12430. Debugging toString
  12431. @return string representation
  12432. </member>
  12433. <member name="M:NPOI.HSSF.Record.ContinueRecord.Clone">
  12434. Clone this record.
  12435. </member>
  12436. <member name="T:NPOI.HSSF.Record.Cont.ContinuableRecord">
  12437. Common superclass of all records that can produce {@link ContinueRecord}s while being Serialized.
  12438. @author Josh Micich
  12439. </member>
  12440. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecord.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  12441. Serializes this record's content to the supplied data output.<br/>
  12442. The standard BIFF header (ushort sid, ushort size) has been handled by the superclass, so
  12443. only BIFF data should be written by this method. Simple data types can be written with the
  12444. standard {@link LittleEndianOutput} methods. Methods from {@link ContinuableRecordOutput}
  12445. can be used to Serialize strings (with {@link ContinueRecord}s being written as required).
  12446. If necessary, implementors can explicitly start {@link ContinueRecord}s (regardless of the
  12447. amount of remaining space).
  12448. @param out a data output stream
  12449. </member>
  12450. <member name="P:NPOI.HSSF.Record.Cont.ContinuableRecord.RecordSize">
  12451. @return the total Length of the encoded record(s)
  12452. (Note - if any {@link ContinueRecord} is required, this result includes the
  12453. size of those too)
  12454. </member>
  12455. <member name="T:NPOI.HSSF.Record.Cont.ContinuableRecordInput">
  12456. A decorated {@link RecordInputStream} that can read primitive data types
  12457. (short, int, long, etc.) spanned across a {@link ContinueRecord } boundary.
  12458. <p>
  12459. Most records construct themselves from {@link RecordInputStream}.
  12460. This class assumes that a {@link ContinueRecord} record break always occurs at the type boundary,
  12461. however, it is not always so.
  12462. </p>
  12463. Two attachments to <a href="https://issues.apache.org/bugzilla/Show_bug.cgi?id=50779">Bugzilla 50779</a>
  12464. demonstrate that a CONTINUE break can appear right in between two bytes of a unicode character
  12465. or between two bytes of a <code>short</code>. The problematic portion of the data is
  12466. in a Asian Phonetic Settings Block (ExtRst) of a UnicodeString.
  12467. <p>
  12468. {@link RecordInputStream} greedily requests the bytes to be read and stumbles on such files with a
  12469. "Not enough data (1) to read requested (2) bytes" exception. The <code>ContinuableRecordInput</code>
  12470. class circumvents this "type boundary" rule and Reads data byte-by-byte rolling over CONTINUE if necessary.
  12471. </p>
  12472. <p>
  12473. YK: For now (March 2011) this class is only used to read
  12474. @link NPOI.HSSF.Record.Common.UnicodeString.ExtRst} blocks of a UnicodeString.
  12475. </p>
  12476. @author Yegor Kozlov
  12477. </member>
  12478. <member name="T:NPOI.HSSF.Record.Cont.ContinuableRecordOutput">
  12479. An augmented {@link LittleEndianOutput} used for serialization of {@link ContinuableRecord}s.
  12480. This class keeps track of how much remaining space is available in the current BIFF record and
  12481. can start new {@link ContinueRecord}s as required.
  12482. @author Josh Micich
  12483. </member>
  12484. <member name="P:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.TotalSize">
  12485. @return total number of bytes written so far (including all BIFF headers)
  12486. </member>
  12487. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.Terminate">
  12488. Terminates the last record (also updates its 'ushort size' field)
  12489. </member>
  12490. <member name="P:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.AvailableSpace">
  12491. @return number of remaining bytes of space in current record
  12492. </member>
  12493. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.WriteContinue">
  12494. Terminates the current record and starts a new {@link ContinueRecord} (regardless
  12495. of how much space is still available in the current record).
  12496. </member>
  12497. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.WriteStringData(System.String)">
  12498. Writes the 'optionFlags' byte and encoded character data of a unicode string. This includes:
  12499. <ul>
  12500. <li>byte optionFlags</li>
  12501. <li>encoded character data (in "ISO-8859-1" or "UTF-16LE" encoding)</li>
  12502. </ul>
  12503. Notes:
  12504. <ul>
  12505. <li>The value of the 'is16bitEncoded' flag is determined by the actual character data
  12506. of <c>text</c></li>
  12507. <li>The string options flag is never separated (by a {@link ContinueRecord}) from the
  12508. first chunk of character data it refers to.</li>
  12509. <li>The 'ushort Length' field is assumed to have been explicitly written earlier. Hence,
  12510. there may be an intervening {@link ContinueRecord}</li>
  12511. </ul>
  12512. </member>
  12513. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.WriteString(System.String,System.Int32,System.Int32)">
  12514. Writes a unicode string complete with header and character data. This includes:
  12515. <ul>
  12516. <li>ushort Length</li>
  12517. <li>byte optionFlags</li>
  12518. <li>ushort numberOfRichTextRuns (optional)</li>
  12519. <li>ushort extendedDataSize (optional)</li>
  12520. <li>encoded character data (in "ISO-8859-1" or "UTF-16LE" encoding)</li>
  12521. </ul>
  12522. The following bits of the 'optionFlags' byte will be set as appropriate:
  12523. <table border='1'>
  12524. <tr><th>Mask</th><th>Description</th></tr>
  12525. <tr><td>0x01</td><td>is16bitEncoded</td></tr>
  12526. <tr><td>0x04</td><td>hasExtendedData</td></tr>
  12527. <tr><td>0x08</td><td>isRichText</td></tr>
  12528. </table>
  12529. Notes:
  12530. <ul>
  12531. <li>The value of the 'is16bitEncoded' flag is determined by the actual character data
  12532. of <c>text</c></li>
  12533. <li>The string header fields are never separated (by a {@link ContinueRecord}) from the
  12534. first chunk of character data (i.e. the first character is always encoded in the same
  12535. record as the string header).</li>
  12536. </ul>
  12537. </member>
  12538. <member name="F:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.NOPOutput">
  12539. **
  12540. </member>
  12541. <member name="T:NPOI.HSSF.Record.Cont.UnknownLengthRecordOutput">
  12542. Allows the writing of BIFF records when the 'ushort size' header field is not known in advance.
  12543. When the client is finished writing data, it calls {@link #terminate()}, at which point this
  12544. class updates the 'ushort size' with its value.
  12545. @author Josh Micich
  12546. </member>
  12547. <member name="F:NPOI.HSSF.Record.Cont.UnknownLengthRecordOutput._dataSizeOutput">
  12548. for writing the 'ushort size' field once its value is known
  12549. </member>
  12550. <member name="P:NPOI.HSSF.Record.Cont.UnknownLengthRecordOutput.TotalSize">
  12551. includes 4 byte header
  12552. </member>
  12553. <member name="M:NPOI.HSSF.Record.Cont.UnknownLengthRecordOutput.Terminate">
  12554. Finishes writing the current record and updates 'ushort size' field.<br/>
  12555. After this method is called, only {@link #getTotalSize()} may be called.
  12556. </member>
  12557. <member name="T:NPOI.HSSF.Record.CountryRecord">
  12558. Title: Country Record (aka WIN.INI country)
  12559. Description: used for localization. Currently HSSF always Sets this to 1
  12560. and it seems to work fine even in Germany. (es geht's auch fuer Deutschland)
  12561. REFERENCE: PG 298 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12562. @author Andrew C. Oliver (acoliver at apache dot org)
  12563. @version 2.0-pre
  12564. </member>
  12565. <member name="M:NPOI.HSSF.Record.CountryRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12566. Constructs a CountryRecord and Sets its fields appropriately
  12567. @param in the RecordInputstream to Read the record from
  12568. </member>
  12569. <member name="P:NPOI.HSSF.Record.CountryRecord.DefaultCountry">
  12570. Gets the default country
  12571. @return country ID (1 = US)
  12572. </member>
  12573. <member name="P:NPOI.HSSF.Record.CountryRecord.CurrentCountry">
  12574. Gets the current country
  12575. @return country ID (1 = US)
  12576. </member>
  12577. <member name="T:NPOI.HSSF.Record.CRNCountRecord">
  12578. XCT ?CRN Count
  12579. REFERENCE: 5.114
  12580. @author Josh Micich
  12581. </member>
  12582. <member name="P:NPOI.HSSF.Record.CRNCountRecord.Sid">
  12583. return the non static version of the id for this record.
  12584. </member>
  12585. <member name="T:NPOI.HSSF.Record.CRNRecord">
  12586. Title: CRN
  12587. Description: This record stores the contents of an external cell or cell range
  12588. REFERENCE: 5.23
  12589. @author josh micich
  12590. </member>
  12591. <member name="P:NPOI.HSSF.Record.CRNRecord.Sid">
  12592. return the non static version of the id for this record.
  12593. </member>
  12594. <member name="T:NPOI.HSSF.Record.Crypto.Biff8DecryptingStream">
  12595. @author Josh Micich
  12596. </member>
  12597. <member name="M:NPOI.HSSF.Record.Crypto.Biff8DecryptingStream.ReadRecordSID">
  12598. Reads an unsigned short value without decrypting
  12599. </member>
  12600. <member name="M:NPOI.HSSF.Record.Crypto.Biff8DecryptingStream.ReadDataSize">
  12601. Reads an unsigned short value without decrypting
  12602. </member>
  12603. <member name="M:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey.Create(System.Byte[])">
  12604. Create using the default password and a specified docId
  12605. @param docId 16 bytes
  12606. </member>
  12607. <member name="M:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey.Validate(System.Byte[],System.Byte[])">
  12608. @return <c>true</c> if the keyDigest is compatible with the specified saltData and saltHash
  12609. </member>
  12610. <member name="M:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey.CreateRC4(System.Int32)">
  12611. The {@link RC4} instance needs to be Changed every 1024 bytes.
  12612. @param keyBlockNo used to seed the newly Created {@link RC4}
  12613. </member>
  12614. <member name="F:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey._userPasswordTLS">
  12615. Stores the BIFF8 encryption/decryption password for the current thread. This has been done
  12616. using a {@link ThreadLocal} in order to avoid further overloading the various public APIs
  12617. (e.g. {@link HSSFWorkbook}) that need this functionality.
  12618. </member>
  12619. <member name="P:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey.CurrentUserPassword">
  12620. @return the BIFF8 encryption/decryption password for the current thread.
  12621. <code>null</code> if it is currently unSet.
  12622. </member>
  12623. <member name="T:NPOI.HSSF.Record.Crypto.Biff8RC4">
  12624. Used for both encrypting and decrypting BIFF8 streams. The internal
  12625. {@link RC4} instance is renewed (re-keyed) every 1024 bytes.
  12626. @author Josh Micich
  12627. </member>
  12628. <member name="F:NPOI.HSSF.Record.Crypto.Biff8RC4._streamPos">
  12629. This field is used to keep track of when to change the {@link RC4}
  12630. instance. The change occurs every 1024 bytes. Every byte passed over is
  12631. counted.
  12632. </member>
  12633. <member name="M:NPOI.HSSF.Record.Crypto.Biff8RC4.IsNeverEncryptedRecord(System.Int32)">
  12634. TODO: Additionally, the lbPlyPos (position_of_BOF) field of the BoundSheet8 record MUST NOT be encrypted.
  12635. @return <c>true</c> if record type specified by <c>sid</c> is never encrypted
  12636. </member>
  12637. <member name="M:NPOI.HSSF.Record.Crypto.Biff8RC4.SkipTwoBytes">
  12638. Used when BIFF header fields (sid, size) are being Read. The internal
  12639. {@link RC4} instance must step even when unencrypted bytes are read
  12640. </member>
  12641. <member name="T:NPOI.HSSF.Record.Crypto.RC4">
  12642. Simple implementation of the alleged RC4 algorithm.
  12643. Inspired by <A HREF="http://en.wikipedia.org/wiki/RC4">wikipedia's RC4 article</A>
  12644. @author Josh Micich
  12645. </member>
  12646. <member name="P:NPOI.HSSF.Record.CustomField.Size">
  12647. @return The size of this field in bytes. This operation Is not valid
  12648. Until after the call to <c>FillField()</c>
  12649. </member>
  12650. <member name="M:NPOI.HSSF.Record.CustomField.FillField(NPOI.HSSF.Record.RecordInputStream)">
  12651. Populates this fields data from the byte array passed in1.
  12652. @param in the RecordInputstream to Read the record from
  12653. </member>
  12654. <member name="M:NPOI.HSSF.Record.CustomField.ToString(System.Text.StringBuilder)">
  12655. Appends the string representation of this field to the supplied
  12656. StringBuilder.
  12657. @param str The string buffer to Append to.
  12658. </member>
  12659. <member name="M:NPOI.HSSF.Record.CustomField.SerializeField(System.Int32,System.Byte[])">
  12660. Converts this field to it's byte array form.
  12661. @param offset The offset into the byte array to start writing to.
  12662. @param data The data array to Write to.
  12663. @return The number of bytes written.
  12664. </member>
  12665. <member name="T:NPOI.HSSF.Record.DateWindow1904Record">
  12666. Title: Date Window 1904 Flag record
  12667. Description: Flag specifying whether 1904 date windowing Is used.
  12668. (tick toc tick toc...BOOM!)
  12669. REFERENCE: PG 280 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12670. @author Andrew C. Oliver (acoliver at apache dot org)
  12671. @version 2.0-pre
  12672. </member>
  12673. <member name="M:NPOI.HSSF.Record.DateWindow1904Record.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12674. Constructs a DateWindow1904 record and Sets its fields appropriately.
  12675. @param in the RecordInputstream to Read the record from
  12676. </member>
  12677. <member name="P:NPOI.HSSF.Record.DateWindow1904Record.Windowing">
  12678. Gets whether or not to use 1904 date windowing (which means you'll be screwed in 2004)
  12679. @return window flag - 0/1 (false,true)
  12680. </member>
  12681. <member name="T:NPOI.HSSF.Record.DBCellRecord">
  12682. Title: DBCell Record
  12683. Description: Used by Excel and other MS apps to quickly Find rows in the sheets.
  12684. REFERENCE: PG 299/440 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12685. @author Andrew C. Oliver (acoliver at apache dot org)
  12686. @author Jason Height
  12687. @version 2.0-pre
  12688. </member>
  12689. <member name="M:NPOI.HSSF.Record.DBCellRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12690. Constructs a DBCellRecord and Sets its fields appropriately
  12691. @param in the RecordInputstream to Read the record from
  12692. </member>
  12693. <member name="M:NPOI.HSSF.Record.DBCellRecord.#ctor(System.Int32,System.Int16[])">
  12694. offset from the start of this DBCellRecord to the start of the first cell in
  12695. the next DBCell block.
  12696. </member>
  12697. <member name="P:NPOI.HSSF.Record.DBCellRecord.RowOffset">
  12698. Gets offset from the start of this DBCellRecord to the start of the first cell in
  12699. the next DBCell block.
  12700. @return rowoffset to the start of the first cell in the next DBCell block
  12701. </member>
  12702. <member name="M:NPOI.HSSF.Record.DBCellRecord.GetCellOffsetAt(System.Int32)">
  12703. return the cell offset in the array
  12704. @param index of the cell offset to retrieve
  12705. @return celloffset from the celloffset array
  12706. </member>
  12707. <member name="P:NPOI.HSSF.Record.DBCellRecord.NumCellOffsets">
  12708. Get the number of cell offsets in the celloffset array
  12709. @return number of cell offsets
  12710. </member>
  12711. <member name="M:NPOI.HSSF.Record.DBCellRecord.CalculateSizeOfRecords(System.Int32,System.Int32)">
  12712. @returns the size of the Group of <c>DBCellRecord</c>s needed to encode
  12713. the specified number of blocks and rows
  12714. </member>
  12715. <member name="T:NPOI.HSSF.Record.DConRefRecord">
  12716. DConRef records specify a range in a workbook (internal or external) that serves as a data source
  12717. for pivot tables or data consolidation.
  12718. Represents a <code>DConRef</code> Structure
  12719. <a href="http://msdn.microsoft.com/en-us/library/dd923854(office.12).aspx">[MS-XLS s.
  12720. 2.4.86]</a>, and the contained <code>DConFile</code> structure
  12721. <a href="http://msdn.microsoft.com/en-us/library/dd950157(office.12).aspx">
  12722. [MS-XLS s. 2.5.69]</a>. This in turn contains a <code>XLUnicodeStringNoCch</code>
  12723. <a href="http://msdn.microsoft.com/en-us/library/dd910585(office.12).aspx">
  12724. [MS-XLS s. 2.5.296]</a>.
  12725. <pre>
  12726. _______________________________
  12727. | DConRef |
  12728. (bytes) +-+-+-+-+-+-+-+-+-+-+...+-+-+-+-+
  12729. | ref |cch| stFile | un|
  12730. +-+-+-+-+-+-+-+-+-+-+...+-+-+-+-+
  12731. |
  12732. _________|_____________________
  12733. |DConFile / XLUnicodeStringNoCch|
  12734. +-+-+-+-+-+-+-+-+-+-+-+...+-+-+-+
  12735. (bits) |h| reserved | rgb |
  12736. +-+-+-+-+-+-+-+-+-+-+-+...+-+-+-+
  12737. </pre>
  12738. Where
  12739. <ul>
  12740. <li><code>DConFile.h = 0x00</code> if the characters in<code>rgb</code> are single byte, and
  12741. <code>DConFile.h = 0x01</code> if they are double byte. <br/>
  12742. If they are double byte, then<br/>
  12743. <ul>
  12744. <li> If it exists, the length of <code>DConRef.un = 2</code>. Otherwise it is 1.</li>
  12745. <li> The length of <code>DConFile.rgb = (2 * DConRef.cch)</code>. Otherwise it is equal to
  12746. <code>DConRef.cch</code></li>.
  12747. </ul>
  12748. </li>
  12749. <li><code>DConRef.rgb</code> starts with <code>0x01</code> if it is an external reference,
  12750. and with <code>0x02</code> if it is a self-reference.</li>
  12751. </ul>
  12752. At the moment this class is read-only.
  12753. @author Niklas Rehfeld
  12754. </member>
  12755. <member name="F:NPOI.HSSF.Record.DConRefRecord.sid">
  12756. The id of the record type,
  12757. <code>sid = {@value}</code>
  12758. </member>
  12759. <member name="F:NPOI.HSSF.Record.DConRefRecord.firstRow">
  12760. A RefU structure specifying the range of cells if this record is part of an SXTBL.
  12761. <a href="http://msdn.microsoft.com/en-us/library/dd920420(office.12).aspx">
  12762. [MS XLS s.2.5.211]</a>
  12763. </member>
  12764. <member name="F:NPOI.HSSF.Record.DConRefRecord.lastRow">
  12765. A RefU structure specifying the range of cells if this record is part of an SXTBL.
  12766. <a href="http://msdn.microsoft.com/en-us/library/dd920420(office.12).aspx">
  12767. [MS XLS s.2.5.211]</a>
  12768. </member>
  12769. <member name="F:NPOI.HSSF.Record.DConRefRecord.firstCol">
  12770. A RefU structure specifying the range of cells if this record is part of an SXTBL.
  12771. <a href="http://msdn.microsoft.com/en-us/library/dd920420(office.12).aspx">
  12772. [MS XLS s.2.5.211]</a>
  12773. </member>
  12774. <member name="F:NPOI.HSSF.Record.DConRefRecord.lastCol">
  12775. A RefU structure specifying the range of cells if this record is part of an SXTBL.
  12776. <a href="http://msdn.microsoft.com/en-us/library/dd920420(office.12).aspx">
  12777. [MS XLS s.2.5.211]</a>
  12778. </member>
  12779. <member name="F:NPOI.HSSF.Record.DConRefRecord.charCount">
  12780. the number of chars in the link
  12781. </member>
  12782. <member name="F:NPOI.HSSF.Record.DConRefRecord.charType">
  12783. the type of characters (single or double byte)
  12784. </member>
  12785. <member name="F:NPOI.HSSF.Record.DConRefRecord.path">
  12786. The link's path string. This is the <code>rgb</code> field of a
  12787. <code>XLUnicodeStringNoCch</code>. Therefore it will contain at least one leading special
  12788. character (0x01 or 0x02) and probably other ones.<p/>
  12789. @see <a href="http://msdn.microsoft.com/en-us/library/dd923491(office.12).aspx">
  12790. DConFile [MS-XLS s. 2.5.77]</a> and
  12791. <a href="http://msdn.microsoft.com/en-us/library/dd950157(office.12).aspx">
  12792. VirtualPath [MS-XLS s. 2.5.69]</a>
  12793. <p/>
  12794. </member>
  12795. <member name="F:NPOI.HSSF.Record.DConRefRecord._unused">
  12796. unused bits at the end, must be set to 0.
  12797. </member>
  12798. <member name="M:NPOI.HSSF.Record.DConRefRecord.#ctor(System.Byte[])">
  12799. Read constructor.
  12800. @param data byte array containing a DConRef Record, including the header.
  12801. </member>
  12802. <member name="M:NPOI.HSSF.Record.DConRefRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12803. Read Constructor.
  12804. @param inStream RecordInputStream containing a DConRefRecord structure.
  12805. </member>
  12806. <member name="P:NPOI.HSSF.Record.DConRefRecord.FirstColumn">
  12807. @return The first column of the range.
  12808. </member>
  12809. <member name="P:NPOI.HSSF.Record.DConRefRecord.FirstRow">
  12810. @return The first row of the range.
  12811. </member>
  12812. <member name="P:NPOI.HSSF.Record.DConRefRecord.LastColumn">
  12813. @return The last column of the range.
  12814. </member>
  12815. <member name="P:NPOI.HSSF.Record.DConRefRecord.LastRow">
  12816. @return The last row of the range.
  12817. </member>
  12818. <member name="M:NPOI.HSSF.Record.DConRefRecord.GetPath">
  12819. @return raw path byte array.
  12820. </member>
  12821. <member name="P:NPOI.HSSF.Record.DConRefRecord.ReadablePath">
  12822. @return the link's path, with the special characters stripped/replaced. May be null.
  12823. See MS-XLS 2.5.277 (VirtualPath)
  12824. </member>
  12825. <member name="P:NPOI.HSSF.Record.DConRefRecord.IsExternalRef">
  12826. Checks if the data source in this reference record is external to this sheet or internal.
  12827. @return true iff this is an external reference.
  12828. </member>
  12829. <member name="T:NPOI.HSSF.Record.DefaultColWidthRecord">
  12830. Title: Default Column Width Record
  12831. Description: Specifies the default width for columns that have no specific
  12832. width Set.
  12833. REFERENCE: PG 302 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12834. @author Andrew C. Oliver (acoliver at apache dot org)
  12835. @author Jason Height (jheight at chariot dot net dot au)
  12836. @version 2.0-pre
  12837. </member>
  12838. <member name="F:NPOI.HSSF.Record.DefaultColWidthRecord.DEFAULT_COLUMN_WIDTH">
  12839. The default column width is 8 characters
  12840. </member>
  12841. <member name="M:NPOI.HSSF.Record.DefaultColWidthRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12842. Constructs a DefaultColumnWidth record and Sets its fields appropriately.
  12843. @param in the RecordInputstream to Read the record from
  12844. </member>
  12845. <member name="P:NPOI.HSSF.Record.DefaultColWidthRecord.ColWidth">
  12846. Get the default column width
  12847. @return defaultwidth for columns
  12848. </member>
  12849. <member name="T:NPOI.HSSF.Record.DefaultRowHeightRecord">
  12850. Title: Default Row Height Record
  12851. Description: Row height for rows with Undefined or not explicitly defined
  12852. heights.
  12853. REFERENCE: PG 301 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12854. @author Andrew C. Oliver (acoliver at apache dot org)
  12855. @author Jason Height (jheight at chariot dot net dot au)
  12856. @version 2.0-pre
  12857. </member>
  12858. <member name="F:NPOI.HSSF.Record.DefaultRowHeightRecord.DEFAULT_ROW_HEIGHT">
  12859. The default row height for empty rows is 255 twips (255 / 20 == 12.75 points)
  12860. </member>
  12861. <member name="M:NPOI.HSSF.Record.DefaultRowHeightRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12862. <summary>
  12863. Constructs a DefaultRowHeight record and Sets its fields appropriately.
  12864. </summary>
  12865. <param name="in1">the RecordInputstream to Read the record from</param>
  12866. </member>
  12867. <member name="P:NPOI.HSSF.Record.DefaultRowHeightRecord.RowHeight">
  12868. <summary>
  12869. Get the default row height
  12870. </summary>
  12871. </member>
  12872. <member name="T:NPOI.HSSF.Record.DeltaRecord">
  12873. Title: Delta Record
  12874. Description: controls the accuracy of the calculations
  12875. REFERENCE: PG 303 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12876. @author Andrew C. Oliver (acoliver at apache dot org)
  12877. @author Jason Height (jheight at chariot dot net dot au)
  12878. @version 2.0-pre
  12879. </member>
  12880. <member name="M:NPOI.HSSF.Record.DeltaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12881. Constructs a Delta record and Sets its fields appropriately.
  12882. @param in the RecordInputstream to Read the record from
  12883. </member>
  12884. <member name="P:NPOI.HSSF.Record.DeltaRecord.MaxChange">
  12885. Get the maximum Change
  12886. @return maxChange - maximum rounding error
  12887. </member>
  12888. <member name="T:NPOI.HSSF.Record.DimensionsRecord">
  12889. Title: Dimensions Record
  12890. Description: provides the minumum and maximum bounds
  12891. of a sheet.
  12892. REFERENCE: PG 303 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12893. @author Andrew C. Oliver (acoliver at apache dot org)
  12894. @author Jason Height (jheight at chariot dot net dot au)
  12895. @version 2.0-pre
  12896. </member>
  12897. <member name="M:NPOI.HSSF.Record.DimensionsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12898. Constructs a Dimensions record and Sets its fields appropriately.
  12899. @param in the RecordInputstream to Read the record from
  12900. </member>
  12901. <member name="P:NPOI.HSSF.Record.DimensionsRecord.FirstRow">
  12902. Get the first row number for the sheet
  12903. @return row - first row on the sheet
  12904. </member>
  12905. <member name="P:NPOI.HSSF.Record.DimensionsRecord.LastRow">
  12906. Get the last row number for the sheet
  12907. @return row - last row on the sheet
  12908. </member>
  12909. <member name="P:NPOI.HSSF.Record.DimensionsRecord.FirstCol">
  12910. Get the first column number for the sheet
  12911. @return column - first column on the sheet
  12912. </member>
  12913. <member name="P:NPOI.HSSF.Record.DimensionsRecord.LastCol">
  12914. Get the last col number for the sheet
  12915. @return column - last column on the sheet
  12916. </member>
  12917. <member name="M:NPOI.HSSF.Record.DrawingGroupRecord.ProcessChildRecords">
  12918. Process the bytes into escher records.
  12919. (Not done by default in case we break things,
  12920. Unless you Set the "poi.deSerialize.escher"
  12921. system property)
  12922. </member>
  12923. <member name="P:NPOI.HSSF.Record.DrawingGroupRecord.RecordSize">
  12924. Size of record (including 4 byte headers for all sections)
  12925. </member>
  12926. <member name="T:NPOI.HSSF.Record.DrawingRecord">
  12927. DrawingRecord (0x00EC)<p/>
  12928. </member>
  12929. <member name="M:NPOI.HSSF.Record.DrawingRecord.Clone">
  12930. Cloning of drawing records must be executed through HSSFPatriarch, because all id's must be changed
  12931. @return cloned drawing records
  12932. </member>
  12933. <member name="T:NPOI.HSSF.Record.DrawingRecordForBiffViewer">
  12934. This Is purely for the biff viewer. During normal operations we don't want
  12935. to be seeing this.
  12936. </member>
  12937. <member name="T:NPOI.HSSF.Record.Drawing.OfficeArtFOPTEOPID">
  12938. <summary>
  12939. specifies the header for an entry in a property table
  12940. </summary>
  12941. </member>
  12942. <member name="P:NPOI.HSSF.Record.Drawing.OfficeArtFOPTEOPID.OpId">
  12943. <summary>
  12944. specifies the identifier of the property in this entry.
  12945. </summary>
  12946. </member>
  12947. <member name="P:NPOI.HSSF.Record.Drawing.OfficeArtFOPTEOPID.IsBlipId">
  12948. <summary>
  12949. whether the value in the op field is a BLIP identifier.
  12950. If this value equals 0x1, the value in the op field specifies the BLIP identifier
  12951. in the OfficeArtBStoreContainer record, as defined in section 2.2.20. If fComplex equals 0x1, this bit MUST be ignored.
  12952. </summary>
  12953. </member>
  12954. <member name="P:NPOI.HSSF.Record.Drawing.OfficeArtFOPTEOPID.IsComplex">
  12955. <summary>
  12956. specifies whether this property is a complex property.
  12957. If this value equals 0x1, the op field specifies the size of the data for this property, rather than the property data itself.
  12958. </summary>
  12959. </member>
  12960. <member name="T:NPOI.HSSF.Record.Drawing.OfficeArtRecordHeader">
  12961. <summary>
  12962. specifies the common record header for all the OfficeArt records.
  12963. </summary>
  12964. <remarks>
  12965. author: Antony liu (antony.apollo at gmail.com)
  12966. </remarks>
  12967. </member>
  12968. <member name="P:NPOI.HSSF.Record.Drawing.OfficeArtRecordHeader.Ver">
  12969. <summary>
  12970. specifies the version if the record is an atom. If the record is a container, this field MUST contain 0xF.
  12971. </summary>
  12972. </member>
  12973. <member name="P:NPOI.HSSF.Record.Drawing.OfficeArtRecordHeader.Instance">
  12974. <summary>
  12975. An unsigned integer that differentiates an atom from the other atoms that are contained in the record.
  12976. </summary>
  12977. </member>
  12978. <member name="P:NPOI.HSSF.Record.Drawing.OfficeArtRecordHeader.Type">
  12979. <summary>
  12980. specifies the type of the record. This value MUST be from 0xF000 through 0xFFFF, inclusive.
  12981. </summary>
  12982. </member>
  12983. <member name="P:NPOI.HSSF.Record.Drawing.OfficeArtRecordHeader.Len">
  12984. <summary>
  12985. that specifies the length, in bytes, of the record.
  12986. If the record is an atom, this value specifies the length of the atom, excluding the header.
  12987. If the record is a container, this value specifies the sum of the lengths of the atoms that
  12988. the record contains, plus the length of the record header for each atom.
  12989. </summary>
  12990. </member>
  12991. <member name="T:NPOI.HSSF.Record.DSFRecord">
  12992. Title: double Stream Flag Record
  12993. Description: tells if this Is a double stream file. (always no for HSSF generated files)
  12994. double Stream files contain both BIFF8 and BIFF7 workbooks.
  12995. REFERENCE: PG 305 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12996. @author Andrew C. Oliver (acoliver at apache dot org)
  12997. @version 2.0-pre
  12998. </member>
  12999. <member name="M:NPOI.HSSF.Record.DSFRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13000. Constructs a DBCellRecord and Sets its fields appropriately.
  13001. @param in the RecordInputstream to Read the record from
  13002. </member>
  13003. <member name="T:NPOI.HSSF.Record.DVALRecord">
  13004. Title: DATAVALIDATIONS Record
  13005. Description: used in data validation ;
  13006. This record Is the list header of all data validation records (0x01BE) in the current sheet.
  13007. @author Dragos Buleandra (dragos.buleandra@trade2b.ro)
  13008. </member>
  13009. <member name="F:NPOI.HSSF.Record.DVALRecord.field_1_options">
  13010. Options of the DVAL
  13011. </member>
  13012. <member name="F:NPOI.HSSF.Record.DVALRecord.field_2_horiz_pos">
  13013. Horizontal position of the dialog
  13014. </member>
  13015. <member name="F:NPOI.HSSF.Record.DVALRecord.field_3_vert_pos">
  13016. Vertical position of the dialog
  13017. </member>
  13018. <member name="F:NPOI.HSSF.Record.DVALRecord.field_cbo_id">
  13019. Object ID of the drop down arrow object for list boxes ;
  13020. in our case this will be always FFFF , Until
  13021. MSODrawingGroup and MSODrawing records are implemented
  13022. </member>
  13023. <member name="F:NPOI.HSSF.Record.DVALRecord.field_5_dv_no">
  13024. Number of following DV Records
  13025. </member>
  13026. <member name="M:NPOI.HSSF.Record.DVALRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13027. Constructs a DVAL record and Sets its fields appropriately.
  13028. @param in the RecordInputstream to Read the record from
  13029. </member>
  13030. <member name="P:NPOI.HSSF.Record.DVALRecord.Options">
  13031. @return the field_1_options
  13032. </member>
  13033. <member name="P:NPOI.HSSF.Record.DVALRecord.HorizontalPos">
  13034. @return the Horizontal position of the dialog
  13035. </member>
  13036. <member name="P:NPOI.HSSF.Record.DVALRecord.VerticalPos">
  13037. @return the the Vertical position of the dialog
  13038. </member>
  13039. <member name="P:NPOI.HSSF.Record.DVALRecord.ObjectID">
  13040. Get Object ID of the drop down arrow object for list boxes
  13041. </member>
  13042. <member name="P:NPOI.HSSF.Record.DVALRecord.DVRecNo">
  13043. Get number of following DV records
  13044. </member>
  13045. <member name="T:NPOI.HSSF.Record.DVRecord">
  13046. Title: DATAVALIDATION Record (0x01BE)<p/>
  13047. Description: This record stores data validation Settings and a list of cell ranges
  13048. which contain these Settings. The data validation Settings of a sheet
  13049. are stored in a sequential list of DV records. This list Is followed by
  13050. DVAL record(s)
  13051. @author Dragos Buleandra (dragos.buleandra@trade2b.ro)
  13052. @version 2.0-pre
  13053. </member>
  13054. <member name="F:NPOI.HSSF.Record.DVRecord._option_flags">
  13055. Option flags
  13056. </member>
  13057. <member name="F:NPOI.HSSF.Record.DVRecord._promptTitle">
  13058. Title of the prompt box
  13059. </member>
  13060. <member name="F:NPOI.HSSF.Record.DVRecord._errorTitle">
  13061. Title of the error box
  13062. </member>
  13063. <member name="F:NPOI.HSSF.Record.DVRecord._promptText">
  13064. Text of the prompt box
  13065. </member>
  13066. <member name="F:NPOI.HSSF.Record.DVRecord._errorText">
  13067. Text of the error box
  13068. </member>
  13069. <member name="F:NPOI.HSSF.Record.DVRecord._not_used_1">
  13070. Not used - Excel seems to always write 0x3FE0
  13071. </member>
  13072. <member name="F:NPOI.HSSF.Record.DVRecord._formula1">
  13073. Formula data for first condition (RPN token array without size field)
  13074. </member>
  13075. <member name="F:NPOI.HSSF.Record.DVRecord._not_used_2">
  13076. Not used - Excel seems to always write 0x0000
  13077. </member>
  13078. <member name="F:NPOI.HSSF.Record.DVRecord._formula2">
  13079. Formula data for second condition (RPN token array without size field)
  13080. </member>
  13081. <member name="F:NPOI.HSSF.Record.DVRecord._regions">
  13082. Cell range address list with all affected ranges
  13083. </member>
  13084. <member name="F:NPOI.HSSF.Record.DVRecord.opt_data_type">
  13085. Option flags field
  13086. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  13087. </member>
  13088. <member name="M:NPOI.HSSF.Record.DVRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13089. Constructs a DV record and Sets its fields appropriately.
  13090. @param in the RecordInputstream to Read the record from
  13091. </member>
  13092. <member name="M:NPOI.HSSF.Record.DVRecord.ResolveTitleText(System.String)">
  13093. When entered via the UI, Excel translates empty string into "\0"
  13094. While it is possible to encode the title/text as empty string (Excel doesn't exactly crash),
  13095. the resulting tool-tip text / message box looks wrong. It is best to do the same as the
  13096. Excel UI and encode 'not present' as "\0".
  13097. </member>
  13098. <member name="P:NPOI.HSSF.Record.DVRecord.DataType">
  13099. Get the condition data type
  13100. @return the condition data type
  13101. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  13102. </member>
  13103. <member name="P:NPOI.HSSF.Record.DVRecord.ErrorStyle">
  13104. Get the condition error style
  13105. @return the condition error style
  13106. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  13107. </member>
  13108. <member name="P:NPOI.HSSF.Record.DVRecord.ListExplicitFormula">
  13109. return true if in list validations the string list Is explicitly given in the formula, false otherwise
  13110. @return true if in list validations the string list Is explicitly given in the formula, false otherwise
  13111. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  13112. </member>
  13113. <member name="P:NPOI.HSSF.Record.DVRecord.EmptyCellAllowed">
  13114. return true if empty values are allowed in cells, false otherwise
  13115. @return if empty values are allowed in cells, false otherwise
  13116. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  13117. </member>
  13118. <member name="P:NPOI.HSSF.Record.DVRecord.SuppressDropdownArrow">
  13119. @return <code>true</code> if drop down arrow should be suppressed when list validation is
  13120. used, <code>false</code> otherwise
  13121. </member>
  13122. <member name="P:NPOI.HSSF.Record.DVRecord.ShowPromptOnCellSelected">
  13123. return true if a prompt window should appear when cell Is selected, false otherwise
  13124. @return if a prompt window should appear when cell Is selected, false otherwise
  13125. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  13126. </member>
  13127. <member name="P:NPOI.HSSF.Record.DVRecord.ShowErrorOnInvalidValue">
  13128. return true if an error window should appear when an invalid value Is entered in the cell, false otherwise
  13129. @return if an error window should appear when an invalid value Is entered in the cell, false otherwise
  13130. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  13131. </member>
  13132. <member name="P:NPOI.HSSF.Record.DVRecord.ConditionOperator">
  13133. Get the condition operator
  13134. @return the condition operator
  13135. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  13136. </member>
  13137. <member name="P:NPOI.HSSF.Record.DVRecord.OptionFlags">
  13138. Gets the option flags field.
  13139. @return options - the option flags field
  13140. </member>
  13141. <member name="M:NPOI.HSSF.Record.DVRecord.Clone">
  13142. Clones the object. Uses serialisation, as the
  13143. contents are somewhat complex
  13144. </member>
  13145. <member name="T:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord">
  13146. A sub-record within the OBJ record which stores a reference to an object
  13147. stored in a Separate entry within the OLE2 compound file.
  13148. @author Daniel Noll
  13149. </member>
  13150. <member name="F:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord.field_2_refPtg">
  13151. either an area or a cell ref
  13152. </member>
  13153. <member name="F:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord.field_4_unknownByte">
  13154. Formulas often have a single non-zero trailing byte.
  13155. This is in a similar position to he pre-streamId padding
  13156. It is unknown if the value is important (it seems to mirror a value a few bytes earlier)
  13157. </member>
  13158. <member name="M:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  13159. Constructs an EmbeddedObjectRef record and Sets its fields appropriately.
  13160. @param in the record input stream.
  13161. </member>
  13162. <member name="P:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord.StreamId">
  13163. Gets the stream ID containing the actual data. The data itself
  13164. can be found under a top-level directory entry in the OLE2 filesystem
  13165. under the name "MBD<var>xxxxxxxx</var>" where <var>xxxxxxxx</var> is
  13166. this ID converted into hex (in big endian order, funnily enough.)
  13167. @return the data stream ID. Possibly <c>null</c>
  13168. </member>
  13169. <member name="T:NPOI.HSSF.Record.EndSubRecord">
  13170. * The end data record is used to denote the end of the subrecords.
  13171. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  13172. * Remove the record in src/records/definitions.
  13173. * @author Glen Stampoultzis (glens at apache.org)
  13174. </member>
  13175. <member name="M:NPOI.HSSF.Record.EndSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  13176. Constructs a End record and Sets its fields appropriately.
  13177. @param in the RecordInputstream to Read the record from
  13178. </member>
  13179. <member name="P:NPOI.HSSF.Record.EndSubRecord.DataSize">
  13180. Size of record (exluding 4 byte header)
  13181. </member>
  13182. <member name="T:NPOI.HSSF.Record.EOFRecord">
  13183. End Of File record.
  13184. Description: Marks the end of records belonging to a particular object in the
  13185. HSSF File
  13186. REFERENCE: PG 307 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13187. @author Andrew C. Oliver (acoliver at apache dot org)
  13188. @author Jason Height (jheight at chariot dot net dot au)
  13189. @version 2.0-pre
  13190. </member>
  13191. <member name="M:NPOI.HSSF.Record.EOFRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13192. Constructs a EOFRecord record and Sets its fields appropriately.
  13193. @param in the RecordInputstream to Read the record from
  13194. </member>
  13195. <member name="T:NPOI.HSSF.Record.EscherAggregate">
  13196. This class Is used to aggregate the MSODRAWING and OBJ record
  13197. combinations. This Is necessary due to the bizare way in which
  13198. these records are Serialized. What happens Is that you Get a
  13199. combination of MSODRAWING -> OBJ -> MSODRAWING -> OBJ records
  13200. but the escher records are Serialized _across_ the MSODRAWING
  13201. records.
  13202. It Gets even worse when you start looking at TXO records.
  13203. So what we do with this class Is aggregate lazily. That Is
  13204. we don't aggregate the MSODRAWING -> OBJ records Unless we
  13205. need to modify them.
  13206. At first document contains 4 types of records which belong to drawing layer.
  13207. There are can be such sequence of record:
  13208. <p/>
  13209. DrawingRecord
  13210. ContinueRecord
  13211. ...
  13212. ContinueRecord
  13213. ObjRecord | TextObjectRecord
  13214. .....
  13215. ContinueRecord
  13216. ...
  13217. ContinueRecord
  13218. ObjRecord | TextObjectRecord
  13219. NoteRecord
  13220. ...
  13221. NoteRecord
  13222. <p/>
  13223. To work with shapes we have to read data from Drawing and Continue records into single array of bytes and
  13224. build escher(office art) records tree from this array.
  13225. Each shape in drawing layer matches corresponding ObjRecord
  13226. Each textbox matches corresponding TextObjectRecord
  13227. <p/>
  13228. ObjRecord contains information about shape. Thus each ObjRecord corresponds EscherContainerRecord(SPGR)
  13229. <p/>
  13230. EscherAggrefate contains also NoteRecords
  13231. NoteRecords must be serial
  13232. @author Glen Stampoultzis (glens at apache.org)
  13233. </member>
  13234. <member name="F:NPOI.HSSF.Record.EscherAggregate.shapeToObj">
  13235. Maps shape container objects to their OBJ records
  13236. </member>
  13237. <member name="F:NPOI.HSSF.Record.EscherAggregate.tailRec">
  13238. list of "tail" records that need to be Serialized after all drawing Group records
  13239. </member>
  13240. <member name="P:NPOI.HSSF.Record.EscherAggregate.Sid">
  13241. @return Returns the current sid.
  13242. </member>
  13243. <member name="M:NPOI.HSSF.Record.EscherAggregate.ToString">
  13244. Calculates the string representation of this record. This Is
  13245. simply a dump of all the records.
  13246. </member>
  13247. <member name="M:NPOI.HSSF.Record.EscherAggregate.ToXml(System.String)">
  13248. Calculates the xml representation of this record. This is
  13249. simply a dump of all the records.
  13250. @param tab - string which must be added before each line (used by default '\t')
  13251. @return xml representation of the all aggregated records
  13252. </member>
  13253. <member name="M:NPOI.HSSF.Record.EscherAggregate.IsDrawingLayerRecord(System.Int16)">
  13254. @param sid - record sid we want to check if it belongs to drawing layer
  13255. @return true if record is instance of DrawingRecord or ContinueRecord or ObjRecord or TextObjRecord
  13256. </member>
  13257. <member name="M:NPOI.HSSF.Record.EscherAggregate.CreateAggregate(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase},System.Int32)">
  13258. Collapses the drawing records into an aggregate.
  13259. read Drawing, Obj, TxtObj, Note and Continue records into single byte array,
  13260. create Escher tree from byte array, create map &lt;EscherRecord, Record&gt;
  13261. @param records - list of all records inside sheet
  13262. @param locFirstDrawingRecord - location of the first DrawingRecord inside sheet
  13263. @return new EscherAggregate create from all aggregated records which belong to drawing layer
  13264. </member>
  13265. <member name="M:NPOI.HSSF.Record.EscherAggregate.Serialize(System.Int32,System.Byte[])">
  13266. Serializes this aggregate to a byte array. Since this Is an aggregate
  13267. record it will effectively Serialize the aggregated records.
  13268. @param offset The offset into the start of the array.
  13269. @param data The byte array to Serialize to.
  13270. @return The number of bytes Serialized.
  13271. </member>
  13272. <member name="M:NPOI.HSSF.Record.EscherAggregate.WriteDataIntoDrawingRecord(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
  13273. @param drawingData - escher records saved into single byte array
  13274. @param writtenEscherBytes - count of bytes already saved into drawing records (we should know it to decide create
  13275. drawing or continue record)
  13276. @param pos current position of data array
  13277. @param data - array of bytes where drawing records must be serialized
  13278. @param i - number of shape, saved into data array
  13279. @return offset of data array after serialization
  13280. </member>
  13281. <member name="M:NPOI.HSSF.Record.EscherAggregate.GetEscherRecordSize(System.Collections.Generic.List{NPOI.DDF.EscherRecord})">
  13282. How many bytes do the raw escher records contain.
  13283. @param records List of escher records
  13284. @return the number of bytes
  13285. </member>
  13286. <member name="M:NPOI.HSSF.Record.EscherAggregate.GetSid(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase},System.Int32)">
  13287. @param records list of records to look into
  13288. @param loc - location of the record which sid must be returned
  13289. @return sid of the record with selected location
  13290. </member>
  13291. <member name="P:NPOI.HSSF.Record.EscherAggregate.RecordSize">
  13292. @return record size, including header size of obj, text, note, drawing, continue records
  13293. </member>
  13294. <member name="M:NPOI.HSSF.Record.EscherAggregate.BuildBaseTree">
  13295. create base tree with such structure:
  13296. EscherDgContainer
  13297. -EscherSpgrContainer
  13298. --EscherSpContainer
  13299. ---EscherSpRecord
  13300. ---EscherSpgrRecord
  13301. ---EscherSpRecord
  13302. -EscherDgRecord
  13303. id of DgRecord and SpRecord are empty and must be set later by HSSFPatriarch
  13304. </member>
  13305. <member name="M:NPOI.HSSF.Record.EscherAggregate.Children(System.Byte[],System.Int16,System.Int32)">
  13306. Unused since this Is an aggregate record. Use CreateAggregate().
  13307. @see #CreateAggregate
  13308. </member>
  13309. <member name="M:NPOI.HSSF.Record.EscherAggregate.GetEscherChild(NPOI.DDF.EscherContainerRecord,System.Int32)">
  13310. Converts the Records into UserModel
  13311. objects on the bound HSSFPatriarch
  13312. </member>
  13313. <member name="M:NPOI.HSSF.Record.EscherAggregate.AssociateShapeToObjRecord(NPOI.DDF.EscherRecord,NPOI.HSSF.Record.Record)">
  13314. <summary>
  13315. Associates an escher record to an OBJ record or a TXO record.
  13316. </summary>
  13317. <param name="r">ClientData or Textbox record</param>
  13318. <param name="objRecord">Obj or TextObj record</param>
  13319. </member>
  13320. <member name="M:NPOI.HSSF.Record.EscherAggregate.RemoveShapeToObjRecord(NPOI.DDF.EscherRecord)">
  13321. <summary>
  13322. Remove echerRecord and associated to it Obj or TextObj record
  13323. </summary>
  13324. <param name="rec">clientData or textbox record to be removed</param>
  13325. </member>
  13326. <member name="P:NPOI.HSSF.Record.EscherAggregate.TailRecords">
  13327. @return unmodifiable copy of tail records. We need to access them when building shapes.
  13328. Every HSSFComment shape has a link to a NoteRecord from the tailRec collection.
  13329. </member>
  13330. <member name="M:NPOI.HSSF.Record.EscherAggregate.GetNoteRecordByObj(NPOI.HSSF.Record.ObjRecord)">
  13331. @param obj - ObjRecord with id == NoteRecord.id
  13332. @return null if note record is not found else returns note record with id == obj.id
  13333. </member>
  13334. <member name="T:NPOI.HSSF.Record.ExtendedFormatRecord">
  13335. Title: Extended Format Record
  13336. Description: Probably one of the more complex records. There are two breeds:
  13337. Style and Cell.
  13338. It should be noted that fields in the extended format record are
  13339. somewhat arbitrary. Almost all of the fields are bit-level, but
  13340. we name them as best as possible by functional Group. In some
  13341. places this Is better than others.
  13342. REFERENCE: PG 426 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13343. @author Andrew C. Oliver (acoliver at apache dot org)
  13344. @version 2.0-pre
  13345. </member>
  13346. <member name="M:NPOI.HSSF.Record.ExtendedFormatRecord.#ctor">
  13347. Constructor ExtendedFormatRecord
  13348. </member>
  13349. <member name="M:NPOI.HSSF.Record.ExtendedFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13350. Constructs an ExtendedFormat record and Sets its fields appropriately.
  13351. @param in the RecordInputstream to Read the record from
  13352. </member>
  13353. <member name="M:NPOI.HSSF.Record.ExtendedFormatRecord.CloneStyleFrom(NPOI.HSSF.Record.ExtendedFormatRecord)">
  13354. Clones all the style information from another
  13355. ExtendedFormatRecord, onto this one. This
  13356. will then hold all the same style options.
  13357. If The source ExtendedFormatRecord comes from
  13358. a different Workbook, you will need to sort
  13359. out the font and format indicies yourself!
  13360. </member>
  13361. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FontIndex">
  13362. <summary>
  13363. Get the index to the FONT record (which font to use 0 based)
  13364. </summary>
  13365. </member>
  13366. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FormatIndex">
  13367. <summary>
  13368. Get the index to the Format record (which FORMAT to use 0-based)
  13369. </summary>
  13370. </member>
  13371. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.CellOptions">
  13372. <summary>
  13373. Gets the options bitmask - you can also use corresponding option bit Getters
  13374. (see other methods that reference this one)
  13375. </summary>
  13376. </member>
  13377. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsLocked">
  13378. <summary>
  13379. Get whether the cell Is locked or not
  13380. </summary>
  13381. </member>
  13382. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsHidden">
  13383. <summary>
  13384. Get whether the cell Is hidden or not
  13385. </summary>
  13386. </member>
  13387. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.XFType">
  13388. <summary>
  13389. Get whether the cell Is a cell or style XFRecord
  13390. </summary>
  13391. </member>
  13392. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord._123Prefix">
  13393. <summary>
  13394. Get some old holdover from lotus 123. Who cares, its all over for Lotus.
  13395. RIP Lotus.
  13396. </summary>
  13397. </member>
  13398. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.ParentIndex">
  13399. <summary>
  13400. for cell XF types this Is the parent style (usually 0/normal). For
  13401. style this should be NULL.
  13402. </summary>
  13403. </member>
  13404. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AlignmentOptions">
  13405. <summary>
  13406. Get the alignment options bitmask. See corresponding bitGetter methods
  13407. that reference this one.
  13408. </summary>
  13409. </member>
  13410. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.Alignment">
  13411. <summary>
  13412. Get the horizontal alignment of the cell.
  13413. </summary>
  13414. </member>
  13415. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.WrapText">
  13416. <summary>
  13417. Get whether to wrap the text in the cell
  13418. </summary>
  13419. </member>
  13420. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.VerticalAlignment">
  13421. <summary>
  13422. Get the vertical alignment of text in the cell
  13423. </summary>
  13424. </member>
  13425. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.JustifyLast">
  13426. <summary>
  13427. Docs just say this Is for far east versions.. (I'm guessing it
  13428. justifies for right-to-left Read languages)
  13429. </summary>
  13430. </member>
  13431. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.Rotation">
  13432. <summary>
  13433. Get the degree of rotation. (I've not actually seen this used anywhere)
  13434. </summary>
  13435. </member>
  13436. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IndentionOptions">
  13437. <summary>
  13438. Get the indent options bitmask (see corresponding bit Getters that reference
  13439. this field)
  13440. </summary>
  13441. </member>
  13442. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.Indent">
  13443. <summary>
  13444. Get indention (not sure of the Units, think its spaces)
  13445. </summary>
  13446. </member>
  13447. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.ShrinkToFit">
  13448. <summary>
  13449. Get whether to shrink the text to fit
  13450. </summary>
  13451. </member>
  13452. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.MergeCells">
  13453. <summary>
  13454. Get whether to merge cells
  13455. </summary>
  13456. </member>
  13457. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.ReadingOrder">
  13458. <summary>
  13459. Get the Reading order for far east versions (0 - Context, 1 - Left to right,
  13460. 2 - right to left) - We could use some help with support for the far east.
  13461. </summary>
  13462. </member>
  13463. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentFormat">
  13464. <summary>
  13465. Get whether or not to use the format in this XF instead of the parent XF.
  13466. </summary>
  13467. </member>
  13468. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentFont">
  13469. <summary>
  13470. Get whether or not to use the font in this XF instead of the parent XF.
  13471. </summary>
  13472. </member>
  13473. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentAlignment">
  13474. <summary>
  13475. Get whether or not to use the alignment in this XF instead of the parent XF.
  13476. </summary>
  13477. </member>
  13478. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentBorder">
  13479. <summary>
  13480. Get whether or not to use the border in this XF instead of the parent XF.
  13481. </summary>
  13482. </member>
  13483. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentPattern">
  13484. <summary>
  13485. Get whether or not to use the pattern in this XF instead of the parent XF.
  13486. (foregrount/background)
  13487. </summary>
  13488. </member>
  13489. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentCellOptions">
  13490. <summary>
  13491. Get whether or not to use the locking/hidden in this XF instead of the parent XF.
  13492. </summary>
  13493. </member>
  13494. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderOptions">
  13495. <summary>
  13496. Get the border options bitmask (see the corresponding bit Getter methods
  13497. that reference back to this one)
  13498. </summary>
  13499. </member>
  13500. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderLeft">
  13501. <summary>
  13502. Get the borderline style for the left border
  13503. </summary>
  13504. </member>
  13505. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderRight">
  13506. <summary>
  13507. Get the borderline style for the right border
  13508. </summary>
  13509. </member>
  13510. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderTop">
  13511. <summary>
  13512. Get the borderline style for the top border
  13513. </summary>
  13514. </member>
  13515. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderBottom">
  13516. <summary>
  13517. Get the borderline style for the bottom border
  13518. </summary>
  13519. </member>
  13520. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.PaletteOptions">
  13521. <summary>
  13522. Get the palette options bitmask (see the individual bit Getter methods that
  13523. reference this one)
  13524. </summary>
  13525. </member>
  13526. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.LeftBorderPaletteIdx">
  13527. <summary>
  13528. Get the palette index for the left border color
  13529. </summary>
  13530. </member>
  13531. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.RightBorderPaletteIdx">
  13532. <summary>
  13533. Get the palette index for the right border color
  13534. </summary>
  13535. </member>
  13536. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AdtlPaletteOptions">
  13537. <summary>
  13538. Get the Additional palette options bitmask (see individual bit Getter methods
  13539. that reference this method)
  13540. </summary>
  13541. </member>
  13542. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.TopBorderPaletteIdx">
  13543. <summary>
  13544. Get the palette index for the top border
  13545. </summary>
  13546. </member>
  13547. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BottomBorderPaletteIdx">
  13548. <summary>
  13549. Get the palette index for the bottom border
  13550. </summary>
  13551. </member>
  13552. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AdtlDiagBorderPaletteIdx">
  13553. <summary>
  13554. Get for diagonal borders
  13555. </summary>
  13556. </member>
  13557. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AdtlDiagLineStyle">
  13558. <summary>
  13559. Get the diagonal border line style
  13560. </summary>
  13561. </member>
  13562. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.Diagonal">
  13563. <summary>
  13564. Not sure what this Is for (maybe Fill lines?) 1 = down, 2 = up, 3 = both, 0 for none..
  13565. </summary>
  13566. </member>
  13567. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AdtlFillPattern">
  13568. <summary>
  13569. Get the Additional Fill pattern
  13570. </summary>
  13571. </member>
  13572. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FillPaletteOptions">
  13573. <summary>
  13574. Get the Fill palette options bitmask (see indivdual bit Getters that
  13575. reference this method)
  13576. </summary>
  13577. </member>
  13578. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FillForeground">
  13579. <summary>
  13580. Get the foreground palette color index
  13581. </summary>
  13582. </member>
  13583. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FillBackground">
  13584. <summary>
  13585. Get the background palette color index
  13586. </summary>
  13587. </member>
  13588. <member name="M:NPOI.HSSF.Record.ExtendedFormatRecord.Equals(System.Object)">
  13589. Will consider two different records with the same
  13590. contents as Equals, as the various indexes
  13591. that matter are embedded in the records
  13592. </member>
  13593. <member name="T:NPOI.HSSF.Record.ExternalNameRecord">
  13594. EXTERNALNAME<p/>
  13595. @author Josh Micich
  13596. </member>
  13597. <member name="F:NPOI.HSSF.Record.ExternalNameRecord._ddeValues">
  13598. 'rgoper' / 'Last received results of the DDE link'
  13599. (seems to be only applicable to DDE links)<br/>
  13600. Logically this is a 2-D array, which has been flattened into 1-D array here.
  13601. </member>
  13602. <member name="F:NPOI.HSSF.Record.ExternalNameRecord._nColumns">
  13603. (logical) number of columns in the {@link #_ddeValues} array
  13604. </member>
  13605. <member name="F:NPOI.HSSF.Record.ExternalNameRecord._nRows">
  13606. (logical) number of rows in the {@link #_ddeValues} array
  13607. </member>
  13608. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.IsBuiltInName">
  13609. Convenience Function to determine if the name Is a built-in name
  13610. </member>
  13611. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.IsAutomaticLink">
  13612. For OLE and DDE, links can be either 'automatic' or 'manual'
  13613. </member>
  13614. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.IsPicureLink">
  13615. only for OLE and DDE
  13616. </member>
  13617. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.IsStdDocumentNameIdentifier">
  13618. DDE links only. If <c>true</c>, this denotes the 'StdDocumentName'
  13619. </member>
  13620. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.Text">
  13621. @return the standard String representation of this name
  13622. </member>
  13623. <member name="F:NPOI.HSSF.Record.RefSubRecord._extBookIndex">
  13624. index to External Book Block (which starts with a EXTERNALBOOK record)
  13625. </member>
  13626. <member name="M:NPOI.HSSF.Record.RefSubRecord.#ctor(System.Int32,System.Int32,System.Int32)">
  13627. a Constructor for making new sub record
  13628. </member>
  13629. <member name="M:NPOI.HSSF.Record.RefSubRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13630. @param in the RecordInputstream to Read the record from
  13631. </member>
  13632. <member name="M:NPOI.HSSF.Record.RefSubRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  13633. called by the class that is responsible for writing this sucker.
  13634. Subclasses should implement this so that their data is passed back in a
  13635. byte array.
  13636. @param offset to begin writing at
  13637. @param data byte array containing instance data
  13638. @return number of bytes written
  13639. </member>
  13640. <member name="T:NPOI.HSSF.Record.ExternSheetRecord">
  13641. Title: Extern Sheet
  13642. Description: A List of Inndexes to SupBook
  13643. REFERENCE:
  13644. @author Libin Roman (Vista Portal LDT. Developer)
  13645. @version 1.0-pre
  13646. </member>
  13647. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13648. Constructs a Extern Sheet record and Sets its fields appropriately.
  13649. @param in the RecordInputstream to Read the record from
  13650. </member>
  13651. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.AddRef(System.Int32,System.Int32,System.Int32)">
  13652. Add a zero-based reference to a {@link org.apache.poi.hssf.record.SupBookRecord}.
  13653. <p>
  13654. If the type of the SupBook record is same-sheet referencing, Add-In referencing,
  13655. DDE data source referencing, or OLE data source referencing,
  13656. then no scope is specified and this value <em>MUST</em> be -2. Otherwise,
  13657. the scope must be set as follows:
  13658. <ol>
  13659. <li><code>-2</code> Workbook-level reference that applies to the entire workbook.</li>
  13660. <li><code>-1</code> Sheet-level reference. </li>
  13661. <li><code>&gt;=0</code> Sheet-level reference. This specifies the first sheet in the reference.
  13662. <p>
  13663. If the SupBook type is unused or external workbook referencing,
  13664. then this value specifies the zero-based index of an external sheet name,
  13665. see {@link org.apache.poi.hssf.record.SupBookRecord#getSheetNames()}.
  13666. This referenced string specifies the name of the first sheet within the external workbook that is in scope.
  13667. This sheet MUST be a worksheet or macro sheet.
  13668. </p>
  13669. <p>
  13670. If the supporting link type is self-referencing, then this value specifies the zero-based index of a
  13671. {@link org.apache.poi.hssf.record.BoundSheetRecord} record in the workbook stream that specifies
  13672. the first sheet within the scope of this reference. This sheet MUST be a worksheet or a macro sheet.
  13673. </p>
  13674. </li>
  13675. </ol></p>
  13676. @param firstSheetIndex the scope, must be -2 for add-in references
  13677. @param lastSheetIndex the scope, must be -2 for add-in references
  13678. @return index of newly added ref
  13679. </member>
  13680. <member name="P:NPOI.HSSF.Record.ExternSheetRecord.NumOfREFRecords">
  13681. returns the number of REF Records, which is in model
  13682. @return number of REF records
  13683. </member>
  13684. <member name="P:NPOI.HSSF.Record.ExternSheetRecord.NumOfRefs">
  13685. @return number of REF structures
  13686. </member>
  13687. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.AddREFRecord(NPOI.HSSF.Record.RefSubRecord)">
  13688. Adds REF struct (ExternSheetSubRecord)
  13689. @param rec REF struct
  13690. </member>
  13691. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.GetExtbookIndexFromRefIndex(System.Int32)">
  13692. Returns the index of the SupBookRecord for this index
  13693. </member>
  13694. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.FindRefIndexFromExtBookIndex(System.Int32)">
  13695. @return -1 if not found
  13696. </member>
  13697. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.GetFirstSheetIndexFromRefIndex(System.Int32)">
  13698. Returns the first sheet that the reference applies to, or
  13699. -1 if the referenced sheet can't be found, or -2 if the
  13700. reference is workbook scoped.
  13701. </member>
  13702. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.GetLastSheetIndexFromRefIndex(System.Int32)">
  13703. Returns the last sheet that the reference applies to, or
  13704. -1 if the referenced sheet can't be found, or -2 if the
  13705. reference is workbook scoped.
  13706. For a single sheet reference, the first and last should be
  13707. the same.
  13708. </member>
  13709. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  13710. called by the class that Is responsible for writing this sucker.
  13711. Subclasses should implement this so that their data Is passed back in a
  13712. byte array.
  13713. @param offset to begin writing at
  13714. @param data byte array containing instance data
  13715. @return number of bytes written
  13716. </member>
  13717. <member name="P:NPOI.HSSF.Record.ExternSheetRecord.Sid">
  13718. return the non static version of the id for this record.
  13719. </member>
  13720. <member name="T:NPOI.HSSF.Record.ExternSheetSubRecord">
  13721. Title: A sub Record for Extern Sheet
  13722. Description: Defines a named range within a workbook.
  13723. REFERENCE:
  13724. @author Libin Roman (Vista Portal LDT. Developer)
  13725. @version 1.0-pre
  13726. </member>
  13727. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.#ctor">
  13728. a Constractor for making new sub record
  13729. </member>
  13730. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13731. Constructs a Extern Sheet Sub Record record and Sets its fields appropriately.
  13732. @param in the RecordInputstream to Read the record from
  13733. </member>
  13734. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.SetIndexToSupBook(System.Int16)">
  13735. Sets the Index to the sup book
  13736. @param index sup book index
  13737. </member>
  13738. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.GetIndexToSupBook">
  13739. Gets the index to sup book
  13740. @return sup book index
  13741. </member>
  13742. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.SetIndexToFirstSupBook(System.Int16)">
  13743. Sets the index to first sheet in supbook
  13744. @param index index to first sheet
  13745. </member>
  13746. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.GetIndexToFirstSupBook">
  13747. Gets the index to first sheet from supbook
  13748. @return index to first supbook
  13749. </member>
  13750. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.SetIndexToLastSupBook(System.Int16)">
  13751. Sets the index to last sheet in supbook
  13752. @param index index to last sheet
  13753. </member>
  13754. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.GetIndexToLastSupBook">
  13755. Gets the index to last sheet in supbook
  13756. @return index to last supbook
  13757. </member>
  13758. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.Serialize(System.Int32,System.Byte[])">
  13759. called by the class that Is responsible for writing this sucker.
  13760. Subclasses should implement this so that their data Is passed back in a
  13761. byte array.
  13762. @param offset to begin writing at
  13763. @param data byte array containing instance data
  13764. @return number of bytes written
  13765. </member>
  13766. <member name="P:NPOI.HSSF.Record.ExternSheetSubRecord.RecordSize">
  13767. returns the record size
  13768. </member>
  13769. <member name="P:NPOI.HSSF.Record.ExternSheetSubRecord.Sid">
  13770. return the non static version of the id for this record.
  13771. </member>
  13772. <member name="T:NPOI.HSSF.Record.InfoSubRecord">
  13773. Extended SST table info subrecord
  13774. Contains the elements of "info" in the SST's array field
  13775. @author Andrew C. Oliver (acoliver at apache dot org)
  13776. @version 2.0-pre
  13777. @see org.apache.poi.hssf.record.ExtSSTRecord
  13778. </member>
  13779. <member name="M:NPOI.HSSF.Record.InfoSubRecord.#ctor(System.Int32,System.Int32)">
  13780. Creates new ExtSSTInfoSubRecord
  13781. </member>
  13782. <member name="T:NPOI.HSSF.Record.ExtSSTRecord">
  13783. Title: Extended Static String Table
  13784. Description: This record Is used for a quick Lookup into the SST record. This
  13785. record breaks the SST table into a Set of buckets. The offsets
  13786. to these buckets within the SST record are kept as well as the
  13787. position relative to the start of the SST record.
  13788. REFERENCE: PG 313 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13789. @author Andrew C. Oliver (acoliver at apache dot org)
  13790. @author Jason Height (jheight at apache dot org)
  13791. @version 2.0-pre
  13792. @see org.apache.poi.hssf.record.ExtSSTInfoSubRecord
  13793. </member>
  13794. <member name="M:NPOI.HSSF.Record.ExtSSTRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13795. Constructs a EOFRecord record and Sets its fields appropriately.
  13796. @param in the RecordInputstream to Read the record from
  13797. </member>
  13798. <member name="P:NPOI.HSSF.Record.ExtSSTRecord.DataSize">
  13799. Returns the size of this record
  13800. </member>
  13801. <member name="M:NPOI.HSSF.Record.ExtSSTRecord.GetRecordSizeForStrings(System.Int32)">
  13802. Given a number of strings (in the sst), returns the size of the extsst record
  13803. </member>
  13804. <member name="T:NPOI.HSSF.Record.FeatHdrRecord">
  13805. Title: FeatHdr (Feature Header) Record
  13806. This record specifies common information for Shared Features, and
  13807. specifies the beginning of a collection of records to define them.
  13808. The collection of data (Globals Substream ABNF, macro sheet substream
  13809. ABNF or worksheet substream ABNF) specifies Shared Feature data.
  13810. </member>
  13811. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.SHAREDFEATURES_ISFPROTECTION">
  13812. Specifies the enhanced protection type. Used to protect a
  13813. shared workbook by restricting access to some areas of it
  13814. </member>
  13815. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.SHAREDFEATURES_ISFFEC2">
  13816. Specifies that formula errors should be ignored
  13817. </member>
  13818. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.SHAREDFEATURES_ISFFACTOID">
  13819. Specifies the smart tag type. Recognises certain
  13820. types of entries (proper names, dates/times etc) and
  13821. flags them for action
  13822. </member>
  13823. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.SHAREDFEATURES_ISFLIST">
  13824. Specifies the shared list type. Used for a table
  13825. within a sheet
  13826. </member>
  13827. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.cbHdrData">
  13828. 0x00000000 = rgbHdrData not present
  13829. 0xffffffff = rgbHdrData present
  13830. </member>
  13831. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.rgbHdrData">
  13832. We need a BOFRecord to make sense of this...
  13833. </member>
  13834. <member name="T:NPOI.HSSF.Record.FeatRecord">
  13835. Title: Feat (Feature) Record
  13836. This record specifies Shared Features data. It is normally paired
  13837. up with a {@link FeatHdrRecord}.
  13838. </member>
  13839. <member name="F:NPOI.HSSF.Record.FeatRecord.isf_sharedFeatureType">
  13840. See SHAREDFEATURES_* on {@link FeatHdrRecord}
  13841. </member>
  13842. <member name="F:NPOI.HSSF.Record.FeatRecord.cbFeatData">
  13843. Only matters if type is ISFFEC2
  13844. </member>
  13845. <member name="F:NPOI.HSSF.Record.FeatRecord.sharedFeature">
  13846. Contents depends on isf_sharedFeatureType :
  13847. ISFPROTECTION -> FeatProtection
  13848. ISFFEC2 -> FeatFormulaErr2
  13849. ISFFACTOID -> FeatSmartTag
  13850. </member>
  13851. <!-- Badly formed XML comment ignored for member "T:NPOI.HSSF.Record.FilePassRecord" -->
  13852. <member name="M:NPOI.HSSF.Record.FilePassRecord.Rc4KeyData.Clone">
  13853. <summary>
  13854. </summary>
  13855. <returns>Rc4KeyData</returns>
  13856. </member>
  13857. <member name="F:NPOI.HSSF.Record.FilePassRecord.XorKeyData._key">
  13858. key (2 bytes): An unsigned integer that specifies the obfuscation key.
  13859. See [MS-OFFCRYPTO], 2.3.6.2 section, the first step of Initializing XOR
  13860. array where it describes the generation of 16-bit XorKey value.
  13861. </member>
  13862. <member name="F:NPOI.HSSF.Record.FilePassRecord.XorKeyData._verifier">
  13863. verificationBytes (2 bytes): An unsigned integer that specifies
  13864. the password verification identifier.
  13865. </member>
  13866. <member name="M:NPOI.HSSF.Record.FilePassRecord.XorKeyData.Clone">
  13867. <summary>
  13868. </summary>
  13869. <returns>XorKeyData</returns>
  13870. </member>
  13871. <member name="M:NPOI.HSSF.Record.FilePassRecord.Clone">
  13872. <summary>
  13873. </summary>
  13874. <returns>FilePassRecord</returns>
  13875. </member>
  13876. <member name="T:NPOI.HSSF.Record.FileSharingRecord">
  13877. Title: FILESHARING
  13878. Description: stores the encrypted Readonly for a workbook (Write protect)
  13879. This functionality Is accessed from the options dialog box available when performing 'Save As'.<p/>
  13880. REFERENCE: PG 314 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<p/>
  13881. @author Andrew C. Oliver (acoliver at apache dot org)
  13882. </member>
  13883. <member name="M:NPOI.HSSF.Record.FileSharingRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13884. Constructs a FileSharing record and Sets its fields appropriately.
  13885. @param in the RecordInputstream to Read the record from
  13886. </member>
  13887. <member name="P:NPOI.HSSF.Record.FileSharingRecord.ReadOnly">
  13888. Get the Readonly
  13889. @return short representing if this Is Read only (1 = true)
  13890. </member>
  13891. <member name="P:NPOI.HSSF.Record.FileSharingRecord.Password">
  13892. @returns password hashed with hashPassword() (very lame)
  13893. </member>
  13894. <member name="P:NPOI.HSSF.Record.FileSharingRecord.Username">
  13895. @returns username of the user that Created the file
  13896. </member>
  13897. <member name="M:NPOI.HSSF.Record.FileSharingRecord.Clone">
  13898. Clone this record.
  13899. </member>
  13900. <member name="T:NPOI.HSSF.Record.FnGroupCountRecord">
  13901. Title: Function Group Count Record
  13902. Description: Number of built in function Groups in the current version of the
  13903. SpReadsheet (probably only used on Windoze)
  13904. REFERENCE: PG 315 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13905. @author Andrew C. Oliver (acoliver at apache dot org)
  13906. @version 2.0-pre
  13907. </member>
  13908. <member name="F:NPOI.HSSF.Record.FnGroupCountRecord.COUNT">
  13909. suggested default (14 dec)
  13910. </member>
  13911. <member name="M:NPOI.HSSF.Record.FnGroupCountRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13912. Constructs a FnGroupCount record and Sets its fields appropriately.
  13913. @param in the RecordInputstream to Read the record from
  13914. </member>
  13915. <member name="P:NPOI.HSSF.Record.FnGroupCountRecord.Count">
  13916. Get the number of built-in functions
  13917. @return number of built-in functions
  13918. </member>
  13919. <member name="T:NPOI.HSSF.Record.FontRecord">
  13920. Title: Font Record - descrbes a font in the workbook (index = 0-3,5-infinity - skip 4)
  13921. Description: An element in the Font Table
  13922. REFERENCE: PG 315 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13923. @author Andrew C. Oliver (acoliver at apache dot org)
  13924. @version 2.0-pre
  13925. </member>
  13926. <member name="M:NPOI.HSSF.Record.FontRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13927. Constructs a Font record and Sets its fields appropriately.
  13928. @param in the RecordInputstream to Read the record from
  13929. </member>
  13930. <member name="M:NPOI.HSSF.Record.FontRecord.CloneStyleFrom(NPOI.HSSF.Record.FontRecord)">
  13931. Clones all the font style information from another
  13932. FontRecord, onto this one. This
  13933. will then hold all the same font style options.
  13934. </member>
  13935. <member name="P:NPOI.HSSF.Record.FontRecord.IsItalic">
  13936. Set the font to be italics or not
  13937. @param italics - whether the font Is italics or not
  13938. @see #SetAttributes(short)
  13939. </member>
  13940. <member name="P:NPOI.HSSF.Record.FontRecord.IsStrikeout">
  13941. Set the font to be stricken out or not
  13942. @param strike - whether the font Is stricken out or not
  13943. @see #SetAttributes(short)
  13944. </member>
  13945. <member name="P:NPOI.HSSF.Record.FontRecord.IsMacoutlined">
  13946. whether to use the mac outline font style thing (mac only) - Some mac person
  13947. should comment this instead of me doing it (since I have no idea)
  13948. @param mac - whether to do that mac font outline thing or not
  13949. @see #SetAttributes(short)
  13950. </member>
  13951. <member name="P:NPOI.HSSF.Record.FontRecord.IsMacshadowed">
  13952. whether to use the mac shado font style thing (mac only) - Some mac person
  13953. should comment this instead of me doing it (since I have no idea)
  13954. @param mac - whether to do that mac font shadow thing or not
  13955. @see #SetAttributes(short)
  13956. </member>
  13957. <member name="P:NPOI.HSSF.Record.FontRecord.Underline">
  13958. Set the type of Underlining for the font
  13959. </member>
  13960. <member name="P:NPOI.HSSF.Record.FontRecord.Family">
  13961. Set the font family (TODO)
  13962. @param f family
  13963. </member>
  13964. <member name="P:NPOI.HSSF.Record.FontRecord.Charset">
  13965. Set the Char Set
  13966. @param charSet - CharSet
  13967. </member>
  13968. <member name="P:NPOI.HSSF.Record.FontRecord.FontName">
  13969. Set the name of the font
  13970. @param fn - name of the font (i.e. "Arial")
  13971. </member>
  13972. <member name="P:NPOI.HSSF.Record.FontRecord.FontHeight">
  13973. Gets the height of the font in 1/20th point Units
  13974. @return fontheight (in points/20)
  13975. </member>
  13976. <member name="P:NPOI.HSSF.Record.FontRecord.Attributes">
  13977. Get the font attributes (see individual bit Getters that reference this method)
  13978. @return attribute - the bitmask
  13979. </member>
  13980. <member name="P:NPOI.HSSF.Record.FontRecord.ColorPaletteIndex">
  13981. Get the font's color palette index
  13982. @return cpi - font color index
  13983. </member>
  13984. <member name="P:NPOI.HSSF.Record.FontRecord.BoldWeight">
  13985. Get the bold weight for this font (100-1000dec or 0x64-0x3e8). Default Is
  13986. 0x190 for normal and 0x2bc for bold
  13987. @return bw - a number between 100-1000 for the fonts "boldness"
  13988. </member>
  13989. <member name="P:NPOI.HSSF.Record.FontRecord.SuperSubScript">
  13990. Get the type of base or subscript for the font
  13991. @return base or subscript option
  13992. </member>
  13993. <member name="M:NPOI.HSSF.Record.FontRecord.SameProperties(NPOI.HSSF.Record.FontRecord)">
  13994. Does this FontRecord have all the same font
  13995. properties as the supplied FontRecord?
  13996. Note that {@link #equals(Object)} will check
  13997. for exact objects, while this will check
  13998. for exact contents, because normally the
  13999. font record's position makes a big
  14000. difference too.
  14001. </member>
  14002. <member name="M:NPOI.HSSF.Record.FontRecord.Equals(System.Object)">
  14003. Only returns two for the same exact object -
  14004. creating a second FontRecord with the same
  14005. properties won't be considered equal, as
  14006. the record's position in the record stream
  14007. matters.
  14008. </member>
  14009. <member name="T:NPOI.HSSF.Record.FooterRecord">
  14010. Title: Footer Record
  14011. Description: Specifies the footer for a sheet
  14012. REFERENCE: PG 317 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14013. @author Andrew C. Oliver (acoliver at apache dot org)
  14014. @author Shawn Laubach (slaubach at apache dot org) Modified 3/14/02
  14015. @author Jason Height (jheight at chariot dot net dot au)
  14016. @version 2.0-pre
  14017. </member>
  14018. <member name="M:NPOI.HSSF.Record.FooterRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14019. <summary>
  14020. Initializes a new instance of the <see cref="T:NPOI.HSSF.Record.FooterRecord"/> class.
  14021. </summary>
  14022. <param name="in1">the RecordInputstream to Read the record from</param>
  14023. </member>
  14024. <member name="M:NPOI.HSSF.Record.FooterRecord.ToString">
  14025. <summary>
  14026. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  14027. </summary>
  14028. <returns>
  14029. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  14030. </returns>
  14031. </member>
  14032. <member name="P:NPOI.HSSF.Record.FooterRecord.Sid">
  14033. <summary>
  14034. </summary>
  14035. <value></value>
  14036. return the non static version of the id for this record.
  14037. </member>
  14038. <member name="T:NPOI.HSSF.Record.FormatRecord">
  14039. Title: Format Record
  14040. Description: describes a number format -- those goofy strings like $(#,###)
  14041. REFERENCE: PG 317 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14042. @author Andrew C. Oliver (acoliver at apache dot org)
  14043. @author Shawn M. Laubach (slaubach at apache dot org)
  14044. @version 2.0-pre
  14045. </member>
  14046. <member name="M:NPOI.HSSF.Record.FormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14047. Constructs a Format record and Sets its fields appropriately.
  14048. @param in the RecordInputstream to Read the record from
  14049. </member>
  14050. <member name="P:NPOI.HSSF.Record.FormatRecord.IndexCode">
  14051. Get the format index code (for built in formats)
  14052. @return the format index code
  14053. @see org.apache.poi.hssf.model.Workbook
  14054. </member>
  14055. <member name="P:NPOI.HSSF.Record.FormatRecord.FormatString">
  14056. Get the format string
  14057. @return the format string
  14058. </member>
  14059. <member name="T:NPOI.HSSF.Record.SpecialCachedValue">
  14060. Manages the cached formula result values of other types besides numeric.
  14061. Excel encodes the same 8 bytes that would be field_4_value with various NaN
  14062. values that are decoded/encoded by this class.
  14063. </member>
  14064. <member name="F:NPOI.HSSF.Record.SpecialCachedValue.BIT_MARKER">
  14065. deliberately chosen by Excel in order to encode other values within Double NaNs
  14066. </member>
  14067. <member name="M:NPOI.HSSF.Record.SpecialCachedValue.Create(System.Int64)">
  14068. @return <c>null</c> if the double value encoded by <c>valueLongBits</c>
  14069. is a normal (non NaN) double value.
  14070. </member>
  14071. <member name="T:NPOI.HSSF.Record.FormulaRecord">
  14072. Formula Record.
  14073. REFERENCE: PG 317/444 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14074. @author Andrew C. Oliver (acoliver at apache dot org)
  14075. @author Jason Height (jheight at chariot dot net dot au)
  14076. @version 2.0-pre
  14077. </member>
  14078. <member name="F:NPOI.HSSF.Record.FormulaRecord.specialCachedValue">
  14079. Since the NaN support seems sketchy (different constants) we'll store and spit it out directly
  14080. </member>
  14081. <member name="M:NPOI.HSSF.Record.FormulaRecord.#ctor">
  14082. Creates new FormulaRecord
  14083. </member>
  14084. <member name="M:NPOI.HSSF.Record.FormulaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14085. Constructs a Formula record and Sets its fields appropriately.
  14086. Note - id must be 0x06 (NOT 0x406 see MSKB #Q184647 for an
  14087. "explanation of this bug in the documentation) or an exception
  14088. will be throw upon validation
  14089. @param in the RecordInputstream to Read the record from
  14090. </member>
  14091. <member name="P:NPOI.HSSF.Record.FormulaRecord.HasCachedResultString">
  14092. @return <c>true</c> if this {@link FormulaRecord} is followed by a
  14093. {@link StringRecord} representing the cached text result of the formula
  14094. evaluation.
  14095. </member>
  14096. <member name="P:NPOI.HSSF.Record.FormulaRecord.Value">
  14097. Get the calculated value of the formula
  14098. @return calculated value
  14099. </member>
  14100. <member name="P:NPOI.HSSF.Record.FormulaRecord.Options">
  14101. Get the option flags
  14102. @return bitmask
  14103. </member>
  14104. <member name="P:NPOI.HSSF.Record.FormulaRecord.ParsedExpression">
  14105. Get the stack as a list
  14106. @return list of tokens (casts stack to a list and returns it!)
  14107. this method can return null Is we are Unable to Create Ptgs from
  14108. existing excel file
  14109. callers should Check for null!
  14110. </member>
  14111. <member name="M:NPOI.HSSF.Record.FtCblsSubRecord.#ctor">
  14112. Construct a new <code>FtCblsSubRecord</code> and
  14113. fill its data with the default values
  14114. </member>
  14115. <member name="M:NPOI.HSSF.Record.FtCblsSubRecord.ToString">
  14116. Convert this record to string.
  14117. Used by BiffViewer and other utilities.
  14118. </member>
  14119. <member name="M:NPOI.HSSF.Record.FtCblsSubRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  14120. Serialize the record data into the supplied array of bytes
  14121. @param out the stream to serialize into
  14122. </member>
  14123. <member name="P:NPOI.HSSF.Record.FtCblsSubRecord.Sid">
  14124. @return id of this record.
  14125. </member>
  14126. <member name="T:NPOI.HSSF.Record.FtCfSubRecord">
  14127. The FtCf structure specifies the clipboard format of the picture-type Obj record Containing this FtCf.
  14128. </member>
  14129. <member name="F:NPOI.HSSF.Record.FtCfSubRecord.METAFILE_BIT">
  14130. Specifies the format of the picture is an enhanced metafile.
  14131. </member>
  14132. <member name="F:NPOI.HSSF.Record.FtCfSubRecord.BITMAP_BIT">
  14133. Specifies the format of the picture is a bitmap.
  14134. </member>
  14135. <member name="F:NPOI.HSSF.Record.FtCfSubRecord.UNSPECIFIED_BIT">
  14136. Specifies the picture is in an unspecified format that is
  14137. neither and enhanced metafile nor a bitmap.
  14138. </member>
  14139. <member name="M:NPOI.HSSF.Record.FtCfSubRecord.#ctor">
  14140. Construct a new <code>FtPioGrbitSubRecord</code> and
  14141. fill its data with the default values
  14142. </member>
  14143. <member name="M:NPOI.HSSF.Record.FtCfSubRecord.ToString">
  14144. Convert this record to string.
  14145. Used by BiffViewer and other utilities.
  14146. </member>
  14147. <member name="M:NPOI.HSSF.Record.FtCfSubRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  14148. Serialize the record data into the supplied array of bytes
  14149. @param out the stream to serialize into
  14150. </member>
  14151. <member name="P:NPOI.HSSF.Record.FtCfSubRecord.Sid">
  14152. @return id of this record.
  14153. </member>
  14154. <member name="T:NPOI.HSSF.Record.FtPioGrbitSubRecord">
  14155. This structure appears as part of an Obj record that represents image display properties.
  14156. </member>
  14157. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.AUTO_PICT_BIT">
  14158. A bit that specifies whether the picture's aspect ratio is preserved when rendered in
  14159. different views (Normal view, Page Break Preview view, Page Layout view and printing).
  14160. </member>
  14161. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.DDE_BIT">
  14162. A bit that specifies whether the pictFmla field of the Obj record that Contains
  14163. this FtPioGrbit specifies a DDE reference.
  14164. </member>
  14165. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.PRINT_CALC_BIT">
  14166. A bit that specifies whether this object is expected to be updated on print to
  14167. reflect the values in the cell associated with the object.
  14168. </member>
  14169. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.ICON_BIT">
  14170. A bit that specifies whether the picture is displayed as an icon.
  14171. </member>
  14172. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.CTL_BIT">
  14173. A bit that specifies whether this object is an ActiveX control.
  14174. It MUST NOT be the case that both fCtl and fDde are equal to 1.
  14175. </member>
  14176. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.PRSTM_BIT">
  14177. A bit that specifies whether the object data are stored in an
  14178. embedding storage (= 0) or in the controls stream (ctls) (= 1).
  14179. </member>
  14180. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.CAMERA_BIT">
  14181. A bit that specifies whether this is a camera picture.
  14182. </member>
  14183. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.DEFAULT_SIZE_BIT">
  14184. A bit that specifies whether this picture's size has been explicitly Set.
  14185. 0 = picture size has been explicitly Set, 1 = has not been Set
  14186. </member>
  14187. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.AUTO_LOAD_BIT">
  14188. A bit that specifies whether the OLE server for the object is called
  14189. to load the object's data automatically when the parent workbook is opened.
  14190. </member>
  14191. <member name="M:NPOI.HSSF.Record.FtPioGrbitSubRecord.#ctor">
  14192. Construct a new <code>FtPioGrbitSubRecord</code> and
  14193. fill its data with the default values
  14194. </member>
  14195. <member name="M:NPOI.HSSF.Record.FtPioGrbitSubRecord.SetFlagByBit(System.Int32,System.Boolean)">
  14196. Use one of the bitmasks MANUAL_ADVANCE_BIT ... CURSOR_VISIBLE_BIT
  14197. @param bitmask
  14198. @param enabled
  14199. </member>
  14200. <member name="M:NPOI.HSSF.Record.FtPioGrbitSubRecord.ToString">
  14201. Convert this record to string.
  14202. Used by BiffViewer and other utilities.
  14203. </member>
  14204. <member name="M:NPOI.HSSF.Record.FtPioGrbitSubRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  14205. Serialize the record data into the supplied array of bytes
  14206. @param out the stream to serialize into
  14207. </member>
  14208. <member name="P:NPOI.HSSF.Record.FtPioGrbitSubRecord.Sid">
  14209. @return id of this record.
  14210. </member>
  14211. <member name="T:NPOI.HSSF.Record.GridsetRecord">
  14212. Title: GridSet Record.
  14213. Description: flag denoting whether the user specified that gridlines are used when
  14214. printing.
  14215. REFERENCE: PG 320 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14216. @author Andrew C. Oliver (acoliver at apache dot org)
  14217. @author Glen Stampoultzis (glens at apache.org)
  14218. @author Jason Height (jheight at chariot dot net dot au)
  14219. @version 2.0-pre
  14220. </member>
  14221. <member name="M:NPOI.HSSF.Record.GridsetRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14222. Constructs a GridSet record and Sets its fields appropriately.
  14223. @param in the RecordInputstream to Read the record from
  14224. </member>
  14225. <member name="P:NPOI.HSSF.Record.GridsetRecord.Gridset">
  14226. Get whether the gridlines are shown during printing.
  14227. @return gridSet - true if gridlines are NOT printed, false if they are.
  14228. </member>
  14229. <member name="T:NPOI.HSSF.Record.GroupMarkerSubRecord">
  14230. * The Group marker record is used as a position holder for Groups.
  14231. * @author Glen Stampoultzis (glens at apache.org)
  14232. </member>
  14233. <member name="M:NPOI.HSSF.Record.GroupMarkerSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  14234. Constructs a Group marker record and Sets its fields appropriately.
  14235. @param in the RecordInputstream to Read the record from
  14236. </member>
  14237. <member name="P:NPOI.HSSF.Record.GroupMarkerSubRecord.DataSize">
  14238. Size of record (exluding 4 byte header)
  14239. </member>
  14240. <member name="T:NPOI.HSSF.Record.GutsRecord">
  14241. Title: Guts Record
  14242. Description: Row/column gutter sizes
  14243. REFERENCE: PG 320 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14244. @author Andrew C. Oliver (acoliver at apache dot org)
  14245. @author Jason Height (jheight at chariot dot net dot au)
  14246. @version 2.0-pre
  14247. </member>
  14248. <member name="M:NPOI.HSSF.Record.GutsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14249. Constructs a Guts record and Sets its fields appropriately.
  14250. @param in the RecordInputstream to Read the record from
  14251. </member>
  14252. <member name="P:NPOI.HSSF.Record.GutsRecord.LeftRowGutter">
  14253. Get the size of the gutter that appears at the left of the rows
  14254. @return gutter size in screen Units
  14255. </member>
  14256. <member name="P:NPOI.HSSF.Record.GutsRecord.TopColGutter">
  14257. Get the size of the gutter that appears at the above the columns
  14258. @return gutter size in screen Units
  14259. </member>
  14260. <member name="P:NPOI.HSSF.Record.GutsRecord.RowLevelMax">
  14261. Get the maximum outline level for the row gutter.
  14262. @return maximum outline level
  14263. </member>
  14264. <member name="P:NPOI.HSSF.Record.GutsRecord.ColLevelMax">
  14265. Get the maximum outline level for the col gutter.
  14266. @return maximum outline level
  14267. </member>
  14268. <member name="T:NPOI.HSSF.Record.HCenterRecord">
  14269. Title: HCenter record
  14270. Description: whether to center between horizontal margins
  14271. REFERENCE: PG 320 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14272. @author Andrew C. Oliver (acoliver at apache dot org)
  14273. @author Jason Height (jheight at chariot dot net dot au)
  14274. @version 2.0-pre
  14275. </member>
  14276. <member name="M:NPOI.HSSF.Record.HCenterRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14277. Constructs an HCenter record and Sets its fields appropriately.
  14278. @param in the RecordInputstream to Read the record from
  14279. </member>
  14280. <member name="P:NPOI.HSSF.Record.HCenterRecord.HCenter">
  14281. Get whether or not to horizonatally center this sheet.
  14282. @return center - t/f
  14283. </member>
  14284. <member name="T:NPOI.HSSF.Record.HeaderFooterBase">
  14285. Common header/footer base class
  14286. @author Josh Micich
  14287. </member>
  14288. <member name="P:NPOI.HSSF.Record.HeaderFooterBase.TextLength">
  14289. get the length of the footer string
  14290. @return length of the footer string
  14291. </member>
  14292. <member name="T:NPOI.HSSF.Record.HeaderFooterRecord">
  14293. The HEADERFOOTER record stores information Added in Office Excel 2007 for headers/footers.
  14294. @author Yegor Kozlov
  14295. </member>
  14296. <member name="M:NPOI.HSSF.Record.HeaderFooterRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14297. construct a HeaderFooterRecord record. No fields are interpreted and the record will
  14298. be Serialized in its original form more or less
  14299. @param in the RecordInputstream to read the record from
  14300. </member>
  14301. <member name="M:NPOI.HSSF.Record.HeaderFooterRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  14302. spit the record out AS IS. no interpretation or identification
  14303. </member>
  14304. <member name="P:NPOI.HSSF.Record.HeaderFooterRecord.Guid">
  14305. If this header belongs to a specific sheet view , the sheet view?s GUID will be saved here.
  14306. If it is zero, it means the current sheet. Otherwise, this field MUST match the guid field
  14307. of the preceding {@link UserSViewBegin} record.
  14308. @return the sheet view's GUID
  14309. </member>
  14310. <member name="P:NPOI.HSSF.Record.HeaderFooterRecord.IsCurrentSheet">
  14311. @return whether this record belongs to the current sheet
  14312. </member>
  14313. <member name="T:NPOI.HSSF.Record.HeaderRecord">
  14314. Title: Header Record
  14315. Description: Specifies a header for a sheet
  14316. REFERENCE: PG 321 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14317. @author Andrew C. Oliver (acoliver at apache dot org)
  14318. @author Shawn Laubach (slaubach at apache dot org) Modified 3/14/02
  14319. @author Jason Height (jheight at chariot dot net dot au)
  14320. @version 2.0-pre
  14321. </member>
  14322. <member name="M:NPOI.HSSF.Record.HeaderRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14323. Constructs an Header record and Sets its fields appropriately.
  14324. @param in the RecordInputstream to Read the record from
  14325. </member>
  14326. <member name="T:NPOI.HSSF.Record.HideObjRecord">
  14327. Title: Hide Object Record
  14328. Description: flag defines whether to hide placeholders and object
  14329. REFERENCE: PG 321 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14330. @author Andrew C. Oliver (acoliver at apache dot org)
  14331. @version 2.0-pre
  14332. </member>
  14333. <member name="M:NPOI.HSSF.Record.HideObjRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14334. Constructs an HideObj record and Sets its fields appropriately.
  14335. @param in the RecordInputstream to Read the record from
  14336. </member>
  14337. <member name="M:NPOI.HSSF.Record.HideObjRecord.SetHideObj(System.Int16)">
  14338. Set hide object options
  14339. @param hide options
  14340. @see #HIDE_ALL
  14341. @see #SHOW_PLACEHOLDERS
  14342. @see #SHOW_ALL
  14343. </member>
  14344. <member name="M:NPOI.HSSF.Record.HideObjRecord.GetHideObj">
  14345. Get hide object options
  14346. @return hide options
  14347. @see #HIDE_ALL
  14348. @see #SHOW_PLACEHOLDERS
  14349. @see #SHOW_ALL
  14350. </member>
  14351. <member name="T:NPOI.HSSF.Record.HorizontalPageBreakRecord">
  14352. HorizontalPageBreak record that stores page breaks at rows
  14353. This class Is just used so that SID Compares work properly in the RecordFactory
  14354. @see PageBreakRecord
  14355. @author Danny Mui (dmui at apache dot org)
  14356. </member>
  14357. <member name="M:NPOI.HSSF.Record.HorizontalPageBreakRecord.#ctor">
  14358. </member>
  14359. <member name="M:NPOI.HSSF.Record.HorizontalPageBreakRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14360. @param in the RecordInputstream to Read the record from
  14361. </member>
  14362. <member name="T:NPOI.HSSF.Record.HyperlinkRecord">
  14363. The <c>HyperlinkRecord</c> wraps an HLINK-record
  14364. from the Excel-97 format.
  14365. Supports only external links for now (eg http://)
  14366. @author Mark Hissink Muller <a href="mailto:mark@hissinkmuller.nl">mark@hissinkmuller.nl</a>
  14367. @author Yegor Kozlov (yegor at apache dot org)
  14368. </member>
  14369. <member name="F:NPOI.HSSF.Record.HyperlinkRecord.HLINK_URL">
  14370. Link flags
  14371. </member>
  14372. <member name="F:NPOI.HSSF.Record.HyperlinkRecord.URL_uninterpretedTail">
  14373. Tail of a URL link
  14374. </member>
  14375. <member name="F:NPOI.HSSF.Record.HyperlinkRecord.FILE_uninterpretedTail">
  14376. Tail of a file link
  14377. </member>
  14378. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._range">
  14379. cell range of this hyperlink
  14380. </member>
  14381. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._guid">
  14382. 16-byte GUID
  14383. </member>
  14384. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._fileOpts">
  14385. Some sort of options for file links.
  14386. </member>
  14387. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._linkOpts">
  14388. Link options. Can include any of HLINK_* flags.
  14389. </member>
  14390. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._label">
  14391. Test label
  14392. </member>
  14393. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._moniker">
  14394. Moniker. Makes sense only for URL and file links
  14395. </member>
  14396. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._shortFilename">
  14397. in 8:3 DOS format No Unicode string header,
  14398. always 8-bit characters, zero-terminated
  14399. </member>
  14400. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._address">
  14401. Link
  14402. </member>
  14403. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._textMark">
  14404. Text describing a place in document. In Excel UI, this is appended to the
  14405. address, (after a '#' delimiter).<br/>
  14406. This field is optional. If present, the {@link #HLINK_PLACE} must be set.
  14407. </member>
  14408. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._uninterpretedTail">
  14409. Remaining bytes
  14410. </member>
  14411. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.#ctor">
  14412. Create a new hyperlink
  14413. </member>
  14414. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14415. Read hyperlink from input stream
  14416. @param in the stream to Read from
  14417. </member>
  14418. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.FirstColumn">
  14419. Return the column of the first cell that Contains the hyperlink
  14420. @return the 0-based column of the first cell that Contains the hyperlink
  14421. </member>
  14422. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.LastColumn">
  14423. Set the column of the last cell that Contains the hyperlink
  14424. @return the 0-based column of the last cell that Contains the hyperlink
  14425. </member>
  14426. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.FirstRow">
  14427. Return the row of the first cell that Contains the hyperlink
  14428. @return the 0-based row of the first cell that Contains the hyperlink
  14429. </member>
  14430. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.LastRow">
  14431. Return the row of the last cell that Contains the hyperlink
  14432. @return the 0-based row of the last cell that Contains the hyperlink
  14433. </member>
  14434. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.Guid">
  14435. Returns a 16-byte guid identifier. Seems to always equal {@link STD_MONIKER}
  14436. @return 16-byte guid identifier
  14437. </member>
  14438. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.Moniker">
  14439. Returns a 16-byte moniker.
  14440. @return 16-byte moniker
  14441. </member>
  14442. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.Label">
  14443. Return text label for this hyperlink
  14444. @return text to Display
  14445. </member>
  14446. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.Address">
  14447. Hypelink Address. Depending on the hyperlink type it can be URL, e-mail, patrh to a file, etc.
  14448. @return the Address of this hyperlink
  14449. </member>
  14450. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.LinkOptions">
  14451. Link options. Must be a combination of HLINK_* constants.
  14452. </member>
  14453. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.LabelOptions">
  14454. Label options
  14455. </member>
  14456. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.FileOptions">
  14457. Options for a file link
  14458. </member>
  14459. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.IsUrlLink">
  14460. Based on the link options, is this a url?
  14461. </member>
  14462. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.IsFileLink">
  14463. Based on the link options, is this a file?
  14464. </member>
  14465. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.IsDocumentLink">
  14466. Based on the link options, is this a document?
  14467. </member>
  14468. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.CreateUrlLink">
  14469. <summary>
  14470. Initialize a new url link
  14471. </summary>
  14472. </member>
  14473. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.CreateFileLink">
  14474. <summary>
  14475. Initialize a new file link
  14476. </summary>
  14477. </member>
  14478. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.CreateDocumentLink">
  14479. <summary>
  14480. Initialize a new document link
  14481. </summary>
  14482. </member>
  14483. <member name="T:NPOI.HSSF.Record.IndexRecord">
  14484. Title: Index Record
  14485. Description: Occurs right after BOF, tells you where the DBCELL records are for a sheet
  14486. Important for locating cells
  14487. NOT USED IN THIS RELEASE
  14488. REFERENCE: PG 323 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14489. @author Andrew C. Oliver (acoliver at apache dot org)
  14490. @author Jason Height (jheight at chariot dot net dot au)
  14491. @version 2.0-pre
  14492. </member>
  14493. <member name="M:NPOI.HSSF.Record.IndexRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14494. Constructs an Index record and Sets its fields appropriately.
  14495. @param in the RecordInputstream to Read the record from
  14496. </member>
  14497. <member name="M:NPOI.HSSF.Record.IndexRecord.GetRecordSizeForBlockCount(System.Int32)">
  14498. Returns the size of an INdexRecord when it needs to index the specified number of blocks
  14499. </member>
  14500. <member name="T:NPOI.HSSF.Record.InterfaceEndRecord">
  14501. Title: Interface End Record
  14502. Description: Shows where the Interface Records end (MMS)
  14503. (has no fields)
  14504. REFERENCE: PG 324 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14505. @author Andrew C. Oliver (acoliver at apache dot org)
  14506. @version 2.0-pre
  14507. </member>
  14508. <member name="M:NPOI.HSSF.Record.InterfaceEndRecord.Create(NPOI.HSSF.Record.RecordInputStream)">
  14509. Constructs an InterfaceEnd record and Sets its fields appropriately.
  14510. @param in the RecordInputstream to Read the record from
  14511. </member>
  14512. <member name="M:NPOI.HSSF.Record.InterfaceEndRecord.GetDataSize">
  14513. <summary>
  14514. for test TestInterfaceEndRecord.TestCreate()
  14515. </summary>
  14516. <returns></returns>
  14517. </member>
  14518. <member name="T:NPOI.HSSF.Record.InterfaceHdrRecord">
  14519. Title: Interface Header Record
  14520. Description: Defines the beginning of Interface records (MMS)
  14521. REFERENCE: PG 324 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14522. @author Andrew C. Oliver (acoliver at apache dot org)
  14523. @version 2.0-pre
  14524. </member>
  14525. <member name="F:NPOI.HSSF.Record.InterfaceHdrRecord.CODEPAGE">
  14526. suggested (and probably correct) default
  14527. </member>
  14528. <member name="M:NPOI.HSSF.Record.InterfaceHdrRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14529. Constructs an Codepage record and Sets its fields appropriately.
  14530. @param in the RecordInputstream to Read the record from
  14531. </member>
  14532. <member name="T:NPOI.HSSF.Record.IterationRecord">
  14533. Title: Iteration Record
  14534. Description: Tells whether to iterate over forumla calculations or not
  14535. (if a formula Is dependant upon another formula's result)
  14536. (odd feature for something that can only have 32 elements in
  14537. a formula!)
  14538. REFERENCE: PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14539. @author Andrew C. Oliver (acoliver at apache dot org)
  14540. @author Jason Height (jheight at chariot dot net dot au)
  14541. @version 2.0-pre
  14542. </member>
  14543. <member name="M:NPOI.HSSF.Record.IterationRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14544. Constructs an Iteration record and Sets its fields appropriately.
  14545. @param in the RecordInputstream to Read the record from
  14546. </member>
  14547. <member name="P:NPOI.HSSF.Record.IterationRecord.Iteration">
  14548. Get whether or not to iterate for calculations
  14549. @return whether iterative calculations are turned off or on
  14550. </member>
  14551. <member name="T:NPOI.HSSF.Record.LabelRecord">
  14552. Label Record - Read only support for strings stored directly in the cell.. Don't
  14553. use this (except to Read), use LabelSST instead
  14554. REFERENCE: PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14555. @see org.apache.poi.hssf.record.LabelSSTRecord
  14556. </member>
  14557. <member name="M:NPOI.HSSF.Record.LabelRecord.#ctor">
  14558. Creates new LabelRecord
  14559. </member>
  14560. <member name="M:NPOI.HSSF.Record.LabelRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14561. Constructs an Label record and Sets its fields appropriately.
  14562. @param in the RecordInputstream to Read the record from
  14563. </member>
  14564. <member name="P:NPOI.HSSF.Record.LabelRecord.StringLength">
  14565. Get the number of Chars this string Contains
  14566. @return number of Chars
  14567. </member>
  14568. <member name="P:NPOI.HSSF.Record.LabelRecord.IsUncompressedUnicode">
  14569. Is this Uncompressed Unicode (16bit)? Or just 8-bit compressed?
  14570. @return IsUnicode - True for 16bit- false for 8bit
  14571. </member>
  14572. <member name="P:NPOI.HSSF.Record.LabelRecord.Value">
  14573. Get the value
  14574. @return the text string
  14575. @see #GetStringLength
  14576. </member>
  14577. <member name="M:NPOI.HSSF.Record.LabelRecord.Serialize(System.Int32,System.Byte[])">
  14578. THROWS A RUNTIME EXCEPTION.. USE LABELSSTRecords. YOU HAVE NO REASON to use LABELRecord!!
  14579. </member>
  14580. <member name="T:NPOI.HSSF.Record.LabelSSTRecord">
  14581. Title: Label SST Record
  14582. Description: Refers to a string in the shared string table and Is a column
  14583. value.
  14584. REFERENCE: PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14585. @author Andrew C. Oliver (acoliver at apache dot org)
  14586. @author Jason Height (jheight at chariot dot net dot au)
  14587. @version 2.0-pre
  14588. </member>
  14589. <member name="M:NPOI.HSSF.Record.LabelSSTRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14590. Constructs an LabelSST record and Sets its fields appropriately.
  14591. @param in the RecordInputstream to Read the record from
  14592. </member>
  14593. <member name="P:NPOI.HSSF.Record.LabelSSTRecord.SSTIndex">
  14594. Get the index to the string in the SSTRecord
  14595. @return index of string in the SST Table
  14596. @see org.apache.poi.hssf.record.SSTRecord
  14597. </member>
  14598. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._cbFContinued">
  14599. From [MS-XLS].pdf 2.5.147 FtLbsData:
  14600. An unsigned integer that indirectly specifies whether
  14601. some of the data in this structure appear in a subsequent Continue record.
  14602. If _cbFContinued is 0x00, all of the fields in this structure except sid and _cbFContinued
  14603. MUST NOT exist. If this entire structure is Contained within the same record,
  14604. then _cbFContinued MUST be greater than or equal to the size, in bytes,
  14605. of this structure, not including the four bytes for the ft and _cbFContinued fields
  14606. </member>
  14607. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._unknownPreFormulaInt">
  14608. a formula that specifies the range of cell values that are the items in this list.
  14609. </member>
  14610. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._cLines">
  14611. An unsigned integer that specifies the number of items in the list.
  14612. </member>
  14613. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._iSel">
  14614. An unsigned integer that specifies the one-based index of the first selected item in this list.
  14615. A value of 0x00 specifies there is no currently selected item.
  14616. </member>
  14617. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._flags">
  14618. flags that tell what data follows
  14619. </member>
  14620. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._idEdit">
  14621. An ObjId that specifies the edit box associated with this list.
  14622. A value of 0x00 specifies that there is no edit box associated with this list.
  14623. </member>
  14624. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._dropData">
  14625. An optional LbsDropData that specifies properties for this dropdown control.
  14626. This field MUST exist if and only if the Containing Obj?s cmo.ot is equal to 0x14.
  14627. </member>
  14628. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._rgLines">
  14629. An optional array of strings where each string specifies an item in the list.
  14630. The number of elements in this array, if it exists, MUST be {@link #_cLines}
  14631. </member>
  14632. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._bsels">
  14633. An optional array of bools that specifies
  14634. which items in the list are part of a multiple selection
  14635. </member>
  14636. <member name="M:NPOI.HSSF.Record.LbsDataSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32,System.Int32)">
  14637. @param in the stream to read data from
  14638. @param cbFContinued the seconf short in the record header
  14639. @param cmoOt the Containing Obj's {@link CommonObjectDataSubRecord#field_1_objectType}
  14640. </member>
  14641. <member name="P:NPOI.HSSF.Record.LbsDataSubRecord.Formula">
  14642. @return the formula that specifies the range of cell values that are the items in this list.
  14643. </member>
  14644. <member name="P:NPOI.HSSF.Record.LbsDataSubRecord.NumberOfItems">
  14645. @return the number of items in the list
  14646. </member>
  14647. <member name="M:NPOI.HSSF.Record.LbsDataSubRecord.CreateAutoFilterInstance">
  14648. @return a new instance of LbsDataSubRecord to construct auto-filters
  14649. @see org.apache.poi.hssf.model.ComboboxShape#createObjRecord(org.apache.poi.hssf.usermodel.HSSFSimpleShape, int)
  14650. </member>
  14651. <member name="T:NPOI.HSSF.Record.LbsDropData">
  14652. This structure specifies properties of the dropdown list control
  14653. </member>
  14654. <member name="F:NPOI.HSSF.Record.LbsDropData.STYLE_COMBO_DROPDOWN">
  14655. Combo dropdown control
  14656. </member>
  14657. <member name="F:NPOI.HSSF.Record.LbsDropData.STYLE_COMBO_EDIT_DROPDOWN">
  14658. Combo Edit dropdown control
  14659. </member>
  14660. <member name="F:NPOI.HSSF.Record.LbsDropData.STYLE_COMBO_SIMPLE_DROPDOWN">
  14661. Simple dropdown control (just the dropdown button)
  14662. </member>
  14663. <member name="F:NPOI.HSSF.Record.LbsDropData._wStyle">
  14664. An unsigned integer that specifies the style of this dropdown.
  14665. </member>
  14666. <member name="F:NPOI.HSSF.Record.LbsDropData._cLine">
  14667. An unsigned integer that specifies the number of lines to be displayed in the dropdown.
  14668. </member>
  14669. <member name="F:NPOI.HSSF.Record.LbsDropData._dxMin">
  14670. An unsigned integer that specifies the smallest width in pixels allowed for the dropdown window
  14671. </member>
  14672. <member name="F:NPOI.HSSF.Record.LbsDropData._str">
  14673. a string that specifies the current string value in the dropdown
  14674. </member>
  14675. <member name="F:NPOI.HSSF.Record.LbsDropData._unused">
  14676. Optional, undefined and MUST be ignored.
  14677. This field MUST exist if and only if the size of str in bytes is an odd number
  14678. </member>
  14679. <member name="T:NPOI.HSSF.Record.LeftMarginRecord">
  14680. Record for the left margin.
  14681. NOTE: This source was automatically generated.
  14682. @author Shawn Laubach (slaubach at apache dot org)
  14683. </member>
  14684. <member name="M:NPOI.HSSF.Record.LeftMarginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14685. Constructs a LeftMargin record and Sets its fields appropriately.
  14686. @param in the RecordInputstream to Read the record from
  14687. </member>
  14688. <member name="P:NPOI.HSSF.Record.LeftMarginRecord.Margin">
  14689. Get the margin field for the LeftMargin record.
  14690. </member>
  14691. <member name="T:NPOI.HSSF.Record.LinkedDataFormulaField">
  14692. Not implemented yet. May commit it anyway just so people can see
  14693. where I'm heading.
  14694. @author Glen Stampoultzis (glens at apache.org)
  14695. </member>
  14696. <member name="T:NPOI.HSSF.Record.IMargin">
  14697. The margin interface Is a parent used to define left, right, top and bottom margins.
  14698. This allows much of the code to be generic when it comes to handling margins.
  14699. NOTE: This source wass automatically generated.
  14700. @author Shawn Laubach (slaubach at apache dot org)
  14701. </member>
  14702. <member name="P:NPOI.HSSF.Record.IMargin.Margin">
  14703. Get the margin field for the Margin.
  14704. </member>
  14705. <member name="T:NPOI.HSSF.Record.MergeCellsRecord">
  14706. Title: Merged Cells Record
  14707. Description: Optional record defining a square area of cells to "merged" into
  14708. one cell.
  14709. REFERENCE: NONE (UNDOCUMENTED PRESENTLY)
  14710. @author Andrew C. Oliver (acoliver at apache dot org)
  14711. @version 2.0-pre
  14712. </member>
  14713. <member name="F:NPOI.HSSF.Record.MergeCellsRecord._regions">
  14714. sometimes the regions array is shared with other MergedCellsRecords
  14715. </member>
  14716. <member name="M:NPOI.HSSF.Record.MergeCellsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14717. Constructs a MergedCellsRecord and Sets its fields appropriately
  14718. @param in the RecordInputstream to Read the record from
  14719. </member>
  14720. <member name="P:NPOI.HSSF.Record.MergeCellsRecord.NumAreas">
  14721. Get the number of merged areas. If this drops down to 0 you should just go
  14722. ahead and delete the record.
  14723. @return number of areas
  14724. </member>
  14725. <member name="M:NPOI.HSSF.Record.MergeCellsRecord.GetAreaAt(System.Int32)">
  14726. @return MergedRegion at the given index representing the area that is Merged (r1,c1 - r2,c2)
  14727. </member>
  14728. <member name="T:NPOI.HSSF.Record.MMSRecord">
  14729. Title: MMS Record
  14730. Description: defines how many Add menu and del menu options are stored
  14731. in the file. Should always be Set to 0 for HSSF workbooks
  14732. REFERENCE: PG 328 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14733. @author Andrew C. Oliver (acoliver at apache dot org)
  14734. @version 2.0-pre
  14735. </member>
  14736. <member name="M:NPOI.HSSF.Record.MMSRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14737. Constructs a MMS record and Sets its fields appropriately.
  14738. @param in the RecordInputstream to Read the record from
  14739. </member>
  14740. <member name="P:NPOI.HSSF.Record.MMSRecord.AddMenuCount">
  14741. Set number of Add menu options (Set to 0)
  14742. @param am number of Add menu options
  14743. </member>
  14744. <member name="P:NPOI.HSSF.Record.MMSRecord.DelMenuCount">
  14745. Set number of del menu options (Set to 0)
  14746. @param dm number of del menu options
  14747. </member>
  14748. <member name="T:NPOI.HSSF.Record.MulBlankRecord">
  14749. Title: Mulitple Blank cell record
  14750. Description: Represents a Set of columns in a row with no value but with styling.
  14751. In this release we have Read-only support for this record type.
  14752. The RecordFactory Converts this to a Set of BlankRecord objects.
  14753. REFERENCE: PG 329 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14754. @author Andrew C. Oliver (acoliver at apache dot org)
  14755. @author Glen Stampoultzis (glens at apache.org)
  14756. @version 2.0-pre
  14757. @see org.apache.poi.hssf.record.BlankRecord
  14758. </member>
  14759. <member name="M:NPOI.HSSF.Record.MulBlankRecord.#ctor">
  14760. Creates new MulBlankRecord
  14761. </member>
  14762. <member name="M:NPOI.HSSF.Record.MulBlankRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14763. Constructs a MulBlank record and Sets its fields appropriately.
  14764. @param in the RecordInputstream to Read the record from
  14765. </member>
  14766. <member name="P:NPOI.HSSF.Record.MulBlankRecord.Row">
  14767. Get the row number of the cells this represents
  14768. @return row number
  14769. </member>
  14770. <member name="P:NPOI.HSSF.Record.MulBlankRecord.FirstColumn">
  14771. starting column (first cell this holds in the row)
  14772. @return first column number
  14773. </member>
  14774. <member name="P:NPOI.HSSF.Record.MulBlankRecord.LastColumn">
  14775. ending column (last cell this holds in the row)
  14776. @return first column number
  14777. </member>
  14778. <member name="P:NPOI.HSSF.Record.MulBlankRecord.NumColumns">
  14779. Get the number of columns this Contains (last-first +1)
  14780. @return number of columns (last - first +1)
  14781. </member>
  14782. <member name="M:NPOI.HSSF.Record.MulBlankRecord.GetXFAt(System.Int32)">
  14783. returns the xf index for column (coffset = column - field_2_first_col)
  14784. @param coffset the column (coffset = column - field_2_first_col)
  14785. @return the XF index for the column
  14786. </member>
  14787. <member name="T:NPOI.HSSF.Record.MulRKRecord">
  14788. Used to store multiple RK numbers on a row. 1 MulRk = Multiple Cell values.
  14789. HSSF just Converts this into multiple NUMBER records. Read-ONLY SUPPORT!
  14790. REFERENCE: PG 330 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14791. @author Andrew C. Oliver (acoliver at apache dot org)
  14792. @version 2.0-pre
  14793. </member>
  14794. <member name="M:NPOI.HSSF.Record.MulRKRecord.#ctor">
  14795. Creates new MulRKRecord
  14796. </member>
  14797. <member name="M:NPOI.HSSF.Record.MulRKRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14798. Constructs a MulRK record and Sets its fields appropriately.
  14799. @param in the RecordInputstream to Read the record from
  14800. </member>
  14801. <member name="P:NPOI.HSSF.Record.MulRKRecord.FirstColumn">
  14802. starting column (first cell this holds in the row)
  14803. @return first column number
  14804. </member>
  14805. <member name="P:NPOI.HSSF.Record.MulRKRecord.LastColumn">
  14806. ending column (last cell this holds in the row)
  14807. @return first column number
  14808. </member>
  14809. <member name="P:NPOI.HSSF.Record.MulRKRecord.NumColumns">
  14810. Get the number of columns this Contains (last-first +1)
  14811. @return number of columns (last - first +1)
  14812. </member>
  14813. <member name="M:NPOI.HSSF.Record.MulRKRecord.GetXFAt(System.Int32)">
  14814. returns the xf index for column (coffset = column - field_2_first_col)
  14815. @return the XF index for the column
  14816. </member>
  14817. <member name="M:NPOI.HSSF.Record.MulRKRecord.GetRKNumberAt(System.Int32)">
  14818. returns the rk number for column (coffset = column - field_2_first_col)
  14819. @return the value (decoded into a double)
  14820. </member>
  14821. <member name="T:NPOI.HSSF.Record.NameCommentRecord">
  14822. Title: NAMECMT Record (0x0894)
  14823. Description: Defines a comment associated with a specified name.
  14824. REFERENCE:
  14825. @author Andrew Shirley (aks at corefiling.co.uk)
  14826. </member>
  14827. <member name="M:NPOI.HSSF.Record.NameCommentRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14828. @param ris the RecordInputstream to read the record from
  14829. </member>
  14830. <member name="P:NPOI.HSSF.Record.NameCommentRecord.Sid">
  14831. return the non static version of the id for this record.
  14832. </member>
  14833. <member name="P:NPOI.HSSF.Record.NameCommentRecord.NameText">
  14834. @return the name of the NameRecord to which this comment applies.
  14835. </member>
  14836. <member name="P:NPOI.HSSF.Record.NameCommentRecord.CommentText">
  14837. @return the text of the comment.
  14838. </member>
  14839. <member name="T:NPOI.HSSF.Record.NameRecord">
  14840. Title: Name Record (aka Named Range)
  14841. Description: Defines a named range within a workbook.
  14842. REFERENCE:
  14843. @author Libin Roman (Vista Portal LDT. Developer)
  14844. @author Sergei Kozello (sergeikozello at mail.ru)
  14845. @author Glen Stampoultzis (glens at apache.org)
  14846. @version 1.0-pre
  14847. </member>
  14848. <member name="F:NPOI.HSSF.Record.NameRecord.sid">
  14849. </member>
  14850. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_CONSOLIDATE_AREA">
  14851. Included for completeness sake, not implemented
  14852. </member>
  14853. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_AUTO_OPEN">
  14854. Included for completeness sake, not implemented
  14855. </member>
  14856. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_AUTO_CLOSE">
  14857. Included for completeness sake, not implemented
  14858. </member>
  14859. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_DATABASE">
  14860. Included for completeness sake, not implemented
  14861. </member>
  14862. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_CRITERIA">
  14863. Included for completeness sake, not implemented
  14864. </member>
  14865. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_RECORDER">
  14866. Included for completeness sake, not implemented
  14867. </member>
  14868. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_DATA_FORM">
  14869. Included for completeness sake, not implemented
  14870. </member>
  14871. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_AUTO_ACTIVATE">
  14872. Included for completeness sake, not implemented
  14873. </member>
  14874. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_AUTO_DEACTIVATE">
  14875. Included for completeness sake, not implemented
  14876. </member>
  14877. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_SHEET_TITLE">
  14878. Included for completeness sake, not implemented
  14879. </member>
  14880. <member name="F:NPOI.HSSF.Record.NameRecord.field_5_externSheetIndex_plus1">
  14881. One-based extern index of sheet (resolved via LinkTable). Zero if this is a global name
  14882. </member>
  14883. <member name="F:NPOI.HSSF.Record.NameRecord.field_6_sheetNumber">
  14884. the one based sheet number.
  14885. </member>
  14886. <member name="M:NPOI.HSSF.Record.NameRecord.#ctor">
  14887. Creates new NameRecord
  14888. </member>
  14889. <member name="M:NPOI.HSSF.Record.NameRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14890. Constructs a Name record and Sets its fields appropriately.
  14891. @param in the RecordInputstream to Read the record from
  14892. </member>
  14893. <member name="M:NPOI.HSSF.Record.NameRecord.#ctor(System.Byte,System.Int32)">
  14894. Constructor to Create a built-in named region
  14895. @param builtin Built-in byte representation for the name record, use the public constants
  14896. @param index
  14897. </member>
  14898. <member name="P:NPOI.HSSF.Record.NameRecord.FnGroup">
  14899. @return function Group
  14900. @see FnGroupCountRecord
  14901. </member>
  14902. <member name="P:NPOI.HSSF.Record.NameRecord.OptionFlag">
  14903. Gets the option flag
  14904. @return option flag
  14905. </member>
  14906. <member name="P:NPOI.HSSF.Record.NameRecord.KeyboardShortcut">
  14907. returns the keyboard shortcut
  14908. @return keyboard shortcut
  14909. </member>
  14910. <member name="P:NPOI.HSSF.Record.NameRecord.NameTextLength">
  14911. **
  14912. </member>
  14913. <member name="M:NPOI.HSSF.Record.NameRecord.SetFunction(System.Boolean)">
  14914. Indicates that the defined name refers to a user-defined function.
  14915. This attribute is used when there is an add-in or other code project associated with the file.
  14916. @param function <c>true</c> indicates the name refers to a function.
  14917. </member>
  14918. <member name="P:NPOI.HSSF.Record.NameRecord.HasFormula">
  14919. @return <c>true</c> if name has a formula (named range or defined value)
  14920. </member>
  14921. <member name="P:NPOI.HSSF.Record.NameRecord.IsHiddenName">
  14922. @return true if name Is hidden
  14923. </member>
  14924. <member name="P:NPOI.HSSF.Record.NameRecord.IsFunctionName">
  14925. @return true if name Is a function
  14926. </member>
  14927. <member name="P:NPOI.HSSF.Record.NameRecord.IsCommandName">
  14928. @return true if name Is a command
  14929. </member>
  14930. <member name="P:NPOI.HSSF.Record.NameRecord.IsMacro">
  14931. @return true if function macro or command macro
  14932. </member>
  14933. <member name="P:NPOI.HSSF.Record.NameRecord.IsComplexFunction">
  14934. @return true if array formula or user defined
  14935. </member>
  14936. <member name="P:NPOI.HSSF.Record.NameRecord.IsBuiltInName">
  14937. Convenience Function to determine if the name Is a built-in name
  14938. </member>
  14939. <member name="P:NPOI.HSSF.Record.NameRecord.NameText">
  14940. Gets the name
  14941. @return name
  14942. </member>
  14943. <member name="P:NPOI.HSSF.Record.NameRecord.BuiltInName">
  14944. Gets the Built In Name
  14945. @return the built in Name
  14946. </member>
  14947. <member name="P:NPOI.HSSF.Record.NameRecord.NameDefinition">
  14948. Gets the definition, reference (Formula)
  14949. @return definition -- can be null if we cant Parse ptgs
  14950. </member>
  14951. <member name="P:NPOI.HSSF.Record.NameRecord.CustomMenuText">
  14952. Get the custom menu text
  14953. @return custom menu text
  14954. </member>
  14955. <member name="P:NPOI.HSSF.Record.NameRecord.DescriptionText">
  14956. Gets the description text
  14957. @return description text
  14958. </member>
  14959. <member name="P:NPOI.HSSF.Record.NameRecord.HelpTopicText">
  14960. Get the help topic text
  14961. @return gelp topic text
  14962. </member>
  14963. <member name="P:NPOI.HSSF.Record.NameRecord.StatusBarText">
  14964. Gets the status bar text
  14965. @return status bar text
  14966. </member>
  14967. <member name="P:NPOI.HSSF.Record.NameRecord.SheetNumber">
  14968. For named ranges, and built-in names
  14969. @return the 1-based sheet number.
  14970. </member>
  14971. <member name="M:NPOI.HSSF.Record.NameRecord.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  14972. called by the class that Is responsible for writing this sucker.
  14973. Subclasses should implement this so that their data Is passed back in a
  14974. @param offset to begin writing at
  14975. @param data byte array containing instance data
  14976. @return number of bytes written
  14977. </member>
  14978. <member name="P:NPOI.HSSF.Record.NameRecord.ExternSheetNumber">
  14979. Gets the extern sheet number
  14980. @return extern sheet index
  14981. </member>
  14982. <member name="P:NPOI.HSSF.Record.NameRecord.Sid">
  14983. return the non static version of the id for this record.
  14984. </member>
  14985. <member name="M:NPOI.HSSF.Record.NameRecord.ToString">
  14986. @see Object#ToString()
  14987. </member>
  14988. <member name="M:NPOI.HSSF.Record.NameRecord.TranslateBuiltInName(System.Byte)">
  14989. Creates a human Readable name for built in types
  14990. @return Unknown if the built-in name cannot be translated
  14991. </member>
  14992. <member name="T:NPOI.HSSF.Record.NoteRecord">
  14993. NOTE: Comment Associated with a Cell (1Ch)
  14994. @author Yegor Kozlov
  14995. </member>
  14996. <member name="F:NPOI.HSSF.Record.NoteRecord.NOTE_HIDDEN">
  14997. Flag indicating that the comment Is hidden (default)
  14998. </member>
  14999. <member name="F:NPOI.HSSF.Record.NoteRecord.NOTE_VISIBLE">
  15000. Flag indicating that the comment Is visible
  15001. </member>
  15002. <member name="F:NPOI.HSSF.Record.NoteRecord.field_7_padding">
  15003. Saves padding byte value to reduce delta during round-trip serialization.<br/>
  15004. The documentation is not clear about how padding should work. In any case
  15005. Excel(2007) does something different.
  15006. </member>
  15007. <member name="M:NPOI.HSSF.Record.NoteRecord.#ctor">
  15008. Construct a new <c>NoteRecord</c> and
  15009. Fill its data with the default values
  15010. </member>
  15011. <member name="M:NPOI.HSSF.Record.NoteRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15012. Constructs a <c>NoteRecord</c> and Fills its fields
  15013. from the supplied <c>RecordInputStream</c>.
  15014. @param in the stream to Read from
  15015. </member>
  15016. <member name="P:NPOI.HSSF.Record.NoteRecord.Sid">
  15017. @return id of this record.
  15018. </member>
  15019. <member name="M:NPOI.HSSF.Record.NoteRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  15020. Serialize the record data into the supplied array of bytes
  15021. @param offset offset in the <c>data</c>
  15022. @param data the data to Serialize into
  15023. @return size of the record
  15024. </member>
  15025. <member name="P:NPOI.HSSF.Record.NoteRecord.DataSize">
  15026. Size of record
  15027. </member>
  15028. <member name="M:NPOI.HSSF.Record.NoteRecord.ToString">
  15029. Convert this record to string.
  15030. Used by BiffViewer and other utulities.
  15031. </member>
  15032. <member name="P:NPOI.HSSF.Record.NoteRecord.Row">
  15033. Return the row that Contains the comment
  15034. @return the row that Contains the comment
  15035. </member>
  15036. <member name="P:NPOI.HSSF.Record.NoteRecord.Column">
  15037. Return the column that Contains the comment
  15038. @return the column that Contains the comment
  15039. </member>
  15040. <member name="P:NPOI.HSSF.Record.NoteRecord.Flags">
  15041. Options flags.
  15042. @return the options flag
  15043. @see #NOTE_VISIBLE
  15044. @see #NOTE_HIDDEN
  15045. </member>
  15046. <member name="P:NPOI.HSSF.Record.NoteRecord.ShapeId">
  15047. Object id for OBJ record that Contains the comment
  15048. </member>
  15049. <member name="P:NPOI.HSSF.Record.NoteRecord.Author">
  15050. Name of the original comment author
  15051. @return the name of the original author of the comment
  15052. </member>
  15053. <member name="P:NPOI.HSSF.Record.NoteRecord.AuthorIsMultibyte">
  15054. For unit testing only!
  15055. </member>
  15056. <member name="T:NPOI.HSSF.Record.NoteStructureSubRecord">
  15057. Represents a NoteStructure (0xD) sub record.
  15058. The docs say nothing about it. The Length of this record is always 26 bytes.
  15059. @author Yegor Kozlov
  15060. </member>
  15061. <member name="M:NPOI.HSSF.Record.NoteStructureSubRecord.#ctor">
  15062. Construct a new <c>NoteStructureSubRecord</c> and
  15063. Fill its data with the default values
  15064. </member>
  15065. <member name="M:NPOI.HSSF.Record.NoteStructureSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  15066. Constructs a NoteStructureSubRecord and Sets its fields appropriately.
  15067. </member>
  15068. <member name="M:NPOI.HSSF.Record.NoteStructureSubRecord.ToString">
  15069. Convert this record to string.
  15070. Used by BiffViewer and other utulities.
  15071. </member>
  15072. <member name="M:NPOI.HSSF.Record.NoteStructureSubRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  15073. Serialize the record data into the supplied array of bytes
  15074. @param offset offset in the <c>data</c>
  15075. @param data the data to Serialize into
  15076. @return size of the record
  15077. </member>
  15078. <member name="P:NPOI.HSSF.Record.NoteStructureSubRecord.DataSize">
  15079. Size of record
  15080. </member>
  15081. <member name="P:NPOI.HSSF.Record.NoteStructureSubRecord.Sid">
  15082. @return id of this record.
  15083. </member>
  15084. <member name="T:NPOI.HSSF.Record.NumberRecord">
  15085. Contains a numeric cell value.
  15086. REFERENCE: PG 334 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15087. @author Andrew C. Oliver (acoliver at apache dot org)
  15088. @author Jason Height (jheight at chariot dot net dot au)
  15089. @version 2.0-pre
  15090. </member>
  15091. <member name="M:NPOI.HSSF.Record.NumberRecord.#ctor">
  15092. Creates new NumberRecord
  15093. </member>
  15094. <member name="M:NPOI.HSSF.Record.NumberRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15095. Constructs a Number record and Sets its fields appropriately.
  15096. @param in the RecordInputstream to Read the record from
  15097. </member>
  15098. <member name="P:NPOI.HSSF.Record.NumberRecord.Value">
  15099. Get the value for the cell
  15100. @return double representing the value
  15101. </member>
  15102. <member name="T:NPOI.HSSF.Record.ObjectProtectRecord">
  15103. Title: Object Protect Record
  15104. Description: Protect embedded object with the lamest "security" ever invented.
  15105. This record tells "I want to protect my objects" with lame security. It
  15106. appears in conjunction with the PASSWORD and PROTECT records as well as its
  15107. scenario protect cousin.
  15108. REFERENCE: PG 368 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15109. @author Andrew C. Oliver (acoliver at apache dot org)
  15110. </member>
  15111. <member name="M:NPOI.HSSF.Record.ObjectProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15112. Constructs a Protect record and Sets its fields appropriately.
  15113. @param in the RecordInputstream to Read the record from
  15114. </member>
  15115. <member name="P:NPOI.HSSF.Record.ObjectProtectRecord.Protect">
  15116. Get whether the sheet Is protected or not
  15117. @return whether to protect the sheet or not
  15118. </member>
  15119. <member name="T:NPOI.HSSF.Record.ObjRecord">
  15120. The obj record is used to hold various graphic objects and controls.
  15121. @author Glen Stampoultzis (glens at apache.org)
  15122. </member>
  15123. <member name="F:NPOI.HSSF.Record.ObjRecord._uninterpretedData">
  15124. used when POI has no idea what is going on
  15125. </member>
  15126. <member name="F:NPOI.HSSF.Record.ObjRecord._isPaddedToQuadByteMultiple">
  15127. Excel seems to tolerate padding to quad or double byte length
  15128. </member>
  15129. <member name="M:NPOI.HSSF.Record.ObjRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15130. Constructs a OBJ record and Sets its fields appropriately.
  15131. @param in the RecordInputstream to Read the record from
  15132. </member>
  15133. <member name="M:NPOI.HSSF.Record.ObjRecord.CanPaddingBeDiscarded(System.Byte[],System.Int32)">
  15134. Some XLS files have ObjRecords with nearly 8Kb of excessive padding. These were probably
  15135. written by a version of POI (around 3.1) which incorrectly interpreted the second short of
  15136. the ftLbs subrecord (0x1FEE) as a length, and read that many bytes as padding (other bugs
  15137. helped allow this to occur).
  15138. Excel reads files with this excessive padding OK, truncating the over-sized ObjRecord back
  15139. to the its proper size. POI does the same.
  15140. </member>
  15141. <member name="P:NPOI.HSSF.Record.ObjRecord.RecordSize">
  15142. Size of record (excluding 4 byte header)
  15143. </member>
  15144. <member name="T:NPOI.HSSF.Record.OldCellRecord">
  15145. Base class for all old (Biff 2 - Biff 4) cell value records
  15146. (implementors of {@link CellValueRecordInterface}).
  15147. Subclasses are expected to manage the cell data values (of various types).
  15148. </member>
  15149. <member name="P:NPOI.HSSF.Record.OldCellRecord.XFIndex">
  15150. Get the index to the ExtendedFormat, for non-Biff2
  15151. @see NPOI.HSSF.Record.ExtendedFormatRecord
  15152. @return index to the XF record
  15153. </member>
  15154. <member name="P:NPOI.HSSF.Record.OldCellRecord.IsBiff2">
  15155. Is this a Biff2 record, or newer?
  15156. </member>
  15157. <member name="M:NPOI.HSSF.Record.OldCellRecord.AppendValueText(System.Text.StringBuilder)">
  15158. Append specific debug info (used by {@link #ToString()} for the value
  15159. Contained in this record. Trailing new-line should not be Appended
  15160. (superclass does that).
  15161. </member>
  15162. <member name="P:NPOI.HSSF.Record.OldCellRecord.RecordName">
  15163. Gets the debug info BIFF record type name (used by {@link #ToString()}.
  15164. </member>
  15165. <member name="T:NPOI.HSSF.Record.OldFormulaRecord">
  15166. Formula Record (0x0006 / 0x0206 / 0x0406) - holds a formula in
  15167. encoded form, along with the value if a number
  15168. </member>
  15169. <member name="P:NPOI.HSSF.Record.OldFormulaRecord.Value">
  15170. Get the calculated value of the formula
  15171. @return calculated value
  15172. </member>
  15173. <member name="P:NPOI.HSSF.Record.OldFormulaRecord.Options">
  15174. Get the option flags
  15175. @return bitmask
  15176. </member>
  15177. <member name="P:NPOI.HSSF.Record.OldFormulaRecord.ParsedExpression">
  15178. @return the formula tokens. never <code>null</code>
  15179. </member>
  15180. <member name="T:NPOI.HSSF.Record.OldLabelRecord">
  15181. Biff2 - Biff 4 Label Record (0x0004 / 0x0204) - read only support for
  15182. strings stored directly in the cell, from the older file formats that
  15183. didn't use {@link LabelSSTRecord}
  15184. </member>
  15185. <member name="M:NPOI.HSSF.Record.OldLabelRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15186. @param in the RecordInputstream to read the record from
  15187. </member>
  15188. <member name="P:NPOI.HSSF.Record.OldLabelRecord.StringLength">
  15189. Get the number of characters this string Contains
  15190. @return number of characters
  15191. </member>
  15192. <member name="P:NPOI.HSSF.Record.OldLabelRecord.Value">
  15193. Get the String of the cell
  15194. </member>
  15195. <member name="M:NPOI.HSSF.Record.OldLabelRecord.Serialize(System.Int32,System.Byte[])">
  15196. Not supported
  15197. </member>
  15198. <member name="T:NPOI.HSSF.Record.OldSheetRecord">
  15199. Title: Bound Sheet Record (aka BundleSheet) (0x0085) for BIFF 5<br/>
  15200. Description: Defines a sheet within a workbook. Basically stores the sheet name
  15201. and tells where the Beginning of file record is within the HSSF
  15202. file.
  15203. </member>
  15204. <member name="P:NPOI.HSSF.Record.OldSheetRecord.PositionOfBof">
  15205. Get the offset in bytes of the Beginning of File Marker within the HSSF Stream part of the POIFS file
  15206. @return offset in bytes
  15207. </member>
  15208. <member name="P:NPOI.HSSF.Record.OldSheetRecord.Sheetname">
  15209. Get the sheetname for this sheet. (this appears in the tabs at the bottom)
  15210. @return sheetname the name of the sheet
  15211. </member>
  15212. <member name="T:NPOI.HSSF.Record.OldStringRecord">
  15213. Biff2 - Biff 4 Label Record (0x0007 / 0x0207) - read only support for
  15214. formula string results.
  15215. </member>
  15216. <member name="M:NPOI.HSSF.Record.OldStringRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15217. @param in the RecordInputstream to read the record from
  15218. </member>
  15219. <member name="M:NPOI.HSSF.Record.OldStringRecord.GetString">
  15220. @return The string represented by this record.
  15221. </member>
  15222. <member name="T:NPOI.HSSF.Record.PageBreakRecord">
  15223. Record that Contains the functionality page _breaks (horizontal and vertical)
  15224. The other two classes just specifically Set the SIDS for record creation.
  15225. REFERENCE: Microsoft Excel SDK page 322 and 420
  15226. @see HorizontalPageBreakRecord
  15227. @see VerticalPageBreakRecord
  15228. @author Danny Mui (dmui at apache dot org)
  15229. </member>
  15230. <member name="T:NPOI.HSSF.Record.PageBreakRecord.Break">
  15231. Since both records store 2byte integers (short), no point in
  15232. differentiating it in the records.
  15233. The subs (rows or columns, don't seem to be able to Set but excel Sets
  15234. them automatically)
  15235. </member>
  15236. <member name="M:NPOI.HSSF.Record.PageBreakRecord.AddBreak(System.Int32,System.Int32,System.Int32)">
  15237. Adds the page break at the specified parameters
  15238. @param main Depending on sid, will determine row or column to put page break (zero-based)
  15239. @param subFrom No user-interface to Set (defaults to minumum, 0)
  15240. @param subTo No user-interface to Set
  15241. </member>
  15242. <member name="M:NPOI.HSSF.Record.PageBreakRecord.RemoveBreak(System.Int32)">
  15243. Removes the break indicated by the parameter
  15244. @param main (zero-based)
  15245. </member>
  15246. <member name="M:NPOI.HSSF.Record.PageBreakRecord.GetBreak(System.Int32)">
  15247. Retrieves the region at the row/column indicated
  15248. @param main FIXME: Document this!
  15249. @return The Break or null if no break exists at the row/col specified.
  15250. </member>
  15251. <member name="T:NPOI.HSSF.Record.PaletteRecord">
  15252. PaletteRecord - Supports custom palettes.
  15253. @author Andrew C. Oliver (acoliver at apache dot org)
  15254. @author Brian Sanders (bsanders at risklabs dot com) - custom palette editing
  15255. @version 2.0-pre
  15256. </member>
  15257. <member name="F:NPOI.HSSF.Record.PaletteRecord.STANDARD_PALETTE_SIZE">
  15258. The standard size of an XLS palette
  15259. </member>
  15260. <member name="F:NPOI.HSSF.Record.PaletteRecord.FIRST_COLOR_INDEX">
  15261. The byte index of the first color
  15262. </member>
  15263. <member name="M:NPOI.HSSF.Record.PaletteRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15264. Constructs a PaletteRecord record and Sets its fields appropriately.
  15265. @param in the RecordInputstream to Read the record from
  15266. </member>
  15267. <member name="M:NPOI.HSSF.Record.PaletteRecord.ClearColors">
  15268. <summary>
  15269. Dangerous! Only call this if you intend to replace the colors!
  15270. </summary>
  15271. </member>
  15272. <member name="M:NPOI.HSSF.Record.PaletteRecord.GetColor(System.Int16)">
  15273. Returns the color value at a given index
  15274. @return the RGB triplet for the color, or null if the specified index
  15275. does not exist
  15276. </member>
  15277. <member name="M:NPOI.HSSF.Record.PaletteRecord.SetColor(System.Int16,System.Byte,System.Byte,System.Byte)">
  15278. Sets the color value at a given index
  15279. If the given index Is greater than the current last color index,
  15280. then black Is Inserted at every index required to make the palette continuous.
  15281. @param byteIndex the index to Set; if this index Is less than 0x8 or greater than
  15282. 0x40, then no modification Is made
  15283. </member>
  15284. <member name="M:NPOI.HSSF.Record.PaletteRecord.CreateDefaultPalette">
  15285. Creates the default palette as PaletteRecord binary data
  15286. @see org.apache.poi.hssf.model.Workbook#createPalette
  15287. </member>
  15288. <member name="T:NPOI.HSSF.Record.PColor">
  15289. PColor - element in the list of colors - consider it a "struct"
  15290. </member>
  15291. <member name="T:NPOI.HSSF.Record.PaneRecord">
  15292. * Describes the frozen and Unfozen panes.
  15293. * NOTE: This source Is automatically generated please do not modify this file. Either subclass or
  15294. * Remove the record in src/records/definitions.
  15295. * @author Glen Stampoultzis (glens at apache.org)
  15296. </member>
  15297. <member name="M:NPOI.HSSF.Record.PaneRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15298. Constructs a Pane record and Sets its fields appropriately.
  15299. @param in the RecordInputstream to Read the record from
  15300. </member>
  15301. <member name="P:NPOI.HSSF.Record.PaneRecord.X">
  15302. Get the x field for the Pane record.
  15303. </member>
  15304. <member name="P:NPOI.HSSF.Record.PaneRecord.Y">
  15305. Get the y field for the Pane record.
  15306. </member>
  15307. <member name="P:NPOI.HSSF.Record.PaneRecord.TopRow">
  15308. Get the top row field for the Pane record.
  15309. </member>
  15310. <member name="P:NPOI.HSSF.Record.PaneRecord.LeftColumn">
  15311. Get the left column field for the Pane record.
  15312. </member>
  15313. <member name="P:NPOI.HSSF.Record.PaneRecord.ActivePane">
  15314. Get the active pane field for the Pane record.
  15315. @return One of
  15316. ACTIVE_PANE_LOWER_RIGHT
  15317. ACTIVE_PANE_UPPER_RIGHT
  15318. ACTIVE_PANE_LOWER_LEFT
  15319. ACTIVE_PANE_UPPER_LEFT
  15320. </member>
  15321. <member name="T:NPOI.HSSF.Record.PasswordRecord">
  15322. Title: Password Record
  15323. Description: stores the encrypted password for a sheet or workbook (HSSF doesn't support encryption)
  15324. REFERENCE: PG 371 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15325. @author Andrew C. Oliver (acoliver at apache dot org)
  15326. @version 2.0-pre
  15327. </member>
  15328. <member name="M:NPOI.HSSF.Record.PasswordRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15329. Constructs a Password record and Sets its fields appropriately.
  15330. @param in the RecordInputstream to Read the record from
  15331. </member>
  15332. <member name="P:NPOI.HSSF.Record.PasswordRecord.Password">
  15333. Get the password
  15334. @return short representing the password
  15335. </member>
  15336. <member name="M:NPOI.HSSF.Record.PasswordRecord.Clone">
  15337. Clone this record.
  15338. </member>
  15339. <member name="T:NPOI.HSSF.Record.PasswordRev4Record">
  15340. Title: Protection Revision 4 password Record
  15341. Description: Stores the (2 byte??!!) encrypted password for a shared
  15342. workbook
  15343. REFERENCE: PG 374 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15344. @author Andrew C. Oliver (acoliver at apache dot org)
  15345. @version 2.0-pre
  15346. </member>
  15347. <member name="M:NPOI.HSSF.Record.PasswordRev4Record.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15348. Constructs a PasswordRev4 (PROT4REVPASS) record and Sets its fields appropriately.
  15349. @param in the RecordInputstream to Read the record from
  15350. </member>
  15351. <member name="M:NPOI.HSSF.Record.PasswordRev4Record.SetPassword(System.Int16)">
  15352. set the password
  15353. @param pw representing the password
  15354. </member>
  15355. <member name="T:NPOI.HSSF.Record.PivotTable.DataItemRecord">
  15356. SXDI - Data Item (0x00C5)<br/>
  15357. @author Patrick Cheng
  15358. </member>
  15359. <member name="T:NPOI.HSSF.Record.PivotTable.ExtendedPivotTableViewFieldsRecord">
  15360. SXVDEX - Extended PivotTable View Fields (0x0100)<br/>
  15361. @author Patrick Cheng
  15362. </member>
  15363. <member name="F:NPOI.HSSF.Record.PivotTable.ExtendedPivotTableViewFieldsRecord.STRING_NOT_PRESENT_LEN">
  15364. the value of the <c>cchSubName</c> field when the subName is not present
  15365. </member>
  15366. <member name="T:NPOI.HSSF.Record.PivotTable.PageItemRecord">
  15367. SXPI - Page Item (0x00B6)<br/>
  15368. @author Patrick Cheng
  15369. </member>
  15370. <member name="F:NPOI.HSSF.Record.PivotTable.PageItemRecord.FieldInfo._isxvi">
  15371. Index to the View Item SXVI(0x00B2) record
  15372. </member>
  15373. <member name="F:NPOI.HSSF.Record.PivotTable.PageItemRecord.FieldInfo._isxvd">
  15374. Index to the {@link ViewFieldsRecord} SXVD(0x00B1) record
  15375. </member>
  15376. <member name="F:NPOI.HSSF.Record.PivotTable.PageItemRecord.FieldInfo._idObj">
  15377. Object ID for the drop-down arrow
  15378. </member>
  15379. <member name="T:NPOI.HSSF.Record.PivotTable.StreamIDRecord">
  15380. SXIDSTM - Stream ID (0x00D5)<br/>
  15381. @author Patrick Cheng
  15382. </member>
  15383. <member name="T:NPOI.HSSF.Record.PivotTable.ViewDefinitionRecord">
  15384. SXVIEW - View Definition (0x00B0)<br/>
  15385. @author Patrick Cheng
  15386. </member>
  15387. <member name="T:NPOI.HSSF.Record.PivotTable.ViewFieldsRecord">
  15388. SXVD - View Fields (0x00B1)<br/>
  15389. @author Patrick Cheng
  15390. </member>
  15391. <member name="T:NPOI.HSSF.Record.PivotTable.ViewFieldsRecord.Axis">
  15392. values for the {@link ViewFieldsRecord#sxaxis} field
  15393. </member>
  15394. <member name="F:NPOI.HSSF.Record.PivotTable.ViewFieldsRecord.STRING_NOT_PRESENT_LEN">
  15395. the value of the <c>cchName</c> field when the name is not present
  15396. </member>
  15397. <member name="F:NPOI.HSSF.Record.PivotTable.ViewFieldsRecord.BASE_SIZE">
  15398. 5 shorts
  15399. </member>
  15400. <member name="T:NPOI.HSSF.Record.PivotTable.ViewSourceRecord">
  15401. SXVS - View Source (0x00E3)<br/>
  15402. @author Patrick Cheng
  15403. </member>
  15404. <member name="T:NPOI.HSSF.Record.PrecisionRecord">
  15405. Title: Precision Record
  15406. Description: defines whether to store with full precision or what's Displayed by the gui
  15407. (meaning have really screwed up and skewed figures or only think you do!)
  15408. REFERENCE: PG 372 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15409. @author Andrew C. Oliver (acoliver at apache dot org)
  15410. @version 2.0-pre
  15411. </member>
  15412. <member name="M:NPOI.HSSF.Record.PrecisionRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15413. Constructs a Precision record and Sets its fields appropriately.
  15414. @param in the RecordInputstream to Read the record from
  15415. </member>
  15416. <member name="P:NPOI.HSSF.Record.PrecisionRecord.FullPrecision">
  15417. Get whether to use full precision or just skew all you figures all to hell.
  15418. @return fullprecision - or not
  15419. </member>
  15420. <member name="T:NPOI.HSSF.Record.PrintGridlinesRecord">
  15421. Title: Print Gridlines Record
  15422. Description: whether to print the gridlines when you enjoy you spReadsheet on paper.
  15423. REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15424. @author Andrew C. Oliver (acoliver at apache dot org)
  15425. @author Jason Height (jheight at chariot dot net dot au)
  15426. @version 2.0-pre
  15427. </member>
  15428. <member name="M:NPOI.HSSF.Record.PrintGridlinesRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15429. Constructs a PrintGridlines record and Sets its fields appropriately.
  15430. @param in the RecordInputstream to Read the record from
  15431. </member>
  15432. <member name="P:NPOI.HSSF.Record.PrintGridlinesRecord.PrintGridlines">
  15433. Get whether or not to print the gridlines (and make your spReadsheet ugly)
  15434. @return make spReadsheet ugly - Y/N
  15435. </member>
  15436. <member name="T:NPOI.HSSF.Record.PrintHeadersRecord">
  15437. Title: Print Headers Record
  15438. Description: Whether or not to print the row/column headers when you
  15439. enjoy your spReadsheet in the physical form.
  15440. REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15441. @author Andrew C. Oliver (acoliver at apache dot org)
  15442. @author Jason Height (jheight at chariot dot net dot au)
  15443. @version 2.0-pre
  15444. </member>
  15445. <member name="M:NPOI.HSSF.Record.PrintHeadersRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15446. Constructs a PrintHeaders record and Sets its fields appropriately.
  15447. @param in the RecordInputstream to Read the record from
  15448. </member>
  15449. <member name="P:NPOI.HSSF.Record.PrintHeadersRecord.PrintHeaders">
  15450. <summary>
  15451. Get whether to print the headers - y/n
  15452. </summary>
  15453. <value><c>true</c> if [print headers]; otherwise, <c>false</c>.</value>
  15454. </member>
  15455. <member name="T:NPOI.HSSF.Record.PrintSetupRecord">
  15456. Title: Print Setup Record
  15457. Description: Stores print Setup options -- bogus for HSSF (and marked as such)
  15458. REFERENCE: PG 385 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15459. @author Andrew C. Oliver (acoliver at apache dot org)
  15460. @author Jason Height (jheight at chariot dot net dot au)
  15461. @version 2.0-pre
  15462. </member>
  15463. <member name="M:NPOI.HSSF.Record.PrintSetupRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15464. Constructs a PrintSetup (SetUP) record and Sets its fields appropriately.
  15465. @param in the RecordInputstream to Read the record from
  15466. </member>
  15467. <member name="T:NPOI.HSSF.Record.ProtectionRev4Record">
  15468. Title: Protection Revision 4 Record
  15469. Description: describes whether this is a protected shared/tracked workbook
  15470. ( HSSF does not support encryption because we don't feel like going to jail )
  15471. REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15472. @author Andrew C. Oliver (acoliver at apache dot org)
  15473. @version 2.0-pre
  15474. </member>
  15475. <member name="M:NPOI.HSSF.Record.ProtectionRev4Record.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15476. Constructs a ProtectionRev4 record and Sets its fields appropriately.
  15477. @param in the RecordInputstream to Read the record from
  15478. </member>
  15479. <member name="P:NPOI.HSSF.Record.ProtectionRev4Record.Protect">
  15480. Get whether the this is protected shared/tracked workbook or not
  15481. @return whether to protect the workbook or not
  15482. </member>
  15483. <member name="T:NPOI.HSSF.Record.ProtectRecord">
  15484. Title: Protect Record
  15485. Description: defines whether a sheet or workbook is protected (HSSF DOES NOT SUPPORT ENCRYPTION)
  15486. (kindly ask the US government to stop having arcane stupid encryption laws and we'll support it)
  15487. (after all terrorists will all use US-legal encrypton right??)
  15488. HSSF now supports the simple "protected" sheets (where they are not encrypted and open office et al
  15489. ignore the password record entirely).
  15490. REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15491. @author Andrew C. Oliver (acoliver at apache dot org)
  15492. </member>
  15493. <member name="M:NPOI.HSSF.Record.ProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15494. Constructs a Protect record and Sets its fields appropriately.
  15495. @param in the RecordInputstream to Read the record from
  15496. </member>
  15497. <member name="P:NPOI.HSSF.Record.ProtectRecord.Protect">
  15498. Get whether the sheet is protected or not
  15499. @return whether to protect the sheet or not
  15500. </member>
  15501. <member name="T:NPOI.HSSF.Record.RecalcIdRecord">
  15502. Title: Recalc Id Record
  15503. Description: This record Contains an ID that marks when a worksheet was last
  15504. recalculated. It's an optimization Excel uses to determine if it
  15505. needs to recalculate the spReadsheet when it's opened. So far, only
  15506. the two values <c>0xC1 0x01 0x00 0x00 0x80 0x38 0x01 0x00</c>
  15507. (do not recalculate) and <c>0xC1 0x01 0x00 0x00 0x60 0x69 0x01
  15508. 0x00</c> have been seen. If the field <c>isNeeded</c> Is
  15509. Set to false (default), then this record Is swallowed during the
  15510. serialization Process
  15511. REFERENCE: http://chicago.sourceforge.net/devel/docs/excel/biff8.html
  15512. @author Luc Girardin (luc dot girardin at macrofocus dot com)
  15513. @version 2.0-pre
  15514. @see org.apache.poi.hssf.model.Workbook
  15515. </member>
  15516. <member name="F:NPOI.HSSF.Record.RecalcIdRecord._engineId">
  15517. An unsigned integer that specifies the recalculation engine identifier
  15518. of the recalculation engine that performed the last recalculation.
  15519. If the value is less than the recalculation engine identifier associated with the application,
  15520. the application will recalculate the results of all formulas on
  15521. this workbook immediately after loading the file
  15522. </member>
  15523. <member name="M:NPOI.HSSF.Record.RecalcIdRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15524. Constructs a RECALCID record and Sets its fields appropriately.
  15525. @param in the RecordInputstream to Read the record from
  15526. </member>
  15527. <member name="T:NPOI.HSSF.Record.Record">
  15528. Title: Record
  15529. Description: All HSSF Records inherit from this class. It
  15530. populates the fields common to all records (id, size and data).
  15531. Subclasses should be sure to validate the id,
  15532. Company:
  15533. @author Andrew C. Oliver
  15534. @author Marc Johnson (mjohnson at apache dot org)
  15535. @author Jason Height (jheight at chariot dot net dot au)
  15536. @version 2.0-pre
  15537. </member>
  15538. <member name="M:NPOI.HSSF.Record.Record.#ctor">
  15539. instantiates a blank record strictly for ID matching
  15540. </member>
  15541. <member name="M:NPOI.HSSF.Record.Record.Serialize">
  15542. called by the class that is responsible for writing this sucker.
  15543. Subclasses should implement this so that their data is passed back in a
  15544. byte array.
  15545. @return byte array containing instance data
  15546. </member>
  15547. <member name="P:NPOI.HSSF.Record.Record.Sid">
  15548. return the non static version of the id for this record.
  15549. </member>
  15550. <member name="T:NPOI.HSSF.Record.RecordBase">
  15551. Common base class of {@link Record} and {@link RecordAggregate}
  15552. @author Josh Micich
  15553. </member>
  15554. <member name="M:NPOI.HSSF.Record.RecordBase.Serialize(System.Int32,System.Byte[])">
  15555. called by the class that is responsible for writing this sucker.
  15556. Subclasses should implement this so that their data is passed back in a
  15557. byte array.
  15558. @param offset to begin writing at
  15559. @param data byte array containing instance data
  15560. @return number of bytes written
  15561. </member>
  15562. <member name="P:NPOI.HSSF.Record.RecordBase.RecordSize">
  15563. gives the current serialized size of the record. Should include the sid
  15564. and reclength (4 bytes).
  15565. </member>
  15566. <member name="T:NPOI.HSSF.Record.RecordFactory">
  15567. Title: Record Factory
  15568. Description: Takes a stream and outputs an array of Record objects.
  15569. @deprecated use {@link org.apache.poi.hssf.eventmodel.EventRecordFactory} instead
  15570. @see org.apache.poi.hssf.eventmodel.EventRecordFactory
  15571. @author Andrew C. Oliver (acoliver at apache dot org)
  15572. @author Marc Johnson (mjohnson at apache dot org)
  15573. @author Glen Stampoultzis (glens at apache.org)
  15574. @author Csaba Nagy (ncsaba at yahoo dot com)
  15575. </member>
  15576. <member name="T:NPOI.HSSF.Record.RecordFactory.ReflectionMethodRecordCreator">
  15577. A "create" method is used instead of the usual constructor if the created record might
  15578. be of a different class to the declaring class.
  15579. </member>
  15580. <member name="F:NPOI.HSSF.Record.RecordFactory._recordCreatorsById">
  15581. cache of the recordsToMap();
  15582. </member>
  15583. <member name="M:NPOI.HSSF.Record.RecordFactory.GetRecordClass(System.Int32)">
  15584. Debug / diagnosis method<br/>
  15585. Gets the POI implementation class for a given <tt>sid</tt>. Only a subset of the any BIFF
  15586. records are actually interpreted by POI. A few others are known but not interpreted
  15587. (see {@link UnknownRecord#getBiffName(int)}).
  15588. @return the POI implementation class for the specified record <tt>sid</tt>.
  15589. <code>null</code> if the specified record is not interpreted by POI.
  15590. </member>
  15591. <member name="M:NPOI.HSSF.Record.RecordFactory.SetCapacity(System.Int32)">
  15592. Changes the default capacity (10000) to handle larger files
  15593. </member>
  15594. <member name="M:NPOI.HSSF.Record.RecordFactory.CreateRecords(System.IO.Stream)">
  15595. Create an array of records from an input stream
  15596. @param in the InputStream from which the records will be
  15597. obtained
  15598. @return an array of Records Created from the InputStream
  15599. @exception RecordFormatException on error Processing the
  15600. InputStream
  15601. </member>
  15602. <member name="M:NPOI.HSSF.Record.RecordFactory.ConvertBlankRecords(NPOI.HSSF.Record.MulBlankRecord)">
  15603. Converts a {@link MulBlankRecord} into an equivalent array of {@link BlankRecord}s
  15604. </member>
  15605. <member name="M:NPOI.HSSF.Record.RecordFactory.ConvertToNumberRecord(NPOI.HSSF.Record.RKRecord)">
  15606. <summary>
  15607. RK record is a slightly smaller alternative to NumberRecord
  15608. POI likes NumberRecord better
  15609. </summary>
  15610. <param name="rk">The rk.</param>
  15611. <returns></returns>
  15612. </member>
  15613. <member name="M:NPOI.HSSF.Record.RecordFactory.ConvertRKRecords(NPOI.HSSF.Record.MulRKRecord)">
  15614. <summary>
  15615. Converts a MulRKRecord into an equivalent array of NumberRecords
  15616. </summary>
  15617. <param name="mrk">The MRK.</param>
  15618. <returns></returns>
  15619. </member>
  15620. <member name="T:NPOI.HSSF.Record.RecordFactoryInputStream">
  15621. A stream based way to get at complete records, with
  15622. as low a memory footprint as possible.
  15623. This handles Reading from a RecordInputStream, turning
  15624. the data into full records, processing continue records
  15625. etc.
  15626. Most users should use {@link HSSFEventFactory} /
  15627. {@link HSSFListener} and have new records pushed to
  15628. them, but this does allow for a "pull" style of coding.
  15629. </member>
  15630. <member name="T:NPOI.HSSF.Record.RecordFactoryInputStream.StreamEncryptionInfo">
  15631. Keeps track of the sizes of the Initial records up to and including {@link FilePassRecord}
  15632. Needed for protected files because each byte is encrypted with respect to its absolute
  15633. position from the start of the stream.
  15634. </member>
  15635. <member name="P:NPOI.HSSF.Record.RecordFactoryInputStream.StreamEncryptionInfo.LastRecord">
  15636. @return last record scanned while looking for encryption info.
  15637. This will typically be the first or second record Read. Possibly <code>null</code>
  15638. if stream was empty
  15639. </member>
  15640. <member name="P:NPOI.HSSF.Record.RecordFactoryInputStream.StreamEncryptionInfo.HasBOFRecord">
  15641. <c>false</c> in some test cases
  15642. </member>
  15643. <member name="F:NPOI.HSSF.Record.RecordFactoryInputStream._unreadRecordBuffer">
  15644. Temporarily stores a group of {@link Record}s, for future return by {@link #nextRecord()}.
  15645. This is used at the start of the workbook stream, and also when the most recently read
  15646. underlying record is a {@link MulRKRecord}
  15647. </member>
  15648. <member name="F:NPOI.HSSF.Record.RecordFactoryInputStream._unreadRecordIndex">
  15649. used to help iterating over the unread records
  15650. </member>
  15651. <member name="F:NPOI.HSSF.Record.RecordFactoryInputStream._lastRecord">
  15652. The most recent record that we gave to the user
  15653. </member>
  15654. <member name="F:NPOI.HSSF.Record.RecordFactoryInputStream._lastDrawingRecord">
  15655. The most recent DrawingRecord seen
  15656. </member>
  15657. <member name="M:NPOI.HSSF.Record.RecordFactoryInputStream.#ctor(System.IO.Stream,System.Boolean)">
  15658. @param shouldIncludeContinueRecords caller can pass <c>false</c> if loose
  15659. {@link ContinueRecord}s should be skipped (this is sometimes useful in event based
  15660. processing).
  15661. </member>
  15662. <member name="M:NPOI.HSSF.Record.RecordFactoryInputStream.NextRecord">
  15663. Returns the next (complete) record from the
  15664. stream, or null if there are no more.
  15665. </member>
  15666. <member name="M:NPOI.HSSF.Record.RecordFactoryInputStream.GetNextUnreadRecord">
  15667. @return the next {@link Record} from the multiple record group as expanded from
  15668. a recently read {@link MulRKRecord}. <code>null</code> if not present.
  15669. </member>
  15670. <member name="M:NPOI.HSSF.Record.RecordFactoryInputStream.ReadNextRecord">
  15671. @return the next available record, or <code>null</code> if
  15672. this pass didn't return a record that's
  15673. suitable for returning (eg was a continue record).
  15674. </member>
  15675. <member name="T:NPOI.HSSF.Record.RecordInputStream">
  15676. Title: Record Input Stream
  15677. Description: Wraps a stream and provides helper methods for the construction of records.
  15678. @author Jason Height (jheight @ apache dot org)
  15679. </member>
  15680. <member name="F:NPOI.HSSF.Record.RecordInputStream.MAX_RECORD_DATA_SIZE">
  15681. Maximum size of a single record (minus the 4 byte header) without a continue
  15682. </member>
  15683. <member name="F:NPOI.HSSF.Record.RecordInputStream._bhi">
  15684. Header {@link LittleEndianInput} facet of the wrapped {@link InputStream}
  15685. </member>
  15686. <member name="F:NPOI.HSSF.Record.RecordInputStream._dataInput">
  15687. Data {@link LittleEndianInput} facet of the wrapped {@link InputStream}
  15688. </member>
  15689. <member name="M:NPOI.HSSF.Record.RecordInputStream.#ctor(System.IO.Stream)">
  15690. the record identifier of the BIFF record currently being read
  15691. </member>
  15692. <member name="M:NPOI.HSSF.Record.RecordInputStream.Read">
  15693. This method will Read a byte from the current record
  15694. </member>
  15695. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadNextSid">
  15696. @return the sid of the next record or {@link #INVALID_SID_VALUE} if at end of stream
  15697. </member>
  15698. <member name="M:NPOI.HSSF.Record.RecordInputStream.NextRecord">
  15699. Moves to the next record in the stream.
  15700. <i>Note: The auto continue flag is Reset to true</i>
  15701. </member>
  15702. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadByte">
  15703. Reads an 8 bit, signed value
  15704. </member>
  15705. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadShort">
  15706. Reads a 16 bit, signed value
  15707. </member>
  15708. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadUByte">
  15709. Reads an 8 bit, Unsigned value
  15710. </member>
  15711. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadUShort">
  15712. Reads a 16 bit,un- signed value.
  15713. @return
  15714. </member>
  15715. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadUnicodeLEString(System.Int32)">
  15716. given a byte array of 16-bit Unicode Chars, compress to 8-bit and
  15717. return a string
  15718. { 0x16, 0x00 } -0x16
  15719. @param Length the Length of the string
  15720. @return the Converted string
  15721. @exception ArgumentException if len is too large (i.e.,
  15722. there is not enough data in string to Create a String of that
  15723. Length)
  15724. </member>
  15725. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadRemainder">
  15726. Returns the remaining bytes for the current record.
  15727. @return The remaining bytes of the current record.
  15728. </member>
  15729. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadAllContinuedRemainder">
  15730. Reads all byte data for the current record, including any
  15731. that overlaps into any following continue records.
  15732. @deprecated Best to write a input stream that wraps this one where there Is
  15733. special sub record that may overlap continue records.
  15734. </member>
  15735. <member name="P:NPOI.HSSF.Record.RecordInputStream.Remaining">
  15736. The remaining number of bytes in the <i>current</i> record.
  15737. @return The number of bytes remaining in the current record
  15738. </member>
  15739. <member name="P:NPOI.HSSF.Record.RecordInputStream.IsContinueNext">
  15740. Returns true iif a Continue record is next in the excel stream _currentDataOffset
  15741. @return True when a ContinueRecord is next.
  15742. </member>
  15743. <member name="M:NPOI.HSSF.Record.RecordInputStream.GetNextSid">
  15744. @return sid of next record. Can be called after hasNextRecord()
  15745. </member>
  15746. <member name="T:NPOI.HSSF.Record.RefModeRecord">
  15747. Title: RefMode Record
  15748. Description: Describes which reference mode to use
  15749. REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15750. @author Andrew C. Oliver (acoliver at apache dot org)
  15751. @author Jason Height (jheight at chariot dot net dot au)
  15752. @version 2.0-pre
  15753. </member>
  15754. <member name="M:NPOI.HSSF.Record.RefModeRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15755. Constructs a RefMode record and Sets its fields appropriately.
  15756. @param in the RecordInputstream to Read the record from
  15757. </member>
  15758. <member name="P:NPOI.HSSF.Record.RefModeRecord.Mode">
  15759. Get the reference mode to use (HSSF uses/assumes A1)
  15760. @return mode to use
  15761. @see #USE_A1_MODE
  15762. @see #USE_R1C1_MODE
  15763. </member>
  15764. <member name="T:NPOI.HSSF.Record.RefreshAllRecord">
  15765. Title: Refresh All Record
  15766. Description: Flag whether to refresh all external data when loading a sheet.
  15767. (which hssf doesn't support anyhow so who really cares?)
  15768. REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15769. @author Andrew C. Oliver (acoliver at apache dot org)
  15770. @version 2.0-pre
  15771. </member>
  15772. <member name="M:NPOI.HSSF.Record.RefreshAllRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15773. Constructs a RefreshAll record and Sets its fields appropriately.
  15774. @param in the RecordInputstream to Read the record from
  15775. </member>
  15776. <member name="P:NPOI.HSSF.Record.RefreshAllRecord.RefreshAll">
  15777. Get whether to refresh all external data when loading a sheet
  15778. @return refreshall or not
  15779. </member>
  15780. <member name="T:NPOI.HSSF.Record.RightMarginRecord">
  15781. Record for the right margin. * NOTE: This source was automatically generated. * @author Shawn Laubach (slaubach at apache dot org)
  15782. </member>
  15783. <member name="M:NPOI.HSSF.Record.RightMarginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15784. Constructs a RightMargin record and Sets its fields appropriately. * * @param id id must be 0x27 or an exception * will be throw upon validation * @param size size the size of the data area of the record * @param data data of the record (should not contain sid/len)
  15785. </member>
  15786. <member name="P:NPOI.HSSF.Record.RightMarginRecord.Margin">
  15787. Get the margin field for the RightMargin record.
  15788. </member>
  15789. <member name="T:NPOI.HSSF.Record.RKRecord">
  15790. Title: RK Record
  15791. Description: An internal 32 bit number with the two most significant bits
  15792. storing the type. This is part of a bizarre scheme to save disk
  15793. space and memory (gee look at all the other whole records that
  15794. are in the file just "cause"..,far better to waste Processor
  15795. cycles on this then leave on of those "valuable" records out).
  15796. We support this in Read-ONLY mode. HSSF Converts these to NUMBER records
  15797. REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15798. @author Andrew C. Oliver (acoliver at apache dot org)
  15799. @author Jason Height (jheight at chariot dot net dot au)
  15800. @version 2.0-pre
  15801. @see org.apache.poi.hssf.record.NumberRecord
  15802. </member>
  15803. <member name="M:NPOI.HSSF.Record.RKRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15804. Constructs a RK record and Sets its fields appropriately.
  15805. @param in the RecordInputstream to Read the record from
  15806. </member>
  15807. <member name="P:NPOI.HSSF.Record.RKRecord.RKType">
  15808. Get the type of the number
  15809. @return one of these values:
  15810. <OL START="0">
  15811. <LI>RK_IEEE_NUMBER</LI>
  15812. <LI>RK_IEEE_NUMBER_TIMES_100</LI>
  15813. <LI>RK_INTEGER</LI>
  15814. <LI>RK_INTEGER_TIMES_100</LI>
  15815. </OL>
  15816. </member>
  15817. <member name="P:NPOI.HSSF.Record.RKRecord.RKNumber">
  15818. Extract the value of the number
  15819. The mechanism for determining the value is dependent on the two
  15820. low order bits of the raw number. If bit 1 is Set, the number
  15821. is an integer and can be cast directly as a double, otherwise,
  15822. it's apparently the exponent and mantissa of a double (and the
  15823. remaining low-order bits of the double's mantissa are 0's).
  15824. If bit 0 is Set, the result of the conversion to a double Is
  15825. divided by 100; otherwise, the value is left alone.
  15826. [Insert picture of Screwy Squirrel in full Napoleonic regalia]
  15827. @return the value as a proper double (hey, it <B>could</B>
  15828. happen)
  15829. </member>
  15830. <member name="T:NPOI.HSSF.Record.RowDataRecord">
  15831. <summary>
  15832. this record only used for record that has name and not implemented.
  15833. </summary>
  15834. </member>
  15835. <member name="T:NPOI.HSSF.Record.RowRecord">
  15836. Title: Row Record
  15837. Description: stores the row information for the sheet.
  15838. REFERENCE: PG 379 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15839. @author Andrew C. Oliver (acoliver at apache dot org)
  15840. @author Jason Height (jheight at chariot dot net dot au)
  15841. @version 2.0-pre
  15842. </member>
  15843. <member name="F:NPOI.HSSF.Record.RowRecord.MAX_ROW_NUMBER">
  15844. The maximum row number that excel can handle (zero based) ie 65536 rows Is
  15845. max number of rows.
  15846. </member>
  15847. <member name="F:NPOI.HSSF.Record.RowRecord.field_7_option_flags">
  15848. 16 bit options flags
  15849. </member>
  15850. <member name="M:NPOI.HSSF.Record.RowRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15851. Constructs a Row record and Sets its fields appropriately.
  15852. @param in the RecordInputstream to Read the record from
  15853. </member>
  15854. <member name="P:NPOI.HSSF.Record.RowRecord.IsEmpty">
  15855. Get the logical row number for this row (0 based index)
  15856. @return row - the row number
  15857. </member>
  15858. <member name="P:NPOI.HSSF.Record.RowRecord.FirstCol">
  15859. Get the logical col number for the first cell this row (0 based index)
  15860. @return col - the col number
  15861. </member>
  15862. <member name="P:NPOI.HSSF.Record.RowRecord.LastCol">
  15863. Get the logical col number for the last cell this row plus one (0 based index)
  15864. @return col - the last col number + 1
  15865. </member>
  15866. <member name="P:NPOI.HSSF.Record.RowRecord.Height">
  15867. Get the height of the row
  15868. @return height of the row
  15869. </member>
  15870. <member name="P:NPOI.HSSF.Record.RowRecord.Optimize">
  15871. Get whether to optimize or not (Set to 0)
  15872. @return optimize (Set to 0)
  15873. </member>
  15874. <member name="P:NPOI.HSSF.Record.RowRecord.OptionFlags">
  15875. Gets the option bitmask. (use the individual bit Setters that refer to this
  15876. method)
  15877. @return options - the bitmask
  15878. </member>
  15879. <member name="P:NPOI.HSSF.Record.RowRecord.OutlineLevel">
  15880. Get the outline level of this row
  15881. @return ol - the outline level
  15882. @see #GetOptionFlags()
  15883. </member>
  15884. <member name="P:NPOI.HSSF.Record.RowRecord.Colapsed">
  15885. Get whether or not to colapse this row
  15886. @return c - colapse or not
  15887. @see #GetOptionFlags()
  15888. </member>
  15889. <member name="P:NPOI.HSSF.Record.RowRecord.ZeroHeight">
  15890. Get whether or not to Display this row with 0 height
  15891. @return - z height is zero or not.
  15892. @see #GetOptionFlags()
  15893. </member>
  15894. <member name="P:NPOI.HSSF.Record.RowRecord.BadFontHeight">
  15895. Get whether the font and row height are not compatible
  15896. @return - f -true if they aren't compatible (damn not logic)
  15897. @see #GetOptionFlags()
  15898. </member>
  15899. <member name="P:NPOI.HSSF.Record.RowRecord.Formatted">
  15900. Get whether the row has been formatted (even if its got all blank cells)
  15901. @return formatted or not
  15902. @see #GetOptionFlags()
  15903. </member>
  15904. <member name="P:NPOI.HSSF.Record.RowRecord.XFIndex">
  15905. if the row is formatted then this is the index to the extended format record
  15906. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  15907. @return index to the XF record or bogus value (undefined) if Isn't formatted
  15908. </member>
  15909. <member name="P:NPOI.HSSF.Record.RowRecord.TopBorder">
  15910. bit that specifies whether any cell in the row has a thick top border, or any
  15911. cell in the row directly above the current row has a thick bottom border.
  15912. @param f has thick top border
  15913. </member>
  15914. <member name="P:NPOI.HSSF.Record.RowRecord.BottomBorder">
  15915. A bit that specifies whether any cell in the row has a medium or thick
  15916. bottom border, or any cell in the row directly below the current row has
  15917. a medium or thick top border.
  15918. @param f has thick bottom border
  15919. </member>
  15920. <member name="P:NPOI.HSSF.Record.RowRecord.PhoeneticGuide">
  15921. A bit that specifies whether the phonetic guide feature is enabled for
  15922. any cell in this row.
  15923. @param f use phoenetic guide
  15924. </member>
  15925. <member name="T:NPOI.HSSF.Record.SaveRecalcRecord">
  15926. Title: Save Recalc Record
  15927. Description: defines whether to recalculate before saving (Set to true)
  15928. REFERENCE: PG 381 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15929. @author Andrew C. Oliver (acoliver at apache dot org)
  15930. @author Jason Height (jheight at chariot dot net dot au)
  15931. @version 2.0-pre
  15932. </member>
  15933. <member name="M:NPOI.HSSF.Record.SaveRecalcRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15934. Constructs an SaveRecalc record and Sets its fields appropriately.
  15935. @param in the RecordInputstream to Read the record from
  15936. </member>
  15937. <member name="P:NPOI.HSSF.Record.SaveRecalcRecord.Recalc">
  15938. Get whether to recalculate formulas/etc before saving or not
  15939. @return recalc - whether to recalculate or not
  15940. </member>
  15941. <member name="T:NPOI.HSSF.Record.ScenarioProtectRecord">
  15942. Title: Scenario Protect Record
  15943. Description: I have no idea what a Scenario is or why on would want to
  15944. protect it with the lamest "security" ever invented. However this record tells
  15945. excel "I want to protect my scenarios" (0xAF) with lame security. It appears
  15946. in conjunction with the PASSWORD and PROTECT records as well as its object
  15947. protect cousin.
  15948. REFERENCE: PG 383 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15949. @author Andrew C. Oliver (acoliver at apache dot org)
  15950. </member>
  15951. <member name="M:NPOI.HSSF.Record.ScenarioProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15952. Constructs a Protect record and Sets its fields appropriately.
  15953. @param in the RecordInputstream to Read the record from
  15954. </member>
  15955. <member name="P:NPOI.HSSF.Record.ScenarioProtectRecord.Protect">
  15956. Get whether the sheet is protected or not
  15957. @return whether to protect the sheet or not
  15958. </member>
  15959. <member name="T:NPOI.HSSF.Record.SCLRecord">
  15960. * Specifies the window's zoom magnification. If this record Isn't present then the windows zoom is 100%. see p384 Excel Dev Kit
  15961. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  15962. * Remove the record in src/records/definitions.
  15963. * @author Andrew C. Oliver (acoliver at apache.org)
  15964. </member>
  15965. <member name="M:NPOI.HSSF.Record.SCLRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15966. Constructs a SCL record and Sets its fields appropriately.
  15967. @param in the RecordInputstream to Read the record from
  15968. </member>
  15969. <member name="P:NPOI.HSSF.Record.SCLRecord.DataSize">
  15970. Size of record (exluding 4 byte header)
  15971. </member>
  15972. <member name="P:NPOI.HSSF.Record.SCLRecord.Numerator">
  15973. Get the numerator field for the SCL record.
  15974. </member>
  15975. <member name="P:NPOI.HSSF.Record.SCLRecord.Denominator">
  15976. Get the denominator field for the SCL record.
  15977. </member>
  15978. <member name="T:NPOI.HSSF.Record.SelectionRecord">
  15979. Title: Selection Record
  15980. Description: shows the user's selection on the sheet
  15981. for Write Set num refs to 0
  15982. TODO : Fully implement reference subrecords.
  15983. REFERENCE: PG 291 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15984. @author Andrew C. Oliver (acoliver at apache dot org)
  15985. @author Jason Height (jheight at chariot dot net dot au)
  15986. @author Glen Stampoultzis (glens at apache.org)
  15987. </member>
  15988. <member name="M:NPOI.HSSF.Record.SelectionRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15989. <summary>
  15990. Constructs a Selection record and Sets its fields appropriately.
  15991. </summary>
  15992. <param name="in1">the RecordInputstream to Read the record from</param>
  15993. </member>
  15994. <member name="P:NPOI.HSSF.Record.SelectionRecord.Pane">
  15995. <summary>
  15996. Gets or sets the pane this is for.
  15997. </summary>
  15998. <value>The pane.</value>
  15999. </member>
  16000. <member name="P:NPOI.HSSF.Record.SelectionRecord.ActiveCellRow">
  16001. <summary>
  16002. Gets or sets the active cell row.
  16003. </summary>
  16004. <value>row number of active cell</value>
  16005. </member>
  16006. <member name="P:NPOI.HSSF.Record.SelectionRecord.ActiveCellCol">
  16007. <summary>
  16008. Gets or sets the active cell's col
  16009. </summary>
  16010. <value>number of active cell</value>
  16011. </member>
  16012. <member name="P:NPOI.HSSF.Record.SelectionRecord.ActiveCellRef">
  16013. <summary>
  16014. Gets or sets the active cell's reference number
  16015. </summary>
  16016. <value>ref number of active cell</value>
  16017. </member>
  16018. <member name="T:NPOI.HSSF.Record.SharedFormulaRecord">
  16019. Title: SharedFormulaRecord
  16020. Description: Primarily used as an excel optimization so that multiple similar formulas
  16021. are not written out too many times. We should recognize this record and
  16022. Serialize as Is since this Is used when Reading templates.
  16023. Note: the documentation says that the SID Is BC where biffviewer reports 4BC. The hex dump shows
  16024. that the two byte sid representation to be 'BC 04' that Is consistent with the other high byte
  16025. record types.
  16026. @author Danny Mui at apache dot org
  16027. </member>
  16028. <member name="M:NPOI.HSSF.Record.SharedFormulaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16029. @param in the RecordInputstream to Read the record from
  16030. </member>
  16031. <member name="M:NPOI.HSSF.Record.SharedFormulaRecord.ToString">
  16032. print a sort of string representation ([SHARED FORMULA RECORD] id = x [/SHARED FORMULA RECORD])
  16033. </member>
  16034. <member name="M:NPOI.HSSF.Record.SharedFormulaRecord.GetFormulaTokens(NPOI.HSSF.Record.FormulaRecord)">
  16035. @return the equivalent {@link Ptg} array that the formula would have, were it not shared.
  16036. </member>
  16037. <member name="T:NPOI.HSSF.Record.SharedValueRecordBase">
  16038. Common base class for {@link SharedFormulaRecord}, {@link ArrayRecord} and
  16039. {@link TableRecord} which are have similarities.
  16040. @author Josh Micich
  16041. </member>
  16042. <member name="M:NPOI.HSSF.Record.SharedValueRecordBase.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16043. reads only the range (1 {@link CellRangeAddress8Bit}) from the stream
  16044. </member>
  16045. <member name="M:NPOI.HSSF.Record.SharedValueRecordBase.IsInRange(System.Int32,System.Int32)">
  16046. @return <c>true</c> if (rowIx, colIx) is within the range ({@link #Range})
  16047. of this shared value object.
  16048. </member>
  16049. <member name="M:NPOI.HSSF.Record.SharedValueRecordBase.IsFirstCell(System.Int32,System.Int32)">
  16050. @return <c>true</c> if (rowIx, colIx) describes the first cell in this shared value
  16051. object's range ({@link #Range})
  16052. </member>
  16053. <member name="T:NPOI.HSSF.Record.SheetExtRecord">
  16054. <summary>
  16055. </summary>
  16056. </member>
  16057. <member name="T:NPOI.HSSF.Record.SSTDeserializer">
  16058. Handles the task of deserializing a SST string. The two main entry points are
  16059. @author Glen Stampoultzis (glens at apache.org)
  16060. @author Jason Height (jheight at apache.org)
  16061. </member>
  16062. <member name="M:NPOI.HSSF.Record.SSTDeserializer.ManufactureStrings(System.Int32,NPOI.HSSF.Record.RecordInputStream)">
  16063. This Is the starting point where strings are constructed. Note that
  16064. strings may span across multiple continuations. Read the SST record
  16065. carefully before beginning to hack.
  16066. </member>
  16067. <member name="T:NPOI.HSSF.Record.SSTRecord">
  16068. Title: Static String Table Record
  16069. Description: This holds all the strings for LabelSSTRecords.
  16070. REFERENCE: PG 389 Microsoft Excel 97 Developer's Kit (ISBN:
  16071. 1-57231-498-2)
  16072. @author Andrew C. Oliver (acoliver at apache dot org)
  16073. @author Marc Johnson (mjohnson at apache dot org)
  16074. @author Glen Stampoultzis (glens at apache.org)
  16075. @see org.apache.poi.hssf.record.LabelSSTRecord
  16076. @see org.apache.poi.hssf.record.ContinueRecord
  16077. </member>
  16078. <member name="F:NPOI.HSSF.Record.SSTRecord.MAX_RECORD_SIZE">
  16079. how big can an SST record be? As big as any record can be: 8228 bytes
  16080. </member>
  16081. <member name="F:NPOI.HSSF.Record.SSTRecord.STD_RECORD_OVERHEAD">
  16082. standard record overhead: two shorts (record id plus data space size)
  16083. </member>
  16084. <member name="F:NPOI.HSSF.Record.SSTRecord.SST_RECORD_OVERHEAD">
  16085. SST overhead: the standard record overhead, plus the number of strings and the number of Unique strings -- two ints
  16086. </member>
  16087. <member name="F:NPOI.HSSF.Record.SSTRecord.MAX_DATA_SPACE">
  16088. how much data can we stuff into an SST record? That would be _max minus the standard SST record overhead
  16089. </member>
  16090. <member name="F:NPOI.HSSF.Record.SSTRecord.field_1_num_strings">
  16091. Union of strings in the SST and EXTSST
  16092. </member>
  16093. <member name="F:NPOI.HSSF.Record.SSTRecord.field_2_num_unique_strings">
  16094. according to docs ONLY SST
  16095. </member>
  16096. <member name="F:NPOI.HSSF.Record.SSTRecord.bucketAbsoluteOffsets">
  16097. Offsets from the beginning of the SST record (even across continuations)
  16098. </member>
  16099. <member name="F:NPOI.HSSF.Record.SSTRecord.bucketRelativeOffsets">
  16100. Offsets relative the start of the current SST or continue record
  16101. </member>
  16102. <member name="M:NPOI.HSSF.Record.SSTRecord.#ctor">
  16103. default constructor
  16104. </member>
  16105. <member name="M:NPOI.HSSF.Record.SSTRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16106. Constructs an SST record and Sets its fields appropriately.
  16107. @param in the RecordInputstream to Read the record from
  16108. </member>
  16109. <member name="M:NPOI.HSSF.Record.SSTRecord.AddString(NPOI.HSSF.Record.UnicodeString)">
  16110. Add a string.
  16111. @param string string to be Added
  16112. @return the index of that string in the table
  16113. </member>
  16114. <member name="P:NPOI.HSSF.Record.SSTRecord.NumStrings">
  16115. @return number of strings
  16116. </member>
  16117. <member name="P:NPOI.HSSF.Record.SSTRecord.NumUniqueStrings">
  16118. @return number of Unique strings
  16119. </member>
  16120. <member name="M:NPOI.HSSF.Record.SSTRecord.GetString(System.Int32)">
  16121. Get a particular string by its index
  16122. @param id index into the array of strings
  16123. @return the desired string
  16124. </member>
  16125. <member name="M:NPOI.HSSF.Record.SSTRecord.ToString">
  16126. Return a debugging string representation
  16127. @return string representation
  16128. </member>
  16129. <member name="P:NPOI.HSSF.Record.SSTRecord.Sid">
  16130. @return sid
  16131. </member>
  16132. <member name="M:NPOI.HSSF.Record.SSTRecord.GetHashCode">
  16133. @return hashcode
  16134. </member>
  16135. <member name="M:NPOI.HSSF.Record.SSTRecord.GetStrings">
  16136. @return an iterator of the strings we hold. All instances are
  16137. UnicodeStrings
  16138. </member>
  16139. <member name="P:NPOI.HSSF.Record.SSTRecord.CountStrings">
  16140. @return count of the strings we hold.
  16141. </member>
  16142. <member name="M:NPOI.HSSF.Record.SSTRecord.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  16143. called by the class that Is responsible for writing this sucker.
  16144. Subclasses should implement this so that their data Is passed back in a
  16145. byte array.
  16146. @return size
  16147. </member>
  16148. <member name="M:NPOI.HSSF.Record.SSTRecord.CreateExtSSTRecord(System.Int32)">
  16149. Creates an extended string record based on the current contents of
  16150. the current SST record. The offset within the stream to the SST record
  16151. Is required because the extended string record points directly to the
  16152. strings in the SST record.
  16153. NOTE: THIS FUNCTION MUST ONLY BE CALLED AFTER THE SST RECORD HAS BEEN
  16154. SERIALIZED.
  16155. @param sstOffset The offset in the stream to the start of the
  16156. SST record.
  16157. @return The new SST record.
  16158. </member>
  16159. <member name="M:NPOI.HSSF.Record.SSTRecord.CalcExtSSTRecordSize">
  16160. Calculates the size in bytes of the EXTSST record as it would be if the
  16161. record was Serialized.
  16162. @return The size of the ExtSST record in bytes.
  16163. </member>
  16164. <member name="T:NPOI.HSSF.Record.SSTSerializer">
  16165. This class handles serialization of SST records. It utilizes the record processor
  16166. class write individual records. This has been refactored from the SSTRecord class.
  16167. @author Glen Stampoultzis (glens at apache.org)
  16168. </member>
  16169. <member name="F:NPOI.HSSF.Record.SSTSerializer.bucketAbsoluteOffsets">
  16170. OffSets from the beginning of the SST record (even across continuations)
  16171. </member>
  16172. <member name="F:NPOI.HSSF.Record.SSTSerializer.bucketRelativeOffsets">
  16173. OffSets relative the start of the current SST or continue record
  16174. </member>
  16175. <member name="T:NPOI.HSSF.Record.StandardRecord">
  16176. Subclasses of this class (the majority of BIFF records) are non-continuable. This allows for
  16177. some simplification of serialization logic
  16178. @author Josh Micich
  16179. </member>
  16180. <member name="M:NPOI.HSSF.Record.StandardRecord.Serialize(System.Int32,System.Byte[])">
  16181. <summary>
  16182. Write the data content of this BIFF record including the sid and record length.
  16183. The subclass must write the exact number of bytes as reported by Record#getRecordSize()
  16184. </summary>
  16185. <param name="offset">offset</param>
  16186. <param name="data">data</param>
  16187. <returns></returns>
  16188. </member>
  16189. <member name="M:NPOI.HSSF.Record.StandardRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  16190. Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields
  16191. have already been written by the superclass.<br/>
  16192. The number of bytes written must equal the record size reported by
  16193. {@link Record#getDataSize()} minus four
  16194. ( record header consiting of a 'ushort sid' and 'ushort reclength' has already been written
  16195. by thye superclass).
  16196. </member>
  16197. <member name="T:NPOI.HSSF.Record.StringRecord">
  16198. Supports the STRING record structure.
  16199. @author Glen Stampoultzis (glens at apache.org)
  16200. </member>
  16201. <member name="M:NPOI.HSSF.Record.StringRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16202. Constructs a String record and Sets its fields appropriately.
  16203. @param in the RecordInputstream to Read the record from
  16204. </member>
  16205. <member name="M:NPOI.HSSF.Record.StringRecord.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  16206. called by the class that Is responsible for writing this sucker.
  16207. Subclasses should implement this so that their data Is passed back in a
  16208. byte array.
  16209. @param offset to begin writing at
  16210. @param data byte array containing instance data
  16211. @return number of bytes written
  16212. </member>
  16213. <member name="P:NPOI.HSSF.Record.StringRecord.Sid">
  16214. return the non static version of the id for this record.
  16215. </member>
  16216. <member name="P:NPOI.HSSF.Record.StringRecord.String">
  16217. @return The string represented by this record.
  16218. </member>
  16219. <member name="T:NPOI.HSSF.Record.StyleRecord">
  16220. Title: Style Record
  16221. Description: Describes a builtin to the gui or user defined style
  16222. REFERENCE: PG 390 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  16223. @author Andrew C. Oliver (acoliver at apache dot org)
  16224. @author aviks : string fixes for UserDefined Style
  16225. @version 2.0-pre
  16226. </member>
  16227. <member name="M:NPOI.HSSF.Record.StyleRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16228. Constructs a Style record and Sets its fields appropriately.
  16229. @param in the RecordInputstream to Read the record from
  16230. </member>
  16231. <member name="M:NPOI.HSSF.Record.StyleRecord.SetBuiltinStyle(System.Int32)">
  16232. if this is a builtin style set the number of the built in style
  16233. @param builtinStyleId style number (0-7)
  16234. </member>
  16235. <member name="P:NPOI.HSSF.Record.StyleRecord.XFIndex">
  16236. Get the actual index of the style extended format record
  16237. @see #Index
  16238. @return index of the xf record
  16239. </member>
  16240. <member name="P:NPOI.HSSF.Record.StyleRecord.Name">
  16241. Get the style's name
  16242. @return name of the style
  16243. @see #NameLength
  16244. </member>
  16245. <member name="P:NPOI.HSSF.Record.StyleRecord.OutlineStyleLevel">
  16246. Get the row or column level of the style (if builtin 1||2)
  16247. </member>
  16248. <member name="T:NPOI.HSSF.Record.ScrollableObjectSubRecord">
  16249. <summary>
  16250. FtSbs structure
  16251. </summary>
  16252. </member>
  16253. <member name="T:NPOI.HSSF.Record.SubRecord">
  16254. Subrecords are part of the OBJ class.
  16255. </member>
  16256. <member name="P:NPOI.HSSF.Record.SubRecord.IsTerminating">
  16257. Wether this record terminates the sub-record stream.
  16258. There are two cases when this method must be overridden and return <c>true</c>
  16259. - EndSubRecord (sid = 0x00)
  16260. - LbsDataSubRecord (sid = 0x12)
  16261. @return whether this record is the last in the sub-record stream
  16262. </member>
  16263. <member name="T:NPOI.HSSF.Record.SupBookRecord">
  16264. Title: Sup Book (EXTERNALBOOK)
  16265. Description: A External Workbook Description (Suplemental Book)
  16266. Its only a dummy record for making new ExternSheet Record
  16267. REFERENCE: 5.38
  16268. @author Libin Roman (Vista Portal LDT. Developer)
  16269. @author Andrew C. Oliver (acoliver@apache.org)
  16270. </member>
  16271. <member name="M:NPOI.HSSF.Record.SupBookRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16272. Constructs a Extern Sheet record and Sets its fields appropriately.
  16273. @param id id must be 0x16 or an exception will be throw upon validation
  16274. @param size the size of the data area of the record
  16275. @param data data of the record (should not contain sid/len)
  16276. </member>
  16277. <member name="T:NPOI.HSSF.Record.TabIdRecord">
  16278. Title: Sheet Tab Index Array Record
  16279. Description: Contains an array of sheet id's. Sheets always keep their ID
  16280. regardless of what their name Is.
  16281. REFERENCE: PG 412 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  16282. @author Andrew C. Oliver (acoliver at apache dot org)
  16283. @version 2.0-pre
  16284. </member>
  16285. <member name="M:NPOI.HSSF.Record.TabIdRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16286. Constructs a TabID record and Sets its fields appropriately.
  16287. @param in the RecordInputstream to Read the record from
  16288. </member>
  16289. <member name="M:NPOI.HSSF.Record.TabIdRecord.SetTabIdArray(System.Int16[])">
  16290. Set the tab array. (0,1,2).
  16291. @param array of tab id's {0,1,2}
  16292. </member>
  16293. <member name="M:NPOI.HSSF.Record.TabIdRecord.ToString">
  16294. Get the tab array. (0,1,2).
  16295. @return array of tab id's {0,1,2}
  16296. </member>
  16297. <member name="T:NPOI.HSSF.Record.TableRecord">
  16298. DATATABLE (0x0236)<p/>
  16299. TableRecord - The record specifies a data table.
  16300. This record Is preceded by a single Formula record that
  16301. defines the first cell in the data table, which should
  16302. only contain a single Ptg, {@link TblPtg}.
  16303. See p536 of the June 08 binary docs
  16304. </member>
  16305. <member name="T:NPOI.HSSF.Record.TableStylesRecord">
  16306. TABLESTYLES (0x088E)<br/>
  16307. @author Patrick Cheng
  16308. </member>
  16309. <member name="F:NPOI.HSSF.Record.TextObjectRecord._linkRefPtg">
  16310. expect tRef, tRef3D, tArea, tArea3D or tName
  16311. </member>
  16312. <member name="F:NPOI.HSSF.Record.TextObjectRecord._unknownPostFormulaByte">
  16313. Not clear if needed . Excel seems to be OK if this byte is not present.
  16314. Value is often the same as the earlier firstColumn byte.
  16315. </member>
  16316. <member name="P:NPOI.HSSF.Record.TextObjectRecord.TextOrientation">
  16317. Get the text orientation field for the TextObjectBase record.
  16318. @return a TextOrientation
  16319. </member>
  16320. <member name="P:NPOI.HSSF.Record.TextObjectRecord.HorizontalTextAlignment">
  16321. @return the Horizontal text alignment field value.
  16322. </member>
  16323. <member name="P:NPOI.HSSF.Record.TextObjectRecord.VerticalTextAlignment">
  16324. @return the Vertical text alignment field value.
  16325. </member>
  16326. <member name="P:NPOI.HSSF.Record.TextObjectRecord.IsTextLocked">
  16327. Text has been locked
  16328. @return the text locked field value.
  16329. </member>
  16330. <member name="T:NPOI.HSSF.Record.TopMarginRecord">
  16331. Record for the top margin.
  16332. NOTE: This source was automatically generated.
  16333. @author Shawn Laubach (slaubach at apache dot org)
  16334. </member>
  16335. <member name="M:NPOI.HSSF.Record.TopMarginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16336. Constructs a TopMargin record and Sets its fields appropriately.
  16337. @param in the RecordInputstream to Read the record from
  16338. </member>
  16339. <member name="P:NPOI.HSSF.Record.TopMarginRecord.Margin">
  16340. Get the margin field for the TopMargin record.
  16341. </member>
  16342. <member name="T:NPOI.HSSF.Record.UncalcedRecord">
  16343. Title: Uncalced Record
  16344. If this record occurs in the Worksheet Substream, it indicates that the formulas have not
  16345. been recalculated before the document was saved.
  16346. @author Olivier Leprince
  16347. </member>
  16348. <member name="M:NPOI.HSSF.Record.UncalcedRecord.#ctor">
  16349. Default constructor
  16350. </member>
  16351. <member name="M:NPOI.HSSF.Record.UncalcedRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16352. Read constructor
  16353. </member>
  16354. <member name="T:NPOI.HSSF.Record.UnknownRecord">
  16355. Title: Unknown Record (for debugging)
  16356. Description: Unknown record just tells you the sid so you can figure out
  16357. what records you are missing. Also helps us Read/modify sheets we
  16358. don't know all the records to. (HSSF leaves these alone!)
  16359. Company: SuperLink Software, Inc.
  16360. @author Andrew C. Oliver (acoliver at apache dot org)
  16361. @author Jason Height (jheight at chariot dot net dot au)
  16362. @author Glen Stampoultzis (glens at apache.org)
  16363. </member>
  16364. <member name="M:NPOI.HSSF.Record.UnknownRecord.#ctor(System.Int32,System.Byte[])">
  16365. @param id id of the record -not Validated, just stored for serialization
  16366. @param data the data
  16367. </member>
  16368. <member name="M:NPOI.HSSF.Record.UnknownRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16369. construct an Unknown record. No fields are interperated and the record will
  16370. be Serialized in its original form more or less
  16371. @param in the RecordInputstream to Read the record from
  16372. </member>
  16373. <member name="M:NPOI.HSSF.Record.UnknownRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  16374. spit the record out AS IS. no interpretation or identification
  16375. </member>
  16376. <member name="M:NPOI.HSSF.Record.UnknownRecord.ToString">
  16377. print a sort of string representation ([UNKNOWN RECORD] id = x [/UNKNOWN RECORD])
  16378. </member>
  16379. <member name="M:NPOI.HSSF.Record.UnknownRecord.GetBiffName(System.Int32)">
  16380. These BIFF record types are known but still uninterpreted by POI
  16381. @return the documented name of this BIFF record type, <code>null</code> if unknown to POI
  16382. </member>
  16383. <member name="M:NPOI.HSSF.Record.UnknownRecord.IsObservedButUnknown(System.Int32)">
  16384. @return <c>true</c> if the unknown record id has been observed in POI unit tests
  16385. </member>
  16386. <member name="M:NPOI.HSSF.Record.UnknownRecord.Clone">
  16387. Unlike the other Record.Clone methods this Is a shallow Clone
  16388. </member>
  16389. <member name="T:NPOI.HSSF.Record.UserSViewBegin">
  16390. The UserSViewBegin record specifies Settings for a custom view associated with the sheet.
  16391. This record also marks the start of custom view records, which save custom view Settings.
  16392. Records between {@link UserSViewBegin} and {@link UserSViewEnd} contain Settings for the custom view,
  16393. not Settings for the sheet itself.
  16394. @author Yegor Kozlov
  16395. </member>
  16396. <member name="M:NPOI.HSSF.Record.UserSViewBegin.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16397. construct an UserSViewBegin record. No fields are interpreted and the record will
  16398. be Serialized in its original form more or less
  16399. @param in the RecordInputstream to read the record from
  16400. </member>
  16401. <member name="M:NPOI.HSSF.Record.UserSViewBegin.Serialize(NPOI.Util.ILittleEndianOutput)">
  16402. spit the record out AS IS. no interpretation or identification
  16403. </member>
  16404. <member name="P:NPOI.HSSF.Record.UserSViewBegin.Guid">
  16405. @return Globally unique identifier for the custom view
  16406. </member>
  16407. <member name="T:NPOI.HSSF.Record.UserSViewEnd">
  16408. The UserSViewEnd record marks the end of the Settings for a custom view associated with the sheet
  16409. @author Yegor Kozlov
  16410. </member>
  16411. <member name="M:NPOI.HSSF.Record.UserSViewEnd.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16412. construct an UserSViewEnd record. No fields are interpreted and the record will
  16413. be Serialized in its original form more or less
  16414. @param in the RecordInputstream to read the record from
  16415. </member>
  16416. <member name="M:NPOI.HSSF.Record.UserSViewEnd.Serialize(NPOI.Util.ILittleEndianOutput)">
  16417. spit the record out AS IS. no interpretation or identification
  16418. </member>
  16419. <member name="T:NPOI.HSSF.Record.UseSelFSRecord">
  16420. Title: Use Natural Language Formulas Flag
  16421. Description: Tells the GUI if this was written by something that can use
  16422. "natural language" formulas. HSSF can't.
  16423. REFERENCE: PG 420 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  16424. @author Andrew C. Oliver (acoliver at apache dot org)
  16425. @version 2.0-pre
  16426. </member>
  16427. <member name="M:NPOI.HSSF.Record.UseSelFSRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16428. Constructs a UseSelFS record and Sets its fields appropriately.
  16429. @param in the RecordInputstream to Read the record from
  16430. </member>
  16431. <member name="T:NPOI.HSSF.Record.VCenterRecord">
  16432. Title: VCenter record
  16433. Description: tells whether to center the sheet between vertical margins
  16434. REFERENCE: PG 420 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  16435. @author Andrew C. Oliver (acoliver at apache dot org)
  16436. @author Jason Height (jheight at chariot dot net dot au)
  16437. @version 2.0-pre
  16438. </member>
  16439. <member name="M:NPOI.HSSF.Record.VCenterRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16440. Constructs a VCENTER record and Sets its fields appropriately.
  16441. @param in the RecordInputstream to Read the record from
  16442. </member>
  16443. <member name="P:NPOI.HSSF.Record.VCenterRecord.VCenter">
  16444. Get whether to center vertically or not
  16445. @return vcenter or not
  16446. </member>
  16447. <member name="T:NPOI.HSSF.Record.VerticalPageBreakRecord">
  16448. VerticalPageBreak record that stores page breaks at columns
  16449. This class Is just used so that SID Compares work properly in the RecordFactory
  16450. @see PageBreakRecord
  16451. @author Danny Mui (dmui at apache dot org)
  16452. </member>
  16453. <member name="M:NPOI.HSSF.Record.VerticalPageBreakRecord.#ctor">
  16454. </member>
  16455. <member name="M:NPOI.HSSF.Record.VerticalPageBreakRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16456. @param in the RecordInputstream to Read the record from
  16457. </member>
  16458. <member name="T:NPOI.HSSF.Record.WindowOneRecord">
  16459. Title: Window1 Record
  16460. Description: Stores the attributes of the workbook window. This Is basically
  16461. so the gui knows how big to make the window holding the spReadsheet
  16462. document.
  16463. REFERENCE: PG 421 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  16464. @author Andrew C. Oliver (acoliver at apache dot org)
  16465. @version 2.0-pre
  16466. </member>
  16467. <member name="M:NPOI.HSSF.Record.WindowOneRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16468. Constructs a WindowOne record and Sets its fields appropriately.
  16469. @param in the RecordInputstream to Read the record from
  16470. </member>
  16471. <member name="P:NPOI.HSSF.Record.WindowOneRecord.HorizontalHold">
  16472. Get the horizontal position of the window (in 1/20ths of a point)
  16473. @return h - horizontal location
  16474. </member>
  16475. <member name="P:NPOI.HSSF.Record.WindowOneRecord.VerticalHold">
  16476. Get the vertical position of the window (in 1/20ths of a point)
  16477. @return v - vertical location
  16478. </member>
  16479. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Width">
  16480. Get the width of the window
  16481. @return width
  16482. </member>
  16483. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Height">
  16484. Get the height of the window
  16485. @return height
  16486. </member>
  16487. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Options">
  16488. Get the options bitmask (see bit Setters)
  16489. @return o - the bitmask
  16490. </member>
  16491. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Hidden">
  16492. Get whether the window Is hidden or not
  16493. @return Ishidden or not
  16494. </member>
  16495. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Iconic">
  16496. Get whether the window has been iconized or not
  16497. @return iconize or not
  16498. </member>
  16499. <member name="P:NPOI.HSSF.Record.WindowOneRecord.DisplayHorizontalScrollbar">
  16500. Get whether to Display the horizontal scrollbar or not
  16501. @return Display or not
  16502. </member>
  16503. <member name="P:NPOI.HSSF.Record.WindowOneRecord.DisplayVerticalScrollbar">
  16504. Get whether to Display the vertical scrollbar or not
  16505. @return Display or not
  16506. </member>
  16507. <member name="P:NPOI.HSSF.Record.WindowOneRecord.DisplayTabs">
  16508. Get whether to Display the tabs or not
  16509. @return Display or not
  16510. </member>
  16511. <member name="P:NPOI.HSSF.Record.WindowOneRecord.ActiveSheetIndex">
  16512. @return the index of the currently Displayed sheet
  16513. </member>
  16514. <member name="P:NPOI.HSSF.Record.WindowOneRecord.FirstVisibleTab">
  16515. @return the first visible sheet in the worksheet tab-bar.
  16516. I.E. the scroll position of the tab-bar.
  16517. </member>
  16518. <member name="P:NPOI.HSSF.Record.WindowOneRecord.NumSelectedTabs">
  16519. Get the number of selected tabs
  16520. @return number of tabs
  16521. </member>
  16522. <member name="P:NPOI.HSSF.Record.WindowOneRecord.TabWidthRatio">
  16523. ratio of the width of the tabs to the horizontal scrollbar
  16524. @return ratio
  16525. </member>
  16526. <member name="T:NPOI.HSSF.Record.WindowProtectRecord">
  16527. Title: Window Protect Record
  16528. Description: flags whether workbook windows are protected
  16529. REFERENCE: PG 424 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  16530. @author Andrew C. Oliver (acoliver at apache dot org)
  16531. @version 2.0-pre
  16532. </member>
  16533. <member name="M:NPOI.HSSF.Record.WindowProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16534. Constructs a WindowProtect record and Sets its fields appropriately.
  16535. @param in the RecordInputstream to Read the record from
  16536. </member>
  16537. <member name="P:NPOI.HSSF.Record.WindowProtectRecord.Protect">
  16538. Is this window protected or not
  16539. @return protected or not
  16540. </member>
  16541. <member name="T:NPOI.HSSF.Record.WindowTwoRecord">
  16542. Title: Window Two Record
  16543. Description: sheet window Settings
  16544. REFERENCE: PG 422 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  16545. @author Andrew C. Oliver (acoliver at apache dot org)
  16546. @author Jason Height (jheight at chariot dot net dot au)
  16547. @version 2.0-pre
  16548. </member>
  16549. <member name="M:NPOI.HSSF.Record.WindowTwoRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16550. Constructs a WindowTwo record and Sets its fields appropriately.
  16551. @param in the RecordInputstream to Read the record from
  16552. </member>
  16553. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.Options">
  16554. Get the options bitmask or just use the bit Setters.
  16555. @return options
  16556. </member>
  16557. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayFormulas">
  16558. Get whether the window should Display formulas
  16559. @return formulas or not
  16560. </member>
  16561. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayGridlines">
  16562. Get whether the window should Display gridlines
  16563. @return gridlines or not
  16564. </member>
  16565. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayRowColHeadings">
  16566. Get whether the window should Display row and column headings
  16567. @return headings or not
  16568. </member>
  16569. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.FreezePanes">
  16570. Get whether the window should freeze panes
  16571. @return freeze panes or not
  16572. </member>
  16573. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayZeros">
  16574. Get whether the window should Display zero values
  16575. @return zeros or not
  16576. </member>
  16577. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DefaultHeader">
  16578. Get whether the window should Display a default header
  16579. @return header or not
  16580. </member>
  16581. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.Arabic">
  16582. Is this arabic?
  16583. @return arabic or not
  16584. </member>
  16585. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayGuts">
  16586. Get whether the outline symbols are displaed
  16587. @return symbols or not
  16588. </member>
  16589. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.FreezePanesNoSplit">
  16590. freeze Unsplit panes or not
  16591. @return freeze or not
  16592. </member>
  16593. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.IsSelected">
  16594. sheet tab Is selected
  16595. @return selected or not
  16596. </member>
  16597. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.IsActive">
  16598. Is the sheet currently Displayed in the window
  16599. @return Displayed or not
  16600. </member>
  16601. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.SavedInPageBreakPreview">
  16602. was the sheet saved in page break view
  16603. @return pagebreaksaved or not
  16604. </member>
  16605. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.TopRow">
  16606. Get the top row visible in the window
  16607. @return toprow
  16608. </member>
  16609. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.LeftCol">
  16610. Get the leftmost column Displayed in the window
  16611. @return leftmost
  16612. </member>
  16613. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.HeaderColor">
  16614. Get the palette index for the header color
  16615. @return color
  16616. </member>
  16617. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.PageBreakZoom">
  16618. zoom magification in page break view
  16619. @return zoom
  16620. </member>
  16621. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.NormalZoom">
  16622. Get the zoom magnification in normal view
  16623. @return zoom
  16624. </member>
  16625. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.Reserved">
  16626. Get the reserved bits - why would you do this?
  16627. @return reserved stuff -probably garbage
  16628. </member>
  16629. <member name="T:NPOI.HSSF.Record.WriteAccessRecord">
  16630. Title: Write Access Record
  16631. Description: Stores the username of that who owns the spReadsheet generator
  16632. (on Unix the user's login, on Windoze its the name you typed when
  16633. you installed the thing)
  16634. REFERENCE: PG 424 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  16635. @author Andrew C. Oliver (acoliver at apache dot org)
  16636. @version 2.0-pre
  16637. </member>
  16638. <member name="F:NPOI.HSSF.Record.WriteAccessRecord.PADDING">
  16639. this record is always padded to a constant length
  16640. </member>
  16641. <member name="M:NPOI.HSSF.Record.WriteAccessRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16642. Constructs a WriteAccess record and Sets its fields appropriately.
  16643. @param in the RecordInputstream to Read the record from
  16644. </member>
  16645. <member name="P:NPOI.HSSF.Record.WriteAccessRecord.Username">
  16646. Get the username for the user that Created the report. HSSF uses the logged in user. On
  16647. natively Created M$ Excel sheet this would be the name you typed in when you installed it
  16648. in most cases.
  16649. @return username of the user who Is logged in (probably "tomcat" or "apache")
  16650. </member>
  16651. <member name="T:NPOI.HSSF.Record.WriteProtectRecord">
  16652. Title: Write Protect Record
  16653. Description: Indicated that the sheet/workbook Is Write protected.
  16654. REFERENCE: PG 425 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  16655. @version 3.0-pre
  16656. </member>
  16657. <member name="M:NPOI.HSSF.Record.WriteProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16658. Constructs a WriteAccess record and Sets its fields appropriately.
  16659. @param in the RecordInputstream to Read the record from
  16660. </member>
  16661. <member name="T:NPOI.HSSF.Record.WSBoolRecord">
  16662. Title: WSBool Record.
  16663. Description: stores workbook Settings (aka its a big "everything we didn't
  16664. put somewhere else")
  16665. REFERENCE: PG 425 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  16666. @author Andrew C. Oliver (acoliver at apache dot org)
  16667. @author Glen Stampoultzis (gstamp@iprimus.com.au)
  16668. @author Jason Height (jheight at chariot dot net dot au)
  16669. @version 2.0-pre
  16670. </member>
  16671. <member name="M:NPOI.HSSF.Record.WSBoolRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16672. Constructs a WSBool record and Sets its fields appropriately.
  16673. @param in the RecordInputstream to Read the record from
  16674. </member>
  16675. <member name="P:NPOI.HSSF.Record.WSBoolRecord.WSBool1">
  16676. Get first byte (see bit Getters)
  16677. </member>
  16678. <member name="P:NPOI.HSSF.Record.WSBoolRecord.Autobreaks">
  16679. <summary>
  16680. Whether to show automatic page breaks or not
  16681. </summary>
  16682. </member>
  16683. <member name="P:NPOI.HSSF.Record.WSBoolRecord.Dialog">
  16684. <summary>
  16685. Whether sheet is a dialog sheet or not
  16686. </summary>
  16687. </member>
  16688. <member name="P:NPOI.HSSF.Record.WSBoolRecord.RowSumsBelow">
  16689. <summary>
  16690. Get if row summaries appear below detail in the outline
  16691. </summary>
  16692. </member>
  16693. <member name="P:NPOI.HSSF.Record.WSBoolRecord.RowSumsRight">
  16694. <summary>
  16695. Get if col summaries appear right of the detail in the outline
  16696. </summary>
  16697. </member>
  16698. <member name="P:NPOI.HSSF.Record.WSBoolRecord.WSBool2">
  16699. <summary>
  16700. Get the second byte (see bit Getters)
  16701. </summary>
  16702. </member>
  16703. <member name="P:NPOI.HSSF.Record.WSBoolRecord.FitToPage">
  16704. <summary>
  16705. fit to page option is on
  16706. </summary>
  16707. </member>
  16708. <member name="P:NPOI.HSSF.Record.WSBoolRecord.DisplayGuts">
  16709. <summary>
  16710. Whether to display the guts or not
  16711. </summary>
  16712. </member>
  16713. <member name="P:NPOI.HSSF.Record.WSBoolRecord.AlternateExpression">
  16714. <summary>
  16715. whether alternate expression evaluation is on
  16716. </summary>
  16717. </member>
  16718. <member name="P:NPOI.HSSF.Record.WSBoolRecord.AlternateFormula">
  16719. <summary>
  16720. whether alternative formula entry is on
  16721. </summary>
  16722. </member>
  16723. <member name="F:NPOI.HSSF.XmlTkBlob.xtHeader">
  16724. <summary>
  16725. The xtHeader.drType field MUST be equal to 0x07.
  16726. </summary>
  16727. </member>
  16728. <member name="F:NPOI.HSSF.XmlTkBool.xtHeader">
  16729. <summary>
  16730. The xtHeader.drType field MUST be equal to 0x02.
  16731. </summary>
  16732. </member>
  16733. <member name="F:NPOI.HSSF.XmlTkDouble.xtHeader">
  16734. <summary>
  16735. The xtHeader.drType field MUST be equal to 0x03.
  16736. </summary>
  16737. </member>
  16738. <member name="F:NPOI.HSSF.XmlTkDWord.xtHeader">
  16739. <summary>
  16740. The xtHeader.drType field MUST be equal to 0x04.
  16741. </summary>
  16742. </member>
  16743. <member name="F:NPOI.HSSF.XmlTkEnd.xtHeader">
  16744. <summary>
  16745. The xtHeader.drType field MUST be equal to 0x01.
  16746. </summary>
  16747. </member>
  16748. <member name="F:NPOI.HSSF.XmlTkString.xtHeader">
  16749. <summary>
  16750. The xtHeader.drType field MUST be equal to 0x05.
  16751. </summary>
  16752. </member>
  16753. <member name="F:NPOI.HSSF.XmlTkString.rgbValue">
  16754. <summary>
  16755. An array of Unicode characters. The size of the array, in characters, is specified
  16756. by the cchValue field. The size of the field, in bytes, MUST equal the result of
  16757. the following formula:cchValue * 2.
  16758. </summary>
  16759. </member>
  16760. <member name="F:NPOI.HSSF.XmlTkStyle.chartStyle">
  16761. <summary>
  16762. The chartStyle.xtHeader.xmlTkTag MUST be equal to 0x0003.
  16763. </summary>
  16764. </member>
  16765. <member name="F:NPOI.HSSF.XmlTkTickMarkSkipFrt.nInterval">
  16766. <summary>
  16767. The nInterval.xtHeader.xmlTkTag field MUST be equal to 0x0052.
  16768. </summary>
  16769. </member>
  16770. <member name="T:NPOI.HSSF.UserModel.DVConstraint">
  16771. @author Josh Micich
  16772. </member>
  16773. <member name="M:NPOI.HSSF.UserModel.DVConstraint.#ctor(System.String,System.String[])">
  16774. Creates a list constraint
  16775. </member>
  16776. <member name="M:NPOI.HSSF.UserModel.DVConstraint.CreateNumericConstraint(System.Int32,System.Int32,System.String,System.String)">
  16777. Creates a number based data validation constraint. The text values entered for expr1 and expr2
  16778. can be either standard Excel formulas or formatted number values. If the expression starts
  16779. with '=' it is Parsed as a formula, otherwise it is Parsed as a formatted number.
  16780. @param validationType one of {@link NPOI.SS.UserModel.DataValidationConstraint.ValidationType#ANY},
  16781. {@link NPOI.SS.UserModel.DataValidationConstraint.ValidationType#DECIMAL},
  16782. {@link NPOI.SS.UserModel.DataValidationConstraint.ValidationType#INTEGER},
  16783. {@link NPOI.SS.UserModel.DataValidationConstraint.ValidationType#TEXT_LENGTH}
  16784. @param comparisonOperator any constant from {@link NPOI.SS.UserModel.DataValidationConstraint.OperatorType} enum
  16785. @param expr1 date formula (when first char is '=') or formatted number value
  16786. @param expr2 date formula (when first char is '=') or formatted number value
  16787. </member>
  16788. <member name="M:NPOI.HSSF.UserModel.DVConstraint.CreateTimeConstraint(System.Int32,System.String,System.String)">
  16789. Creates a time based data validation constraint. The text values entered for expr1 and expr2
  16790. can be either standard Excel formulas or formatted time values. If the expression starts
  16791. with '=' it is Parsed as a formula, otherwise it is Parsed as a formatted time. To parse
  16792. formatted times, two formats are supported: "HH:MM" or "HH:MM:SS". This is contrary to
  16793. Excel which uses the default time format from the OS.
  16794. @param comparisonOperator constant from {@link NPOI.SS.UserModel.DataValidationConstraint.OperatorType} enum
  16795. @param expr1 date formula (when first char is '=') or formatted time value
  16796. @param expr2 date formula (when first char is '=') or formatted time value
  16797. </member>
  16798. <member name="M:NPOI.HSSF.UserModel.DVConstraint.CreateDateConstraint(System.Int32,System.String,System.String,System.String)">
  16799. Creates a date based data validation constraint. The text values entered for expr1 and expr2
  16800. can be either standard Excel formulas or formatted date values. If the expression starts
  16801. with '=' it is Parsed as a formula, otherwise it is Parsed as a formatted date (Excel uses
  16802. the same convention). To parse formatted dates, a date format needs to be specified. This
  16803. is contrary to Excel which uses the default short date format from the OS.
  16804. @param comparisonOperator constant from {@link NPOI.SS.UserModel.DataValidationConstraint.OperatorType} enum
  16805. @param expr1 date formula (when first char is '=') or formatted date value
  16806. @param expr2 date formula (when first char is '=') or formatted date value
  16807. @param dateFormat ignored if both expr1 and expr2 are formulas. Default value is "YYYY/MM/DD"
  16808. otherwise any other valid argument for <c>SimpleDateFormat</c> can be used
  16809. @see <a href='http://java.sun.com/j2se/1.5.0/docs/api/java/text/DateFormat.html'>SimpleDateFormat</a>
  16810. </member>
  16811. <member name="M:NPOI.HSSF.UserModel.DVConstraint.GetFormulaFromTextExpression(System.String)">
  16812. Distinguishes formula expressions from simple value expressions. This logic is only
  16813. required by a few factory methods in this class that create data validation constraints
  16814. from more or less the same parameters that would have been entered in the Excel UI. The
  16815. data validation dialog box uses the convention that formulas begin with '='. Other methods
  16816. in this class follow the POI convention (formulas and values are distinct), so the '='
  16817. convention is not used there.
  16818. @param textExpr a formula or value expression
  16819. @return all text After '=' if textExpr begins with '='. Otherwise <code>null</code> if textExpr does not begin with '='
  16820. </member>
  16821. <member name="M:NPOI.HSSF.UserModel.DVConstraint.ConvertNumber(System.String)">
  16822. @return <code>null</code> if numberStr is <code>null</code>
  16823. </member>
  16824. <member name="M:NPOI.HSSF.UserModel.DVConstraint.ConvertTime(System.String)">
  16825. @return <code>null</code> if timeStr is <code>null</code>
  16826. </member>
  16827. <member name="M:NPOI.HSSF.UserModel.DVConstraint.ConvertDate(System.String,NPOI.SS.Util.SimpleDateFormat)">
  16828. @param dateFormat pass <code>null</code> for default YYYYMMDD
  16829. @return <code>null</code> if timeStr is <code>null</code>
  16830. </member>
  16831. <member name="P:NPOI.HSSF.UserModel.DVConstraint.IsListValidationType">
  16832. Convenience method
  16833. @return <c>true</c> if this constraint is a 'list' validation
  16834. </member>
  16835. <member name="P:NPOI.HSSF.UserModel.DVConstraint.IsExplicitList">
  16836. Convenience method
  16837. @return <c>true</c> if this constraint is a 'list' validation with explicit values
  16838. </member>
  16839. <member name="P:NPOI.HSSF.UserModel.DVConstraint.Value1">
  16840. @return the numeric value for expression 1. May be <c>null</c>
  16841. </member>
  16842. <member name="P:NPOI.HSSF.UserModel.DVConstraint.Value2">
  16843. @return the numeric value for expression 2. May be <c>null</c>
  16844. </member>
  16845. <member name="M:NPOI.HSSF.UserModel.DVConstraint.CreateFormulas(NPOI.HSSF.UserModel.HSSFSheet)">
  16846. @return both Parsed formulas (for expression 1 and 2).
  16847. </member>
  16848. <member name="M:NPOI.HSSF.UserModel.DVConstraint.ConvertDoubleFormula(System.String,System.Double,NPOI.HSSF.UserModel.HSSFSheet)">
  16849. @return The Parsed token array representing the formula or value specified.
  16850. Empty array if both formula and value are <code>null</code>
  16851. </member>
  16852. <member name="T:NPOI.HSSF.UserModel.EscherGraphics">
  16853. Translates Graphics calls into escher calls. The translation Is lossy so
  16854. many features are not supported and some just aren't implemented yet. If
  16855. in doubt test the specific calls you wish to make. Graphics calls are
  16856. always performed into an EscherGroup so one will need to be Created.
  16857. <b>Important:</b>
  16858. <blockquote>
  16859. One important concept worth considering Is that of font size. One of the
  16860. difficulties in Converting Graphics calls into escher Drawing calls Is that
  16861. Excel does not have the concept of absolute pixel positions. It measures
  16862. it's cell widths in 'Chars' and the cell heights in points.
  16863. Unfortunately it's not defined exactly what a type of Char it's
  16864. measuring. Presumably this Is due to the fact that the Excel will be
  16865. using different fonts on different platforms or even within the same
  16866. platform.
  16867. Because of this constraint we've had to calculate the
  16868. verticalPointsPerPixel. This the amount the font should be scaled by when
  16869. you Issue commands such as DrawString(). A good way to calculate this
  16870. Is to use the follow formula:
  16871. <pre>
  16872. multipler = GroupHeightInPoints / heightOfGroup
  16873. </pre>
  16874. The height of the Group Is calculated fairly simply by calculating the
  16875. difference between the y coordinates of the bounding box of the shape. The
  16876. height of the Group can be calculated by using a convenience called
  16877. <c>HSSFClientAnchor.GetAnchorHeightInPoints()</c>.
  16878. </blockquote>
  16879. @author Glen Stampoultzis (glens at apache.org)
  16880. </member>
  16881. <member name="M:NPOI.HSSF.UserModel.EscherGraphics.#ctor(NPOI.HSSF.UserModel.HSSFShapeGroup,NPOI.HSSF.UserModel.HSSFWorkbook,SixLabors.ImageSharp.Color,System.Single)">
  16882. Construct an escher graphics object.
  16883. @param escherGroup The escher Group to Write the graphics calls into.
  16884. @param workbook The workbook we are using.
  16885. @param forecolor The foreground color to use as default.
  16886. @param verticalPointsPerPixel The font multiplier. (See class description for information on how this works.).
  16887. </member>
  16888. <member name="M:NPOI.HSSF.UserModel.EscherGraphics.#ctor(NPOI.HSSF.UserModel.HSSFShapeGroup,NPOI.HSSF.UserModel.HSSFWorkbook,SixLabors.ImageSharp.Color,SixLabors.Fonts.Font,System.Single)">
  16889. Constructs an escher graphics object.
  16890. @param escherGroup The escher Group to Write the graphics calls into.
  16891. @param workbook The workbook we are using.
  16892. @param foreground The foreground color to use as default.
  16893. @param verticalPointsPerPixel The font multiplier. (See class description for information on how this works.).
  16894. @param font The font to use.
  16895. </member>
  16896. <member name="M:NPOI.HSSF.UserModel.EscherGraphics.FillPolygon(System.Int32[],System.Int32[],System.Int32)">
  16897. Fills a (closed) polygon, as defined by a pair of arrays, which
  16898. hold the <i>x</i> and <i>y</i> coordinates.
  16899. This Draws the polygon, with <c>nPoint</c> line segments.
  16900. The first <c>nPoint - 1</c> line segments are
  16901. Drawn between sequential points
  16902. (<c>xPoints[i],yPoints[i],xPoints[i+1],yPoints[i+1]</c>).
  16903. The line segment Is a closing one, from the last point to
  16904. the first (assuming they are different).
  16905. The area inside of the polygon Is defined by using an
  16906. even-odd Fill rule (also known as the alternating rule), and
  16907. the area inside of it Is Filled.
  16908. @param xPoints array of the <c>x</c> coordinates.
  16909. @param yPoints array of the <c>y</c> coordinates.
  16910. @param nPoints the total number of points in the polygon.
  16911. @see java.awt.Graphics#DrawPolygon(int[], int[], int)
  16912. </member>
  16913. <member name="T:NPOI.HSSF.UserModel.EvaluationCycleDetector">
  16914. Instances of this class keep track of multiple dependent cell evaluations due
  16915. to recursive calls to <c>HSSFFormulaEvaluator.internalEvaluate()</c>.
  16916. The main purpose of this class Is to detect an attempt to evaluate a cell
  16917. that Is alReady being evaluated. In other words, it detects circular
  16918. references in spReadsheet formulas.
  16919. @author Josh Micich
  16920. </member>
  16921. <member name="T:NPOI.HSSF.UserModel.EvaluationCycleDetector.CellEvaluationFrame">
  16922. Stores the parameters that identify the evaluation of one cell.<br/>
  16923. </member>
  16924. <member name="M:NPOI.HSSF.UserModel.EvaluationCycleDetector.CellEvaluationFrame.FormatAsString">
  16925. @return human Readable string for debug purposes
  16926. </member>
  16927. <member name="M:NPOI.HSSF.UserModel.EvaluationCycleDetector.StartEvaluate(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,System.Int32,System.Int32)">
  16928. Notifies this evaluation tracker that evaluation of the specified cell Is
  16929. about to start.<br/>
  16930. In the case of a <c>true</c> return code, the caller should
  16931. continue evaluation of the specified cell, and also be sure to call
  16932. <c>endEvaluate()</c> when complete.<br/>
  16933. In the case of a <c>false</c> return code, the caller should
  16934. return an evaluation result of
  16935. <c>ErrorEval.CIRCULAR_REF_ERROR</c>, and not call <c>endEvaluate()</c>.
  16936. <br/>
  16937. @return <c>true</c> if the specified cell has not been visited yet in the current
  16938. evaluation. <c>false</c> if the specified cell Is alReady being evaluated.
  16939. </member>
  16940. <member name="M:NPOI.HSSF.UserModel.EvaluationCycleDetector.EndEvaluate(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,System.Int32,System.Int32)">
  16941. Notifies this evaluation tracker that the evaluation of the specified
  16942. cell Is complete. <p/>
  16943. Every successful call to <c>startEvaluate</c> must be followed by a
  16944. call to <c>endEvaluate</c> (recommended in a finally block) to enable
  16945. proper tracking of which cells are being evaluated at any point in time.<p/>
  16946. Assuming a well behaved client, parameters to this method would not be
  16947. required. However, they have been included to assert correct behaviour,
  16948. and form more meaningful error messages.
  16949. </member>
  16950. <member name="T:NPOI.HSSF.UserModel.EvaluationCycleDetectorManager">
  16951. This class makes an <c>EvaluationCycleDetector</c> instance available to
  16952. each thRead via a <c>ThReadLocal</c> in order to avoid Adding a parameter
  16953. to a few protected methods within <c>HSSFFormulaEvaluator</c>.
  16954. @author Josh Micich
  16955. </member>
  16956. <member name="M:NPOI.HSSF.UserModel.EvaluationCycleDetectorManager.GetTracker">
  16957. @return
  16958. </member>
  16959. <member name="T:NPOI.HSSF.UserModel.FontDetails">
  16960. <summary>
  16961. Stores width and height details about a font.
  16962. @author Glen Stampoultzis (glens at apache.org)
  16963. </summary>
  16964. </member>
  16965. <member name="M:NPOI.HSSF.UserModel.FontDetails.#ctor(System.String,System.Int32)">
  16966. <summary>
  16967. Construct the font details with the given name and height.
  16968. </summary>
  16969. <param name="fontName">The font name.</param>
  16970. <param name="height">The height of the font.</param>
  16971. </member>
  16972. <member name="M:NPOI.HSSF.UserModel.FontDetails.GetFontName">
  16973. <summary>
  16974. Gets the name of the font.
  16975. </summary>
  16976. <returns></returns>
  16977. </member>
  16978. <member name="M:NPOI.HSSF.UserModel.FontDetails.GetHeight">
  16979. <summary>
  16980. Gets the height.
  16981. </summary>
  16982. <returns></returns>
  16983. </member>
  16984. <member name="M:NPOI.HSSF.UserModel.FontDetails.AddChar(System.Char,System.Int32)">
  16985. <summary>
  16986. Adds the char.
  16987. </summary>
  16988. <param name="c">The c.</param>
  16989. <param name="width">The width.</param>
  16990. </member>
  16991. <member name="M:NPOI.HSSF.UserModel.FontDetails.GetCharWidth(System.Char)">
  16992. <summary>
  16993. Retrieves the width of the specified Char. If the metrics for
  16994. a particular Char are not available it defaults to returning the
  16995. width for the 'W' Char.
  16996. </summary>
  16997. <param name="c">The character.</param>
  16998. <returns></returns>
  16999. </member>
  17000. <member name="M:NPOI.HSSF.UserModel.FontDetails.AddChars(System.Char[],System.Int32[])">
  17001. <summary>
  17002. Adds the chars.
  17003. </summary>
  17004. <param name="Chars">The chars.</param>
  17005. <param name="widths">The widths.</param>
  17006. </member>
  17007. <member name="M:NPOI.HSSF.UserModel.FontDetails.BuildFontHeightProperty(System.String)">
  17008. <summary>
  17009. Builds the font height property.
  17010. </summary>
  17011. <param name="fontName">Name of the font.</param>
  17012. <returns></returns>
  17013. </member>
  17014. <member name="M:NPOI.HSSF.UserModel.FontDetails.BuildFontWidthsProperty(System.String)">
  17015. <summary>
  17016. Builds the font widths property.
  17017. </summary>
  17018. <param name="fontName">Name of the font.</param>
  17019. <returns></returns>
  17020. </member>
  17021. <member name="M:NPOI.HSSF.UserModel.FontDetails.BuildFontCharsProperty(System.String)">
  17022. <summary>
  17023. Builds the font chars property.
  17024. </summary>
  17025. <param name="fontName">Name of the font.</param>
  17026. <returns></returns>
  17027. </member>
  17028. <member name="M:NPOI.HSSF.UserModel.FontDetails.Create(System.String,NPOI.Util.Collections.Properties)">
  17029. <summary>
  17030. Create an instance of
  17031. <c>FontDetails</c>
  17032. by loading them from the
  17033. provided property object.
  17034. </summary>
  17035. <param name="fontName">the font name.</param>
  17036. <param name="fontMetricsProps">the property object holding the details of this
  17037. particular font.</param>
  17038. <returns>a new FontDetails instance.</returns>
  17039. </member>
  17040. <member name="M:NPOI.HSSF.UserModel.FontDetails.GetStringWidth(System.String)">
  17041. <summary>
  17042. Gets the width of all Chars in a string.
  17043. </summary>
  17044. <param name="str">The string to measure.</param>
  17045. <returns>The width of the string for a 10 point font.</returns>
  17046. </member>
  17047. <member name="M:NPOI.HSSF.UserModel.FontDetails.Split(System.String,System.String,System.Int32)">
  17048. <summary>
  17049. Split the given string into an array of strings using the given
  17050. delimiter.
  17051. </summary>
  17052. <param name="text">The text.</param>
  17053. <param name="separator">The separator.</param>
  17054. <param name="max">The max.</param>
  17055. <returns></returns>
  17056. </member>
  17057. <member name="T:NPOI.HSSF.UserModel.HeaderFooter">
  17058. <summary>
  17059. Common class for HSSFHeader and HSSFFooter
  17060. </summary>
  17061. </member>
  17062. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.RawText">
  17063. @return the internal text representation (combining center, left and right parts).
  17064. Possibly empty string if no header or footer is set. Never <c>null</c>.
  17065. </member>
  17066. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.UpdateHeaderFooterText(System.String[])">
  17067. <summary>
  17068. Creates the complete footer string based on the left, center, and middle
  17069. strings.
  17070. </summary>
  17071. <param name="parts">The parts.</param>
  17072. </member>
  17073. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.SetHeaderFooterText(System.String)">
  17074. <summary>
  17075. Sets the header footer text.
  17076. </summary>
  17077. <param name="text">the new header footer text (contains mark-up tags). Possibly
  17078. empty string never </param>
  17079. </member>
  17080. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Left">
  17081. <summary>
  17082. Get the left side of the header or footer.
  17083. </summary>
  17084. <value>The string representing the left side.</value>
  17085. </member>
  17086. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Center">
  17087. <summary>
  17088. Get the center of the header or footer.
  17089. </summary>
  17090. <value>The string representing the center.</value>
  17091. </member>
  17092. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Right">
  17093. <summary>
  17094. Get the right side of the header or footer.
  17095. </summary>
  17096. <value>The string representing the right side..</value>
  17097. </member>
  17098. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.FontSize(System.Int16)">
  17099. <summary>
  17100. Returns the string that represents the change in font size.
  17101. </summary>
  17102. <param name="size">the new font size.</param>
  17103. <returns>The special string to represent a new font size</returns>
  17104. </member>
  17105. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.Font(System.String,System.String)">
  17106. <summary>
  17107. Returns the string that represents the change in font.
  17108. </summary>
  17109. <param name="font">the new font.</param>
  17110. <param name="style">the fonts style, one of regular, italic, bold, italic bold or bold italic.</param>
  17111. <returns>The special string to represent a new font size</returns>
  17112. </member>
  17113. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Page">
  17114. <summary>
  17115. Returns the string representing the current page number
  17116. </summary>
  17117. <value>The special string for page number.</value>
  17118. </member>
  17119. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.NumPages">
  17120. <summary>
  17121. Returns the string representing the number of pages.
  17122. </summary>
  17123. <value>The special string for the number of pages.</value>
  17124. </member>
  17125. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Date">
  17126. <summary>
  17127. Returns the string representing the current date
  17128. </summary>
  17129. <value>The special string for the date</value>
  17130. </member>
  17131. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Time">
  17132. <summary>
  17133. Gets the time.
  17134. </summary>
  17135. <value>The time.</value>
  17136. Returns the string representing the current time
  17137. @return The special string for the time
  17138. </member>
  17139. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.File">
  17140. <summary>
  17141. Returns the string representing the current file name
  17142. </summary>
  17143. <value>The special string for the file name.</value>
  17144. </member>
  17145. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Tab">
  17146. <summary>
  17147. Returns the string representing the current tab (sheet) name
  17148. </summary>
  17149. <value>The special string for tab name.</value>
  17150. </member>
  17151. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.StartBold">
  17152. <summary>
  17153. Returns the string representing the start bold
  17154. </summary>
  17155. <returns>The special string for start bold</returns>
  17156. </member>
  17157. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.EndBold">
  17158. <summary>
  17159. Returns the string representing the end bold
  17160. </summary>
  17161. <value>The special string for end bold.</value>
  17162. </member>
  17163. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.StartUnderline">
  17164. <summary>
  17165. Returns the string representing the start underline
  17166. </summary>
  17167. <value>The special string for start underline.</value>
  17168. </member>
  17169. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.EndUnderline">
  17170. <summary>
  17171. Returns the string representing the end underline
  17172. </summary>
  17173. <value>The special string for end underline.</value>
  17174. </member>
  17175. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.StartDoubleUnderline">
  17176. <summary>
  17177. Returns the string representing the start double underline
  17178. </summary>
  17179. <value>The special string for start double underline.</value>
  17180. </member>
  17181. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.EndDoubleUnderline">
  17182. <summary>
  17183. Returns the string representing the end double underline
  17184. </summary>
  17185. <value>The special string for end double underline.</value>
  17186. </member>
  17187. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.StripFields(System.String)">
  17188. <summary>
  17189. Removes any fields (eg macros, page markers etc)
  17190. from the string.
  17191. Normally used to make some text suitable for showing
  17192. to humans, and the resultant text should not normally
  17193. be saved back into the document!
  17194. </summary>
  17195. <param name="text">The text.</param>
  17196. <returns></returns>
  17197. </member>
  17198. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.AreFieldsStripped">
  17199. <summary>
  17200. Are fields currently being Stripped from
  17201. the text that this {@link HeaderStories} returns?
  17202. Default is false, but can be changed
  17203. </summary>
  17204. <value><c>true</c> if [are fields stripped]; otherwise, <c>false</c>.</value>
  17205. </member>
  17206. <member name="T:NPOI.HSSF.UserModel.HeaderFooter.Field">
  17207. <summary>
  17208. Represents a special field in a header or footer,
  17209. eg the page number
  17210. </summary>
  17211. </member>
  17212. <member name="F:NPOI.HSSF.UserModel.HeaderFooter.Field.sequence">
  17213. The character sequence that marks this field
  17214. </member>
  17215. <member name="T:NPOI.HSSF.UserModel.HeaderFooter.PairField">
  17216. <summary>
  17217. A special field that normally comes in a pair, eg
  17218. turn on underline / turn off underline
  17219. </summary>
  17220. </member>
  17221. <member name="F:NPOI.HSSF.UserModel.HeaderFooter.Fields.instance">
  17222. <summary>
  17223. Instance to this class.
  17224. </summary>
  17225. </member>
  17226. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.Fields.#cctor">
  17227. <summary>
  17228. Explicit static constructor to tell C# compiler not to mark type as beforefieldinit.
  17229. </summary>
  17230. </member>
  17231. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.Fields.#ctor">
  17232. <summary>
  17233. Initialize AllFields.
  17234. </summary>
  17235. </member>
  17236. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Fields.Instance">
  17237. <summary>
  17238. Accessing the initialized instance.
  17239. </summary>
  17240. </member>
  17241. <member name="M:NPOI.HSSF.UserModel.Helpers.HSSFRowColShifter.UpdateFormulas(NPOI.SS.UserModel.ISheet,NPOI.SS.Formula.FormulaShifter)">
  17242. <summary>
  17243. Update formulas.
  17244. </summary>
  17245. <param name="sheet"></param>
  17246. <param name="formulaShifter"></param>
  17247. </member>
  17248. <member name="M:NPOI.HSSF.UserModel.Helpers.HSSFRowColShifter.UpdateRowFormulas(NPOI.SS.UserModel.IRow,NPOI.SS.Formula.FormulaShifter)">
  17249. <summary>
  17250. Update the formulas in specified row using the formula shifting policy specified by shifter
  17251. </summary>
  17252. <param name="row">the row to update the formulas on</param>
  17253. <param name="formulaShifter">the formula shifting policy</param>
  17254. </member>
  17255. <member name="M:NPOI.HSSF.UserModel.Helpers.HSSFRowColShifter.ShiftFormula(NPOI.SS.UserModel.IRow,System.String,NPOI.SS.Formula.FormulaShifter)">
  17256. <summary>
  17257. Shift a formula using the supplied FormulaShifter
  17258. </summary>
  17259. <param name="row">the row of the cell this formula belongs to. Used to get a reference to the parent workbook.</param>
  17260. <param name="formula">the formula to shift</param>
  17261. <param name="formulaShifter">the FormulaShifter object that operates on the parsed formula tokens</param>
  17262. <returns>the shifted formula if the formula was changed, null if the formula wasn't modified</returns>
  17263. </member>
  17264. <member name="T:NPOI.HSSF.UserModel.helpers.HSSFRowShifter">
  17265. Helper for Shifting rows up or down
  17266. When possible, code should be implemented in the RowShifter abstract class to avoid duplication with {@link NPOI.XSSF.UserModel.helpers.XSSFRowShifter}
  17267. </member>
  17268. <member name="T:NPOI.HSSF.UserModel.HSSFAnchor">
  17269. <summary>
  17270. An anchor Is what specifics the position of a shape within a client object
  17271. or within another containing shape.
  17272. @author Glen Stampoultzis (glens at apache.org)
  17273. </summary>
  17274. </member>
  17275. <member name="M:NPOI.HSSF.UserModel.HSSFAnchor.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
  17276. <summary>
  17277. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFAnchor"/> class.
  17278. </summary>
  17279. <param name="dx1">The DX1.</param>
  17280. <param name="dy1">The dy1.</param>
  17281. <param name="dx2">The DX2.</param>
  17282. <param name="dy2">The dy2.</param>
  17283. </member>
  17284. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.Dx1">
  17285. <summary>
  17286. Gets or sets the DX1.
  17287. </summary>
  17288. <value>The DX1.</value>
  17289. </member>
  17290. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.Dy1">
  17291. <summary>
  17292. Gets or sets the dy1.
  17293. </summary>
  17294. <value>The dy1.</value>
  17295. </member>
  17296. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.Dy2">
  17297. <summary>
  17298. Gets or sets the dy2.
  17299. </summary>
  17300. <value>The dy2.</value>
  17301. </member>
  17302. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.Dx2">
  17303. <summary>
  17304. Gets or sets the DX2.
  17305. </summary>
  17306. <value>The DX2.</value>
  17307. </member>
  17308. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.IsHorizontallyFlipped">
  17309. <summary>
  17310. Gets a value indicating whether this instance is horizontally flipped.
  17311. </summary>
  17312. <value>
  17313. <c>true</c> if this instance is horizontally flipped; otherwise, <c>false</c>.
  17314. </value>
  17315. </member>
  17316. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.IsVerticallyFlipped">
  17317. <summary>
  17318. Gets a value indicating whether this instance is vertically flipped.
  17319. </summary>
  17320. <value>
  17321. <c>true</c> if this instance is vertically flipped; otherwise, <c>false</c>.
  17322. </value>
  17323. </member>
  17324. <member name="T:NPOI.HSSF.UserModel.HSSFBorderFormatting">
  17325. High level representation for Border Formatting component
  17326. of Conditional Formatting Settings
  17327. @author Dmitriy Kumshayev
  17328. </member>
  17329. <member name="T:NPOI.HSSF.UserModel.HSSFCell">
  17330. <summary>
  17331. High level representation of a cell in a row of a spReadsheet.
  17332. Cells can be numeric, formula-based or string-based (text). The cell type
  17333. specifies this. String cells cannot conatin numbers and numeric cells cannot
  17334. contain strings (at least according to our model). Client apps should do the
  17335. conversions themselves. Formula cells have the formula string, as well as
  17336. the formula result, which can be numeric or string.
  17337. Cells should have their number (0 based) before being Added to a row. Only
  17338. cells that have values should be Added.
  17339. </summary>
  17340. <remarks>
  17341. @author Andrew C. Oliver (acoliver at apache dot org)
  17342. @author Dan Sherman (dsherman at Isisph.com)
  17343. @author Brian Sanders (kestrel at burdell dot org) Active Cell support
  17344. @author Yegor Kozlov cell comments support
  17345. </remarks>
  17346. </member>
  17347. <member name="M:NPOI.HSSF.UserModel.HSSFCell.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,System.Int32,System.Int16)">
  17348. <summary>
  17349. Creates new Cell - Should only be called by HSSFRow. This Creates a cell
  17350. from scratch.
  17351. When the cell is initially Created it is Set to CellType.Blank. Cell types
  17352. can be Changed/overwritten by calling SetCellValue with the appropriate
  17353. type as a parameter although conversions from one type to another may be
  17354. prohibited.
  17355. </summary>
  17356. <param name="book">Workbook record of the workbook containing this cell</param>
  17357. <param name="sheet">Sheet record of the sheet containing this cell</param>
  17358. <param name="row">the row of this cell</param>
  17359. <param name="col">the column for this cell</param>
  17360. </member>
  17361. <member name="M:NPOI.HSSF.UserModel.HSSFCell.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,System.Int32,System.Int16,NPOI.SS.UserModel.CellType)">
  17362. <summary>
  17363. Creates new Cell - Should only be called by HSSFRow. This Creates a cell
  17364. from scratch.
  17365. </summary>
  17366. <param name="book">Workbook record of the workbook containing this cell</param>
  17367. <param name="sheet">Sheet record of the sheet containing this cell</param>
  17368. <param name="row">the row of this cell</param>
  17369. <param name="col">the column for this cell</param>
  17370. <param name="type">CellType.Numeric, CellType.String, CellType.Formula, CellType.Blank,
  17371. CellType.Boolean, CellType.Error</param>
  17372. </member>
  17373. <member name="M:NPOI.HSSF.UserModel.HSSFCell.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.Record.CellValueRecordInterface)">
  17374. <summary>
  17375. Creates an Cell from a CellValueRecordInterface. HSSFSheet uses this when
  17376. reading in cells from an existing sheet.
  17377. </summary>
  17378. <param name="book">Workbook record of the workbook containing this cell</param>
  17379. <param name="sheet">Sheet record of the sheet containing this cell</param>
  17380. <param name="cval">the Cell Value Record we wish to represent</param>
  17381. </member>
  17382. <member name="M:NPOI.HSSF.UserModel.HSSFCell.#ctor">
  17383. private constructor to prevent blank construction
  17384. </member>
  17385. <member name="M:NPOI.HSSF.UserModel.HSSFCell.DetermineType(NPOI.HSSF.Record.CellValueRecordInterface)">
  17386. used internally -- given a cell value record, figure out its type
  17387. </member>
  17388. <member name="P:NPOI.HSSF.UserModel.HSSFCell.BoundWorkbook">
  17389. <summary>
  17390. the Workbook that this Cell is bound to
  17391. </summary>
  17392. </member>
  17393. <member name="P:NPOI.HSSF.UserModel.HSSFCell.Row">
  17394. <summary>
  17395. the HSSFRow this cell belongs to
  17396. </summary>
  17397. </member>
  17398. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellType(NPOI.SS.UserModel.CellType)">
  17399. <summary>
  17400. Set the cells type (numeric, formula or string)
  17401. </summary>
  17402. <param name="cellType">Type of the cell.</param>
  17403. </member>
  17404. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellType(NPOI.SS.UserModel.CellType,System.Boolean,System.Int32,System.Int32,System.Int16)">
  17405. <summary>
  17406. Sets the cell type. The SetValue flag indicates whether to bother about
  17407. trying to preserve the current value in the new record if one is Created.
  17408. The SetCellValue method will call this method with false in SetValue
  17409. since it will overWrite the cell value later
  17410. </summary>
  17411. <param name="cellType">Type of the cell.</param>
  17412. <param name="setValue">if set to <c>true</c> [set value].</param>
  17413. <param name="row">The row.</param>
  17414. <param name="col">The col.</param>
  17415. <param name="styleIndex">Index of the style.</param>
  17416. </member>
  17417. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellType">
  17418. <summary>
  17419. Get the cells type (numeric, formula or string)
  17420. </summary>
  17421. <value>The type of the cell.</value>
  17422. </member>
  17423. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(System.Double)">
  17424. <summary>
  17425. Set a numeric value for the cell
  17426. </summary>
  17427. <param name="value">the numeric value to Set this cell to. For formulas we'll Set the
  17428. precalculated value, for numerics we'll Set its value. For other types we
  17429. will Change the cell to a numeric cell and Set its value.</param>
  17430. </member>
  17431. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(System.DateTime)">
  17432. <summary>
  17433. Set a date value for the cell. Excel treats dates as numeric so you will need to format the cell as
  17434. a date.
  17435. </summary>
  17436. <param name="value">the date value to Set this cell to. For formulas we'll Set the
  17437. precalculated value, for numerics we'll Set its value. For other types we
  17438. will Change the cell to a numeric cell and Set its value.</param>
  17439. </member>
  17440. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(System.String)">
  17441. <summary>
  17442. Set a string value for the cell. Please note that if you are using
  17443. full 16 bit Unicode you should call SetEncoding() first.
  17444. </summary>
  17445. <param name="value">value to Set the cell to. For formulas we'll Set the formula
  17446. string, for String cells we'll Set its value. For other types we will
  17447. Change the cell to a string cell and Set its value.
  17448. If value is null then we will Change the cell to a Blank cell.</param>
  17449. </member>
  17450. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellErrorValue(System.Byte)">
  17451. set a error value for the cell
  17452. @param errorCode the error value to set this cell to. For formulas we'll set the
  17453. precalculated value , for errors we'll set
  17454. its value. For other types we will change the cell to an error
  17455. cell and set its value.
  17456. </member>
  17457. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellErrorValue(NPOI.SS.UserModel.FormulaError)">
  17458. set a error value for the cell
  17459. @param error the error value to set this cell to. For formulas we'll set the
  17460. precalculated value , for errors we'll set
  17461. its value. For other types we will change the cell to an error
  17462. cell and set its value.
  17463. </member>
  17464. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(NPOI.SS.UserModel.IRichTextString)">
  17465. <summary>
  17466. Set a string value for the cell. Please note that if you are using
  17467. full 16 bit Unicode you should call SetEncoding() first.
  17468. </summary>
  17469. <param name="value">value to Set the cell to. For formulas we'll Set the formula
  17470. string, for String cells we'll Set its value. For other types we will
  17471. Change the cell to a string cell and Set its value.
  17472. If value is null then we will Change the cell to a Blank cell.</param>
  17473. </member>
  17474. <member name="M:NPOI.HSSF.UserModel.HSSFCell.NotifyFormulaChanging">
  17475. Should be called any time that a formula could potentially be deleted.
  17476. Does nothing if this cell currently does not hold a formula
  17477. </member>
  17478. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellFormula">
  17479. <summary>
  17480. Gets or sets the cell formula.
  17481. </summary>
  17482. <value>The cell formula.</value>
  17483. </member>
  17484. <member name="M:NPOI.HSSF.UserModel.HSSFCell.TryToDeleteArrayFormula(System.String)">
  17485. <summary>
  17486. Called when this an array formula in this cell is deleted.
  17487. </summary>
  17488. <param name="message">a customized exception message for the case if deletion of the cell is impossible. If null, a default message will be generated</param>
  17489. </member>
  17490. <member name="P:NPOI.HSSF.UserModel.HSSFCell.NumericCellValue">
  17491. <summary>
  17492. Get the value of the cell as a number. For strings we throw an exception.
  17493. For blank cells we return a 0.
  17494. </summary>
  17495. <value>The numeric cell value.</value>
  17496. </member>
  17497. <member name="M:NPOI.HSSF.UserModel.HSSFCell.GetCellTypeName(NPOI.SS.UserModel.CellType)">
  17498. <summary>
  17499. Used to help format error messages
  17500. </summary>
  17501. <param name="cellTypeCode">The cell type code.</param>
  17502. <returns></returns>
  17503. </member>
  17504. <member name="M:NPOI.HSSF.UserModel.HSSFCell.TypeMismatch(NPOI.SS.UserModel.CellType,NPOI.SS.UserModel.CellType,System.Boolean)">
  17505. <summary>
  17506. Types the mismatch.
  17507. </summary>
  17508. <param name="expectedTypeCode">The expected type code.</param>
  17509. <param name="actualTypeCode">The actual type code.</param>
  17510. <param name="isFormulaCell">if set to <c>true</c> [is formula cell].</param>
  17511. <returns></returns>
  17512. </member>
  17513. <member name="M:NPOI.HSSF.UserModel.HSSFCell.CheckFormulaCachedValueType(NPOI.SS.UserModel.CellType,NPOI.HSSF.Record.FormulaRecord)">
  17514. <summary>
  17515. Checks the type of the formula cached value.
  17516. </summary>
  17517. <param name="expectedTypeCode">The expected type code.</param>
  17518. <param name="fr">The fr.</param>
  17519. </member>
  17520. <member name="P:NPOI.HSSF.UserModel.HSSFCell.DateCellValue">
  17521. <summary>
  17522. Get the value of the cell as a date. For strings we throw an exception.
  17523. For blank cells we return a null.
  17524. </summary>
  17525. <value>The date cell value.</value>
  17526. </member>
  17527. <member name="P:NPOI.HSSF.UserModel.HSSFCell.StringCellValue">
  17528. <summary>
  17529. Get the value of the cell as a string - for numeric cells we throw an exception.
  17530. For blank cells we return an empty string.
  17531. For formulaCells that are not string Formulas, we return empty String
  17532. </summary>
  17533. <value>The string cell value.</value>
  17534. </member>
  17535. <member name="P:NPOI.HSSF.UserModel.HSSFCell.RichStringCellValue">
  17536. <summary>
  17537. Get the value of the cell as a string - for numeric cells we throw an exception.
  17538. For blank cells we return an empty string.
  17539. For formulaCells that are not string Formulas, we return empty String
  17540. </summary>
  17541. <value>The rich string cell value.</value>
  17542. </member>
  17543. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(System.Boolean)">
  17544. <summary>
  17545. Set a bool value for the cell
  17546. </summary>
  17547. <param name="value">the bool value to Set this cell to. For formulas we'll Set the
  17548. precalculated value, for bools we'll Set its value. For other types we
  17549. will Change the cell to a bool cell and Set its value.</param>
  17550. </member>
  17551. <member name="M:NPOI.HSSF.UserModel.HSSFCell.ConvertCellValueToBoolean">
  17552. <summary>
  17553. Chooses a new bool value for the cell when its type is changing.
  17554. Usually the caller is calling SetCellType() with the intention of calling
  17555. SetCellValue(bool) straight afterwards. This method only exists to give
  17556. the cell a somewhat reasonable value until the SetCellValue() call (if at all).
  17557. TODO - perhaps a method like SetCellTypeAndValue(int, Object) should be introduced to avoid this
  17558. </summary>
  17559. <returns></returns>
  17560. </member>
  17561. <member name="P:NPOI.HSSF.UserModel.HSSFCell.BooleanCellValue">
  17562. <summary>
  17563. Get the value of the cell as a bool. For strings, numbers, and errors, we throw an exception.
  17564. For blank cells we return a false.
  17565. </summary>
  17566. <value><c>true</c> if [boolean cell value]; otherwise, <c>false</c>.</value>
  17567. </member>
  17568. <member name="P:NPOI.HSSF.UserModel.HSSFCell.ErrorCellValue">
  17569. <summary>
  17570. Get the value of the cell as an error code. For strings, numbers, and bools, we throw an exception.
  17571. For blank cells we return a 0.
  17572. </summary>
  17573. <value>The error cell value.</value>
  17574. </member>
  17575. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellStyle">
  17576. <summary>
  17577. Get the style for the cell. This is a reference to a cell style contained in the workbook
  17578. object.
  17579. </summary>
  17580. <value>The cell style.</value>
  17581. </member>
  17582. <member name="M:NPOI.HSSF.UserModel.HSSFCell.ApplyUserCellStyle(NPOI.HSSF.UserModel.HSSFCellStyle)">
  17583. Applying a user-defined style (UDS) is special. Excel does not directly reference user-defined styles, but
  17584. instead create a 'proxy' ExtendedFormatRecord referencing the UDS as parent.
  17585. The proceudre to apply a UDS is as follows:
  17586. 1. search for a ExtendedFormatRecord with parentIndex == style.getIndex()
  17587. and xfType == ExtendedFormatRecord.XF_CELL.
  17588. 2. if not found then create a new ExtendedFormatRecord and copy all attributes from the user-defined style
  17589. and set the parentIndex to be style.getIndex()
  17590. 3. return the index of the ExtendedFormatRecord, this will be assigned to the parent cell record
  17591. @param style the user style to apply
  17592. @return the index of a ExtendedFormatRecord record that will be referenced by the cell
  17593. </member>
  17594. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellValueRecord">
  17595. <summary>
  17596. Should only be used by HSSFSheet and friends. Returns the low level CellValueRecordInterface record
  17597. </summary>
  17598. <value>the cell via the low level api.</value>
  17599. </member>
  17600. <member name="M:NPOI.HSSF.UserModel.HSSFCell.CheckBounds(System.Int32)">
  17601. <summary>
  17602. Checks the bounds.
  17603. </summary>
  17604. <param name="cellIndex">The cell num.</param>
  17605. <exception cref="T:System.Exception">if the bounds are exceeded.</exception>
  17606. </member>
  17607. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetAsActiveCell">
  17608. <summary>
  17609. Sets this cell as the active cell for the worksheet
  17610. </summary>
  17611. </member>
  17612. <member name="M:NPOI.HSSF.UserModel.HSSFCell.ToString">
  17613. <summary>
  17614. Returns a string representation of the cell
  17615. This method returns a simple representation,
  17616. anthing more complex should be in user code, with
  17617. knowledge of the semantics of the sheet being Processed.
  17618. Formula cells return the formula string,
  17619. rather than the formula result.
  17620. Dates are Displayed in dd-MMM-yyyy format
  17621. Errors are Displayed as #ERR&lt;errIdx&gt;
  17622. </summary>
  17623. </member>
  17624. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellComment">
  17625. <summary>
  17626. Returns comment associated with this cell
  17627. </summary>
  17628. <value>The cell comment associated with this cell.</value>
  17629. </member>
  17630. <member name="M:NPOI.HSSF.UserModel.HSSFCell.RemoveCellComment">
  17631. <summary>
  17632. Removes the comment for this cell, if
  17633. there is one.
  17634. </summary>
  17635. <remarks>WARNING - some versions of excel will loose
  17636. all comments after performing this action!</remarks>
  17637. </member>
  17638. <member name="P:NPOI.HSSF.UserModel.HSSFCell.ColumnIndex">
  17639. <summary>
  17640. Gets the index of the column.
  17641. </summary>
  17642. <value>The index of the column.</value>
  17643. </member>
  17644. <member name="M:NPOI.HSSF.UserModel.HSSFCell.UpdateCellNum(System.Int32)">
  17645. Updates the cell record's idea of what
  17646. column it belongs in (0 based)
  17647. @param num the new cell number
  17648. </member>
  17649. <member name="P:NPOI.HSSF.UserModel.HSSFCell.RowIndex">
  17650. <summary>
  17651. Gets the (zero based) index of the row containing this cell
  17652. </summary>
  17653. <value>The index of the row.</value>
  17654. </member>
  17655. <member name="P:NPOI.HSSF.UserModel.HSSFCell.Hyperlink">
  17656. <summary>
  17657. Get or set hyperlink associated with this cell
  17658. If the supplied hyperlink is null on setting, the hyperlink for this cell will be removed.
  17659. </summary>
  17660. <value>The hyperlink associated with this cell or null if not found</value>
  17661. </member>
  17662. <member name="M:NPOI.HSSF.UserModel.HSSFCell.RemoveHyperlink">
  17663. <summary>
  17664. Removes the hyperlink for this cell, if there is one.
  17665. </summary>
  17666. </member>
  17667. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CachedFormulaResultType">
  17668. <summary>
  17669. Only valid for formula cells
  17670. </summary>
  17671. <value>one of (CellType.Numeric,CellType.String, CellType.Boolean, CellType.Error) depending
  17672. on the cached value of the formula</value>
  17673. </member>
  17674. <member name="M:NPOI.HSSF.UserModel.HSSFCell.NotifyArrayFormulaChanging(System.String)">
  17675. <summary>
  17676. The purpose of this method is to validate the cell state prior to modification
  17677. </summary>
  17678. <param name="msg"></param>
  17679. </member>
  17680. <member name="M:NPOI.HSSF.UserModel.HSSFCell.NotifyArrayFormulaChanging">
  17681. <summary>
  17682. Called when this cell is modified.
  17683. The purpose of this method is to validate the cell state prior to modification.
  17684. </summary>
  17685. </member>
  17686. <member name="T:NPOI.HSSF.UserModel.HSSFCellStyle">
  17687. <summary>
  17688. High level representation of the style of a cell in a sheet of a workbook.
  17689. @author Andrew C. Oliver (acoliver at apache dot org)
  17690. @author Jason Height (jheight at chariot dot net dot au)
  17691. </summary>
  17692. </member>
  17693. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.#ctor(System.Int16,NPOI.HSSF.Record.ExtendedFormatRecord,NPOI.HSSF.UserModel.HSSFWorkbook)">
  17694. <summary>
  17695. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFCellStyle"/> class.
  17696. </summary>
  17697. <param name="index">The index.</param>
  17698. <param name="rec">The record.</param>
  17699. <param name="workbook">The workbook.</param>
  17700. </member>
  17701. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.#ctor(System.Int16,NPOI.HSSF.Record.ExtendedFormatRecord,NPOI.HSSF.Model.InternalWorkbook)">
  17702. <summary>
  17703. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFCellStyle"/> class.
  17704. </summary>
  17705. <param name="index">The index.</param>
  17706. <param name="rec">The record.</param>
  17707. <param name="workbook">The workbook.</param>
  17708. </member>
  17709. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.Index">
  17710. <summary>
  17711. Get the index within the HSSFWorkbook (sequence within the collection of ExtnededFormat objects)
  17712. </summary>
  17713. <value>Unique index number of the Underlying record this style represents (probably you don't care
  17714. Unless you're comparing which one is which)</value>
  17715. </member>
  17716. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.ParentStyle">
  17717. <summary>
  17718. Gets the parent style.
  17719. </summary>
  17720. <value>the parent style for this cell style.
  17721. In most cases this will be null, but in a few
  17722. cases there'll be a fully defined parent.</value>
  17723. </member>
  17724. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.DataFormat">
  17725. <summary>
  17726. Get the index of the format
  17727. </summary>
  17728. <value>The data format.</value>
  17729. </member>
  17730. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetDataFormatString">
  17731. <summary>
  17732. Get the contents of the format string, by looking up
  17733. the DataFormat against the bound workbook
  17734. </summary>
  17735. <returns></returns>
  17736. </member>
  17737. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetDataFormatString(NPOI.SS.UserModel.IWorkbook)">
  17738. <summary>
  17739. Get the contents of the format string, by looking up the DataFormat against the supplied workbook
  17740. </summary>
  17741. <param name="workbook">The workbook</param>
  17742. <returns>the format string or "General" if not found</returns>
  17743. </member>
  17744. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetDataFormatString(NPOI.HSSF.Model.InternalWorkbook)">
  17745. <summary>
  17746. Get the contents of the format string, by looking up
  17747. the DataFormat against the supplied workbook
  17748. </summary>
  17749. <param name="workbook">The internal workbook.</param>
  17750. <returns></returns>
  17751. </member>
  17752. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.SetFont(NPOI.SS.UserModel.IFont)">
  17753. <summary>
  17754. Set the font for this style
  17755. </summary>
  17756. <param name="font">a font object Created or retreived from the HSSFWorkbook object</param>
  17757. </member>
  17758. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.FontIndex">
  17759. <summary>
  17760. Gets the index of the font for this style.
  17761. </summary>
  17762. <value>The index of the font.</value>
  17763. </member>
  17764. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetFont(NPOI.SS.UserModel.IWorkbook)">
  17765. <summary>
  17766. Gets the font for this style
  17767. </summary>
  17768. <param name="parentWorkbook">The parent workbook that this style belongs to.</param>
  17769. <returns></returns>
  17770. </member>
  17771. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.IsHidden">
  17772. <summary>
  17773. Get whether the cell's using this style are to be hidden
  17774. </summary>
  17775. <value>whether the cell using this style should be hidden</value>
  17776. </member>
  17777. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.IsLocked">
  17778. <summary>
  17779. Get whether the cell's using this style are to be locked
  17780. </summary>
  17781. <value>whether the cell using this style should be locked</value>
  17782. </member>
  17783. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.Alignment">
  17784. <summary>
  17785. Get the type of horizontal alignment for the cell
  17786. </summary>
  17787. <value> the type of alignment</value>
  17788. </member>
  17789. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.WrapText">
  17790. <summary>
  17791. Gets or sets a value indicating whether the text should be wrapped
  17792. </summary>
  17793. <value><c>true</c> if [wrap text]; otherwise, <c>false</c>.</value>
  17794. </member>
  17795. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.VerticalAlignment">
  17796. <summary>
  17797. Gets or sets the vertical alignment for the cell.
  17798. </summary>
  17799. <value>the type of alignment</value>
  17800. </member>
  17801. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.Rotation">
  17802. <summary>
  17803. Gets or sets the degree of rotation for the text in the cell
  17804. Note: HSSF uses values from -90 to 90 degrees, whereas XSSF
  17805. uses values from 0 to 180 degrees.The implementations of this method will map between these two value-ranges
  17806. accordingly, however the corresponding getter is returning values in the range mandated by the current type
  17807. of Excel file-format that this CellStyle is applied to.
  17808. </summary>
  17809. <value>The rotation degrees (between -90 and 90 degrees).</value>
  17810. </member>
  17811. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.VerifyBelongsToWorkbook(NPOI.HSSF.UserModel.HSSFWorkbook)">
  17812. <summary>
  17813. Verifies that this style belongs to the supplied Workbook.
  17814. Will throw an exception if it belongs to a different one.
  17815. This is normally called when trying to assign a style to a
  17816. cell, to ensure the cell and the style are from the same
  17817. workbook (if they're not, it won't work)
  17818. </summary>
  17819. <param name="wb">The workbook.</param>
  17820. </member>
  17821. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.Indention">
  17822. <summary>
  17823. Gets or sets the number of spaces to indent the text in the cell
  17824. </summary>
  17825. <value>number of spaces</value>
  17826. </member>
  17827. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderLeft">
  17828. <summary>
  17829. Gets or sets the type of border to use for the left border of the cell
  17830. </summary>
  17831. <value>The border type.</value>
  17832. </member>
  17833. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderRight">
  17834. <summary>
  17835. Gets or sets the type of border to use for the right border of the cell
  17836. </summary>
  17837. <value>The border type.</value>
  17838. </member>
  17839. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderTop">
  17840. <summary>
  17841. Gets or sets the type of border to use for the top border of the cell
  17842. </summary>
  17843. <value>The border type.</value>
  17844. </member>
  17845. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderBottom">
  17846. <summary>
  17847. Gets or sets the type of border to use for the bottom border of the cell
  17848. </summary>
  17849. <value>The border type.</value>
  17850. </member>
  17851. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.LeftBorderColor">
  17852. <summary>
  17853. Gets or sets the color to use for the left border
  17854. </summary>
  17855. <value>The index of the color definition</value>
  17856. </member>
  17857. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.RightBorderColor">
  17858. <summary>
  17859. Gets or sets the color to use for the left border.
  17860. </summary>
  17861. <value>The index of the color definition</value>
  17862. </member>
  17863. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.TopBorderColor">
  17864. <summary>
  17865. Gets or sets the color to use for the top border
  17866. </summary>
  17867. <value>The index of the color definition.</value>
  17868. </member>
  17869. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BottomBorderColor">
  17870. <summary>
  17871. Gets or sets the color to use for the left border
  17872. </summary>
  17873. <value>The index of the color definition.</value>
  17874. </member>
  17875. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderDiagonalColor">
  17876. <summary>
  17877. Gets or sets the color to use for the diagional border
  17878. </summary>
  17879. <value>The index of the color definition.</value>
  17880. </member>
  17881. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderDiagonalLineStyle">
  17882. <summary>
  17883. Gets or sets the line type to use for the diagional border
  17884. </summary>
  17885. <value>The line type.</value>
  17886. </member>
  17887. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderDiagonal">
  17888. <summary>
  17889. Gets or sets the type of diagional border
  17890. </summary>.
  17891. <value>The border diagional type.</value>
  17892. </member>
  17893. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.ShrinkToFit">
  17894. <summary>
  17895. Gets or sets whether the cell is shrink-to-fit
  17896. </summary>
  17897. </member>
  17898. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.ReadingOrder">
  17899. Get or set the reading order, for RTL/LTR ordering of
  17900. the text.
  17901. <p>0 means Context (Default), 1 means Left To Right,
  17902. and 2 means Right to Left</p>
  17903. @return order - the reading order (0,1,2)
  17904. </member>
  17905. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.FillPattern">
  17906. <summary>
  17907. Gets or sets the fill pattern. - Set to 1 to Fill with foreground color
  17908. </summary>
  17909. <value>The fill pattern.</value>
  17910. </member>
  17911. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.CheckDefaultBackgroundFills">
  17912. <summary>
  17913. Checks if the background and foreground Fills are Set correctly when one
  17914. or the other is Set to the default color.
  17915. Works like the logic table below:
  17916. BACKGROUND FOREGROUND
  17917. NONE AUTOMATIC
  17918. 0x41 0x40
  17919. NONE RED/ANYTHING
  17920. 0x40 0xSOMETHING
  17921. </summary>
  17922. </member>
  17923. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.CloneStyleFrom(NPOI.SS.UserModel.ICellStyle)">
  17924. Clones all the style information from another
  17925. HSSFCellStyle, onto this one. This
  17926. HSSFCellStyle will then have all the same
  17927. properties as the source, but the two may
  17928. be edited independently.
  17929. Any stylings on this HSSFCellStyle will be lost!
  17930. The source HSSFCellStyle could be from another
  17931. HSSFWorkbook if you like. This allows you to
  17932. copy styles from one HSSFWorkbook to another.
  17933. </member>
  17934. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.CloneStyleFrom(NPOI.HSSF.UserModel.HSSFCellStyle)">
  17935. <summary>
  17936. Clones all the style information from another
  17937. HSSFCellStyle, onto this one. This
  17938. HSSFCellStyle will then have all the same
  17939. properties as the source, but the two may
  17940. be edited independently.
  17941. Any stylings on this HSSFCellStyle will be lost!
  17942. The source HSSFCellStyle could be from another
  17943. HSSFWorkbook if you like. This allows you to
  17944. copy styles from one HSSFWorkbook to another.
  17945. </summary>
  17946. <param name="source">The source.</param>
  17947. </member>
  17948. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.FillBackgroundColor">
  17949. <summary>
  17950. Gets or sets the color of the fill background.
  17951. </summary>
  17952. <value>The color of the fill background.</value>
  17953. Set the background Fill color.
  17954. <example>
  17955. cs.SetFillPattern(HSSFCellStyle.FINE_DOTS );
  17956. cs.SetFillBackgroundColor(new HSSFColor.RED().Index);
  17957. optionally a Foreground and background Fill can be applied:
  17958. Note: Ensure Foreground color is Set prior to background
  17959. cs.SetFillPattern(HSSFCellStyle.FINE_DOTS );
  17960. cs.SetFillForegroundColor(new HSSFColor.BLUE().Index);
  17961. cs.SetFillBackgroundColor(new HSSFColor.RED().Index);
  17962. or, for the special case of SOLID_Fill:
  17963. cs.SetFillPattern(HSSFCellStyle.SOLID_FOREGROUND );
  17964. cs.SetFillForegroundColor(new HSSFColor.RED().Index);
  17965. It is necessary to Set the Fill style in order
  17966. for the color to be shown in the cell.
  17967. </example>
  17968. </member>
  17969. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.FillForegroundColor">
  17970. <summary>
  17971. Gets or sets the foreground Fill color
  17972. </summary>
  17973. <value>Fill color.</value>
  17974. @see org.apache.poi.hssf.usermodel.HSSFPalette#GetColor(short)
  17975. </member>
  17976. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.UserStyleName">
  17977. Gets the name of the user defined style.
  17978. Returns null for built in styles, and
  17979. styles where no name has been defined
  17980. </member>
  17981. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetHashCode">
  17982. <summary>
  17983. Serves as a hash function for a particular type.
  17984. </summary>
  17985. <returns>
  17986. A hash code for the current <see cref="T:System.Object"/>.
  17987. </returns>
  17988. </member>
  17989. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.Equals(System.Object)">
  17990. <summary>
  17991. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
  17992. </summary>
  17993. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
  17994. <returns>
  17995. true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
  17996. </returns>
  17997. <exception cref="T:System.NullReferenceException">
  17998. The <paramref name="obj"/> parameter is null.
  17999. </exception>
  18000. </member>
  18001. <member name="T:NPOI.HSSF.UserModel.HSSFChart">
  18002. Has methods for construction of a chart object.
  18003. @author Glen Stampoultzis (glens at apache.org)
  18004. </member>
  18005. <member name="M:NPOI.HSSF.UserModel.HSSFChart.CreateBarChart(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet)">
  18006. Creates a bar chart. API needs some work. :)
  18007. NOTE: Does not yet work... checking it in just so others
  18008. can take a look.
  18009. </member>
  18010. <member name="M:NPOI.HSSF.UserModel.HSSFChart.GetSheetCharts(NPOI.HSSF.UserModel.HSSFSheet)">
  18011. Returns all the charts for the given sheet.
  18012. NOTE: You won't be able to do very much with
  18013. these charts yet, as this is very limited support
  18014. </member>
  18015. <member name="P:NPOI.HSSF.UserModel.HSSFChart.ChartX">
  18016. Get the X offset of the chart
  18017. </member>
  18018. <member name="P:NPOI.HSSF.UserModel.HSSFChart.ChartY">
  18019. Get the Y offset of the chart
  18020. </member>
  18021. <member name="P:NPOI.HSSF.UserModel.HSSFChart.ChartWidth">
  18022. Get the width of the chart. {@link ChartRecord}
  18023. </member>
  18024. <member name="P:NPOI.HSSF.UserModel.HSSFChart.ChartHeight">
  18025. Get the height of the chart. {@link ChartRecord}
  18026. </member>
  18027. <member name="P:NPOI.HSSF.UserModel.HSSFChart.Series">
  18028. Returns the series of the chart
  18029. </member>
  18030. <member name="P:NPOI.HSSF.UserModel.HSSFChart.ChartTitle">
  18031. Returns the chart's title, if there is one,
  18032. or null if not
  18033. </member>
  18034. <member name="M:NPOI.HSSF.UserModel.HSSFChart.SetValueRange(System.Int32,System.Nullable{System.Double},System.Nullable{System.Double},System.Nullable{System.Double},System.Nullable{System.Double})">
  18035. Set value range (basic Axis Options)
  18036. @param axisIndex 0 - primary axis, 1 - secondary axis
  18037. @param minimum minimum value; Double.NaN - automatic; null - no change
  18038. @param maximum maximum value; Double.NaN - automatic; null - no change
  18039. @param majorUnit major unit value; Double.NaN - automatic; null - no change
  18040. @param minorUnit minor unit value; Double.NaN - automatic; null - no change
  18041. </member>
  18042. <member name="T:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries">
  18043. A series in a chart
  18044. </member>
  18045. <member name="P:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.ValueType">
  18046. See {@link SeriesRecord}
  18047. </member>
  18048. <member name="P:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.SeriesTitle">
  18049. Returns the series' title, if there is one,
  18050. or null if not
  18051. </member>
  18052. <member name="M:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.GetDataName">
  18053. @return record with data names
  18054. </member>
  18055. <member name="M:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.GetDataValues">
  18056. @return record with data values
  18057. </member>
  18058. <member name="M:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.GetDataCategoryLabels">
  18059. @return record with data category labels
  18060. </member>
  18061. <member name="M:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.GetDataSecondaryCategoryLabels">
  18062. @return record with data secondary category labels
  18063. </member>
  18064. <member name="M:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.GetSeries">
  18065. @return record with series
  18066. </member>
  18067. <member name="M:NPOI.HSSF.UserModel.HSSFChildAnchor.#ctor(NPOI.DDF.EscherChildAnchorRecord)">
  18068. create anchor from existing file
  18069. @param escherChildAnchorRecord
  18070. </member>
  18071. <member name="M:NPOI.HSSF.UserModel.HSSFChildAnchor.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
  18072. create anchor from scratch
  18073. @param dx1 x coordinate of the left up corner
  18074. @param dy1 y coordinate of the left up corner
  18075. @param dx2 x coordinate of the right down corner
  18076. @param dy2 y coordinate of the right down corner
  18077. </member>
  18078. <member name="M:NPOI.HSSF.UserModel.HSSFChildAnchor.SetAnchor(System.Int32,System.Int32,System.Int32,System.Int32)">
  18079. @param dx1 x coordinate of the left up corner
  18080. @param dy1 y coordinate of the left up corner
  18081. @param dx2 x coordinate of the right down corner
  18082. @param dy2 y coordinate of the right down corner
  18083. </member>
  18084. <member name="T:NPOI.HSSF.UserModel.HSSFClientAnchor">
  18085. <summary>
  18086. A client anchor Is attached to an excel worksheet. It anchors against a
  18087. top-left and buttom-right cell.
  18088. @author Glen Stampoultzis (glens at apache.org)
  18089. </summary>
  18090. </member>
  18091. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.#ctor">
  18092. <summary>
  18093. Creates a new client anchor and defaults all the anchor positions to 0.
  18094. </summary>
  18095. </member>
  18096. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  18097. <summary>
  18098. Creates a new client anchor and Sets the top-left and bottom-right
  18099. coordinates of the anchor.
  18100. Note: Microsoft Excel seems to sometimes disallow
  18101. higher y1 than y2 or higher x1 than x2 in the anchor, you might need to
  18102. reverse them and draw shapes vertically or horizontally flipped!
  18103. </summary>
  18104. <param name="dx1">the x coordinate within the first cell.</param>
  18105. <param name="dy1">the y coordinate within the first cell.</param>
  18106. <param name="dx2">the x coordinate within the second cell.</param>
  18107. <param name="dy2">the y coordinate within the second cell.</param>
  18108. <param name="col1">the column (0 based) of the first cell.</param>
  18109. <param name="row1">the row (0 based) of the first cell.</param>
  18110. <param name="col2">the column (0 based) of the second cell.</param>
  18111. <param name="row2">the row (0 based) of the second cell.</param>
  18112. </member>
  18113. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.GetAnchorHeightInPoints(NPOI.SS.UserModel.ISheet)">
  18114. <summary>
  18115. Calculates the height of a client anchor in points.
  18116. </summary>
  18117. <param name="sheet">the sheet the anchor will be attached to</param>
  18118. <returns>the shape height.</returns>
  18119. </member>
  18120. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.GetRowHeightInPoints(NPOI.SS.UserModel.ISheet,System.Int32)">
  18121. <summary>
  18122. Gets the row height in points.
  18123. </summary>
  18124. <param name="sheet">The sheet.</param>
  18125. <param name="rowNum">The row num.</param>
  18126. <returns></returns>
  18127. </member>
  18128. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.Col1">
  18129. <summary>
  18130. Gets or sets the col1.
  18131. </summary>
  18132. <value>The col1.</value>
  18133. </member>
  18134. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.Col2">
  18135. <summary>
  18136. Gets or sets the col2.
  18137. </summary>
  18138. <value>The col2.</value>
  18139. </member>
  18140. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.Row1">
  18141. <summary>
  18142. Gets or sets the row1.
  18143. </summary>
  18144. <value>The row1.</value>
  18145. </member>
  18146. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.Row2">
  18147. <summary>
  18148. Gets or sets the row2.
  18149. </summary>
  18150. <value>The row2.</value>
  18151. </member>
  18152. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.SetAnchor(System.Int16,System.Int32,System.Int32,System.Int32,System.Int16,System.Int32,System.Int32,System.Int32)">
  18153. <summary>
  18154. Sets the top-left and bottom-right
  18155. coordinates of the anchor
  18156. Note: Microsoft Excel seems to sometimes disallow
  18157. higher y1 than y2 or higher x1 than x2 in the anchor, you might need to
  18158. reverse them and draw shapes vertically or horizontally flipped!
  18159. </summary>
  18160. <param name="col1">the column (0 based) of the first cell.</param>
  18161. <param name="row1"> the row (0 based) of the first cell.</param>
  18162. <param name="x1">the x coordinate within the first cell.</param>
  18163. <param name="y1">the y coordinate within the first cell.</param>
  18164. <param name="col2">the column (0 based) of the second cell.</param>
  18165. <param name="row2">the row (0 based) of the second cell.</param>
  18166. <param name="x2">the x coordinate within the second cell.</param>
  18167. <param name="y2">the y coordinate within the second cell.</param>
  18168. </member>
  18169. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.IsHorizontallyFlipped">
  18170. <summary>
  18171. Gets a value indicating whether this instance is horizontally flipped.
  18172. </summary>
  18173. <value>
  18174. <c>true</c> if the anchor goes from right to left; otherwise, <c>false</c>.
  18175. </value>
  18176. </member>
  18177. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.IsVerticallyFlipped">
  18178. <summary>
  18179. Gets a value indicating whether this instance is vertically flipped.
  18180. </summary>
  18181. <value>
  18182. <c>true</c> if the anchor goes from bottom to top.; otherwise, <c>false</c>.
  18183. </value>
  18184. </member>
  18185. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.AnchorType">
  18186. <summary>
  18187. Gets the anchor type
  18188. 0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells.
  18189. </summary>
  18190. <value>The type of the anchor.</value>
  18191. </member>
  18192. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.CheckRange(System.Int32,System.Int32,System.Int32,System.String)">
  18193. <summary>
  18194. Checks the range.
  18195. </summary>
  18196. <param name="value">The value.</param>
  18197. <param name="minRange">The min range.</param>
  18198. <param name="maxRange">The max range.</param>
  18199. <param name="varName">Name of the variable.</param>
  18200. </member>
  18201. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.unsignedValue(System.Int16)">
  18202. Given a 16-bit unsigned integer stored in a short, return the unsigned value.
  18203. @param s A 16-bit value intended to be interpreted as an unsigned integer.
  18204. @return The value represented by <code>s</code>.
  18205. </member>
  18206. <member name="T:NPOI.HSSF.UserModel.HSSFColorScaleFormatting">
  18207. High level representation for Color Scale / Color Gradient
  18208. Formatting component of Conditional Formatting Settings
  18209. </member>
  18210. <member name="T:NPOI.HSSF.UserModel.HSSFComment">
  18211. <summary>
  18212. Represents a cell comment - a sticky note associated with a cell.
  18213. @author Yegor Kozlov
  18214. </summary>
  18215. </member>
  18216. <member name="M:NPOI.HSSF.UserModel.HSSFComment.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  18217. <summary>
  18218. Construct a new comment with the given parent and anchor.
  18219. </summary>
  18220. <param name="parent"></param>
  18221. <param name="anchor">defines position of this anchor in the sheet</param>
  18222. </member>
  18223. <member name="M:NPOI.HSSF.UserModel.HSSFComment.#ctor(NPOI.HSSF.Record.NoteRecord,NPOI.HSSF.Record.TextObjectRecord)">
  18224. <summary>
  18225. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFComment"/> class.
  18226. </summary>
  18227. <param name="note">The note.</param>
  18228. <param name="txo">The txo.</param>
  18229. </member>
  18230. <member name="P:NPOI.HSSF.UserModel.HSSFComment.Visible">
  18231. <summary>
  18232. Gets or sets a value indicating whether this <see cref="T:NPOI.HSSF.UserModel.HSSFComment"/> is visible.
  18233. </summary>
  18234. <value><c>true</c> if visible; otherwise, <c>false</c>.</value>
  18235. Sets whether this comment Is visible.
  18236. @return
  18237. <c>true</c>
  18238. if the comment Is visible,
  18239. <c>false</c>
  18240. otherwise
  18241. </member>
  18242. <member name="P:NPOI.HSSF.UserModel.HSSFComment.Row">
  18243. <summary>
  18244. Gets or sets the row of the cell that Contains the comment
  18245. </summary>
  18246. <value>the 0-based row of the cell that Contains the comment</value>
  18247. </member>
  18248. <member name="P:NPOI.HSSF.UserModel.HSSFComment.Column">
  18249. <summary>
  18250. Gets or sets the column of the cell that Contains the comment
  18251. </summary>
  18252. <value>the 0-based column of the cell that Contains the comment</value>
  18253. </member>
  18254. <member name="P:NPOI.HSSF.UserModel.HSSFComment.Author">
  18255. <summary>
  18256. Gets or sets the name of the original comment author
  18257. </summary>
  18258. <value>the name of the original author of the comment</value>
  18259. </member>
  18260. <member name="P:NPOI.HSSF.UserModel.HSSFComment.NoteRecord">
  18261. <summary>
  18262. Gets the note record.
  18263. </summary>
  18264. <value>the underlying Note record.</value>
  18265. </member>
  18266. <member name="P:NPOI.HSSF.UserModel.HSSFComment.HasPosition">
  18267. Do we know which cell this comment belongs to?
  18268. </member>
  18269. <member name="T:NPOI.HSSF.UserModel.HSSFConditionalFormatting">
  18270. <summary>
  18271. HSSFConditionalFormatting class encapsulates all Settings of Conditional Formatting.
  18272. The class can be used to make a copy HSSFConditionalFormatting Settings
  18273. </summary>
  18274. <example>
  18275. HSSFConditionalFormatting cf = sheet.GetConditionalFormattingAt(index);
  18276. newSheet.AddConditionalFormatting(cf);
  18277. or to modify existing Conditional Formatting Settings (formatting regions and/or rules).
  18278. Use {@link HSSFSheet#GetConditionalFormattingAt(int)} to Get access to an instance of this class.
  18279. To Create a new Conditional Formatting Set use the following approach:
  18280. // Define a Conditional Formatting rule, which triggers formatting
  18281. // when cell's value Is greater or equal than 100.0 and
  18282. // applies patternFormatting defined below.
  18283. HSSFConditionalFormattingRule rule = sheet.CreateConditionalFormattingRule(
  18284. ComparisonOperator.GE,
  18285. "100.0", // 1st formula
  18286. null // 2nd formula Is not used for comparison operator GE
  18287. );
  18288. // Create pattern with red background
  18289. HSSFPatternFormatting patternFmt = rule.cretePatternFormatting();
  18290. patternFormatting.SetFillBackgroundColor(HSSFColor.RED.index);
  18291. // Define a region containing first column
  18292. Region [] regions =
  18293. {
  18294. new Region(1,(short)1,-1,(short)1)
  18295. };
  18296. // Apply Conditional Formatting rule defined above to the regions
  18297. sheet.AddConditionalFormatting(regions, rule);
  18298. </example>
  18299. <remarks>@author Dmitriy Kumshayev</remarks>
  18300. </member>
  18301. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.#ctor(NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.Record.Aggregates.CFRecordsAggregate)">
  18302. <summary>
  18303. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFConditionalFormatting"/> class.
  18304. </summary>
  18305. <param name="workbook">The workbook.</param>
  18306. <param name="cfAggregate">The cf aggregate.</param>
  18307. </member>
  18308. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormatting.CFRecordsAggregate">
  18309. <summary>
  18310. Gets the CF records aggregate.
  18311. </summary>
  18312. <returns></returns>
  18313. </member>
  18314. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.GetFormattingRanges">
  18315. <summary>
  18316. Gets array of CellRangeAddresses
  18317. </summary>
  18318. <returns></returns>
  18319. </member>
  18320. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.SetRule(System.Int32,NPOI.HSSF.UserModel.HSSFConditionalFormattingRule)">
  18321. <summary>
  18322. Replaces an existing Conditional Formatting rule at position idx.
  18323. Excel allows to Create up to 3 Conditional Formatting rules.
  18324. This method can be useful to modify existing Conditional Formatting rules.
  18325. </summary>
  18326. <param name="idx">position of the rule. Should be between 0 and 2.</param>
  18327. <param name="cfRule">Conditional Formatting rule</param>
  18328. </member>
  18329. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.AddRule(NPOI.HSSF.UserModel.HSSFConditionalFormattingRule)">
  18330. <summary>
  18331. Add a Conditional Formatting rule.
  18332. Excel allows to Create up to 3 Conditional Formatting rules.
  18333. </summary>
  18334. <param name="cfRule">Conditional Formatting rule</param>
  18335. </member>
  18336. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.GetRule(System.Int32)">
  18337. <summary>
  18338. Gets the Conditional Formatting rule at position idx
  18339. </summary>
  18340. <param name="idx">The index.</param>
  18341. <returns></returns>
  18342. </member>
  18343. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormatting.NumberOfRules">
  18344. <summary>
  18345. Gets the number of Conditional Formatting rules.
  18346. </summary>
  18347. <value>The number of rules.</value>
  18348. </member>
  18349. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.ToString">
  18350. <summary>
  18351. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  18352. </summary>
  18353. <returns>
  18354. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  18355. </returns>
  18356. </member>
  18357. <member name="T:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule">
  18358. High level representation of Conditional Formatting Rule.
  18359. It allows to specify formula based conditions for the Conditional Formatting
  18360. and the formatting Settings such as font, border and pattern.
  18361. @author Dmitriy Kumshayev
  18362. </member>
  18363. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.FontFormatting">
  18364. @return - font formatting object if defined, <c>null</c> otherwise
  18365. </member>
  18366. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.CreateFontFormatting">
  18367. Create a new font formatting structure if it does not exist,
  18368. otherwise just return existing object.
  18369. @return - font formatting object, never returns <c>null</c>.
  18370. </member>
  18371. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.BorderFormatting">
  18372. @return - border formatting object if defined, <c>null</c> otherwise
  18373. </member>
  18374. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.CreateBorderFormatting">
  18375. Create a new border formatting structure if it does not exist,
  18376. otherwise just return existing object.
  18377. @return - border formatting object, never returns <c>null</c>.
  18378. </member>
  18379. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.PatternFormatting">
  18380. @return - pattern formatting object if defined, <c>null</c> otherwise
  18381. </member>
  18382. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.CreatePatternFormatting">
  18383. Create a new pattern formatting structure if it does not exist,
  18384. otherwise just return existing object.
  18385. @return - pattern formatting object, never returns <c>null</c>.
  18386. </member>
  18387. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.DataBarFormatting">
  18388. @return databar / data-bar formatting object if defined, <code>null</code> otherwise
  18389. </member>
  18390. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.CreateDataBarFormatting">
  18391. create a new databar / data-bar formatting object if it does not exist,
  18392. otherwise just return the existing object.
  18393. </member>
  18394. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.MultiStateFormatting">
  18395. @return icon / multi-state formatting object if defined, <code>null</code> otherwise
  18396. </member>
  18397. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.CreateMultiStateFormatting">
  18398. create a new icon / multi-state formatting object if it does not exist,
  18399. otherwise just return the existing object.
  18400. </member>
  18401. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.ColorScaleFormatting">
  18402. @return color scale / gradient formatting object if defined, <code>null</code> otherwise
  18403. </member>
  18404. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.CreateColorScaleFormatting">
  18405. create a new color scale / gradient formatting object if it does not exist,
  18406. otherwise just return the existing object.
  18407. </member>
  18408. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.ConditionType">
  18409. @return - the conditiontype for the cfrule
  18410. </member>
  18411. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.ComparisonOperation">
  18412. @return - the comparisionoperatation for the cfrule
  18413. </member>
  18414. <member name="T:NPOI.HSSF.UserModel.HSSFConditionalFormattingThreshold">
  18415. High level representation for Icon / Multi-State / Databar /
  18416. Colour Scale change thresholds
  18417. </member>
  18418. <member name="M:NPOI.HSSF.UserModel.HSSFCreationHelper.CreateFormulaEvaluator">
  18419. Creates a HSSFFormulaEvaluator, the object that Evaluates formula cells.
  18420. @return a HSSFFormulaEvaluator instance
  18421. </member>
  18422. <member name="M:NPOI.HSSF.UserModel.HSSFCreationHelper.CreateClientAnchor">
  18423. Creates a HSSFClientAnchor. Use this object to position drawing object in a sheet
  18424. @return a HSSFClientAnchor instance
  18425. @see NPOI.SS.usermodel.Drawing
  18426. </member>
  18427. <member name="T:NPOI.HSSF.UserModel.HSSFDataBarFormatting">
  18428. High level representation for DataBar / Data-Bar Formatting
  18429. component of Conditional Formatting Settings
  18430. </member>
  18431. <member name="F:NPOI.HSSF.UserModel.HSSFDataFormat.FIRST_USER_DEFINED_FORMAT_INDEX">
  18432. The first user-defined format starts at 164.
  18433. </member>
  18434. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.#ctor(NPOI.HSSF.Model.InternalWorkbook)">
  18435. <summary>
  18436. Construncts a new data formatter. It takes a workbook to have
  18437. access to the workbooks format records.
  18438. </summary>
  18439. <param name="workbook">the workbook the formats are tied to.</param>
  18440. </member>
  18441. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.GetBuiltinFormat(System.String)">
  18442. <summary>
  18443. Get the format index that matches the given format string
  18444. Automatically Converts "text" to excel's format string to represent text.
  18445. </summary>
  18446. <param name="format">The format string matching a built in format.</param>
  18447. <returns>index of format or -1 if Undefined.</returns>
  18448. </member>
  18449. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.GetFormat(System.String)">
  18450. <summary>
  18451. Get the format index that matches the given format
  18452. string, creating a new format entry if required.
  18453. Aliases text to the proper format as required.
  18454. </summary>
  18455. <param name="pFormat">The format string matching a built in format.</param>
  18456. <returns>index of format.</returns>
  18457. </member>
  18458. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.GetFormat(System.Int16)">
  18459. <summary>
  18460. Get the format string that matches the given format index
  18461. </summary>
  18462. <param name="index">The index of a format.</param>
  18463. <returns>string represented at index of format or null if there Is not a format at that index</returns>
  18464. </member>
  18465. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.GetBuiltinFormat(System.Int16)">
  18466. <summary>
  18467. Get the format string that matches the given format index
  18468. </summary>
  18469. <param name="index">The index of a built in format.</param>
  18470. <returns>string represented at index of format or null if there Is not a builtin format at that index</returns>
  18471. </member>
  18472. <member name="P:NPOI.HSSF.UserModel.HSSFDataFormat.NumberOfBuiltinBuiltinFormats">
  18473. <summary>
  18474. Get the number of builtin and reserved builtinFormats
  18475. </summary>
  18476. <returns>number of builtin and reserved builtinFormats</returns>
  18477. </member>
  18478. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.EnsureFormatsSize(System.Int32)">
  18479. Ensures that the formats list can hold entries
  18480. up to and including the entry with this index
  18481. </member>
  18482. <member name="T:NPOI.HSSF.UserModel.HSSFDataFormatter">
  18483. HSSFDataFormatter contains methods for formatting the value stored in an
  18484. HSSFCell. This can be useful for reports and GUI presentations when you
  18485. need to display data exactly as it appears in Excel. Supported formats
  18486. include currency, SSN, percentages, decimals, dates, phone numbers, zip
  18487. codes, etc.
  18488. Internally, formats will be implemented using subclasses of <see cref="T:NPOI.SS.Util.FormatBase"/>
  18489. such as <see cref="T:NPOI.SS.Util.DecimalFormat"/> and <see cref="T:NPOI.SS.Util.SimpleDateFormat"/>. Therefore the
  18490. formats used by this class must obey the same pattern rules as these Format
  18491. subclasses. This means that only legal number pattern characters ("0", "#",
  18492. ".", "," etc.) may appear in number formats. Other characters can be
  18493. inserted <em>before</em> or <em>after</em> the number pattern to form a
  18494. prefix or suffix.
  18495. For example the Excel pattern <c>"$#,##0.00 "USD"_);($#,##0.00 "USD")"
  18496. </c> will be correctly formatted as "$1,000.00 USD" or "($1,000.00 USD)".
  18497. However the pattern <c>"00-00-00"</c> is incorrectly formatted by
  18498. DecimalFormat as "000000--". For Excel formats that are not compatible with
  18499. DecimalFormat, you can provide your own custom {@link Format} implementation
  18500. via <c>HSSFDataFormatter.AddFormat(String,Format)</c>. The following
  18501. custom formats are already provided by this class:
  18502. <pre>
  18503. <ul><li>SSN "000-00-0000"</li>
  18504. <li>Phone Number "(###) ###-####"</li>
  18505. <li>Zip plus 4 "00000-0000"</li>
  18506. </ul>
  18507. </pre>
  18508. If the Excel format pattern cannot be parsed successfully, then a default
  18509. format will be used. The default number format will mimic the Excel General
  18510. format: "#" for whole numbers and "#.##########" for decimal numbers. You
  18511. can override the default format pattern with <c>
  18512. HSSFDataFormatter.DefaultNumberFormat=(Format)</c>. <b>Note:</b> the
  18513. default format will only be used when a Format cannot be created from the
  18514. cell's data format string.
  18515. @author James May (james dot may at fmr dot com)
  18516. </member>
  18517. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormatter.#ctor(System.Globalization.CultureInfo)">
  18518. Creates a formatter using the given locale.
  18519. </member>
  18520. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormatter.#ctor">
  18521. Creates a formatter using the {@link Locale#getDefault() default locale}.
  18522. </member>
  18523. <member name="T:NPOI.HSSF.UserModel.HSSFDataValidation">
  18524. Utility class for creating data validation cells
  18525. @author Dragos Buleandra (dragos.buleandra@trade2b.ro)
  18526. </member>
  18527. <member name="M:NPOI.HSSF.UserModel.HSSFDataValidation.#ctor(NPOI.SS.Util.CellRangeAddressList,NPOI.SS.UserModel.IDataValidationConstraint)">
  18528. Constructor which Initializes the cell range on which this object will be
  18529. applied
  18530. @param constraint
  18531. </member>
  18532. <member name="T:NPOI.HSSF.UserModel.HSSFDataValidationHelper">
  18533. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  18534. </member>
  18535. <member name="T:NPOI.HSSF.UserModel.HSSFDateUtil">
  18536. Contains methods for dealing with Excel dates.
  18537. @author Michael Harhen
  18538. @author Glen Stampoultzis (glens at apache.org)
  18539. @author Dan Sherman (dsherman at isisph.com)
  18540. @author Hack Kampbjorn (hak at 2mba.dk)
  18541. @author Alex Jacoby (ajacoby at gmail.com)
  18542. @author Pavel Krupets (pkrupets at palmtreebusiness dot com)
  18543. </member>
  18544. <member name="T:NPOI.HSSF.UserModel.HSSFEvaluationCell">
  18545. <summary>
  18546. HSSF wrapper for a cell under evaluation
  18547. @author Josh Micich
  18548. </summary>
  18549. </member>
  18550. <member name="T:NPOI.HSSF.UserModel.HSSFEvaluationSheet">
  18551. HSSF wrapper for a sheet under evaluation
  18552. @author Josh Micich
  18553. </member>
  18554. <member name="T:NPOI.HSSF.UserModel.HSSFEvaluationWorkbook">
  18555. Internal POI use only
  18556. @author Josh Micich
  18557. </member>
  18558. <member name="M:NPOI.HSSF.UserModel.HSSFEvaluationWorkbook.GetNameXPtg(System.String,NPOI.SS.Formula.SheetIdentifier)">
  18559. <summary>
  18560. Return an external name (named range, function, user-defined function) Ptg
  18561. </summary>
  18562. <param name="name"></param>
  18563. <param name="sheet"></param>
  18564. <returns></returns>
  18565. </member>
  18566. <member name="T:NPOI.HSSF.UserModel.HSSFExtendedColor">
  18567. The HSSF file format normally stores Color information in the
  18568. Palette (see PaletteRecord), but for a few cases (eg Conditional
  18569. Formatting, Sheet Extensions), this XSSF-style color record
  18570. can be used.
  18571. </member>
  18572. <member name="T:NPOI.HSSF.UserModel.HSSFFont">
  18573. <summary>
  18574. Represents a Font used in a workbook.
  18575. @version 1.0-pre
  18576. @author Andrew C. Oliver
  18577. </summary>
  18578. </member>
  18579. <member name="M:NPOI.HSSF.UserModel.HSSFFont.#ctor(System.Int16,NPOI.HSSF.Record.FontRecord)">
  18580. <summary>
  18581. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFFont"/> class.
  18582. </summary>
  18583. <param name="index">The index.</param>
  18584. <param name="rec">The record.</param>
  18585. </member>
  18586. <member name="P:NPOI.HSSF.UserModel.HSSFFont.FontName">
  18587. <summary>
  18588. Get the name for the font (i.e. Arial)
  18589. </summary>
  18590. <value>the name of the font to use</value>
  18591. </member>
  18592. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Index">
  18593. <summary>
  18594. Get the index within the HSSFWorkbook (sequence within the collection of Font objects)
  18595. </summary>
  18596. <value>Unique index number of the Underlying record this Font represents (probably you don't care
  18597. Unless you're comparing which one is which)</value>
  18598. </member>
  18599. <member name="P:NPOI.HSSF.UserModel.HSSFFont.FontHeight">
  18600. <summary>
  18601. Get or sets the font height in Unit's of 1/20th of a point. Maybe you might want to
  18602. use the GetFontHeightInPoints which matches to the familiar 10, 12, 14 etc..
  18603. </summary>
  18604. <value>height in 1/20ths of a point.</value>
  18605. </member>
  18606. <member name="P:NPOI.HSSF.UserModel.HSSFFont.FontHeightInPoints">
  18607. <summary>
  18608. Gets or sets the font height in points.
  18609. </summary>
  18610. <value>height in the familiar Unit of measure - points.</value>
  18611. </member>
  18612. <member name="P:NPOI.HSSF.UserModel.HSSFFont.IsItalic">
  18613. <summary>
  18614. Gets or sets whether to use italics or not
  18615. </summary>
  18616. <value><c>true</c> if this instance is italic; otherwise, <c>false</c>.</value>
  18617. </member>
  18618. <member name="P:NPOI.HSSF.UserModel.HSSFFont.IsStrikeout">
  18619. <summary>
  18620. Get whether to use a strikeout horizontal line through the text or not
  18621. </summary>
  18622. <value>
  18623. strikeout or not
  18624. </value>
  18625. </member>
  18626. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Color">
  18627. <summary>
  18628. Gets or sets the color for the font.
  18629. </summary>
  18630. <value>The color to use.</value>
  18631. </member>
  18632. <member name="M:NPOI.HSSF.UserModel.HSSFFont.GetHSSFColor(NPOI.HSSF.UserModel.HSSFWorkbook)">
  18633. <summary>
  18634. get the color value for the font
  18635. </summary>
  18636. <param name="wb">HSSFWorkbook</param>
  18637. <returns></returns>
  18638. </member>
  18639. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Boldweight">
  18640. <summary>
  18641. Gets or sets the boldness to use
  18642. </summary>
  18643. <value>The boldweight.</value>
  18644. </member>
  18645. <member name="P:NPOI.HSSF.UserModel.HSSFFont.IsBold">
  18646. get or set if the font bold style
  18647. </member>
  18648. <member name="P:NPOI.HSSF.UserModel.HSSFFont.TypeOffset">
  18649. <summary>
  18650. Gets or sets normal,base or subscript.
  18651. </summary>
  18652. <value>offset type to use (none,base,sub)</value>
  18653. </member>
  18654. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Underline">
  18655. <summary>
  18656. Gets or sets the type of text Underlining to use
  18657. </summary>
  18658. <value>The Underlining type.</value>
  18659. </member>
  18660. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Charset">
  18661. <summary>
  18662. Gets or sets the char set to use.
  18663. </summary>
  18664. <value>The char set.</value>
  18665. </member>
  18666. <member name="M:NPOI.HSSF.UserModel.HSSFFont.ToString">
  18667. <summary>
  18668. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  18669. </summary>
  18670. <returns>
  18671. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  18672. </returns>
  18673. </member>
  18674. <member name="M:NPOI.HSSF.UserModel.HSSFFont.GetHashCode">
  18675. <summary>
  18676. Serves as a hash function for a particular type.
  18677. </summary>
  18678. <returns>
  18679. A hash code for the current <see cref="T:System.Object"/>.
  18680. </returns>
  18681. </member>
  18682. <member name="M:NPOI.HSSF.UserModel.HSSFFont.Equals(System.Object)">
  18683. <summary>
  18684. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
  18685. </summary>
  18686. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
  18687. <returns>
  18688. true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
  18689. </returns>
  18690. <exception cref="T:System.NullReferenceException">
  18691. The <paramref name="obj"/> parameter is null.
  18692. </exception>
  18693. </member>
  18694. <member name="T:NPOI.HSSF.UserModel.HSSFFontFormatting">
  18695. High level representation for Font Formatting component
  18696. of Conditional Formatting Settings
  18697. @author Dmitriy Kumshayev
  18698. </member>
  18699. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.EscapementType">
  18700. Get the type of base or subscript for the font
  18701. @return base or subscript option
  18702. </member>
  18703. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.FontColorIndex">
  18704. @return font color index
  18705. </member>
  18706. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.FontHeight">
  18707. Gets the height of the font in 1/20th point Units
  18708. @return fontheight (in points/20); or -1 if not modified
  18709. </member>
  18710. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.FontWeight">
  18711. Get the font weight for this font (100-1000dec or 0x64-0x3e8). Default Is
  18712. 0x190 for normal and 0x2bc for bold
  18713. @return bw - a number between 100-1000 for the fonts "boldness"
  18714. </member>
  18715. <member name="M:NPOI.HSSF.UserModel.HSSFFontFormatting.GetRawRecord">
  18716. @return
  18717. @see org.apache.poi.hssf.record.cf.FontFormatting#GetRawRecord()
  18718. </member>
  18719. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.UnderlineType">
  18720. Get the type of Underlining for the font
  18721. @return font Underlining type
  18722. @see #U_NONE
  18723. @see #U_SINGLE
  18724. @see #U_DOUBLE
  18725. @see #U_SINGLE_ACCOUNTING
  18726. @see #U_DOUBLE_ACCOUNTING
  18727. </member>
  18728. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsBold">
  18729. Get whether the font weight Is Set to bold or not
  18730. @return bold - whether the font Is bold or not
  18731. </member>
  18732. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsEscapementTypeModified">
  18733. @return true if escapement type was modified from default
  18734. </member>
  18735. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontCancellationModified">
  18736. @return true if font cancellation was modified from default
  18737. </member>
  18738. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontOutlineModified">
  18739. @return true if font outline type was modified from default
  18740. </member>
  18741. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontShadowModified">
  18742. @return true if font shadow type was modified from default
  18743. </member>
  18744. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontStyleModified">
  18745. @return true if font style was modified from default
  18746. </member>
  18747. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsItalic">
  18748. @return true if font style was Set to <i>italic</i>
  18749. </member>
  18750. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsOutlineOn">
  18751. @return true if font outline Is on
  18752. </member>
  18753. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsShadowOn">
  18754. @return true if font shadow Is on
  18755. </member>
  18756. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsStrikeout">
  18757. @return true if font strikeout Is on
  18758. </member>
  18759. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsUnderlineTypeModified">
  18760. @return true if font Underline type was modified from default
  18761. </member>
  18762. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontWeightModified">
  18763. @return true if font weight was modified from default
  18764. </member>
  18765. <member name="M:NPOI.HSSF.UserModel.HSSFFontFormatting.SetFontStyle(System.Boolean,System.Boolean)">
  18766. Set font style options.
  18767. @param italic - if true, Set posture style to italic, otherwise to normal
  18768. @param bold- if true, Set font weight to bold, otherwise to normal
  18769. </member>
  18770. <member name="M:NPOI.HSSF.UserModel.HSSFFontFormatting.ResetFontStyle">
  18771. Set font style options to default values (non-italic, non-bold)
  18772. </member>
  18773. <member name="T:NPOI.HSSF.UserModel.HSSFFooter">
  18774. <summary>
  18775. Class to Read and manipulate the footer.
  18776. The footer works by having a left, center, and right side. The total cannot
  18777. be more that 255 bytes long. One uses this class by Getting the HSSFFooter
  18778. from HSSFSheet and then Getting or Setting the left, center, and right side.
  18779. For special things (such as page numbers and date), one can use a the methods
  18780. that return the Chars used to represent these. One can also Change the
  18781. fonts by using similar methods.
  18782. @author Shawn Laubach (slaubach at apache dot org)
  18783. </summary>
  18784. </member>
  18785. <member name="M:NPOI.HSSF.UserModel.HSSFFooter.#ctor(NPOI.HSSF.Record.Aggregates.PageSettingsBlock)">
  18786. <summary>
  18787. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFFooter"/> class.
  18788. </summary>
  18789. <param name="psb">Footer record to create the footer with</param>
  18790. </member>
  18791. <member name="P:NPOI.HSSF.UserModel.HSSFFooter.RawText">
  18792. <summary>
  18793. Gets the raw footer.
  18794. </summary>
  18795. <value>The raw footer.</value>
  18796. </member>
  18797. <member name="T:NPOI.HSSF.UserModel.HSSFFormulaEvaluator">
  18798. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  18799. </member>
  18800. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.#ctor(NPOI.SS.UserModel.IWorkbook,NPOI.SS.Formula.IStabilityClassifier)">
  18801. @param stabilityClassifier used to optimise caching performance. Pass <code>null</code>
  18802. for the (conservative) assumption that any cell may have its definition changed after
  18803. evaluation begins.
  18804. </member>
  18805. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.#ctor(NPOI.SS.UserModel.IWorkbook,NPOI.SS.Formula.IStabilityClassifier,NPOI.SS.Formula.UDF.UDFFinder)">
  18806. @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
  18807. </member>
  18808. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.Create(NPOI.SS.UserModel.IWorkbook,NPOI.SS.Formula.IStabilityClassifier,NPOI.SS.Formula.UDF.UDFFinder)">
  18809. @param stabilityClassifier used to optimise caching performance. Pass <code>null</code>
  18810. for the (conservative) assumption that any cell may have its definition changed after
  18811. evaluation begins.
  18812. @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
  18813. </member>
  18814. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.SetupEnvironment(System.String[],NPOI.HSSF.UserModel.HSSFFormulaEvaluator[])">
  18815. Coordinates several formula evaluators together so that formulas that involve external
  18816. references can be evaluated.
  18817. @param workbookNames the simple file names used to identify the workbooks in formulas
  18818. with external links (for example "MyData.xls" as used in a formula "[MyData.xls]Sheet1!A1")
  18819. @param evaluators all evaluators for the full set of workbooks required by the formulas.
  18820. </member>
  18821. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.NotifyUpdateCell(NPOI.SS.UserModel.ICell)">
  18822. Should be called to tell the cell value cache that the specified (value or formula) cell
  18823. has changed.
  18824. Failure to call this method after changing cell values will cause incorrect behaviour
  18825. of the evaluate~ methods of this class
  18826. </member>
  18827. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.NotifyDeleteCell(NPOI.SS.UserModel.ICell)">
  18828. Should be called to tell the cell value cache that the specified cell has just been
  18829. deleted.
  18830. Failure to call this method after changing cell values will cause incorrect behaviour
  18831. of the evaluate~ methods of this class
  18832. </member>
  18833. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.NotifySetFormula(NPOI.SS.UserModel.ICell)">
  18834. Should be called to tell the cell value cache that the specified (value or formula) cell
  18835. has changed.
  18836. Failure to call this method after changing cell values will cause incorrect behaviour
  18837. of the evaluate~ methods of this class
  18838. </member>
  18839. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.EvaluateFormulaCellValue(NPOI.SS.UserModel.ICell)">
  18840. Returns a CellValue wrapper around the supplied ValueEval instance.
  18841. @param cell
  18842. </member>
  18843. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.EvaluateInCell(NPOI.SS.UserModel.ICell)">
  18844. If cell Contains formula, it Evaluates the formula, and
  18845. puts the formula result back into the cell, in place
  18846. of the old formula.
  18847. Else if cell does not contain formula, this method leaves
  18848. the cell UnChanged.
  18849. Note that the same instance of Cell is returned to
  18850. allow chained calls like:
  18851. <pre>
  18852. int EvaluatedCellType = evaluator.EvaluateInCell(cell).CellType;
  18853. </pre>
  18854. Be aware that your cell value will be Changed to hold the
  18855. result of the formula. If you simply want the formula
  18856. value computed for you, use {@link #EvaluateFormulaCell(HSSFCell)}
  18857. @param cell
  18858. </member>
  18859. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.EvaluateAllFormulaCells(NPOI.HSSF.UserModel.HSSFWorkbook)">
  18860. Loops over all cells in all sheets of the supplied
  18861. workbook.
  18862. For cells that contain formulas, their formulas are
  18863. Evaluated, and the results are saved. These cells
  18864. remain as formula cells.
  18865. For cells that do not contain formulas, no Changes
  18866. are made.
  18867. This is a helpful wrapper around looping over all
  18868. cells, and calling EvaluateFormulaCell on each one.
  18869. </member>
  18870. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.EvaluateAllFormulaCells(NPOI.SS.UserModel.IWorkbook)">
  18871. Loops over all cells in all sheets of the supplied
  18872. workbook.
  18873. For cells that contain formulas, their formulas are
  18874. evaluated, and the results are saved. These cells
  18875. remain as formula cells.
  18876. For cells that do not contain formulas, no changes
  18877. are made.
  18878. This is a helpful wrapper around looping over all
  18879. cells, and calling evaluateFormulaCell on each one.
  18880. </member>
  18881. <member name="T:NPOI.HSSF.UserModel.HSSFHeader">
  18882. <summary>
  18883. Class to Read and manipulate the header.
  18884. The header works by having a left, center, and right side. The total cannot
  18885. be more that 255 bytes long. One uses this class by Getting the HSSFHeader
  18886. from HSSFSheet and then Getting or Setting the left, center, and right side.
  18887. For special things (such as page numbers and date), one can use a the methods
  18888. that return the Chars used to represent these. One can also Change the
  18889. fonts by using similar methods.
  18890. @author Shawn Laubach (slaubach at apache dot org)
  18891. </summary>
  18892. </member>
  18893. <member name="M:NPOI.HSSF.UserModel.HSSFHeader.#ctor(NPOI.HSSF.Record.Aggregates.PageSettingsBlock)">
  18894. <summary>
  18895. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFFooter"/> class.
  18896. </summary>
  18897. <param name="psb">Footer record to Create the footer with</param>
  18898. </member>
  18899. <member name="P:NPOI.HSSF.UserModel.HSSFHeader.RawText">
  18900. <summary>
  18901. Gets the raw footer.
  18902. </summary>
  18903. <value>The raw footer.</value>
  18904. </member>
  18905. <member name="T:NPOI.HSSF.UserModel.HSSFHyperlink">
  18906. <summary>
  18907. Represents an Excel hyperlink.
  18908. </summary>
  18909. <remarks>@author Yegor Kozlov (yegor at apache dot org)</remarks>
  18910. </member>
  18911. <member name="F:NPOI.HSSF.UserModel.HSSFHyperlink.record">
  18912. Low-level record object that stores the actual hyperlink data
  18913. </member>
  18914. <member name="F:NPOI.HSSF.UserModel.HSSFHyperlink.link_type">
  18915. If we Create a new hypelrink remember its type
  18916. </member>
  18917. <member name="M:NPOI.HSSF.UserModel.HSSFHyperlink.#ctor(NPOI.SS.UserModel.HyperlinkType)">
  18918. <summary>
  18919. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFHyperlink"/> class.
  18920. </summary>
  18921. <param name="type">The type of hyperlink to Create.</param>
  18922. </member>
  18923. <member name="M:NPOI.HSSF.UserModel.HSSFHyperlink.#ctor(NPOI.HSSF.Record.HyperlinkRecord)">
  18924. <summary>
  18925. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFHyperlink"/> class.
  18926. </summary>
  18927. <param name="record">The record.</param>
  18928. </member>
  18929. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.FirstRow">
  18930. <summary>
  18931. Gets or sets the row of the first cell that Contains the hyperlink
  18932. </summary>
  18933. <value>the 0-based row of the cell that Contains the hyperlink.</value>
  18934. </member>
  18935. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.LastRow">
  18936. <summary>
  18937. Gets or sets the row of the last cell that Contains the hyperlink
  18938. </summary>
  18939. <value>the 0-based row of the last cell that Contains the hyperlink</value>
  18940. </member>
  18941. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.FirstColumn">
  18942. <summary>
  18943. Gets or sets the column of the first cell that Contains the hyperlink
  18944. </summary>
  18945. <value>the 0-based column of the first cell that Contains the hyperlink</value>
  18946. </member>
  18947. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.LastColumn">
  18948. <summary>
  18949. Gets or sets the column of the last cell that Contains the hyperlink
  18950. </summary>
  18951. <value>the 0-based column of the last cell that Contains the hyperlink</value>
  18952. </member>
  18953. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.Address">
  18954. <summary>
  18955. Gets or sets Hypelink Address. Depending on the hyperlink type it can be URL, e-mail, patrh to a file, etc.
  18956. </summary>
  18957. <value>the Address of this hyperlink</value>
  18958. </member>
  18959. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.TextMark">
  18960. <summary>
  18961. Gets or sets the text mark.
  18962. </summary>
  18963. <value>The text mark.</value>
  18964. </member>
  18965. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.ShortFilename">
  18966. <summary>
  18967. Gets or sets the short filename.
  18968. </summary>
  18969. <value>The short filename.</value>
  18970. </member>
  18971. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.Label">
  18972. <summary>
  18973. Gets or sets the text label for this hyperlink
  18974. </summary>
  18975. <value>text to Display</value>
  18976. </member>
  18977. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.Type">
  18978. <summary>
  18979. Gets the type of this hyperlink
  18980. </summary>
  18981. <value>the type of this hyperlink</value>
  18982. </member>
  18983. <member name="M:NPOI.HSSF.UserModel.HSSFHyperlink.Equals(System.Object)">
  18984. @return whether the objects have the same HyperlinkRecord
  18985. </member>
  18986. <member name="T:NPOI.HSSF.UserModel.HSSFIconMultiStateFormatting">
  18987. High level representation for Icon / Multi-State Formatting
  18988. component of Conditional Formatting Settings
  18989. </member>
  18990. <member name="T:NPOI.HSSF.UserModel.HSSFName">
  18991. <summary>
  18992. High Level Represantion of Named Range
  18993. </summary>
  18994. <remarks>@author Libin Roman (Vista Portal LDT. Developer)</remarks>
  18995. </member>
  18996. <member name="M:NPOI.HSSF.UserModel.HSSFName.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.Record.NameRecord,NPOI.HSSF.Record.NameCommentRecord)">
  18997. <summary>
  18998. Creates new HSSFName - called by HSSFWorkbook to Create a sheet from
  18999. scratch.
  19000. </summary>
  19001. <param name="book">lowlevel Workbook object associated with the sheet.</param>
  19002. <param name="name">the Name Record</param>
  19003. <param name="comment"></param>
  19004. </member>
  19005. <member name="P:NPOI.HSSF.UserModel.HSSFName.SheetName">
  19006. <summary>
  19007. Gets or sets the sheets name which this named range is referenced to
  19008. </summary>
  19009. <value>sheet name, which this named range refered to</value>
  19010. </member>
  19011. <member name="P:NPOI.HSSF.UserModel.HSSFName.NameName">
  19012. <summary>
  19013. Gets or sets the name of the named range
  19014. </summary>
  19015. <value>named range name</value>
  19016. </member>
  19017. <member name="P:NPOI.HSSF.UserModel.HSSFName.SheetIndex">
  19018. Returns the sheet index this name applies to.
  19019. @return the sheet index this name applies to, -1 if this name applies to the entire workbook
  19020. </member>
  19021. <member name="M:NPOI.HSSF.UserModel.HSSFName.SetNameDefinition(NPOI.SS.Formula.PTG.Ptg[])">
  19022. <summary>
  19023. Sets the NameParsedFormula structure that specifies the formula for the defined name.
  19024. </summary>
  19025. <param name="ptgs">the sequence of {@link Ptg}s for the formula.</param>
  19026. </member>
  19027. <member name="P:NPOI.HSSF.UserModel.HSSFName.IsDeleted">
  19028. <summary>
  19029. Tests if this name points to a cell that no longer exists
  19030. </summary>
  19031. <value>
  19032. <c>true</c> if the name refers to a deleted cell; otherwise, <c>false</c>.
  19033. </value>
  19034. </member>
  19035. <member name="P:NPOI.HSSF.UserModel.HSSFName.IsFunctionName">
  19036. <summary>
  19037. Gets a value indicating whether this instance is function name.
  19038. </summary>
  19039. <value>
  19040. <c>true</c> if this instance is function name; otherwise, <c>false</c>.
  19041. </value>
  19042. </member>
  19043. <member name="M:NPOI.HSSF.UserModel.HSSFName.SetFunction(System.Boolean)">
  19044. Indicates that the defined name refers to a user-defined function.
  19045. This attribute is used when there is an add-in or other code project associated with the file.
  19046. @param value <c>true</c> indicates the name refers to a function.
  19047. </member>
  19048. <member name="M:NPOI.HSSF.UserModel.HSSFName.ToString">
  19049. <summary>
  19050. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  19051. </summary>
  19052. <returns>
  19053. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  19054. </returns>
  19055. </member>
  19056. <member name="T:NPOI.HSSF.UserModel.HSSFObjectData">
  19057. Represents binary object (i.e. OLE) data stored in the file. Eg. A GIF, JPEG etc...
  19058. @author Daniel Noll
  19059. </member>
  19060. <member name="F:NPOI.HSSF.UserModel.HSSFObjectData._root">
  19061. Reference to the filesystem root, required for retrieving the object data.
  19062. </member>
  19063. <member name="P:NPOI.HSSF.UserModel.HSSFObjectData.OLE2ClassName">
  19064. Returns the OLE2 Class Name of the object
  19065. </member>
  19066. <member name="M:NPOI.HSSF.UserModel.HSSFObjectData.GetDirectory">
  19067. Gets the object data. Only call for ones that have
  19068. data though. See {@link #hasDirectoryEntry()}
  19069. @return the object data as an OLE2 directory.
  19070. @ if there was an error Reading the data.
  19071. </member>
  19072. <member name="M:NPOI.HSSF.UserModel.HSSFObjectData.GetObjectData">
  19073. Returns the data portion, for an ObjectData
  19074. that doesn't have an associated POIFS Directory
  19075. Entry
  19076. </member>
  19077. <member name="M:NPOI.HSSF.UserModel.HSSFObjectData.HasDirectoryEntry">
  19078. Does this ObjectData have an associated POIFS
  19079. Directory Entry?
  19080. (Not all do, those that don't have a data portion)
  19081. </member>
  19082. <member name="M:NPOI.HSSF.UserModel.HSSFObjectData.FindObjectRecord">
  19083. Finds the EmbeddedObjectRefSubRecord, or throws an
  19084. Exception if there wasn't one
  19085. </member>
  19086. <member name="T:NPOI.HSSF.UserModel.HSSFOptimiser">
  19087. <summary>
  19088. Excel can Get cranky if you give it files containing too
  19089. many (especially duplicate) objects, and this class can
  19090. help to avoid those.
  19091. In general, it's much better to make sure you don't
  19092. duplicate the objects in your code, as this is likely
  19093. to be much faster than creating lots and lots of
  19094. excel objects+records, only to optimise them down to
  19095. many fewer at a later stage.
  19096. However, sometimes this is too hard / tricky to do, which
  19097. is where the use of this class comes in.
  19098. </summary>
  19099. </member>
  19100. <member name="M:NPOI.HSSF.UserModel.HSSFOptimiser.OptimiseFonts(NPOI.HSSF.UserModel.HSSFWorkbook)">
  19101. <summary>
  19102. Goes through the Workbook, optimising the fonts by
  19103. removing duplicate ones.
  19104. For now, only works on fonts used in HSSFCellStyle
  19105. and HSSFRichTextString. Any other font uses
  19106. (eg charts, pictures) may well end up broken!
  19107. This can be a slow operation, especially if you have
  19108. lots of cells, cell styles or rich text strings
  19109. </summary>
  19110. <param name="workbook">The workbook in which to optimise the fonts</param>
  19111. </member>
  19112. <member name="M:NPOI.HSSF.UserModel.HSSFOptimiser.OptimiseCellStyles(NPOI.HSSF.UserModel.HSSFWorkbook)">
  19113. <summary>
  19114. Goes through the Wokrbook, optimising the cell styles
  19115. by removing duplicate ones and ones that aren't used.
  19116. For best results, optimise the fonts via a call to
  19117. OptimiseFonts(HSSFWorkbook) first
  19118. </summary>
  19119. <param name="workbook">The workbook in which to optimise the cell styles</param>
  19120. </member>
  19121. <member name="T:NPOI.HSSF.UserModel.HSSFPalette">
  19122. <summary>
  19123. Represents a workbook color palette.
  19124. Internally, the XLS format refers to colors using an offset into the palette
  19125. record. Thus, the first color in the palette has the index 0x8, the second
  19126. has the index 0x9, etc. through 0x40
  19127. @author Brian Sanders (bsanders at risklabs dot com)
  19128. </summary>
  19129. </member>
  19130. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.GetColor(System.Int16)">
  19131. <summary>
  19132. Retrieves the color at a given index
  19133. </summary>
  19134. <param name="index">the palette index, between 0x8 to 0x40 inclusive.</param>
  19135. <returns>the color, or null if the index Is not populated</returns>
  19136. </member>
  19137. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.FindColor(System.Byte,System.Byte,System.Byte)">
  19138. <summary>
  19139. Finds the first occurance of a given color
  19140. </summary>
  19141. <param name="red">the RGB red component, between 0 and 255 inclusive</param>
  19142. <param name="green">the RGB green component, between 0 and 255 inclusive</param>
  19143. <param name="blue">the RGB blue component, between 0 and 255 inclusive</param>
  19144. <returns>the color, or null if the color does not exist in this palette</returns>
  19145. </member>
  19146. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.FindSimilarColor(System.Byte,System.Byte,System.Byte)">
  19147. <summary>
  19148. Finds the closest matching color in the custom palette. The
  19149. method for Finding the distance between the colors Is fairly
  19150. primative.
  19151. </summary>
  19152. <param name="red">The red component of the color to match.</param>
  19153. <param name="green">The green component of the color to match.</param>
  19154. <param name="blue">The blue component of the color to match.</param>
  19155. <returns>The closest color or null if there are no custom
  19156. colors currently defined.</returns>
  19157. </member>
  19158. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.SetColorAtIndex(System.Int16,System.Byte,System.Byte,System.Byte)">
  19159. <summary>
  19160. Sets the color at the given offset
  19161. </summary>
  19162. <param name="index">the palette index, between 0x8 to 0x40 inclusive</param>
  19163. <param name="red">the RGB red component, between 0 and 255 inclusive</param>
  19164. <param name="green">the RGB green component, between 0 and 255 inclusive</param>
  19165. <param name="blue">the RGB blue component, between 0 and 255 inclusive</param>
  19166. </member>
  19167. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.AddColor(System.Byte,System.Byte,System.Byte)">
  19168. <summary>
  19169. Adds a new color into an empty color slot.
  19170. </summary>
  19171. <param name="red">The red component</param>
  19172. <param name="green">The green component</param>
  19173. <param name="blue">The blue component</param>
  19174. <returns>The new custom color.</returns>
  19175. </member>
  19176. <member name="T:NPOI.HSSF.UserModel.HSSFPalette.CustomColor">
  19177. <summary>
  19178. user custom color
  19179. </summary>
  19180. </member>
  19181. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.#ctor(System.Int16,System.Byte[])">
  19182. <summary>
  19183. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFPalette.CustomColor"/> class.
  19184. </summary>
  19185. <param name="byteOffset">The byte offset.</param>
  19186. <param name="colors">The colors.</param>
  19187. </member>
  19188. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.#ctor(System.Int16,System.Byte,System.Byte,System.Byte)">
  19189. <summary>
  19190. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFPalette.CustomColor"/> class.
  19191. </summary>
  19192. <param name="byteOffset">The byte offset.</param>
  19193. <param name="red">The red.</param>
  19194. <param name="green">The green.</param>
  19195. <param name="blue">The blue.</param>
  19196. </member>
  19197. <member name="P:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.Indexed">
  19198. <summary>
  19199. Gets index to the standard palette
  19200. </summary>
  19201. <value></value>
  19202. </member>
  19203. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.GetTriplet">
  19204. <summary>
  19205. Gets triplet representation like that in Excel
  19206. </summary>
  19207. <value></value>
  19208. </member>
  19209. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.GetHexString">
  19210. <summary>
  19211. Gets a hex string exactly like a gnumeric triplet
  19212. </summary>
  19213. <value></value>
  19214. </member>
  19215. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.GetGnumericPart(System.Byte)">
  19216. <summary>
  19217. Gets the gnumeric part.
  19218. </summary>
  19219. <param name="color">The color.</param>
  19220. <returns></returns>
  19221. </member>
  19222. <member name="T:NPOI.HSSF.UserModel.HSSFPatriarch">
  19223. <summary>
  19224. The patriarch is the toplevel container for shapes in a sheet. It does
  19225. little other than act as a container for other shapes and Groups.
  19226. @author Glen Stampoultzis (glens at apache.org)
  19227. </summary>
  19228. </member>
  19229. <member name="F:NPOI.HSSF.UserModel.HSSFPatriarch._boundAggregate">
  19230. The EscherAggregate we have been bound to.
  19231. (This will handle writing us out into records,
  19232. and building up our shapes from the records)
  19233. </member>
  19234. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.#ctor(NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.Record.EscherAggregate)">
  19235. <summary>
  19236. Creates the patriarch.
  19237. </summary>
  19238. <param name="sheet">the sheet this patriarch is stored in.</param>
  19239. <param name="boundAggregate">The bound aggregate.</param>
  19240. </member>
  19241. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.PreSerialize">
  19242. check if any shapes contain wrong data
  19243. At now(13.08.2010) check if patriarch contains 2 or more comments with same coordinates
  19244. </member>
  19245. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.RemoveShape(NPOI.HSSF.UserModel.HSSFShape)">
  19246. @param shape to be removed
  19247. @return true of shape is removed
  19248. </member>
  19249. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateGroup(NPOI.HSSF.UserModel.HSSFClientAnchor)">
  19250. <summary>
  19251. Creates a new Group record stored Under this patriarch.
  19252. </summary>
  19253. <param name="anchor">the client anchor describes how this Group is attached
  19254. to the sheet.</param>
  19255. <returns>the newly created Group.</returns>
  19256. </member>
  19257. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateSimpleShape(NPOI.HSSF.UserModel.HSSFClientAnchor)">
  19258. <summary>
  19259. Creates a simple shape. This includes such shapes as lines, rectangles,
  19260. and ovals.
  19261. Note: Microsoft Excel seems to sometimes disallow
  19262. higher y1 than y2 or higher x1 than x2 in the anchor, you might need to
  19263. reverse them and draw shapes vertically or horizontally flipped!
  19264. </summary>
  19265. <param name="anchor">the client anchor describes how this Group is attached
  19266. to the sheet.</param>
  19267. <returns>the newly created shape.</returns>
  19268. </member>
  19269. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreatePicture(NPOI.HSSF.UserModel.HSSFClientAnchor,System.Int32)">
  19270. <summary>
  19271. Creates a picture.
  19272. </summary>
  19273. <param name="anchor">the client anchor describes how this Group is attached
  19274. to the sheet.</param>
  19275. <param name="pictureIndex">Index of the picture.</param>
  19276. <returns>the newly created shape.</returns>
  19277. </member>
  19278. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreatePicture(NPOI.SS.UserModel.IClientAnchor,System.Int32)">
  19279. <summary>
  19280. CreatePicture
  19281. </summary>
  19282. <param name="anchor">the client anchor describes how this picture is attached to the sheet.</param>
  19283. <param name="pictureIndex">the index of the picture in the workbook collection of pictures.</param>
  19284. <returns>return newly created shape</returns>
  19285. </member>
  19286. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateObjectData(NPOI.HSSF.UserModel.HSSFClientAnchor,System.Int32,System.Int32)">
  19287. Adds a new OLE Package Shape
  19288. @param anchor the client anchor describes how this picture is
  19289. attached to the sheet.
  19290. @param storageId the storageId returned by {@Link HSSFWorkbook.AddOlePackage}
  19291. @param pictureIndex the index of the picture (used as preview image) in the
  19292. workbook collection of pictures.
  19293. @return newly Created shape
  19294. </member>
  19295. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreatePolygon(NPOI.SS.UserModel.IClientAnchor)">
  19296. <summary>
  19297. Creates a polygon
  19298. </summary>
  19299. <param name="anchor">the client anchor describes how this Group is attached
  19300. to the sheet.</param>
  19301. <returns>the newly Created shape.</returns>
  19302. </member>
  19303. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateTextbox(NPOI.SS.UserModel.IClientAnchor)">
  19304. <summary>
  19305. Constructs a textbox Under the patriarch.
  19306. </summary>
  19307. <param name="anchor">the client anchor describes how this Group is attached
  19308. to the sheet.</param>
  19309. <returns>the newly Created textbox.</returns>
  19310. </member>
  19311. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateComment(NPOI.HSSF.UserModel.HSSFAnchor)">
  19312. Constructs a cell comment.
  19313. @param anchor the client anchor describes how this comment is attached
  19314. to the sheet.
  19315. @return the newly created comment.
  19316. </member>
  19317. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateComboBox(NPOI.HSSF.UserModel.HSSFAnchor)">
  19318. YK: used to create autofilters
  19319. @see org.apache.poi.hssf.usermodel.HSSFSheet#setAutoFilter(int, int, int, int)
  19320. </member>
  19321. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateCellComment(NPOI.SS.UserModel.IClientAnchor)">
  19322. <summary>
  19323. Constructs a cell comment.
  19324. </summary>
  19325. <param name="anchor">the client anchor describes how this comment is attached
  19326. to the sheet.</param>
  19327. <returns>the newly created comment.</returns>
  19328. </member>
  19329. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.Children">
  19330. <summary>
  19331. Returns a list of all shapes contained by the patriarch.
  19332. </summary>
  19333. <value>The children.</value>
  19334. </member>
  19335. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.AddShape(NPOI.HSSF.UserModel.HSSFShape)">
  19336. add a shape to this drawing
  19337. </member>
  19338. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.CountOfAllChildren">
  19339. <summary>
  19340. Total count of all children and their children's children.
  19341. </summary>
  19342. <value>The count of all children.</value>
  19343. </member>
  19344. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.SetCoordinates(System.Int32,System.Int32,System.Int32,System.Int32)">
  19345. <summary>
  19346. Sets the coordinate space of this Group. All children are contrained
  19347. to these coordinates.
  19348. </summary>
  19349. <param name="x1">The x1.</param>
  19350. <param name="y1">The y1.</param>
  19351. <param name="x2">The x2.</param>
  19352. <param name="y2">The y2.</param>
  19353. </member>
  19354. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.ContainsChart">
  19355. <summary>
  19356. Does this HSSFPatriarch contain a chart?
  19357. (Technically a reference to a chart, since they
  19358. Get stored in a different block of records)
  19359. FIXME - detect chart in all cases (only seems
  19360. to work on some charts so far)
  19361. </summary>
  19362. <returns>
  19363. <c>true</c> if this instance contains chart; otherwise, <c>false</c>.
  19364. </returns>
  19365. </member>
  19366. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.X1">
  19367. <summary>
  19368. The top left x coordinate of this Group.
  19369. </summary>
  19370. <value>The x1.</value>
  19371. </member>
  19372. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.Y1">
  19373. <summary>
  19374. The top left y coordinate of this Group.
  19375. </summary>
  19376. <value>The y1.</value>
  19377. </member>
  19378. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.X2">
  19379. <summary>
  19380. The bottom right x coordinate of this Group.
  19381. </summary>
  19382. <value>The x2.</value>
  19383. </member>
  19384. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.Y2">
  19385. <summary>
  19386. The bottom right y coordinate of this Group.
  19387. </summary>
  19388. <value>The y2.</value>
  19389. </member>
  19390. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.GetBoundAggregate">
  19391. <summary>
  19392. Returns the aggregate escher record we're bound to
  19393. </summary>
  19394. <returns></returns>
  19395. </member>
  19396. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateAnchor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  19397. Creates a new client anchor and sets the top-left and bottom-right
  19398. coordinates of the anchor.
  19399. @param dx1 the x coordinate in EMU within the first cell.
  19400. @param dy1 the y coordinate in EMU within the first cell.
  19401. @param dx2 the x coordinate in EMU within the second cell.
  19402. @param dy2 the y coordinate in EMU within the second cell.
  19403. @param col1 the column (0 based) of the first cell.
  19404. @param row1 the row (0 based) of the first cell.
  19405. @param col2 the column (0 based) of the second cell.
  19406. @param row2 the row (0 based) of the second cell.
  19407. @return the newly created client anchor
  19408. </member>
  19409. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.BuildShapeTree">
  19410. create shape tree from existing escher records tree
  19411. </member>
  19412. <member name="T:NPOI.HSSF.UserModel.HSSFPatternFormatting">
  19413. <summary>
  19414. High level representation for Conditional Formatting Settings
  19415. @author Dmitriy Kumshayev
  19416. </summary>
  19417. </member>
  19418. <member name="M:NPOI.HSSF.UserModel.HSSFPatternFormatting.#ctor(NPOI.HSSF.Record.CFRuleBase,NPOI.HSSF.UserModel.HSSFWorkbook)">
  19419. <summary>
  19420. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFPatternFormatting"/> class.
  19421. </summary>
  19422. <param name="cfRuleRecord">The cf rule record.</param>
  19423. </member>
  19424. <member name="P:NPOI.HSSF.UserModel.HSSFPatternFormatting.PatternFormattingBlock">
  19425. <summary>
  19426. Gets the pattern formatting block.
  19427. </summary>
  19428. <value>The pattern formatting block.</value>
  19429. </member>
  19430. <member name="P:NPOI.HSSF.UserModel.HSSFPatternFormatting.FillBackgroundColor">
  19431. <summary>
  19432. Gets or sets the color of the fill background.
  19433. </summary>
  19434. <value>The color of the fill background.</value>
  19435. </member>
  19436. <member name="P:NPOI.HSSF.UserModel.HSSFPatternFormatting.FillForegroundColor">
  19437. <summary>
  19438. Gets or sets the color of the fill foreground.
  19439. </summary>
  19440. <value>The color of the fill foreground.</value>
  19441. </member>
  19442. <member name="P:NPOI.HSSF.UserModel.HSSFPatternFormatting.FillPattern">
  19443. <summary>
  19444. Gets or sets the fill pattern.
  19445. </summary>
  19446. <value>The fill pattern.</value>
  19447. </member>
  19448. <member name="T:NPOI.HSSF.UserModel.HSSFPicture">
  19449. <summary>
  19450. Represents a escher picture. Eg. A GIF, JPEG etc...
  19451. @author Glen Stampoultzis
  19452. @author Yegor Kozlov (yegor at apache.org)
  19453. </summary>
  19454. </member>
  19455. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  19456. <summary>
  19457. Constructs a picture object.
  19458. </summary>
  19459. <param name="parent">The parent.</param>
  19460. <param name="anchor">The anchor.</param>
  19461. </member>
  19462. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.Resize">
  19463. <summary>
  19464. Reset the image to the dimension of the embedded image
  19465. </summary>
  19466. <remarks>
  19467. Please note, that this method works correctly only for workbooks
  19468. with default font size (Arial 10pt for .xls).
  19469. If the default font is changed the resized image can be streched vertically or horizontally.
  19470. </remarks>
  19471. </member>
  19472. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.Resize(System.Double)">
  19473. <summary>
  19474. Resize the image proportionally.
  19475. </summary>
  19476. <param name="scale">scale</param>
  19477. <seealso cref="M:NPOI.HSSF.UserModel.HSSFPicture.Resize(System.Double,System.Double)"/>
  19478. </member>
  19479. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.Resize(System.Double,System.Double)">
  19480. Resize the image
  19481. <p>
  19482. Please note, that this method works correctly only for workbooks
  19483. with default font size (Arial 10pt for .xls).
  19484. If the default font is changed the resized image can be streched vertically or horizontally.
  19485. </p>
  19486. <p>
  19487. <code>resize(1.0,1.0)</code> keeps the original size,<br/>
  19488. <code>resize(0.5,0.5)</code> resize to 50% of the original,<br/>
  19489. <code>resize(2.0,2.0)</code> resizes to 200% of the original.<br/>
  19490. <code>resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE})</code> resizes to the dimension of the embedded image.
  19491. </p>
  19492. @param scaleX the amount by which the image width is multiplied relative to the original width.
  19493. @param scaleY the amount by which the image height is multiplied relative to the original height.
  19494. </member>
  19495. <member name="P:NPOI.HSSF.UserModel.HSSFPicture.PictureIndex">
  19496. <summary>
  19497. Gets or sets the index of the picture.
  19498. </summary>
  19499. <value>The index of the picture.</value>
  19500. </member>
  19501. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.GetPreferredSize(System.Double)">
  19502. Calculate the preferred size for this picture.
  19503. @param scale the amount by which image dimensions are multiplied relative to the original size.
  19504. @return HSSFClientAnchor with the preferred size for this image
  19505. @since POI 3.0.2
  19506. </member>
  19507. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.GetPreferredSize(System.Double,System.Double)">
  19508. <summary>
  19509. Calculate the preferred size for this picture.
  19510. </summary>
  19511. <param name="scaleX">the amount by which image width is multiplied relative to the original width.</param>
  19512. <param name="scaleY">the amount by which image height is multiplied relative to the original height.</param>
  19513. <returns>HSSFClientAnchor with the preferred size for this image</returns>
  19514. </member>
  19515. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.GetPreferredSize">
  19516. <summary>
  19517. Calculate the preferred size for this picture.
  19518. </summary>
  19519. <returns>HSSFClientAnchor with the preferred size for this image</returns>
  19520. </member>
  19521. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.GetResolution(SixLabors.ImageSharp.Image)">
  19522. <summary>
  19523. The metadata of PNG and JPEG can contain the width of a pixel in millimeters.
  19524. Return the the "effective" dpi calculated as
  19525. <c>25.4/HorizontalPixelSize</c>
  19526. and
  19527. <c>25.4/VerticalPixelSize</c>
  19528. . Where 25.4 is the number of mm in inch.
  19529. </summary>
  19530. <param name="r">The image.</param>
  19531. <returns>the resolution</returns>
  19532. </member>
  19533. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.GetImageDimension">
  19534. <summary>
  19535. Return the dimension of the embedded image in pixel
  19536. </summary>
  19537. <returns>image dimension</returns>
  19538. </member>
  19539. <member name="P:NPOI.HSSF.UserModel.HSSFPicture.PictureData">
  19540. Return picture data for this shape
  19541. @return picture data for this shape
  19542. </member>
  19543. <member name="P:NPOI.HSSF.UserModel.HSSFPicture.FileName">
  19544. The color applied to the lines of this shape.
  19545. </member>
  19546. <member name="P:NPOI.HSSF.UserModel.HSSFPicture.ClientAnchor">
  19547. @return the anchor that is used by this picture.
  19548. </member>
  19549. <member name="P:NPOI.HSSF.UserModel.HSSFPicture.Sheet">
  19550. @return the sheet which contains the picture shape
  19551. </member>
  19552. <member name="T:NPOI.HSSF.UserModel.HSSFPictureData">
  19553. <summary>
  19554. Represents binary data stored in the file. Eg. A GIF, JPEG etc...
  19555. @author Daniel Noll
  19556. </summary>
  19557. </member>
  19558. <member name="F:NPOI.HSSF.UserModel.HSSFPictureData.blip">
  19559. Underlying escher blip record containing the bitmap data.
  19560. </member>
  19561. <member name="M:NPOI.HSSF.UserModel.HSSFPictureData.#ctor(NPOI.DDF.EscherBlipRecord)">
  19562. <summary>
  19563. Constructs a picture object.
  19564. </summary>
  19565. <param name="blip">the underlying blip record containing the bitmap data.</param>
  19566. </member>
  19567. <member name="P:NPOI.HSSF.UserModel.HSSFPictureData.Data">
  19568. <summary>
  19569. Gets the picture data.
  19570. </summary>
  19571. <value>the picture data.</value>
  19572. </member>
  19573. <member name="P:NPOI.HSSF.UserModel.HSSFPictureData.Format">
  19574. <summary>
  19575. gets format of the picture.
  19576. </summary>
  19577. <value>The format.</value>
  19578. </member>
  19579. <member name="M:NPOI.HSSF.UserModel.HSSFPictureData.SuggestFileExtension">
  19580. <summary>
  19581. Suggests a file extension for this image.
  19582. </summary>
  19583. <returns>the file extension.</returns>
  19584. </member>
  19585. <member name="P:NPOI.HSSF.UserModel.HSSFPictureData.MimeType">
  19586. Returns the mime type for the image
  19587. </member>
  19588. <member name="P:NPOI.HSSF.UserModel.HSSFPictureData.PictureType">
  19589. @return the POI internal image type, -1 if not unknown image type
  19590. @see Workbook#PICTURE_TYPE_DIB
  19591. @see Workbook#PICTURE_TYPE_EMF
  19592. @see Workbook#PICTURE_TYPE_JPEG
  19593. @see Workbook#PICTURE_TYPE_PICT
  19594. @see Workbook#PICTURE_TYPE_PNG
  19595. @see Workbook#PICTURE_TYPE_WMF
  19596. </member>
  19597. <member name="T:NPOI.HSSF.UserModel.HSSFPolygon">
  19598. <summary>
  19599. @author Glen Stampoultzis (glens at baselinksoftware.com)
  19600. </summary>
  19601. </member>
  19602. <member name="M:NPOI.HSSF.UserModel.HSSFPolygon.CreateSpContainer">
  19603. Generates the shape records for this shape.
  19604. </member>
  19605. <member name="M:NPOI.HSSF.UserModel.HSSFPolygon.CreateObjRecord">
  19606. Creates the low level OBJ record for this shape.
  19607. </member>
  19608. <member name="P:NPOI.HSSF.UserModel.HSSFPolygon.XPoints">
  19609. @return array of x coordinates
  19610. </member>
  19611. <member name="P:NPOI.HSSF.UserModel.HSSFPolygon.YPoints">
  19612. @return array of y coordinates
  19613. </member>
  19614. <member name="M:NPOI.HSSF.UserModel.HSSFPolygon.SetPoints(System.Int32[],System.Int32[])">
  19615. @param xPoints - array of x coordinates
  19616. @param yPoints - array of y coordinates
  19617. </member>
  19618. <member name="M:NPOI.HSSF.UserModel.HSSFPolygon.SetPolygonDrawArea(System.Int32,System.Int32)">
  19619. Defines the width and height of the points in the polygon
  19620. @param width
  19621. @param height
  19622. </member>
  19623. <member name="P:NPOI.HSSF.UserModel.HSSFPolygon.DrawAreaWidth">
  19624. @return shape width
  19625. </member>
  19626. <member name="P:NPOI.HSSF.UserModel.HSSFPolygon.DrawAreaHeight">
  19627. @return shape height
  19628. </member>
  19629. <member name="T:NPOI.HSSF.UserModel.HSSFPrintSetup">
  19630. <summary>
  19631. Used to modify the print Setup.
  19632. @author Shawn Laubach (slaubach at apache dot org)
  19633. </summary>
  19634. </member>
  19635. <member name="M:NPOI.HSSF.UserModel.HSSFPrintSetup.#ctor(NPOI.HSSF.Record.PrintSetupRecord)">
  19636. <summary>
  19637. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFPrintSetup"/> class.
  19638. </summary>
  19639. <param name="printSetupRecord">Takes the low level print Setup record.</param>
  19640. </member>
  19641. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.PaperSize">
  19642. <summary>
  19643. Gets or sets the size of the paper.
  19644. </summary>
  19645. <value>The size of the paper.</value>
  19646. </member>
  19647. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Scale">
  19648. <summary>
  19649. Gets or sets the scale.
  19650. </summary>
  19651. <value>The scale.</value>
  19652. </member>
  19653. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.PageStart">
  19654. <summary>
  19655. Gets or sets the page start.
  19656. </summary>
  19657. <value>The page start.</value>
  19658. </member>
  19659. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.FitWidth">
  19660. <summary>
  19661. Gets or sets the number of pages wide to fit sheet in.
  19662. </summary>
  19663. <value>the number of pages wide to fit sheet in</value>
  19664. </member>
  19665. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.FitHeight">
  19666. <summary>
  19667. Gets or sets number of pages high to fit the sheet in
  19668. </summary>
  19669. <value>number of pages high to fit the sheet in.</value>
  19670. </member>
  19671. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Options">
  19672. <summary>
  19673. Gets or sets the bit flags for the options.
  19674. </summary>
  19675. <value>the bit flags for the options.</value>
  19676. </member>
  19677. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.LeftToRight">
  19678. <summary>
  19679. Gets or sets the left to right print order.
  19680. </summary>
  19681. <value>the left to right print order.</value>
  19682. </member>
  19683. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Landscape">
  19684. <summary>
  19685. Gets or sets the landscape mode.
  19686. </summary>
  19687. <value>the landscape mode.</value>
  19688. </member>
  19689. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.ValidSettings">
  19690. <summary>
  19691. Gets or sets the valid Settings.
  19692. </summary>
  19693. <value>the valid Settings.</value>
  19694. </member>
  19695. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.NoColor">
  19696. <summary>
  19697. Gets or sets the black and white Setting.
  19698. </summary>
  19699. <value>black and white Setting</value>
  19700. </member>
  19701. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Draft">
  19702. <summary>
  19703. Gets or sets the draft mode.
  19704. </summary>
  19705. <value>the draft mode.</value>
  19706. </member>
  19707. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Notes">
  19708. <summary>
  19709. Gets or sets the print notes.
  19710. </summary>
  19711. <value>the print notes.</value>
  19712. </member>
  19713. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.NoOrientation">
  19714. <summary>
  19715. Gets or sets a value indicating whether [no orientation].
  19716. </summary>
  19717. <value><c>true</c> if [no orientation]; otherwise, <c>false</c>.</value>
  19718. </member>
  19719. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.UsePage">
  19720. <summary>
  19721. Gets or sets the use page numbers.
  19722. </summary>
  19723. <value>use page numbers. </value>
  19724. </member>
  19725. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.HResolution">
  19726. <summary>
  19727. Gets or sets the horizontal resolution.
  19728. </summary>
  19729. <value>the horizontal resolution.</value>
  19730. </member>
  19731. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.VResolution">
  19732. <summary>
  19733. Gets or sets the vertical resolution.
  19734. </summary>
  19735. <value>the vertical resolution.</value>
  19736. </member>
  19737. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.HeaderMargin">
  19738. <summary>
  19739. Gets or sets the header margin.
  19740. </summary>
  19741. <value>The header margin.</value>
  19742. </member>
  19743. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.FooterMargin">
  19744. <summary>
  19745. Gets or sets the footer margin.
  19746. </summary>
  19747. <value>The footer margin.</value>
  19748. </member>
  19749. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Copies">
  19750. <summary>
  19751. Gets or sets the number of copies.
  19752. </summary>
  19753. <value>the number of copies.</value>
  19754. </member>
  19755. <member name="T:NPOI.HSSF.UserModel.HSSFRichTextString">
  19756. <summary>
  19757. Rich text Unicode string. These strings can have fonts applied to
  19758. arbitary parts of the string.
  19759. @author Glen Stampoultzis (glens at apache.org)
  19760. @author Jason Height (jheight at apache.org)
  19761. </summary>
  19762. </member>
  19763. <member name="F:NPOI.HSSF.UserModel.HSSFRichTextString.NO_FONT">
  19764. Place holder for indicating that NO_FONT has been applied here
  19765. </member>
  19766. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.#ctor">
  19767. <summary>
  19768. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFRichTextString"/> class.
  19769. </summary>
  19770. </member>
  19771. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.#ctor(System.String)">
  19772. <summary>
  19773. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFRichTextString"/> class.
  19774. </summary>
  19775. <param name="str">The string.</param>
  19776. </member>
  19777. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.#ctor(NPOI.HSSF.Model.InternalWorkbook,NPOI.HSSF.Record.LabelSSTRecord)">
  19778. <summary>
  19779. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFRichTextString"/> class.
  19780. </summary>
  19781. <param name="book">The workbook.</param>
  19782. <param name="record">The record.</param>
  19783. </member>
  19784. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.SetWorkbookReferences(NPOI.HSSF.Model.InternalWorkbook,NPOI.HSSF.Record.LabelSSTRecord)">
  19785. <summary>
  19786. This must be called to Setup the internal work book references whenever
  19787. a RichTextString Is Added to a cell
  19788. </summary>
  19789. <param name="book">The workbook.</param>
  19790. <param name="record">The record.</param>
  19791. </member>
  19792. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.CloneStringIfRequired">
  19793. <summary>
  19794. Called whenever the Unicode string Is modified. When it Is modified
  19795. we need to Create a new SST index, so that other LabelSSTRecords will not
  19796. be affected by Changes tat we make to this string.
  19797. </summary>
  19798. <returns></returns>
  19799. </member>
  19800. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.AddToSSTIfRequired">
  19801. <summary>
  19802. Adds to SST if required.
  19803. </summary>
  19804. </member>
  19805. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ApplyFont(System.Int32,System.Int32,System.Int16)">
  19806. <summary>
  19807. Applies a font to the specified Chars of a string.
  19808. </summary>
  19809. <param name="startIndex">The start index to apply the font to (inclusive).</param>
  19810. <param name="endIndex">The end index to apply the font to (exclusive).</param>
  19811. <param name="fontIndex">The font to use.</param>
  19812. </member>
  19813. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ApplyFont(System.Int32,System.Int32,NPOI.SS.UserModel.IFont)">
  19814. <summary>
  19815. Applies a font to the specified Chars of a string.
  19816. </summary>
  19817. <param name="startIndex">The start index to apply the font to (inclusive).</param>
  19818. <param name="endIndex"> The end index to apply to font to (exclusive).</param>
  19819. <param name="font">The index of the font to use.</param>
  19820. </member>
  19821. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ApplyFont(NPOI.SS.UserModel.IFont)">
  19822. <summary>
  19823. Sets the font of the entire string.
  19824. </summary>
  19825. <param name="font">The font to use.</param>
  19826. </member>
  19827. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ClearFormatting">
  19828. <summary>
  19829. Removes any formatting that may have been applied to the string.
  19830. </summary>
  19831. </member>
  19832. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.String">
  19833. <summary>
  19834. Returns the plain string representation.
  19835. </summary>
  19836. <value>The string.</value>
  19837. </member>
  19838. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.RawUnicodeString">
  19839. <summary>
  19840. Returns the raw, probably shared Unicode String.
  19841. Used when tweaking the styles, eg updating font
  19842. positions.
  19843. Changes to this string may well effect
  19844. other RichTextStrings too!
  19845. </summary>
  19846. <value>The raw unicode string.</value>
  19847. </member>
  19848. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.UnicodeString">
  19849. <summary>
  19850. Gets or sets the unicode string.
  19851. </summary>
  19852. <value>The unicode string.</value>
  19853. </member>
  19854. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.Length">
  19855. <summary>
  19856. Gets the number of Chars in the font..
  19857. </summary>
  19858. <value>The length.</value>
  19859. </member>
  19860. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.GetFontAtIndex(System.Int32)">
  19861. <summary>
  19862. Returns the font in use at a particular index.
  19863. </summary>
  19864. <param name="index">The index.</param>
  19865. <returns>The font that's currently being applied at that
  19866. index or null if no font Is being applied or the
  19867. index Is out of range.</returns>
  19868. </member>
  19869. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.NumFormattingRuns">
  19870. <summary>
  19871. Gets the number of formatting runs used. There will always be at
  19872. least one of font NO_FONT.
  19873. </summary>
  19874. <value>The num formatting runs.</value>
  19875. </member>
  19876. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.GetIndexOfFormattingRun(System.Int32)">
  19877. <summary>
  19878. The index within the string to which the specified formatting run applies.
  19879. </summary>
  19880. <param name="index">the index of the formatting run</param>
  19881. <returns>the index within the string.</returns>
  19882. </member>
  19883. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.GetFontOfFormattingRun(System.Int32)">
  19884. <summary>
  19885. Gets the font used in a particular formatting run.
  19886. </summary>
  19887. <param name="index">the index of the formatting run.</param>
  19888. <returns>the font number used.</returns>
  19889. </member>
  19890. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.CompareTo(NPOI.HSSF.UserModel.HSSFRichTextString)">
  19891. <summary>
  19892. Compares one rich text string to another.
  19893. </summary>
  19894. <param name="other">The other rich text string.</param>
  19895. <returns></returns>
  19896. </member>
  19897. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.Equals(System.Object)">
  19898. <summary>
  19899. Equalses the specified o.
  19900. </summary>
  19901. <param name="o">The o.</param>
  19902. <returns></returns>
  19903. </member>
  19904. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ToString">
  19905. <summary>
  19906. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  19907. </summary>
  19908. <returns>
  19909. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  19910. </returns>
  19911. </member>
  19912. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ApplyFont(System.Int16)">
  19913. <summary>
  19914. Applies the specified font to the entire string.
  19915. </summary>
  19916. <param name="fontIndex">Index of the font to apply.</param>
  19917. </member>
  19918. <member name="T:NPOI.HSSF.UserModel.HSSFRow">
  19919. <summary>
  19920. High level representation of a row of a spReadsheet.
  19921. Only rows that have cells should be Added to a Sheet.
  19922. @author Andrew C. Oliver (acoliver at apache dot org)
  19923. @author Glen Stampoultzis (glens at apache.org)
  19924. </summary>
  19925. </member>
  19926. <member name="F:NPOI.HSSF.UserModel.HSSFRow.INITIAL_CAPACITY">
  19927. <summary>
  19928. used for collections
  19929. </summary>
  19930. </member>
  19931. <member name="F:NPOI.HSSF.UserModel.HSSFRow.row">
  19932. reference to low level representation
  19933. </member>
  19934. <member name="F:NPOI.HSSF.UserModel.HSSFRow.book">
  19935. reference to containing low level Workbook
  19936. </member>
  19937. <member name="F:NPOI.HSSF.UserModel.HSSFRow.sheet">
  19938. reference to containing Sheet
  19939. </member>
  19940. <member name="M:NPOI.HSSF.UserModel.HSSFRow.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,System.Int32)">
  19941. <summary>
  19942. Creates new HSSFRow from scratch. Only HSSFSheet should do this.
  19943. </summary>
  19944. <param name="book">low-level Workbook object containing the sheet that Contains this row</param>
  19945. <param name="sheet">low-level Sheet object that Contains this Row</param>
  19946. <param name="rowNum">the row number of this row (0 based)</param>
  19947. <see cref="M:NPOI.HSSF.UserModel.HSSFSheet.CreateRow(System.Int32)"/>
  19948. </member>
  19949. <member name="M:NPOI.HSSF.UserModel.HSSFRow.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.Record.RowRecord)">
  19950. <summary>
  19951. Creates an HSSFRow from a low level RowRecord object. Only HSSFSheet should do
  19952. this. HSSFSheet uses this when an existing file is Read in.
  19953. </summary>
  19954. <param name="book">low-level Workbook object containing the sheet that Contains this row</param>
  19955. <param name="sheet"> low-level Sheet object that Contains this Row</param>
  19956. <param name="record">the low level api object this row should represent</param>
  19957. <see cref="M:NPOI.HSSF.UserModel.HSSFSheet.CreateRow(System.Int32)"/>
  19958. </member>
  19959. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CreateCell(System.Int32)">
  19960. <summary>
  19961. Use this to create new cells within the row and return it.
  19962. The cell that is returned is a CELL_TYPE_BLANK (<see cref="T:NPOI.SS.UserModel.ICell"/>/<see cref="F:NPOI.SS.UserModel.CellType.Blank"/>).
  19963. The type can be changed either through calling <c>SetCellValue</c> or <c>SetCellType</c>.
  19964. </summary>
  19965. <param name="column">the column number this cell represents</param>
  19966. <returns>a high level representation of the created cell.</returns>
  19967. </member>
  19968. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CreateCell(System.Int32,NPOI.SS.UserModel.CellType)">
  19969. <summary>
  19970. Use this to create new cells within the row and return it.
  19971. The cell that is returned is a CELL_TYPE_BLANK. The type can be changed
  19972. either through calling setCellValue or setCellType.
  19973. </summary>
  19974. <param name="columnIndex">the column number this cell represents</param>
  19975. <param name="type">a high level representation of the created cell.</param>
  19976. <returns></returns>
  19977. </member>
  19978. <member name="M:NPOI.HSSF.UserModel.HSSFRow.RemoveCell(NPOI.SS.UserModel.ICell)">
  19979. <summary>
  19980. Remove the Cell from this row.
  19981. </summary>
  19982. <param name="cell">The cell to Remove.</param>
  19983. </member>
  19984. <member name="M:NPOI.HSSF.UserModel.HSSFRow.RemoveCell(NPOI.SS.UserModel.ICell,System.Boolean)">
  19985. <summary>
  19986. Removes the cell.
  19987. </summary>
  19988. <param name="cell">The cell.</param>
  19989. <param name="alsoRemoveRecords">if set to <c>true</c> [also remove records].</param>
  19990. </member>
  19991. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CalculateNewLastCellPlusOne(System.Int32)">
  19992. used internally to refresh the "last cell plus one" when the last cell is removed.
  19993. @return 0 when row contains no cells
  19994. </member>
  19995. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CalculateNewFirstCell(System.Int32)">
  19996. used internally to refresh the "first cell" when the first cell is removed.
  19997. @return 0 when row contains no cells (also when first cell is occupied)
  19998. </member>
  19999. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CreateCellFromRecord(NPOI.HSSF.Record.CellValueRecordInterface)">
  20000. <summary>
  20001. Create a high level Cell object from an existing low level record. Should
  20002. only be called from HSSFSheet or HSSFRow itself.
  20003. </summary>
  20004. <param name="cell">The low level cell to Create the high level representation from</param>
  20005. <returns> the low level record passed in</returns>
  20006. </member>
  20007. <member name="P:NPOI.HSSF.UserModel.HSSFRow.IsHidden">
  20008. <summary>
  20009. true, when the row is invisible. This is the case when the height is zero.
  20010. </summary>
  20011. </member>
  20012. <member name="M:NPOI.HSSF.UserModel.HSSFRow.RemoveAllCells">
  20013. <summary>
  20014. Removes all the cells from the row, and their
  20015. records too.
  20016. </summary>
  20017. </member>
  20018. <member name="P:NPOI.HSSF.UserModel.HSSFRow.RowNum">
  20019. <summary>
  20020. Get row number this row represents
  20021. </summary>
  20022. <value>the row number (0 based)</value>
  20023. </member>
  20024. <member name="P:NPOI.HSSF.UserModel.HSSFRow.OutlineLevel">
  20025. <summary>
  20026. Returns the rows outline level. Increased as you
  20027. put it into more Groups (outlines), reduced as
  20028. you take it out of them.
  20029. </summary>
  20030. <value>The outline level.</value>
  20031. </member>
  20032. <member name="M:NPOI.HSSF.UserModel.HSSFRow.MoveCell(NPOI.SS.UserModel.ICell,System.Int32)">
  20033. <summary>
  20034. Moves the supplied cell to a new column, which
  20035. must not already have a cell there!
  20036. </summary>
  20037. <param name="cell">The cell to move</param>
  20038. <param name="newColumn">The new column number (0 based)</param>
  20039. </member>
  20040. <member name="P:NPOI.HSSF.UserModel.HSSFRow.Sheet">
  20041. Returns the HSSFSheet this row belongs to
  20042. @return the HSSFSheet that owns this row
  20043. </member>
  20044. <member name="M:NPOI.HSSF.UserModel.HSSFRow.AddCell(NPOI.SS.UserModel.ICell)">
  20045. <summary>
  20046. used internally to Add a cell.
  20047. </summary>
  20048. <param name="cell">The cell.</param>
  20049. </member>
  20050. <member name="M:NPOI.HSSF.UserModel.HSSFRow.RetrieveCell(System.Int32)">
  20051. <summary>
  20052. Get the hssfcell representing a given column (logical cell)
  20053. 0-based. If you ask for a cell that is not defined, then
  20054. you Get a null.
  20055. This is the basic call, with no policies applied
  20056. </summary>
  20057. <param name="cellnum">0 based column number</param>
  20058. <returns>Cell representing that column or null if Undefined.</returns>
  20059. </member>
  20060. <member name="M:NPOI.HSSF.UserModel.HSSFRow.GetCell(System.Int32)">
  20061. <summary>
  20062. Get the hssfcell representing a given column (logical cell)
  20063. 0-based. If you ask for a cell that is not defined then
  20064. you get a null, unless you have set a different
  20065. MissingCellPolicy on the base workbook.
  20066. </summary>
  20067. <param name="cellnum">0 based column number</param>
  20068. <returns>Cell representing that column or null if undefined.</returns>
  20069. </member>
  20070. <member name="M:NPOI.HSSF.UserModel.HSSFRow.GetCell(System.Int32,NPOI.SS.UserModel.MissingCellPolicy)">
  20071. <summary>
  20072. Get the hssfcell representing a given column (logical cell)
  20073. 0-based. If you ask for a cell that is not defined, then
  20074. your supplied policy says what to do
  20075. </summary>
  20076. <param name="cellnum">0 based column number</param>
  20077. <param name="policy">Policy on blank / missing cells</param>
  20078. <returns>that column or null if Undefined + policy allows.</returns>
  20079. </member>
  20080. <member name="P:NPOI.HSSF.UserModel.HSSFRow.FirstCellNum">
  20081. <summary>
  20082. Get the number of the first cell contained in this row.
  20083. </summary>
  20084. <value>the first logical cell in the row, or -1 if the row does not contain any cells.</value>
  20085. </member>
  20086. <member name="P:NPOI.HSSF.UserModel.HSSFRow.LastCellNum">
  20087. <summary>
  20088. Gets the index of the last cell contained in this row PLUS ONE
  20089. . The result also happens to be the 1-based column number of the last cell. This value can be used as a
  20090. standard upper bound when iterating over cells:
  20091. </summary>
  20092. <value>
  20093. short representing the last logical cell in the row PLUS ONE, or -1 if the
  20094. row does not contain any cells.
  20095. </value>
  20096. <example>
  20097. short minColIx = row.GetFirstCellNum();
  20098. short maxColIx = row.GetLastCellNum();
  20099. for(short colIx=minColIx; colIx&lt;maxColIx; colIx++) {
  20100. Cell cell = row.GetCell(colIx);
  20101. if(cell == null) {
  20102. continue;
  20103. }
  20104. //... do something with cell
  20105. }
  20106. </example>
  20107. </member>
  20108. <member name="P:NPOI.HSSF.UserModel.HSSFRow.PhysicalNumberOfCells">
  20109. <summary>
  20110. Gets the number of defined cells (NOT number of cells in the actual row!).
  20111. That is to say if only columns 0,4,5 have values then there would be 3.
  20112. </summary>
  20113. <value>the number of defined cells in the row.</value>
  20114. </member>
  20115. <member name="P:NPOI.HSSF.UserModel.HSSFRow.ZeroHeight">
  20116. <summary>
  20117. Gets or sets whether or not to Display this row with 0 height
  20118. </summary>
  20119. <value>height is zero or not.</value>
  20120. </member>
  20121. <member name="P:NPOI.HSSF.UserModel.HSSFRow.Height">
  20122. <summary>
  20123. Get or sets the row's height or ff (-1) for undefined/default-height in twips (1/20th of a point)
  20124. </summary>
  20125. <value>rowheight or 0xff for Undefined (use sheet default)</value>
  20126. </member>
  20127. <member name="P:NPOI.HSSF.UserModel.HSSFRow.IsFormatted">
  20128. <summary>
  20129. is this row formatted? Most aren't, but some rows
  20130. do have whole-row styles. For those that do, you
  20131. can get the formatting from {@link #getRowStyle()}
  20132. </summary>
  20133. <value>
  20134. <c>true</c> if this instance is formatted; otherwise, <c>false</c>.
  20135. </value>
  20136. </member>
  20137. <member name="P:NPOI.HSSF.UserModel.HSSFRow.RowStyle">
  20138. <summary>
  20139. Returns the whole-row cell styles. Most rows won't
  20140. have one of these, so will return null. Call IsFormmated to check first
  20141. </summary>
  20142. <value>The row style.</value>
  20143. </member>
  20144. <member name="P:NPOI.HSSF.UserModel.HSSFRow.HeightInPoints">
  20145. <summary>
  20146. Get the row's height or ff (-1) for Undefined/default-height in points (20*Height)
  20147. </summary>
  20148. <value>row height or 0xff for Undefined (use sheet default).</value>
  20149. </member>
  20150. <member name="P:NPOI.HSSF.UserModel.HSSFRow.RowRecord">
  20151. <summary>
  20152. Get the lowlevel RowRecord represented by this object - should only be called
  20153. by other parts of the high level API
  20154. </summary>
  20155. <value>RowRecord this row represents</value>
  20156. </member>
  20157. <member name="M:NPOI.HSSF.UserModel.HSSFRow.FindFirstCell(System.Int32)">
  20158. <summary>
  20159. used internally to refresh the "first cell" when the first cell is Removed.
  20160. </summary>
  20161. <param name="firstcell">The first cell index.</param>
  20162. <returns></returns>
  20163. </member>
  20164. <member name="P:NPOI.HSSF.UserModel.HSSFRow.Cells">
  20165. <summary>
  20166. Get cells in the row (existing cells only, no blanks)
  20167. </summary>
  20168. </member>
  20169. <member name="M:NPOI.HSSF.UserModel.HSSFRow.GetEnumerator">
  20170. <summary>
  20171. Gets the cell enumerator of the physically defined cells.
  20172. </summary>
  20173. <remarks>
  20174. Note that the 4th element might well not be cell 4, as the iterator
  20175. will not return Un-defined (null) cells.
  20176. Call CellNum on the returned cells to know which cell they are.
  20177. </remarks>
  20178. </member>
  20179. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CompareTo(NPOI.HSSF.UserModel.HSSFRow)">
  20180. <summary>
  20181. Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
  20182. </summary>
  20183. <param name="other">An object to compare with this instance.</param>
  20184. <returns>
  20185. A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings:
  20186. Value
  20187. Meaning
  20188. Less than zero
  20189. This instance is less than <paramref name="other"/>.
  20190. Zero
  20191. This instance is equal to <paramref name="other"/>.
  20192. Greater than zero
  20193. This instance is greater than <paramref name="other"/>.
  20194. </returns>
  20195. <exception cref="T:System.ArgumentException">
  20196. <paramref name="other"/> is not the same type as this instance.
  20197. </exception>
  20198. </member>
  20199. <member name="M:NPOI.HSSF.UserModel.HSSFRow.Equals(System.Object)">
  20200. <summary>
  20201. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
  20202. </summary>
  20203. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
  20204. <returns>
  20205. true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
  20206. </returns>
  20207. <exception cref="T:System.NullReferenceException">
  20208. The <paramref name="obj"/> parameter is null.
  20209. </exception>
  20210. </member>
  20211. <member name="M:NPOI.HSSF.UserModel.HSSFRow.GetHashCode">
  20212. <summary>
  20213. Returns a hash code. In this case it is the number of the row.
  20214. </summary>
  20215. </member>
  20216. <member name="T:NPOI.HSSF.UserModel.HSSFShape">
  20217. <summary>
  20218. An abstract shape.
  20219. Note: Microsoft Excel seems to sometimes disallow
  20220. higher y1 than y2 or higher x1 than x2 in the anchor, you might need to
  20221. reverse them and draw shapes vertically or horizontally flipped!
  20222. </summary>
  20223. </member>
  20224. <member name="M:NPOI.HSSF.UserModel.HSSFShape.#ctor(NPOI.DDF.EscherContainerRecord,NPOI.HSSF.Record.ObjRecord)">
  20225. creates shapes from existing file
  20226. @param spContainer
  20227. @param objRecord
  20228. </member>
  20229. <member name="M:NPOI.HSSF.UserModel.HSSFShape.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  20230. <summary>
  20231. Create a new shape with the specified parent and anchor.
  20232. </summary>
  20233. <param name="parent">The parent.</param>
  20234. <param name="anchor">The anchor.</param>
  20235. </member>
  20236. <member name="P:NPOI.HSSF.UserModel.HSSFShape.Parent">
  20237. <summary>
  20238. Gets the parent shape.
  20239. </summary>
  20240. <value>The parent.</value>
  20241. </member>
  20242. <member name="P:NPOI.HSSF.UserModel.HSSFShape.Anchor">
  20243. <summary>
  20244. Gets or sets the anchor that is used by this shape.
  20245. </summary>
  20246. <value>The anchor.</value>
  20247. </member>
  20248. <member name="P:NPOI.HSSF.UserModel.HSSFShape.LineStyleColor">
  20249. <summary>
  20250. The color applied to the lines of this shape.
  20251. </summary>
  20252. <value>The color of the line style.</value>
  20253. </member>
  20254. <member name="M:NPOI.HSSF.UserModel.HSSFShape.SetLineStyleColor(System.Int32,System.Int32,System.Int32)">
  20255. <summary>
  20256. Sets the color applied to the lines of this shape
  20257. </summary>
  20258. <param name="red">The red.</param>
  20259. <param name="green">The green.</param>
  20260. <param name="blue">The blue.</param>
  20261. </member>
  20262. <member name="P:NPOI.HSSF.UserModel.HSSFShape.FillColor">
  20263. <summary>
  20264. Gets or sets the color used to fill this shape.
  20265. </summary>
  20266. <value>The color of the fill.</value>
  20267. </member>
  20268. <member name="M:NPOI.HSSF.UserModel.HSSFShape.SetFillColor(System.Int32,System.Int32,System.Int32)">
  20269. <summary>
  20270. Sets the color used to fill this shape.
  20271. </summary>
  20272. <param name="red">The red.</param>
  20273. <param name="green">The green.</param>
  20274. <param name="blue">The blue.</param>
  20275. </member>
  20276. <member name="P:NPOI.HSSF.UserModel.HSSFShape.LineWidth">
  20277. <summary>
  20278. Gets or sets with width of the line in EMUs. 12700 = 1 pt.
  20279. </summary>
  20280. <value>The width of the line.</value>
  20281. </member>
  20282. <member name="P:NPOI.HSSF.UserModel.HSSFShape.LineStyle">
  20283. <summary>
  20284. Gets or sets One of the constants in LINESTYLE_*
  20285. </summary>
  20286. <value>The line style.</value>
  20287. </member>
  20288. <member name="P:NPOI.HSSF.UserModel.HSSFShape.IsNoFill">
  20289. <summary>
  20290. Gets or sets a value indicating whether this instance is no fill.
  20291. </summary>
  20292. <value>
  20293. <c>true</c> if this shape Is not filled with a color; otherwise, <c>false</c>.
  20294. </value>
  20295. </member>
  20296. <member name="P:NPOI.HSSF.UserModel.HSSFShape.IsFlipVertical">
  20297. <summary>
  20298. whether this shape is vertically flipped.
  20299. </summary>
  20300. </member>
  20301. <member name="P:NPOI.HSSF.UserModel.HSSFShape.IsFlipHorizontal">
  20302. <summary>
  20303. whether this shape is horizontally flipped.
  20304. </summary>
  20305. </member>
  20306. <member name="P:NPOI.HSSF.UserModel.HSSFShape.RotationDegree">
  20307. <summary>
  20308. get or set the rotation, in degrees, that is applied to a shape.
  20309. Negative values specify rotation in the counterclockwise direction.
  20310. Rotation occurs around the center of the shape.
  20311. The default value for this property is 0x00000000
  20312. </summary>
  20313. </member>
  20314. <member name="P:NPOI.HSSF.UserModel.HSSFShape.CountOfAllChildren">
  20315. <summary>
  20316. Count of all children and their childrens children.
  20317. </summary>
  20318. <value>The count of all children.</value>
  20319. </member>
  20320. <member name="T:NPOI.HSSF.UserModel.HSSFShapeContainer">
  20321. <summary>
  20322. An interface that indicates whether a class can contain children.
  20323. @author Glen Stampoultzis (glens at apache.org)
  20324. </summary>
  20325. </member>
  20326. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.Children">
  20327. <summary>
  20328. Gets Any children contained by this shape.
  20329. </summary>
  20330. <value>The children.</value>
  20331. </member>
  20332. <member name="M:NPOI.HSSF.UserModel.HSSFShapeContainer.AddShape(NPOI.HSSF.UserModel.HSSFShape)">
  20333. <summary>
  20334. dd shape to the list of child records
  20335. </summary>
  20336. <param name="shape">shape</param>
  20337. </member>
  20338. <member name="M:NPOI.HSSF.UserModel.HSSFShapeContainer.SetCoordinates(System.Int32,System.Int32,System.Int32,System.Int32)">
  20339. <summary>
  20340. set coordinates of this group relative to the parent
  20341. </summary>
  20342. <param name="x1">x1</param>
  20343. <param name="y1">y1</param>
  20344. <param name="x2">x2</param>
  20345. <param name="y2">y2</param>
  20346. </member>
  20347. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.X1">
  20348. <summary>
  20349. Get the top left x coordinate of this group.
  20350. </summary>
  20351. </member>
  20352. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.Y1">
  20353. <summary>
  20354. Get the top left y coordinate of this group.
  20355. </summary>
  20356. </member>
  20357. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.X2">
  20358. <summary>
  20359. Get the bottom right x coordinate of this group.
  20360. </summary>
  20361. </member>
  20362. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.Y2">
  20363. <summary>
  20364. Get the bottom right y coordinate of this group.
  20365. </summary>
  20366. </member>
  20367. <member name="M:NPOI.HSSF.UserModel.HSSFShapeContainer.RemoveShape(NPOI.HSSF.UserModel.HSSFShape)">
  20368. remove first level shapes
  20369. @param shape to be removed
  20370. @return true if shape is removed else return false
  20371. </member>
  20372. <member name="T:NPOI.HSSF.UserModel.HSSFShapeFactory">
  20373. @author Evgeniy Berlog
  20374. date: 05.06.12
  20375. </member>
  20376. <member name="M:NPOI.HSSF.UserModel.HSSFShapeFactory.CreateShapeTree(NPOI.DDF.EscherContainerRecord,NPOI.HSSF.Record.EscherAggregate,NPOI.HSSF.UserModel.HSSFShapeContainer,NPOI.POIFS.FileSystem.DirectoryNode)">
  20377. build shape tree from escher container
  20378. @param container root escher container from which escher records must be taken
  20379. @param agg - EscherAggregate
  20380. @param out - shape container to which shapes must be added
  20381. @param root - node to create HSSFObjectData shapes
  20382. </member>
  20383. <member name="T:NPOI.HSSF.UserModel.HSSFShapeGroup">
  20384. <summary>
  20385. A shape Group may contain other shapes. It was no actual form on the
  20386. sheet.
  20387. @author Glen Stampoultzis (glens at apache.org)
  20388. </summary>
  20389. </member>
  20390. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreateGroup(NPOI.HSSF.UserModel.HSSFChildAnchor)">
  20391. <summary>
  20392. Create another Group Under this Group.
  20393. </summary>
  20394. <param name="anchor">the position of the new Group.</param>
  20395. <returns>the Group</returns>
  20396. </member>
  20397. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreateShape(NPOI.HSSF.UserModel.HSSFChildAnchor)">
  20398. <summary>
  20399. Create a new simple shape Under this Group.
  20400. </summary>
  20401. <param name="anchor">the position of the shape.</param>
  20402. <returns>the shape</returns>
  20403. </member>
  20404. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreateTextbox(NPOI.HSSF.UserModel.HSSFChildAnchor)">
  20405. <summary>
  20406. Create a new textbox Under this Group.
  20407. </summary>
  20408. <param name="anchor">the position of the shape.</param>
  20409. <returns>the textbox</returns>
  20410. </member>
  20411. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreatePolygon(NPOI.HSSF.UserModel.HSSFChildAnchor)">
  20412. <summary>
  20413. Creates a polygon
  20414. </summary>
  20415. <param name="anchor">the client anchor describes how this Group Is attached
  20416. to the sheet.</param>
  20417. <returns>the newly Created shape.</returns>
  20418. </member>
  20419. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreatePicture(NPOI.HSSF.UserModel.HSSFChildAnchor,System.Int32)">
  20420. <summary>
  20421. Creates a picture.
  20422. </summary>
  20423. <param name="anchor">the client anchor describes how this Group Is attached
  20424. to the sheet.</param>
  20425. <param name="pictureIndex">Index of the picture.</param>
  20426. <returns>the newly Created shape.</returns>
  20427. </member>
  20428. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.Children">
  20429. <summary>
  20430. Return all children contained by this shape.
  20431. </summary>
  20432. <value></value>
  20433. </member>
  20434. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.SetCoordinates(System.Int32,System.Int32,System.Int32,System.Int32)">
  20435. <summary>
  20436. Sets the coordinate space of this Group. All children are constrained
  20437. to these coordinates.
  20438. </summary>
  20439. <param name="x1">The x1.</param>
  20440. <param name="y1">The y1.</param>
  20441. <param name="x2">The x2.</param>
  20442. <param name="y2">The y2.</param>
  20443. </member>
  20444. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.X1">
  20445. <summary>
  20446. Gets The top left x coordinate of this Group.
  20447. </summary>
  20448. <value>The x1.</value>
  20449. </member>
  20450. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.Y1">
  20451. <summary>
  20452. Gets The top left y coordinate of this Group.
  20453. </summary>
  20454. <value>The y1.</value>
  20455. </member>
  20456. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.X2">
  20457. <summary>
  20458. Gets The bottom right x coordinate of this Group.
  20459. </summary>
  20460. <value>The x2.</value>
  20461. </member>
  20462. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.Y2">
  20463. <summary>
  20464. Gets the bottom right y coordinate of this Group.
  20465. </summary>
  20466. <value>The y2.</value>
  20467. </member>
  20468. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.CountOfAllChildren">
  20469. <summary>
  20470. Count of all children and their childrens children.
  20471. </summary>
  20472. <value></value>
  20473. </member>
  20474. <member name="T:NPOI.HSSF.UserModel.HSSFSheet">
  20475. <summary>
  20476. High level representation of a worksheet.
  20477. </summary>
  20478. <remarks>
  20479. @author Andrew C. Oliver (acoliver at apache dot org)
  20480. @author Glen Stampoultzis (glens at apache.org)
  20481. @author Libin Roman (romal at vistaportal.com)
  20482. @author Shawn Laubach (slaubach at apache dot org) (Just a little)
  20483. @author Jean-Pierre Paris (jean-pierre.paris at m4x dot org) (Just a little, too)
  20484. @author Yegor Kozlov (yegor at apache.org) (Autosizing columns)
  20485. </remarks>
  20486. </member>
  20487. <member name="F:NPOI.HSSF.UserModel.HSSFSheet.PX_DEFAULT">
  20488. width of 1px in columns with default width in units of 1/256 of a character width
  20489. </member>
  20490. <member name="F:NPOI.HSSF.UserModel.HSSFSheet.PX_MODIFIED">
  20491. width of 1px in columns with overridden width in units of 1/256 of a character width
  20492. </member>
  20493. <member name="F:NPOI.HSSF.UserModel.HSSFSheet.INITIAL_CAPACITY">
  20494. Used for compile-time optimization. This is the initial size for the collection of
  20495. rows. It is currently Set to 20. If you generate larger sheets you may benefit
  20496. by Setting this to a higher number and recompiling a custom edition of HSSFSheet.
  20497. </member>
  20498. <member name="F:NPOI.HSSF.UserModel.HSSFSheet._sheet">
  20499. reference to the low level Sheet object
  20500. </member>
  20501. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook)">
  20502. <summary>
  20503. Creates new HSSFSheet - called by HSSFWorkbook to create a _sheet from
  20504. scratch. You should not be calling this from application code (its protected anyhow).
  20505. </summary>
  20506. <param name="workbook">The HSSF Workbook object associated with the _sheet.</param>
  20507. <see cref="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateSheet"/>
  20508. </member>
  20509. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.Model.InternalSheet)">
  20510. <summary>
  20511. Creates an HSSFSheet representing the given Sheet object. Should only be
  20512. called by HSSFWorkbook when reading in an exisiting file.
  20513. </summary>
  20514. <param name="workbook">The HSSF Workbook object associated with the _sheet.</param>
  20515. <param name="sheet">lowlevel Sheet object this _sheet will represent</param>
  20516. <see cref="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.DirectoryNode,System.Boolean)"/>
  20517. </member>
  20518. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CloneSheet(NPOI.HSSF.UserModel.HSSFWorkbook)">
  20519. <summary>
  20520. Clones the _sheet.
  20521. </summary>
  20522. <param name="workbook">The _workbook.</param>
  20523. <returns>the cloned sheet</returns>
  20524. </member>
  20525. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CopyRow(System.Int32,System.Int32)">
  20526. <summary>
  20527. Copy one row to the target row
  20528. </summary>
  20529. <param name="sourceIndex">index of the source row</param>
  20530. <param name="targetIndex">index of the target row</param>
  20531. </member>
  20532. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CopyComment(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.ICell)">
  20533. <summary>
  20534. Copies comment from one cell to another
  20535. </summary>
  20536. <param name="sourceCell">Cell with a comment to copy</param>
  20537. <param name="targetCell">Cell to paste the comment to</param>
  20538. <returns>Copied comment</returns>
  20539. </member>
  20540. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetPropertiesFromSheet(NPOI.HSSF.Model.InternalSheet)">
  20541. <summary>
  20542. used internally to Set the properties given a Sheet object
  20543. </summary>
  20544. <param name="sheet">The _sheet.</param>
  20545. </member>
  20546. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayZeros">
  20547. Gets the flag indicating whether the window should show 0 (zero) in cells containing zero value.
  20548. When false, cells with zero value appear blank instead of showing the number zero.
  20549. In Excel 2003 this option can be changed in the Options dialog on the View tab.
  20550. @return whether all zero values on the worksheet are displayed
  20551. </member>
  20552. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateRow(System.Int32)">
  20553. <summary>
  20554. Create a new row within the _sheet and return the high level representation
  20555. </summary>
  20556. <param name="rownum">The row number.</param>
  20557. <returns></returns>
  20558. @see org.apache.poi.hssf.usermodel.HSSFRow
  20559. @see #RemoveRow(HSSFRow)
  20560. </member>
  20561. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateRowFromRecord(NPOI.HSSF.Record.RowRecord)">
  20562. <summary>
  20563. Used internally to Create a high level Row object from a low level row object.
  20564. USed when Reading an existing file
  20565. </summary>
  20566. <param name="row">low level record to represent as a high level Row and Add to _sheet.</param>
  20567. <returns>HSSFRow high level representation</returns>
  20568. </member>
  20569. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveRow(NPOI.SS.UserModel.IRow)">
  20570. <summary>
  20571. Remove a row from this _sheet. All cells contained in the row are Removed as well
  20572. </summary>
  20573. <param name="row">the row to Remove.</param>
  20574. </member>
  20575. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.FindLastRow(System.Int32)">
  20576. <summary>
  20577. used internally to refresh the "last row" when the last row is Removed.
  20578. </summary>
  20579. <param name="lastrow">The last row.</param>
  20580. <returns></returns>
  20581. </member>
  20582. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.FindFirstRow(System.Int32)">
  20583. <summary>
  20584. used internally to refresh the "first row" when the first row is Removed.
  20585. </summary>
  20586. <param name="firstrow">The first row.</param>
  20587. <returns></returns>
  20588. </member>
  20589. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AddRow(NPOI.HSSF.UserModel.HSSFRow,System.Boolean)">
  20590. Add a row to the _sheet
  20591. @param AddLow whether to Add the row to the low level model - false if its already there
  20592. </member>
  20593. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetColumnStyle(System.Int32)">
  20594. <summary>
  20595. Returns the HSSFCellStyle that applies to the given
  20596. (0 based) column, or null if no style has been
  20597. set for that column
  20598. </summary>
  20599. <param name="column">The column.</param>
  20600. <returns></returns>
  20601. </member>
  20602. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetRow(System.Int32)">
  20603. <summary>
  20604. Returns the logical row (not physical) 0-based. If you ask for a row that is not
  20605. defined you get a null. This is to say row 4 represents the fifth row on a _sheet.
  20606. </summary>
  20607. <param name="rowIndex">Index of the row to get.</param>
  20608. <returns>the row number or null if its not defined on the _sheet</returns>
  20609. </member>
  20610. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.PhysicalNumberOfRows">
  20611. <summary>
  20612. Returns the number of phsyically defined rows (NOT the number of rows in the _sheet)
  20613. </summary>
  20614. <value>The physical number of rows.</value>
  20615. </member>
  20616. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.FirstRowNum">
  20617. <summary>
  20618. Gets the first row on the _sheet
  20619. </summary>
  20620. <value>the number of the first logical row on the _sheet</value>
  20621. </member>
  20622. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.LastRowNum">
  20623. <summary>
  20624. Gets the last row on the _sheet
  20625. </summary>
  20626. <value>last row contained n this _sheet.</value>
  20627. </member>
  20628. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AddValidationData(NPOI.SS.UserModel.IDataValidation)">
  20629. <summary>
  20630. Creates a data validation object
  20631. </summary>
  20632. <param name="dataValidation">The data validation object settings</param>
  20633. </member>
  20634. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetColumnHidden(System.Int32,System.Boolean)">
  20635. <summary>
  20636. Get the visibility state for a given column.F:\Gloria\�о�\�ļ���ʽ\NPOI\src\NPOI\HSSF\Util\HSSFDataValidation.cs
  20637. </summary>
  20638. <param name="column">the column to Get (0-based).</param>
  20639. <param name="hidden">the visiblity state of the column.</param>
  20640. </member>
  20641. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.IsColumnHidden(System.Int32)">
  20642. <summary>
  20643. Get the hidden state for a given column.
  20644. </summary>
  20645. <param name="column">the column to Set (0-based)</param>
  20646. <returns>the visiblity state of the column;
  20647. </returns>
  20648. </member>
  20649. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetColumnWidth(System.Int32,System.Int32)">
  20650. <summary>
  20651. Set the width (in Units of 1/256th of a Char width)
  20652. </summary>
  20653. <param name="column">the column to Set (0-based)</param>
  20654. <param name="width">the width in Units of 1/256th of a Char width</param>
  20655. </member>
  20656. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetColumnWidth(System.Int32)">
  20657. <summary>
  20658. Get the width (in Units of 1/256th of a Char width )
  20659. </summary>
  20660. <param name="column">the column to Set (0-based)</param>
  20661. <returns>the width in Units of 1/256th of a Char width</returns>
  20662. </member>
  20663. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DefaultColumnWidth">
  20664. <summary>
  20665. Gets or sets the default width of the column.
  20666. </summary>
  20667. <value>The default width of the column.</value>
  20668. </member>
  20669. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DefaultRowHeight">
  20670. <summary>
  20671. Get the default row height for the _sheet (if the rows do not define their own height) in
  20672. twips (1/20 of a point)
  20673. </summary>
  20674. <value>The default height of the row.</value>
  20675. </member>
  20676. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DefaultRowHeightInPoints">
  20677. <summary>
  20678. Get the default row height for the _sheet (if the rows do not define their own height) in
  20679. points.
  20680. </summary>
  20681. <value>The default row height in points.</value>
  20682. </member>
  20683. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsGridsPrinted">
  20684. <summary>
  20685. Get whether gridlines are printed.
  20686. </summary>
  20687. <value>
  20688. <c>true</c> if printed; otherwise, <c>false</c>.
  20689. </value>
  20690. </member>
  20691. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AddMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  20692. <summary>
  20693. Adds a merged region of cells on a sheet.
  20694. </summary>
  20695. <param name="region">region to merge</param>
  20696. <returns>index of this region</returns>
  20697. <exception cref="T:System.ArgumentException">if region contains fewer than 2 cells</exception>
  20698. <exception cref="T:System.InvalidOperationException">if region intersects with an existing merged region
  20699. or multi-cell array formula on this sheet</exception>
  20700. </member>
  20701. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AddMergedRegionUnsafe(NPOI.SS.Util.CellRangeAddress)">
  20702. <summary>
  20703. Adds a merged region of cells (hence those cells form one).
  20704. Skips validation. It is possible to create overlapping merged regions
  20705. or create a merged region that intersects a multi-cell array formula
  20706. with this formula, which may result in a corrupt workbook.
  20707. To check for merged regions overlapping array formulas or other merged regions
  20708. after addMergedRegionUnsafe has been called, call {@link #validateMergedRegions()}, which runs in O(n^2) time.
  20709. </summary>
  20710. <param name="region">region to merge</param>
  20711. <returns>index of this region</returns>
  20712. <exception cref="T:System.ArgumentException">if region contains fewer than 2 cells</exception>
  20713. </member>
  20714. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ValidateMergedRegions">
  20715. <summary>
  20716. Verify that merged regions do not intersect multi-cell array formulas and
  20717. no merged regions intersect another merged region in this sheet.
  20718. </summary>
  20719. <exception cref="T:System.InvalidOperationException">if region intersects with an existing merged region
  20720. or multi-cell array formula on this sheet</exception>
  20721. </member>
  20722. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AddMergedRegion(NPOI.SS.Util.CellRangeAddress,System.Boolean)">
  20723. <summary>
  20724. adds a merged region of cells (hence those cells form one)
  20725. </summary>
  20726. <param name="region">region (rowfrom/colfrom-rowto/colto) to merge</param>
  20727. <param name="validate">whether to validate merged region</param>
  20728. <returns>index of this region</returns>
  20729. <exception cref="T:System.ArgumentException">if region contains fewer than 2 cells</exception>
  20730. <exception cref="T:System.InvalidOperationException">if region intersects with an existing merged region
  20731. or multi-cell array formula on this sheet</exception>
  20732. </member>
  20733. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CheckForMergedRegionsIntersectingArrayFormulas">
  20734. <summary>
  20735. Verify that none of the merged regions intersect a multi-cell array formula in this sheet
  20736. </summary>
  20737. <exception cref="!:NPOI.Util.InvalidOperationException">if candidate region intersects an existing array formula in this sheet</exception>
  20738. </member>
  20739. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CheckForIntersectingMergedRegions">
  20740. <summary>
  20741. Verify that no merged regions intersect another merged region in this sheet.
  20742. </summary>
  20743. <exception cref="T:System.InvalidOperationException">if at least one region intersects with another merged region in this sheet</exception>
  20744. </member>
  20745. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.ForceFormulaRecalculation">
  20746. <summary>
  20747. Whether a record must be Inserted or not at generation to indicate that
  20748. formula must be recalculated when _workbook is opened.
  20749. </summary>
  20750. <value>
  20751. <c>true</c> if [force formula recalculation]; otherwise, <c>false</c>.
  20752. </value>
  20753. @return true if an Uncalced record must be Inserted or not at generation
  20754. </member>
  20755. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.VerticallyCenter">
  20756. <summary>
  20757. Determine whether printed output for this _sheet will be vertically centered.
  20758. </summary>
  20759. <value><c>true</c> if [vertically center]; otherwise, <c>false</c>.</value>
  20760. </member>
  20761. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.HorizontallyCenter">
  20762. <summary>
  20763. Determine whether printed output for this _sheet will be horizontally centered.
  20764. </summary>
  20765. <value><c>true</c> if [horizontally center]; otherwise, <c>false</c>.</value>
  20766. </member>
  20767. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveMergedRegion(System.Int32)">
  20768. <summary>
  20769. Removes a merged region of cells (hence letting them free)
  20770. </summary>
  20771. <param name="index">index of the region to Unmerge</param>
  20772. </member>
  20773. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveMergedRegions(System.Collections.Generic.IList{System.Int32})">
  20774. <summary>
  20775. Removes a number of merged regions of cells (hence letting them free)
  20776. </summary>
  20777. <param name="indices">A set of the regions to unmerge</param>
  20778. </member>
  20779. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.NumMergedRegions">
  20780. <summary>
  20781. returns the number of merged regions
  20782. </summary>
  20783. <value>The number of merged regions</value>
  20784. </member>
  20785. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetRowEnumerator">
  20786. <summary>
  20787. Gets the row enumerator.
  20788. </summary>
  20789. <returns>
  20790. an iterator of the PHYSICAL rows. Meaning the 3rd element may not
  20791. be the third row if say for instance the second row is undefined.
  20792. Call <see cref="P:NPOI.SS.UserModel.IRow.RowNum"/> on each row
  20793. if you care which one it is.
  20794. </returns>
  20795. </member>
  20796. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetEnumerator">
  20797. <summary>
  20798. Alias for GetRowEnumerator() to allow <c>foreach</c> loops.
  20799. </summary>
  20800. <returns>
  20801. an iterator of the PHYSICAL rows. Meaning the 3rd element may not
  20802. be the third row if say for instance the second row is undefined.
  20803. Call <see cref="P:NPOI.SS.UserModel.IRow.RowNum"/> on each row
  20804. if you care which one it is.
  20805. </returns>
  20806. </member>
  20807. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Sheet">
  20808. <summary>
  20809. used internally in the API to Get the low level Sheet record represented by this
  20810. Object.
  20811. </summary>
  20812. <value>low level representation of this HSSFSheet.</value>
  20813. </member>
  20814. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetActiveCell(System.Int32,System.Int32)">
  20815. <summary>
  20816. Sets the active cell.
  20817. </summary>
  20818. <param name="row">The row.</param>
  20819. <param name="column">The column.</param>
  20820. </member>
  20821. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetActiveCellRange(System.Int32,System.Int32,System.Int32,System.Int32)">
  20822. <summary>
  20823. Sets the active cell range.
  20824. </summary>
  20825. <param name="firstRow">The first row.</param>
  20826. <param name="lastRow">The last row.</param>
  20827. <param name="firstColumn">The first column.</param>
  20828. <param name="lastColumn">The last column.</param>
  20829. </member>
  20830. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetActiveCellRange(System.Collections.Generic.List{NPOI.SS.Util.CellRangeAddress8Bit},System.Int32,System.Int32,System.Int32)">
  20831. <summary>
  20832. Sets the active cell range.
  20833. </summary>
  20834. <param name="cellranges">The cellranges.</param>
  20835. <param name="activeRange">The index of the active range.</param>
  20836. <param name="activeRow">The active row in the active range</param>
  20837. <param name="activeColumn">The active column in the active range</param>
  20838. </member>
  20839. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.AlternativeExpression">
  20840. <summary>
  20841. Gets or sets whether alternate expression evaluation is on
  20842. </summary>
  20843. <value>
  20844. <c>true</c> if [alternative expression]; otherwise, <c>false</c>.
  20845. </value>
  20846. </member>
  20847. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.AlternativeFormula">
  20848. <summary>
  20849. whether alternative formula entry is on
  20850. </summary>
  20851. <value><c>true</c> alternative formulas or not; otherwise, <c>false</c>.</value>
  20852. </member>
  20853. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Autobreaks">
  20854. <summary>
  20855. show automatic page breaks or not
  20856. </summary>
  20857. <value>whether to show auto page breaks</value>
  20858. </member>
  20859. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Dialog">
  20860. <summary>
  20861. Gets or sets a value indicating whether _sheet is a dialog _sheet
  20862. </summary>
  20863. <value><c>true</c> if is dialog; otherwise, <c>false</c>.</value>
  20864. </member>
  20865. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayGuts">
  20866. <summary>
  20867. Gets or sets a value indicating whether to Display the guts or not.
  20868. </summary>
  20869. <value><c>true</c> if guts or no guts (or glory); otherwise, <c>false</c>.</value>
  20870. </member>
  20871. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.FitToPage">
  20872. <summary>
  20873. Gets or sets a value indicating whether fit to page option is on
  20874. </summary>
  20875. <value><c>true</c> if [fit to page]; otherwise, <c>false</c>.</value>
  20876. </member>
  20877. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.RowSumsBelow">
  20878. <summary>
  20879. Get if row summaries appear below detail in the outline
  20880. </summary>
  20881. <value><c>true</c> if below or not; otherwise, <c>false</c>.</value>
  20882. </member>
  20883. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.RowSumsRight">
  20884. <summary>
  20885. Get if col summaries appear right of the detail in the outline
  20886. </summary>
  20887. <value><c>true</c> right or not; otherwise, <c>false</c>.</value>
  20888. </member>
  20889. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsPrintGridlines">
  20890. <summary>
  20891. Gets or sets whether gridlines are printed.
  20892. </summary>
  20893. <value>
  20894. <c>true</c> Gridlines are printed; otherwise, <c>false</c>.
  20895. </value>
  20896. </member>
  20897. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsPrintRowAndColumnHeadings">
  20898. <summary>
  20899. get or set whether row and column headings are printed.
  20900. </summary>
  20901. <value>row and column headings are printed</value>
  20902. </member>
  20903. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.PrintSetup">
  20904. <summary>
  20905. Gets the print setup object.
  20906. </summary>
  20907. <value>The user model for the print setup object.</value>
  20908. </member>
  20909. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Header">
  20910. <summary>
  20911. Gets the user model for the document header.
  20912. </summary>
  20913. <value>The Document header.</value>
  20914. </member>
  20915. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Footer">
  20916. <summary>
  20917. Gets the user model for the document footer.
  20918. </summary>
  20919. <value>The Document footer.</value>
  20920. </member>
  20921. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsRightToLeft">
  20922. <summary>
  20923. Gets or sets whether the worksheet is displayed from right to left instead of from left to right.
  20924. </summary>
  20925. <value>true for right to left, false otherwise</value>
  20926. <remarks>poi bug 47970</remarks>
  20927. </member>
  20928. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsSelected">
  20929. <summary>
  20930. Note - this is not the same as whether the _sheet is focused (isActive)
  20931. </summary>
  20932. <value>
  20933. <c>true</c> if this _sheet is currently selected; otherwise, <c>false</c>.
  20934. </value>
  20935. </member>
  20936. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsActive">
  20937. <summary>
  20938. Gets or sets a value indicating if this _sheet is currently focused.
  20939. </summary>
  20940. <value><c>true</c> if this _sheet is currently focused; otherwise, <c>false</c>.</value>
  20941. </member>
  20942. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetActive(System.Boolean)">
  20943. <summary>
  20944. Sets whether sheet is selected.
  20945. </summary>
  20946. <param name="sel">Whether to select the sheet or deselect the sheet.</param>
  20947. </member>
  20948. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Protect">
  20949. <summary>
  20950. Answer whether protection is enabled or disabled
  20951. </summary>
  20952. <value><c>true</c> if protection enabled; otherwise, <c>false</c>.</value>
  20953. </member>
  20954. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Password">
  20955. <summary>
  20956. Gets the hashed password
  20957. </summary>
  20958. <value>The password.</value>
  20959. </member>
  20960. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.ObjectProtect">
  20961. <summary>
  20962. Answer whether object protection is enabled or disabled
  20963. </summary>
  20964. <value><c>true</c> if protection enabled; otherwise, <c>false</c>.</value>
  20965. </member>
  20966. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.ScenarioProtect">
  20967. <summary>
  20968. Answer whether scenario protection is enabled or disabled
  20969. </summary>
  20970. <value><c>true</c> if protection enabled; otherwise, <c>false</c>.</value>
  20971. </member>
  20972. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ProtectSheet(System.String)">
  20973. <summary>
  20974. Sets the protection enabled as well as the password
  20975. </summary>
  20976. <param name="password">password to set for protection, pass <code>null</code> to remove protection</param>
  20977. </member>
  20978. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetZoom(System.Int32,System.Int32)">
  20979. <summary>
  20980. Sets the zoom magnication for the _sheet. The zoom is expressed as a
  20981. fraction. For example to express a zoom of 75% use 3 for the numerator
  20982. and 4 for the denominator.
  20983. </summary>
  20984. <param name="numerator">The numerator for the zoom magnification.</param>
  20985. <param name="denominator">The denominator for the zoom magnification.</param>
  20986. </member>
  20987. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetZoom(System.Int32)">
  20988. Window zoom magnification for current view representing percent values.
  20989. Valid values range from 10 to 400. Horizontal &amp; Vertical scale together.
  20990. For example:
  20991. <pre>
  20992. 10 - 10%
  20993. 20 - 20%
  20994. ...
  20995. 100 - 100%
  20996. ...
  20997. 400 - 400%
  20998. </pre>
  20999. @param scale window zoom magnification
  21000. @throws IllegalArgumentException if scale is invalid
  21001. </member>
  21002. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetEnclosedBorderOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  21003. <summary>
  21004. Sets the enclosed border of region.
  21005. </summary>
  21006. <param name="region">The region.</param>
  21007. <param name="borderType">Type of the border.</param>
  21008. <param name="color">The color.</param>
  21009. </member>
  21010. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetBorderRightOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  21011. <summary>
  21012. Sets the right border of region.
  21013. </summary>
  21014. <param name="region">The region.</param>
  21015. <param name="borderType">Type of the border.</param>
  21016. <param name="color">The color.</param>
  21017. </member>
  21018. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetBorderLeftOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  21019. <summary>
  21020. Sets the left border of region.
  21021. </summary>
  21022. <param name="region">The region.</param>
  21023. <param name="borderType">Type of the border.</param>
  21024. <param name="color">The color.</param>
  21025. </member>
  21026. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetBorderTopOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  21027. <summary>
  21028. Sets the top border of region.
  21029. </summary>
  21030. <param name="region">The region.</param>
  21031. <param name="borderType">Type of the border.</param>
  21032. <param name="color">The color.</param>
  21033. </member>
  21034. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetBorderBottomOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  21035. <summary>
  21036. Sets the bottom border of region.
  21037. </summary>
  21038. <param name="region">The region.</param>
  21039. <param name="borderType">Type of the border.</param>
  21040. <param name="color">The color.</param>
  21041. </member>
  21042. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.TopRow">
  21043. <summary>
  21044. The top row in the visible view when the _sheet is
  21045. first viewed after opening it in a viewer
  21046. </summary>
  21047. <value>the rownum (0 based) of the top row</value>
  21048. </member>
  21049. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.LeftCol">
  21050. <summary>
  21051. The left col in the visible view when the _sheet Is
  21052. first viewed after opening it in a viewer
  21053. </summary>
  21054. <value>the rownum (0 based) of the top row</value>
  21055. </member>
  21056. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShowInPane(System.Int32,System.Int32)">
  21057. Sets desktop window pane display area, when the
  21058. file is first opened in a viewer.
  21059. @param toprow the top row to show in desktop window pane
  21060. @param leftcol the left column to show in desktop window pane
  21061. </member>
  21062. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShowInPane(System.Int16,System.Int16)">
  21063. <summary>
  21064. Sets desktop window pane display area, when the
  21065. file is first opened in a viewer.
  21066. </summary>
  21067. <param name="toprow">the top row to show in desktop window pane</param>
  21068. <param name="leftcol">the left column to show in desktop window pane</param>
  21069. </member>
  21070. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShiftMerged(System.Int32,System.Int32,System.Int32,System.Boolean)">
  21071. <summary>
  21072. Shifts the merged regions left or right depending on mode
  21073. TODO: MODE , this is only row specific
  21074. </summary>
  21075. <param name="startRow">The start row.</param>
  21076. <param name="endRow">The end row.</param>
  21077. <param name="n">The n.</param>
  21078. <param name="IsRow">if set to <c>true</c> [is row].</param>
  21079. </member>
  21080. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32)">
  21081. <summary>
  21082. Shifts rows between startRow and endRow n number of rows.
  21083. If you use a negative number, it will Shift rows up.
  21084. Code Ensures that rows don't wrap around.
  21085. Calls ShiftRows(startRow, endRow, n, false, false);
  21086. Additionally Shifts merged regions that are completely defined in these
  21087. rows (ie. merged 2 cells on a row to be Shifted).
  21088. </summary>
  21089. <param name="startRow">the row to start Shifting</param>
  21090. <param name="endRow">the row to end Shifting</param>
  21091. <param name="n">the number of rows to Shift</param>
  21092. </member>
  21093. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean)">
  21094. <summary>
  21095. Shifts rows between startRow and endRow n number of rows.
  21096. If you use a negative number, it will shift rows up.
  21097. Code ensures that rows don't wrap around
  21098. Additionally shifts merged regions that are completely defined in these
  21099. rows (ie. merged 2 cells on a row to be shifted).
  21100. TODO Might want to add bounds checking here
  21101. </summary>
  21102. <param name="startRow">the row to start shifting</param>
  21103. <param name="endRow">the row to end shifting</param>
  21104. <param name="n">the number of rows to shift</param>
  21105. <param name="copyRowHeight">whether to copy the row height during the shift</param>
  21106. <param name="resetOriginalRowHeight">whether to set the original row's height to the default</param>
  21107. </member>
  21108. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean,System.Boolean)">
  21109. <summary>
  21110. Shifts rows between startRow and endRow n number of rows.
  21111. If you use a negative number, it will Shift rows up.
  21112. Code Ensures that rows don't wrap around
  21113. Additionally Shifts merged regions that are completely defined in these
  21114. rows (ie. merged 2 cells on a row to be Shifted).
  21115. TODO Might want to Add bounds Checking here
  21116. </summary>
  21117. <param name="startRow">the row to start Shifting</param>
  21118. <param name="endRow">the row to end Shifting</param>
  21119. <param name="n">the number of rows to Shift</param>
  21120. <param name="copyRowHeight">whether to copy the row height during the Shift</param>
  21121. <param name="resetOriginalRowHeight">whether to Set the original row's height to the default</param>
  21122. <param name="moveComments">if set to <c>true</c> [move comments].</param>
  21123. </member>
  21124. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.InsertChartRecords(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  21125. <summary>
  21126. Inserts the chart records.
  21127. </summary>
  21128. <param name="records">The records.</param>
  21129. </member>
  21130. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateFreezePane(System.Int32,System.Int32,System.Int32,System.Int32)">
  21131. <summary>
  21132. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  21133. </summary>
  21134. <param name="colSplit">Horizonatal position of split.</param>
  21135. <param name="rowSplit">Vertical position of split.</param>
  21136. <param name="leftmostColumn">Top row visible in bottom pane</param>
  21137. <param name="topRow">Left column visible in right pane.</param>
  21138. </member>
  21139. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateFreezePane(System.Int32,System.Int32)">
  21140. <summary>
  21141. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  21142. </summary>
  21143. <param name="colSplit">Horizonatal position of split.</param>
  21144. <param name="rowSplit">Vertical position of split.</param>
  21145. </member>
  21146. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateSplitPane(System.Int32,System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.PanePosition)">
  21147. <summary>
  21148. Creates a split pane. Any existing freezepane or split pane is overwritten.
  21149. </summary>
  21150. <param name="xSplitPos">Horizonatal position of split (in 1/20th of a point).</param>
  21151. <param name="ySplitPos">Vertical position of split (in 1/20th of a point).</param>
  21152. <param name="leftmostColumn">Left column visible in right pane.</param>
  21153. <param name="topRow">Top row visible in bottom pane.</param>
  21154. <param name="activePane">Active pane. One of: PANE_LOWER_RIGHT,PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT</param>
  21155. </member>
  21156. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.PaneInformation">
  21157. <summary>
  21158. Returns the information regarding the currently configured pane (split or freeze).
  21159. </summary>
  21160. <value>null if no pane configured, or the pane information.</value>
  21161. </member>
  21162. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayGridlines">
  21163. <summary>
  21164. Gets or sets if gridlines are Displayed.
  21165. </summary>
  21166. <value>whether gridlines are Displayed</value>
  21167. </member>
  21168. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayFormulas">
  21169. <summary>
  21170. Gets or sets a value indicating whether formulas are displayed.
  21171. </summary>
  21172. <value>whether formulas are Displayed</value>
  21173. </member>
  21174. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayRowColHeadings">
  21175. <summary>
  21176. Gets or sets a value indicating whether RowColHeadings are displayed.
  21177. </summary>
  21178. <value>
  21179. whether RowColHeadings are displayed
  21180. </value>
  21181. </member>
  21182. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetMargin(NPOI.SS.UserModel.MarginType)">
  21183. <summary>
  21184. Gets the size of the margin in inches.
  21185. </summary>
  21186. <param name="margin">which margin to get.</param>
  21187. <returns>the size of the margin</returns>
  21188. </member>
  21189. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetMargin(NPOI.SS.UserModel.MarginType,System.Double)">
  21190. <summary>
  21191. Sets the size of the margin in inches.
  21192. </summary>
  21193. <param name="margin">which margin to get.</param>
  21194. <param name="size">the size of the margin</param>
  21195. </member>
  21196. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetRowBreak(System.Int32)">
  21197. <summary>
  21198. Sets a page break at the indicated row
  21199. </summary>
  21200. <param name="row">The row.</param>
  21201. </member>
  21202. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.IsRowBroken(System.Int32)">
  21203. <summary>
  21204. Determines if there is a page break at the indicated row
  21205. </summary>
  21206. <param name="row">The row.</param>
  21207. <returns>
  21208. <c>true</c> if [is row broken] [the specified row]; otherwise, <c>false</c>.
  21209. </returns>
  21210. </member>
  21211. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveRowBreak(System.Int32)">
  21212. <summary>
  21213. Removes the page break at the indicated row
  21214. </summary>
  21215. <param name="row">The row.</param>
  21216. </member>
  21217. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.RowBreaks">
  21218. <summary>
  21219. Retrieves all the horizontal page breaks
  21220. </summary>
  21221. <value>all the horizontal page breaks, or null if there are no row page breaks</value>
  21222. </member>
  21223. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.ColumnBreaks">
  21224. <summary>
  21225. Retrieves all the vertical page breaks
  21226. </summary>
  21227. <value>all the vertical page breaks, or null if there are no column page breaks</value>
  21228. </member>
  21229. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetColumnBreak(System.Int32)">
  21230. <summary>
  21231. Sets a page break at the indicated column
  21232. </summary>
  21233. <param name="column">The column.</param>
  21234. </member>
  21235. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.IsColumnBroken(System.Int32)">
  21236. <summary>
  21237. Determines if there is a page break at the indicated column
  21238. </summary>
  21239. <param name="column">The column.</param>
  21240. <returns>
  21241. <c>true</c> if [is column broken] [the specified column]; otherwise, <c>false</c>.
  21242. </returns>
  21243. </member>
  21244. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveColumnBreak(System.Int32)">
  21245. <summary>
  21246. Removes a page break at the indicated column
  21247. </summary>
  21248. <param name="column">The column.</param>
  21249. </member>
  21250. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ValidateRow(System.Int32)">
  21251. <summary>
  21252. Runs a bounds Check for row numbers
  21253. </summary>
  21254. <param name="row">The row.</param>
  21255. </member>
  21256. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ValidateColumn(System.Int32)">
  21257. <summary>
  21258. Runs a bounds Check for column numbers
  21259. </summary>
  21260. <param name="column">The column.</param>
  21261. </member>
  21262. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.DumpDrawingRecords(System.Boolean)">
  21263. <summary>
  21264. Aggregates the drawing records and dumps the escher record hierarchy
  21265. to the standard output.
  21266. </summary>
  21267. <param name="fat">if set to <c>true</c> [fat].</param>
  21268. </member>
  21269. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DrawingEscherAggregate">
  21270. <summary>
  21271. Returns the agregate escher records for this _sheet,
  21272. it there is one.
  21273. WARNING - calling this will trigger a parsing of the
  21274. associated escher records. Any that aren't supported
  21275. (such as charts and complex drawing types) will almost
  21276. certainly be lost or corrupted when written out.
  21277. </summary>
  21278. <value>The drawing escher aggregate.</value>
  21279. </member>
  21280. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DrawingPatriarch">
  21281. This will hold any graphics or charts for the sheet.
  21282. @return the top-level drawing patriarch, if there is one, else returns null
  21283. </member>
  21284. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateDrawingPatriarch">
  21285. Creates the top-level drawing patriarch. This will have
  21286. the effect of removing any existing drawings on this
  21287. sheet.
  21288. This may then be used to add graphics or charts
  21289. @return The new patriarch.
  21290. </member>
  21291. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.TabColorIndex">
  21292. <summary>
  21293. Gets or sets the tab color of the _sheet
  21294. </summary>
  21295. </member>
  21296. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsAutoTabColor">
  21297. <summary>
  21298. Gets or sets whether the tab color of _sheet is automatic
  21299. </summary>
  21300. </member>
  21301. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetColumnGroupCollapsed(System.Int32,System.Boolean)">
  21302. <summary>
  21303. Expands or collapses a column Group.
  21304. </summary>
  21305. <param name="columnNumber">One of the columns in the Group.</param>
  21306. <param name="collapsed">true = collapse Group, false = expand Group.</param>
  21307. </member>
  21308. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GroupColumn(System.Int32,System.Int32)">
  21309. <summary>
  21310. Create an outline for the provided column range.
  21311. </summary>
  21312. <param name="fromColumn">beginning of the column range.</param>
  21313. <param name="toColumn">end of the column range.</param>
  21314. </member>
  21315. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.UngroupColumn(System.Int32,System.Int32)">
  21316. <summary>
  21317. Ungroups the column.
  21318. </summary>
  21319. <param name="fromColumn">From column.</param>
  21320. <param name="toColumn">To column.</param>
  21321. </member>
  21322. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GroupRow(System.Int32,System.Int32)">
  21323. <summary>
  21324. Groups the row.
  21325. </summary>
  21326. <param name="fromRow">From row.</param>
  21327. <param name="toRow">To row.</param>
  21328. </member>
  21329. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveArrayFormula(NPOI.SS.UserModel.ICell)">
  21330. <summary>
  21331. Remove a Array Formula from this sheet. All cells contained in the Array Formula range are removed as well
  21332. </summary>
  21333. <param name="cell">any cell within Array Formula range</param>
  21334. <returns>the <see cref="T:NPOI.SS.UserModel.ICellRange`1"/> of cells affected by this change</returns>
  21335. </member>
  21336. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetCellRange(NPOI.SS.Util.CellRangeAddress)">
  21337. <summary>
  21338. Also creates cells if they don't exist.
  21339. </summary>
  21340. </member>
  21341. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetArrayFormula(System.String,NPOI.SS.Util.CellRangeAddress)">
  21342. <summary>
  21343. Sets array formula to specified region for result.
  21344. </summary>
  21345. <param name="formula">text representation of the formula</param>
  21346. <param name="range">Region of array formula for result</param>
  21347. <returns>the <see cref="T:NPOI.SS.UserModel.ICellRange`1"/> of cells affected by this change</returns>
  21348. </member>
  21349. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.UngroupRow(System.Int32,System.Int32)">
  21350. <summary>
  21351. Ungroups the row.
  21352. </summary>
  21353. <param name="fromRow">From row.</param>
  21354. <param name="toRow">To row.</param>
  21355. </member>
  21356. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetRowGroupCollapsed(System.Int32,System.Boolean)">
  21357. <summary>
  21358. Sets the row group collapsed.
  21359. </summary>
  21360. <param name="row">The row.</param>
  21361. <param name="collapse">if set to <c>true</c> [collapse].</param>
  21362. </member>
  21363. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetDefaultColumnStyle(System.Int32,NPOI.SS.UserModel.ICellStyle)">
  21364. <summary>
  21365. Sets the default column style for a given column. POI will only apply this style to new cells Added to the _sheet.
  21366. </summary>
  21367. <param name="column">the column index</param>
  21368. <param name="style">the style to set</param>
  21369. </member>
  21370. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AutoSizeColumn(System.Int32)">
  21371. <summary>
  21372. Adjusts the column width to fit the contents.
  21373. This Process can be relatively slow on large sheets, so this should
  21374. normally only be called once per column, at the end of your
  21375. Processing.
  21376. </summary>
  21377. <param name="column">the column index.</param>
  21378. </member>
  21379. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AutoSizeColumn(System.Int32,System.Boolean)">
  21380. <summary>
  21381. Adjusts the column width to fit the contents.
  21382. This Process can be relatively slow on large sheets, so this should
  21383. normally only be called once per column, at the end of your
  21384. Processing.
  21385. You can specify whether the content of merged cells should be considered or ignored.
  21386. Default is to ignore merged cells.
  21387. </summary>
  21388. <param name="column">the column index</param>
  21389. <param name="useMergedCells">whether to use the contents of merged cells when calculating the width of the column</param>
  21390. </member>
  21391. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AutoSizeRow(System.Int32)">
  21392. Adjusts the row height to fit the contents.
  21393. This process can be relatively slow on large sheets, so this should
  21394. normally only be called once per row, at the end of your
  21395. Processing.
  21396. @param row the row index
  21397. </member>
  21398. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AutoSizeRow(System.Int32,System.Boolean)">
  21399. Adjusts the row height to fit the contents.
  21400. <p>
  21401. This process can be relatively slow on large sheets, so this should
  21402. normally only be called once per row, at the end of your
  21403. Processing.
  21404. </p>
  21405. You can specify whether the content of merged cells should be considered or ignored.
  21406. Default is to ignore merged cells.
  21407. @param row the row index
  21408. @param useMergedCells whether to use the contents of merged cells when calculating the height of the row
  21409. </member>
  21410. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.IsMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  21411. <summary>
  21412. Checks if the provided region is part of the merged regions.
  21413. </summary>
  21414. <param name="mergedRegion">Region searched in the merged regions</param>
  21415. <returns><c>true</c>, when the region is contained in at least one of the merged regions</returns>
  21416. </member>
  21417. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetMergedRegion(System.Int32)">
  21418. <summary>
  21419. Gets the merged region at the specified index
  21420. </summary>
  21421. <param name="index">The index.</param>
  21422. <returns></returns>
  21423. </member>
  21424. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.MergedRegions">
  21425. <summary>
  21426. get the list of merged regions
  21427. </summary>
  21428. <returns>return the list of merged regions</returns>
  21429. </member>
  21430. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.HSSFFont2Font(NPOI.HSSF.UserModel.HSSFFont)">
  21431. <summary>
  21432. Convert HSSFFont to Font.
  21433. </summary>
  21434. <param name="font1">The font.</param>
  21435. <returns></returns>
  21436. </member>
  21437. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetCellComment(System.Int32,System.Int32)">
  21438. <summary>
  21439. Returns cell comment for the specified row and column
  21440. </summary>
  21441. <param name="row">The row.</param>
  21442. <param name="column">The column.</param>
  21443. <returns>cell comment or null if not found</returns>
  21444. </member>
  21445. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetCellComment(NPOI.SS.Util.CellAddress)">
  21446. <summary>
  21447. Returns cell comment for the specified row and column
  21448. </summary>
  21449. <param name="ref1">cell location</param>
  21450. <returns>return cell comment or null if not found</returns>
  21451. </member>
  21452. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetHyperlink(System.Int32,System.Int32)">
  21453. <summary>
  21454. Get a Hyperlink in this sheet anchored at row, column
  21455. </summary>
  21456. <param name="row">The index of the row of the hyperlink, zero-based</param>
  21457. <param name="column">the index of the column of the hyperlink, zero-based</param>
  21458. <returns>return hyperlink if there is a hyperlink anchored at row, column; otherwise returns null</returns>
  21459. </member>
  21460. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetHyperlink(NPOI.SS.Util.CellAddress)">
  21461. <summary>
  21462. Get a Hyperlink in this sheet located in a cell specified by {code addr}
  21463. </summary>
  21464. <param name="addr">The address of the cell containing the hyperlink</param>
  21465. <returns>return hyperlink if there is a hyperlink anchored at {@code addr}; otherwise returns {@code null}</returns>
  21466. </member>
  21467. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetHyperlinkList">
  21468. Get a list of Hyperlinks in this sheet
  21469. @return Hyperlinks for the sheet
  21470. </member>
  21471. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveHyperlink(NPOI.HSSF.UserModel.HSSFHyperlink)">
  21472. Remove the underlying HyperlinkRecord from this sheet.
  21473. If multiple HSSFHyperlinks refer to the same HyperlinkRecord, all HSSFHyperlinks will be removed.
  21474. @param link the HSSFHyperlink wrapper around the HyperlinkRecord to remove
  21475. </member>
  21476. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveHyperlink(NPOI.HSSF.Record.HyperlinkRecord)">
  21477. Remove the underlying HyperlinkRecord from this sheet
  21478. @param link the underlying HyperlinkRecord to remove from this sheet
  21479. </member>
  21480. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.SheetConditionalFormatting">
  21481. <summary>
  21482. Gets the sheet conditional formatting.
  21483. </summary>
  21484. <value>The sheet conditional formatting.</value>
  21485. </member>
  21486. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DVRecords">
  21487. <summary>
  21488. Get the DVRecords objects that are associated to this _sheet
  21489. </summary>
  21490. <value>a list of DVRecord instances</value>
  21491. </member>
  21492. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Workbook">
  21493. <summary>
  21494. Provide a reference to the parent workbook.
  21495. </summary>
  21496. </member>
  21497. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.SheetName">
  21498. <summary>
  21499. Returns the name of this _sheet
  21500. </summary>
  21501. </member>
  21502. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetDataValidationHelper">
  21503. <summary>
  21504. Create an instance of a DataValidationHelper.
  21505. </summary>
  21506. <returns>Instance of a DataValidationHelper</returns>
  21507. </member>
  21508. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetAutoFilter(NPOI.SS.Util.CellRangeAddress)">
  21509. <summary>
  21510. Enable filtering for a range of cells
  21511. </summary>
  21512. <param name="range">the range of cells to filter</param>
  21513. </member>
  21514. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetCellComments">
  21515. <summary>
  21516. Returns all cell comments on this sheet.
  21517. </summary>
  21518. <returns>return A Dictionary of each Comment in the sheet, keyed on the cell address where the comment is located.</returns>
  21519. </member>
  21520. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.FindCellCommentLocations(NPOI.HSSF.UserModel.HSSFShapeContainer,System.Collections.Generic.Dictionary{NPOI.SS.Util.CellAddress,NPOI.SS.UserModel.IComment})">
  21521. Finds all cell comments in this sheet and adds them to the specified locations map
  21522. @param container a container that may contain HSSFComments
  21523. @param locations the map to store the HSSFComments in
  21524. </member>
  21525. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetColumnOutlineLevel(System.Int32)">
  21526. <summary>
  21527. Returns the column outline level. Increased as you
  21528. put it into more groups (outlines), reduced as
  21529. you take it out of them.
  21530. </summary>
  21531. <param name="columnIndex"></param>
  21532. <returns></returns>
  21533. </member>
  21534. <member name="T:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting">
  21535. <summary>
  21536. The Conditional Formatting facet of HSSFSheet
  21537. @author Dmitriy Kumshayev
  21538. </summary>
  21539. </member>
  21540. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.ComparisonOperator,System.String,System.String)">
  21541. <summary>
  21542. A factory method allowing to Create a conditional formatting rule
  21543. with a cell comparison operator
  21544. TODO - formulas containing cell references are currently not Parsed properly
  21545. </summary>
  21546. <param name="comparisonOperation">a constant value from HSSFConditionalFormattingRule.ComparisonOperator</param>
  21547. <param name="formula1">formula for the valued, Compared with the cell</param>
  21548. <param name="formula2">second formula (only used with HSSFConditionalFormattingRule#COMPARISON_OPERATOR_BETWEEN
  21549. and HSSFConditionalFormattingRule#COMPARISON_OPERATOR_NOT_BETWEEN operations)</param>
  21550. <returns></returns>
  21551. </member>
  21552. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.CreateConditionalFormattingRule(System.String)">
  21553. <summary>
  21554. A factory method allowing to Create a conditional formatting rule with a formula.
  21555. The formatting rules are applied by Excel when the value of the formula not equal to 0.
  21556. TODO - formulas containing cell references are currently not Parsed properly
  21557. </summary>
  21558. <param name="formula">formula for the valued, Compared with the cell</param>
  21559. <returns></returns>
  21560. </member>
  21561. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.IconSet)">
  21562. A factory method allowing the creation of conditional formatting
  21563. rules using an Icon Set / Multi-State formatting.
  21564. The thresholds for it will be created, but will be empty
  21565. and require configuring with
  21566. {@link HSSFConditionalFormattingRule#getMultiStateFormatting()}
  21567. then
  21568. {@link HSSFIconMultiStateFormatting#getThresholds()}
  21569. </member>
  21570. <!-- Badly formed XML comment ignored for member "M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.HSSF.UserModel.HSSFExtendedColor)" -->
  21571. <!-- Badly formed XML comment ignored for member "M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.CreateConditionalFormattingColorScaleRule" -->
  21572. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.HSSF.UserModel.HSSFConditionalFormatting)">
  21573. <summary>
  21574. Adds a copy of HSSFConditionalFormatting object to the sheet
  21575. This method could be used to copy HSSFConditionalFormatting object
  21576. from one sheet to another.
  21577. </summary>
  21578. <param name="cf">HSSFConditionalFormatting object</param>
  21579. <returns>index of the new Conditional Formatting object</returns>
  21580. <example>
  21581. HSSFConditionalFormatting cf = sheet.GetConditionalFormattingAt(index);
  21582. newSheet.AddConditionalFormatting(cf);
  21583. </example>
  21584. </member>
  21585. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule[])">
  21586. <summary>
  21587. Allows to Add a new Conditional Formatting Set to the sheet.
  21588. </summary>
  21589. <param name="regions">list of rectangular regions to apply conditional formatting rules</param>
  21590. <param name="cfRules">Set of up to three conditional formatting rules</param>
  21591. <returns>index of the newly Created Conditional Formatting object</returns>
  21592. </member>
  21593. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule)">
  21594. <summary>
  21595. Adds the conditional formatting.
  21596. </summary>
  21597. <param name="regions">The regions.</param>
  21598. <param name="rule1">The rule1.</param>
  21599. <returns></returns>
  21600. </member>
  21601. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule,NPOI.SS.UserModel.IConditionalFormattingRule)">
  21602. <summary>
  21603. Adds the conditional formatting.
  21604. </summary>
  21605. <param name="regions">The regions.</param>
  21606. <param name="rule1">The rule1.</param>
  21607. <param name="rule2">The rule2.</param>
  21608. <returns></returns>
  21609. </member>
  21610. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.GetConditionalFormattingAt(System.Int32)">
  21611. <summary>
  21612. Gets Conditional Formatting object at a particular index
  21613. @param index
  21614. of the Conditional Formatting object to fetch
  21615. </summary>
  21616. <param name="index">Conditional Formatting object</param>
  21617. <returns></returns>
  21618. </member>
  21619. <member name="P:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.NumConditionalFormattings">
  21620. <summary>
  21621. the number of Conditional Formatting objects of the sheet
  21622. </summary>
  21623. <value>The num conditional formattings.</value>
  21624. </member>
  21625. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.RemoveConditionalFormatting(System.Int32)">
  21626. <summary>
  21627. Removes a Conditional Formatting object by index
  21628. </summary>
  21629. <param name="index">index of a Conditional Formatting object to Remove</param>
  21630. </member>
  21631. <member name="T:NPOI.HSSF.UserModel.HSSFSimpleShape">
  21632. <summary>
  21633. Represents a simple shape such as a line, rectangle or oval.
  21634. @author Glen Stampoultzis (glens at apache.org)
  21635. </summary>
  21636. </member>
  21637. <member name="M:NPOI.HSSF.UserModel.HSSFSimpleShape.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  21638. <summary>
  21639. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFSimpleShape"/> class.
  21640. </summary>
  21641. <param name="parent">The parent.</param>
  21642. <param name="anchor">The anchor.</param>
  21643. </member>
  21644. <member name="P:NPOI.HSSF.UserModel.HSSFSimpleShape.ShapeType">
  21645. <summary>
  21646. Gets the shape type.
  21647. </summary>
  21648. <value>One of the OBJECT_TYPE_* constants.</value>
  21649. @see #OBJECT_TYPE_LINE
  21650. @see #OBJECT_TYPE_OVAL
  21651. @see #OBJECT_TYPE_RECTANGLE
  21652. @see #OBJECT_TYPE_PICTURE
  21653. @see #OBJECT_TYPE_COMMENT
  21654. </member>
  21655. <member name="P:NPOI.HSSF.UserModel.HSSFSimpleShape.String">
  21656. <summary>
  21657. Get or set the rich text string used by this object.
  21658. </summary>
  21659. </member>
  21660. <member name="T:NPOI.HSSF.UserModel.HSSFTextbox">
  21661. <summary>
  21662. A textbox Is a shape that may hold a rich text string.
  21663. @author Glen Stampoultzis (glens at apache.org)
  21664. </summary>
  21665. </member>
  21666. <member name="M:NPOI.HSSF.UserModel.HSSFTextbox.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  21667. <summary>
  21668. Construct a new textbox with the given parent and anchor.
  21669. </summary>
  21670. <param name="parent">The parent.</param>
  21671. <param name="anchor">One of HSSFClientAnchor or HSSFChildAnchor</param>
  21672. </member>
  21673. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.MarginLeft">
  21674. <summary>
  21675. Gets or sets the left margin within the textbox.
  21676. </summary>
  21677. <value>The margin left.</value>
  21678. </member>
  21679. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.MarginRight">
  21680. <summary>
  21681. Gets or sets the right margin within the textbox.
  21682. </summary>
  21683. <value>The margin right.</value>
  21684. </member>
  21685. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.MarginTop">
  21686. <summary>
  21687. Gets or sets the top margin within the textbox
  21688. </summary>
  21689. <value>The top margin.</value>
  21690. </member>
  21691. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.MarginBottom">
  21692. <summary>
  21693. Gets or sets the bottom margin within the textbox.
  21694. </summary>
  21695. <value>The margin bottom.</value>
  21696. </member>
  21697. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.HorizontalAlignment">
  21698. <summary>
  21699. Gets or sets the horizontal alignment.
  21700. </summary>
  21701. <value>The horizontal alignment.</value>
  21702. </member>
  21703. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.VerticalAlignment">
  21704. <summary>
  21705. Gets or sets the vertical alignment.
  21706. </summary>
  21707. <value>The vertical alignment.</value>
  21708. </member>
  21709. <member name="T:NPOI.HSSF.UserModel.HSSFWorkbook">
  21710. <summary>
  21711. High level representation of a workbook. This is the first object most users
  21712. will construct whether they are reading or writing a workbook. It is also the
  21713. top level object for creating new sheets/etc.
  21714. </summary>
  21715. @author Andrew C. Oliver (acoliver at apache dot org)
  21716. @author Glen Stampoultzis (glens at apache.org)
  21717. @author Shawn Laubach (slaubach at apache dot org)
  21718. </member>
  21719. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.MAX_STYLES">
  21720. The maximum number of cell styles in a .xls workbook.
  21721. The 'official' limit is 4,000, but POI allows a slightly larger number.
  21722. This extra delta takes into account built-in styles that are automatically
  21723. created for new workbooks
  21724. See http://office.microsoft.com/en-us/excel-help/excel-specifications-and-limits-HP005199291.aspx
  21725. </member>
  21726. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.INITIAL_CAPACITY">
  21727. used for compile-time performance/memory optimization. This determines the
  21728. initial capacity for the sheet collection. Its currently Set to 3.
  21729. Changing it in this release will decrease performance
  21730. since you're never allowed to have more or less than three sheets!
  21731. </member>
  21732. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.workbook">
  21733. this Is the reference to the low level Workbook object
  21734. </member>
  21735. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook._sheets">
  21736. this holds the HSSFSheet objects attached to this workbook
  21737. </member>
  21738. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.names">
  21739. this holds the HSSFName objects attached to this workbook
  21740. </member>
  21741. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.preserveNodes">
  21742. holds whether or not to preserve other nodes in the POIFS. Used
  21743. for macros and embedded objects.
  21744. </member>
  21745. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.formatter">
  21746. Used to keep track of the data formatter so that all
  21747. CreateDataFormatter calls return the same one for a given
  21748. book. This Ensures that updates from one places Is visible
  21749. someplace else.
  21750. </member>
  21751. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.fonts">
  21752. this holds the HSSFFont objects attached to this workbook.
  21753. We only create these from the low level records as required.
  21754. </member>
  21755. <member name="T:NPOI.HSSF.UserModel.HSSFWorkbook.SheetRecordCollector">
  21756. <summary>
  21757. Totals the sizes of all sheet records and eventually serializes them
  21758. </summary>
  21759. </member>
  21760. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor">
  21761. <summary>
  21762. Creates new HSSFWorkbook from scratch (start here!)
  21763. </summary>
  21764. </member>
  21765. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  21766. Companion to HSSFWorkbook(POIFSFileSystem), this constructs the
  21767. POI filesystem around your inputstream, including all nodes.
  21768. This calls {@link #HSSFWorkbook(InputStream, boolean)} with
  21769. preserve nodes set to true.
  21770. @see #HSSFWorkbook(InputStream, boolean)
  21771. @see #HSSFWorkbook(POIFSFileSystem)
  21772. @see org.apache.poi.poifs.filesystem.POIFSFileSystem
  21773. @exception IOException if the stream cannot be read
  21774. </member>
  21775. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  21776. Given a POI POIFSFileSystem object, read in its Workbook along
  21777. with all related nodes, and populate the high and low level models.
  21778. This calls {@link #HSSFWorkbook(POIFSFileSystem, boolean)} with
  21779. preserve nodes set to true.
  21780. @see #HSSFWorkbook(POIFSFileSystem, boolean)
  21781. @see org.apache.poi.poifs.filesystem.POIFSFileSystem
  21782. @exception IOException if the stream cannot be read
  21783. </member>
  21784. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.POIFSFileSystem,System.Boolean)">
  21785. <summary>
  21786. given a POI POIFSFileSystem object, Read in its Workbook and populate the high and
  21787. low level models. If you're Reading in a workbook...start here.
  21788. </summary>
  21789. <param name="fs">the POI filesystem that Contains the Workbook stream.</param>
  21790. <param name="preserveNodes">whether to preseve other nodes, such as
  21791. macros. This takes more memory, so only say yes if you
  21792. need to. If Set, will store all of the POIFSFileSystem
  21793. in memory</param>
  21794. </member>
  21795. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.DirectoryNode,NPOI.POIFS.FileSystem.POIFSFileSystem,System.Boolean)">
  21796. <summary>
  21797. given a POI POIFSFileSystem object, and a specific directory
  21798. within it, Read in its Workbook and populate the high and
  21799. low level models. If you're Reading in a workbook...start here.
  21800. </summary>
  21801. <param name="directory">the POI filesystem directory to Process from</param>
  21802. <param name="fs">the POI filesystem that Contains the Workbook stream.</param>
  21803. <param name="preserveNodes">whether to preseve other nodes, such as
  21804. macros. This takes more memory, so only say yes if you
  21805. need to. If Set, will store all of the POIFSFileSystem
  21806. in memory</param>
  21807. </member>
  21808. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.DirectoryNode,System.Boolean)">
  21809. given a POI POIFSFileSystem object, and a specific directory
  21810. within it, read in its Workbook and populate the high and
  21811. low level models. If you're reading in a workbook...start here.
  21812. @param directory the POI filesystem directory to process from
  21813. @param preserveNodes whether to preseve other nodes, such as
  21814. macros. This takes more memory, so only say yes if you
  21815. need to. If set, will store all of the POIFSFileSystem
  21816. in memory
  21817. @see org.apache.poi.poifs.filesystem.POIFSFileSystem
  21818. @exception IOException if the stream cannot be read
  21819. </member>
  21820. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(System.IO.Stream,System.Boolean)">
  21821. Companion to HSSFWorkbook(POIFSFileSystem), this constructs the POI filesystem around your
  21822. inputstream.
  21823. @param s the POI filesystem that Contains the Workbook stream.
  21824. @param preserveNodes whether to preseve other nodes, such as
  21825. macros. This takes more memory, so only say yes if you
  21826. need to.
  21827. @see org.apache.poi.poifs.filesystem.POIFSFileSystem
  21828. @see #HSSFWorkbook(POIFSFileSystem)
  21829. @exception IOException if the stream cannot be Read
  21830. </member>
  21831. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetPropertiesFromWorkbook(NPOI.HSSF.Model.InternalWorkbook)">
  21832. used internally to Set the workbook properties.
  21833. </member>
  21834. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.ConvertLabelRecords(System.Collections.IList,System.Int32)">
  21835. <summary>
  21836. This is basically a kludge to deal with the now obsolete Label records. If
  21837. you have to read in a sheet that contains Label records, be aware that the rest
  21838. of the API doesn't deal with them, the low level structure only provides Read-only
  21839. semi-immutable structures (the Sets are there for interface conformance with NO
  21840. impelmentation). In short, you need to call this function passing it a reference
  21841. to the Workbook object. All labels will be converted to LabelSST records and their
  21842. contained strings will be written to the Shared String tabel (SSTRecord) within
  21843. the Workbook.
  21844. </summary>
  21845. <param name="records">The records.</param>
  21846. <param name="offset">The offset.</param>
  21847. </member>
  21848. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.MissingCellPolicy">
  21849. <summary>
  21850. Retrieves the current policy on what to do when
  21851. getting missing or blank cells from a row.
  21852. The default is to return blank and null cells.
  21853. </summary>
  21854. <value>The missing cell policy.</value>
  21855. </member>
  21856. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSheetOrder(System.String,System.Int32)">
  21857. <summary>
  21858. Sets the order of appearance for a given sheet.
  21859. </summary>
  21860. <param name="sheetname">the name of the sheet to reorder</param>
  21861. <param name="pos">the position that we want to Insert the sheet into (0 based)</param>
  21862. </member>
  21863. <!-- Badly formed XML comment ignored for member "M:NPOI.HSSF.UserModel.HSSFWorkbook.UpdateNamedRangesAfterSheetReorder(System.Int32,System.Int32)" -->
  21864. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.ValidateSheetIndex(System.Int32)">
  21865. <summary>
  21866. Validates the index of the sheet.
  21867. </summary>
  21868. <param name="index">The index.</param>
  21869. </member>
  21870. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.InsertChartRecord">
  21871. Test only. Do not use
  21872. </member>
  21873. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSelectedTab(System.Int32)">
  21874. <summary>
  21875. Selects a single sheet. This may be different to
  21876. the 'active' sheet (which Is the sheet with focus).
  21877. </summary>
  21878. <param name="index">The index.</param>
  21879. </member>
  21880. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSelectedTabs(System.Int32[])">
  21881. <summary>
  21882. Sets the selected tabs.
  21883. </summary>
  21884. <param name="indexes">The indexes.</param>
  21885. </member>
  21886. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSelectedTabs(System.Collections.Generic.IList{System.Int32})">
  21887. Selects multiple sheets as a group. This is distinct from
  21888. the 'active' sheet (which is the sheet with focus).
  21889. Unselects sheets that are not in <code>indexes</code>.
  21890. @param indexes
  21891. </member>
  21892. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSelectedTabs">
  21893. Gets the selected sheets (if more than one, Excel calls these a [Group]).
  21894. @return indices of selected sheets
  21895. </member>
  21896. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.ActiveSheetIndex">
  21897. <summary>
  21898. Gets the tab whose data is actually seen when the sheet is opened.
  21899. This may be different from the "selected sheet" since excel seems to
  21900. allow you to show the data of one sheet when another Is seen "selected"
  21901. in the tabs (at the bottom).
  21902. </summary>
  21903. </member>
  21904. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetActiveSheet(System.Int32)">
  21905. <summary>
  21906. Sets the tab whose data is actually seen when the sheet is opened.
  21907. This may be different from the "selected sheet" since excel seems to
  21908. allow you to show the data of one sheet when another Is seen "selected"
  21909. in the tabs (at the bottom).
  21910. <param name="index">The sheet number(0 based).</param>
  21911. </summary>
  21912. </member>
  21913. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.FirstVisibleTab">
  21914. <summary>
  21915. Gets or sets the first tab that is displayed in the list of tabs
  21916. in excel. This method does <b>not</b> hide, select or focus sheets.
  21917. It just sets the scroll position in the tab-bar.
  21918. @param index the sheet index of the tab that will become the first in the tab-bar
  21919. </summary>
  21920. </member>
  21921. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.ENCODING_COMPRESSED_UNICODE">
  21922. @deprecated POI will now properly handle Unicode strings without
  21923. forceing an encoding
  21924. </member>
  21925. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.ENCODING_UTF_16">
  21926. @deprecated POI will now properly handle Unicode strings without
  21927. forceing an encoding
  21928. </member>
  21929. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSheetName(System.Int32,System.String)">
  21930. <summary>
  21931. Set the sheet name.
  21932. </summary>
  21933. <param name="sheetIx">The sheet number(0 based).</param>
  21934. <param name="name">The name.</param>
  21935. </member>
  21936. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheetName(System.Int32)">
  21937. <summary>
  21938. Get the sheet name
  21939. </summary>
  21940. <param name="sheetIx">The sheet index.</param>
  21941. <returns>Sheet name</returns>
  21942. </member>
  21943. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.IsSheetHidden(System.Int32)">
  21944. <summary>
  21945. Check whether a sheet is hidden
  21946. </summary>
  21947. <param name="sheetIx">The sheet index.</param>
  21948. <returns>
  21949. <c>true</c> if sheet is hidden; otherwise, <c>false</c>.
  21950. </returns>
  21951. </member>
  21952. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.IsSheetVeryHidden(System.Int32)">
  21953. <summary>
  21954. Check whether a sheet is very hidden.
  21955. This is different from the normal
  21956. hidden status
  21957. </summary>
  21958. <param name="sheetIx">The sheet index.</param>
  21959. <returns>
  21960. <c>true</c> if sheet is very hidden; otherwise, <c>false</c>.
  21961. </returns>
  21962. </member>
  21963. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSheetHidden(System.Int32,NPOI.SS.UserModel.SheetState)">
  21964. <summary>
  21965. Hide or Unhide a sheet
  21966. </summary>
  21967. <param name="sheetIx">The sheet index</param>
  21968. <param name="hidden">True to mark the sheet as hidden, false otherwise</param>
  21969. </member>
  21970. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSheetHidden(System.Int32,System.Int32)">
  21971. <summary>
  21972. Hide or unhide a sheet.
  21973. </summary>
  21974. <param name="sheetIx">The sheet number</param>
  21975. <param name="hidden">0 for not hidden, 1 for hidden, 2 for very hidden</param>
  21976. </member>
  21977. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheetIndex(System.String)">
  21978. <summary>
  21979. Returns the index of the sheet by his name
  21980. </summary>
  21981. <param name="name">the sheet name</param>
  21982. <returns>index of the sheet (0 based)</returns>
  21983. </member>
  21984. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheetIndex(NPOI.SS.UserModel.ISheet)">
  21985. <summary>
  21986. Returns the index of the given sheet
  21987. </summary>
  21988. <param name="sheet">the sheet to look up</param>
  21989. <returns>index of the sheet (0 based).-1
  21990. if not found </returns>
  21991. </member>
  21992. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateSheet">
  21993. <summary>
  21994. Create an HSSFSheet for this HSSFWorkbook, Adds it to the sheets and returns
  21995. the high level representation. Use this to Create new sheets.
  21996. </summary>
  21997. <returns>HSSFSheet representing the new sheet.</returns>
  21998. </member>
  21999. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CloneSheet(System.Int32)">
  22000. <summary>
  22001. Create an HSSFSheet from an existing sheet in the HSSFWorkbook.
  22002. </summary>
  22003. <param name="sheetIndex">the sheet index</param>
  22004. <returns>HSSFSheet representing the Cloned sheet.</returns>
  22005. </member>
  22006. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetUniqueSheetName(System.String)">
  22007. <summary>
  22008. Gets the name of the unique sheet.
  22009. </summary>
  22010. <param name="srcName">Name of the SRC.</param>
  22011. <returns></returns>
  22012. </member>
  22013. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateSheet(System.String)">
  22014. <summary>
  22015. Create an HSSFSheet for this HSSFWorkbook, Adds it to the sheets and
  22016. returns the high level representation. Use this to Create new sheets.
  22017. </summary>
  22018. <param name="sheetname">sheetname to set for the sheet.</param>
  22019. <returns>HSSFSheet representing the new sheet.</returns>
  22020. </member>
  22021. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NumberOfSheets">
  22022. <summary>
  22023. Get the number of spreadsheets in the workbook (this will be three after serialization)
  22024. </summary>
  22025. <value>The number of sheets.</value>
  22026. </member>
  22027. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheets">
  22028. <summary>
  22029. Gets the sheets.
  22030. </summary>
  22031. <returns></returns>
  22032. </member>
  22033. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheetAt(System.Int32)">
  22034. <summary>
  22035. Get the HSSFSheet object at the given index.
  22036. </summary>
  22037. <param name="index">index of the sheet number (0-based)</param>
  22038. <returns>HSSFSheet at the provided index</returns>
  22039. </member>
  22040. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheet(System.String)">
  22041. <summary>
  22042. Get sheet with the given name (case insensitive match)
  22043. </summary>
  22044. <param name="name">name of the sheet</param>
  22045. <returns>HSSFSheet with the name provided or null if it does not exist</returns>
  22046. </member>
  22047. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemoveSheetAt(System.Int32)">
  22048. <summary>
  22049. Removes sheet at the given index.
  22050. </summary>
  22051. <param name="index">index of the sheet (0-based)</param>
  22052. <remarks>
  22053. Care must be taken if the Removed sheet Is the currently active or only selected sheet in
  22054. the workbook. There are a few situations when Excel must have a selection and/or active
  22055. sheet. (For example when printing - see Bug 40414).
  22056. This method makes sure that if the Removed sheet was active, another sheet will become
  22057. active in its place. Furthermore, if the Removed sheet was the only selected sheet, another
  22058. sheet will become selected. The newly active/selected sheet will have the same index, or
  22059. one less if the Removed sheet was the last in the workbook.
  22060. </remarks>
  22061. </member>
  22062. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.BackupFlag">
  22063. <summary>
  22064. determine whether the Excel GUI will backup the workbook when saving.
  22065. </summary>
  22066. <value>the current Setting for backups.</value>
  22067. </member>
  22068. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateFont">
  22069. <summary>
  22070. Create a new Font and Add it to the workbook's font table
  22071. </summary>
  22072. <returns>new font object</returns>
  22073. </member>
  22074. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.FindFont(System.Int16,System.Int16,System.Int16,System.String,System.Boolean,System.Boolean,NPOI.SS.UserModel.FontSuperScript,NPOI.SS.UserModel.FontUnderlineType)">
  22075. <summary>
  22076. Finds a font that matches the one with the supplied attributes
  22077. </summary>
  22078. <param name="boldWeight">The bold weight.</param>
  22079. <param name="color">The color.</param>
  22080. <param name="fontHeight">Height of the font.</param>
  22081. <param name="name">The name.</param>
  22082. <param name="italic">if set to <c>true</c> [italic].</param>
  22083. <param name="strikeout">if set to <c>true</c> [strikeout].</param>
  22084. <param name="typeOffset">The type offset.</param>
  22085. <param name="underline">The underline.</param>
  22086. <returns></returns>
  22087. </member>
  22088. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.FindFont(System.Boolean,System.Int16,System.Int16,System.String,System.Boolean,System.Boolean,NPOI.SS.UserModel.FontSuperScript,NPOI.SS.UserModel.FontUnderlineType)">
  22089. <summary>
  22090. Finds a font that matches the one with the supplied attributes
  22091. </summary>
  22092. <param name="bold">The bold weight.</param>
  22093. <param name="color">The color.</param>
  22094. <param name="fontHeight">Height of the font.</param>
  22095. <param name="name">The name.</param>
  22096. <param name="italic">if set to <c>true</c> [italic].</param>
  22097. <param name="strikeout">if set to <c>true</c> [strikeout].</param>
  22098. <param name="typeOffset">The type offset.</param>
  22099. <param name="underline">The underline.</param>
  22100. <returns></returns>
  22101. </member>
  22102. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NumberOfFonts">
  22103. <summary>
  22104. Get the number of fonts in the font table
  22105. </summary>
  22106. <value>The number of fonts.</value>
  22107. </member>
  22108. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetFontAt(System.Int16)">
  22109. <summary>
  22110. Get the font at the given index number
  22111. </summary>
  22112. <param name="idx">The index number</param>
  22113. <returns>HSSFFont at the index</returns>
  22114. </member>
  22115. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.ResetFontCache">
  22116. <summary>
  22117. Reset the fonts cache, causing all new calls
  22118. to getFontAt() to create new objects.
  22119. Should only be called after deleting fonts,
  22120. and that's not something you should normally do
  22121. </summary>
  22122. </member>
  22123. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateCellStyle">
  22124. <summary>
  22125. Create a new Cell style and Add it to the workbook's style table
  22126. </summary>
  22127. <returns>the new Cell Style object</returns>
  22128. </member>
  22129. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NumCellStyles">
  22130. <summary>
  22131. Get the number of styles the workbook Contains
  22132. </summary>
  22133. <value>count of cell styles</value>
  22134. </member>
  22135. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetCellStyleAt(System.Int32)">
  22136. <summary>
  22137. Get the cell style object at the given index
  22138. </summary>
  22139. <param name="idx">index within the Set of styles</param>
  22140. <returns>HSSFCellStyle object at the index</returns>
  22141. </member>
  22142. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.Close">
  22143. Closes the underlying {@link NPOIFSFileSystem} from which
  22144. the Workbook was read, if any. Has no effect on Workbooks
  22145. opened from an InputStream, or newly created ones.
  22146. Once {@link #close()} has been called, no further
  22147. operations, updates or reads should be performed on the
  22148. Workbook.
  22149. </member>
  22150. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.Write">
  22151. Write out this workbook to the currently open {@link File} via the
  22152. writeable {@link POIFSFileSystem} it was opened as.
  22153. This will fail (with an {@link InvalidOperationException} if the
  22154. Workbook was opened read-only, opened from an {@link InputStream}
  22155. instead of a File, or if this is not the root document. For those cases,
  22156. you must use {@link #write(OutputStream)} or {@link #write(File)} to
  22157. write to a brand new document.
  22158. </member>
  22159. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.Write(System.IO.FileInfo)">
  22160. Method write - write out this workbook to a new {@link File}. Constructs
  22161. a new POI POIFSFileSystem, passes in the workbook binary representation and
  22162. writes it out. If the file exists, it will be replaced, otherwise a new one
  22163. will be created.
  22164. Note that you cannot write to the currently open File using this method.
  22165. If you opened your Workbook from a File, you <i>must</i> use the {@link #write()}
  22166. method instead!
  22167. @param newFile - the new File you wish to write the XLS to
  22168. @exception IOException if anything can't be written.
  22169. @see org.apache.poi.poifs.filesystem.POIFSFileSystem
  22170. </member>
  22171. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.Write(System.IO.Stream,System.Boolean)">
  22172. <summary>
  22173. Write out this workbook to an Outputstream. Constructs
  22174. a new POI POIFSFileSystem, passes in the workbook binary representation and
  22175. Writes it out.
  22176. </summary>
  22177. <param name="stream">the stream you wish to write the XLS to</param>
  22178. <param name="leaveOpen">leave stream open or not</param>
  22179. </member>
  22180. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.Write(NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  22181. Writes the workbook out to a brand new, empty POIFS
  22182. </member>
  22183. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetBytes">
  22184. <summary>
  22185. Get the bytes of just the HSSF portions of the XLS file.
  22186. Use this to construct a POI POIFSFileSystem yourself.
  22187. </summary>
  22188. <returns>byte[] array containing the binary representation of this workbook and all contained
  22189. sheets, rows, cells, etc.</returns>
  22190. </member>
  22191. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook._udfFinder">
  22192. The locator of user-defined functions.
  22193. By default includes functions from the Excel Analysis Toolpack
  22194. </member>
  22195. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.AddToolPack(NPOI.SS.Formula.UDF.UDFFinder)">
  22196. Register a new toolpack in this workbook.
  22197. @param toopack the toolpack to register
  22198. </member>
  22199. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.Workbook">
  22200. <summary>
  22201. Gets the workbook.
  22202. </summary>
  22203. <value>The workbook.</value>
  22204. </member>
  22205. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NumberOfNames">
  22206. <summary>
  22207. Gets the total number of named ranges in the workboko
  22208. </summary>
  22209. <value>The number of named ranges</value>
  22210. </member>
  22211. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetNameAt(System.Int32)">
  22212. <summary>
  22213. Gets the Named range
  22214. </summary>
  22215. <param name="nameIndex">position of the named range</param>
  22216. <returns>named range high level</returns>
  22217. </member>
  22218. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetNameName(System.Int32)">
  22219. <summary>
  22220. Gets the named range name
  22221. </summary>
  22222. <param name="index">the named range index (0 based)</param>
  22223. <returns>named range name</returns>
  22224. </member>
  22225. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetPrintArea(System.Int32,System.String)">
  22226. <summary>
  22227. Sets the printarea for the sheet provided
  22228. i.e. Reference = $A$1:$B$2
  22229. </summary>
  22230. <param name="sheetIndex">Zero-based sheet index (0 Represents the first sheet to keep consistent with java)</param>
  22231. <param name="reference">Valid name Reference for the Print Area</param>
  22232. </member>
  22233. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetPrintArea(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  22234. <summary>
  22235. Sets the print area.
  22236. </summary>
  22237. <param name="sheetIndex">Zero-based sheet index (0 = First Sheet)</param>
  22238. <param name="startColumn">Column to begin printarea</param>
  22239. <param name="endColumn">Column to end the printarea</param>
  22240. <param name="startRow">Row to begin the printarea</param>
  22241. <param name="endRow">Row to end the printarea</param>
  22242. </member>
  22243. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetPrintArea(System.Int32)">
  22244. <summary>
  22245. Retrieves the reference for the printarea of the specified sheet, the sheet name Is Appended to the reference even if it was not specified.
  22246. </summary>
  22247. <param name="sheetIndex">Zero-based sheet index (0 Represents the first sheet to keep consistent with java)</param>
  22248. <returns>String Null if no print area has been defined</returns>
  22249. </member>
  22250. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemovePrintArea(System.Int32)">
  22251. <summary>
  22252. Delete the printarea for the sheet specified
  22253. </summary>
  22254. <param name="sheetIndex">Zero-based sheet index (0 = First Sheet)</param>
  22255. </member>
  22256. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateName">
  22257. <summary>
  22258. Creates a new named range and Add it to the model
  22259. </summary>
  22260. <returns>named range high level</returns>
  22261. </member>
  22262. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetNameIndex(System.String)">
  22263. <summary>
  22264. Gets the named range index by his name
  22265. Note:
  22266. Excel named ranges are case-insensitive and
  22267. this method performs a case-insensitive search.
  22268. </summary>
  22269. <param name="name">named range name</param>
  22270. <returns>named range index</returns>
  22271. </member>
  22272. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetNameIndex(NPOI.HSSF.UserModel.HSSFName)">
  22273. <summary>
  22274. As GetNameIndex(String) is not necessarily unique
  22275. (name + sheet index is unique), this method is more accurate.
  22276. </summary>
  22277. <param name="name">the name whose index in the list of names of this workbook should be looked up.</param>
  22278. <returns>an index value >= 0 if the name was found; -1, if the name was not found</returns>
  22279. </member>
  22280. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemoveName(System.Int32)">
  22281. <summary>
  22282. Remove the named range by his index
  22283. </summary>
  22284. <param name="index">The named range index (0 based)</param>
  22285. </member>
  22286. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateDataFormat">
  22287. <summary>
  22288. Creates the instance of HSSFDataFormat for this workbook.
  22289. </summary>
  22290. <returns>the HSSFDataFormat object</returns>
  22291. </member>
  22292. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemoveName(System.String)">
  22293. <summary>
  22294. Remove the named range by his name
  22295. </summary>
  22296. <param name="name">named range name</param>
  22297. </member>
  22298. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemoveName(NPOI.SS.UserModel.IName)">
  22299. <summary>
  22300. As #removeName(String) is not necessarily unique (name + sheet index is unique),
  22301. this method is more accurate.
  22302. </summary>
  22303. <param name="name">the name to remove.</param>
  22304. </member>
  22305. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.DumpDrawingGroupRecords(System.Boolean)">
  22306. <summary>
  22307. Spits out a list of all the drawing records in the workbook.
  22308. </summary>
  22309. <param name="fat">if set to <c>true</c> [fat].</param>
  22310. </member>
  22311. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.AddPicture(System.Byte[],NPOI.SS.UserModel.PictureType)">
  22312. <summary>
  22313. Adds a picture to the workbook.
  22314. </summary>
  22315. <param name="pictureData">The bytes of the picture</param>
  22316. <param name="format">The format of the picture. One of
  22317. PictureType.</param>
  22318. <returns>the index to this picture (1 based).</returns>
  22319. </member>
  22320. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetAllPictures">
  22321. <summary>
  22322. Gets all pictures from the Workbook.
  22323. </summary>
  22324. <returns>the list of pictures (a list of HSSFPictureData objects.)</returns>
  22325. </member>
  22326. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SearchForPictures(System.Collections.IList,System.Collections.Generic.List{NPOI.HSSF.UserModel.HSSFPictureData})">
  22327. <summary>
  22328. Performs a recursive search for pictures in the given list of escher records.
  22329. </summary>
  22330. <param name="escherRecords">the escher records.</param>
  22331. <param name="pictures">the list to populate with the pictures.</param>
  22332. </member>
  22333. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.LinkExternalWorkbook(System.String,NPOI.SS.UserModel.IWorkbook)">
  22334. <summary>
  22335. Adds the LinkTable records required to allow formulas referencing
  22336. the specified external workbook to be added to this one. Allows
  22337. formulas such as "[MyOtherWorkbook]Sheet3!$A$5" to be added to the
  22338. file, for workbooks not already referenced.
  22339. </summary>
  22340. <param name="name">The name the workbook will be referenced as in formulas</param>
  22341. <param name="workbook">The open workbook to fetch the link required information from</param>
  22342. <returns></returns>
  22343. </member>
  22344. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.IsWriteProtected">
  22345. <summary>
  22346. Is the workbook protected with a password (not encrypted)?
  22347. </summary>
  22348. <value>
  22349. <c>true</c> if this instance is write protected; otherwise, <c>false</c>.
  22350. </value>
  22351. </member>
  22352. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.WriteProtectWorkbook(System.String,System.String)">
  22353. <summary>
  22354. protect a workbook with a password (not encypted, just Sets Writeprotect
  22355. flags and the password.
  22356. </summary>
  22357. <param name="password">password to set</param>
  22358. <param name="username">The username.</param>
  22359. </member>
  22360. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.UnwriteProtectWorkbook">
  22361. <summary>
  22362. Removes the Write protect flag
  22363. </summary>
  22364. </member>
  22365. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetAllEmbeddedObjects">
  22366. <summary>
  22367. Gets all embedded OLE2 objects from the Workbook.
  22368. </summary>
  22369. <returns>the list of embedded objects (a list of HSSFObjectData objects.)</returns>
  22370. </member>
  22371. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetAllEmbeddedObjects(NPOI.HSSF.UserModel.HSSFSheet,System.Collections.Generic.List{NPOI.HSSF.UserModel.HSSFObjectData})">
  22372. <summary>
  22373. Gets all embedded OLE2 objects from the Workbook.
  22374. </summary>
  22375. <param name="sheet">the list of records to search.</param>
  22376. <param name="objects">the list of embedded objects to populate.</param>
  22377. </member>
  22378. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetAllEmbeddedObjects(NPOI.HSSF.UserModel.HSSFShapeContainer,System.Collections.Generic.List{NPOI.HSSF.UserModel.HSSFObjectData})">
  22379. <summary>
  22380. Recursively iterates a shape container to get all embedded objects.
  22381. </summary>
  22382. <param name="parent">the parent.</param>
  22383. <param name="objects">the list of embedded objects to populate.</param>
  22384. </member>
  22385. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NewUID">
  22386. <summary>
  22387. Gets the new UID.
  22388. </summary>
  22389. <value>The new UID.</value>
  22390. </member>
  22391. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetEnumerator">
  22392. <summary>
  22393. Support foreach ISheet, e.g.
  22394. HSSFWorkbook workbook = new HSSFWorkbook();
  22395. foreach(ISheet sheet in workbook) ...
  22396. </summary>
  22397. <returns>Enumeration of all the sheets of this workbook</returns>
  22398. </member>
  22399. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.ForceFormulaRecalculation">
  22400. <summary>
  22401. Whether the application shall perform a full recalculation when the workbook is opened.
  22402. Typically you want to force formula recalculation when you modify cell formulas or values
  22403. of a workbook previously created by Excel. When set to true, this flag will tell Excel
  22404. that it needs to recalculate all formulas in the workbook the next time the file is opened.
  22405. Note, that recalculation updates cached formula results and, thus, modifies the workbook.
  22406. Depending on the version, Excel may prompt you with "Do you want to save the changes in <em>filename</em>?"
  22407. on close.
  22408. Value is true if the application will perform a full recalculation of
  22409. workbook values when the workbook is opened.
  22410. since 3.8
  22411. </summary>
  22412. </member>
  22413. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.SpreadsheetVersion">
  22414. <summary>
  22415. Returns the spreadsheet version (EXCLE97) of this workbook
  22416. </summary>
  22417. </member>
  22418. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.ChangeExternalReference(System.String,System.String)">
  22419. Changes an external referenced file to another file.
  22420. A formular in Excel which refers a cell in another file is saved in two parts:
  22421. The referenced file is stored in an reference table. the row/cell information is saved separate.
  22422. This method invokation will only change the reference in the lookup-table itself.
  22423. @param oldUrl The old URL to search for and which is to be replaced
  22424. @param newUrl The URL replacement
  22425. @return true if the oldUrl was found and replaced with newUrl. Otherwise false
  22426. </member>
  22427. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.IsDate1904">
  22428. <summary>
  22429. Gets a bool value that indicates whether the date systems used in the workbook starts in 1904.
  22430. The default value is false, meaning that the workbook uses the 1900 date system,
  22431. where 1/1/1900 is the first day in the system.
  22432. </summary>
  22433. <returns>True if the date systems used in the workbook starts in 1904</returns>
  22434. </member>
  22435. <member name="T:NPOI.HSSF.UserModel.OperationEvaluatorFactory">
  22436. This class Creates <c>OperationEval</c> instances to help evaluate <c>OperationPtg</c>
  22437. formula tokens.
  22438. @author Josh Micich
  22439. </member>
  22440. <member name="M:NPOI.HSSF.UserModel.OperationEvaluatorFactory.Create(NPOI.SS.Formula.PTG.OperationPtg)">
  22441. returns the OperationEval concrete impl instance corresponding
  22442. to the supplied operationPtg
  22443. </member>
  22444. <member name="T:NPOI.HSSF.UserModel.StaticFontMetrics">
  22445. Allows the user to lookup the font metrics for a particular font without
  22446. actually having the font on the system. The font details are Loaded
  22447. as a resource from the POI jar file (or classpath) and should be contained
  22448. in path "/font_metrics.properties". The font widths are for a 10 point
  22449. version of the font. Use a multiplier for other sizes.
  22450. @author Glen Stampoultzis (glens at apache.org)
  22451. </member>
  22452. <member name="F:NPOI.HSSF.UserModel.StaticFontMetrics.fontMetricsProps">
  22453. The font metrics property file we're using
  22454. </member>
  22455. <member name="F:NPOI.HSSF.UserModel.StaticFontMetrics.fontDetailsMap">
  22456. Our cache of font details we've alReady looked up
  22457. </member>
  22458. <member name="F:NPOI.HSSF.Util.GUID._d1">
  22459. 4 bytes - little endian
  22460. </member>
  22461. <member name="F:NPOI.HSSF.Util.GUID._d2">
  22462. 2 bytes - little endian
  22463. </member>
  22464. <member name="F:NPOI.HSSF.Util.GUID._d3">
  22465. 2 bytes - little endian
  22466. </member>
  22467. <member name="F:NPOI.HSSF.Util.GUID._d4">
  22468. 8 bytes - serialized as big endian, stored with inverted endianness here
  22469. </member>
  22470. <member name="M:NPOI.HSSF.Util.GUID.Parse(System.String)">
  22471. Read a GUID in standard text form e.g.<br/>
  22472. 13579BDF-0246-8ACE-0123-456789ABCDEF
  22473. <br/> -&gt; <br/>
  22474. 0x13579BDF, 0x0246, 0x8ACE 0x0123456789ABCDEF
  22475. </member>
  22476. <member name="T:NPOI.HSSF.Util.HSSFCellRangeAddress">
  22477. <p>Title: HSSFCellRangeAddress</p>
  22478. <p>Description:
  22479. Implementation of the cell range Address lists,like Is described in
  22480. OpenOffice.org's Excel Documentation .
  22481. In BIFF8 there Is a common way to store absolute cell range Address
  22482. lists in several records (not formulas). A cell range Address list
  22483. consists of a field with the number of ranges and the list of the range
  22484. Addresses. Each cell range Address (called an AddR structure) Contains
  22485. 4 16-bit-values.</p>
  22486. <p>Copyright: Copyright (c) 2004</p>
  22487. <p>Company: </p>
  22488. @author Dragos Buleandra (dragos.buleandra@trade2b.ro)
  22489. @version 2.0-pre
  22490. </member>
  22491. <member name="F:NPOI.HSSF.Util.HSSFCellRangeAddress.field_Addr_number">
  22492. Number of following AddR structures
  22493. </member>
  22494. <member name="F:NPOI.HSSF.Util.HSSFCellRangeAddress.field_regions_list">
  22495. List of AddR structures. Each structure represents a cell range
  22496. </member>
  22497. <member name="M:NPOI.HSSF.Util.HSSFCellRangeAddress.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  22498. Construct a new HSSFCellRangeAddress object and Sets its fields appropriately .
  22499. Even this Isn't an Excel record , I kept the same behavior for reading/writing
  22500. the object's data as for a regular record .
  22501. @param in the RecordInputstream to read the record from
  22502. </member>
  22503. <member name="P:NPOI.HSSF.Util.HSSFCellRangeAddress.AddRStructureNumber">
  22504. Get the number of following AddR structures.
  22505. The number of this structures Is automatically Set when reading an Excel file
  22506. and/or increased when you manually Add a new AddR structure .
  22507. This Is the reason there Isn't a Set method for this field .
  22508. @return number of AddR structures
  22509. </member>
  22510. <member name="M:NPOI.HSSF.Util.HSSFCellRangeAddress.AddAddRStructure(System.Int16,System.Int16,System.Int16,System.Int16)">
  22511. Add an AddR structure .
  22512. @param first_row - the upper left hand corner's row
  22513. @param first_col - the upper left hand corner's col
  22514. @param last_row - the lower right hand corner's row
  22515. @param last_col - the lower right hand corner's col
  22516. @return the index of this AddR structure
  22517. </member>
  22518. <member name="M:NPOI.HSSF.Util.HSSFCellRangeAddress.RemoveAddRStructureAt(System.Int32)">
  22519. Remove the AddR structure stored at the passed in index
  22520. @param index The AddR structure's index
  22521. </member>
  22522. <member name="M:NPOI.HSSF.Util.HSSFCellRangeAddress.GetAddRStructureAt(System.Int32)">
  22523. return the AddR structure at the given index.
  22524. @return AddrStructure representing
  22525. </member>
  22526. <member name="P:NPOI.HSSF.Util.HSSFCellRangeAddress.AddrStructure.FirstColumn">
  22527. Get the upper left hand corner column number
  22528. @return column number for the upper left hand corner
  22529. </member>
  22530. <member name="P:NPOI.HSSF.Util.HSSFCellRangeAddress.AddrStructure.FirstRow">
  22531. Get the upper left hand corner row number
  22532. @return row number for the upper left hand corner
  22533. </member>
  22534. <member name="P:NPOI.HSSF.Util.HSSFCellRangeAddress.AddrStructure.LastColumn">
  22535. Get the lower right hand corner column number
  22536. @return column number for the lower right hand corner
  22537. </member>
  22538. <member name="P:NPOI.HSSF.Util.HSSFCellRangeAddress.AddrStructure.LastRow">
  22539. Get the lower right hand corner row number
  22540. @return row number for the lower right hand corner
  22541. </member>
  22542. <member name="T:NPOI.HSSF.Util.HSSFCellUtil">
  22543. <summary>
  22544. Various utility functions that make working with a cells and rows easier. The various
  22545. methods that deal with style's allow you to Create your HSSFCellStyles as you need them.
  22546. When you apply a style change to a cell, the code will attempt to see if a style already
  22547. exists that meets your needs. If not, then it will Create a new style. This is to prevent
  22548. creating too many styles. there is an upper limit in Excel on the number of styles that
  22549. can be supported.
  22550. @author Eric Pugh epugh@upstate.com
  22551. </summary>
  22552. </member>
  22553. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.GetRow(System.Int32,NPOI.HSSF.UserModel.HSSFSheet)">
  22554. <summary>
  22555. Get a row from the spreadsheet, and Create it if it doesn't exist.
  22556. </summary>
  22557. <param name="rowCounter">The 0 based row number</param>
  22558. <param name="sheet">The sheet that the row is part of.</param>
  22559. <returns>The row indicated by the rowCounter</returns>
  22560. </member>
  22561. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.GetCell(NPOI.SS.UserModel.IRow,System.Int32)">
  22562. <summary>
  22563. Get a specific cell from a row. If the cell doesn't exist,
  22564. </summary>
  22565. <param name="row">The row that the cell is part of</param>
  22566. <param name="column">The column index that the cell is in.</param>
  22567. <returns>The cell indicated by the column.</returns>
  22568. </member>
  22569. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.CreateCell(NPOI.SS.UserModel.IRow,System.Int32,System.String,NPOI.HSSF.UserModel.HSSFCellStyle)">
  22570. <summary>
  22571. Creates a cell, gives it a value, and applies a style if provided
  22572. </summary>
  22573. <param name="row">the row to Create the cell in</param>
  22574. <param name="column">the column index to Create the cell in</param>
  22575. <param name="value">The value of the cell</param>
  22576. <param name="style">If the style is not null, then Set</param>
  22577. <returns>A new HSSFCell</returns>
  22578. </member>
  22579. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.CreateCell(NPOI.SS.UserModel.IRow,System.Int32,System.String)">
  22580. <summary>
  22581. Create a cell, and give it a value.
  22582. </summary>
  22583. <param name="row">the row to Create the cell in</param>
  22584. <param name="column">the column index to Create the cell in</param>
  22585. <param name="value">The value of the cell</param>
  22586. <returns>A new HSSFCell.</returns>
  22587. </member>
  22588. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.SetAlignment(NPOI.SS.UserModel.ICell,NPOI.HSSF.UserModel.HSSFWorkbook,System.Int16)">
  22589. <summary>
  22590. Take a cell, and align it.
  22591. </summary>
  22592. <param name="cell">the cell to Set the alignment for</param>
  22593. <param name="workbook">The workbook that is being worked with.</param>
  22594. <param name="align">the column alignment to use.</param>
  22595. </member>
  22596. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.SetFont(NPOI.SS.UserModel.ICell,NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFFont)">
  22597. <summary>
  22598. Take a cell, and apply a font to it
  22599. </summary>
  22600. <param name="cell">the cell to Set the alignment for</param>
  22601. <param name="workbook">The workbook that is being worked with.</param>
  22602. <param name="font">The HSSFFont that you want to Set...</param>
  22603. </member>
  22604. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.SetCellStyleProperty(NPOI.SS.UserModel.ICell,NPOI.HSSF.UserModel.HSSFWorkbook,System.String,System.Object)">
  22605. This method attempt to find an already existing HSSFCellStyle that matches
  22606. what you want the style to be. If it does not find the style, then it
  22607. Creates a new one. If it does Create a new one, then it applies the
  22608. propertyName and propertyValue to the style. This is necessary because
  22609. Excel has an upper limit on the number of Styles that it supports.
  22610. @param workbook The workbook that is being worked with.
  22611. @param propertyName The name of the property that is to be
  22612. changed.
  22613. @param propertyValue The value of the property that is to be
  22614. changed.
  22615. @param cell The cell that needs it's style changes
  22616. @exception NestableException Thrown if an error happens.
  22617. </member>
  22618. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.TranslateUnicodeValues(NPOI.SS.UserModel.ICell)">
  22619. <summary>
  22620. Looks for text in the cell that should be unicode, like alpha; and provides the
  22621. unicode version of it.
  22622. </summary>
  22623. <param name="cell">The cell to check for unicode values</param>
  22624. <returns>transalted to unicode</returns>
  22625. </member>
  22626. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.RemapCellStyle(NPOI.HSSF.UserModel.HSSFCellStyle,System.Collections.Generic.Dictionary{System.Int16,System.Int16})">
  22627. <summary>
  22628. Translate color palette entries from the source to the destination sheet
  22629. </summary>
  22630. </member>
  22631. <member name="T:NPOI.HSSF.Util.HSSFColor">
  22632. Intends to provide support for the very evil index to triplet Issue and
  22633. will likely replace the color constants interface for HSSF 2.0.
  22634. This class Contains static inner class members for representing colors.
  22635. Each color has an index (for the standard palette in Excel (tm) ),
  22636. native (RGB) triplet and string triplet. The string triplet Is as the
  22637. color would be represented by Gnumeric. Having (string) this here Is a bit of a
  22638. collusion of function between HSSF and the HSSFSerializer but I think its
  22639. a reasonable one in this case.
  22640. @author Andrew C. Oliver (acoliver at apache dot org)
  22641. @author Brian Sanders (bsanders at risklabs dot com) - full default color palette
  22642. </member>
  22643. <member name="M:NPOI.HSSF.Util.HSSFColor.#ctor">
  22644. Creates a new instance of HSSFColor
  22645. </member>
  22646. <member name="M:NPOI.HSSF.Util.HSSFColor.GetIndexHash">
  22647. this function returns all colors in a hastable. Its not implemented as a
  22648. static member/staticly initialized because that would be dirty in a
  22649. server environment as it Is intended. This means you'll eat the time
  22650. it takes to Create it once per request but you will not hold onto it
  22651. if you have none of those requests.
  22652. @return a hashtable containing all colors keyed by <c>int</c> excel-style palette indexes
  22653. </member>
  22654. <member name="M:NPOI.HSSF.Util.HSSFColor.GetMutableIndexHash">
  22655. This function returns all the Colours, stored in a Hashtable that
  22656. can be edited. No caching is performed. If you don't need to edit
  22657. the table, then call {@link #getIndexHash()} which returns a
  22658. statically cached imuatable map of colours.
  22659. </member>
  22660. <member name="M:NPOI.HSSF.Util.HSSFColor.GetTripletHash">
  22661. <summary>
  22662. this function returns all colors in a hastable. Its not implemented as a
  22663. static member/staticly initialized because that would be dirty in a
  22664. server environment as it Is intended. This means you'll eat the time
  22665. it takes to Create it once per request but you will not hold onto it
  22666. if you have none of those requests.
  22667. </summary>
  22668. <returns>a hashtable containing all colors keyed by String gnumeric-like triplets</returns>
  22669. </member>
  22670. <member name="P:NPOI.HSSF.Util.HSSFColor.Indexed">
  22671. @return index to the standard palette
  22672. </member>
  22673. <member name="M:NPOI.HSSF.Util.HSSFColor.GetTriplet">
  22674. @return triplet representation like that in Excel
  22675. </member>
  22676. <member name="M:NPOI.HSSF.Util.HSSFColor.GetHexString">
  22677. @return a hex string exactly like a gnumeric triplet
  22678. </member>
  22679. <member name="T:NPOI.HSSF.Util.HSSFColor.Black">
  22680. Class BLACK
  22681. </member>
  22682. <member name="T:NPOI.HSSF.Util.HSSFColor.Brown">
  22683. Class BROWN
  22684. </member>
  22685. <member name="T:NPOI.HSSF.Util.HSSFColor.OliveGreen">
  22686. Class OLIVE_GREEN
  22687. </member>
  22688. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkGreen">
  22689. Class DARK_GREEN
  22690. </member>
  22691. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkTeal">
  22692. Class DARK_TEAL
  22693. </member>
  22694. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkBlue">
  22695. Class DARK_BLUE
  22696. </member>
  22697. <member name="T:NPOI.HSSF.Util.HSSFColor.Indigo">
  22698. Class INDIGO
  22699. </member>
  22700. <member name="T:NPOI.HSSF.Util.HSSFColor.Grey80Percent">
  22701. Class GREY_80_PERCENT
  22702. </member>
  22703. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkRed">
  22704. Class DARK_RED
  22705. </member>
  22706. <member name="T:NPOI.HSSF.Util.HSSFColor.Orange">
  22707. Class ORANGE
  22708. </member>
  22709. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkYellow">
  22710. Class DARK_YELLOW
  22711. </member>
  22712. <member name="T:NPOI.HSSF.Util.HSSFColor.Green">
  22713. Class GREEN
  22714. </member>
  22715. <member name="T:NPOI.HSSF.Util.HSSFColor.Teal">
  22716. Class TEAL
  22717. </member>
  22718. <member name="T:NPOI.HSSF.Util.HSSFColor.Blue">
  22719. Class BLUE
  22720. </member>
  22721. <member name="T:NPOI.HSSF.Util.HSSFColor.BlueGrey">
  22722. Class BLUE_GREY
  22723. </member>
  22724. <member name="T:NPOI.HSSF.Util.HSSFColor.Grey50Percent">
  22725. Class GREY_50_PERCENT
  22726. </member>
  22727. <member name="T:NPOI.HSSF.Util.HSSFColor.Red">
  22728. Class RED
  22729. </member>
  22730. <member name="T:NPOI.HSSF.Util.HSSFColor.LightOrange">
  22731. Class LIGHT_ORANGE
  22732. </member>
  22733. <member name="T:NPOI.HSSF.Util.HSSFColor.Lime">
  22734. Class LIME
  22735. </member>
  22736. <member name="T:NPOI.HSSF.Util.HSSFColor.SeaGreen">
  22737. Class SEA_GREEN
  22738. </member>
  22739. <member name="T:NPOI.HSSF.Util.HSSFColor.Aqua">
  22740. Class AQUA
  22741. </member>
  22742. <member name="T:NPOI.HSSF.Util.HSSFColor.Grey40Percent">
  22743. Class GREY_40_PERCENT
  22744. </member>
  22745. <member name="T:NPOI.HSSF.Util.HSSFColor.Turquoise">
  22746. Class TURQUOISE
  22747. </member>
  22748. <member name="T:NPOI.HSSF.Util.HSSFColor.SkyBlue">
  22749. Class SKY_BLUE
  22750. </member>
  22751. <member name="T:NPOI.HSSF.Util.HSSFColor.Plum">
  22752. Class PLUM
  22753. </member>
  22754. <member name="T:NPOI.HSSF.Util.HSSFColor.Grey25Percent">
  22755. Class GREY_25_PERCENT
  22756. </member>
  22757. <member name="T:NPOI.HSSF.Util.HSSFColor.Rose">
  22758. Class ROSE
  22759. </member>
  22760. <member name="T:NPOI.HSSF.Util.HSSFColor.Tan">
  22761. Class TAN
  22762. </member>
  22763. <member name="T:NPOI.HSSF.Util.HSSFColor.LightYellow">
  22764. Class LIGHT_YELLOW
  22765. </member>
  22766. <member name="T:NPOI.HSSF.Util.HSSFColor.LightGreen">
  22767. Class LIGHT_GREEN
  22768. </member>
  22769. <member name="T:NPOI.HSSF.Util.HSSFColor.LightTurquoise">
  22770. Class LIGHT_TURQUOISE
  22771. </member>
  22772. <member name="T:NPOI.HSSF.Util.HSSFColor.PaleBlue">
  22773. Class PALE_BLUE
  22774. </member>
  22775. <member name="T:NPOI.HSSF.Util.HSSFColor.Lavender">
  22776. Class LAVENDER
  22777. </member>
  22778. <member name="T:NPOI.HSSF.Util.HSSFColor.White">
  22779. Class WHITE
  22780. </member>
  22781. <member name="T:NPOI.HSSF.Util.HSSFColor.CornflowerBlue">
  22782. Class CORNFLOWER_BLUE
  22783. </member>
  22784. <member name="T:NPOI.HSSF.Util.HSSFColor.LemonChiffon">
  22785. Class LEMON_CHIFFON
  22786. </member>
  22787. <member name="T:NPOI.HSSF.Util.HSSFColor.Maroon">
  22788. Class MAROON
  22789. </member>
  22790. <member name="T:NPOI.HSSF.Util.HSSFColor.Orchid">
  22791. Class ORCHID
  22792. </member>
  22793. <member name="T:NPOI.HSSF.Util.HSSFColor.Coral">
  22794. Class CORAL
  22795. </member>
  22796. <member name="T:NPOI.HSSF.Util.HSSFColor.RoyalBlue">
  22797. Class ROYAL_BLUE
  22798. </member>
  22799. <member name="T:NPOI.HSSF.Util.HSSFColor.LightCornflowerBlue">
  22800. Class LIGHT_CORNFLOWER_BLUE
  22801. </member>
  22802. <member name="T:NPOI.HSSF.Util.HSSFColor.Automatic">
  22803. Special Default/Normal/Automatic color.
  22804. <i>Note:</i> This class Is NOT in the default HashTables returned by HSSFColor.
  22805. The index Is a special case which Is interpreted in the various SetXXXColor calls.
  22806. @author Jason
  22807. </member>
  22808. <member name="T:NPOI.HSSF.Util.HSSFRegionUtil">
  22809. <summary>
  22810. Various utility functions that make working with a region of cells easier.
  22811. @author Eric Pugh epugh@upstate.com
  22812. </summary>
  22813. </member>
  22814. <member name="T:NPOI.HSSF.Util.HSSFRegionUtil.CellPropertySetter">
  22815. <summary>
  22816. For setting the same property on many cells to the same value
  22817. </summary>
  22818. </member>
  22819. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBorderLeft(NPOI.SS.UserModel.BorderStyle,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  22820. <summary>
  22821. Sets the left border for a region of cells by manipulating the cell style
  22822. of the individual cells on the left
  22823. </summary>
  22824. <param name="border">The new border</param>
  22825. <param name="region">The region that should have the border</param>
  22826. <param name="sheet">The sheet that the region is on.</param>
  22827. <param name="workbook">The workbook that the region is on.</param>
  22828. </member>
  22829. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetLeftBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  22830. <summary>
  22831. Sets the leftBorderColor attribute of the HSSFRegionUtil object
  22832. </summary>
  22833. <param name="color">The color of the border</param>
  22834. <param name="region">The region that should have the border</param>
  22835. <param name="sheet">The sheet that the region is on.</param>
  22836. <param name="workbook">The workbook that the region is on.</param>
  22837. </member>
  22838. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBorderRight(NPOI.SS.UserModel.BorderStyle,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  22839. <summary>
  22840. Sets the borderRight attribute of the HSSFRegionUtil object
  22841. </summary>
  22842. <param name="border">The new border</param>
  22843. <param name="region">The region that should have the border</param>
  22844. <param name="sheet">The sheet that the region is on.</param>
  22845. <param name="workbook">The workbook that the region is on.</param>
  22846. </member>
  22847. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetRightBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  22848. <summary>
  22849. Sets the rightBorderColor attribute of the HSSFRegionUtil object
  22850. </summary>
  22851. <param name="color">The color of the border</param>
  22852. <param name="region">The region that should have the border</param>
  22853. <param name="sheet">The workbook that the region is on.</param>
  22854. <param name="workbook">The sheet that the region is on.</param>
  22855. </member>
  22856. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBorderBottom(NPOI.SS.UserModel.BorderStyle,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  22857. <summary>
  22858. Sets the borderBottom attribute of the HSSFRegionUtil object
  22859. </summary>
  22860. <param name="border">The new border</param>
  22861. <param name="region">The region that should have the border</param>
  22862. <param name="sheet">The sheet that the region is on.</param>
  22863. <param name="workbook">The workbook that the region is on.</param>
  22864. </member>
  22865. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBottomBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  22866. <summary>
  22867. Sets the bottomBorderColor attribute of the HSSFRegionUtil object
  22868. </summary>
  22869. <param name="color">The color of the border</param>
  22870. <param name="region">The region that should have the border</param>
  22871. <param name="sheet">The sheet that the region is on.</param>
  22872. <param name="workbook">The workbook that the region is on.</param>
  22873. </member>
  22874. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBorderTop(NPOI.SS.UserModel.BorderStyle,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  22875. <summary>
  22876. Sets the borderBottom attribute of the HSSFRegionUtil object
  22877. </summary>
  22878. <param name="border">The new border</param>
  22879. <param name="region">The region that should have the border</param>
  22880. <param name="sheet">The sheet that the region is on.</param>
  22881. <param name="workbook">The workbook that the region is on.</param>
  22882. </member>
  22883. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetTopBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  22884. <summary>
  22885. Sets the topBorderColor attribute of the HSSFRegionUtil object
  22886. </summary>
  22887. <param name="color">The color of the border</param>
  22888. <param name="region">The region that should have the border</param>
  22889. <param name="sheet">The sheet that the region is on.</param>
  22890. <param name="workbook">The workbook that the region is on.</param>
  22891. </member>
  22892. <member name="T:NPOI.HSSF.Util.LazilyConcatenatedByteArray">
  22893. Utility for delaying the concatenation of multiple byte arrays. Doing this up-front
  22894. causes significantly more copying, which for a large number of byte arrays can cost
  22895. a large amount of time.
  22896. </member>
  22897. <member name="M:NPOI.HSSF.Util.LazilyConcatenatedByteArray.Clear">
  22898. Clears the array (sets the concatenated length back to zero.
  22899. </member>
  22900. <member name="M:NPOI.HSSF.Util.LazilyConcatenatedByteArray.Concatenate(System.Byte[])">
  22901. Concatenates an array onto the end of our array.
  22902. This is a relatively fast operation.
  22903. @param array the array to concatenate.
  22904. @throws ArgumentException if {@code array} is {@code null}.
  22905. </member>
  22906. <member name="M:NPOI.HSSF.Util.LazilyConcatenatedByteArray.ToArray">
  22907. Gets the concatenated contents as a single byte array.
  22908. This is a slower operation, but the concatenated array is stored off as a single
  22909. array again so that subsequent calls will not perform Additional copying.
  22910. @return the byte array. Returns {@code null} if no data has been placed into it.
  22911. </member>
  22912. <member name="T:NPOI.HSSF.Util.RangeAddress">
  22913. * Title: Range Address
  22914. * Description: provides connectivity utilities for ranges
  22915. *
  22916. *
  22917. * REFERENCE:
  22918. * @author IgOr KaTz &amp; EuGeNe BuMaGiN (Tal Moshaiov) (VistaPortal LDT.)
  22919. @version 1.0
  22920. </member>
  22921. <member name="M:NPOI.HSSF.Util.RangeAddress.#ctor(System.String)">
  22922. Accepts an external reference from excel.
  22923. i.e. Sheet1!$A$4:$B$9
  22924. @param _url
  22925. </member>
  22926. <member name="P:NPOI.HSSF.Util.RangeAddress.Address">
  22927. @return String <b>note: </b> All absolute references are Removed
  22928. </member>
  22929. <member name="T:NPOI.HSSF.Util.RKUtil">
  22930. Utility class for helping convert RK numbers.
  22931. @author Andrew C. Oliver (acoliver at apache dot org)
  22932. @author Glen Stampoultzis (glens at apache.org)
  22933. @author Rolf-J黵gen Moll
  22934. @see org.apache.poi.hssf.record.MulRKRecord
  22935. @see org.apache.poi.hssf.record.RKRecord
  22936. </member>
  22937. <member name="M:NPOI.HSSF.Util.RKUtil.DecodeNumber(System.Int32)">
  22938. Do the dirty work of decoding; made a private static method to
  22939. facilitate testing the algorithm
  22940. </member>
  22941. <member name="T:NPOI.POIDocument">
  22942. <summary>
  22943. This holds the common functionality for all POI
  22944. Document classes.
  22945. Currently, this relates to Document Information Properties
  22946. </summary>
  22947. <remarks>@author Nick Burch</remarks>
  22948. </member>
  22949. <member name="F:NPOI.POIDocument.sInf">
  22950. Holds metadata on our document
  22951. </member>
  22952. <member name="F:NPOI.POIDocument.dsInf">
  22953. Holds further metadata on our document
  22954. </member>
  22955. <member name="F:NPOI.POIDocument.directory">
  22956. The directory that our document lives in
  22957. </member>
  22958. <member name="M:NPOI.POIDocument.SetDirectoryNode(NPOI.POIFS.FileSystem.DirectoryNode)">
  22959. <summary>
  22960. just for test case TestPOIDocumentMain.TestWriteReadProperties
  22961. </summary>
  22962. </member>
  22963. <member name="F:NPOI.POIDocument.initialized">
  22964. For our own logging use
  22965. </member>
  22966. <member name="M:NPOI.POIDocument.#ctor(NPOI.POIFS.FileSystem.OPOIFSFileSystem)">
  22967. Constructs from an old-style OPOIFS
  22968. </member>
  22969. <member name="M:NPOI.POIDocument.#ctor(NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  22970. <summary>
  22971. Initializes a new instance of the <see cref="T:NPOI.POIDocument"/> class.
  22972. </summary>
  22973. <param name="fs">The fs.</param>
  22974. </member>
  22975. <member name="M:NPOI.POIDocument.#ctor(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  22976. Constructs from the default POIFS
  22977. </member>
  22978. <member name="M:NPOI.POIDocument.CreateInformationProperties">
  22979. Will create whichever of SummaryInformation
  22980. and DocumentSummaryInformation (HPSF) properties
  22981. are not already part of your document.
  22982. This is normally useful when creating a new
  22983. document from scratch.
  22984. If the information properties are already there,
  22985. then nothing will happen.
  22986. </member>
  22987. <member name="P:NPOI.POIDocument.DocumentSummaryInformation">
  22988. <summary>
  22989. Fetch the Document Summary Information of the document
  22990. </summary>
  22991. <value>The document summary information.</value>
  22992. </member>
  22993. <member name="P:NPOI.POIDocument.SummaryInformation">
  22994. <summary>
  22995. Fetch the Summary Information of the document
  22996. </summary>
  22997. <value>The summary information.</value>
  22998. </member>
  22999. <member name="M:NPOI.POIDocument.ReadProperties">
  23000. <summary>
  23001. Find, and Create objects for, the standard
  23002. Documment Information Properties (HPSF).
  23003. If a given property Set is missing or corrupt,
  23004. it will remain null;
  23005. </summary>
  23006. </member>
  23007. <member name="M:NPOI.POIDocument.GetPropertySet(System.String)">
  23008. <summary>
  23009. For a given named property entry, either return it or null if
  23010. if it wasn't found
  23011. </summary>
  23012. <param name="setName">The property to read</param>
  23013. <returns>The value of the given property or null if it wasn't found.</returns>
  23014. <exception cref="T:System.IO.IOException">If retrieving properties fails</exception>
  23015. </member>
  23016. <member name="M:NPOI.POIDocument.GetPropertySet(System.String,NPOI.POIFS.Crypt.EncryptionInfo)">
  23017. <summary>
  23018. For a given named property entry, either return it or null if
  23019. if it wasn't found
  23020. </summary>
  23021. <param name="setName">The property to read</param>
  23022. <param name="encryptionInfo">the encryption descriptor in case of cryptoAPI encryption</param>
  23023. <returns>The value of the given property or null if it wasn't found.</returns>
  23024. <exception cref="T:System.IO.IOException">If retrieving properties fails</exception>
  23025. </member>
  23026. <member name="M:NPOI.POIDocument.WriteProperties">
  23027. Writes out the updated standard Document Information Properties (HPSF)
  23028. into the currently open NPOIFSFileSystem
  23029. TODO Implement in-place update
  23030. @throws IOException if an error when writing to the open
  23031. {@link NPOIFSFileSystem} occurs
  23032. TODO throws exception if open from stream not file
  23033. </member>
  23034. <member name="M:NPOI.POIDocument.WriteProperties(NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  23035. <summary>
  23036. Writes out the standard Documment Information Properties (HPSF)
  23037. </summary>
  23038. <param name="outFS">the POIFSFileSystem to Write the properties into</param>
  23039. </member>
  23040. <member name="M:NPOI.POIDocument.WriteProperties(NPOI.POIFS.FileSystem.NPOIFSFileSystem,System.Collections.IList)">
  23041. <summary>
  23042. Writes out the standard Documment Information Properties (HPSF)
  23043. </summary>
  23044. <param name="outFS">the POIFSFileSystem to Write the properties into.</param>
  23045. <param name="writtenEntries">a list of POIFS entries to Add the property names too.</param>
  23046. </member>
  23047. <member name="M:NPOI.POIDocument.WritePropertySet(System.String,NPOI.HPSF.PropertySet,NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  23048. <summary>
  23049. Writes out a given ProperySet
  23050. </summary>
  23051. <param name="name">the (POIFS Level) name of the property to Write.</param>
  23052. <param name="Set">the PropertySet to Write out.</param>
  23053. <param name="outFS">the POIFSFileSystem to Write the property into.</param>
  23054. </member>
  23055. <member name="M:NPOI.POIDocument.ValidateInPlaceWritePossible">
  23056. Called during a {@link #write()} to ensure that the Document (and
  23057. associated {@link POIFSFileSystem}) was opened in a way compatible
  23058. with an in-place write.
  23059. @ if the document was opened suitably
  23060. </member>
  23061. <!-- Badly formed XML comment ignored for member "M:NPOI.POIDocument.Write" -->
  23062. <member name="M:NPOI.POIDocument.Write(System.IO.FileInfo)">
  23063. Writes the document out to the specified new {@link File}. If the file
  23064. exists, it will be replaced, otherwise a new one will be created
  23065. @param newFile The new File to write to.
  23066. @ thrown on errors writing to the file
  23067. </member>
  23068. <member name="M:NPOI.POIDocument.Write(System.IO.Stream)">
  23069. Writes the document out to the specified output stream. The
  23070. stream is not closed as part of this operation.
  23071. Note - if the Document was opened from a {@link File} rather
  23072. than an {@link InputStream}, you <b>must</b> write out using
  23073. {@link #write()} or to a different File. Overwriting the currently
  23074. open file via an OutputStream isn't possible.
  23075. If {@code stream} is a {@link java.io.FileOutputStream} on a networked drive
  23076. or has a high cost/latency associated with each written byte,
  23077. consider wrapping the OutputStream in a {@link java.io.BufferedOutputStream}
  23078. to improve write performance, or use {@link #write()} / {@link #write(File)}
  23079. if possible.
  23080. @param out The stream to write to.
  23081. @ thrown on errors writing to the stream
  23082. </member>
  23083. <member name="M:NPOI.POIDocument.Close">
  23084. Closes the underlying {@link NPOIFSFileSystem} from which
  23085. the document was read, if any. Has no effect on documents
  23086. opened from an InputStream, or newly created ones.
  23087. Once {@link #close()} has been called, no further operations
  23088. should be called on the document.
  23089. </member>
  23090. <member name="T:NPOI.POIFS.Common.POIFSBigBlockSize">
  23091. <p>A class describing attributes of the Big Block Size</p>
  23092. </member>
  23093. <member name="M:NPOI.POIFS.Common.POIFSBigBlockSize.GetHeaderValue">
  23094. Returns the value that Gets written into the
  23095. header.
  23096. Is the power of two that corresponds to the
  23097. size of the block, eg 512 => 9
  23098. </member>
  23099. <member name="T:NPOI.POIFS.Common.POIFSConstants">
  23100. <summary>
  23101. A repository for constants shared by POI classes.
  23102. @author Marc Johnson (mjohnson at apache dot org)
  23103. </summary>
  23104. </member>
  23105. <member name="F:NPOI.POIFS.Common.POIFSConstants.SMALLER_BIG_BLOCK_SIZE">
  23106. Most files use 512 bytes as their big block size
  23107. </member>
  23108. <member name="F:NPOI.POIFS.Common.POIFSConstants.LARGER_BIG_BLOCK_SIZE">
  23109. Some use 4096 bytes
  23110. </member>
  23111. <member name="F:NPOI.POIFS.Common.POIFSConstants.BIG_BLOCK_SIZE">
  23112. Most files use 512 bytes as their big block size
  23113. </member>
  23114. <member name="F:NPOI.POIFS.Common.POIFSConstants.MINI_BLOCK_SIZE">
  23115. Most files use 512 bytes as their big block size
  23116. </member>
  23117. <member name="F:NPOI.POIFS.Common.POIFSConstants.SMALL_BLOCK_SIZE">
  23118. How big a block in the small block stream is. Fixed size
  23119. </member>
  23120. <member name="F:NPOI.POIFS.Common.POIFSConstants.PROPERTY_SIZE">
  23121. How big a single property is
  23122. </member>
  23123. <member name="F:NPOI.POIFS.Common.POIFSConstants.BIG_BLOCK_MINIMUM_DOCUMENT_SIZE">
  23124. The minimum size of a document before it's stored using
  23125. Big Blocks (normal streams). Smaller documents go in the
  23126. Mini Stream (SBAT / Small Blocks)
  23127. </member>
  23128. <member name="F:NPOI.POIFS.Common.POIFSConstants.LARGEST_REGULAR_SECTOR_NUMBER">
  23129. The highest sector number you're allowed, 0xFFFFFFFA
  23130. </member>
  23131. <member name="F:NPOI.POIFS.Common.POIFSConstants.FAT_SECTOR_BLOCK">
  23132. Indicates the sector holds a FAT block (0xFFFFFFFD)
  23133. </member>
  23134. <member name="F:NPOI.POIFS.Common.POIFSConstants.DIFAT_SECTOR_BLOCK">
  23135. Indicates the sector holds a DIFAT block (0xFFFFFFFC)
  23136. </member>
  23137. <member name="F:NPOI.POIFS.Common.POIFSConstants.END_OF_CHAIN">
  23138. Indicates the sector is the end of a chain (0xFFFFFFFE)
  23139. </member>
  23140. <member name="F:NPOI.POIFS.Common.POIFSConstants.UNUSED_BLOCK">
  23141. Indicates the sector is not used (0xFFFFFFFF)
  23142. </member>
  23143. <member name="F:NPOI.POIFS.Common.POIFSConstants.OOXML_FILE_HEADER">
  23144. The first 4 bytes of an OOXML file, used in detection
  23145. </member>
  23146. <member name="F:NPOI.POIFS.Common.POIFSConstants.RAW_XML_FILE_HEADER">
  23147. The first 5 bytes of a raw XML file, used in detection
  23148. </member>
  23149. <member name="M:NPOI.POIFS.Crypt.ChunkedCipherInputStream.RemainingBytes">
  23150. <summary>
  23151. Helper method for forbidden available call - we know the size beforehand, so it's ok ...
  23152. </summary>
  23153. <returns>the remaining byte until EOF</returns>
  23154. </member>
  23155. <member name="M:NPOI.POIFS.Crypt.ChunkedCipherInputStream.InvokeCipher(System.Int32,System.Boolean)">
  23156. <summary>
  23157. Helper function for overriding the cipher invocation, i.e. XOR doesn't use a cipher and uses its own implementation
  23158. </summary>
  23159. <param name="totalBytes">The total bytes.</param>
  23160. <param name="doFinal">The do final.</param>
  23161. <returns></returns>
  23162. </member>
  23163. <member name="M:NPOI.POIFS.Crypt.ChunkedCipherInputStream.ReadPlain(System.Byte[],System.Int32,System.Int32)">
  23164. <summary>
  23165. Used when BIFF header fields (sid, size) are being read. The internal <see cref="T:NPOI.POIFS.Crypt.Cipher"/> instance must step even when unencrypted bytes are read
  23166. </summary>
  23167. <param name="b">The buffet.</param>
  23168. <param name="off">The offset.</param>
  23169. <param name="len">The length.</param>
  23170. <exception cref="T:System.IO.EndOfStreamException">buffer underrun</exception>
  23171. <exception cref="T:NPOI.Util.RuntimeException"></exception>
  23172. </member>
  23173. <member name="M:NPOI.POIFS.Crypt.ChunkedCipherInputStream.SetNextRecordSize(System.Int32)">
  23174. <summary>
  23175. Some ciphers (actually just XOR) are based on the record size, which needs to be set before decryption
  23176. </summary>
  23177. <param name="recordSize">The size of the next record.</param>
  23178. </member>
  23179. <member name="M:NPOI.POIFS.Crypt.ChunkedCipherInputStream.GetChunk">
  23180. <summary>
  23181. Gets the chunk bytes.
  23182. </summary>
  23183. <returns>the chunk bytes</returns>
  23184. </member>
  23185. <member name="M:NPOI.POIFS.Crypt.ChunkedCipherInputStream.GetPlain">
  23186. <summary>
  23187. Gets the plain bytes.
  23188. </summary>
  23189. <returns>the plain bytes</returns>
  23190. </member>
  23191. <member name="M:NPOI.POIFS.Crypt.ChunkedCipherInputStream.GetPos">
  23192. <summary>
  23193. Gets the position.
  23194. </summary>
  23195. <returns>the absolute position in the stream</returns>
  23196. </member>
  23197. <member name="M:NPOI.POIFS.Crypt.CryptoAPI.CryptoAPIDecryptor.InitCipherForBlock(NPOI.POIFS.Crypt.Cipher,System.Int32)">
  23198. Initializes a cipher object for a given block index for decryption
  23199. @param cipher may be null, otherwise the given instance is reset to the new block index
  23200. @param block the block index, e.g. the persist/slide id (hslf)
  23201. @return a new cipher object, if cipher was null, otherwise the reInitialized cipher
  23202. @throws GeneralSecurityException
  23203. </member>
  23204. <member name="M:NPOI.POIFS.Crypt.CryptoAPI.CryptoAPIDecryptor.GetDataStream(NPOI.POIFS.FileSystem.DirectoryNode)">
  23205. Decrypt the Document-/SummaryInformation and other optionally streams.
  23206. Opposed to other crypto modes, cryptoapi is record based and can't be used
  23207. to stream-decrypt a whole file
  23208. @see <a href="http://msdn.microsoft.com/en-us/library/dd943321(v=office.12).aspx">2.3.5.4 RC4 CryptoAPI Encrypted Summary Stream</a>
  23209. </member>
  23210. <member name="M:NPOI.POIFS.Crypt.CryptoAPI.CryptoAPIDecryptor.GetLength">
  23211. @return the length of the stream returned by {@link #getDataStream(DirectoryNode)}
  23212. </member>
  23213. <member name="M:NPOI.POIFS.Crypt.CryptoAPI.CryptoAPIEncryptionInfoBuilder.Initialize(NPOI.POIFS.Crypt.EncryptionInfo,NPOI.Util.ILittleEndianInput)">
  23214. Initialize the builder from a stream
  23215. </member>
  23216. <member name="M:NPOI.POIFS.Crypt.CryptoAPI.CryptoAPIEncryptionInfoBuilder.Initialize(NPOI.POIFS.Crypt.EncryptionInfo,NPOI.POIFS.Crypt.CipherAlgorithm,NPOI.POIFS.Crypt.HashAlgorithm,System.Int32,System.Int32,NPOI.POIFS.Crypt.ChainingMode)">
  23217. Initialize the builder from scratch
  23218. </member>
  23219. <member name="M:NPOI.POIFS.Crypt.CryptoAPI.CryptoAPIEncryptor.InitCipherForBlock(NPOI.POIFS.Crypt.Cipher,System.Int32)">
  23220. Initializes a cipher object for a given block index for encryption
  23221. @param cipher may be null, otherwise the given instance is reset to the new block index
  23222. @param block the block index, e.g. the persist/slide id (hslf)
  23223. @return a new cipher object, if cipher was null, otherwise the reInitialized cipher
  23224. @throws GeneralSecurityException
  23225. </member>
  23226. <member name="M:NPOI.POIFS.Crypt.CryptoAPI.CryptoAPIEncryptor.GetDataStream(NPOI.POIFS.FileSystem.DirectoryNode)">
  23227. Encrypt the Document-/SummaryInformation and other optionally streams.
  23228. Opposed to other crypto modes, cryptoapi is record based and can't be used
  23229. to stream-encrypt a whole file
  23230. @see <a href="http://msdn.microsoft.com/en-us/library/dd943321(v=office.12).aspx">2.3.5.4 RC4 CryptoAPI Encrypted Summary Stream</a>
  23231. </member>
  23232. <member name="T:NPOI.POIFS.Crypt.CryptoFunctions">
  23233. Helper functions used for standard and agile encryption
  23234. </member>
  23235. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.HashPassword(System.String,NPOI.POIFS.Crypt.HashAlgorithm,System.Byte[],System.Int32)">
  23236. <p><cite>2.3.4.7 ECMA-376 Document Encryption Key Generation (Standard Encryption)<br/>
  23237. 2.3.4.11 Encryption Key Generation (Agile Encryption)</cite></p>
  23238. <p>The encryption key for ECMA-376 document encryption [ECMA-376] using agile
  23239. encryption MUST be generated by using the following method, which is derived from PKCS #5:
  23240. <a href="https://www.ietf.org/rfc/rfc2898.txt">Password-Based Cryptography Version 2.0 [RFC2898]</a>.</p>
  23241. <p>Let H() be a hashing algorithm as determined by the PasswordKeyEncryptor.hashAlgorithm
  23242. element, H_n be the hash data of the n-th iteration, and a plus sign (+) represent concatenation.
  23243. The password MUST be provided as an array of Unicode characters. Limitations on the length of the
  23244. password and the characters used by the password are implementation-dependent.
  23245. The initial password hash is generated as follows:</p>
  23246. <pre>H_0 = H(salt + password)</pre>
  23247. <p>The salt used MUST be generated randomly. The salt MUST be stored in the
  23248. PasswordKeyEncryptor.saltValue element contained within the \EncryptionInfo stream as
  23249. specified in section 2.3.4.10. The hash is then iterated by using the following approach:</p>
  23250. <pre>H_n = H(iterator + H_n-1)</pre>
  23251. <p>where iterator is an unsigned 32-bit value that is initially set to 0x00000000 and then incremented
  23252. monotonically on each iteration until PasswordKey.spinCount iterations have been performed.
  23253. The value of iterator on the last iteration MUST be one less than PasswordKey.spinCount.</p>
  23254. <p>For POI, H_final will be calculated by {@link #generateKey(byte[],HashAlgorithm,byte[],int)}</p>
  23255. @param password
  23256. @param hashAlgorithm
  23257. @param salt
  23258. @param spinCount
  23259. @return the hashed password
  23260. </member>
  23261. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.HashPassword(System.String,NPOI.POIFS.Crypt.HashAlgorithm,System.Byte[],System.Int32,System.Boolean)">
  23262. Generalized method for read and write protection hash generation.
  23263. The difference is, read protection uses the order iterator then hash in the hash loop, whereas write protection
  23264. uses first the last hash value and then the current iterator value
  23265. @param password
  23266. @param hashAlgorithm
  23267. @param salt
  23268. @param spinCount
  23269. @param iteratorFirst if true, the iterator is hashed before the n-1 hash value,
  23270. if false the n-1 hash value is applied first
  23271. @return the hashed password
  23272. </member>
  23273. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.GenerateIv(NPOI.POIFS.Crypt.HashAlgorithm,System.Byte[],System.Byte[],System.Int32)">
  23274. <p><cite>2.3.4.12 Initialization Vector Generation (Agile Encryption)</cite></p>
  23275. <p>Initialization vectors are used in all cases for agile encryption. An initialization vector MUST be
  23276. generated by using the following method, where H() is a hash function that MUST be the same as
  23277. specified in section 2.3.4.11 and a plus sign (+) represents concatenation:</p>
  23278. <ul>
  23279. <li>If a blockKey is provided, let IV be a hash of the KeySalt and the following value:<br/>
  23280. {@code blockKey: IV = H(KeySalt + blockKey)}</li>
  23281. <li>If a blockKey is not provided, let IV be equal to the following value:<br/>
  23282. {@code KeySalt:IV = KeySalt}</li>
  23283. <li>If the number of bytes in the value of IV is less than the the value of the blockSize attribute
  23284. corresponding to the cipherAlgorithm attribute, pad the array of bytes by appending 0x36 until
  23285. the array is blockSize bytes. If the array of bytes is larger than blockSize bytes, truncate the
  23286. array to blockSize bytes.</li>
  23287. </ul>
  23288. </member>
  23289. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.GenerateKey(System.Byte[],NPOI.POIFS.Crypt.HashAlgorithm,System.Byte[],System.Int32)">
  23290. <p><cite>2.3.4.11 Encryption Key Generation (Agile Encryption)</cite></p>
  23291. <p>The final hash data that is used for an encryption key is then generated by using the following
  23292. method:</p>
  23293. <pre>H_final = H(H_n + blockKey)</pre>
  23294. <p>where blockKey represents an array of bytes used to prevent two different blocks from encrypting
  23295. to the same cipher text.</p>
  23296. <p>If the size of the resulting H_final is smaller than that of PasswordKeyEncryptor.keyBits, the key
  23297. MUST be padded by appending bytes with a value of 0x36. If the hash value is larger in size than
  23298. PasswordKeyEncryptor.keyBits, the key is obtained by truncating the hash value.</p>
  23299. @param passwordHash
  23300. @param hashAlgorithm
  23301. @param blockKey
  23302. @param keySize
  23303. @return intermediate key
  23304. </member>
  23305. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.GetCipher(NPOI.POIFS.Crypt.ISecretKey,NPOI.POIFS.Crypt.CipherAlgorithm,NPOI.POIFS.Crypt.ChainingMode,System.Byte[],System.Int32)">
  23306. Initialize a new cipher object with the given cipher properties and no padding
  23307. If the given algorithm is not implemented in the JCE, it will try to load it from the bouncy castle
  23308. provider.
  23309. @param key the secrect key
  23310. @param cipherAlgorithm the cipher algorithm
  23311. @param chain the chaining mode
  23312. @param vec the initialization vector (IV), can be null
  23313. @param cipherMode Cipher.DECRYPT_MODE or Cipher.ENCRYPT_MODE
  23314. @return the requested cipher
  23315. @throws GeneralSecurityException
  23316. @throws EncryptedDocumentException if the initialization failed or if an algorithm was specified,
  23317. which depends on a missing bouncy castle provider
  23318. </member>
  23319. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.GetCipher(NPOI.POIFS.Crypt.IKey,NPOI.POIFS.Crypt.CipherAlgorithm,NPOI.POIFS.Crypt.ChainingMode,System.Byte[],System.Int32,System.String)">
  23320. Initialize a new cipher object with the given cipher properties
  23321. If the given algorithm is not implemented in the JCE, it will try to load it from the bouncy castle
  23322. provider.
  23323. @param key the secrect key
  23324. @param cipherAlgorithm the cipher algorithm
  23325. @param chain the chaining mode
  23326. @param vec the Initialization vector (IV), can be null
  23327. @param cipherMode Cipher.DECRYPT_MODE or Cipher.ENCRYPT_MODE
  23328. @param padding the padding (null = NOPADDING, ANSIX923Padding, PKCS5Padding, PKCS7Padding, ISO10126Padding, ...)
  23329. @return the requested cipher
  23330. @throws GeneralSecurityException
  23331. @throws EncryptedDocumentException if the Initialization failed or if an algorithm was specified,
  23332. which depends on a missing bouncy castle provider
  23333. </member>
  23334. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.GetBlock36(System.Byte[],System.Int32)">
  23335. Returns a new byte array with a tRuncated to the given size.
  23336. If the hash has less then size bytes, it will be Filled with 0x36-bytes
  23337. @param hash the to be tRuncated/filled hash byte array
  23338. @param size the size of the returned byte array
  23339. @return the pAdded hash
  23340. </member>
  23341. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.GetBlock0(System.Byte[],System.Int32)">
  23342. Returns a new byte array with a tRuncated to the given size.
  23343. If the hash has less then size bytes, it will be Filled with 0-bytes
  23344. @param hash the to be tRuncated/filled hash byte array
  23345. @param size the size of the returned byte array
  23346. @return the pAdded hash
  23347. </member>
  23348. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.CreateXorVerifier1(System.String)">
  23349. Create the verifier for xor obfuscation (method 1)
  23350. @see <a href="http://msdn.microsoft.com/en-us/library/dd926947.aspx">2.3.7.1 Binary Document Password Verifier Derivation Method 1</a>
  23351. @see <a href="http://msdn.microsoft.com/en-us/library/dd905229.aspx">2.3.7.4 Binary Document Password Verifier Derivation Method 2</a>
  23352. @see <a href="http://www.ecma-international.org/news/TC45_current_work/Office Open XML Part 4 - Markup Language Reference.pdf">Part 4 - Markup Language Reference - Ecma International - 3.2.12 fileSharing</a>
  23353. @param password the password
  23354. @return the verifier (actually a short value)
  23355. </member>
  23356. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.CreateXorVerifier2(System.String)">
  23357. This method generates the xor verifier for word documents &lt; 2007 (method 2).
  23358. Its output will be used as password input for the newer word generations which
  23359. utilize a real hashing algorithm like sha1.
  23360. @param password the password
  23361. @return the hashed password
  23362. @see <a href="http://msdn.microsoft.com/en-us/library/dd905229.aspx">2.3.7.4 Binary Document Password Verifier Derivation Method 2</a>
  23363. @see <a href="http://blogs.msdn.com/b/vsod/archive/2010/04/05/how-to-set-the-editing-restrictions-in-word-using-open-xml-sdk-2-0.aspx">How to Set the editing restrictions in Word using Open XML SDK 2.0</a>
  23364. @see <a href="http://www.aspose.com/blogs/aspose-blogs/vladimir-averkin/archive/2007/08/20/funny-how-the-new-powerful-cryptography-implemented-in-word-2007-turns-it-into-a-perfect-tool-for-document-password-removal.html">Funny: How the new powerful cryptography implemented in Word 2007 turns it into a perfect tool for document password removal.</a>
  23365. </member>
  23366. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.XorHashPassword(System.String)">
  23367. This method generates the xored-hashed password for word documents &lt; 2007.
  23368. </member>
  23369. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.XorHashPasswordReversed(System.String)">
  23370. Convenience function which returns the reversed xored-hashed password for further
  23371. Processing in word documents 2007 and newer, which utilize a real hashing algorithm like sha1.
  23372. </member>
  23373. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.CreateXorKey1(System.String)">
  23374. Create the xor key for xor obfuscation, which is used to create the xor array (method 1)
  23375. @see <a href="http://msdn.microsoft.com/en-us/library/dd924704.aspx">2.3.7.2 Binary Document XOR Array Initialization Method 1</a>
  23376. @see <a href="http://msdn.microsoft.com/en-us/library/dd905229.aspx">2.3.7.4 Binary Document Password Verifier Derivation Method 2</a>
  23377. @param password the password
  23378. @return the xor key
  23379. </member>
  23380. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.CreateXorArray1(System.String)">
  23381. Creates an byte array for xor obfuscation (method 1)
  23382. @see <a href="http://msdn.microsoft.com/en-us/library/dd924704.aspx">2.3.7.2 Binary Document XOR Array Initialization Method 1</a>
  23383. @see <a href="http://docs.libreoffice.org/oox/html/binarycodec_8cxx_source.html">Libre Office implementation</a>
  23384. @param password the password
  23385. @return the byte array for xor obfuscation
  23386. </member>
  23387. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.toAnsiPassword(System.String)">
  23388. The provided Unicode password string is converted to a ANSI string
  23389. @param password the password
  23390. @return the ansi bytes
  23391. @see <a href="http://www.ecma-international.org/news/TC45_current_work/Office Open XML Part 4 - Markup Language Reference.pdf">Part 4 - Markup Language Reference - Ecma International</a> (3.2.29 workbookProtection)
  23392. </member>
  23393. <member name="M:NPOI.POIFS.Crypt.Decryptor.GetDataStream(NPOI.POIFS.FileSystem.DirectoryNode)">
  23394. Return a stream with decrypted data.
  23395. <p>
  23396. Use {@link #getLength()} to Get the size of that data that can be safely read from the stream.
  23397. Just Reading to the end of the input stream is not sufficient because there are
  23398. normally pAdding bytes that must be discarded
  23399. </p>
  23400. @param dir the node to read from
  23401. @return decrypted stream
  23402. </member>
  23403. <member name="M:NPOI.POIFS.Crypt.Decryptor.GetLength">
  23404. Returns the length of the encrypted data that can be safely read with
  23405. {@link #getDataStream(NPOI.POIFS.FileSystem.DirectoryNode)}.
  23406. Just Reading to the end of the input stream is not sufficient because there are
  23407. normally pAdding bytes that must be discarded
  23408. <p>
  23409. The length variable is Initialized in {@link #getDataStream(NPOI.POIFS.FileSystem.DirectoryNode)},
  23410. an attempt to call GetLength() prior to GetDataStream() will result in InvalidOperationException.
  23411. </p>
  23412. @return length of the encrypted data
  23413. @throws InvalidOperationException if {@link #getDataStream(NPOI.POIFS.FileSystem.DirectoryNode)}
  23414. was not called
  23415. </member>
  23416. <member name="T:NPOI.POIFS.Crypt.EncryptionHeader">
  23417. Reads and Processes OOXML Encryption Headers
  23418. The constants are largely based on ZIP constants.
  23419. </member>
  23420. <member name="M:NPOI.POIFS.Crypt.EncryptionHeader.GetCipherMode">
  23421. @deprecated use GetChainingMode().ecmaId
  23422. </member>
  23423. <member name="F:NPOI.POIFS.Crypt.EncryptionInfo.flagCryptoAPI">
  23424. A flag that specifies whether CryptoAPI RC4 or ECMA-376 encryption
  23425. ECMA-376 is used. It MUST be 1 unless flagExternal is 1. If flagExternal is 1, it MUST be 0.
  23426. </member>
  23427. <member name="F:NPOI.POIFS.Crypt.EncryptionInfo.flagDocProps">
  23428. A value that MUST be 0 if document properties are encrypted.
  23429. The encryption of document properties is specified in section 2.3.5.4.
  23430. </member>
  23431. <member name="F:NPOI.POIFS.Crypt.EncryptionInfo.flagExternal">
  23432. A value that MUST be 1 if extensible encryption is used. If this value is 1,
  23433. the value of every other field in this structure MUST be 0.
  23434. </member>
  23435. <member name="F:NPOI.POIFS.Crypt.EncryptionInfo.flagAES">
  23436. A value that MUST be 1 if the protected content is an ECMA-376 document
  23437. ECMA-376. If the fAES bit is 1, the fCryptoAPI bit MUST also be 1.
  23438. </member>
  23439. <member name="M:NPOI.POIFS.Crypt.EncryptionInfo.#ctor(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  23440. Opens for decryption
  23441. </member>
  23442. <member name="M:NPOI.POIFS.Crypt.EncryptionInfo.#ctor(NPOI.POIFS.FileSystem.OPOIFSFileSystem)">
  23443. Opens for decryption
  23444. </member>
  23445. <member name="M:NPOI.POIFS.Crypt.EncryptionInfo.#ctor(NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  23446. Opens for decryption
  23447. </member>
  23448. <member name="M:NPOI.POIFS.Crypt.EncryptionInfo.#ctor(NPOI.POIFS.FileSystem.DirectoryNode)">
  23449. Opens for decryption
  23450. </member>
  23451. <member name="M:NPOI.POIFS.Crypt.EncryptionInfo.#ctor(NPOI.POIFS.FileSystem.POIFSFileSystem,NPOI.POIFS.Crypt.EncryptionMode)">
  23452. @deprecated Use {@link #EncryptionInfo(EncryptionMode)} (fs parameter no longer required)
  23453. </member>
  23454. <member name="M:NPOI.POIFS.Crypt.EncryptionInfo.#ctor(NPOI.POIFS.FileSystem.NPOIFSFileSystem,NPOI.POIFS.Crypt.EncryptionMode)">
  23455. @deprecated Use {@link #EncryptionInfo(EncryptionMode)} (fs parameter no longer required)
  23456. </member>
  23457. <member name="M:NPOI.POIFS.Crypt.EncryptionInfo.#ctor(NPOI.POIFS.FileSystem.DirectoryNode,NPOI.POIFS.Crypt.EncryptionMode)">
  23458. @deprecated Use {@link #EncryptionInfo(EncryptionMode)} (dir parameter no longer required)
  23459. </member>
  23460. <member name="M:NPOI.POIFS.Crypt.EncryptionInfo.#ctor(NPOI.POIFS.FileSystem.POIFSFileSystem,NPOI.POIFS.Crypt.EncryptionMode,NPOI.POIFS.Crypt.CipherAlgorithm,NPOI.POIFS.Crypt.HashAlgorithm,System.Int32,System.Int32,NPOI.POIFS.Crypt.ChainingMode)">
  23461. @deprecated use {@link #EncryptionInfo(EncryptionMode, CipherAlgorithm, HashAlgorithm, int, int, ChainingMode)}
  23462. </member>
  23463. <member name="M:NPOI.POIFS.Crypt.EncryptionInfo.#ctor(NPOI.POIFS.FileSystem.NPOIFSFileSystem,NPOI.POIFS.Crypt.EncryptionMode,NPOI.POIFS.Crypt.CipherAlgorithm,NPOI.POIFS.Crypt.HashAlgorithm,System.Int32,System.Int32,NPOI.POIFS.Crypt.ChainingMode)">
  23464. @deprecated use {@link #EncryptionInfo(EncryptionMode, CipherAlgorithm, HashAlgorithm, int, int, ChainingMode)}
  23465. </member>
  23466. <member name="M:NPOI.POIFS.Crypt.EncryptionInfo.#ctor(NPOI.POIFS.FileSystem.DirectoryNode,NPOI.POIFS.Crypt.EncryptionMode,NPOI.POIFS.Crypt.CipherAlgorithm,NPOI.POIFS.Crypt.HashAlgorithm,System.Int32,System.Int32,NPOI.POIFS.Crypt.ChainingMode)">
  23467. @deprecated use {@link #EncryptionInfo(EncryptionMode, CipherAlgorithm, HashAlgorithm, int, int, ChainingMode)}
  23468. </member>
  23469. <member name="M:NPOI.POIFS.Crypt.EncryptionInfo.#ctor(NPOI.POIFS.Crypt.EncryptionMode)">
  23470. Prepares for encryption, using the given Encryption Mode, and
  23471. all other parameters as default.
  23472. @see #EncryptionInfo(EncryptionMode, CipherAlgorithm, HashAlgorithm, int, int, ChainingMode)
  23473. </member>
  23474. <member name="M:NPOI.POIFS.Crypt.EncryptionInfo.#ctor(NPOI.POIFS.Crypt.EncryptionMode,NPOI.POIFS.Crypt.CipherAlgorithm,NPOI.POIFS.Crypt.HashAlgorithm,System.Int32,System.Int32,NPOI.POIFS.Crypt.ChainingMode)">
  23475. Constructs an EncryptionInfo from scratch
  23476. @param encryptionMode see {@link EncryptionMode} for values, {@link EncryptionMode#cryptoAPI} is for
  23477. internal use only, as it's record based
  23478. @param cipherAlgorithm
  23479. @param hashAlgorithm
  23480. @param keyBits
  23481. @param blockSize
  23482. @param chainingMode
  23483. @throws EncryptedDocumentException if the given parameters mismatch, e.g. only certain combinations
  23484. of keyBits, blockSize are allowed for a given {@link CipherAlgorithm}
  23485. </member>
  23486. <member name="M:NPOI.POIFS.Crypt.IEncryptionInfoBuilder.Initialize(NPOI.POIFS.Crypt.EncryptionInfo,NPOI.Util.ILittleEndianInput)">
  23487. Initialize the builder from a stream
  23488. </member>
  23489. <member name="M:NPOI.POIFS.Crypt.IEncryptionInfoBuilder.Initialize(NPOI.POIFS.Crypt.EncryptionInfo,NPOI.POIFS.Crypt.CipherAlgorithm,NPOI.POIFS.Crypt.HashAlgorithm,System.Int32,System.Int32,NPOI.POIFS.Crypt.ChainingMode)">
  23490. Initialize the builder from scratch
  23491. </member>
  23492. <member name="M:NPOI.POIFS.Crypt.IEncryptionInfoBuilder.GetHeader">
  23493. @return the header data
  23494. </member>
  23495. <member name="M:NPOI.POIFS.Crypt.IEncryptionInfoBuilder.GetVerifier">
  23496. @return the verifier data
  23497. </member>
  23498. <member name="M:NPOI.POIFS.Crypt.IEncryptionInfoBuilder.GetDecryptor">
  23499. @return the decryptor
  23500. </member>
  23501. <member name="M:NPOI.POIFS.Crypt.IEncryptionInfoBuilder.GetEncryptor">
  23502. @return the encryptor
  23503. </member>
  23504. <member name="T:NPOI.POIFS.Crypt.EncryptionMode">
  23505. Office supports various encryption modes.
  23506. The encryption is either based on the whole Container ({@link #agile}, {@link #standard} or {@link #binaryRC4})
  23507. or record based ({@link #cryptoAPI}). The record based encryption can't be accessed directly, but will be
  23508. invoked by using the {@link Biff8EncryptionKey#setCurrentUserPassword(String)} before saving the document.
  23509. </member>
  23510. <member name="T:NPOI.POIFS.Crypt.EncryptionVerifier">
  23511. Used when Checking if a key is valid for a document
  23512. </member>
  23513. <member name="M:NPOI.POIFS.Crypt.EncryptionVerifier.GetVerifier">
  23514. The method name is misleading - you'll Get the encrypted verifier, not the plain verifier
  23515. @deprecated use GetEncryptedVerifier()
  23516. </member>
  23517. <member name="M:NPOI.POIFS.Crypt.EncryptionVerifier.GetVerifierHash">
  23518. The method name is misleading - you'll Get the encrypted verifier hash, not the plain verifier hash
  23519. @deprecated use GetEnryptedVerifierHash
  23520. </member>
  23521. <member name="M:NPOI.POIFS.Crypt.EncryptionVerifier.GetAlgorithmName">
  23522. @deprecated use GetCipherAlgorithm().jceId
  23523. </member>
  23524. <member name="M:NPOI.POIFS.Crypt.Encryptor.GetDataStream(NPOI.POIFS.FileSystem.DirectoryNode)">
  23525. Return a output stream for encrypted data.
  23526. @param dir the node to write to
  23527. @return encrypted stream
  23528. </member>
  23529. <member name="T:NPOI.POIFS.Crypt.Standard.StandardDecryptor">
  23530. </member>
  23531. <member name="M:NPOI.POIFS.Crypt.Standard.StandardDecryptor.GetLength">
  23532. @return the length of the stream returned by {@link #getDataStream(DirectoryNode)}
  23533. </member>
  23534. <member name="M:NPOI.POIFS.Crypt.Standard.StandardEncryptionHeader.Write(NPOI.Util.LittleEndianByteArrayOutputStream)">
  23535. Serializes the header
  23536. </member>
  23537. <member name="M:NPOI.POIFS.Crypt.Standard.StandardEncryptionInfoBuilder.Initialize(NPOI.POIFS.Crypt.EncryptionInfo,NPOI.Util.ILittleEndianInput)">
  23538. Initialize the builder from a stream
  23539. </member>
  23540. <member name="M:NPOI.POIFS.Crypt.Standard.StandardEncryptionInfoBuilder.Initialize(NPOI.POIFS.Crypt.EncryptionInfo,NPOI.POIFS.Crypt.CipherAlgorithm,NPOI.POIFS.Crypt.HashAlgorithm,System.Int32,System.Int32,NPOI.POIFS.Crypt.ChainingMode)">
  23541. Initialize the builder from scratch
  23542. </member>
  23543. <member name="T:NPOI.POIFS.Crypt.Standard.StandardEncryptionVerifier">
  23544. Used when Checking if a key is valid for a document
  23545. </member>
  23546. <member name="M:NPOI.POIFS.Crypt.Standard.StandardEncryptor.ConfirmPassword(System.String,System.Byte[],System.Byte[],System.Byte[],System.Byte[],System.Byte[])">
  23547. Fills the fields of verifier and header with the calculated hashes based
  23548. on the password and a random salt
  23549. see [MS-OFFCRYPTO] - 2.3.4.7 ECMA-376 Document Encryption Key Generation
  23550. </member>
  23551. <member name="T:NPOI.POIFS.Dev.POIFSViewable">
  23552. <summary>
  23553. Interface for a drill-down viewable object. Such an object has
  23554. content that may or may not be displayed, at the discretion of the
  23555. viewer. The content is returned to the viewer as an array or as an
  23556. Iterator, and the object provides a clue as to which technique the
  23557. viewer should use to get its content.
  23558. A POIFSViewable object is also expected to provide a short
  23559. description of itself, that can be used by a viewer when the
  23560. viewable object is collapsed.
  23561. @author Marc Johnson (mjohnson at apache dot org)
  23562. </summary>
  23563. </member>
  23564. <member name="P:NPOI.POIFS.Dev.POIFSViewable.PreferArray">
  23565. <summary>
  23566. Provides a short description of the object to be used when a
  23567. POIFSViewable object has not provided its contents.
  23568. </summary>
  23569. <value><c>true</c> if [prefer array]; otherwise, <c>false</c>.</value>
  23570. </member>
  23571. <member name="P:NPOI.POIFS.Dev.POIFSViewable.ShortDescription">
  23572. <summary>
  23573. Gets the short description.
  23574. </summary>
  23575. <value>The short description.</value>
  23576. </member>
  23577. <member name="P:NPOI.POIFS.Dev.POIFSViewable.ViewableArray">
  23578. <summary>
  23579. Get an array of objects, some of which may implement POIFSViewable
  23580. </summary>
  23581. <value>The viewable array.</value>
  23582. </member>
  23583. <member name="P:NPOI.POIFS.Dev.POIFSViewable.ViewableIterator">
  23584. <summary>
  23585. Give viewers a hint as to whether to call ViewableArray or ViewableIterator
  23586. </summary>
  23587. <value>The viewable iterator.</value>
  23588. </member>
  23589. <member name="T:NPOI.POIFS.Dev.POIFSViewEngine">
  23590. <summary>
  23591. This class contains methods used to inspect POIFSViewable objects
  23592. @author Marc Johnson (mjohnson at apache dot org)
  23593. </summary>
  23594. </member>
  23595. <member name="M:NPOI.POIFS.Dev.POIFSViewEngine.InspectViewable(System.Object,System.Boolean,System.Int32,System.String)">
  23596. <summary>
  23597. Inspect an object that may be viewable, and drill down if told to
  23598. </summary>
  23599. <param name="viewable">the object to be viewed</param>
  23600. <param name="drilldown">if <c>true</c> and the object implements POIFSViewable, inspect the objects' contents</param>
  23601. <param name="indentLevel">how far in to indent each string</param>
  23602. <param name="indentString">string to use for indenting</param>
  23603. <returns>a List of Strings holding the content</returns>
  23604. </member>
  23605. <member name="M:NPOI.POIFS.Dev.POIFSViewEngine.Indent(System.Int32,System.String,System.String)">
  23606. <summary>
  23607. Indents the specified indent level.
  23608. </summary>
  23609. <param name="indentLevel">how far in to indent each string</param>
  23610. <param name="indentString">string to use for indenting</param>
  23611. <param name="data">The data.</param>
  23612. <returns></returns>
  23613. </member>
  23614. <member name="T:NPOI.POIFS.EventFileSystem.POIFSReader">
  23615. <summary>
  23616. An event-driven Reader for POIFS file systems. Users of this class
  23617. first Create an instance of it, then use the RegisterListener
  23618. methods to Register POIFSReaderListener instances for specific
  23619. documents. Once all the listeners have been Registered, the Read()
  23620. method is called, which results in the listeners being notified as
  23621. their documents are Read.
  23622. @author Marc Johnson (mjohnson at apache dot org)
  23623. </summary>
  23624. </member>
  23625. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.#ctor">
  23626. <summary>
  23627. Initializes a new instance of the <see cref="T:NPOI.POIFS.EventFileSystem.POIFSReader"/> class.
  23628. </summary>
  23629. </member>
  23630. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.Read(System.IO.Stream)">
  23631. <summary>
  23632. Read from an InputStream and Process the documents we Get
  23633. </summary>
  23634. <param name="stream">the InputStream from which to Read the data</param>
  23635. <returns>POIFSDocument list</returns>
  23636. </member>
  23637. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.RegisterListener(NPOI.POIFS.EventFileSystem.POIFSReaderListener)">
  23638. Register a POIFSReaderListener for all documents
  23639. @param listener the listener to be registered
  23640. @exception NullPointerException if listener is null
  23641. @exception InvalidOperationException if read() has already been
  23642. called
  23643. </member>
  23644. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.RegisterListener(NPOI.POIFS.EventFileSystem.POIFSReaderListener,System.String)">
  23645. Register a POIFSReaderListener for a document in the root
  23646. directory
  23647. @param listener the listener to be registered
  23648. @param name the document name
  23649. @exception NullPointerException if listener is null or name is
  23650. null or empty
  23651. @exception InvalidOperationException if read() has already been
  23652. called
  23653. </member>
  23654. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.RegisterListener(NPOI.POIFS.EventFileSystem.POIFSReaderListener,NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String)">
  23655. Register a POIFSReaderListener for a document in the specified
  23656. directory
  23657. @param listener the listener to be registered
  23658. @param path the document path; if null, the root directory is
  23659. assumed
  23660. @param name the document name
  23661. @exception NullPointerException if listener is null or name is
  23662. null or empty
  23663. @exception InvalidOperationException if read() has already been
  23664. called
  23665. </member>
  23666. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.ProcessProperties(NPOI.POIFS.Storage.BlockList,NPOI.POIFS.Storage.BlockList,System.Collections.IEnumerator,NPOI.POIFS.FileSystem.POIFSDocumentPath)">
  23667. <summary>
  23668. Processes the properties.
  23669. </summary>
  23670. <param name="small_blocks">The small_blocks.</param>
  23671. <param name="big_blocks">The big_blocks.</param>
  23672. <param name="properties">The properties.</param>
  23673. <param name="path">The path.</param>
  23674. <returns></returns>
  23675. </member>
  23676. <member name="T:NPOI.POIFS.EventFileSystem.POIFSReaderEvent">
  23677. Class POIFSReaderEvent
  23678. @author Marc Johnson (mjohnson at apache dot org)
  23679. @version %I%, %G%
  23680. </member>
  23681. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderEvent.#ctor(NPOI.POIFS.FileSystem.DocumentInputStream,NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String)">
  23682. package scoped constructor
  23683. @param stream the DocumentInputStream, freshly opened
  23684. @param path the path of the document
  23685. @param documentName the name of the document
  23686. </member>
  23687. <member name="P:NPOI.POIFS.EventFileSystem.POIFSReaderEvent.Stream">
  23688. @return the DocumentInputStream, freshly opened
  23689. </member>
  23690. <member name="P:NPOI.POIFS.EventFileSystem.POIFSReaderEvent.Path">
  23691. @return the document's path
  23692. </member>
  23693. <member name="P:NPOI.POIFS.EventFileSystem.POIFSReaderEvent.Name">
  23694. @return the document's name
  23695. </member>
  23696. <member name="T:NPOI.POIFS.EventFileSystem.POIFSReaderEventArgs">
  23697. <summary>
  23698. EventArgs for POIFSReader
  23699. author: Tony Qu
  23700. </summary>
  23701. </member>
  23702. <member name="T:NPOI.POIFS.EventFileSystem.POIFSReaderListener">
  23703. Interface POIFSReaderListener
  23704. @author Marc Johnson (mjohnson at apache dot org)
  23705. @version %I%, %G%
  23706. </member>
  23707. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderListener.ProcessPOIFSReaderEvent(NPOI.POIFS.EventFileSystem.POIFSReaderEvent)">
  23708. Process a POIFSReaderEvent that this listener had Registered
  23709. for
  23710. @param event the POIFSReaderEvent
  23711. </member>
  23712. <member name="T:NPOI.POIFS.EventFileSystem.POIFSReaderRegistry">
  23713. A registry for POIFSReaderListeners and the DocumentDescriptors of
  23714. the documents those listeners are interested in
  23715. @author Marc Johnson (mjohnson at apache dot org)
  23716. @version %I%, %G%
  23717. </member>
  23718. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderRegistry.#ctor">
  23719. Construct the registry
  23720. </member>
  23721. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderRegistry.RegisterListener(NPOI.POIFS.EventFileSystem.POIFSReaderListener,NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String)">
  23722. Register a POIFSReaderListener for a particular document
  23723. @param listener the listener
  23724. @param path the path of the document of interest
  23725. @param documentName the name of the document of interest
  23726. </member>
  23727. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderRegistry.RegisterListener(NPOI.POIFS.EventFileSystem.POIFSReaderListener)">
  23728. Register for all documents
  23729. @param listener the listener who wants to Get all documents
  23730. </member>
  23731. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderRegistry.GetListeners(NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String)">
  23732. Get am iterator of listeners for a particular document
  23733. @param path the document path
  23734. @param name the name of the document
  23735. @return an Iterator POIFSReaderListeners; may be empty
  23736. </member>
  23737. <member name="T:NPOI.POIFS.EventFileSystem.POIFSWriterEvent">
  23738. Class POIFSWriterEvent
  23739. @author Marc Johnson (mjohnson at apache dot org)
  23740. @version %I%, %G%
  23741. </member>
  23742. <member name="M:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.#ctor(NPOI.POIFS.FileSystem.DocumentOutputStream,NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String,System.Int32)">
  23743. namespace scoped constructor
  23744. @param stream the DocumentOutputStream, freshly opened
  23745. @param path the path of the document
  23746. @param documentName the name of the document
  23747. @param limit the limit, in bytes, that can be written to the
  23748. stream
  23749. </member>
  23750. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.Stream">
  23751. @return the DocumentOutputStream, freshly opened
  23752. </member>
  23753. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.Path">
  23754. @return the document's path
  23755. </member>
  23756. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.Name">
  23757. @return the document's name
  23758. </member>
  23759. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.Limit">
  23760. @return the limit on writing, in bytes
  23761. </member>
  23762. <member name="T:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs">
  23763. <summary>
  23764. EventArgs for POIFSWriter
  23765. author: Tony Qu
  23766. </summary>
  23767. </member>
  23768. <member name="M:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.#ctor(NPOI.POIFS.FileSystem.DocumentOutputStream,NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String,System.Int32)">
  23769. <summary>
  23770. Initializes a new instance of the <see cref="T:NPOI.POIFS.EventFileSystem.POIFSWriterEvent"/> class.
  23771. </summary>
  23772. <param name="stream">the POIFSDocumentWriter, freshly opened</param>
  23773. <param name="path">the path of the document</param>
  23774. <param name="documentName">the name of the document</param>
  23775. <param name="limit">the limit, in bytes, that can be written to the stream</param>
  23776. </member>
  23777. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.Limit">
  23778. <summary>
  23779. Gets the limit on writing, in bytes
  23780. </summary>
  23781. <value>The limit.</value>
  23782. </member>
  23783. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.Name">
  23784. <summary>
  23785. Gets the document's name
  23786. </summary>
  23787. <value>The name.</value>
  23788. </member>
  23789. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.Path">
  23790. <summary>
  23791. Gets the document's path
  23792. </summary>
  23793. <value>The path.</value>
  23794. </member>
  23795. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.Stream">
  23796. <summary>
  23797. the POIFSDocumentWriter, freshly opened
  23798. </summary>
  23799. <value>The stream.</value>
  23800. </member>
  23801. <member name="T:NPOI.POIFS.EventFileSystem.POIFSWriterListener">
  23802. Interface POIFSWriterListener
  23803. @author Marc Johnson (mjohnson at apache dot org)
  23804. @version %I%, %G%
  23805. </member>
  23806. <member name="M:NPOI.POIFS.EventFileSystem.POIFSWriterListener.ProcessPOIFSWriterEvent(NPOI.POIFS.EventFileSystem.POIFSWriterEvent)">
  23807. Process a POIFSWriterEvent that this listener had registered
  23808. for
  23809. @param event the POIFSWriterEvent
  23810. </member>
  23811. <member name="T:NPOI.POIFS.FileSystem.BATManaged">
  23812. <summary>
  23813. This interface defines behaviors for objects managed by the Block
  23814. Allocation Table (BAT).
  23815. @author Marc Johnson (mjohnson at apache dot org)
  23816. </summary>
  23817. </member>
  23818. <member name="P:NPOI.POIFS.FileSystem.BATManaged.CountBlocks">
  23819. <summary>
  23820. Gets the number of BigBlock's this instance uses
  23821. </summary>
  23822. <value>count of BigBlock instances</value>
  23823. </member>
  23824. <member name="P:NPOI.POIFS.FileSystem.BATManaged.StartBlock">
  23825. <summary>
  23826. Sets the start block for this instance
  23827. </summary>
  23828. <value>index into the array of BigBlock instances making up the the filesystem</value>
  23829. </member>
  23830. <member name="T:NPOI.POIFS.FileSystem.BlockStore">
  23831. <summary>
  23832. This abstract class describes a way to read, store, chain
  23833. and free a series of blocks (be they Big or Small ones)
  23834. </summary>
  23835. </member>
  23836. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetBlockStoreBlockSize">
  23837. <summary>
  23838. Returns the size of the blocks managed through the block store.
  23839. </summary>
  23840. <returns></returns>
  23841. </member>
  23842. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetBlockAt(System.Int32)">
  23843. <summary>
  23844. Load the block at the given offset.
  23845. </summary>
  23846. <param name="offset"></param>
  23847. <returns></returns>
  23848. </member>
  23849. <member name="M:NPOI.POIFS.FileSystem.BlockStore.TryGetBlockAt(System.Int32,NPOI.Util.ByteBuffer@)">
  23850. <summary>
  23851. Tries to load the block at the given offset.
  23852. </summary>
  23853. <param name="offset">An offset in the buffer, 0 or greater.</param>
  23854. <param name="byteBuffer">The resulting buffer, if possible.</param>
  23855. <returns>True if it was possible to load the block from the specified offset, false if the offset is beyond the size of the buffer.</returns>
  23856. </member>
  23857. <member name="M:NPOI.POIFS.FileSystem.BlockStore.CreateBlockIfNeeded(System.Int32)">
  23858. <summary>
  23859. Extends the file if required to hold blocks up to
  23860. the specified offset, and return the block from there.
  23861. </summary>
  23862. <param name="offset"></param>
  23863. <returns></returns>
  23864. </member>
  23865. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetBATBlockAndIndex(System.Int32)">
  23866. <summary>
  23867. Returns the BATBlock that handles the specified offset,
  23868. and the relative index within it
  23869. </summary>
  23870. <param name="offset"></param>
  23871. <returns></returns>
  23872. </member>
  23873. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetNextBlock(System.Int32)">
  23874. <summary>
  23875. Works out what block follows the specified one.
  23876. </summary>
  23877. <param name="offset"></param>
  23878. <returns></returns>
  23879. </member>
  23880. <member name="M:NPOI.POIFS.FileSystem.BlockStore.SetNextBlock(System.Int32,System.Int32)">
  23881. <summary>
  23882. Changes the record of what block follows the specified one.
  23883. </summary>
  23884. <param name="offset"></param>
  23885. <param name="nextBlock"></param>
  23886. </member>
  23887. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetFreeBlock">
  23888. <summary>
  23889. Finds a free block, and returns its offset.
  23890. This method will extend the file/stream if needed, and if doing
  23891. so, allocate new FAT blocks to address the extra space.
  23892. </summary>
  23893. <returns></returns>
  23894. </member>
  23895. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetChainLoopDetector">
  23896. <summary>
  23897. Creates a Detector for loops in the chain
  23898. </summary>
  23899. <returns></returns>
  23900. </member>
  23901. <member name="T:NPOI.POIFS.FileSystem.ChainLoopDetector">
  23902. <summary>
  23903. Used to detect if a chain has a loop in it, so
  23904. we can bail out with an error rather than
  23905. spinning away for ever...
  23906. </summary>
  23907. </member>
  23908. <member name="T:NPOI.POIFS.FileSystem.DirectoryEntry">
  23909. <summary>
  23910. This interface defines methods specific to Directory objects
  23911. managed by a Filesystem instance.
  23912. @author Marc Johnson (mjohnson at apache dot org)
  23913. </summary>
  23914. </member>
  23915. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.Entries">
  23916. <summary>
  23917. get an iterator of the Entry instances contained directly in
  23918. this instance (in other words, children only; no grandchildren
  23919. etc.)
  23920. </summary>
  23921. <value>The entries.never null, but hasNext() may return false
  23922. immediately (i.e., this DirectoryEntry is empty). All
  23923. objects retrieved by next() are guaranteed to be
  23924. implementations of Entry.</value>
  23925. </member>
  23926. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.EntryNames">
  23927. <summary>
  23928. get the names of all the Entries contained directly in this
  23929. instance (in other words, names of children only; no grandchildren etc).
  23930. </summary>
  23931. <value>the names of all the entries that may be retrieved with
  23932. getEntry(String), which may be empty (if this DirectoryEntry is empty
  23933. </value>
  23934. </member>
  23935. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.IsEmpty">
  23936. <summary>
  23937. is this DirectoryEntry empty?
  23938. </summary>
  23939. <value><c>true</c> if this instance contains no Entry instances; otherwise, <c>false</c>.</value>
  23940. </member>
  23941. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.EntryCount">
  23942. <summary>
  23943. find out how many Entry instances are contained directly within
  23944. this DirectoryEntry
  23945. </summary>
  23946. <value>number of immediately (no grandchildren etc.) contained
  23947. Entry instances</value>
  23948. </member>
  23949. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.GetEntry(System.String)">
  23950. <summary>
  23951. get a specified Entry by name
  23952. </summary>
  23953. <param name="name">the name of the Entry to obtain.</param>
  23954. <returns>the specified Entry, if it is directly contained in
  23955. this DirectoryEntry</returns>
  23956. </member>
  23957. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.CreateDocument(System.String,System.IO.Stream)">
  23958. <summary>
  23959. Create a new DocumentEntry
  23960. </summary>
  23961. <param name="name">the name of the new DocumentEntry</param>
  23962. <param name="stream">the Stream from which to Create the new DocumentEntry</param>
  23963. <returns>the new DocumentEntry</returns>
  23964. </member>
  23965. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.CreateDocument(System.String,System.Int32,NPOI.POIFS.EventFileSystem.POIFSWriterListener)">
  23966. <summary>
  23967. Create a new DocumentEntry; the data will be provided later
  23968. </summary>
  23969. <param name="name">the name of the new DocumentEntry</param>
  23970. <param name="size">the size of the new DocumentEntry</param>
  23971. <param name="writer">BeforeWriting event handler</param>
  23972. <returns>the new DocumentEntry</returns>
  23973. </member>
  23974. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.CreateDirectory(System.String)">
  23975. <summary>
  23976. Create a new DirectoryEntry
  23977. </summary>
  23978. <param name="name">the name of the new DirectoryEntry</param>
  23979. <returns>the name of the new DirectoryEntry</returns>
  23980. </member>
  23981. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.StorageClsid">
  23982. <summary>
  23983. Gets or sets the storage ClassID.
  23984. </summary>
  23985. <value>The storage ClassID.</value>
  23986. </member>
  23987. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.HasEntry(System.String)">
  23988. <summary>
  23989. Checks if entry with specified name present
  23990. </summary>
  23991. <param name="name">entry name</param>
  23992. <returns>true if have</returns>
  23993. </member>
  23994. <member name="T:NPOI.POIFS.FileSystem.DirectoryNode">
  23995. <summary>
  23996. Simple implementation of DirectoryEntry
  23997. @author Marc Johnson (mjohnson at apache dot org)
  23998. </summary>
  23999. </member>
  24000. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.#ctor(NPOI.POIFS.Properties.DirectoryProperty,NPOI.POIFS.FileSystem.OPOIFSFileSystem,NPOI.POIFS.FileSystem.DirectoryNode)">
  24001. <summary>
  24002. Create a DirectoryNode. This method Is not public by design; it
  24003. Is intended strictly for the internal use of this package
  24004. </summary>
  24005. <param name="property">the DirectoryProperty for this DirectoryEntry</param>
  24006. <param name="fileSystem">the OPOIFSFileSystem we belong to</param>
  24007. <param name="parent">the parent of this entry</param>
  24008. </member>
  24009. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.#ctor(NPOI.POIFS.Properties.DirectoryProperty,NPOI.POIFS.FileSystem.NPOIFSFileSystem,NPOI.POIFS.FileSystem.DirectoryNode)">
  24010. <summary>
  24011. Create a DirectoryNode. This method Is not public by design; it
  24012. Is intended strictly for the internal use of this package
  24013. </summary>
  24014. <param name="property">the DirectoryProperty for this DirectoryEntry</param>
  24015. <param name="nFileSystem">the POIFSFileSystem we belong to</param>
  24016. <param name="parent">the parent of this entry</param>
  24017. </member>
  24018. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.CreatePOIFSDocumentReader(System.String)">
  24019. <summary>
  24020. open a document in the directory's entry's list of entries
  24021. </summary>
  24022. <param name="documentName">the name of the document to be opened</param>
  24023. <returns>a newly opened DocumentStream</returns>
  24024. </member>
  24025. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.CreateDocument(NPOI.POIFS.FileSystem.OPOIFSDocument)">
  24026. <summary>
  24027. Create a new DocumentEntry; the data will be provided later
  24028. </summary>
  24029. <param name="document">the name of the new documentEntry</param>
  24030. <returns>the new DocumentEntry</returns>
  24031. </member>
  24032. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.ChangeName(System.String,System.String)">
  24033. <summary>
  24034. Change a contained Entry's name
  24035. </summary>
  24036. <param name="oldName">the original name</param>
  24037. <param name="newName">the new name</param>
  24038. <returns>true if the operation succeeded, else false</returns>
  24039. </member>
  24040. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.DeleteEntry(NPOI.POIFS.FileSystem.EntryNode)">
  24041. <summary>
  24042. Deletes the entry.
  24043. </summary>
  24044. <param name="entry">the EntryNode to be Deleted</param>
  24045. <returns>true if the entry was Deleted, else false</returns>
  24046. </member>
  24047. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.Path">
  24048. <summary>
  24049. Gets the path.
  24050. </summary>
  24051. <value>this directory's path representation</value>
  24052. </member>
  24053. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.FileSystem">
  24054. <summary>
  24055. return the filesystem that this belongs to
  24056. TODO: Temporary workaround during #56791
  24057. </summary>
  24058. </member>
  24059. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.OFileSystem">
  24060. <summary>
  24061. If this is OPOIFS based, return the NPOIFSFileSystem
  24062. that this belong to, otherwise Null if NPOIFS based
  24063. return the filesystem that this belongs to
  24064. </summary>
  24065. </member>
  24066. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.NFileSystem">
  24067. <summary>
  24068. If this is NPOIFS based, return the NPOIFSFileSystem
  24069. that this belong to, otherwise Null if OPOIFS based.
  24070. return the filesystem that this belongs to
  24071. </summary>
  24072. </member>
  24073. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.Entries">
  24074. <summary>
  24075. get an iterator of the Entry instances contained directly in
  24076. this instance (in other words, children only; no grandchildren
  24077. etc.)
  24078. </summary>
  24079. <value>
  24080. The entries.never null, but hasNext() may return false
  24081. immediately (i.e., this DirectoryEntry is empty). All
  24082. objects retrieved by next() are guaranteed to be
  24083. implementations of Entry.
  24084. </value>
  24085. </member>
  24086. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.EntryNames">
  24087. get the names of all the Entries contained directly in this
  24088. instance (in other words, names of children only; no grandchildren
  24089. etc).
  24090. @return the names of all the entries that may be retrieved with
  24091. getEntry(String), which may be empty (if this
  24092. DirectoryEntry is empty)
  24093. </member>
  24094. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.IsEmpty">
  24095. <summary>
  24096. is this DirectoryEntry empty?
  24097. </summary>
  24098. <value>
  24099. <c>true</c> if this instance contains no Entry instances; otherwise, <c>false</c>.
  24100. </value>
  24101. </member>
  24102. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.EntryCount">
  24103. <summary>
  24104. find out how many Entry instances are contained directly within
  24105. this DirectoryEntry
  24106. </summary>
  24107. <value>
  24108. number of immediately (no grandchildren etc.) contained
  24109. Entry instances
  24110. </value>
  24111. </member>
  24112. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.GetEntry(System.String)">
  24113. <summary>
  24114. get a specified Entry by name
  24115. </summary>
  24116. <param name="name">the name of the Entry to obtain.</param>
  24117. <returns>
  24118. the specified Entry, if it is directly contained in
  24119. this DirectoryEntry
  24120. </returns>
  24121. </member>
  24122. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.CreateDirectory(System.String)">
  24123. <summary>
  24124. Create a new DirectoryEntry
  24125. </summary>
  24126. <param name="name">the name of the new DirectoryEntry</param>
  24127. <returns>the name of the new DirectoryEntry</returns>
  24128. </member>
  24129. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.CreateOrUpdateDocument(System.String,System.IO.Stream)">
  24130. Set the contents of a document, creating if needed,
  24131. otherwise updating. Returns the created / updated DocumentEntry
  24132. @param name the name of the new or existing DocumentEntry
  24133. @param stream the InputStream from which to populate the DocumentEntry
  24134. @return the new or updated DocumentEntry
  24135. @exception IOException
  24136. </member>
  24137. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.StorageClsid">
  24138. <summary>
  24139. Gets or Sets the storage clsid for the directory entry
  24140. </summary>
  24141. <value>The storage ClassID.</value>
  24142. </member>
  24143. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.IsDirectoryEntry">
  24144. <summary>
  24145. Is this a DirectoryEntry?
  24146. </summary>
  24147. <value>true if the Entry Is a DirectoryEntry, else false</value>
  24148. </member>
  24149. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.IsDeleteOK">
  24150. <summary>
  24151. extensions use this method to verify internal rules regarding
  24152. deletion of the underlying store.
  24153. </summary>
  24154. <value> true if it's ok to Delete the underlying store, else
  24155. false</value>
  24156. </member>
  24157. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.ViewableArray">
  24158. <summary>
  24159. Get an array of objects, some of which may implement POIFSViewable
  24160. </summary>
  24161. <value>an array of Object; may not be null, but may be empty</value>
  24162. </member>
  24163. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.ViewableIterator">
  24164. <summary>
  24165. Get an Iterator of objects, some of which may implement
  24166. POIFSViewable
  24167. </summary>
  24168. <value>an Iterator; may not be null, but may have an empty
  24169. back end store</value>
  24170. </member>
  24171. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.PreferArray">
  24172. <summary>
  24173. Give viewers a hint as to whether to call GetViewableArray or
  24174. GetViewableIterator
  24175. </summary>
  24176. <value><c>true</c> if a viewer should call GetViewableArray; otherwise, <c>false</c>if
  24177. a viewer should call GetViewableIterator</value>
  24178. </member>
  24179. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.ShortDescription">
  24180. <summary>
  24181. Provides a short description of the object, to be used when a
  24182. POIFSViewable object has not provided its contents.
  24183. </summary>
  24184. <value>The short description.</value>
  24185. </member>
  24186. <member name="T:NPOI.POIFS.FileSystem.DocumentDescriptor">
  24187. <summary>
  24188. Class DocumentDescriptor
  24189. @author Marc Johnson (mjohnson at apache dot org)
  24190. </summary>
  24191. </member>
  24192. <member name="M:NPOI.POIFS.FileSystem.DocumentDescriptor.#ctor(NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String)">
  24193. <summary>
  24194. Initializes a new instance of the <see cref="T:NPOI.POIFS.FileSystem.DocumentDescriptor"/> class.
  24195. </summary>
  24196. <param name="path">the Document path</param>
  24197. <param name="name">the Document name</param>
  24198. </member>
  24199. <member name="P:NPOI.POIFS.FileSystem.DocumentDescriptor.Path">
  24200. <summary>
  24201. Gets the path.
  24202. </summary>
  24203. <value>The path.</value>
  24204. </member>
  24205. <member name="P:NPOI.POIFS.FileSystem.DocumentDescriptor.Name">
  24206. <summary>
  24207. Gets the name.
  24208. </summary>
  24209. <value>The name.</value>
  24210. </member>
  24211. <member name="M:NPOI.POIFS.FileSystem.DocumentDescriptor.Equals(System.Object)">
  24212. <summary>
  24213. equality. Two DocumentDescriptor instances are equal if they
  24214. have equal paths and names
  24215. </summary>
  24216. <param name="o">the object we're checking equality for</param>
  24217. <returns>true if the object is equal to this object</returns>
  24218. </member>
  24219. <member name="M:NPOI.POIFS.FileSystem.DocumentDescriptor.GetHashCode">
  24220. <summary>
  24221. Serves as a hash function for a particular type.
  24222. </summary>
  24223. <returns>
  24224. hashcode
  24225. </returns>
  24226. </member>
  24227. <member name="M:NPOI.POIFS.FileSystem.DocumentDescriptor.ToString">
  24228. <summary>
  24229. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  24230. </summary>
  24231. <returns>
  24232. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  24233. </returns>
  24234. </member>
  24235. <member name="T:NPOI.POIFS.FileSystem.DocumentEntry">
  24236. <summary>
  24237. This interface defines methods specific to Document objects
  24238. managed by a Filesystem instance.
  24239. @author Marc Johnson (mjohnson at apache dot org)
  24240. </summary>
  24241. </member>
  24242. <member name="P:NPOI.POIFS.FileSystem.DocumentEntry.Size">
  24243. <summary>
  24244. get the size of the document, in bytes
  24245. </summary>
  24246. <value>size in bytes</value>
  24247. </member>
  24248. <member name="T:NPOI.POIFS.FileSystem.DocumentFactoryHelper">
  24249. <summary>
  24250. A small base class for the various factories, e.g. WorkbookFactory, SlideShowFactory to combine common code here.
  24251. </summary>
  24252. </member>
  24253. <member name="M:NPOI.POIFS.FileSystem.DocumentFactoryHelper.GetDecryptedStream(NPOI.POIFS.FileSystem.NPOIFSFileSystem,System.String)">
  24254. <summary>
  24255. Wrap the OLE2 data in the NPOIFSFileSystem into a decrypted stream by using the given password.
  24256. </summary>
  24257. <param name="fs">The OLE2 stream for the document</param>
  24258. <param name="password">The password, null if the default password should be used</param>
  24259. <returns>A stream for reading the decrypted data</returns>
  24260. <exception cref="T:System.IO.IOException">If an error occurs while decrypting or if the password does not match</exception>
  24261. </member>
  24262. <member name="M:NPOI.POIFS.FileSystem.DocumentFactoryHelper.HasOOXMLHeader(System.IO.Stream)">
  24263. <summary>
  24264. Checks that the supplied InputStream (which MUST support mark and reset, or be a PushbackInputStream) has a OOXML (zip) header at the start of it.
  24265. If your InputStream does not support mark / reset, then wrap it in a PushBackInputStream, then be sure to always use that, and not the original!
  24266. </summary>
  24267. <param name="inp">An InputStream which supports either mark/reset, or is a PushbackInputStream</param>
  24268. </member>
  24269. <member name="M:NPOI.POIFS.FileSystem.DocumentFactoryHelper.IsPasswordProtected(System.String)">
  24270. <summary>
  24271. Detects if a given office document is protected by a password or not.
  24272. Supported formats: Word, Excel and PowerPoint (both legacy and OpenXml).
  24273. </summary>
  24274. <param name="fileName">Path to an office document.</param>
  24275. <returns>True if document is protected by a password, false otherwise.</returns>
  24276. </member>
  24277. <member name="M:NPOI.POIFS.FileSystem.DocumentFactoryHelper.IsPasswordProtected(System.IO.Stream)">
  24278. <summary>
  24279. Detects if a given office document is protected by a password or not.
  24280. Supported formats: Word, Excel and PowerPoint (both legacy and OpenXml).
  24281. </summary>
  24282. <param name="stream">Office document stream.</param>
  24283. <returns>True if document is protected by a password, false otherwise.</returns>
  24284. </member>
  24285. <member name="M:NPOI.POIFS.FileSystem.DocumentFactoryHelper.GetPasswordProtected(System.IO.Stream)">
  24286. <summary>
  24287. Detects if a given office document is protected by a password or not.
  24288. Supported formats: Word, Excel and PowerPoint (both legacy and OpenXml).
  24289. </summary>
  24290. <param name="stream">Office document stream.</param>
  24291. <returns>True if document is protected by a password, false otherwise.</returns>
  24292. </member>
  24293. <!-- Badly formed XML comment ignored for member "T:NPOI.POIFS.FileSystem.DocumentInputStream" -->
  24294. <member name="F:NPOI.POIFS.FileSystem.DocumentInputStream.EOF">
  24295. returned by read operations if we're at end of document
  24296. </member>
  24297. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.#ctor">
  24298. <summary>
  24299. For use by downstream implementations
  24300. </summary>
  24301. </member>
  24302. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.#ctor(NPOI.POIFS.FileSystem.DocumentEntry)">
  24303. <summary>
  24304. Initializes a new instance of the <see cref="T:NPOI.POIFS.FileSystem.DocumentInputStream"/> class.
  24305. Create an <see cref="T:NPOI.Util.InputStream"/> from the specified DocumentEntry
  24306. </summary>
  24307. <param name="document">the DocumentEntry to be read</param>
  24308. <exception cref="T:System.IO.IOException">
  24309. IOException if the DocumentEntry cannot be opened (like, maybe it has been deleted?)
  24310. </exception>
  24311. </member>
  24312. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.#ctor(NPOI.POIFS.FileSystem.OPOIFSDocument)">
  24313. <summary>
  24314. Initializes a new instance of the <see cref="T:NPOI.POIFS.FileSystem.DocumentInputStream"/> class.
  24315. Create an <see cref="T:NPOI.Util.InputStream"/> from the specified DocumentEntry
  24316. </summary>
  24317. <param name="document">the DocumentEntry to be read</param>
  24318. </member>
  24319. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.#ctor(NPOI.POIFS.FileSystem.NPOIFSDocument)">
  24320. <summary>
  24321. Initializes a new instance of the <see cref="T:NPOI.POIFS.FileSystem.DocumentInputStream"/> class.
  24322. Create an <see cref="T:NPOI.Util.InputStream"/> from the specified DocumentEntry
  24323. </summary>
  24324. <param name="document">the DocumentEntry to be read</param>
  24325. </member>
  24326. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.MarkSupported">
  24327. <summary>
  24328. Tests if this input stream supports the mark and reset methods.
  24329. </summary>
  24330. <returns><c>true</c> always</returns>
  24331. </member>
  24332. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.Reset">
  24333. <summary>
  24334. Repositions this stream to the position at the time the mark() method was
  24335. last called on this input stream. If mark() has not been called this
  24336. method repositions the stream to its beginning.
  24337. </summary>
  24338. </member>
  24339. <member name="T:NPOI.POIFS.FileSystem.DocumentNode">
  24340. <summary>
  24341. Simple implementation of DocumentEntry
  24342. @author Marc Johnson (mjohnson at apache dot org)
  24343. </summary>
  24344. </member>
  24345. <member name="M:NPOI.POIFS.FileSystem.DocumentNode.#ctor(NPOI.POIFS.Properties.DocumentProperty,NPOI.POIFS.FileSystem.DirectoryNode)">
  24346. create a DocumentNode. This method Is not public by design; it
  24347. Is intended strictly for the internal use of this package
  24348. @param property the DocumentProperty for this DocumentEntry
  24349. @param parent the parent of this entry
  24350. </member>
  24351. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.Document">
  24352. get the POIFSDocument
  24353. @return the internal POIFSDocument
  24354. </member>
  24355. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.Size">
  24356. get the zize of the document, in bytes
  24357. @return size in bytes
  24358. </member>
  24359. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.IsDocumentEntry">
  24360. Is this a DocumentEntry?
  24361. @return true if the Entry Is a DocumentEntry, else false
  24362. </member>
  24363. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.IsDeleteOK">
  24364. extensions use this method to verify internal rules regarding
  24365. deletion of the underlying store.
  24366. @return true if it's ok to delete the underlying store, else
  24367. false
  24368. </member>
  24369. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.ViewableArray">
  24370. Get an array of objects, some of which may implement
  24371. POIFSViewable
  24372. @return an array of Object; may not be null, but may be empty
  24373. </member>
  24374. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.ViewableIterator">
  24375. Get an Iterator of objects, some of which may implement
  24376. POIFSViewable
  24377. @return an Iterator; may not be null, but may have an empty
  24378. back end store
  24379. </member>
  24380. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.PreferArray">
  24381. Give viewers a hint as to whether to call getViewableArray or
  24382. getViewableIterator
  24383. @return true if a viewer should call getViewableArray, false if
  24384. a viewer should call getViewableIterator
  24385. </member>
  24386. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.ShortDescription">
  24387. Provides a short description of the object, to be used when a
  24388. POIFSViewable object has not provided its contents.
  24389. @return short description
  24390. </member>
  24391. <member name="T:NPOI.POIFS.FileSystem.DocumentOutputStream">
  24392. This class provides a wrapper over an OutputStream so that Document
  24393. Writers can't accidently go over their size limits
  24394. @author Marc Johnson (mjohnson at apache dot org)
  24395. </member>
  24396. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.#ctor(System.IO.Stream,System.Int32)">
  24397. Create a DocumentOutputStream
  24398. @param stream the OutputStream to which the data is actually
  24399. read
  24400. @param limit the maximum number of bytes that can be written
  24401. </member>
  24402. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Write(System.Int32)">
  24403. Writes the specified byte to this output stream. The general
  24404. contract for write is that one byte is written to the output
  24405. stream. The byte to be written is the eight low-order bits of
  24406. the argument b. The 24 high-order bits of b are ignored.
  24407. @param b the byte.
  24408. @exception IOException if an I/O error occurs. In particular,
  24409. an IOException may be thrown if the
  24410. output stream has been closed, or if the
  24411. Writer tries to write too much data.
  24412. </member>
  24413. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Write(System.Byte[])">
  24414. Writes b.Length bytes from the specified byte array
  24415. to this output stream.
  24416. @param b the data.
  24417. @exception IOException if an I/O error occurs.
  24418. </member>
  24419. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Write(System.Byte[],System.Int32,System.Int32)">
  24420. <summary>
  24421. Writes len bytes from the specified byte array starting at
  24422. offset off to this output stream. The general contract for
  24423. Write(b, off, len) is that some of the bytes in the array b are
  24424. written to the output stream in order; element b[off] is the
  24425. first byte written and b[off+len-1] is the last byte written by
  24426. this operation.
  24427. </summary>
  24428. <param name="b">the data.</param>
  24429. <param name="off">the start offset in the data.</param>
  24430. <param name="len">the number of bytes to Write.</param>
  24431. </member>
  24432. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Flush">
  24433. <summary>
  24434. Flushes this output stream and forces any buffered output bytes to be written out
  24435. </summary>
  24436. </member>
  24437. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Close">
  24438. Closes this output stream and releases any system resources
  24439. associated with this stream. The general contract of close is
  24440. that it closes the output stream. A closed stream cannot
  24441. perform output operations and cannot be reopened.
  24442. @exception IOException if an I/O error occurs.
  24443. </member>
  24444. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.WriteFiller(System.Int32,System.Byte)">
  24445. write the rest of the document's data (fill in at the end)
  24446. @param totalLimit the actual number of bytes the corresponding
  24447. document must fill
  24448. @param fill the byte to fill remaining space with
  24449. @exception IOException on I/O error
  24450. </member>
  24451. <member name="T:NPOI.POIFS.FileSystem.Entry">
  24452. <summary>
  24453. This interface provides access to an object managed by a Filesystem
  24454. instance. Entry objects are further divided into DocumentEntry and
  24455. DirectoryEntry instances.
  24456. @author Marc Johnson (mjohnson at apache dot org)
  24457. </summary>
  24458. </member>
  24459. <member name="P:NPOI.POIFS.FileSystem.Entry.Name">
  24460. <summary>
  24461. Get the name of the Entry
  24462. </summary>
  24463. <value>The name.</value>
  24464. </member>
  24465. <member name="P:NPOI.POIFS.FileSystem.Entry.IsDirectoryEntry">
  24466. <summary>
  24467. Is this a DirectoryEntry?
  24468. </summary>
  24469. <value>
  24470. <c>true</c> if the Entry Is a DirectoryEntry; otherwise, <c>false</c>.
  24471. </value>
  24472. </member>
  24473. <member name="P:NPOI.POIFS.FileSystem.Entry.IsDocumentEntry">
  24474. <summary>
  24475. Is this a DocumentEntry?
  24476. </summary>
  24477. <value>
  24478. <c>true</c> if the Entry Is a DocumentEntry; otherwise, <c>false</c>.
  24479. </value>
  24480. </member>
  24481. <member name="P:NPOI.POIFS.FileSystem.Entry.Parent">
  24482. <summary>
  24483. Get this Entry's parent (the DirectoryEntry that owns this
  24484. Entry). All Entry objects, except the root Entry, has a parent.
  24485. </summary>
  24486. <value>this Entry's parent; null iff this Is the root Entry</value>
  24487. This property is moved to EntryNode
  24488. </member>
  24489. <member name="M:NPOI.POIFS.FileSystem.Entry.Delete">
  24490. <summary>
  24491. Delete this Entry. ThIs operation should succeed, but there are
  24492. special circumstances when it will not:
  24493. If this Entry Is the root of the Entry tree, it cannot be
  24494. deleted, as there Is no way to Create another one.
  24495. If this Entry Is a directory, it cannot be deleted unless it Is
  24496. empty.
  24497. </summary>
  24498. <returns>true if the Entry was successfully deleted, else false</returns>
  24499. </member>
  24500. <member name="M:NPOI.POIFS.FileSystem.Entry.RenameTo(System.String)">
  24501. <summary>
  24502. Rename this Entry. ThIs operation will fail if:
  24503. There Is a sibling Entry (i.e., an Entry whose parent Is the
  24504. same as this Entry's parent) with the same name.
  24505. ThIs Entry Is the root of the Entry tree. Its name Is dictated
  24506. by the Filesystem and many not be Changed.
  24507. </summary>
  24508. <param name="newName">the new name for this Entry</param>
  24509. <returns>true if the operation succeeded, else false</returns>
  24510. </member>
  24511. <member name="T:NPOI.POIFS.FileSystem.EntryNode">
  24512. <summary>
  24513. Abstract implementation of Entry
  24514. Extending classes should override isDocument() or isDirectory(), as
  24515. appropriate
  24516. Extending classes must override isDeleteOK()
  24517. @author Marc Johnson (mjohnson at apache dot org)
  24518. </summary>
  24519. </member>
  24520. <member name="M:NPOI.POIFS.FileSystem.EntryNode.#ctor(NPOI.POIFS.Properties.Property,NPOI.POIFS.FileSystem.DirectoryNode)">
  24521. <summary>
  24522. Create a DocumentNode. ThIs method Is not public by design; it
  24523. Is intended strictly for the internal use of extending classes
  24524. </summary>
  24525. <param name="property">the Property for this Entry</param>
  24526. <param name="parent">the parent of this entry</param>
  24527. </member>
  24528. <member name="P:NPOI.POIFS.FileSystem.EntryNode.Property">
  24529. <summary>
  24530. grant access to the property
  24531. </summary>
  24532. <value>the property backing this entry</value>
  24533. </member>
  24534. <member name="P:NPOI.POIFS.FileSystem.EntryNode.IsRoot">
  24535. <summary>
  24536. Is this the root of the tree?
  24537. </summary>
  24538. <value><c>true</c> if this instance is root; otherwise, <c>false</c>.</value>
  24539. </member>
  24540. <member name="P:NPOI.POIFS.FileSystem.EntryNode.IsDeleteOK">
  24541. <summary>
  24542. extensions use this method to verify internal rules regarding
  24543. deletion of the underlying store.
  24544. </summary>
  24545. <value>
  24546. <c>true</c> if it's ok to Delete the underlying store; otherwise, <c>false</c>.
  24547. </value>
  24548. </member>
  24549. <member name="P:NPOI.POIFS.FileSystem.EntryNode.Name">
  24550. <summary>
  24551. Get the name of the Entry
  24552. </summary>
  24553. <value>The name.</value>
  24554. Get the name of the Entry
  24555. @return name
  24556. </member>
  24557. <member name="P:NPOI.POIFS.FileSystem.EntryNode.IsDirectoryEntry">
  24558. <summary>
  24559. Is this a DirectoryEntry?
  24560. </summary>
  24561. <value>
  24562. <c>true</c> if the Entry Is a DirectoryEntry; otherwise, <c>false</c>.
  24563. </value>
  24564. </member>
  24565. <member name="P:NPOI.POIFS.FileSystem.EntryNode.IsDocumentEntry">
  24566. <summary>
  24567. Is this a DocumentEntry?
  24568. </summary>
  24569. <value>
  24570. <c>true</c> if the Entry Is a DocumentEntry; otherwise, <c>false</c>.
  24571. </value>
  24572. </member>
  24573. <member name="P:NPOI.POIFS.FileSystem.EntryNode.Parent">
  24574. <summary>
  24575. Get this Entry's parent (the DocumentEntry that owns this
  24576. Entry). All Entry objects, except the root Entry, has a parent.
  24577. </summary>
  24578. <value>this Entry's parent; null iff this Is the root Entry</value>
  24579. </member>
  24580. <member name="M:NPOI.POIFS.FileSystem.EntryNode.Delete">
  24581. <summary>
  24582. Delete this Entry. ThIs operation should succeed, but there are
  24583. special circumstances when it will not:
  24584. If this Entry Is the root of the Entry tree, it cannot be
  24585. deleted, as there Is no way to Create another one.
  24586. If this Entry Is a directory, it cannot be deleted unless it Is
  24587. empty.
  24588. </summary>
  24589. <returns>
  24590. true if the Entry was successfully deleted, else false
  24591. </returns>
  24592. </member>
  24593. <member name="M:NPOI.POIFS.FileSystem.EntryNode.RenameTo(System.String)">
  24594. <summary>
  24595. Rename this Entry. ThIs operation will fail if:
  24596. There Is a sibling Entry (i.e., an Entry whose parent Is the
  24597. same as this Entry's parent) with the same name.
  24598. ThIs Entry Is the root of the Entry tree. Its name Is dictated
  24599. by the Filesystem and many not be Changed.
  24600. </summary>
  24601. <param name="newName">the new name for this Entry</param>
  24602. <returns>
  24603. true if the operation succeeded, else false
  24604. </returns>
  24605. </member>
  24606. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodeRecursively(NPOI.POIFS.FileSystem.Entry,NPOI.POIFS.FileSystem.DirectoryEntry)">
  24607. Copies an Entry into a target POIFS directory, recursively
  24608. </member>
  24609. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.DirectoryEntry,NPOI.POIFS.FileSystem.DirectoryEntry)">
  24610. Copies all the nodes from one POIFS Directory to another
  24611. @param sourceRoot
  24612. is the source Directory to copy from
  24613. @param targetRoot
  24614. is the target Directory to copy to
  24615. </member>
  24616. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.FilteringDirectoryNode,NPOI.POIFS.FileSystem.FilteringDirectoryNode)">
  24617. Copies nodes from one Directory to the other minus the excepts
  24618. @param filteredSource The filtering source Directory to copy from
  24619. @param filteredTarget The filtering target Directory to copy to
  24620. </member>
  24621. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.DirectoryEntry,NPOI.POIFS.FileSystem.DirectoryEntry,System.Collections.Generic.List{System.String})">
  24622. Copies nodes from one Directory to the other minus the excepts
  24623. @param sourceRoot
  24624. is the source Directory to copy from
  24625. @param targetRoot
  24626. is the target Directory to copy to
  24627. @param excepts
  24628. is a list of Strings specifying what nodes NOT to copy
  24629. @deprecated use {@link FilteringDirectoryNode} instead
  24630. </member>
  24631. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.OPOIFSFileSystem,NPOI.POIFS.FileSystem.OPOIFSFileSystem)">
  24632. Copies all nodes from one POIFS to the other
  24633. @param source
  24634. is the source POIFS to copy from
  24635. @param target
  24636. is the target POIFS to copy to
  24637. </member>
  24638. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.NPOIFSFileSystem,NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  24639. Copies all nodes from one POIFS to the other
  24640. @param source
  24641. is the source POIFS to copy from
  24642. @param target
  24643. is the target POIFS to copy to
  24644. </member>
  24645. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.OPOIFSFileSystem,NPOI.POIFS.FileSystem.OPOIFSFileSystem,System.Collections.Generic.List{System.String})">
  24646. Copies nodes from one POIFS to the other, minus the excepts.
  24647. This delegates the filtering work to {@link FilteringDirectoryNode},
  24648. so excepts can be of the form "NodeToExclude" or
  24649. "FilteringDirectory/ExcludedChildNode"
  24650. @param source is the source POIFS to copy from
  24651. @param target is the target POIFS to copy to
  24652. @param excepts is a list of Entry Names to be excluded from the copy
  24653. </member>
  24654. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.NPOIFSFileSystem,NPOI.POIFS.FileSystem.NPOIFSFileSystem,System.Collections.Generic.List{System.String})">
  24655. Copies nodes from one POIFS to the other, minus the excepts.
  24656. This delegates the filtering work to {@link FilteringDirectoryNode},
  24657. so excepts can be of the form "NodeToExclude" or
  24658. "FilteringDirectory/ExcludedChildNode"
  24659. @param source is the source POIFS to copy from
  24660. @param target is the target POIFS to copy to
  24661. @param excepts is a list of Entry Names to be excluded from the copy
  24662. </member>
  24663. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.AreDirectoriesIdentical(NPOI.POIFS.FileSystem.DirectoryEntry,NPOI.POIFS.FileSystem.DirectoryEntry)">
  24664. Checks to see if the two Directories hold the same contents.
  24665. For this to be true, they must have entries with the same names,
  24666. no entries in one but not the other, and the size+contents
  24667. of each entry must match, and they must share names.
  24668. To exclude certain parts of the Directory from being checked,
  24669. use a {@link FilteringDirectoryNode}
  24670. </member>
  24671. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.AreDocumentsIdentical(NPOI.POIFS.FileSystem.DocumentEntry,NPOI.POIFS.FileSystem.DocumentEntry)">
  24672. Checks to see if two Documents have the same name
  24673. and the same contents. (Their parent directories are
  24674. not checked)
  24675. </member>
  24676. <member name="T:NPOI.POIFS.FileSystem.FilteringDirectoryNode">
  24677. <summary>
  24678. A DirectoryEntry filter, which exposes another DirectoryEntry less certain parts.
  24679. This is typically used when copying or comparing Filesystems.
  24680. </summary>
  24681. </member>
  24682. <member name="M:NPOI.POIFS.FileSystem.FilteringDirectoryNode.#ctor(NPOI.POIFS.FileSystem.DirectoryEntry,System.Collections.Generic.ICollection{System.String})">
  24683. <summary>
  24684. Creates a filter round the specified directory, which will exclude entries such as
  24685. "MyNode" and "MyDir/IgnoreNode". The excludes can stretch into children, if they contain a /.
  24686. </summary>
  24687. <param name="directory">The Directory to filter</param>
  24688. <param name="excludes">The Entries to exclude</param>
  24689. </member>
  24690. <member name="T:NPOI.POIFS.FileSystem.NDocumentInputStream">
  24691. <summary>
  24692. This class provides methods to read a DocumentEntry managed by a <see cref="T:NPOI.POIFS.FileSystem.NPOIFSFileSystem"/> instance
  24693. </summary>
  24694. <seealso cref="T:NPOI.POIFS.FileSystem.DocumentInputStream" />
  24695. </member>
  24696. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._current_offset">
  24697. current offset into the Document
  24698. </member>
  24699. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._current_block_count">
  24700. current block count
  24701. </member>
  24702. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._marked_offset">
  24703. current marked offset into the Document (used by mark and Reset)
  24704. </member>
  24705. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._marked_offset_count">
  24706. and the block count for it
  24707. </member>
  24708. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._document_size">
  24709. the Document's size
  24710. </member>
  24711. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._closed">
  24712. have we been closed?
  24713. </member>
  24714. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._document">
  24715. the actual Document
  24716. </member>
  24717. <member name="M:NPOI.POIFS.FileSystem.NDocumentInputStream.#ctor(NPOI.POIFS.FileSystem.DocumentEntry)">
  24718. <summary>
  24719. Initializes a new instance of the <see cref="T:NPOI.POIFS.FileSystem.NDocumentInputStream"/> class
  24720. Create an InputStream from the specified DocumentEntry
  24721. </summary>
  24722. <param name="document">the DocumentEntry to be read</param>
  24723. <exception cref="T:System.IO.IOException">IOException if the DocumentEntry cannot be opened (like, maybe it has been deleted?)</exception>
  24724. </member>
  24725. <member name="M:NPOI.POIFS.FileSystem.NDocumentInputStream.#ctor(NPOI.POIFS.FileSystem.NPOIFSDocument)">
  24726. <summary>
  24727. Initializes a new instance of the <see cref="T:NPOI.POIFS.FileSystem.NDocumentInputStream"/> class from the specified Document
  24728. </summary>
  24729. <param name="document">the Document to be read</param>
  24730. </member>
  24731. <member name="M:NPOI.POIFS.FileSystem.NDocumentInputStream.Reset">
  24732. <summary>
  24733. Repositions this stream to the position at the time the mark() method was
  24734. last called on this input stream. If mark() has not been called this
  24735. method repositions the stream to its beginning.
  24736. </summary>
  24737. </member>
  24738. <member name="T:NPOI.POIFS.FileSystem.NDocumentOutputStream">
  24739. This class provides methods to write a DocumentEntry managed by a
  24740. {@link NPOIFSFileSystem} instance.
  24741. </member>
  24742. <member name="F:NPOI.POIFS.FileSystem.NDocumentOutputStream._document_size">
  24743. the Document's size
  24744. </member>
  24745. <member name="F:NPOI.POIFS.FileSystem.NDocumentOutputStream._closed">
  24746. have we been closed?
  24747. </member>
  24748. <member name="F:NPOI.POIFS.FileSystem.NDocumentOutputStream._document">
  24749. the actual Document
  24750. </member>
  24751. <member name="F:NPOI.POIFS.FileSystem.NDocumentOutputStream._property">
  24752. and its Property
  24753. </member>
  24754. <member name="F:NPOI.POIFS.FileSystem.NDocumentOutputStream._buffer">
  24755. our buffer, when null we're into normal blocks
  24756. </member>
  24757. <member name="F:NPOI.POIFS.FileSystem.NDocumentOutputStream._stream">
  24758. our main block stream, when we're into normal blocks
  24759. </member>
  24760. <member name="M:NPOI.POIFS.FileSystem.NDocumentOutputStream.#ctor(NPOI.POIFS.FileSystem.DocumentEntry)">
  24761. Create an OutputStream from the specified DocumentEntry.
  24762. The specified entry will be emptied.
  24763. @param document the DocumentEntry to be written
  24764. </member>
  24765. <member name="M:NPOI.POIFS.FileSystem.NDocumentOutputStream.#ctor(NPOI.POIFS.FileSystem.DirectoryEntry,System.String)">
  24766. Create an OutputStream to create the specified new Entry
  24767. @param parent Where to create the Entry
  24768. @param name Name of the new entry
  24769. </member>
  24770. <member name="T:NPOI.POIFS.FileSystem.NotOLE2FileException">
  24771. This exception is thrown when we try to open a file that doesn't
  24772. seem to actually be an OLE2 file After all
  24773. </member>
  24774. <member name="T:NPOI.POIFS.FileSystem.NPOIFSDocument">
  24775. This class manages a document in the NIO POIFS filesystem.
  24776. This is the {@link NPOIFSFileSystem} version.
  24777. </member>
  24778. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.#ctor(NPOI.POIFS.FileSystem.DocumentNode)">
  24779. Constructor for an existing Document
  24780. </member>
  24781. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.#ctor(NPOI.POIFS.Properties.DocumentProperty,NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  24782. Constructor for an existing Document
  24783. </member>
  24784. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.#ctor(System.String,NPOI.POIFS.FileSystem.NPOIFSFileSystem,System.IO.Stream)">
  24785. Constructor for a new Document
  24786. @param name the name of the POIFSDocument
  24787. @param stream the InputStream we read data from
  24788. </member>
  24789. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.Free">
  24790. Frees the underlying stream and property
  24791. </member>
  24792. <member name="P:NPOI.POIFS.FileSystem.NPOIFSDocument.Size">
  24793. @return size of the document
  24794. </member>
  24795. <member name="P:NPOI.POIFS.FileSystem.NPOIFSDocument.DocumentProperty">
  24796. @return the instance's DocumentProperty
  24797. </member>
  24798. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.GetViewableArray">
  24799. Get an array of objects, some of which may implement POIFSViewable
  24800. @return an array of Object; may not be null, but may be empty
  24801. </member>
  24802. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.GetViewableIterator">
  24803. Get an Iterator of objects, some of which may implement POIFSViewable
  24804. @return an Iterator; may not be null, but may have an empty back end
  24805. store
  24806. </member>
  24807. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.GetShortDescription">
  24808. Provides a short description of the object, to be used when a
  24809. POIFSViewable object has not provided its contents.
  24810. @return short description
  24811. </member>
  24812. <member name="T:NPOI.POIFS.FileSystem.NPOIFSFileSystem">
  24813. This is the main class of the POIFS system; it manages the entire
  24814. life cycle of the filesystem.
  24815. This is the new NIO version
  24816. </member>
  24817. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateNonClosingInputStream(System.IO.Stream)">
  24818. Convenience method for clients that want to avoid the auto-close behaviour of the constructor.
  24819. </member>
  24820. <member name="F:NPOI.POIFS.FileSystem.NPOIFSFileSystem.bigBlockSize">
  24821. What big block size the file uses. Most files
  24822. use 512 bytes, but a few use 4096
  24823. </member>
  24824. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor">
  24825. Constructor, intended for writing
  24826. </member>
  24827. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor(System.IO.FileInfo)">
  24828. <p>Creates a POIFSFileSystem from a <tt>File</tt>. This uses less memory than
  24829. creating from an <tt>InputStream</tt>. The File will be opened read-only</p>
  24830. <p>Note that with this constructor, you will need to call {@link #close()}
  24831. when you're done to have the underlying file closed, as the file is
  24832. kept open during normal operation to read the data out.</p>
  24833. @param file the File from which to read the data
  24834. @exception IOException on errors reading, or on invalid data
  24835. </member>
  24836. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor(System.IO.FileInfo,System.Boolean)">
  24837. <p>Creates a POIFSFileSystem from a <tt>File</tt>. This uses less memory than
  24838. creating from an <tt>InputStream</tt>.</p>
  24839. <p>Note that with this constructor, you will need to call {@link #close()}
  24840. when you're done to have the underlying file closed, as the file is
  24841. kept open during normal operation to read the data out.</p>
  24842. @param file the File from which to read or read/write the data
  24843. @param readOnly whether the POIFileSystem will only be used in read-only mode
  24844. @exception IOException on errors reading, or on invalid data
  24845. </member>
  24846. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor(System.IO.FileStream)">
  24847. * <p>Creates a POIFSFileSystem from an open <tt>FileChannel</tt>. This uses
  24848. * less memory than creating from an <tt>InputStream</tt>. The stream will
  24849. * be used in read-only mode.</p>
  24850. *
  24851. * <p>Note that with this constructor, you will need to call {@link #close()}
  24852. * when you're done to have the underlying Channel closed, as the channel is
  24853. * kept open during normal operation to read the data out.</p>
  24854. *
  24855. * @param channel the FileChannel from which to read the data
  24856. *
  24857. * @exception IOException on errors reading, or on invalid data
  24858. </member>
  24859. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor(System.IO.FileStream,System.Boolean)">
  24860. <p>Creates a POIFSFileSystem from an open <tt>FileChannel</tt>. This uses
  24861. less memory than creating from an <tt>InputStream</tt>.</p>
  24862. <p>Note that with this constructor, you will need to call {@link #close()}
  24863. when you're done to have the underlying Channel closed, as the channel is
  24864. kept open during normal operation to read the data out.</p>
  24865. @param channel the FileChannel from which to read or read/write the data
  24866. @param readOnly whether the POIFileSystem will only be used in read-only mode
  24867. @exception IOException on errors reading, or on invalid data
  24868. </member>
  24869. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor(System.IO.Stream)">
  24870. Create a POIFSFileSystem from an <tt>InputStream</tt>. Normally the stream is read until
  24871. EOF. The stream is always closed.<p/>
  24872. Some streams are usable After reaching EOF (typically those that return <code>true</code>
  24873. for <tt>markSupported()</tt>). In the unlikely case that the caller has such a stream
  24874. <i>and</i> needs to use it After this constructor completes, a work around is to wrap the
  24875. stream in order to trap the <tt>close()</tt> call. A convenience method (
  24876. <tt>CreateNonClosingInputStream()</tt>) has been provided for this purpose:
  24877. <pre>
  24878. InputStream wrappedStream = POIFSFileSystem.CreateNonClosingInputStream(is);
  24879. HSSFWorkbook wb = new HSSFWorkbook(wrappedStream);
  24880. is.Reset();
  24881. doSomethingElse(is);
  24882. </pre>
  24883. Note also the special case of <tt>MemoryStream</tt> for which the <tt>close()</tt>
  24884. method does nothing.
  24885. <pre>
  24886. MemoryStream bais = ...
  24887. HSSFWorkbook wb = new HSSFWorkbook(bais); // calls bais.Close() !
  24888. bais.Reset(); // no problem
  24889. doSomethingElse(bais);
  24890. </pre>
  24891. @param stream the InputStream from which to read the data
  24892. @exception IOException on errors Reading, or on invalid data
  24893. </member>
  24894. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CloseInputStream(System.IO.Stream,System.Boolean)">
  24895. @param stream the stream to be closed
  24896. @param success <code>false</code> if an exception is currently being thrown in the calling method
  24897. </member>
  24898. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.HasPOIFSHeader(System.IO.Stream)">
  24899. Checks that the supplied InputStream (which MUST
  24900. support mark and reset, or be a PushbackInputStream)
  24901. has a POIFS (OLE2) header at the start of it.
  24902. If your InputStream does not support mark / reset,
  24903. then wrap it in a PushBackInputStream, then be
  24904. sure to always use that, and not the original!
  24905. @param inp An InputStream which supports either mark/reset, or is a PushbackInputStream
  24906. </member>
  24907. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.HasPOIFSHeader(System.Byte[])">
  24908. Checks if the supplied first 8 bytes of a stream / file
  24909. has a POIFS (OLE2) header.
  24910. </member>
  24911. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.ReadCoreContents">
  24912. Read and process the PropertiesTable and the
  24913. FAT / XFAT blocks, so that we're Ready to
  24914. work with the file
  24915. </member>
  24916. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetBlockAt(System.Int32)">
  24917. Load the block at the given offset.
  24918. </member>
  24919. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.TryGetBlockAt(System.Int32,NPOI.Util.ByteBuffer@)">
  24920. Try to load the block at the given offset, and if the offset is beyond the end of the buffer, return false.
  24921. </member>
  24922. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateBlockIfNeeded(System.Int32)">
  24923. Load the block at the given offset,
  24924. extending the file if needed
  24925. </member>
  24926. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetBATBlockAndIndex(System.Int32)">
  24927. Returns the BATBlock that handles the specified offset,
  24928. and the relative index within it
  24929. </member>
  24930. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetNextBlock(System.Int32)">
  24931. Works out what block follows the specified one.
  24932. </member>
  24933. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.SetNextBlock(System.Int32,System.Int32)">
  24934. Changes the record of what block follows the specified one.
  24935. </member>
  24936. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetFreeBlock">
  24937. Finds a free block, and returns its offset.
  24938. This method will extend the file if needed, and if doing
  24939. so, allocate new FAT blocks to Address the extra space.
  24940. </member>
  24941. <member name="P:NPOI.POIFS.FileSystem.NPOIFSFileSystem.PropertyTable">
  24942. For unit Testing only! Returns the underlying
  24943. properties table
  24944. </member>
  24945. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetMiniStore">
  24946. Returns the MiniStore, which performs a similar low
  24947. level function to this, except for the small blocks.
  24948. </member>
  24949. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.AddDocument(NPOI.POIFS.FileSystem.NPOIFSDocument)">
  24950. add a new POIFSDocument to the FileSytem
  24951. @param document the POIFSDocument being Added
  24952. </member>
  24953. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.AddDirectory(NPOI.POIFS.Properties.DirectoryProperty)">
  24954. add a new DirectoryProperty to the FileSystem
  24955. @param directory the DirectoryProperty being Added
  24956. </member>
  24957. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateDocument(System.IO.Stream,System.String)">
  24958. Create a new document to be Added to the root directory
  24959. @param stream the InputStream from which the document's data
  24960. will be obtained
  24961. @param name the name of the new POIFSDocument
  24962. @return the new DocumentEntry
  24963. @exception IOException on error creating the new POIFSDocument
  24964. </member>
  24965. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateDocument(System.String,System.Int32,NPOI.POIFS.EventFileSystem.POIFSWriterListener)">
  24966. create a new DocumentEntry in the root entry; the data will be
  24967. provided later
  24968. @param name the name of the new DocumentEntry
  24969. @param size the size of the new DocumentEntry
  24970. @param Writer the Writer of the new DocumentEntry
  24971. @return the new DocumentEntry
  24972. @exception IOException
  24973. </member>
  24974. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateDirectory(System.String)">
  24975. create a new DirectoryEntry in the root directory
  24976. @param name the name of the new DirectoryEntry
  24977. @return the new DirectoryEntry
  24978. @exception IOException on name duplication
  24979. </member>
  24980. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateOrUpdateDocument(System.IO.Stream,System.String)">
  24981. Set the contents of a document in1 the root directory,
  24982. creating if needed, otherwise updating
  24983. @param stream the InputStream from which the document's data
  24984. will be obtained
  24985. @param name the name of the new or existing POIFSDocument
  24986. @return the new or updated DocumentEntry
  24987. @exception IOException on error populating the POIFSDocument
  24988. </member>
  24989. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.IsInPlaceWriteable">
  24990. Does the filesystem support an in-place write via
  24991. {@link #writeFilesystem()} ? If false, only writing out to
  24992. a brand new file via {@link #writeFilesystem(OutputStream)}
  24993. is supported.
  24994. </member>
  24995. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.WriteFileSystem">
  24996. Write the filesystem out to the open file. Will thrown an
  24997. {@link ArgumentException} if opened from an
  24998. {@link InputStream}.
  24999. @exception IOException thrown on errors writing to the stream
  25000. </member>
  25001. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.WriteFileSystem(System.IO.Stream)">
  25002. Write the filesystem out
  25003. @param stream the OutputStream to which the filesystem will be
  25004. written
  25005. @exception IOException thrown on errors writing to the stream
  25006. </member>
  25007. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.syncWithDataSource">
  25008. Has our in-memory objects write their state
  25009. to their backing blocks
  25010. </member>
  25011. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.Close">
  25012. Closes the FileSystem, freeing any underlying files, streams
  25013. and buffers. After this, you will be unable to read or
  25014. write from the FileSystem.
  25015. </member>
  25016. <member name="P:NPOI.POIFS.FileSystem.NPOIFSFileSystem.Root">
  25017. Get the root entry
  25018. @return the root entry
  25019. </member>
  25020. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateDocumentInputStream(System.String)">
  25021. open a document in the root entry's list of entries
  25022. @param documentName the name of the document to be opened
  25023. @return a newly opened DocumentInputStream
  25024. @exception IOException if the document does not exist or the
  25025. name is that of a DirectoryEntry
  25026. </member>
  25027. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.Remove(NPOI.POIFS.FileSystem.EntryNode)">
  25028. remove an entry
  25029. @param entry to be Removed
  25030. </member>
  25031. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetViewableArray">
  25032. Get an array of objects, some of which may implement
  25033. POIFSViewable
  25034. @return an array of Object; may not be null, but may be empty
  25035. </member>
  25036. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetViewableIterator">
  25037. Get an Iterator of objects, some of which may implement
  25038. POIFSViewable
  25039. @return an Iterator; may not be null, but may have an empty
  25040. back end store
  25041. </member>
  25042. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetShortDescription">
  25043. Provides a short description of the object, to be used when a
  25044. POIFSViewable object has not provided its contents.
  25045. @return short description
  25046. </member>
  25047. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetBigBlockSize">
  25048. @return The Big Block size, normally 512 bytes, sometimes 4096 bytes
  25049. </member>
  25050. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetBigBlockSizeDetails">
  25051. @return The Big Block size, normally 512 bytes, sometimes 4096 bytes
  25052. </member>
  25053. <member name="T:NPOI.POIFS.FileSystem.NPOIFSMiniStore">
  25054. This class handles the MiniStream (small block store)
  25055. in the NIO case for {@link NPOIFSFileSystem}
  25056. </member>
  25057. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.GetBlockAt(System.Int32,System.Boolean)">
  25058. Load the block at the given offset, optionally throwing an exception if the offset is beyond the limit of the buffer.
  25059. </member>
  25060. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.GetBlockAt(System.Int32)">
  25061. Load the block at the given offset.
  25062. </member>
  25063. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.TryGetBlockAt(System.Int32,NPOI.Util.ByteBuffer@)">
  25064. Try to load the block at the given offset, and if the offset is beyond the end of the buffer, return false.
  25065. </member>
  25066. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.CreateBlockIfNeeded(System.Int32)">
  25067. Load the block, extending the underlying stream if needed
  25068. </member>
  25069. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.GetBATBlockAndIndex(System.Int32)">
  25070. Returns the BATBlock that handles the specified offset,
  25071. and the relative index within it
  25072. </member>
  25073. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.GetNextBlock(System.Int32)">
  25074. Works out what block follows the specified one.
  25075. </member>
  25076. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.SetNextBlock(System.Int32,System.Int32)">
  25077. Changes the record of what block follows the specified one.
  25078. </member>
  25079. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.GetFreeBlock">
  25080. Finds a free block, and returns its offset.
  25081. This method will extend the file if needed, and if doing
  25082. so, allocate new FAT blocks to Address the extra space.
  25083. </member>
  25084. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.SyncWithDataSource">
  25085. <summary>
  25086. Writes the SBATs to their backing blocks, and updates
  25087. the mini-stream size in the properties. Stream size is
  25088. based on full blocks used, not the data within the streams
  25089. </summary>
  25090. </member>
  25091. <member name="T:NPOI.POIFS.FileSystem.NPOIFSStream">
  25092. This handles Reading and writing a stream within a
  25093. {@link NPOIFSFileSystem}. It can supply an iterator
  25094. to read blocks, and way to write out to existing and
  25095. new blocks.
  25096. Most users will want a higher level version of this,
  25097. which deals with properties to track which stream
  25098. this is.
  25099. This only works on big block streams, it doesn't
  25100. handle small block ones.
  25101. This uses the new NIO code
  25102. TODO Implement a streaming write method, and append
  25103. </member>
  25104. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.#ctor(NPOI.POIFS.FileSystem.BlockStore,System.Int32)">
  25105. Constructor for an existing stream. It's up to you
  25106. to know how to Get the start block (eg from a
  25107. {@link HeaderBlock} or a {@link Property})
  25108. </member>
  25109. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.#ctor(NPOI.POIFS.FileSystem.BlockStore)">
  25110. Constructor for a new stream. A start block won't
  25111. be allocated until you begin writing to it.
  25112. </member>
  25113. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.GetStartBlock">
  25114. What block does this stream start at?
  25115. Will be {@link POIFSConstants#END_OF_CHAIN} for a
  25116. new stream that hasn't been written to yet.
  25117. </member>
  25118. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.GetBlockIterator">
  25119. Returns an iterator that'll supply one {@link ByteBuffer}
  25120. per block in the stream.
  25121. </member>
  25122. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.UpdateContents(System.Byte[])">
  25123. Updates the contents of the stream to the new
  25124. Set of bytes.
  25125. Note - if this is property based, you'll still
  25126. need to update the size in the property yourself
  25127. </member>
  25128. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.Free">
  25129. Frees all blocks in the stream
  25130. </member>
  25131. <member name="T:NPOI.POIFS.FileSystem.ODocumentInputStream">
  25132. This class provides methods to read a DocumentEntry managed by a
  25133. {@link POIFSFileSystem} instance.
  25134. @author Marc Johnson (mjohnson at apache dot org)
  25135. </member>
  25136. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._current_offset">
  25137. current offset into the Document
  25138. </member>
  25139. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._marked_offset">
  25140. current marked offset into the Document (used by mark and Reset)
  25141. </member>
  25142. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._document_size">
  25143. the Document's size
  25144. </member>
  25145. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._closed">
  25146. have we been closed?
  25147. </member>
  25148. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._document">
  25149. the actual Document
  25150. </member>
  25151. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._currentBlock">
  25152. the data block Containing the current stream pointer
  25153. </member>
  25154. <member name="M:NPOI.POIFS.FileSystem.ODocumentInputStream.#ctor(NPOI.POIFS.FileSystem.DocumentEntry)">
  25155. Create an InputStream from the specified DocumentEntry
  25156. @param document the DocumentEntry to be read
  25157. @exception IOException if the DocumentEntry cannot be opened (like, maybe it has
  25158. been deleted?)
  25159. </member>
  25160. <member name="M:NPOI.POIFS.FileSystem.ODocumentInputStream.#ctor(NPOI.POIFS.FileSystem.OPOIFSDocument)">
  25161. Create an InputStream from the specified Document
  25162. @param document the Document to be read
  25163. </member>
  25164. <member name="M:NPOI.POIFS.FileSystem.ODocumentInputStream.Reset">
  25165. Repositions this stream to the position at the time the mark() method was
  25166. last called on this input stream. If mark() has not been called this
  25167. method repositions the stream to its beginning.
  25168. </member>
  25169. <member name="T:NPOI.POIFS.FileSystem.OfficeXmlFileException">
  25170. <summary>
  25171. This exception is thrown when we try to open a file that's actually
  25172. an Office 2007+ XML file, rather than an OLE2 file (which is what
  25173. POIFS works with)
  25174. </summary>
  25175. </member>
  25176. <member name="T:NPOI.POIFS.FileSystem.Ole10Native">
  25177. Represents an Ole10Native record which is wrapped around certain binary
  25178. files being embedded in OLE2 documents.
  25179. @author Rainer Schwarze
  25180. </member>
  25181. <member name="T:NPOI.POIFS.FileSystem.Ole10Native.EncodingMode">
  25182. the field encoding mode - merely a try-and-error guess ...
  25183. </member>
  25184. <member name="F:NPOI.POIFS.FileSystem.Ole10Native.EncodingMode.parsed">
  25185. the data is stored in parsed format - including label, command, etc.
  25186. </member>
  25187. <member name="F:NPOI.POIFS.FileSystem.Ole10Native.EncodingMode.unparsed">
  25188. the data is stored raw after the length field
  25189. </member>
  25190. <member name="F:NPOI.POIFS.FileSystem.Ole10Native.EncodingMode.compact">
  25191. the data is stored raw after the length field and the flags1 field
  25192. </member>
  25193. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.CreateFromEmbeddedOleObject(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  25194. <summary>
  25195. Creates an instance of this class from an embedded OLE Object. The OLE Object is expected
  25196. to include a stream &quot;{01}Ole10Native&quot; which Contains the actual
  25197. data relevant for this class.
  25198. </summary>
  25199. <param name="poifs">poifs POI Filesystem object</param>
  25200. <returns>Returns an instance of this class</returns>
  25201. </member>
  25202. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.CreateFromEmbeddedOleObject(NPOI.POIFS.FileSystem.DirectoryNode)">
  25203. <summary>
  25204. Creates an instance of this class from an embedded OLE Object. The OLE Object is expected
  25205. to include a stream &quot;{01}Ole10Native&quot; which contains the actual
  25206. data relevant for this class.
  25207. </summary>
  25208. <param name="directory">directory POI Filesystem object</param>
  25209. <returns>Returns an instance of this class</returns>
  25210. </member>
  25211. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.#ctor(System.String,System.String,System.String,System.Byte[])">
  25212. Creates an instance and fills the fields based on ... the fields
  25213. </member>
  25214. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.#ctor(System.Byte[],System.Int32)">
  25215. Creates an instance and Fills the fields based on the data in the given buffer.
  25216. @param data The buffer Containing the Ole10Native record
  25217. @param offset The start offset of the record in the buffer
  25218. @throws Ole10NativeException on invalid or unexcepted data format
  25219. </member>
  25220. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.TotalSize">
  25221. Returns the value of the totalSize field - the total length of the structure
  25222. is totalSize + 4 (value of this field + size of this field).
  25223. @return the totalSize
  25224. </member>
  25225. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Flags1">
  25226. Returns flags1 - currently unknown - usually 0x0002.
  25227. @return the flags1
  25228. </member>
  25229. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Label">
  25230. Returns the label field - usually the name of the file (without directory) but
  25231. probably may be any name specified during packaging/embedding the data.
  25232. @return the label
  25233. </member>
  25234. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.FileName">
  25235. Returns the fileName field - usually the name of the file being embedded
  25236. including the full path.
  25237. @return the fileName
  25238. </member>
  25239. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Flags2">
  25240. Returns flags2 - currently unknown - mostly 0x0000.
  25241. @return the flags2
  25242. </member>
  25243. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Unknown1">
  25244. Returns unknown1 field - currently unknown.
  25245. @return the unknown1
  25246. </member>
  25247. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Command">
  25248. Returns the command field - usually the name of the file being embedded
  25249. including the full path, may be a command specified during embedding the file.
  25250. @return the command
  25251. </member>
  25252. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.DataSize">
  25253. Returns the size of the embedded file. If the size is 0 (zero), no data has been
  25254. embedded. To be sure, that no data has been embedded, check whether
  25255. {@link #getDataBuffer()} returns <code>null</code>.
  25256. @return the dataSize
  25257. </member>
  25258. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.DataBuffer">
  25259. Returns the buffer Containing the embedded file's data, or <code>null</code>
  25260. if no data was embedded. Note that an embedding may provide information about
  25261. the data, but the actual data is not included. (So label, filename etc. are
  25262. available, but this method returns <code>null</code>.)
  25263. @return the dataBuffer
  25264. </member>
  25265. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Flags3">
  25266. Returns the flags3 - currently unknown.
  25267. @return the flags3
  25268. </member>
  25269. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.WriteOut(System.IO.Stream)">
  25270. Have the contents printer out into an OutputStream, used when writing a
  25271. file back out to disk (Normally, atom classes will keep their bytes
  25272. around, but non atom classes will just request the bytes from their
  25273. children, then chuck on their header and return)
  25274. </member>
  25275. <member name="T:NPOI.POIFS.FileSystem.OPOIFSDocument">
  25276. <summary>
  25277. This class manages a document in the POIFS filesystem.
  25278. @author Marc Johnson (mjohnson at apache dot org)
  25279. </summary>
  25280. </member>
  25281. <member name="M:NPOI.POIFS.FileSystem.OPOIFSDocument.#ctor(System.String,System.IO.Stream)">
  25282. <summary>
  25283. Initializes a new instance of the <see cref="T:NPOI.POIFS.FileSystem.OPOIFSDocument"/> class.
  25284. </summary>
  25285. <param name="name">the name of the POIFSDocument</param>
  25286. <param name="stream">the InputStream we read data from</param>
  25287. </member>
  25288. <member name="M:NPOI.POIFS.FileSystem.OPOIFSDocument.#ctor(System.String,NPOI.POIFS.Storage.ListManagedBlock[],System.Int32)">
  25289. <summary>
  25290. Constructor from small blocks
  25291. </summary>
  25292. <param name="name">the name of the POIFSDocument</param>
  25293. <param name="blocks">the small blocks making up the POIFSDocument</param>
  25294. <param name="length">the actual length of the POIFSDocument</param>
  25295. </member>
  25296. <member name="M:NPOI.POIFS.FileSystem.OPOIFSDocument.Read(System.Byte[],System.Int32)">
  25297. <summary>
  25298. read data from the internal stores
  25299. </summary>
  25300. <param name="buffer">the buffer to write to</param>
  25301. <param name="offset">the offset into our storage to read from</param>
  25302. </member>
  25303. <member name="M:NPOI.POIFS.FileSystem.OPOIFSDocument.WriteBlocks(System.IO.Stream)">
  25304. <summary>
  25305. Writes the blocks.
  25306. </summary>
  25307. <param name="stream">The stream.</param>
  25308. </member>
  25309. <member name="P:NPOI.POIFS.FileSystem.OPOIFSDocument.CountBlocks">
  25310. <summary>
  25311. Gets the number of BigBlock's this instance uses
  25312. </summary>
  25313. <value>count of BigBlock instances</value>
  25314. </member>
  25315. <member name="P:NPOI.POIFS.FileSystem.OPOIFSDocument.DocumentProperty">
  25316. <summary>
  25317. Gets the document property.
  25318. </summary>
  25319. <value>The document property.</value>
  25320. </member>
  25321. <member name="P:NPOI.POIFS.FileSystem.OPOIFSDocument.PreferArray">
  25322. <summary>
  25323. Provides a short description of the object to be used when a
  25324. POIFSViewable object has not provided its contents.
  25325. </summary>
  25326. <value><c>true</c> if [prefer array]; otherwise, <c>false</c>.</value>
  25327. </member>
  25328. <member name="P:NPOI.POIFS.FileSystem.OPOIFSDocument.ShortDescription">
  25329. <summary>
  25330. Gets the short description.
  25331. </summary>
  25332. <value>The short description.</value>
  25333. </member>
  25334. <member name="P:NPOI.POIFS.FileSystem.OPOIFSDocument.Size">
  25335. <summary>
  25336. Gets the size.
  25337. </summary>
  25338. <value>The size.</value>
  25339. </member>
  25340. <member name="P:NPOI.POIFS.FileSystem.OPOIFSDocument.SmallBlocks">
  25341. <summary>
  25342. Gets the small blocks.
  25343. </summary>
  25344. <value>The small blocks.</value>
  25345. </member>
  25346. <member name="P:NPOI.POIFS.FileSystem.OPOIFSDocument.StartBlock">
  25347. <summary>
  25348. Sets the start block for this instance
  25349. </summary>
  25350. <value>
  25351. index into the array of BigBlock instances making up the the filesystem
  25352. </value>
  25353. </member>
  25354. <member name="P:NPOI.POIFS.FileSystem.OPOIFSDocument.ViewableArray">
  25355. <summary>
  25356. Get an array of objects, some of which may implement POIFSViewable
  25357. </summary>
  25358. <value>The viewable array.</value>
  25359. </member>
  25360. <member name="P:NPOI.POIFS.FileSystem.OPOIFSDocument.ViewableIterator">
  25361. <summary>
  25362. Give viewers a hint as to whether to call ViewableArray or ViewableIterator
  25363. </summary>
  25364. <value>The viewable iterator.</value>
  25365. </member>
  25366. <member name="T:NPOI.POIFS.FileSystem.OPOIFSFileSystem">
  25367. <summary>
  25368. This is the main class of the POIFS system; it manages the entire
  25369. life cycle of the filesystem.
  25370. @author Marc Johnson (mjohnson at apache dot org)
  25371. </summary>
  25372. </member>
  25373. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.CreateNonClosingInputStream(System.IO.Stream)">
  25374. <summary>
  25375. Convenience method for clients that want to avoid the auto-Close behaviour of the constructor.
  25376. </summary>
  25377. <param name="stream">The stream.</param>
  25378. <example>
  25379. A convenience method (
  25380. CreateNonClosingInputStream()) has been provided for this purpose:
  25381. StreamwrappedStream = OPOIFSFileSystem.CreateNonClosingInputStream(is);
  25382. HSSFWorkbook wb = new HSSFWorkbook(wrappedStream);
  25383. is.reset();
  25384. doSomethingElse(is);
  25385. </example>
  25386. <returns></returns>
  25387. </member>
  25388. <member name="F:NPOI.POIFS.FileSystem.OPOIFSFileSystem.bigBlockSize">
  25389. What big block size the file uses. Most files
  25390. use 512 bytes, but a few use 4096
  25391. </member>
  25392. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.#ctor">
  25393. <summary>
  25394. Initializes a new instance of the <see cref="T:NPOI.POIFS.FileSystem.OPOIFSFileSystem"/> class. intended for writing
  25395. </summary>
  25396. </member>
  25397. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.#ctor(System.IO.Stream)">
  25398. <summary>
  25399. Create a OPOIFSFileSystem from an Stream. Normally the stream is Read until
  25400. EOF. The stream is always Closed. In the unlikely case that the caller has such a stream and
  25401. needs to use it after this constructor completes, a work around is to wrap the
  25402. stream in order to trap the Close() call.
  25403. </summary>
  25404. <param name="stream">the Streamfrom which to Read the data</param>
  25405. </member>
  25406. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.CloseInputStream(System.IO.Stream,System.Boolean)">
  25407. @param stream the stream to be Closed
  25408. @param success <c>false</c> if an exception is currently being thrown in the calling method
  25409. </member>
  25410. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.HasPOIFSHeader(NPOI.Util.InputStream)">
  25411. <summary>
  25412. Checks that the supplied Stream(which MUST
  25413. support mark and reset, or be a PushbackInputStream)
  25414. has a POIFS (OLE2) header at the start of it.
  25415. If your Streamdoes not support mark / reset,
  25416. then wrap it in a PushBackInputStream, then be
  25417. sure to always use that, and not the original!
  25418. </summary>
  25419. <param name="inp">An Streamwhich supports either mark/reset, or is a PushbackStream</param>
  25420. <returns>
  25421. <c>true</c> if [has POIFS header] [the specified inp]; otherwise, <c>false</c>.
  25422. </returns>
  25423. </member>
  25424. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.HasPOIFSHeader(System.Byte[])">
  25425. Checks if the supplied first 8 bytes of a stream / file
  25426. has a POIFS (OLE2) header.
  25427. </member>
  25428. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.CreateDocument(System.IO.Stream,System.String)">
  25429. <summary>
  25430. Create a new document to be Added to the root directory
  25431. </summary>
  25432. <param name="stream"> the Streamfrom which the document's data will be obtained</param>
  25433. <param name="name">the name of the new POIFSDocument</param>
  25434. <returns>the new DocumentEntry</returns>
  25435. </member>
  25436. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.CreateDocument(System.String,System.Int32,NPOI.POIFS.EventFileSystem.POIFSWriterListener)">
  25437. <summary>
  25438. Create a new DocumentEntry in the root entry; the data will be
  25439. provided later
  25440. </summary>
  25441. <param name="name">the name of the new DocumentEntry</param>
  25442. <param name="size">the size of the new DocumentEntry</param>
  25443. <param name="writer">the Writer of the new DocumentEntry</param>
  25444. <returns>the new DocumentEntry</returns>
  25445. </member>
  25446. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.CreateDirectory(System.String)">
  25447. <summary>
  25448. Create a new DirectoryEntry in the root directory
  25449. </summary>
  25450. <param name="name">the name of the new DirectoryEntry</param>
  25451. <returns>the new DirectoryEntry</returns>
  25452. </member>
  25453. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.CreateDocumentInputStream(System.String)">
  25454. open a document in the root entry's list of entries
  25455. @param documentName the name of the document to be opened
  25456. @return a newly opened DocumentInputStream
  25457. @exception IOException if the document does not exist or the
  25458. name is that of a DirectoryEntry
  25459. </member>
  25460. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.WriteFileSystem(System.IO.Stream)">
  25461. <summary>
  25462. Writes the file system.
  25463. </summary>
  25464. <param name="stream">the OutputStream to which the filesystem will be
  25465. written</param>
  25466. </member>
  25467. <member name="P:NPOI.POIFS.FileSystem.OPOIFSFileSystem.Root">
  25468. <summary>
  25469. Get the root entry
  25470. </summary>
  25471. <value>The root.</value>
  25472. </member>
  25473. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.AddDocument(NPOI.POIFS.FileSystem.OPOIFSDocument)">
  25474. <summary>
  25475. Add a new POIFSDocument
  25476. </summary>
  25477. <param name="document">the POIFSDocument being Added</param>
  25478. </member>
  25479. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.AddDirectory(NPOI.POIFS.Properties.DirectoryProperty)">
  25480. <summary>
  25481. Add a new DirectoryProperty
  25482. </summary>
  25483. <param name="directory">The directory.</param>
  25484. </member>
  25485. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.Remove(NPOI.POIFS.FileSystem.EntryNode)">
  25486. <summary>
  25487. Removes the specified entry.
  25488. </summary>
  25489. <param name="entry">The entry.</param>
  25490. </member>
  25491. <member name="P:NPOI.POIFS.FileSystem.OPOIFSFileSystem.ViewableArray">
  25492. <summary>
  25493. Get an array of objects, some of which may implement
  25494. POIFSViewable
  25495. </summary>
  25496. <value>an array of Object; may not be null, but may be empty</value>
  25497. </member>
  25498. <member name="P:NPOI.POIFS.FileSystem.OPOIFSFileSystem.ViewableIterator">
  25499. <summary>
  25500. Get an Iterator of objects, some of which may implement
  25501. POIFSViewable
  25502. </summary>
  25503. <value>an Iterator; may not be null, but may have an empty
  25504. back end store</value>
  25505. </member>
  25506. <member name="P:NPOI.POIFS.FileSystem.OPOIFSFileSystem.PreferArray">
  25507. <summary>
  25508. Give viewers a hint as to whether to call GetViewableArray or
  25509. GetViewableIterator
  25510. </summary>
  25511. <value><c>true</c> if a viewer should call GetViewableArray, <c>false</c> if
  25512. a viewer should call GetViewableIterator </value>
  25513. </member>
  25514. <member name="P:NPOI.POIFS.FileSystem.OPOIFSFileSystem.ShortDescription">
  25515. <summary>
  25516. Provides a short description of the object, to be used when a
  25517. POIFSViewable object has not provided its contents.
  25518. </summary>
  25519. <value>The short description.</value>
  25520. </member>
  25521. <member name="P:NPOI.POIFS.FileSystem.OPOIFSFileSystem.BigBlockSize">
  25522. <summary>
  25523. Gets The Big Block size, normally 512 bytes, sometimes 4096 bytes
  25524. </summary>
  25525. <value>The size of the big block.</value>
  25526. </member>
  25527. <member name="T:NPOI.POIFS.FileSystem.POIFSDocumentPath">
  25528. <summary>
  25529. Class POIFSDocumentPath
  25530. @author Marc Johnson (mjohnson at apache dot org)
  25531. </summary>
  25532. </member>
  25533. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.#ctor">
  25534. <summary>
  25535. simple constructor for the path of a document that is in the
  25536. root of the POIFSFileSystem. The constructor that takes an
  25537. array of Strings can also be used to create such a
  25538. POIFSDocumentPath by passing it a null or empty String array
  25539. </summary>
  25540. </member>
  25541. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.#ctor(System.String[])">
  25542. <summary>
  25543. constructor for the path of a document that is not in the root
  25544. of the POIFSFileSystem
  25545. </summary>
  25546. <param name="components">the Strings making up the path to a document.
  25547. The Strings must be ordered as they appear in
  25548. the directory hierarchy of the the document
  25549. -- the first string must be the name of a
  25550. directory in the root of the POIFSFileSystem,
  25551. and every Nth (for N &gt; 1) string thereafter
  25552. must be the name of a directory in the
  25553. directory identified by the (N-1)th string.
  25554. If the components parameter is null or has
  25555. zero length, the POIFSDocumentPath is
  25556. appropriate for a document that is in the
  25557. root of a POIFSFileSystem</param>
  25558. </member>
  25559. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.#ctor(NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String[])">
  25560. <summary>
  25561. constructor that adds additional subdirectories to an existing
  25562. path
  25563. </summary>
  25564. <param name="path">the existing path</param>
  25565. <param name="components">the additional subdirectory names to be added</param>
  25566. </member>
  25567. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.Equals(System.Object)">
  25568. <summary>
  25569. equality. Two POIFSDocumentPath instances are equal if they
  25570. have the same number of component Strings, and if each
  25571. component String is equal to its coresponding component String
  25572. </summary>
  25573. <param name="o">the object we're checking equality for</param>
  25574. <returns>true if the object is equal to this object</returns>
  25575. </member>
  25576. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.GetComponent(System.Int32)">
  25577. <summary>
  25578. get the specified component
  25579. </summary>
  25580. <param name="n">which component (0 ... length() - 1)</param>
  25581. <returns>the nth component;</returns>
  25582. </member>
  25583. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.GetHashCode">
  25584. <summary>
  25585. Serves as a hash function for a particular type.
  25586. </summary>
  25587. <returns>
  25588. A hash code for the current <see cref="T:System.Object"/>.
  25589. </returns>
  25590. </member>
  25591. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.ToString">
  25592. <summary>
  25593. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  25594. </summary>
  25595. <returns>
  25596. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  25597. </returns>
  25598. </member>
  25599. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentPath.Length">
  25600. <summary>
  25601. Gets the length.
  25602. </summary>
  25603. <value>the number of components</value>
  25604. </member>
  25605. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentPath.Parent">
  25606. <summary>
  25607. Returns the path's parent or <c>null</c> if this path
  25608. is the root path.
  25609. </summary>
  25610. <value>path of parent, or null if this path is the root path</value>
  25611. </member>
  25612. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentPath.Name">
  25613. <p>Returns the last name in the document path's name sequence.
  25614. If the document path's name sequence is empty, then the empty string is returned.</p>
  25615. @since 2016-04-09
  25616. @return The last name in the document path's name sequence, or empty string if this is the root path
  25617. </member>
  25618. <member name="T:NPOI.POIFS.FileSystem.POIFSDocumentReader">
  25619. <summary>
  25620. This class provides methods to read a DocumentEntry managed by a
  25621. Filesystem instance.
  25622. @author Marc Johnson (mjohnson at apache dot org)
  25623. </summary>
  25624. </member>
  25625. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.#ctor(NPOI.POIFS.FileSystem.DocumentEntry)">
  25626. <summary>
  25627. Create an InputStream from the specified DocumentEntry
  25628. </summary>
  25629. <param name="document">the DocumentEntry to be read</param>
  25630. </member>
  25631. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.#ctor(NPOI.POIFS.FileSystem.OPOIFSDocument)">
  25632. <summary>
  25633. Create an InputStream from the specified Document
  25634. </summary>
  25635. <param name="document">the Document to be read</param>
  25636. </member>
  25637. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.EOD">
  25638. <summary>
  25639. at the end Of document.
  25640. </summary>
  25641. <returns></returns>
  25642. </member>
  25643. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.Available">
  25644. <summary>
  25645. Returns the number of bytes that can be read (or skipped over)
  25646. from this input stream without blocking by the next caller of a
  25647. method for this input stream. The next caller might be the same
  25648. thread or or another thread.
  25649. </summary>
  25650. <value>the number of bytes that can be read from this input
  25651. stream without blocking.</value>
  25652. </member>
  25653. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Close">
  25654. <summary>
  25655. Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.
  25656. </summary>
  25657. </member>
  25658. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Read(System.Byte[])">
  25659. <summary>
  25660. Reads some number of bytes from the input stream and stores
  25661. them into the buffer array b. The number of bytes actually read
  25662. is returned as an integer. The definition of this method in
  25663. java.io.InputStream allows this method to block, but it won't.
  25664. If b is null, a NullPointerException is thrown. If the length
  25665. of b is zero, then no bytes are read and 0 is returned;
  25666. otherwise, there is an attempt to read at least one byte. If no
  25667. byte is available because the stream is at end of file, the
  25668. value -1 is returned; otherwise, at least one byte is read and
  25669. stored into b.
  25670. The first byte read is stored into element b[0], the next one
  25671. into b[1], and so on. The number of bytes read is, at most,
  25672. equal to the length of b. Let k be the number of bytes actually
  25673. read; these bytes will be stored in elements b[0] through
  25674. b[k-1], leaving elements b[k] through b[b.length-1] unaffected.
  25675. If the first byte cannot be read for any reason other than end
  25676. of file, then an IOException is thrown. In particular, an
  25677. IOException is thrown if the input stream has been closed.
  25678. The read(b) method for class InputStream has the same effect as:
  25679. </summary>
  25680. <param name="b">the buffer into which the data is read.</param>
  25681. <returns>the total number of bytes read into the buffer, or -1
  25682. if there is no more data because the end of the stream
  25683. has been reached.</returns>
  25684. </member>
  25685. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Read(System.Byte[],System.Int32,System.Int32)">
  25686. <summary>
  25687. Reads up to len bytes of data from the input stream into an
  25688. array of bytes. An attempt is made to read as many as len
  25689. bytes, but a smaller number may be read, possibly zero. The
  25690. number of bytes actually read is returned as an integer.
  25691. The definition of this method in java.io.InputStream allows it
  25692. to block, but it won't.
  25693. If b is null, a NullPointerException is thrown.
  25694. If off is negative, or len is negative, or off+len is greater
  25695. than the length of the array b, then an
  25696. IndexOutOfBoundsException is thrown.
  25697. If len is zero, then no bytes are read and 0 is returned;
  25698. otherwise, there is an attempt to read at least one byte. If no
  25699. byte is available because the stream is at end of file, the
  25700. value -1 is returned; otherwise, at least one byte is read and
  25701. stored into b.
  25702. The first byte read is stored into element b[off], the next one
  25703. into b[off+1], and so on. The number of bytes read is, at most,
  25704. equal to len. Let k be the number of bytes actually read; these
  25705. bytes will be stored in elements b[off] through b[off+k-1],
  25706. leaving elements b[off+k] through b[off+len-1] unaffected.
  25707. In every case, elements b[0] through b[off] and elements
  25708. b[off+len] through b[b.length-1] are unaffected.
  25709. If the first byte cannot be read for any reason other than end
  25710. of file, then an IOException is thrown. In particular, an
  25711. IOException is thrown if the input stream has been closed.
  25712. </summary>
  25713. <param name="b">the buffer into which the data is read.</param>
  25714. <param name="off">the start offset in array b at which the data is
  25715. written.</param>
  25716. <param name="len">the maximum number of bytes to read.</param>
  25717. <returns>the total number of bytes read into the buffer, or -1
  25718. if there is no more data because the end of the stream
  25719. has been reached.</returns>
  25720. </member>
  25721. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.ReadByte">
  25722. <summary>
  25723. Reads the next byte of data from the input stream. The value
  25724. byte is returned as an int in the range 0 to 255. If no byte is
  25725. available because the end of the stream has been reached, the
  25726. value -1 is returned. The definition of this method in
  25727. java.io.InputStream allows this method to block, but it won't.
  25728. </summary>
  25729. <returns>the next byte of data, or -1 if the end of the stream
  25730. is reached.
  25731. </returns>
  25732. </member>
  25733. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Seek(System.Int64,System.IO.SeekOrigin)">
  25734. <summary>
  25735. When overridden in a derived class, sets the position within the current stream.
  25736. </summary>
  25737. <param name="offset">A byte offset relative to the <paramref name="origin"/> parameter.</param>
  25738. <param name="origin">A value of type <see cref="T:System.IO.SeekOrigin"/> indicating the reference point used to obtain the new position.</param>
  25739. <returns>
  25740. The new position within the current stream.
  25741. </returns>
  25742. <exception cref="T:System.IO.IOException">
  25743. An I/O error occurs.
  25744. </exception>
  25745. <exception cref="T:System.NotSupportedException">
  25746. The stream does not support seeking, such as if the stream is constructed from a pipe or console output.
  25747. </exception>
  25748. <exception cref="T:System.ObjectDisposedException">
  25749. Methods were called after the stream was closed.
  25750. </exception>
  25751. </member>
  25752. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Skip(System.Int64)">
  25753. <summary>
  25754. Skips the specified n.
  25755. </summary>
  25756. <param name="n">The n.</param>
  25757. <returns></returns>
  25758. </member>
  25759. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Write(System.Byte[],System.Int32,System.Int32)">
  25760. <summary>
  25761. When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
  25762. </summary>
  25763. <param name="buffer">An array of bytes. This method copies <paramref name="count"/> bytes from <paramref name="buffer"/> to the current stream.</param>
  25764. <param name="offset">The zero-based byte offset in <paramref name="buffer"/> at which to begin copying bytes to the current stream.</param>
  25765. <param name="count">The number of bytes to be written to the current stream.</param>
  25766. <exception cref="T:System.ArgumentException">
  25767. The sum of <paramref name="offset"/> and <paramref name="count"/> is greater than the buffer length.
  25768. </exception>
  25769. <exception cref="T:System.ArgumentNullException">
  25770. <paramref name="buffer"/> is null.
  25771. </exception>
  25772. <exception cref="T:System.ArgumentOutOfRangeException">
  25773. <paramref name="offset"/> or <paramref name="count"/> is negative.
  25774. </exception>
  25775. <exception cref="T:System.IO.IOException">
  25776. An I/O error occurs.
  25777. </exception>
  25778. <exception cref="T:System.NotSupportedException">
  25779. The stream does not support writing.
  25780. </exception>
  25781. <exception cref="T:System.ObjectDisposedException">
  25782. Methods were called after the stream was closed.
  25783. </exception>
  25784. </member>
  25785. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.CanRead">
  25786. <summary>
  25787. When overridden in a derived class, gets a value indicating whether the current stream supports reading.
  25788. </summary>
  25789. <value></value>
  25790. <returns>true if the stream supports reading; otherwise, false.
  25791. </returns>
  25792. </member>
  25793. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.CanSeek">
  25794. <summary>
  25795. When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
  25796. </summary>
  25797. <value></value>
  25798. <returns>true if the stream supports seeking; otherwise, false.
  25799. </returns>
  25800. </member>
  25801. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.CanWrite">
  25802. <summary>
  25803. When overridden in a derived class, gets a value indicating whether the current stream supports writing.
  25804. </summary>
  25805. <value></value>
  25806. <returns>true if the stream supports writing; otherwise, false.
  25807. </returns>
  25808. </member>
  25809. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.Length">
  25810. <summary>
  25811. When overridden in a derived class, gets the length in bytes of the stream.
  25812. </summary>
  25813. <value></value>
  25814. <returns>
  25815. A long value representing the length of the stream in bytes.
  25816. </returns>
  25817. <exception cref="T:System.NotSupportedException">
  25818. A class derived from Stream does not support seeking.
  25819. </exception>
  25820. <exception cref="T:System.ObjectDisposedException">
  25821. Methods were called after the stream was closed.
  25822. </exception>
  25823. </member>
  25824. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.Position">
  25825. <summary>
  25826. When overridden in a derived class, gets or sets the position within the current stream.
  25827. </summary>
  25828. <value></value>
  25829. <returns>
  25830. The current position within the stream.
  25831. </returns>
  25832. <exception cref="T:System.IO.IOException">
  25833. An I/O error occurs.
  25834. </exception>
  25835. <exception cref="T:System.NotSupportedException">
  25836. The stream does not support seeking.
  25837. </exception>
  25838. <exception cref="T:System.ObjectDisposedException">
  25839. Methods were called after the stream was closed.
  25840. </exception>
  25841. </member>
  25842. <member name="T:NPOI.POIFS.FileSystem.POIFSDocumentWriter">
  25843. <summary>
  25844. This class provides a wrapper over an OutputStream so that Document
  25845. writers can't accidently go over their size limits
  25846. @author Marc Johnson (mjohnson at apache dot org)
  25847. </summary>
  25848. </member>
  25849. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.#ctor(System.IO.Stream,System.Int32)">
  25850. <summary>
  25851. Create a POIFSDocumentWriter
  25852. </summary>
  25853. <param name="stream">the OutputStream to which the data is actually</param>
  25854. <param name="limit">the maximum number of bytes that can be written</param>
  25855. </member>
  25856. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Close">
  25857. <summary>
  25858. Closes this output stream and releases any system resources
  25859. associated with this stream. The general contract of close is
  25860. that it closes the output stream. A closed stream cannot
  25861. perform output operations and cannot be reopened.
  25862. </summary>
  25863. </member>
  25864. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Flush">
  25865. <summary>
  25866. Flushes this output stream and forces any buffered output bytes
  25867. to be written out.
  25868. </summary>
  25869. </member>
  25870. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Write(System.Byte[])">
  25871. <summary>
  25872. Writes b.length bytes from the specified byte array
  25873. to this output stream.
  25874. </summary>
  25875. <param name="b">the data.</param>
  25876. </member>
  25877. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Write(System.Byte[],System.Int32,System.Int32)">
  25878. <summary>
  25879. Writes len bytes from the specified byte array starting at
  25880. offset off to this output stream. The general contract for
  25881. write(b, off, len) is that some of the bytes in the array b are
  25882. written to the output stream in order; element b[off] is the
  25883. first byte written and b[off+len-1] is the last byte written by
  25884. this operation.
  25885. If b is null, a NullPointerException is thrown.
  25886. If off is negative, or len is negative, or off+len is greater
  25887. than the length of the array b, then an
  25888. IndexOutOfBoundsException is thrown.
  25889. </summary>
  25890. <param name="b">the data.</param>
  25891. <param name="off">the start offset in the data.</param>
  25892. <param name="len">the number of bytes to write.</param>
  25893. </member>
  25894. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.WriteByte(System.Byte)">
  25895. <summary>
  25896. Writes the specified byte to this output stream. The general
  25897. contract for write is that one byte is written to the output
  25898. stream. The byte to be written is the eight low-order bits of
  25899. the argument b. The 24 high-order bits of b are ignored.
  25900. </summary>
  25901. <param name="b">the byte.</param>
  25902. </member>
  25903. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.WriteFiller(System.Int32,System.Byte)">
  25904. <summary>
  25905. write the rest of the document's data (fill in at the end)
  25906. </summary>
  25907. <param name="totalLimit">the actual number of bytes the corresponding
  25908. document must fill</param>
  25909. <param name="fill">the byte to fill remaining space with</param>
  25910. </member>
  25911. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentWriter.CanRead">
  25912. <summary>
  25913. When overridden in a derived class, gets a value indicating whether the current stream supports reading.
  25914. </summary>
  25915. <value></value>
  25916. <returns>true if the stream supports reading; otherwise, false.
  25917. </returns>
  25918. </member>
  25919. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentWriter.CanSeek">
  25920. <summary>
  25921. When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
  25922. </summary>
  25923. <value></value>
  25924. <returns>true if the stream supports seeking; otherwise, false.
  25925. </returns>
  25926. </member>
  25927. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentWriter.CanWrite">
  25928. <summary>
  25929. When overridden in a derived class, gets a value indicating whether the current stream supports writing.
  25930. </summary>
  25931. <value></value>
  25932. <returns>true if the stream supports writing; otherwise, false.
  25933. </returns>
  25934. </member>
  25935. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Length">
  25936. <summary>
  25937. When overridden in a derived class, gets the length in bytes of the stream.
  25938. </summary>
  25939. <value></value>
  25940. <returns>
  25941. A long value representing the length of the stream in bytes.
  25942. </returns>
  25943. <exception cref="T:System.NotSupportedException">
  25944. A class derived from Stream does not support seeking.
  25945. </exception>
  25946. <exception cref="T:System.ObjectDisposedException">
  25947. Methods were called after the stream was closed.
  25948. </exception>
  25949. </member>
  25950. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Position">
  25951. <summary>
  25952. When overridden in a derived class, gets or sets the position within the current stream.
  25953. </summary>
  25954. <value></value>
  25955. <returns>
  25956. The current position within the stream.
  25957. </returns>
  25958. <exception cref="T:System.IO.IOException">
  25959. An I/O error occurs.
  25960. </exception>
  25961. <exception cref="T:System.NotSupportedException">
  25962. The stream does not support seeking.
  25963. </exception>
  25964. <exception cref="T:System.ObjectDisposedException">
  25965. Methods were called after the stream was closed.
  25966. </exception>
  25967. </member>
  25968. <member name="T:NPOI.POIFS.FileSystem.POIFSFileSystem">
  25969. <summary>
  25970. This is the main class of the POIFS system; it manages the entire
  25971. life cycle of the filesystem.
  25972. @author Marc Johnson (mjohnson at apache dot org)
  25973. </summary>
  25974. </member>
  25975. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.CreateNonClosingInputStream(System.IO.Stream)">
  25976. <summary>
  25977. Convenience method for clients that want to avoid the auto-Close behaviour of the constructor.
  25978. </summary>
  25979. <param name="stream">The stream.</param>
  25980. <example>
  25981. A convenience method (
  25982. CreateNonClosingInputStream()) has been provided for this purpose:
  25983. StreamwrappedStream = POIFSFileSystem.CreateNonClosingInputStream(is);
  25984. HSSFWorkbook wb = new HSSFWorkbook(wrappedStream);
  25985. is.reset();
  25986. doSomethingElse(is);
  25987. </example>
  25988. <returns></returns>
  25989. </member>
  25990. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.#ctor">
  25991. <summary>
  25992. Initializes a new instance of the <see cref="T:NPOI.POIFS.FileSystem.POIFSFileSystem"/> class. intended for writing
  25993. </summary>
  25994. </member>
  25995. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.#ctor(System.IO.Stream)">
  25996. <summary>
  25997. Create a POIFSFileSystem from an Stream. Normally the stream is Read until
  25998. EOF. The stream is always Closed. In the unlikely case that the caller has such a stream and
  25999. needs to use it after this constructor completes, a work around is to wrap the
  26000. stream in order to trap the Close() call.
  26001. </summary>
  26002. <param name="stream">the Streamfrom which to Read the data</param>
  26003. </member>
  26004. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.#ctor(System.IO.FileInfo,System.Boolean)">
  26005. <p>Creates a POIFSFileSystem from a <tt>File</tt>. This uses less memory than
  26006. creating from an <tt>InputStream</tt>.</p>
  26007. <p>Note that with this constructor, you will need to call {@link #close()}
  26008. when you're done to have the underlying file closed, as the file is
  26009. kept open during normal operation to read the data out.</p>
  26010. @param readOnly whether the POIFileSystem will only be used in read-only mode
  26011. @param file the File from which to read the data
  26012. @exception IOException on errors reading, or on invalid data
  26013. </member>
  26014. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.#ctor(System.IO.FileInfo)">
  26015. <p>Creates a POIFSFileSystem from a <tt>File</tt>. This uses less memory than
  26016. creating from an <tt>InputStream</tt>. The File will be opened read-only</p>
  26017. <p>Note that with this constructor, you will need to call {@link #close()}
  26018. when you're done to have the underlying file closed, as the file is
  26019. kept open during normal operation to read the data out.</p>
  26020. @param file the File from which to read the data
  26021. @exception IOException on errors reading, or on invalid data
  26022. </member>
  26023. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.HasPOIFSHeader(System.IO.Stream)">
  26024. <summary>
  26025. Checks that the supplied Stream(which MUST
  26026. support mark and reset, or be a PushbackInputStream)
  26027. has a POIFS (OLE2) header at the start of it.
  26028. If your Streamdoes not support mark / reset,
  26029. then wrap it in a PushBackInputStream, then be
  26030. sure to always use that, and not the original!
  26031. </summary>
  26032. <param name="inp">An Streamwhich supports either mark/reset, or is a PushbackStream</param>
  26033. <returns>
  26034. <c>true</c> if [has POIFS header] [the specified inp]; otherwise, <c>false</c>.
  26035. </returns>
  26036. </member>
  26037. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.HasPOIFSHeader(System.Byte[])">
  26038. Checks if the supplied first 8 bytes of a stream / file
  26039. has a POIFS (OLE2) header.
  26040. </member>
  26041. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.Create(System.IO.FileInfo)">
  26042. Creates a new {@link POIFSFileSystem} in a new {@link File}.
  26043. Use {@link #POIFSFileSystem(File)} to open an existing File,
  26044. this should only be used to create a new empty filesystem.
  26045. @param file The file to create and open
  26046. @return The created and opened {@link POIFSFileSystem}
  26047. </member>
  26048. <member name="T:NPOI.POIFS.Macros.VBAMacroExtractor">
  26049. This tool extracts out the source of all VBA Modules of an office file,
  26050. both OOXML (eg XLSM) and OLE2/POIFS (eg DOC), to STDOUT or a directory.
  26051. @since 3.15-beta2
  26052. </member>
  26053. <member name="M:NPOI.POIFS.Macros.VBAMacroExtractor.Extract(System.IO.FileInfo,System.IO.DirectoryInfo,System.String)">
  26054. Extracts the VBA modules from a macro-enabled office file and Writes them
  26055. to files in <tt>outputDir</tt>.
  26056. Creates the <tt>outputDir</tt>, directory, including any necessary but
  26057. nonexistent parent directories, if <tt>outputDir</tt> does not exist.
  26058. If <tt>outputDir</tt> is null, Writes the contents to standard out instead.
  26059. @param input the macro-enabled office file.
  26060. @param outputDir the directory to write the extracted VBA modules to.
  26061. @param extension file extension of the extracted VBA modules
  26062. @since 3.15-beta2
  26063. </member>
  26064. <member name="M:NPOI.POIFS.Macros.VBAMacroExtractor.Extract(System.IO.FileInfo,System.IO.DirectoryInfo)">
  26065. Extracts the VBA modules from a macro-enabled office file and Writes them
  26066. to <tt>.vba</tt> files in <tt>outputDir</tt>.
  26067. Creates the <tt>outputDir</tt>, directory, including any necessary but
  26068. nonexistent parent directories, if <tt>outputDir</tt> does not exist.
  26069. If <tt>outputDir</tt> is null, Writes the contents to standard out instead.
  26070. @param input the macro-enabled office file.
  26071. @param outputDir the directory to write the extracted VBA modules to.
  26072. @since 3.15-beta2
  26073. </member>
  26074. <member name="T:NPOI.POIFS.Macros.VBAMacroReader">
  26075. Finds all VBA Macros in an office file (OLE2/POIFS and OOXML/OPC),
  26076. and returns them.
  26077. @since 3.15-beta2
  26078. </member>
  26079. <member name="M:NPOI.POIFS.Macros.VBAMacroReader.ReadMacros">
  26080. Reads all macros from all modules of the opened office file.
  26081. @return All the macros and their contents
  26082. @since 3.15-beta2
  26083. </member>
  26084. <member name="M:NPOI.POIFS.Macros.VBAMacroReader.FindMacros(NPOI.POIFS.FileSystem.DirectoryNode,NPOI.POIFS.Macros.VBAMacroReader.ModuleMap)">
  26085. Recursively traverses directory structure rooted at <tt>dir</tt>.
  26086. For each macro module that is found, the module's name and code are
  26087. Added to <tt>modules</tt>.
  26088. @param dir
  26089. @param modules
  26090. @throws IOException
  26091. @since 3.15-beta2
  26092. </member>
  26093. <member name="M:NPOI.POIFS.Macros.VBAMacroReader.ReadString(NPOI.Util.InputStream,System.Int32,System.Text.Encoding)">
  26094. Read <tt>length</tt> bytes of MBCS (multi-byte character Set) characters from the stream
  26095. @param stream the inputstream to read from
  26096. @param length number of bytes to read from stream
  26097. @param charset the character Set encoding of the bytes in the stream
  26098. @return a java String in the supplied character Set
  26099. @throws IOException
  26100. </member>
  26101. <member name="M:NPOI.POIFS.Macros.VBAMacroReader.ReadModule(NPOI.Util.RLEDecompressingInputStream,System.String,NPOI.POIFS.Macros.VBAMacroReader.ModuleMap)">
  26102. Reads module from DIR node in input stream and Adds it to the modules map for decompression later
  26103. on the second pass through this function, the module will be decompressed
  26104. Side-effects: Adds a new module to the module map or Sets the buf field on the module
  26105. to the decompressed stream contents (the VBA code for one module)
  26106. @param in the Run-length encoded input stream to read from
  26107. @param streamName the stream name of the module
  26108. @param modules a map to store the modules
  26109. @throws IOException
  26110. </member>
  26111. <member name="M:NPOI.POIFS.Macros.VBAMacroReader.TrySkip(NPOI.Util.InputStream,System.Int64)">
  26112. Skips <tt>n</tt> bytes in an input stream, throwing IOException if the
  26113. number of bytes skipped is different than requested.
  26114. @throws IOException
  26115. </member>
  26116. <member name="M:NPOI.POIFS.Macros.VBAMacroReader.ReadMacros(NPOI.POIFS.FileSystem.DirectoryNode,NPOI.POIFS.Macros.VBAMacroReader.ModuleMap)">
  26117. Reads VBA Project modules from a VBA Project directory located at
  26118. <tt>macroDir</tt> into <tt>modules</tt>.
  26119. @since 3.15-beta2
  26120. </member>
  26121. <member name="T:NPOI.POIFS.NIO.ByteArrayBackedDataSource">
  26122. <summary>
  26123. A POIFS <see cref="T:NPOI.POIFS.NIO.DataSource"/> backed by a byte array.
  26124. </summary>
  26125. </member>
  26126. <member name="T:NPOI.POIFS.NIO.DataSource">
  26127. <summary>
  26128. Common definition of how we read and write bytes
  26129. </summary>
  26130. </member>
  26131. <member name="M:NPOI.POIFS.NIO.DataSource.Close">
  26132. <summary>
  26133. Close the underlying stream
  26134. </summary>
  26135. </member>
  26136. <member name="M:NPOI.POIFS.NIO.DataSource.CopyTo(System.IO.Stream)">
  26137. <summary>
  26138. Copies the contents to the specified Stream
  26139. </summary>
  26140. <param name="stream"></param>
  26141. </member>
  26142. <member name="T:NPOI.POIFS.NIO.FileBackedDataSource">
  26143. <summary>
  26144. A POIFS DataSource backed by a File
  26145. TODO - Return the ByteBuffers in such a way that in RW mode,
  26146. changes to the buffer end up on the disk (will fix the HPSF TestWrite
  26147. currently failing unit test when done)
  26148. </summary>
  26149. </member>
  26150. <member name="M:NPOI.POIFS.NIO.FileBackedDataSource.Read(System.Int32,System.Int64)">
  26151. <summary>
  26152. Reads a sequence of bytes from this FileStream starting at the given file position.
  26153. </summary>
  26154. <param name="length"></param>
  26155. <param name="position">The file position at which the transfer is to begin;</param>
  26156. <returns></returns>
  26157. </member>
  26158. <member name="M:NPOI.POIFS.NIO.FileBackedDataSource.Write(NPOI.Util.ByteBuffer,System.Int64)">
  26159. <summary>
  26160. Writes a sequence of bytes to this FileStream from the given Stream,
  26161. starting at the given file position.
  26162. </summary>
  26163. <param name="src">The Stream from which bytes are to be transferred</param>
  26164. <param name="position">The file position at which the transfer is to begin;
  26165. must be non-negative</param>
  26166. </member>
  26167. <member name="T:NPOI.POIFS.Properties.Child">
  26168. <summary>
  26169. This interface defines methods for finding and setting sibling
  26170. Property instances
  26171. @author Marc Johnson (mjohnson at apache dot org)
  26172. </summary>
  26173. </member>
  26174. <member name="P:NPOI.POIFS.Properties.Child.PreviousChild">
  26175. <summary>
  26176. Gets or sets the previous child.
  26177. </summary>
  26178. <value>The previous child.</value>
  26179. </member>
  26180. <member name="P:NPOI.POIFS.Properties.Child.NextChild">
  26181. <summary>
  26182. Gets or sets the next child.
  26183. </summary>
  26184. <value>The next child.</value>
  26185. </member>
  26186. <member name="T:NPOI.POIFS.Properties.DirectoryProperty">
  26187. <summary>
  26188. Trivial extension of Property for POIFSDocuments
  26189. @author Marc Johnson (mjohnson at apache dot org)
  26190. </summary>
  26191. </member>
  26192. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.#ctor(System.String)">
  26193. <summary>
  26194. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.DirectoryProperty"/> class.
  26195. </summary>
  26196. <param name="name">the name of the directory</param>
  26197. </member>
  26198. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.#ctor(System.Int32,System.Byte[],System.Int32)">
  26199. <summary>
  26200. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.DirectoryProperty"/> class.
  26201. </summary>
  26202. <param name="index">index number</param>
  26203. <param name="array">byte data</param>
  26204. <param name="offset">offset into byte data</param>
  26205. </member>
  26206. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.ChangeName(NPOI.POIFS.Properties.Property,System.String)">
  26207. <summary>
  26208. Change a Property's name
  26209. </summary>
  26210. <param name="property">the Property whose name Is being Changed.</param>
  26211. <param name="newName">the new name for the Property</param>
  26212. <returns>true if the name Change could be made, else false</returns>
  26213. </member>
  26214. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.DeleteChild(NPOI.POIFS.Properties.Property)">
  26215. <summary>
  26216. Delete a Property
  26217. </summary>
  26218. <param name="property">the Property being Deleted</param>
  26219. <returns>true if the Property could be Deleted, else false</returns>
  26220. </member>
  26221. <member name="T:NPOI.POIFS.Properties.DirectoryProperty.PropertyComparator">
  26222. <summary>
  26223. Directory Property Comparer
  26224. </summary>
  26225. </member>
  26226. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.PropertyComparator.Equals(System.Object)">
  26227. <summary>
  26228. Object equality, implemented as object identity
  26229. </summary>
  26230. <param name="o">Object we're being Compared to</param>
  26231. <returns>true if identical, else false</returns>
  26232. </member>
  26233. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.PropertyComparator.Compare(NPOI.POIFS.Properties.Property,NPOI.POIFS.Properties.Property)">
  26234. <summary>
  26235. Compare method. Assumes both parameters are non-null
  26236. instances of Property. One property is less than another if
  26237. its name is shorter than the other property's name. If the
  26238. names are the same length, the property whose name comes
  26239. before the other property's name, alphabetically, is less
  26240. than the other property.
  26241. </summary>
  26242. <param name="o1">first object to compare, better be a Property</param>
  26243. <param name="o2">second object to compare, better be a Property</param>
  26244. <returns>negative value if o1 smaller than o2,
  26245. zero if o1 equals o2,
  26246. positive value if o1 bigger than o2.</returns>
  26247. </member>
  26248. <member name="P:NPOI.POIFS.Properties.DirectoryProperty.IsDirectory">
  26249. <summary>
  26250. Gets a value indicating whether this instance is directory.
  26251. </summary>
  26252. <value>
  26253. <c>true</c> if a directory type Property; otherwise, <c>false</c>.
  26254. </value>
  26255. </member>
  26256. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.PreWrite">
  26257. <summary>
  26258. Perform whatever activities need to be performed prior to
  26259. writing
  26260. </summary>
  26261. </member>
  26262. <member name="P:NPOI.POIFS.Properties.DirectoryProperty.Children">
  26263. <summary>
  26264. Get an iterator over the children of this Parent; all elements
  26265. are instances of Property.
  26266. </summary>
  26267. <value>Iterator of children; may refer to an empty collection</value>
  26268. </member>
  26269. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.AddChild(NPOI.POIFS.Properties.Property)">
  26270. <summary>
  26271. Add a new child to the collection of children
  26272. </summary>
  26273. <param name="property">the new child to be added; must not be null</param>
  26274. </member>
  26275. <member name="T:NPOI.POIFS.Properties.DocumentProperty">
  26276. <summary>
  26277. Trivial extension of Property for POIFSDocuments
  26278. @author Marc Johnson (mjohnson at apache dot org)
  26279. </summary>
  26280. </member>
  26281. <member name="M:NPOI.POIFS.Properties.DocumentProperty.#ctor(System.String,System.Int32)">
  26282. <summary>
  26283. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.DocumentProperty"/> class.
  26284. </summary>
  26285. <param name="name">POIFSDocument name</param>
  26286. <param name="size">POIFSDocument size</param>
  26287. </member>
  26288. <member name="M:NPOI.POIFS.Properties.DocumentProperty.#ctor(System.Int32,System.Byte[],System.Int32)">
  26289. <summary>
  26290. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.DocumentProperty"/> class.
  26291. </summary>
  26292. <param name="index">index number</param>
  26293. <param name="array">byte data</param>
  26294. <param name="offset">offset into byte data</param>
  26295. </member>
  26296. <member name="P:NPOI.POIFS.Properties.DocumentProperty.Document">
  26297. <summary>
  26298. Gets or sets the document.
  26299. </summary>
  26300. <value>the associated POIFSDocument</value>
  26301. </member>
  26302. <member name="P:NPOI.POIFS.Properties.DocumentProperty.IsDirectory">
  26303. <summary>
  26304. Determines whether this instance is directory.
  26305. </summary>
  26306. <returns>
  26307. <c>true</c> if this instance is directory; otherwise, <c>false</c>.
  26308. </returns>
  26309. </member>
  26310. <member name="M:NPOI.POIFS.Properties.DocumentProperty.PreWrite">
  26311. <summary>
  26312. Perform whatever activities need to be performed prior to
  26313. writing
  26314. </summary>
  26315. </member>
  26316. <member name="M:NPOI.POIFS.Properties.DocumentProperty.UpdateSize(System.Int32)">
  26317. Update the size of the property's data
  26318. </member>
  26319. <member name="M:NPOI.POIFS.Properties.NPropertyTable.PreWrite">
  26320. Prepare to be written
  26321. </member>
  26322. <member name="T:NPOI.POIFS.Properties.Parent">
  26323. <summary>
  26324. Behavior for parent (directory) properties
  26325. @author Marc Johnson27591@hotmail.com
  26326. </summary>
  26327. </member>
  26328. <member name="P:NPOI.POIFS.Properties.Parent.Children">
  26329. <summary>
  26330. Get an iterator over the children of this Parent
  26331. all elements are instances of Property.
  26332. </summary>
  26333. <returns></returns>
  26334. </member>
  26335. <member name="M:NPOI.POIFS.Properties.Parent.AddChild(NPOI.POIFS.Properties.Property)">
  26336. <summary>
  26337. Add a new child to the collection of children
  26338. </summary>
  26339. <param name="property">the new child to be added; must not be null</param>
  26340. </member>
  26341. <member name="P:NPOI.POIFS.Properties.Parent.PreviousChild">
  26342. <summary>
  26343. Sets the previous child.
  26344. </summary>
  26345. </member>
  26346. <member name="P:NPOI.POIFS.Properties.Parent.NextChild">
  26347. <summary>
  26348. Sets the next child.
  26349. </summary>
  26350. </member>
  26351. <member name="T:NPOI.POIFS.Properties.Property">
  26352. <summary>
  26353. This abstract base class is the ancestor of all classes
  26354. implementing POIFS Property behavior.
  26355. @author Marc Johnson (mjohnson at apache dot org)
  26356. </summary>
  26357. </member>
  26358. <member name="M:NPOI.POIFS.Properties.Property.#ctor">
  26359. <summary>
  26360. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.Property"/> class.
  26361. </summary>
  26362. </member>
  26363. <member name="M:NPOI.POIFS.Properties.Property.#ctor(System.Int32,System.Byte[],System.Int32)">
  26364. <summary>
  26365. Constructor from byte data
  26366. </summary>
  26367. <param name="index">index number</param>
  26368. <param name="array">byte data</param>
  26369. <param name="offset">offset into byte data</param>
  26370. </member>
  26371. <member name="M:NPOI.POIFS.Properties.Property.WriteData(System.IO.Stream)">
  26372. <summary>
  26373. Write the raw data to an OutputStream.
  26374. </summary>
  26375. <param name="stream">the OutputStream to which the data Should be
  26376. written.</param>
  26377. </member>
  26378. <member name="P:NPOI.POIFS.Properties.Property.StartBlock">
  26379. <summary>
  26380. Gets or sets the start block for the document referred to by this
  26381. Property.
  26382. </summary>
  26383. <value>the start block index</value>
  26384. </member>
  26385. <member name="P:NPOI.POIFS.Properties.Property.ShouldUseSmallBlocks">
  26386. <summary>
  26387. Based on the currently defined size, Should this property use
  26388. small blocks?
  26389. </summary>
  26390. <returns>true if the size Is less than _big_block_minimum_bytes</returns>
  26391. </member>
  26392. <member name="M:NPOI.POIFS.Properties.Property.IsSmall(System.Int32)">
  26393. <summary>
  26394. does the length indicate a small document?
  26395. </summary>
  26396. <param name="length">length in bytes</param>
  26397. <returns>
  26398. <c>true</c> if the length Is less than
  26399. _big_block_minimum_bytes; otherwise, <c>false</c>.
  26400. </returns>
  26401. </member>
  26402. <member name="P:NPOI.POIFS.Properties.Property.Name">
  26403. <summary>
  26404. Gets or sets the name of this property
  26405. </summary>
  26406. <value>property name</value>
  26407. </member>
  26408. <member name="P:NPOI.POIFS.Properties.Property.IsDirectory">
  26409. <summary>
  26410. Gets a value indicating whether this instance is directory.
  26411. </summary>
  26412. <value>
  26413. <c>true</c> if a directory type Property; otherwise, <c>false</c>.
  26414. </value>
  26415. </member>
  26416. <member name="P:NPOI.POIFS.Properties.Property.StorageClsid">
  26417. <summary>
  26418. Gets or sets the storage class ID for this property stream. ThIs Is the Class ID
  26419. of the COM object which can read and write this property stream </summary>
  26420. <value>Storage Class ID</value>
  26421. </member>
  26422. <member name="P:NPOI.POIFS.Properties.Property.PropertyType">
  26423. <summary>
  26424. Set the property type. Makes no attempt to validate the value.
  26425. </summary>
  26426. <value>the property type (root, file, directory)</value>
  26427. </member>
  26428. <member name="P:NPOI.POIFS.Properties.Property.NodeColor">
  26429. <summary>
  26430. Sets the color of the node.
  26431. </summary>
  26432. <value>the node color (red or black)</value>
  26433. </member>
  26434. <member name="P:NPOI.POIFS.Properties.Property.ChildProperty">
  26435. <summary>
  26436. Sets the child property.
  26437. </summary>
  26438. <value>the child property's index in the Property Table</value>
  26439. </member>
  26440. <member name="P:NPOI.POIFS.Properties.Property.ChildIndex">
  26441. <summary>
  26442. Get the child property (its index in the Property Table)
  26443. </summary>
  26444. <value>The index of the child.</value>
  26445. </member>
  26446. <member name="P:NPOI.POIFS.Properties.Property.Size">
  26447. <summary>
  26448. Gets or sets the size of the document associated with this Property
  26449. </summary>
  26450. <value>the size of the document, in bytes</value>
  26451. </member>
  26452. <member name="P:NPOI.POIFS.Properties.Property.Index">
  26453. <summary>
  26454. Gets or sets the index.
  26455. </summary>
  26456. <value>The index.</value>
  26457. Get the index for this Property
  26458. @return the index of this Property within its Property Table
  26459. </member>
  26460. <member name="M:NPOI.POIFS.Properties.Property.PreWrite">
  26461. <summary>
  26462. Perform whatever activities need to be performed prior to
  26463. writing
  26464. </summary>
  26465. </member>
  26466. <member name="P:NPOI.POIFS.Properties.Property.NextChildIndex">
  26467. <summary>
  26468. Gets the index of the next child.
  26469. </summary>
  26470. <value>The index of the next child.</value>
  26471. </member>
  26472. <member name="P:NPOI.POIFS.Properties.Property.PreviousChildIndex">
  26473. <summary>
  26474. Gets the index of the previous child.
  26475. </summary>
  26476. <value>The index of the previous child.</value>
  26477. </member>
  26478. <member name="M:NPOI.POIFS.Properties.Property.IsValidIndex(System.Int32)">
  26479. <summary>
  26480. Determines whether the specified index Is valid
  26481. </summary>
  26482. <param name="index">value to be checked</param>
  26483. <returns>
  26484. <c>true</c> if the index Is valid; otherwise, <c>false</c>.
  26485. </returns>
  26486. </member>
  26487. <member name="P:NPOI.POIFS.Properties.Property.PreviousChild">
  26488. <summary>
  26489. Gets or sets the previous child.
  26490. </summary>
  26491. <value>the new 'previous' child; may be null, which has
  26492. the effect of saying there Is no 'previous' child</value>
  26493. </member>
  26494. <member name="P:NPOI.POIFS.Properties.Property.NextChild">
  26495. <summary>
  26496. Gets or sets the next Child
  26497. </summary>
  26498. <value> the new 'next' child; may be null, which has the
  26499. effect of saying there Is no 'next' child</value>
  26500. </member>
  26501. <member name="P:NPOI.POIFS.Properties.Property.ViewableArray">
  26502. <summary>
  26503. Get an array of objects, some of which may implement
  26504. POIFSViewable
  26505. </summary>
  26506. <value>an array of Object; may not be null, but may be empty</value>
  26507. </member>
  26508. <member name="P:NPOI.POIFS.Properties.Property.ViewableIterator">
  26509. <summary>
  26510. Get an Iterator of objects, some of which may implement POIFSViewable
  26511. </summary>
  26512. <value> may not be null, but may have an empty
  26513. back end store</value>
  26514. </member>
  26515. <member name="P:NPOI.POIFS.Properties.Property.PreferArray">
  26516. <summary>
  26517. Give viewers a hint as to whether to call GetViewableArray or
  26518. GetViewableIterator
  26519. </summary>
  26520. <value><c>true</c> if a viewer Should call GetViewableArray; otherwise, <c>false</c>
  26521. if a viewer Should call GetViewableIterator
  26522. </value>
  26523. </member>
  26524. <member name="P:NPOI.POIFS.Properties.Property.ShortDescription">
  26525. <summary>
  26526. Provides a short description of the object, to be used when a
  26527. POIFSViewable object has not provided its contents.
  26528. </summary>
  26529. <value>The short description.</value>
  26530. </member>
  26531. <member name="T:NPOI.POIFS.Properties.PropertyConstants">
  26532. <summary>
  26533. Constants used by Properties namespace
  26534. </summary>
  26535. </member>
  26536. <member name="M:NPOI.POIFS.Properties.PropertyFactory.ConvertToProperties(NPOI.POIFS.Storage.ListManagedBlock[])">
  26537. <summary>
  26538. Convert raw data blocks to an array of Property's
  26539. </summary>
  26540. <param name="blocks">The blocks to be converted</param>
  26541. <returns>the converted List of Property objects. May contain
  26542. nulls, but will not be null</returns>
  26543. </member>
  26544. <member name="M:NPOI.POIFS.Properties.PropertyTable.#ctor(NPOI.POIFS.Storage.HeaderBlock)">
  26545. Default constructor
  26546. </member>
  26547. <member name="M:NPOI.POIFS.Properties.PropertyTable.#ctor(NPOI.POIFS.Storage.HeaderBlock,NPOI.POIFS.Storage.RawDataBlockList)">
  26548. reading constructor (used when we've read in a file and we want
  26549. to extract the property table from it). Populates the
  26550. properties thoroughly
  26551. @param startBlock the first block of the property table
  26552. @param blockList the list of blocks
  26553. @exception IOException if anything goes wrong (which should be
  26554. a result of the input being NFG)
  26555. </member>
  26556. <member name="M:NPOI.POIFS.Properties.PropertyTable.PreWrite">
  26557. Prepare to be written Leon
  26558. </member>
  26559. <member name="P:NPOI.POIFS.Properties.PropertyTable.CountBlocks">
  26560. Return the number of BigBlock's this instance uses
  26561. @return count of BigBlock instances
  26562. </member>
  26563. <member name="M:NPOI.POIFS.Properties.PropertyTable.WriteBlocks(System.IO.Stream)">
  26564. Write the storage to an Stream
  26565. @param stream the Stream to which the stored data should
  26566. be written
  26567. @exception IOException on problems writing to the specified
  26568. stream
  26569. </member>
  26570. <member name="M:NPOI.POIFS.Properties.RootProperty.#ctor(System.Int32,System.Byte[],System.Int32)">
  26571. <summary>
  26572. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.RootProperty"/> class.
  26573. </summary>
  26574. <param name="index">index number</param>
  26575. <param name="array">byte data</param>
  26576. <param name="offset">offset into byte data</param>
  26577. </member>
  26578. <member name="P:NPOI.POIFS.Properties.RootProperty.Size">
  26579. <summary>
  26580. Gets or sets the size of the document associated with this Property
  26581. </summary>
  26582. <value>the size of the document, in bytes</value>
  26583. </member>
  26584. <member name="T:NPOI.POIFS.Storage.BATBlock">
  26585. <summary>
  26586. A block of block allocation table entries. BATBlocks are created
  26587. only through a static factory method: createBATBlocks.
  26588. @author Marc Johnson (mjohnson at apache dot org)
  26589. </summary>
  26590. </member>
  26591. <member name="F:NPOI.POIFS.Storage.BATBlock._values">
  26592. For a regular fat block, these are 128 / 1024
  26593. next sector values.
  26594. For a XFat (DIFat) block, these are 127 / 1023
  26595. next sector values, then a chaining value.
  26596. </member>
  26597. <member name="F:NPOI.POIFS.Storage.BATBlock._has_free_sectors">
  26598. Does this BATBlock have any free sectors in it?
  26599. </member>
  26600. <member name="F:NPOI.POIFS.Storage.BATBlock.ourBlockIndex">
  26601. Where in the file are we?
  26602. </member>
  26603. <member name="M:NPOI.POIFS.Storage.BATBlock.#ctor">
  26604. <summary>
  26605. Create a single instance initialized with default values
  26606. </summary>
  26607. </member>
  26608. <member name="M:NPOI.POIFS.Storage.BATBlock.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32[],System.Int32,System.Int32)">
  26609. Create a single instance initialized (perhaps partially) with entries
  26610. @param entries the array of block allocation table entries
  26611. @param start_index the index of the first entry to be written
  26612. to the block
  26613. @param end_index the index, plus one, of the last entry to be
  26614. written to the block (writing is for all index
  26615. k, start_index &lt;= k &lt; end_index)
  26616. </member>
  26617. <member name="M:NPOI.POIFS.Storage.BATBlock.CreateBATBlock(NPOI.POIFS.Common.POIFSBigBlockSize,System.IO.BinaryReader)">
  26618. Create a single BATBlock from the byte buffer, which must hold at least
  26619. one big block of data to be read.
  26620. </member>
  26621. <member name="M:NPOI.POIFS.Storage.BATBlock.CreateEmptyBATBlock(NPOI.POIFS.Common.POIFSBigBlockSize,System.Boolean)">
  26622. **
  26623. </member>
  26624. <member name="M:NPOI.POIFS.Storage.BATBlock.CreateBATBlocks(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32[])">
  26625. <summary>
  26626. Create an array of BATBlocks from an array of int block
  26627. allocation table entries
  26628. </summary>
  26629. <param name="bigBlockSize">the poifs bigBlockSize</param>
  26630. <param name="entries">the array of int entries</param>
  26631. <returns>the newly created array of BATBlocks</returns>
  26632. </member>
  26633. <member name="M:NPOI.POIFS.Storage.BATBlock.CreateXBATBlocks(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32[],System.Int32)">
  26634. <summary>
  26635. Create an array of XBATBlocks from an array of int block
  26636. allocation table entries
  26637. </summary>
  26638. <param name="bigBlockSize"></param>
  26639. <param name="entries">the array of int entries</param>
  26640. <param name="startBlock">the start block of the array of XBAT blocks</param>
  26641. <returns>the newly created array of BATBlocks</returns>
  26642. </member>
  26643. <member name="M:NPOI.POIFS.Storage.BATBlock.CalculateStorageRequirements(System.Int32)">
  26644. <summary>
  26645. Calculate how many BATBlocks are needed to hold a specified
  26646. number of BAT entries.
  26647. </summary>
  26648. <param name="entryCount">the number of entries</param>
  26649. <returns>the number of BATBlocks needed</returns>
  26650. </member>
  26651. <member name="M:NPOI.POIFS.Storage.BATBlock.CalculateXBATStorageRequirements(System.Int32)">
  26652. <summary>
  26653. Calculate how many XBATBlocks are needed to hold a specified
  26654. number of BAT entries.
  26655. </summary>
  26656. <param name="entryCount">the number of entries</param>
  26657. <returns>the number of XBATBlocks needed</returns>
  26658. </member>
  26659. <member name="M:NPOI.POIFS.Storage.BATBlock.CalculateMaximumSize(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32)">
  26660. Calculates the maximum size of a file which is addressable given the
  26661. number of FAT (BAT) sectors specified. (We don't care if those BAT
  26662. blocks come from the 109 in the header, or from header + XBATS, it
  26663. won't affect the calculation)
  26664. The actual file size will be between [size of fatCount-1 blocks] and
  26665. [size of fatCount blocks].
  26666. For 512 byte block sizes, this means we may over-estimate by up to 65kb.
  26667. For 4096 byte block sizes, this means we may over-estimate by up to 4mb
  26668. </member>
  26669. <member name="P:NPOI.POIFS.Storage.BATBlock.EntriesPerBlock">
  26670. <summary>
  26671. Gets the entries per block.
  26672. </summary>
  26673. <value>The number of entries per block</value>
  26674. </member>
  26675. <member name="P:NPOI.POIFS.Storage.BATBlock.EntriesPerXBATBlock">
  26676. <summary>
  26677. Gets the entries per XBAT block.
  26678. </summary>
  26679. <value>number of entries per XBAT block</value>
  26680. </member>
  26681. <member name="P:NPOI.POIFS.Storage.BATBlock.XBATChainOffset">
  26682. <summary>
  26683. Gets the XBAT chain offset.
  26684. </summary>
  26685. <value>offset of chain index of XBAT block</value>
  26686. </member>
  26687. <member name="P:NPOI.POIFS.Storage.BATBlock.HasFreeSectors">
  26688. Does this BATBlock have any free sectors in it, or
  26689. is it full?
  26690. </member>
  26691. <member name="M:NPOI.POIFS.Storage.BATBlock.GetUsedSectors(System.Boolean)">
  26692. How many sectors in this block are taken?
  26693. Note that calling {@link #hasFreeSectors()} is much quicker
  26694. </member>
  26695. <member name="P:NPOI.POIFS.Storage.BATBlock.OurBlockIndex">
  26696. Retrieve where in the file we live
  26697. </member>
  26698. <member name="M:NPOI.POIFS.Storage.BATBlock.#ctor(System.Int32[],System.Int32,System.Int32)">
  26699. <summary>
  26700. Create a single instance initialized (perhaps partially) with entries
  26701. </summary>
  26702. <param name="entries">the array of block allocation table entries</param>
  26703. <param name="start_index">the index of the first entry to be written
  26704. to the block</param>
  26705. <param name="end_index">the index, plus one, of the last entry to be
  26706. written to the block (writing is for all index
  26707. k, start_index less than k less than end_index)
  26708. </param>
  26709. </member>
  26710. <member name="M:NPOI.POIFS.Storage.BATBlock.WriteData(System.IO.Stream)">
  26711. <summary>
  26712. Write the block's data to an Stream
  26713. </summary>
  26714. <param name="stream">the Stream to which the stored data should
  26715. be written</param>
  26716. </member>
  26717. <member name="T:NPOI.POIFS.Storage.BigBlock">
  26718. <summary>
  26719. Abstract base class of all POIFS block storage classes. All
  26720. extensions of BigBlock should write 512 bytes of data when
  26721. requested to write their data.
  26722. This class has package scope, as there is no reason at this time to
  26723. make the class public.
  26724. @author Marc Johnson (mjohnson at apache dot org)
  26725. </summary>
  26726. </member>
  26727. <member name="M:NPOI.POIFS.Storage.BigBlock.WriteData(System.IO.Stream,System.Byte[])">
  26728. <summary>
  26729. Default implementation of write for extending classes that
  26730. contain their data in a simple array of bytes.
  26731. </summary>
  26732. <param name="stream">the OutputStream to which the data should be written.</param>
  26733. <param name="data">the byte array of to be written.</param>
  26734. </member>
  26735. <member name="M:NPOI.POIFS.Storage.BigBlock.WriteBlocks(System.IO.Stream)">
  26736. <summary>
  26737. Write the block's data to an OutputStream
  26738. </summary>
  26739. <param name="stream">the OutputStream to which the stored data should be written</param>
  26740. </member>
  26741. <member name="M:NPOI.POIFS.Storage.BigBlock.WriteData(System.IO.Stream)">
  26742. <summary>
  26743. Write the storage to an OutputStream
  26744. </summary>
  26745. <param name="stream">the OutputStream to which the stored data should be written </param>
  26746. </member>
  26747. <member name="T:NPOI.POIFS.Storage.BlockAllocationTableReader">
  26748. <summary>
  26749. This class manages and creates the Block Allocation Table, which is
  26750. basically a set of linked lists of block indices.
  26751. Each block of the filesystem has an index. The first block, the
  26752. header, is skipped; the first block after the header is index 0,
  26753. the next is index 1, and so on.
  26754. A block's index is also its index into the Block Allocation
  26755. Table. The entry that it finds in the Block Allocation Table is the
  26756. index of the next block in the linked list of blocks making up a
  26757. file, or it is set to -2: end of list.
  26758. @author Marc Johnson (mjohnson at apache dot org)
  26759. </summary>
  26760. </member>
  26761. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32,System.Int32[],System.Int32,System.Int32,NPOI.POIFS.Storage.BlockList)">
  26762. <summary>
  26763. create a BlockAllocationTableReader for an existing filesystem. Side
  26764. effect: when this method finishes, the BAT blocks will have
  26765. been Removed from the raw block list, and any blocks labeled as
  26766. 'unused' in the block allocation table will also have been
  26767. Removed from the raw block list. </summary>
  26768. <param name="bigBlockSizse">the poifs bigBlockSize</param>
  26769. <param name="block_count">the number of BAT blocks making up the block allocation table</param>
  26770. <param name="block_array">the array of BAT block indices from the
  26771. filesystem's header</param>
  26772. <param name="xbat_count">the number of XBAT blocks</param>
  26773. <param name="xbat_index">the index of the first XBAT block</param>
  26774. <param name="raw_block_list">the list of RawDataBlocks</param>
  26775. </member>
  26776. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Storage.ListManagedBlock[],NPOI.POIFS.Storage.BlockList)">
  26777. <summary>
  26778. create a BlockAllocationTableReader from an array of raw data blocks
  26779. </summary>
  26780. <param name="bigBlockSize"></param>
  26781. <param name="blocks">the raw data</param>
  26782. <param name="raw_block_list">the list holding the managed blocks</param>
  26783. </member>
  26784. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize)">
  26785. <summary>
  26786. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.BlockAllocationTableReader"/> class.
  26787. </summary>
  26788. </member>
  26789. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.FetchBlocks(System.Int32,System.Int32,NPOI.POIFS.Storage.BlockList)">
  26790. <summary>
  26791. walk the entries from a specified point and return the
  26792. associated blocks. The associated blocks are Removed from the block list
  26793. </summary>
  26794. <param name="startBlock">the first block in the chain</param>
  26795. <param name="headerPropertiesStartBlock"></param>
  26796. <param name="blockList">the raw data block list</param>
  26797. <returns>array of ListManagedBlocks, in their correct order</returns>
  26798. </member>
  26799. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.IsUsed(System.Int32)">
  26800. <summary>
  26801. determine whether the block specified by index is used or not
  26802. </summary>
  26803. <param name="index">determine whether the block specified by index is used or not</param>
  26804. <returns>
  26805. <c>true</c> if the specified block is used; otherwise, <c>false</c>.
  26806. </returns>
  26807. </member>
  26808. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.GetNextBlockIndex(System.Int32)">
  26809. <summary>
  26810. return the next block index
  26811. </summary>
  26812. <param name="index">The index of the current block</param>
  26813. <returns>index of the next block (may be
  26814. POIFSConstants.END_OF_CHAIN, indicating end of chain
  26815. (duh))</returns>
  26816. </member>
  26817. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.SetEntries(NPOI.POIFS.Storage.ListManagedBlock[],NPOI.POIFS.Storage.BlockList)">
  26818. <summary>
  26819. Convert an array of blocks into a Set of integer indices
  26820. </summary>
  26821. <param name="blocks">the array of blocks containing the indices</param>
  26822. <param name="raw_blocks">the list of blocks being managed. Unused
  26823. blocks will be eliminated from the list</param>
  26824. </member>
  26825. <member name="T:NPOI.POIFS.Storage.BlockAllocationTableWriter">
  26826. <summary>
  26827. This class manages and creates the Block Allocation Table, which is
  26828. basically a set of linked lists of block indices.
  26829. Each block of the filesystem has an index. The first block, the
  26830. header, is skipped; the first block after the header is index 0,
  26831. the next is index 1, and so on.
  26832. A block's index is also its index into the Block Allocation
  26833. Table. The entry that it finds in the Block Allocation Table is the
  26834. index of the next block in the linked list of blocks making up a
  26835. file, or it is set to -2: end of list.
  26836. *
  26837. @author Marc Johnson (mjohnson at apache dot org)
  26838. </summary>
  26839. </member>
  26840. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize)">
  26841. <summary>
  26842. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.BlockAllocationTableWriter"/> class.
  26843. </summary>
  26844. </member>
  26845. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.CreateBlocks">
  26846. <summary>
  26847. Create the BATBlocks we need
  26848. </summary>
  26849. <returns>start block index of BAT blocks</returns>
  26850. </member>
  26851. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.AllocateSpace(System.Int32)">
  26852. <summary>
  26853. Allocate space for a block of indices
  26854. </summary>
  26855. <param name="blockCount">the number of blocks to allocate space for</param>
  26856. <returns>the starting index of the blocks</returns>
  26857. </member>
  26858. <member name="P:NPOI.POIFS.Storage.BlockAllocationTableWriter.StartBlock">
  26859. <summary>
  26860. Sets the start block for this instance
  26861. </summary>
  26862. <value>
  26863. index into the array of BigBlock instances making up the the filesystem
  26864. </value>
  26865. </member>
  26866. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.SimpleCreateBlocks">
  26867. <summary>
  26868. create the BATBlocks
  26869. </summary>
  26870. </member>
  26871. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.WriteBlocks(System.IO.Stream)">
  26872. <summary>
  26873. Write the storage to an OutputStream
  26874. </summary>
  26875. <param name="stream">the OutputStream to which the stored data should be written</param>
  26876. </member>
  26877. <member name="P:NPOI.POIFS.Storage.BlockAllocationTableWriter.CountBlocks">
  26878. <summary>
  26879. Gets the number of BigBlock's this instance uses
  26880. </summary>
  26881. <value>count of BigBlock instances</value>
  26882. </member>
  26883. <member name="T:NPOI.POIFS.Storage.BlockList">
  26884. <summary>
  26885. Interface for lists of blocks that are mapped by block allocation
  26886. tables
  26887. @author Marc Johnson (mjohnson at apache dot org)
  26888. </summary>
  26889. </member>
  26890. <member name="M:NPOI.POIFS.Storage.BlockList.Zap(System.Int32)">
  26891. <summary>
  26892. remove the specified block from the list
  26893. </summary>
  26894. <param name="index">the index of the specified block; if the index is
  26895. out of range, that's ok</param>
  26896. </member>
  26897. <member name="M:NPOI.POIFS.Storage.BlockList.Remove(System.Int32)">
  26898. <summary>
  26899. Remove and return the specified block from the list
  26900. </summary>
  26901. <param name="index">the index of the specified block</param>
  26902. <returns>the specified block</returns>
  26903. </member>
  26904. <member name="M:NPOI.POIFS.Storage.BlockList.FetchBlocks(System.Int32,System.Int32)">
  26905. <summary>
  26906. get the blocks making up a particular stream in the list. The
  26907. blocks are removed from the list.
  26908. </summary>
  26909. <param name="startBlock">the index of the first block in the stream</param>
  26910. <param name="headerPropertiesStartBlock"></param>
  26911. <returns>the stream as an array of correctly ordered blocks</returns>
  26912. </member>
  26913. <member name="P:NPOI.POIFS.Storage.BlockList.BAT">
  26914. <summary>
  26915. set the associated BlockAllocationTable
  26916. </summary>
  26917. <value>the associated BlockAllocationTable</value>
  26918. </member>
  26919. <member name="M:NPOI.POIFS.Storage.BlockListImpl.#ctor">
  26920. <summary>
  26921. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.BlockListImpl"/> class.
  26922. </summary>
  26923. </member>
  26924. <member name="M:NPOI.POIFS.Storage.BlockListImpl.SetBlocks(NPOI.POIFS.Storage.ListManagedBlock[])">
  26925. <summary>
  26926. provide blocks to manage
  26927. </summary>
  26928. <param name="blocks">blocks to be managed</param>
  26929. </member>
  26930. <member name="M:NPOI.POIFS.Storage.BlockListImpl.Zap(System.Int32)">
  26931. <summary>
  26932. remove the specified block from the list
  26933. </summary>
  26934. <param name="index">the index of the specified block; if the index is
  26935. out of range, that's ok</param>
  26936. </member>
  26937. <member name="M:NPOI.POIFS.Storage.BlockListImpl.Remove(System.Int32)">
  26938. <summary>
  26939. Remove and return the specified block from the list
  26940. </summary>
  26941. <param name="index">the index of the specified block</param>
  26942. <returns>the specified block</returns>
  26943. </member>
  26944. <member name="M:NPOI.POIFS.Storage.BlockListImpl.FetchBlocks(System.Int32,System.Int32)">
  26945. <summary>
  26946. get the blocks making up a particular stream in the list. The
  26947. blocks are removed from the list.
  26948. </summary>
  26949. <param name="startBlock">the index of the first block in the stream</param>
  26950. <param name="headerPropertiesStartBlock"></param>
  26951. <returns>
  26952. the stream as an array of correctly ordered blocks
  26953. </returns>
  26954. </member>
  26955. <member name="P:NPOI.POIFS.Storage.BlockListImpl.BAT">
  26956. <summary>
  26957. set the associated BlockAllocationTable
  26958. </summary>
  26959. <value>the associated BlockAllocationTable</value>
  26960. </member>
  26961. <member name="T:NPOI.POIFS.Storage.BlockWritable">
  26962. <summary>
  26963. An interface for persisting block storage of POIFS components.
  26964. @author Marc Johnson (mjohnson at apache dot org)
  26965. </summary>
  26966. </member>
  26967. <member name="M:NPOI.POIFS.Storage.BlockWritable.WriteBlocks(System.IO.Stream)">
  26968. <summary>
  26969. Writes the blocks.
  26970. </summary>
  26971. <param name="stream">The stream.</param>
  26972. </member>
  26973. <member name="T:NPOI.POIFS.Storage.DataInputBlock">
  26974. Wraps a <c>byte</c> array and provides simple data input access.
  26975. Internally, this class maintains a buffer read index, so that for the most part, primitive
  26976. data can be read in a data-input-stream-like manner.<p/>
  26977. Note - the calling class should call the {@link #available()} method to detect end-of-buffer
  26978. and Move to the next data block when the current is exhausted.
  26979. For optimisation reasons, no error handling is performed in this class. Thus, mistakes in
  26980. calling code ran may raise ugly exceptions here, like {@link ArrayIndexOutOfBoundsException},
  26981. etc .<p/>
  26982. The multi-byte primitive input methods ({@link #readUshortLE()}, {@link #readIntLE()} and
  26983. {@link #readLongLE()}) have corresponding 'spanning Read' methods which (when required) perform
  26984. a read across the block boundary. These spanning read methods take the previous
  26985. {@link DataInputBlock} as a parameter.
  26986. Reads of larger amounts of data (into <c>byte</c> array buffers) must be managed by the caller
  26987. since these could conceivably involve more than two blocks.
  26988. @author Josh Micich
  26989. </member>
  26990. <member name="F:NPOI.POIFS.Storage.DataInputBlock._buf">
  26991. Possibly any size (usually 512K or 64K). Assumed to be at least 8 bytes for all blocks
  26992. before the end of the stream. The last block in the stream can be any size except zero.
  26993. </member>
  26994. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadUshortLE">
  26995. Reads a <c>short</c> which was encoded in <em>little endian</em> format.
  26996. </member>
  26997. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadUshortLE(NPOI.POIFS.Storage.DataInputBlock)">
  26998. Reads a <c>short</c> which spans the end of <c>prevBlock</c> and the start of this block.
  26999. </member>
  27000. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadIntLE">
  27001. Reads an <c>int</c> which was encoded in <em>little endian</em> format.
  27002. </member>
  27003. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadIntLE(NPOI.POIFS.Storage.DataInputBlock,System.Int32)">
  27004. Reads an <c>int</c> which spans the end of <c>prevBlock</c> and the start of this block.
  27005. </member>
  27006. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadLongLE">
  27007. Reads a <c>long</c> which was encoded in <em>little endian</em> format.
  27008. </member>
  27009. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadLongLE(NPOI.POIFS.Storage.DataInputBlock,System.Int32)">
  27010. Reads a <c>long</c> which spans the end of <c>prevBlock</c> and the start of this block.
  27011. </member>
  27012. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadSpanning(NPOI.POIFS.Storage.DataInputBlock,System.Int32,System.Byte[])">
  27013. Reads a small amount of data from across the boundary between two blocks.
  27014. The {@link #_readIndex} of this (the second) block is updated accordingly.
  27015. Note- this method (and other code) assumes that the second {@link DataInputBlock}
  27016. always is big enough to complete the read without being exhausted.
  27017. </member>
  27018. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadFully(System.Byte[],System.Int32,System.Int32)">
  27019. Reads <c>len</c> bytes from this block into the supplied buffer.
  27020. </member>
  27021. <member name="M:NPOI.POIFS.Storage.DocumentBlock.#ctor(NPOI.POIFS.Storage.RawDataBlock)">
  27022. <summary>
  27023. create a document block from a raw data block
  27024. </summary>
  27025. <param name="block">The block.</param>
  27026. </member>
  27027. <member name="M:NPOI.POIFS.Storage.DocumentBlock.#ctor(System.IO.Stream,NPOI.POIFS.Common.POIFSBigBlockSize)">
  27028. <summary>
  27029. Create a single instance initialized with data.
  27030. </summary>
  27031. <param name="stream">the InputStream delivering the data.</param>
  27032. <param name="bigBlockSize">the poifs bigBlockSize</param>
  27033. </member>
  27034. <member name="P:NPOI.POIFS.Storage.DocumentBlock.Size">
  27035. <summary>
  27036. Get the number of bytes Read for this block.
  27037. </summary>
  27038. <value>bytes Read into the block</value>
  27039. </member>
  27040. <member name="P:NPOI.POIFS.Storage.DocumentBlock.PartiallyRead">
  27041. <summary>
  27042. Was this a partially Read block?
  27043. </summary>
  27044. <value><c>true</c> if the block was only partially filled with data</value>
  27045. </member>
  27046. <member name="P:NPOI.POIFS.Storage.DocumentBlock.FillByte">
  27047. <summary>
  27048. Gets the fill byte used
  27049. </summary>
  27050. <value>The fill byte.</value>
  27051. </member>
  27052. <member name="M:NPOI.POIFS.Storage.DocumentBlock.Convert(NPOI.POIFS.Common.POIFSBigBlockSize,System.Byte[],System.Int32)">
  27053. <summary>
  27054. convert a single long array into an array of DocumentBlock
  27055. instances
  27056. </summary>
  27057. <param name="bigBlockSize">the poifs bigBlockSize</param>
  27058. <param name="array">the byte array to be converted</param>
  27059. <param name="size">the intended size of the array (which may be smaller)</param>
  27060. <returns>an array of DocumentBlock instances, filled from the
  27061. input array</returns>
  27062. </member>
  27063. <member name="M:NPOI.POIFS.Storage.DocumentBlock.Read(NPOI.POIFS.Storage.DocumentBlock[],System.Byte[],System.Int32)">
  27064. <summary>
  27065. Read data from an array of DocumentBlocks
  27066. </summary>
  27067. <param name="blocks">the blocks to Read from</param>
  27068. <param name="buffer">the buffer to Write the data into</param>
  27069. <param name="offset">the offset into the array of blocks to Read from</param>
  27070. </member>
  27071. <member name="M:NPOI.POIFS.Storage.DocumentBlock.WriteData(System.IO.Stream)">
  27072. <summary>
  27073. Write the storage to an OutputStream
  27074. </summary>
  27075. <param name="stream">the OutputStream to which the stored data should
  27076. be written</param>
  27077. </member>
  27078. <member name="T:NPOI.POIFS.Storage.HeaderBlock">
  27079. <summary>
  27080. The block containing the archive header
  27081. @author Marc Johnson (mjohnson at apache dot org)
  27082. </summary>
  27083. </member>
  27084. <member name="F:NPOI.POIFS.Storage.HeaderBlock.bigBlockSize">
  27085. What big block Size the file uses. Most files
  27086. use 512 bytes, but a few use 4096
  27087. </member>
  27088. <member name="F:NPOI.POIFS.Storage.HeaderBlock._sbat_count">
  27089. Number of small block allocation table blocks (int)
  27090. (Number of MiniFAT Sectors in Microsoft parlance)
  27091. </member>
  27092. <member name="M:NPOI.POIFS.Storage.HeaderBlock.#ctor(System.IO.Stream)">
  27093. <summary>
  27094. create a new HeaderBlockReader from an Stream
  27095. </summary>
  27096. <param name="stream">the source Stream</param>
  27097. </member>
  27098. <member name="M:NPOI.POIFS.Storage.HeaderBlock.AlertShortRead(System.Int32,System.Int32)">
  27099. <summary>
  27100. Alerts the short read.
  27101. </summary>
  27102. <param name="read">The read.</param>
  27103. <param name="expectedReadSize">The expected size.</param>
  27104. </member>
  27105. <member name="P:NPOI.POIFS.Storage.HeaderBlock.PropertyStart">
  27106. <summary>
  27107. Get start of Property Table
  27108. </summary>
  27109. <value>the index of the first block of the Property Table</value>
  27110. </member>
  27111. <member name="P:NPOI.POIFS.Storage.HeaderBlock.SBATStart">
  27112. <summary>
  27113. Gets start of small block allocation table
  27114. </summary>
  27115. <value>The SBAT start.</value>
  27116. </member>
  27117. <member name="P:NPOI.POIFS.Storage.HeaderBlock.SBATCount">
  27118. <summary>
  27119. Gets number of BAT blocks
  27120. </summary>
  27121. <value>The BAT count.</value>
  27122. </member>
  27123. <member name="P:NPOI.POIFS.Storage.HeaderBlock.BATArray">
  27124. <summary>
  27125. Gets the BAT array.
  27126. </summary>
  27127. <value>The BAT array.</value>
  27128. </member>
  27129. <member name="P:NPOI.POIFS.Storage.HeaderBlock.XBATCount">
  27130. <summary>
  27131. Gets the XBAT count.
  27132. </summary>
  27133. <value>The XBAT count.</value>
  27134. @return XBAT count
  27135. </member>
  27136. <member name="P:NPOI.POIFS.Storage.HeaderBlock.XBATIndex">
  27137. <summary>
  27138. Gets the index of the XBAT.
  27139. </summary>
  27140. <value>The index of the XBAT.</value>
  27141. </member>
  27142. <member name="P:NPOI.POIFS.Storage.HeaderBlock.BigBlockSize">
  27143. <summary>
  27144. Gets The Big Block Size, normally 512 bytes, sometimes 4096 bytes
  27145. </summary>
  27146. <value>The size of the big block.</value>
  27147. @return
  27148. </member>
  27149. <member name="T:NPOI.POIFS.Storage.HeaderBlockConstants">
  27150. <summary>
  27151. Constants used in reading/writing the Header block
  27152. @author Marc Johnson (mjohnson at apache dot org)
  27153. </summary>
  27154. </member>
  27155. <member name="T:NPOI.POIFS.Storage.HeaderBlockReader">
  27156. <summary>
  27157. The block containing the archive header
  27158. @author Marc Johnson (mjohnson at apache dot org)
  27159. </summary>
  27160. </member>
  27161. <member name="F:NPOI.POIFS.Storage.HeaderBlockReader.bigBlockSize">
  27162. What big block Size the file uses. Most files
  27163. use 512 bytes, but a few use 4096
  27164. </member>
  27165. <member name="F:NPOI.POIFS.Storage.HeaderBlockReader._sbat_count">
  27166. Number of small block allocation table blocks (int)
  27167. (Number of MiniFAT Sectors in Microsoft parlance)
  27168. </member>
  27169. <member name="M:NPOI.POIFS.Storage.HeaderBlockReader.#ctor(System.IO.Stream)">
  27170. <summary>
  27171. create a new HeaderBlockReader from an Stream
  27172. </summary>
  27173. <param name="stream">the source Stream</param>
  27174. </member>
  27175. <member name="M:NPOI.POIFS.Storage.HeaderBlockReader.AlertShortRead(System.Int32,System.Int32)">
  27176. <summary>
  27177. Alerts the short read.
  27178. </summary>
  27179. <param name="read">The read.</param>
  27180. <param name="expectedReadSize">expected size to read</param>
  27181. </member>
  27182. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.PropertyStart">
  27183. <summary>
  27184. Get start of Property Table
  27185. </summary>
  27186. <value>the index of the first block of the Property Table</value>
  27187. </member>
  27188. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.SBATStart">
  27189. <summary>
  27190. Gets start of small block allocation table
  27191. </summary>
  27192. <value>The SBAT start.</value>
  27193. </member>
  27194. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.BATCount">
  27195. <summary>
  27196. Gets number of BAT blocks
  27197. </summary>
  27198. <value>The BAT count.</value>
  27199. </member>
  27200. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.BATArray">
  27201. <summary>
  27202. Gets the BAT array.
  27203. </summary>
  27204. <value>The BAT array.</value>
  27205. </member>
  27206. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.XBATCount">
  27207. <summary>
  27208. Gets the XBAT count.
  27209. </summary>
  27210. <value>The XBAT count.</value>
  27211. @return XBAT count
  27212. </member>
  27213. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.XBATIndex">
  27214. <summary>
  27215. Gets the index of the XBAT.
  27216. </summary>
  27217. <value>The index of the XBAT.</value>
  27218. </member>
  27219. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.BigBlockSize">
  27220. <summary>
  27221. Gets The Big Block Size, normally 512 bytes, sometimes 4096 bytes
  27222. </summary>
  27223. <value>The size of the big block.</value>
  27224. @return
  27225. </member>
  27226. <member name="T:NPOI.POIFS.Storage.HeaderBlockWriter">
  27227. <summary>
  27228. The block containing the archive header
  27229. @author Marc Johnson (mjohnson at apache dot org)
  27230. </summary>
  27231. </member>
  27232. <member name="M:NPOI.POIFS.Storage.HeaderBlockWriter.SetBATBlocks(System.Int32,System.Int32)">
  27233. <summary>
  27234. Set BAT block parameters. Assumes that all BAT blocks are
  27235. contiguous. Will construct XBAT blocks if necessary and return
  27236. the array of newly constructed XBAT blocks.
  27237. </summary>
  27238. <param name="blockCount">count of BAT blocks</param>
  27239. <param name="startBlock">index of first BAT block</param>
  27240. <returns>array of XBAT blocks; may be zero Length, will not be
  27241. null</returns>
  27242. </member>
  27243. <member name="P:NPOI.POIFS.Storage.HeaderBlockWriter.PropertyStart">
  27244. <summary>
  27245. Set start of Property Table
  27246. </summary>
  27247. <value>the index of the first block of the Property
  27248. Table</value>
  27249. </member>
  27250. <member name="P:NPOI.POIFS.Storage.HeaderBlockWriter.SBAStart">
  27251. <summary>
  27252. Set start of small block allocation table
  27253. </summary>
  27254. <value>the index of the first big block of the small
  27255. block allocation table</value>
  27256. </member>
  27257. <member name="P:NPOI.POIFS.Storage.HeaderBlockWriter.SBATBlockCount">
  27258. <summary>
  27259. Set count of SBAT blocks
  27260. </summary>
  27261. <value>the number of SBAT blocks</value>
  27262. </member>
  27263. <member name="M:NPOI.POIFS.Storage.HeaderBlockWriter.CalculateXBATStorageRequirements(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32)">
  27264. <summary>
  27265. For a given number of BAT blocks, calculate how many XBAT
  27266. blocks will be needed
  27267. </summary>
  27268. <param name="bigBlockSize"></param>
  27269. <param name="blockCount">number of BAT blocks</param>
  27270. <returns>number of XBAT blocks needed</returns>
  27271. </member>
  27272. <member name="M:NPOI.POIFS.Storage.HeaderBlockWriter.WriteBlocks(System.IO.Stream)">
  27273. <summary>
  27274. Write the block's data to an Stream
  27275. </summary>
  27276. <param name="stream">the Stream to which the stored data should
  27277. be written
  27278. </param>
  27279. </member>
  27280. <member name="T:NPOI.POIFS.Storage.ListManagedBlock">
  27281. <summary>
  27282. An interface for blocks managed by a list that works with a
  27283. BlockAllocationTable to keep block sequences straight
  27284. @author Marc Johnson (mjohnson at apache dot org
  27285. </summary>
  27286. </member>
  27287. <member name="P:NPOI.POIFS.Storage.ListManagedBlock.Data">
  27288. <summary>
  27289. Get the data from the block
  27290. </summary>
  27291. <value>the block's data as a byte array</value>
  27292. </member>
  27293. <member name="T:NPOI.POIFS.Storage.PropertyBlock">
  27294. <summary>
  27295. A block of Property instances
  27296. @author Marc Johnson (mjohnson at apache dot org)
  27297. </summary>
  27298. </member>
  27299. <member name="M:NPOI.POIFS.Storage.PropertyBlock.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Properties.Property[],System.Int32)">
  27300. <summary>
  27301. Create a single instance initialized with default values
  27302. </summary>
  27303. <param name="bigBlockSize"></param>
  27304. <param name="properties">the properties to be inserted</param>
  27305. <param name="offset">the offset into the properties array</param>
  27306. </member>
  27307. <member name="M:NPOI.POIFS.Storage.PropertyBlock.CreatePropertyBlockArray(NPOI.POIFS.Common.POIFSBigBlockSize,System.Collections.Generic.List{NPOI.POIFS.Properties.Property})">
  27308. <summary>
  27309. Create an array of PropertyBlocks from an array of Property
  27310. instances, creating empty Property instances to make up any
  27311. shortfall
  27312. </summary>
  27313. <param name="bigBlockSize"></param>
  27314. <param name="properties">the Property instances to be converted into PropertyBlocks, in a java List</param>
  27315. <returns>the array of newly created PropertyBlock instances</returns>
  27316. </member>
  27317. <member name="M:NPOI.POIFS.Storage.PropertyBlock.WriteData(System.IO.Stream)">
  27318. <summary>
  27319. Write the block's data to an OutputStream
  27320. </summary>
  27321. <param name="stream">the OutputStream to which the stored data should be written</param>
  27322. </member>
  27323. <member name="T:NPOI.POIFS.Storage.RawDataBlock">
  27324. <summary>
  27325. A big block created from an InputStream, holding the raw data
  27326. @author Marc Johnson (mjohnson at apache dot org
  27327. </summary>
  27328. </member>
  27329. <member name="M:NPOI.POIFS.Storage.RawDataBlock.#ctor(System.IO.Stream)">
  27330. <summary>
  27331. Constructor RawDataBlock
  27332. </summary>
  27333. <param name="stream">the Stream from which the data will be read</param>
  27334. </member>
  27335. <member name="M:NPOI.POIFS.Storage.RawDataBlock.#ctor(System.IO.Stream,System.Int32)">
  27336. <summary>
  27337. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.RawDataBlock"/> class.
  27338. </summary>
  27339. <param name="stream">the Stream from which the data will be read</param>
  27340. <param name="blockSize">the size of the POIFS blocks, normally 512 bytes {@link POIFSConstants#BIG_BLOCK_SIZE}</param>
  27341. </member>
  27342. <member name="P:NPOI.POIFS.Storage.RawDataBlock.EOF">
  27343. <summary>
  27344. When we read the data, did we hit end of file?
  27345. </summary>
  27346. <value><c>true</c> if the EoF was hit during this block, or; otherwise, <c>false</c>if not. If you have a dodgy short last block, then
  27347. it's possible to both have data, and also hit EoF...</value>
  27348. </member>
  27349. <member name="P:NPOI.POIFS.Storage.RawDataBlock.HasData">
  27350. <summary>
  27351. Did we actually find any data to read? It's possible,
  27352. in the event of a short last block, to both have hit
  27353. the EoF, but also to have data
  27354. </summary>
  27355. <value><c>true</c> if this instance has data; otherwise, <c>false</c>.</value>
  27356. </member>
  27357. <member name="P:NPOI.POIFS.Storage.RawDataBlock.Data">
  27358. <summary>
  27359. Get the data from the block
  27360. </summary>
  27361. <value>the block's data as a byte array</value>
  27362. </member>
  27363. <member name="T:NPOI.POIFS.Storage.RawDataBlockList">
  27364. <summary>
  27365. A list of RawDataBlocks instances, and methods to manage the list
  27366. @author Marc Johnson (mjohnson at apache dot org
  27367. </summary>
  27368. </member>
  27369. <member name="M:NPOI.POIFS.Storage.RawDataBlockList.#ctor(System.IO.Stream,NPOI.POIFS.Common.POIFSBigBlockSize)">
  27370. <summary>
  27371. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.RawDataBlockList"/> class.
  27372. </summary>
  27373. <param name="stream">the InputStream from which the data will be read</param>
  27374. <param name="bigBlockSize">The big block size, either 512 bytes or 4096 bytes</param>
  27375. </member>
  27376. <member name="T:NPOI.POIFS.Storage.SmallBlockTableReader">
  27377. <summary>
  27378. This class implements reading the small document block list from an
  27379. existing file
  27380. @author Marc Johnson (mjohnson at apache dot org)
  27381. </summary>
  27382. </member>
  27383. <member name="M:NPOI.POIFS.Storage.SmallBlockTableReader._getSmallDocumentBlockReader(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Storage.RawDataBlockList,NPOI.POIFS.Properties.RootProperty,System.Int32)">
  27384. <summary>
  27385. fetch the small document block list from an existing file, normally
  27386. needed for debugging and low level dumping. You should typically call
  27387. </summary>
  27388. <param name="bigBlockSize">the poifs bigBlockSize</param>
  27389. <param name="blockList">the raw data from which the small block table will be extracted</param>
  27390. <param name="root">the root property (which contains the start block and small block table size)</param>
  27391. <param name="sbatStart">the start block of the SBAT</param>
  27392. <returns>the small document block reader</returns>
  27393. </member>
  27394. <member name="M:NPOI.POIFS.Storage.SmallBlockTableReader.GetSmallDocumentBlocks(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Storage.RawDataBlockList,NPOI.POIFS.Properties.RootProperty,System.Int32)">
  27395. <summary>
  27396. fetch the small document block list from an existing file
  27397. </summary>
  27398. <param name="bigBlockSize">the poifs bigBlockSize</param>
  27399. <param name="blockList">the raw data from which the small block table will be extracted</param>
  27400. <param name="root">the root property (which contains the start block and small block table size)</param>
  27401. <param name="sbatStart">the start block of the SBAT</param>
  27402. <returns>the small document block list</returns>
  27403. </member>
  27404. <member name="T:NPOI.POIFS.Storage.SmallBlockTableWriter">
  27405. <summary>
  27406. This class implements reading the small document block list from an
  27407. existing file
  27408. @author Marc Johnson (mjohnson at apache dot org)
  27409. </summary>
  27410. </member>
  27411. <member name="M:NPOI.POIFS.Storage.SmallBlockTableWriter.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,System.Collections.Generic.IList{NPOI.POIFS.FileSystem.OPOIFSDocument},NPOI.POIFS.Properties.RootProperty)">
  27412. <summary>
  27413. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.SmallBlockTableWriter"/> class.
  27414. </summary>
  27415. <param name="bigBlockSize">the poifs bigBlockSize</param>
  27416. <param name="documents">a IList of POIFSDocument instances</param>
  27417. <param name="root">the Filesystem's root property</param>
  27418. </member>
  27419. <member name="P:NPOI.POIFS.Storage.SmallBlockTableWriter.SBATBlockCount">
  27420. <summary>
  27421. Get the number of SBAT blocks
  27422. </summary>
  27423. <value>number of SBAT big blocks</value>
  27424. </member>
  27425. <member name="P:NPOI.POIFS.Storage.SmallBlockTableWriter.SBAT">
  27426. <summary>
  27427. Gets the SBAT.
  27428. </summary>
  27429. <value>the Small Block Allocation Table</value>
  27430. </member>
  27431. <member name="P:NPOI.POIFS.Storage.SmallBlockTableWriter.CountBlocks">
  27432. <summary>
  27433. Return the number of BigBlock's this instance uses
  27434. </summary>
  27435. <value>count of BigBlock instances</value>
  27436. </member>
  27437. <member name="P:NPOI.POIFS.Storage.SmallBlockTableWriter.StartBlock">
  27438. <summary>
  27439. Sets the start block.
  27440. </summary>
  27441. <value>The start block.</value>
  27442. </member>
  27443. <member name="M:NPOI.POIFS.Storage.SmallBlockTableWriter.WriteBlocks(System.IO.Stream)">
  27444. <summary>
  27445. Write the storage to an OutputStream
  27446. </summary>
  27447. <param name="stream">the OutputStream to which the stored data should be written</param>
  27448. </member>
  27449. <member name="T:NPOI.POIFS.Storage.SmallDocumentBlock">
  27450. <summary>
  27451. Storage for documents that are too small to use regular
  27452. DocumentBlocks for their data
  27453. @author Marc Johnson (mjohnson at apache dot org)
  27454. </summary>
  27455. </member>
  27456. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Convert(NPOI.POIFS.Common.POIFSBigBlockSize,System.Byte[],System.Int32)">
  27457. <summary>
  27458. convert a single long array into an array of SmallDocumentBlock
  27459. instances
  27460. </summary>
  27461. <param name="bigBlockSize">the poifs bigBlockSize</param>
  27462. <param name="array">the byte array to be converted</param>
  27463. <param name="size">the intended size of the array (which may be smaller)</param>
  27464. <returns>an array of SmallDocumentBlock instances, filled from
  27465. the array</returns>
  27466. </member>
  27467. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Fill(NPOI.POIFS.Common.POIFSBigBlockSize,System.Collections.Generic.IList{NPOI.POIFS.Storage.SmallDocumentBlock})">
  27468. <summary>
  27469. fill out a List of SmallDocumentBlocks so that it fully occupies
  27470. a Set of big blocks
  27471. </summary>
  27472. <param name="bigBlockSize"></param>
  27473. <param name="blocks">the List to be filled out.</param>
  27474. <returns>number of big blocks the list encompasses</returns>
  27475. </member>
  27476. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Convert(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Storage.BlockWritable[],System.Int32)">
  27477. <summary>
  27478. Factory for creating SmallDocumentBlocks from DocumentBlocks
  27479. </summary>
  27480. <param name="bigBlocksSize"></param>
  27481. <param name="store">the original DocumentBlocks</param>
  27482. <param name="size">the total document size</param>
  27483. <returns>an array of new SmallDocumentBlocks instances</returns>
  27484. </member>
  27485. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Extract(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Storage.ListManagedBlock[])">
  27486. <summary>
  27487. create a list of SmallDocumentBlock's from raw data
  27488. </summary>
  27489. <param name="bigBlockSize"></param>
  27490. <param name="blocks">the raw data containing the SmallDocumentBlock</param>
  27491. <returns>a List of SmallDocumentBlock's extracted from the input</returns>
  27492. </member>
  27493. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Read(NPOI.POIFS.Storage.BlockWritable[],System.Byte[],System.Int32)">
  27494. <summary>
  27495. Read data from an array of SmallDocumentBlocks
  27496. </summary>
  27497. <param name="blocks">the blocks to Read from.</param>
  27498. <param name="buffer">the buffer to Write the data into.</param>
  27499. <param name="offset">the offset into the array of blocks to Read from</param>
  27500. </member>
  27501. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.CalcSize(System.Int32)">
  27502. <summary>
  27503. Calculate the storage size of a Set of SmallDocumentBlocks
  27504. </summary>
  27505. <param name="size"> number of SmallDocumentBlocks</param>
  27506. <returns>total size</returns>
  27507. </member>
  27508. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.MakeEmptySmallDocumentBlock(NPOI.POIFS.Common.POIFSBigBlockSize)">
  27509. <summary>
  27510. Makes the empty small document block.
  27511. </summary>
  27512. <returns></returns>
  27513. </member>
  27514. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.ConvertToBlockCount(System.Int32)">
  27515. <summary>
  27516. Converts to block count.
  27517. </summary>
  27518. <param name="size">The size.</param>
  27519. <returns></returns>
  27520. </member>
  27521. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.WriteBlocks(System.IO.Stream)">
  27522. <summary>
  27523. Write the storage to an OutputStream
  27524. </summary>
  27525. <param name="stream">the OutputStream to which the stored data should
  27526. be written</param>
  27527. </member>
  27528. <member name="P:NPOI.POIFS.Storage.SmallDocumentBlock.Data">
  27529. <summary>
  27530. Get the data from the block
  27531. </summary>
  27532. <value>the block's data as a byte array</value>
  27533. </member>
  27534. <member name="T:NPOI.POIFS.Storage.SmallDocumentBlockList">
  27535. <summary>
  27536. A list of SmallDocumentBlocks instances, and methods to manage the list
  27537. @author Marc Johnson (mjohnson at apache dot org)
  27538. </summary>
  27539. </member>
  27540. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlockList.#ctor(System.Collections.Generic.List{NPOI.POIFS.Storage.SmallDocumentBlock})">
  27541. <summary>
  27542. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.SmallDocumentBlockList"/> class.
  27543. </summary>
  27544. <param name="blocks">a list of SmallDocumentBlock instances</param>
  27545. </member>
  27546. <member name="T:NPOI.POIOLE2TextExtractor">
  27547. <summary>
  27548. Common Parent for OLE2 based Text Extractors
  27549. of POI Documents, such as .doc, .xls
  27550. You will typically find the implementation of
  27551. a given format's text extractor under NPOI.Format.Extractor
  27552. </summary>
  27553. <remarks>
  27554. @see org.apache.poi.hssf.extractor.ExcelExtractor
  27555. @see org.apache.poi.hslf.extractor.PowerPointExtractor
  27556. @see org.apache.poi.hdgf.extractor.VisioTextExtractor
  27557. @see org.apache.poi.hwpf.extractor.WordExtractor
  27558. </remarks>
  27559. </member>
  27560. <member name="F:NPOI.POIOLE2TextExtractor.document">
  27561. The POIDocument that's open
  27562. </member>
  27563. <member name="M:NPOI.POIOLE2TextExtractor.#ctor(NPOI.POIDocument)">
  27564. <summary>
  27565. Creates a new text extractor for the given document
  27566. </summary>
  27567. <param name="document"></param>
  27568. </member>
  27569. <member name="M:NPOI.POIOLE2TextExtractor.#ctor(NPOI.POIOLE2TextExtractor)">
  27570. <summary>
  27571. Creates a new text extractor, using the same document as another
  27572. text extractor. Normally only used by properties extractors.
  27573. </summary>
  27574. <param name="otherExtractor"></param>
  27575. </member>
  27576. <member name="P:NPOI.POIOLE2TextExtractor.DocSummaryInformation">
  27577. <summary>
  27578. Returns the document information metadata for the document
  27579. </summary>
  27580. <value>The doc summary information.</value>
  27581. </member>
  27582. <member name="P:NPOI.POIOLE2TextExtractor.SummaryInformation">
  27583. <summary>
  27584. Returns the summary information metadata for the document
  27585. </summary>
  27586. <value>The summary information.</value>
  27587. </member>
  27588. <member name="P:NPOI.POIOLE2TextExtractor.MetadataTextExtractor">
  27589. <summary>
  27590. Returns an HPSF powered text extractor for the
  27591. document properties metadata, such as title and author.
  27592. </summary>
  27593. <value></value>
  27594. </member>
  27595. <member name="P:NPOI.POIOLE2TextExtractor.Root">
  27596. Return the underlying DirectoryEntry of this document.
  27597. @return the DirectoryEntry that is associated with the POIDocument of this extractor.
  27598. </member>
  27599. <member name="T:NPOI.POITextExtractor">
  27600. <summary>
  27601. Common Parent for Text Extractors
  27602. of POI Documents.
  27603. You will typically find the implementation of
  27604. a given format's text extractor under
  27605. org.apache.poi.[format].extractor .
  27606. </summary>
  27607. @see org.apache.poi.hssf.extractor.ExcelExtractor
  27608. @see org.apache.poi.hslf.extractor.PowerPointExtractor
  27609. @see org.apache.poi.hdgf.extractor.VisioTextExtractor
  27610. @see org.apache.poi.hwpf.extractor.WordExtractor
  27611. </member>
  27612. <member name="P:NPOI.POITextExtractor.Text">
  27613. <summary>
  27614. Retrieves all the text from the document.
  27615. How cells, paragraphs etc are separated in the text
  27616. is implementation specific - see the javadocs for
  27617. a specific project for details.
  27618. </summary>
  27619. <value>All the text from the document.</value>
  27620. </member>
  27621. <member name="P:NPOI.POITextExtractor.MetadataTextExtractor">
  27622. <summary>
  27623. Returns another text extractor, which is able to
  27624. output the textual content of the document
  27625. metadata / properties, such as author and title.
  27626. </summary>
  27627. <value>The metadata text extractor.</value>
  27628. </member>
  27629. <member name="M:NPOI.POITextExtractor.SetFilesystem(NPOI.Util.ICloseable)">
  27630. Used to ensure file handle cleanup.
  27631. @param fs filesystem to close
  27632. </member>
  27633. <member name="M:NPOI.Util.POIUtils.CopyNodeRecursively(NPOI.POIFS.FileSystem.Entry,NPOI.POIFS.FileSystem.DirectoryEntry)">
  27634. Copies an Entry into a target POIFS directory, recursively
  27635. </member>
  27636. <member name="M:NPOI.Util.POIUtils.CopyNodes(NPOI.POIFS.FileSystem.DirectoryEntry,NPOI.POIFS.FileSystem.DirectoryEntry,System.Collections.Generic.List{System.String})">
  27637. Copies nodes from one POIFS to the other minus the excepts
  27638. @param source
  27639. is the source POIFS to copy from
  27640. @param target
  27641. is the target POIFS to copy to
  27642. @param excepts
  27643. is a list of Strings specifying what nodes NOT to copy
  27644. </member>
  27645. <member name="M:NPOI.Util.POIUtils.CopyNodes(NPOI.POIFS.FileSystem.POIFSFileSystem,NPOI.POIFS.FileSystem.POIFSFileSystem,System.Collections.Generic.List{System.String})">
  27646. Copies nodes from one POIFS to the other minus the excepts
  27647. @param source
  27648. is the source POIFS to copy from
  27649. @param target
  27650. is the target POIFS to copy to
  27651. @param excepts
  27652. is a list of Strings specifying what nodes NOT to copy
  27653. </member>
  27654. <member name="M:NPOI.Util.Arrays.Fill(System.Byte[],System.Byte)">
  27655. <summary>
  27656. Fills the specified array.
  27657. </summary>
  27658. <param name="array">The array.</param>
  27659. <param name="defaultValue">The default value.</param>
  27660. </member>
  27661. <member name="M:NPOI.Util.Arrays.Fill(System.Byte[],System.Int32,System.Int32,System.Byte)">
  27662. <summary>
  27663. Assigns the specified byte value to each element of the specified
  27664. range of the specified array of bytes. The range to be filled
  27665. extends from index <tt>fromIndex</tt>, inclusive, to index
  27666. <tt>toIndex</tt>, exclusive. (If <tt>fromIndex==toIndex</tt>, the
  27667. range to be filled is empty.)
  27668. </summary>
  27669. <param name="a">the array to be filled</param>
  27670. <param name="fromIndex">the index of the first element (inclusive) to be filled with the specified value</param>
  27671. <param name="toIndex">the index of the last element (exclusive) to be filled with the specified value</param>
  27672. <param name="val">the value to be stored in all elements of the array</param>
  27673. <exception cref="T:System.ArgumentException">if <c>fromIndex &gt; toIndex</c></exception>
  27674. <exception cref="T:System.IndexOutOfRangeException"> if <c>fromIndex &lt; 0</c> or <c>toIndex &gt; a.length</c></exception>
  27675. </member>
  27676. <member name="M:NPOI.Util.Arrays.RangeCheck(System.Int32,System.Int32,System.Int32)">
  27677. <summary>
  27678. Checks that {@code fromIndex} and {@code toIndex} are in
  27679. the range and throws an appropriate exception, if they aren't.
  27680. </summary>
  27681. <param name="length"></param>
  27682. <param name="fromIndex"></param>
  27683. <param name="toIndex"></param>
  27684. </member>
  27685. <member name="M:NPOI.Util.Arrays.AsList(System.Array)">
  27686. <summary>
  27687. Convert Array to ArrayList
  27688. </summary>
  27689. <param name="arr">source array</param>
  27690. <returns></returns>
  27691. </member>
  27692. <member name="M:NPOI.Util.Arrays.Fill(System.Int32[],System.Byte)">
  27693. <summary>
  27694. Fills the specified array.
  27695. </summary>
  27696. <param name="array">The array.</param>
  27697. <param name="defaultValue">The default value.</param>
  27698. </member>
  27699. <member name="M:NPOI.Util.Arrays.Equals(System.Object,System.Object)">
  27700. <summary>
  27701. Equals the specified a1.
  27702. </summary>
  27703. <param name="a1">The a1.</param>
  27704. <param name="b1">The b1.</param>
  27705. <returns></returns>
  27706. </member>
  27707. <member name="M:NPOI.Util.Arrays.Equals(System.Object[],System.Object[])">
  27708. Returns <c>true</c> if the two specified arrays of Objects are
  27709. <i>equal</i> to one another. The two arrays are considered equal if
  27710. both arrays contain the same number of elements, and all corresponding
  27711. pairs of elements in the two arrays are equal. Two objects <c>e1</c>
  27712. and <c>e2</c> are considered <i>equal</i> if <c>(e1==null ? e2==null
  27713. : e1.equals(e2))</c>. In other words, the two arrays are equal if
  27714. they contain the same elements in the same order. Also, two array
  27715. references are considered equal if both are <c>null</c>.
  27716. @param a one array to be tested for equality
  27717. @param a2 the other array to be tested for equality
  27718. @return <c>true</c> if the two arrays are equal
  27719. </member>
  27720. <member name="M:NPOI.Util.Arrays.ArrayMoveWithin(System.Object[],System.Int32,System.Int32,System.Int32)">
  27721. <summary>
  27722. Moves a number of entries in an array to another point in the array, shifting those inbetween as required.
  27723. </summary>
  27724. <param name="array">The array to alter</param>
  27725. <param name="moveFrom">The (0 based) index of the first entry to move</param>
  27726. <param name="moveTo">The (0 based) index of the positition to move to</param>
  27727. <param name="numToMove">The number of entries to move</param>
  27728. </member>
  27729. <member name="M:NPOI.Util.Arrays.CopyOf(System.Byte[],System.Int32)">
  27730. <summary>
  27731. Copies the specified array, truncating or padding with zeros (if
  27732. necessary) so the copy has the specified length. This method is temporary
  27733. replace for Arrays.copyOf() until we start to require JDK 1.6.
  27734. </summary>
  27735. <param name="source">the array to be copied</param>
  27736. <param name="newLength">the length of the copy to be returned</param>
  27737. <returns>a copy of the original array, truncated or padded with zeros to obtain the specified length</returns>
  27738. </member>
  27739. <member name="M:NPOI.Util.Arrays.HashCode(System.Int64[])">
  27740. Returns a hash code based on the contents of the specified array.
  27741. For any two <tt>long</tt> arrays <tt>a</tt> and <tt>b</tt>
  27742. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  27743. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  27744. The value returned by this method is the same value that would be
  27745. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  27746. method on a {@link List} Containing a sequence of {@link Long}
  27747. instances representing the elements of <tt>a</tt> in the same order.
  27748. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  27749. @param a the array whose hash value to compute
  27750. @return a content-based hash code for <tt>a</tt>
  27751. @since 1.5
  27752. </member>
  27753. <member name="M:NPOI.Util.Arrays.HashCode(System.Int32[])">
  27754. Returns a hash code based on the contents of the specified array.
  27755. For any two non-null <tt>int</tt> arrays <tt>a</tt> and <tt>b</tt>
  27756. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  27757. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  27758. The value returned by this method is the same value that would be
  27759. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  27760. method on a {@link List} Containing a sequence of {@link int}
  27761. instances representing the elements of <tt>a</tt> in the same order.
  27762. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  27763. @param a the array whose hash value to compute
  27764. @return a content-based hash code for <tt>a</tt>
  27765. @since 1.5
  27766. </member>
  27767. <member name="M:NPOI.Util.Arrays.HashCode(System.Int16[])">
  27768. Returns a hash code based on the contents of the specified array.
  27769. For any two <tt>short</tt> arrays <tt>a</tt> and <tt>b</tt>
  27770. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  27771. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  27772. The value returned by this method is the same value that would be
  27773. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  27774. method on a {@link List} Containing a sequence of {@link short}
  27775. instances representing the elements of <tt>a</tt> in the same order.
  27776. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  27777. @param a the array whose hash value to compute
  27778. @return a content-based hash code for <tt>a</tt>
  27779. @since 1.5
  27780. </member>
  27781. <member name="M:NPOI.Util.Arrays.HashCode(System.Char[])">
  27782. Returns a hash code based on the contents of the specified array.
  27783. For any two <tt>char</tt> arrays <tt>a</tt> and <tt>b</tt>
  27784. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  27785. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  27786. The value returned by this method is the same value that would be
  27787. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  27788. method on a {@link List} Containing a sequence of {@link Character}
  27789. instances representing the elements of <tt>a</tt> in the same order.
  27790. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  27791. @param a the array whose hash value to compute
  27792. @return a content-based hash code for <tt>a</tt>
  27793. @since 1.5
  27794. </member>
  27795. <member name="M:NPOI.Util.Arrays.HashCode(System.Byte[])">
  27796. Returns a hash code based on the contents of the specified array.
  27797. For any two <tt>byte</tt> arrays <tt>a</tt> and <tt>b</tt>
  27798. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  27799. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  27800. The value returned by this method is the same value that would be
  27801. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  27802. method on a {@link List} Containing a sequence of {@link Byte}
  27803. instances representing the elements of <tt>a</tt> in the same order.
  27804. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  27805. @param a the array whose hash value to compute
  27806. @return a content-based hash code for <tt>a</tt>
  27807. @since 1.5
  27808. </member>
  27809. <member name="M:NPOI.Util.Arrays.HashCode(System.Boolean[])">
  27810. Returns a hash code based on the contents of the specified array.
  27811. For any two <tt>bool</tt> arrays <tt>a</tt> and <tt>b</tt>
  27812. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  27813. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  27814. The value returned by this method is the same value that would be
  27815. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  27816. method on a {@link List} Containing a sequence of {@link Boolean}
  27817. instances representing the elements of <tt>a</tt> in the same order.
  27818. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  27819. @param a the array whose hash value to compute
  27820. @return a content-based hash code for <tt>a</tt>
  27821. @since 1.5
  27822. </member>
  27823. <member name="M:NPOI.Util.Arrays.HashCode(System.Single[])">
  27824. Returns a hash code based on the contents of the specified array.
  27825. For any two <tt>float</tt> arrays <tt>a</tt> and <tt>b</tt>
  27826. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  27827. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  27828. The value returned by this method is the same value that would be
  27829. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  27830. method on a {@link List} Containing a sequence of {@link Float}
  27831. instances representing the elements of <tt>a</tt> in the same order.
  27832. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  27833. @param a the array whose hash value to compute
  27834. @return a content-based hash code for <tt>a</tt>
  27835. @since 1.5
  27836. </member>
  27837. <member name="M:NPOI.Util.Arrays.HashCode(System.Double[])">
  27838. Returns a hash code based on the contents of the specified array.
  27839. For any two <tt>double</tt> arrays <tt>a</tt> and <tt>b</tt>
  27840. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  27841. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  27842. The value returned by this method is the same value that would be
  27843. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  27844. method on a {@link List} Containing a sequence of {@link Double}
  27845. instances representing the elements of <tt>a</tt> in the same order.
  27846. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  27847. @param a the array whose hash value to compute
  27848. @return a content-based hash code for <tt>a</tt>
  27849. @since 1.5
  27850. </member>
  27851. <member name="M:NPOI.Util.Arrays.HashCode(System.Object[])">
  27852. Returns a hash code based on the contents of the specified array. If
  27853. the array Contains other arrays as elements, the hash code is based on
  27854. their identities rather than their contents. It is therefore
  27855. acceptable to invoke this method on an array that Contains itself as an
  27856. element, either directly or indirectly through one or more levels of
  27857. arrays.
  27858. For any two arrays <tt>a</tt> and <tt>b</tt> such that
  27859. <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  27860. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  27861. The value returned by this method is equal to the value that would
  27862. be returned by <tt>Arrays.AsList(a).HashCode()</tt>, unless <tt>a</tt>
  27863. is <tt>null</tt>, in which case <tt>0</tt> is returned.
  27864. @param a the array whose content-based hash code to compute
  27865. @return a content-based hash code for <tt>a</tt>
  27866. @see #deepHashCode(Object[])
  27867. @since 1.5
  27868. </member>
  27869. <member name="M:NPOI.Util.Arrays.DeepHashCode(System.Object[])">
  27870. Returns a hash code based on the "deep contents" of the specified
  27871. array. If the array Contains other arrays as elements, the
  27872. hash code is based on their contents and so on, ad infInitum.
  27873. It is therefore unacceptable to invoke this method on an array that
  27874. Contains itself as an element, either directly or indirectly through
  27875. one or more levels of arrays. The behavior of such an invocation is
  27876. undefined.
  27877. For any two arrays <tt>a</tt> and <tt>b</tt> such that
  27878. <tt>Arrays.DeepEquals(a, b)</tt>, it is also the case that
  27879. <tt>Arrays.DeepHashCode(a) == Arrays.DeepHashCode(b)</tt>.
  27880. The computation of the value returned by this method is similar to
  27881. that of the value returned by {@link List#hashCode()} on a list
  27882. Containing the same elements as <tt>a</tt> in the same order, with one
  27883. difference: If an element <tt>e</tt> of <tt>a</tt> is itself an array,
  27884. its hash code is computed not by calling <tt>e.HashCode()</tt>, but as
  27885. by calling the appropriate overloading of <tt>Arrays.HashCode(e)</tt>
  27886. if <tt>e</tt> is an array of a primitive type, or as by calling
  27887. <tt>Arrays.DeepHashCode(e)</tt> recursively if <tt>e</tt> is an array
  27888. of a reference type. If <tt>a</tt> is <tt>null</tt>, this method
  27889. returns 0.
  27890. @param a the array whose deep-content-based hash code to compute
  27891. @return a deep-content-based hash code for <tt>a</tt>
  27892. @see #hashCode(Object[])
  27893. @since 1.5
  27894. </member>
  27895. <member name="M:NPOI.Util.Arrays.DeepEquals(System.Object[],System.Object[])">
  27896. Returns <tt>true</tt> if the two specified arrays are <i>deeply
  27897. Equal</i> to one another. Unlike the {@link #Equals(Object[],Object[])}
  27898. method, this method is appropriate for use with nested arrays of
  27899. arbitrary depth.
  27900. Two array references are considered deeply equal if both
  27901. are <tt>null</tt>, or if they refer to arrays that contain the same
  27902. number of elements and all corresponding pairs of elements in the two
  27903. arrays are deeply Equal.
  27904. Two possibly <tt>null</tt> elements <tt>e1</tt> and <tt>e2</tt> are
  27905. deeply equal if any of the following conditions hold:
  27906. <ul>
  27907. <li> <tt>e1</tt> and <tt>e2</tt> are both arrays of object reference
  27908. types, and <tt>Arrays.DeepEquals(e1, e2) would return true</tt></li>
  27909. <li> <tt>e1</tt> and <tt>e2</tt> are arrays of the same primitive
  27910. type, and the appropriate overloading of
  27911. <tt>Arrays.Equals(e1, e2)</tt> would return true.</li>
  27912. <li> <tt>e1 == e2</tt></li>
  27913. <li> <tt>e1.Equals(e2)</tt> would return true.</li>
  27914. </ul>
  27915. Note that this defInition permits <tt>null</tt> elements at any depth.
  27916. If either of the specified arrays contain themselves as elements
  27917. either directly or indirectly through one or more levels of arrays,
  27918. the behavior of this method is undefined.
  27919. @param a1 one array to be tested for Equality
  27920. @param a2 the other array to be tested for Equality
  27921. @return <tt>true</tt> if the two arrays are equal
  27922. @see #Equals(Object[],Object[])
  27923. @see Objects#deepEquals(Object, Object)
  27924. @since 1.5
  27925. </member>
  27926. <member name="M:NPOI.Util.Arrays.ToString(System.Int64[])">
  27927. Returns a string representation of the contents of the specified array.
  27928. The string representation consists of a list of the array's elements,
  27929. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  27930. Separated by the characters <tt>", "</tt> (a comma followed by a
  27931. space). Elements are Converted to strings as by
  27932. <tt>String.ValueOf(long)</tt>. Returns <tt>"null"</tt> if <tt>a</tt>
  27933. is <tt>null</tt>.
  27934. @param a the array whose string representation to return
  27935. @return a string representation of <tt>a</tt>
  27936. @since 1.5
  27937. </member>
  27938. <member name="M:NPOI.Util.Arrays.ToString(System.Int32[])">
  27939. Returns a string representation of the contents of the specified array.
  27940. The string representation consists of a list of the array's elements,
  27941. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  27942. Separated by the characters <tt>", "</tt> (a comma followed by a
  27943. space). Elements are Converted to strings as by
  27944. <tt>String.ValueOf(int)</tt>. Returns <tt>"null"</tt> if <tt>a</tt> is
  27945. <tt>null</tt>.
  27946. @param a the array whose string representation to return
  27947. @return a string representation of <tt>a</tt>
  27948. @since 1.5
  27949. </member>
  27950. <member name="M:NPOI.Util.Arrays.ToString(System.Int16[])">
  27951. Returns a string representation of the contents of the specified array.
  27952. The string representation consists of a list of the array's elements,
  27953. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  27954. Separated by the characters <tt>", "</tt> (a comma followed by a
  27955. space). Elements are Converted to strings as by
  27956. <tt>String.ValueOf(short)</tt>. Returns <tt>"null"</tt> if <tt>a</tt>
  27957. is <tt>null</tt>.
  27958. @param a the array whose string representation to return
  27959. @return a string representation of <tt>a</tt>
  27960. @since 1.5
  27961. </member>
  27962. <member name="M:NPOI.Util.Arrays.ToString(System.Char[])">
  27963. Returns a string representation of the contents of the specified array.
  27964. The string representation consists of a list of the array's elements,
  27965. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  27966. Separated by the characters <tt>", "</tt> (a comma followed by a
  27967. space). Elements are Converted to strings as by
  27968. <tt>String.ValueOf(char)</tt>. Returns <tt>"null"</tt> if <tt>a</tt>
  27969. is <tt>null</tt>.
  27970. @param a the array whose string representation to return
  27971. @return a string representation of <tt>a</tt>
  27972. @since 1.5
  27973. </member>
  27974. <member name="M:NPOI.Util.Arrays.ToString(System.Byte[])">
  27975. Returns a string representation of the contents of the specified array.
  27976. The string representation consists of a list of the array's elements,
  27977. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements
  27978. are Separated by the characters <tt>", "</tt> (a comma followed
  27979. by a space). Elements are Converted to strings as by
  27980. <tt>String.ValueOf(byte)</tt>. Returns <tt>"null"</tt> if
  27981. <tt>a</tt> is <tt>null</tt>.
  27982. @param a the array whose string representation to return
  27983. @return a string representation of <tt>a</tt>
  27984. @since 1.5
  27985. </member>
  27986. <member name="M:NPOI.Util.Arrays.ToString(System.Boolean[])">
  27987. Returns a string representation of the contents of the specified array.
  27988. The string representation consists of a list of the array's elements,
  27989. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  27990. Separated by the characters <tt>", "</tt> (a comma followed by a
  27991. space). Elements are Converted to strings as by
  27992. <tt>String.ValueOf(bool)</tt>. Returns <tt>"null"</tt> if
  27993. <tt>a</tt> is <tt>null</tt>.
  27994. @param a the array whose string representation to return
  27995. @return a string representation of <tt>a</tt>
  27996. @since 1.5
  27997. </member>
  27998. <member name="M:NPOI.Util.Arrays.ToString(System.Single[])">
  27999. Returns a string representation of the contents of the specified array.
  28000. The string representation consists of a list of the array's elements,
  28001. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  28002. Separated by the characters <tt>", "</tt> (a comma followed by a
  28003. space). Elements are Converted to strings as by
  28004. <tt>String.ValueOf(float)</tt>. Returns <tt>"null"</tt> if <tt>a</tt>
  28005. is <tt>null</tt>.
  28006. @param a the array whose string representation to return
  28007. @return a string representation of <tt>a</tt>
  28008. @since 1.5
  28009. </member>
  28010. <member name="M:NPOI.Util.Arrays.ToString(System.Double[])">
  28011. Returns a string representation of the contents of the specified array.
  28012. The string representation consists of a list of the array's elements,
  28013. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  28014. Separated by the characters <tt>", "</tt> (a comma followed by a
  28015. space). Elements are Converted to strings as by
  28016. <tt>String.ValueOf(double)</tt>. Returns <tt>"null"</tt> if <tt>a</tt>
  28017. is <tt>null</tt>.
  28018. @param a the array whose string representation to return
  28019. @return a string representation of <tt>a</tt>
  28020. @since 1.5
  28021. </member>
  28022. <member name="M:NPOI.Util.Arrays.DeepToString(System.Object[])">
  28023. Returns a string representation of the "deep contents" of the specified
  28024. array. If the array Contains other arrays as elements, the string
  28025. representation Contains their contents and so on. This method is
  28026. designed for Converting multidimensional arrays to strings.
  28027. The string representation consists of a list of the array's
  28028. elements, enclosed in square brackets (<tt>"[]"</tt>). Adjacent
  28029. elements are Separated by the characters <tt>", "</tt> (a comma
  28030. followed by a space). Elements are Converted to strings as by
  28031. <tt>String.ValueOf(Object)</tt>, unless they are themselves
  28032. arrays.
  28033. If an element <tt>e</tt> is an array of a primitive type, it is
  28034. Converted to a string as by invoking the appropriate overloading of
  28035. <tt>Arrays.ToString(e)</tt>. If an element <tt>e</tt> is an array of a
  28036. reference type, it is Converted to a string as by invoking
  28037. this method recursively.
  28038. To avoid infInite recursion, if the specified array Contains itself
  28039. as an element, or Contains an indirect reference to itself through one
  28040. or more levels of arrays, the self-reference is Converted to the string
  28041. <tt>"[...]"</tt>. For example, an array Containing only a reference
  28042. to itself would be rendered as <tt>"[[...]]"</tt>.
  28043. This method returns <tt>"null"</tt> if the specified array
  28044. is <tt>null</tt>.
  28045. @param a the array whose string representation to return
  28046. @return a string representation of <tt>a</tt>
  28047. @see #ToString(Object[])
  28048. @since 1.5
  28049. </member>
  28050. <member name="M:NPOI.Util.Arrays.ToString(System.Object[])">
  28051. Returns a string representation of the contents of the specified array.
  28052. If the array contains other arrays as elements, they are converted to
  28053. strings by the {@link Object#toString} method inherited from
  28054. <tt>Object</tt>, which describes their <i>identities</i> rather than
  28055. their contents.
  28056. <p>The value returned by this method is equal to the value that would
  28057. be returned by <tt>Arrays.asList(a).toString()</tt>, unless <tt>a</tt>
  28058. is <tt>null</tt>, in which case <tt>"null"</tt> is returned.</p>
  28059. @param a the array whose string representation to return
  28060. @return a string representation of <tt>a</tt>
  28061. @see #deepToString(Object[])
  28062. @since 1.5
  28063. </member>
  28064. <member name="F:NPOI.Util.BigInteger._signum">
  28065. The signum of this BigInteger: -1 for negative, 0 for zero, or
  28066. 1 for positive. Note that the BigInteger zero <i>must</i> have
  28067. a signum of 0. This is necessary to ensures that there is exactly one
  28068. representation for each BigInteger value.
  28069. @serial
  28070. </member>
  28071. <member name="F:NPOI.Util.BigInteger.mag">
  28072. The magnitude of this BigInteger, in <i>big-endian</i> order: the
  28073. zeroth element of this array is the most-significant int of the
  28074. magnitude. The magnitude must be "minimal" in that the most-significant
  28075. int ({@code mag[0]}) must be non-zero. This is necessary to
  28076. ensure that there is exactly one representation for each BigInteger
  28077. value. Note that this implies that the BigInteger zero has a
  28078. zero-length mag array.
  28079. </member>
  28080. <member name="F:NPOI.Util.BigInteger.bitCount">
  28081. One plus the bitCount of this BigInteger. Zeros means unitialized.
  28082. @serial
  28083. @see #bitCount
  28084. @deprecated Deprecated since logical value is offset from stored
  28085. value and correction factor is applied in accessor method.
  28086. </member>
  28087. <member name="F:NPOI.Util.BigInteger.bitLength">
  28088. One plus the bitLength of this BigInteger. Zeros means unitialized.
  28089. (either value is acceptable).
  28090. @serial
  28091. @see #bitLength()
  28092. @deprecated Deprecated since logical value is offset from stored
  28093. value and correction factor is applied in accessor method.
  28094. </member>
  28095. <member name="F:NPOI.Util.BigInteger.firstNonzeroIntNum">
  28096. Two plus the index of the lowest-order int in the magnitude of this
  28097. BigInteger that contains a nonzero int, or -2 (either value is acceptable).
  28098. The least significant int has int-number 0, the next int in order of
  28099. increasing significance has int-number 1, and so forth.
  28100. @deprecated Deprecated since logical value is offset from stored
  28101. value and correction factor is applied in accessor method.
  28102. </member>
  28103. <member name="F:NPOI.Util.BigInteger.LONG_MASK">
  28104. This mask is used to obtain the value of an int as if it were unsigned.
  28105. </member>
  28106. <member name="M:NPOI.Util.BigInteger.#ctor(System.Int32[],System.Int32)">
  28107. This internal constructor differs from its public cousin
  28108. with the arguments reversed in two ways: it assumes that its
  28109. arguments are correct, and it doesn't copy the magnitude array.
  28110. </member>
  28111. <member name="M:NPOI.Util.BigInteger.#ctor(System.Byte[])">
  28112. Translates a byte array containing the two's-complement binary
  28113. representation of a BigInteger into a BigInteger. The input array is
  28114. assumed to be in <i>big-endian</i> byte-order: the most significant
  28115. byte is in the zeroth element.
  28116. @param val big-endian two's-complement binary representation of
  28117. BigInteger.
  28118. @throws NumberFormatException {@code val} is zero bytes long.
  28119. </member>
  28120. <member name="M:NPOI.Util.BigInteger.#ctor(System.Int32[])">
  28121. This private constructor translates an int array containing the
  28122. two's-complement binary representation of a BigInteger into a
  28123. BigInteger. The input array is assumed to be in <i>big-endian</i>
  28124. int-order: the most significant int is in the zeroth element.
  28125. </member>
  28126. <member name="M:NPOI.Util.BigInteger.#ctor(System.Int64)">
  28127. Constructs a BigInteger with the specified value, which may not be zero.
  28128. </member>
  28129. <member name="M:NPOI.Util.BigInteger.TrustedStripLeadingZeroInts(System.Int32[])">
  28130. Returns the input array stripped of any leading zero bytes.
  28131. Since the source is trusted the copying may be skipped.
  28132. </member>
  28133. <member name="M:NPOI.Util.BigInteger.ToString(System.Int32)">
  28134. Returns the String representation of this BigInteger in the
  28135. given radix. If the radix is outside the range from {@link
  28136. Character#Min_RADIX} to {@link Character#Max_RADIX} inclusive,
  28137. it will default to 10 (as is the case for
  28138. {@code Integer.toString}). The digit-to-character mapping
  28139. provided by {@code Character.forDigit} is used, and a minus
  28140. sign is prepended if appropriate. (This representation is
  28141. compatible with the {@link #BigInteger(String, int) (String,
  28142. int)} constructor.)
  28143. @param radix radix of the String representation.
  28144. @return String representation of this BigInteger in the given radix.
  28145. @see Integer#toString
  28146. @see Character#forDigit
  28147. @see #BigInteger(java.lang.String, int)
  28148. </member>
  28149. <member name="F:NPOI.Util.BigInteger.ZERO">
  28150. The BigInteger constant zero.
  28151. @since 1.2
  28152. </member>
  28153. <member name="F:NPOI.Util.BigInteger.One">
  28154. The BigInteger constant one.
  28155. @since 1.2
  28156. </member>
  28157. <member name="F:NPOI.Util.BigInteger.Two">
  28158. The BigInteger constant two. (Not exported.)
  28159. </member>
  28160. <member name="F:NPOI.Util.BigInteger.TEN">
  28161. The BigInteger constant ten.
  28162. @since 1.5
  28163. </member>
  28164. <member name="M:NPOI.Util.BigInteger.ValueOf(System.Int64)">
  28165. Returns a BigInteger whose value is equal to that of the
  28166. specified {@code long}. This "static factory method" is
  28167. provided in preference to a ({@code long}) constructor
  28168. because it allows for reuse of frequently used BigIntegers.
  28169. @param val value of the BigInteger to return.
  28170. @return a BigInteger with the specified value.
  28171. </member>
  28172. <member name="M:NPOI.Util.BigInteger.ValueOf(System.Int32[])">
  28173. Returns a BigInteger with the given two's complement representation.
  28174. Assumes that the input array will not be modified (the returned
  28175. BigInteger will reference the input array if feasible).
  28176. </member>
  28177. <member name="M:NPOI.Util.BigInteger.BitLengthForInt(System.Int32)">
  28178. Package private method to return bit length for an integer.
  28179. </member>
  28180. <member name="M:NPOI.Util.BigInteger.BitCount">
  28181. Returns the number of bits in the two's complement representation
  28182. of this BigInteger that differ from its sign bit. This method is
  28183. useful when implementing bit-vector style sets atop BigIntegers.
  28184. @return number of bits in the two's complement representation
  28185. of this BigInteger that differ from its sign bit.
  28186. </member>
  28187. <member name="M:NPOI.Util.BigInteger.Abs">
  28188. Returns a BigInteger whose value is the absolute value of this
  28189. BigInteger.
  28190. @return {@code abs(this)}
  28191. </member>
  28192. <member name="M:NPOI.Util.BigInteger.Negate">
  28193. Returns a BigInteger whose value is {@code (-this)}.
  28194. @return {@code -this}
  28195. </member>
  28196. <member name="M:NPOI.Util.BigInteger.Pow(System.Int32)">
  28197. Returns a BigInteger whose value is <c>(this<sup>exponent</sup>)</c>.
  28198. Note that {@code exponent} is an integer rather than a BigInteger.
  28199. @param exponent exponent to which this BigInteger is to be raised.
  28200. @return <c>this<sup>exponent</sup></c>
  28201. @throws ArithmeticException {@code exponent} is negative. (This would
  28202. cause the operation to yield a non-integer value.)
  28203. </member>
  28204. <member name="M:NPOI.Util.BigInteger.MultiplyToLen(System.Int32[],System.Int32,System.Int32[],System.Int32,System.Int32[])">
  28205. Multiplies int arrays x and y to the specified lengths and places
  28206. the result into z. There will be no leading zeros in the resultant array.
  28207. </member>
  28208. <member name="M:NPOI.Util.BigInteger.mulAdd(System.Int32[],System.Int32[],System.Int32,System.Int32,System.Int32)">
  28209. Multiply an array by one word k and add to result, return the carry
  28210. </member>
  28211. <member name="M:NPOI.Util.BigInteger.squareToLen(System.Int32[],System.Int32,System.Int32[])">
  28212. Squares the contents of the int array x. The result is placed into the
  28213. int array z. The contents of x are not changed.
  28214. </member>
  28215. <member name="M:NPOI.Util.BigInteger.addOne(System.Int32[],System.Int32,System.Int32,System.Int32)">
  28216. Add one word to the number a mlen words into a. Return the resulting
  28217. carry.
  28218. </member>
  28219. <member name="M:NPOI.Util.BigInteger.Signum">
  28220. Returns the signum function of this BigInteger.
  28221. @return -1, 0 or 1 as the value of this BigInteger is negative, zero or
  28222. positive.
  28223. </member>
  28224. <member name="M:NPOI.Util.BigInteger.ToByteArray">
  28225. Returns a byte array containing the two's-complement
  28226. representation of this BigInteger. The byte array will be in
  28227. <i>big-endian</i> byte-order: the most significant byte is in
  28228. the zeroth element. The array will contain the minimum number
  28229. of bytes required to represent this BigInteger, including at
  28230. least one sign bit, which is {@code (ceil((this.bitLength() +
  28231. 1)/8))}. (This representation is compatible with the
  28232. {@link #BigInteger(byte[]) (byte[])} constructor.)
  28233. @return a byte array containing the two's-complement representation of
  28234. this BigInteger.
  28235. @see #BigInteger(byte[])
  28236. </member>
  28237. <member name="M:NPOI.Util.BigInteger.intLength">
  28238. Returns the length of the two's complement representation in ints,
  28239. including space for at least one sign bit.
  28240. </member>
  28241. <member name="M:NPOI.Util.BigInteger.GetInt(System.Int32)">
  28242. Returns the specified int of the little-endian two's complement
  28243. representation (int 0 is the least significant). The int number can
  28244. be arbitrarily high (values are logically preceded by infinitely many
  28245. sign ints).
  28246. </member>
  28247. <member name="M:NPOI.Util.BigInteger.FirstNonzeroIntNum">
  28248. Returns the index of the int that contains the first nonzero int in the
  28249. little-endian binary representation of the magnitude (int 0 is the
  28250. least significant). If the magnitude is zero, return value is undefined.
  28251. </member>
  28252. <member name="M:NPOI.Util.BigInteger.stripLeadingZeroBytes(System.Byte[])">
  28253. Returns a copy of the input array stripped of any leading zero bytes.
  28254. </member>
  28255. <member name="M:NPOI.Util.BigInteger.makePositive(System.Byte[])">
  28256. Takes an array a representing a negative 2's-complement number and
  28257. returns the minimal (no leading zero bytes) unsigned whose value is -a.
  28258. </member>
  28259. <member name="M:NPOI.Util.BigInteger.makePositive(System.Int32[])">
  28260. Takes an array a representing a negative 2's-complement number and
  28261. returns the minimal (no leading zero ints) unsigned whose value is -a.
  28262. </member>
  28263. <member name="M:NPOI.Util.BigInteger.NumberOfLeadingZeros(System.Int32)">
  28264. Returns the number of zero bits preceding the highest-order
  28265. ("leftmost") one-bit in the two's complement binary representation
  28266. of the specified {@code int} value. Returns 32 if the
  28267. specified value has no one-bits in its two's complement representation,
  28268. in other words if it is equal to zero.
  28269. Note that this method is closely related to the logarithm base 2.
  28270. For all positive {@code int} values x:
  28271. <ul>
  28272. <li>floor(log<sub>2</sub>(x)) = {@code 31 - numberOfLeadingZeros(x)}</li>
  28273. <li>ceil(log<sub>2</sub>(x)) = {@code 32 - numberOfLeadingZeros(x - 1)}</li>
  28274. </ul>
  28275. @return the number of zero bits preceding the highest-order
  28276. ("leftmost") one-bit in the two's complement binary representation
  28277. of the specified {@code int} value, or 32 if the value
  28278. is equal to zero.
  28279. @since 1.5
  28280. </member>
  28281. <member name="M:NPOI.Util.BigInteger.NumberOfTrailingZeros(System.Int32)">
  28282. Returns the number of zero bits following the lowest-order ("rightmost")
  28283. one-bit in the two's complement binary representation of the specified
  28284. {@code int} value. Returns 32 if the specified value has no
  28285. one-bits in its two's complement representation, in other words if it is
  28286. equal to zero.
  28287. @return the number of zero bits following the lowest-order ("rightmost")
  28288. one-bit in the two's complement binary representation of the
  28289. specified {@code int} value, or 32 if the value is equal
  28290. to zero.
  28291. @since 1.5
  28292. </member>
  28293. <member name="M:NPOI.Util.BigInteger.BitCountForInt(System.Int32)">
  28294. Returns the number of one-bits in the two's complement binary
  28295. representation of the specified {@code int} value. This function is
  28296. sometimes referred to as the <i>population count</i>.
  28297. @return the number of one-bits in the two's complement binary
  28298. representation of the specified {@code int} value.
  28299. @since 1.5
  28300. </member>
  28301. <member name="M:NPOI.Util.BigInteger.compareMagnitude(NPOI.Util.BigInteger)">
  28302. Compares the magnitude array of this BigInteger with the specified
  28303. BigInteger's. This is the version of compareTo ignoring sign.
  28304. @param val BigInteger whose magnitude array to be compared.
  28305. @return -1, 0 or 1 as this magnitude array is less than, equal to or
  28306. greater than the magnitude aray for the specified BigInteger's.
  28307. </member>
  28308. <member name="M:NPOI.Util.BigInteger.Equals(System.Object)">
  28309. Compares this BigInteger with the specified Object for equality.
  28310. @param x Object to which this BigInteger is to be compared.
  28311. @return {@code true} if and only if the specified Object is a
  28312. BigInteger whose value is numerically equal to this BigInteger.
  28313. </member>
  28314. <member name="M:NPOI.Util.BigInteger.Min(NPOI.Util.BigInteger)">
  28315. Returns the minimum of this BigInteger and {@code val}.
  28316. @param val value with which the minimum is to be computed.
  28317. @return the BigInteger whose value is the lesser of this BigInteger and
  28318. {@code val}. If they are equal, either may be returned.
  28319. </member>
  28320. <member name="M:NPOI.Util.BigInteger.Max(NPOI.Util.BigInteger)">
  28321. Returns the maximum of this BigInteger and {@code val}.
  28322. @param val value with which the maximum is to be computed.
  28323. @return the BigInteger whose value is the greater of this and
  28324. {@code val}. If they are equal, either may be returned.
  28325. </member>
  28326. <member name="M:NPOI.Util.BigInteger.GetHashCode">
  28327. Returns the hash code for this BigInteger.
  28328. @return hash code for this BigInteger.
  28329. </member>
  28330. <member name="M:NPOI.Util.BigInteger.IntValue">
  28331. Converts this BigInteger to an {@code int}. This
  28332. conversion is analogous to a
  28333. <i>narrowing primitive conversion</i> from {@code long} to
  28334. {@code int} as defined in section 5.1.3 of
  28335. <cite>The Java(TM) Language Specification</cite>:
  28336. if this BigInteger is too big to fit in an
  28337. {@code int}, only the low-order 32 bits are returned.
  28338. Note that this conversion can lose information about the
  28339. overall magnitude of the BigInteger value as well as return a
  28340. result with the opposite sign.
  28341. @return this BigInteger converted to an {@code int}.
  28342. </member>
  28343. <member name="M:NPOI.Util.BigInteger.LongValue">
  28344. Converts this BigInteger to a {@code long}. This
  28345. conversion is analogous to a
  28346. <i>narrowing primitive conversion</i> from {@code long} to
  28347. {@code int} as defined in section 5.1.3 of
  28348. <cite>The Java(TM) Language Specification</cite>:
  28349. if this BigInteger is too big to fit in a
  28350. {@code long}, only the low-order 64 bits are returned.
  28351. Note that this conversion can lose information about the
  28352. overall magnitude of the BigInteger value as well as return a
  28353. result with the opposite sign.
  28354. @return this BigInteger converted to a {@code long}.
  28355. </member>
  28356. <member name="M:NPOI.Util.BigInteger.ShiftRight(System.Int32)">
  28357. Returns a BigInteger whose value is {@code (this >> n)}. Sign
  28358. extension is performed. The shift distance, {@code n}, may be
  28359. negative, in which case this method performs a left shift.
  28360. (Computes <c>floor(this / 2<sup>n</sup>)</c>.)
  28361. @param n shift distance, in bits.
  28362. @return {@code this >> n}
  28363. @throws ArithmeticException if the shift distance is {@code
  28364. Integer.Min_VALUE}.
  28365. @see #shiftLeft
  28366. </member>
  28367. <member name="M:NPOI.Util.BigInteger.Not">
  28368. Returns a BigInteger whose value is {@code (~this)}. (This method
  28369. returns a negative value if and only if this BigInteger is
  28370. non-negative.)
  28371. @return {@code ~this}
  28372. </member>
  28373. <member name="M:NPOI.Util.BigInteger.Or(NPOI.Util.BigInteger)">
  28374. Returns a BigInteger whose value is {@code (this | val)}. (This method
  28375. returns a negative BigInteger if and only if either this or val is
  28376. negative.)
  28377. @param val value to be OR'ed with this BigInteger.
  28378. @return {@code this | val}
  28379. </member>
  28380. <member name="M:NPOI.Util.BigInteger.Multiply(System.Int64)">
  28381. Package private methods used by BigDecimal code to multiply a BigInteger
  28382. with a long. Assumes v is not equal to INFLATED.
  28383. </member>
  28384. <member name="M:NPOI.Util.BigInteger.Multiply(NPOI.Util.BigInteger)">
  28385. Returns a BigInteger whose value is {@code (this * val)}.
  28386. @param val value to be multiplied by this BigInteger.
  28387. @return {@code this * val}
  28388. </member>
  28389. <member name="M:NPOI.Util.BigInteger.Add(NPOI.Util.BigInteger)">
  28390. Returns a BigInteger whose value is {@code (this + val)}.
  28391. @param val value to be added to this BigInteger.
  28392. @return {@code this + val}
  28393. </member>
  28394. <member name="M:NPOI.Util.BigInteger.add(System.Int32[],System.Int32[])">
  28395. Adds the contents of the int arrays x and y. This method allocates
  28396. a new int array to hold the answer and returns a reference to that
  28397. array.
  28398. </member>
  28399. <member name="M:NPOI.Util.BigInteger.Subtract(NPOI.Util.BigInteger)">
  28400. Returns a BigInteger whose value is {@code (this - val)}.
  28401. @param val value to be subtracted from this BigInteger.
  28402. @return {@code this - val}
  28403. </member>
  28404. <member name="M:NPOI.Util.BigInteger.Subtract(System.Int32[],System.Int32[])">
  28405. Subtracts the contents of the second int arrays (little) from the
  28406. first (big). The first int array (big) must represent a larger number
  28407. than the second. This method allocates the space necessary to hold the
  28408. answer.
  28409. </member>
  28410. <member name="M:NPOI.Util.BigInteger.Divide(NPOI.Util.BigInteger)">
  28411. Returns a BigInteger whose value is {@code (this / val)}.
  28412. @param val value by which this BigInteger is to be divided.
  28413. @return {@code this / val}
  28414. @throws ArithmeticException if {@code val} is zero.
  28415. </member>
  28416. <member name="F:NPOI.Util.MutableBigInteger._value">
  28417. Holds the magnitude of this MutableBigInteger in big endian order.
  28418. The magnitude may start at an offset into the value array, and it may
  28419. end before the length of the value array.
  28420. </member>
  28421. <member name="F:NPOI.Util.MutableBigInteger.intLen">
  28422. The number of ints of the value array that are currently used
  28423. to hold the magnitude of this MutableBigInteger. The magnitude starts
  28424. at an offset and offset + intLen may be less than value.Length.
  28425. </member>
  28426. <member name="F:NPOI.Util.MutableBigInteger.offset">
  28427. The offset into the value array where the magnitude of this
  28428. MutableBigInteger begins.
  28429. </member>
  28430. <member name="F:NPOI.Util.MutableBigInteger.One">
  28431. MutableBigInteger with one element value array with the value 1. Used by
  28432. BigDecimal divideAndRound to increment the quotient. Use this constant
  28433. only when the method is not going to modify this object.
  28434. </member>
  28435. <member name="M:NPOI.Util.MutableBigInteger.#ctor">
  28436. The default constructor. An empty MutableBigInteger is created with
  28437. a one word capacity.
  28438. </member>
  28439. <member name="M:NPOI.Util.MutableBigInteger.#ctor(System.Int32)">
  28440. Construct a new MutableBigInteger with a magnitude specified by
  28441. the int val.
  28442. </member>
  28443. <member name="M:NPOI.Util.MutableBigInteger.#ctor(System.Int32[])">
  28444. Construct a new MutableBigInteger with the specified value array
  28445. up to the length of the array supplied.
  28446. </member>
  28447. <member name="M:NPOI.Util.MutableBigInteger.#ctor(NPOI.Util.BigInteger)">
  28448. Construct a new MutableBigInteger with a magnitude equal to the
  28449. specified BigInteger.
  28450. </member>
  28451. <member name="M:NPOI.Util.MutableBigInteger.#ctor(NPOI.Util.MutableBigInteger)">
  28452. Construct a new MutableBigInteger with a magnitude equal to the
  28453. specified MutableBigInteger.
  28454. </member>
  28455. <member name="M:NPOI.Util.MutableBigInteger.getMagnitudeArray">
  28456. Internal helper method to return the magnitude array. The caller is not
  28457. supposed to modify the returned array.
  28458. </member>
  28459. <member name="M:NPOI.Util.MutableBigInteger.toLong">
  28460. Convert this MutableBigInteger to a long value. The caller has to make
  28461. sure this MutableBigInteger can be fit into long.
  28462. </member>
  28463. <member name="M:NPOI.Util.MutableBigInteger.toBigInteger(System.Int32)">
  28464. Convert this MutableBigInteger to a BigInteger object.
  28465. </member>
  28466. <member name="M:NPOI.Util.MutableBigInteger.clear">
  28467. Clear out a MutableBigInteger for reuse.
  28468. </member>
  28469. <member name="M:NPOI.Util.MutableBigInteger.reset">
  28470. Set a MutableBigInteger to zero, removing its offset.
  28471. </member>
  28472. <member name="M:NPOI.Util.MutableBigInteger.compare(NPOI.Util.MutableBigInteger)">
  28473. Compare the magnitude of two MutableBigIntegers. Returns -1, 0 or 1
  28474. as this MutableBigInteger is numerically less than, equal to, or
  28475. greater than <c>b</c>.
  28476. </member>
  28477. <member name="M:NPOI.Util.MutableBigInteger.compareHalf(NPOI.Util.MutableBigInteger)">
  28478. Compare this against half of a MutableBigInteger object (Needed for
  28479. remainder tests).
  28480. Assumes no leading unnecessary zeros, which holds for results
  28481. from divide().
  28482. </member>
  28483. <member name="M:NPOI.Util.MutableBigInteger.getLowestSetBit">
  28484. Return the index of the lowest set bit in this MutableBigInteger. If the
  28485. magnitude of this MutableBigInteger is zero, -1 is returned.
  28486. </member>
  28487. <member name="M:NPOI.Util.MutableBigInteger.getInt(System.Int32)">
  28488. Return the int in use in this MutableBigInteger at the specified
  28489. index. This method is not used because it is not inlined on all
  28490. platforms.
  28491. </member>
  28492. <member name="M:NPOI.Util.MutableBigInteger.getLong(System.Int32)">
  28493. Return a long which is equal to the unsigned value of the int in
  28494. use in this MutableBigInteger at the specified index. This method is
  28495. not used because it is not inlined on all platforms.
  28496. </member>
  28497. <member name="M:NPOI.Util.MutableBigInteger.normalize">
  28498. Ensure that the MutableBigInteger is in normal form, specifically
  28499. making sure that there are no leading zeros, and that if the
  28500. magnitude is zero, then intLen is zero.
  28501. </member>
  28502. <member name="M:NPOI.Util.MutableBigInteger.ensureCapacity(System.Int32)">
  28503. If this MutableBigInteger cannot hold len words, increase the size
  28504. of the value array to len words.
  28505. </member>
  28506. <member name="M:NPOI.Util.MutableBigInteger.toIntArray">
  28507. Convert this MutableBigInteger into an int array with no leading
  28508. zeros, of a length that is equal to this MutableBigInteger's intLen.
  28509. </member>
  28510. <member name="M:NPOI.Util.MutableBigInteger.setInt(System.Int32,System.Int32)">
  28511. Sets the int at index+offset in this MutableBigInteger to val.
  28512. This does not get inlined on all platforms so it is not used
  28513. as often as originally intended.
  28514. </member>
  28515. <member name="M:NPOI.Util.MutableBigInteger.setValue(System.Int32[],System.Int32)">
  28516. Sets this MutableBigInteger's value array to the specified array.
  28517. The intLen is set to the specified length.
  28518. </member>
  28519. <member name="M:NPOI.Util.MutableBigInteger.copyValue(NPOI.Util.MutableBigInteger)">
  28520. Sets this MutableBigInteger's value array to a copy of the specified
  28521. array. The intLen is set to the length of the new array.
  28522. </member>
  28523. <member name="M:NPOI.Util.MutableBigInteger.copyValue(System.Int32[])">
  28524. Sets this MutableBigInteger's value array to a copy of the specified
  28525. array. The intLen is set to the length of the specified array.
  28526. </member>
  28527. <member name="M:NPOI.Util.MutableBigInteger.isOne">
  28528. Returns true iff this MutableBigInteger has a value of one.
  28529. </member>
  28530. <member name="M:NPOI.Util.MutableBigInteger.isZero">
  28531. Returns true iff this MutableBigInteger has a value of zero.
  28532. </member>
  28533. <member name="M:NPOI.Util.MutableBigInteger.isEven">
  28534. Returns true iff this MutableBigInteger is even.
  28535. </member>
  28536. <member name="M:NPOI.Util.MutableBigInteger.isOdd">
  28537. Returns true iff this MutableBigInteger is odd.
  28538. </member>
  28539. <member name="M:NPOI.Util.MutableBigInteger.isNormal">
  28540. Returns true iff this MutableBigInteger is in normal form. A
  28541. MutableBigInteger is in normal form if it has no leading zeros
  28542. after the offset, and intLen + offset &lt;= value.Length.
  28543. </member>
  28544. <member name="M:NPOI.Util.MutableBigInteger.toString">
  28545. Returns a String representation of this MutableBigInteger in radix 10.
  28546. </member>
  28547. <member name="M:NPOI.Util.MutableBigInteger.rightShift(System.Int32)">
  28548. Right shift this MutableBigInteger n bits. The MutableBigInteger is left
  28549. in normal form.
  28550. </member>
  28551. <member name="M:NPOI.Util.MutableBigInteger.leftShift(System.Int32)">
  28552. Left shift this MutableBigInteger n bits.
  28553. </member>
  28554. <member name="M:NPOI.Util.MutableBigInteger.divadd(System.Int32[],System.Int32[],System.Int32)">
  28555. A primitive used for division. This method adds in one multiple of the
  28556. divisor a back to the dividend result at a specified offset. It is used
  28557. when qhat was estimated too large, and must be adjusted.
  28558. </member>
  28559. <member name="M:NPOI.Util.MutableBigInteger.mulsub(System.Int32[],System.Int32[],System.Int32,System.Int32,System.Int32)">
  28560. This method is used for division. It multiplies an n word input a by one
  28561. word input x, and subtracts the n word product from q. This is needed
  28562. when subtracting qhat*divisor from dividend.
  28563. </member>
  28564. <member name="M:NPOI.Util.MutableBigInteger.primitiveRightShift(System.Int32)">
  28565. Right shift this MutableBigInteger n bits, where n is
  28566. less than 32.
  28567. Assumes that intLen > 0, n > 0 for speed
  28568. </member>
  28569. <member name="M:NPOI.Util.MutableBigInteger.primitiveLeftShift(System.Int32)">
  28570. Left shift this MutableBigInteger n bits, where n is
  28571. less than 32.
  28572. Assumes that intLen > 0, n > 0 for speed
  28573. </member>
  28574. <member name="M:NPOI.Util.MutableBigInteger.add(NPOI.Util.MutableBigInteger)">
  28575. Adds the contents of two MutableBigInteger objects.The result
  28576. is placed within this MutableBigInteger.
  28577. The contents of the addend are not changed.
  28578. </member>
  28579. <member name="M:NPOI.Util.MutableBigInteger.subtract(NPOI.Util.MutableBigInteger)">
  28580. Subtracts the smaller of this and b from the larger and places the
  28581. result into this MutableBigInteger.
  28582. </member>
  28583. <member name="M:NPOI.Util.MutableBigInteger.difference(NPOI.Util.MutableBigInteger)">
  28584. Subtracts the smaller of a and b from the larger and places the result
  28585. into the larger. Returns 1 if the answer is in a, -1 if in b, 0 if no
  28586. operation was performed.
  28587. </member>
  28588. <member name="M:NPOI.Util.MutableBigInteger.multiply(NPOI.Util.MutableBigInteger,NPOI.Util.MutableBigInteger)">
  28589. Multiply the contents of two MutableBigInteger objects. The result is
  28590. placed into MutableBigInteger z. The contents of y are not changed.
  28591. </member>
  28592. <member name="M:NPOI.Util.MutableBigInteger.mul(System.Int32,NPOI.Util.MutableBigInteger)">
  28593. Multiply the contents of this MutableBigInteger by the word y. The
  28594. result is placed into z.
  28595. </member>
  28596. <member name="M:NPOI.Util.MutableBigInteger.divideOneWord(System.Int32,NPOI.Util.MutableBigInteger)">
  28597. This method is used for division of an n word dividend by a one word
  28598. divisor. The quotient is placed into quotient. The one word divisor is
  28599. specified by divisor.
  28600. @return the remainder of the division is returned.
  28601. </member>
  28602. <member name="M:NPOI.Util.MutableBigInteger.divide(NPOI.Util.MutableBigInteger,NPOI.Util.MutableBigInteger)">
  28603. Calculates the quotient of this div b and places the quotient in the
  28604. provided MutableBigInteger objects and the remainder object is returned.
  28605. Uses Algorithm D in Knuth section 4.3.1.
  28606. Many optimizations to that algorithm have been adapted from the Colin
  28607. Plumb C library.
  28608. It special cases one word divisors for speed. The content of b is not
  28609. changed.
  28610. </member>
  28611. <member name="M:NPOI.Util.MutableBigInteger.divide(System.Int64,NPOI.Util.MutableBigInteger)">
  28612. Internally used to calculate the quotient of this div v and places the
  28613. quotient in the provided MutableBigInteger object and the remainder is
  28614. returned.
  28615. @return the remainder of the division will be returned.
  28616. </member>
  28617. <member name="M:NPOI.Util.MutableBigInteger.divideMagnitude(System.Int32[],NPOI.Util.MutableBigInteger)">
  28618. Divide this MutableBigInteger by the divisor represented by its magnitude
  28619. array. The quotient will be placed into the provided quotient object &amp;
  28620. the remainder object is returned.
  28621. </member>
  28622. <member name="M:NPOI.Util.MutableBigInteger.unsignedLongCompare(System.Int64,System.Int64)">
  28623. Compare two longs as if they were unsigned.
  28624. Returns true iff one is bigger than two.
  28625. </member>
  28626. <member name="M:NPOI.Util.MutableBigInteger.divWord(System.Int32[],System.Int64,System.Int32)">
  28627. This method divides a long quantity by an int to estimate
  28628. qhat for two multi precision numbers. It is used when
  28629. the signed value of n is less than zero.
  28630. </member>
  28631. <member name="M:NPOI.Util.MutableBigInteger.hybridGCD(NPOI.Util.MutableBigInteger)">
  28632. Calculate GCD of this and b. This and b are changed by the computation.
  28633. </member>
  28634. <member name="M:NPOI.Util.MutableBigInteger.binaryGCD(NPOI.Util.MutableBigInteger)">
  28635. Calculate GCD of this and v.
  28636. Assumes that this and v are not zero.
  28637. </member>
  28638. <member name="M:NPOI.Util.MutableBigInteger.binaryGcd(System.Int32,System.Int32)">
  28639. Calculate GCD of a and b interpreted as unsigned integers.
  28640. </member>
  28641. <member name="M:NPOI.Util.MutableBigInteger.mutableModInverse(NPOI.Util.MutableBigInteger)">
  28642. Returns the modInverse of this mod p. This and p are not affected by
  28643. the operation.
  28644. </member>
  28645. <member name="M:NPOI.Util.MutableBigInteger.modInverse(NPOI.Util.MutableBigInteger)">
  28646. Calculate the multiplicative inverse of this mod mod, where mod is odd.
  28647. This and mod are not changed by the calculation.
  28648. This method implements an algorithm due to Richard Schroeppel, that uses
  28649. the same intermediate representation as Montgomery Reduction
  28650. ("Montgomery Form"). The algorithm is described in an unpublished
  28651. manuscript entitled "Fast Modular Reciprocals."
  28652. </member>
  28653. <member name="M:NPOI.Util.MutableBigInteger.euclidModInverse(System.Int32)">
  28654. Uses the extended Euclidean algorithm to compute the modInverse of base
  28655. mod a modulus that is a power of 2. The modulus is 2^k.
  28656. </member>
  28657. <member name="T:NPOI.Util.BitField">
  28658. <summary>
  28659. Manage operations dealing with bit-mapped fields.
  28660. @author Marc Johnson (mjohnson at apache dot org)
  28661. @author Andrew C. Oliver (acoliver at apache dot org)
  28662. </summary>
  28663. </member>
  28664. <member name="M:NPOI.Util.BitField.#ctor(System.Int32)">
  28665. <summary>
  28666. Create a <see cref="T:NPOI.Util.BitField"/> instance
  28667. </summary>
  28668. <param name="mask">
  28669. the mask specifying which bits apply to this
  28670. BitField. Bits that are set in this mask are the
  28671. bits that this BitField operates on
  28672. </param>
  28673. </member>
  28674. <member name="M:NPOI.Util.BitField.#ctor(System.UInt32)">
  28675. <summary>
  28676. Create a <see cref="T:NPOI.Util.BitField"/> instance
  28677. </summary>
  28678. <param name="mask">
  28679. the mask specifying which bits apply to this
  28680. BitField. Bits that are set in this mask are the
  28681. bits that this BitField operates on
  28682. </param>
  28683. </member>
  28684. <member name="M:NPOI.Util.BitField.Clear(System.Int32)">
  28685. <summary>
  28686. Clear the bits.
  28687. </summary>
  28688. <param name="holder">the int data containing the bits we're interested in</param>
  28689. <returns>the value of holder with the specified bits cleared (set to 0)</returns>
  28690. </member>
  28691. <member name="M:NPOI.Util.BitField.ClearShort(System.Int16)">
  28692. <summary>
  28693. Clear the bits.
  28694. </summary>
  28695. <param name="holder">the short data containing the bits we're interested in</param>
  28696. <returns>the value of holder with the specified bits cleared (set to 0)</returns>
  28697. </member>
  28698. <member name="M:NPOI.Util.BitField.GetRawValue(System.Int32)">
  28699. <summary>
  28700. Obtain the value for the specified BitField, appropriately
  28701. shifted right. Many users of a BitField will want to treat the
  28702. specified bits as an int value, and will not want to be aware
  28703. that the value is stored as a BitField (and so shifted left so
  28704. many bits)
  28705. </summary>
  28706. <param name="holder">the int data containing the bits we're interested in</param>
  28707. <returns>the selected bits, shifted right appropriately</returns>
  28708. </member>
  28709. <member name="M:NPOI.Util.BitField.GetShortRawValue(System.Int16)">
  28710. <summary>
  28711. Obtain the value for the specified BitField, unshifted
  28712. </summary>
  28713. <param name="holder">the short data containing the bits we're interested in</param>
  28714. <returns>the selected bits</returns>
  28715. </member>
  28716. <member name="M:NPOI.Util.BitField.GetShortValue(System.Int16)">
  28717. <summary>
  28718. Obtain the value for the specified BitField, appropriately
  28719. shifted right, as a short. Many users of a BitField will want
  28720. to treat the specified bits as an int value, and will not want
  28721. to be aware that the value is stored as a BitField (and so
  28722. shifted left so many bits)
  28723. </summary>
  28724. <param name="holder">the short data containing the bits we're interested in</param>
  28725. <returns>the selected bits, shifted right appropriately</returns>
  28726. </member>
  28727. <member name="M:NPOI.Util.BitField.GetValue(System.Int32)">
  28728. <summary>
  28729. Obtain the value for the specified BitField, appropriately
  28730. shifted right. Many users of a BitField will want to treat the
  28731. specified bits as an int value, and will not want to be aware
  28732. that the value is stored as a BitField (and so shifted left so
  28733. many bits)
  28734. </summary>
  28735. <param name="holder">the int data containing the bits we're interested in</param>
  28736. <returns>the selected bits, shifted right appropriately</returns>
  28737. </member>
  28738. <member name="M:NPOI.Util.BitField.IsAllSet(System.Int32)">
  28739. <summary>
  28740. Are all of the bits set or not? This is a stricter test than
  28741. isSet, in that all of the bits in a multi-bit set must be set
  28742. for this method to return true
  28743. </summary>
  28744. <param name="holder">the int data containing the bits we're interested in</param>
  28745. <returns>
  28746. <c>true</c> if all of the bits are set otherwise, <c>false</c>.
  28747. </returns>
  28748. </member>
  28749. <member name="M:NPOI.Util.BitField.IsSet(System.Int32)">
  28750. <summary>
  28751. is the field set or not? This is most commonly used for a
  28752. single-bit field, which is often used to represent a boolean
  28753. value; the results of using it for a multi-bit field is to
  28754. determine whether *any* of its bits are set
  28755. </summary>
  28756. <param name="holder">the int data containing the bits we're interested in</param>
  28757. <returns>
  28758. <c>true</c> if any of the bits are set; otherwise, <c>false</c>.
  28759. </returns>
  28760. </member>
  28761. <member name="M:NPOI.Util.BitField.Set(System.Int32)">
  28762. <summary>
  28763. Set the bits.
  28764. </summary>
  28765. <param name="holder">the int data containing the bits we're interested in</param>
  28766. <returns>the value of holder with the specified bits set to 1</returns>
  28767. </member>
  28768. <member name="M:NPOI.Util.BitField.SetBoolean(System.Int32,System.Boolean)">
  28769. <summary>
  28770. Set a boolean BitField
  28771. </summary>
  28772. <param name="holder">the int data containing the bits we're interested in</param>
  28773. <param name="flag">indicating whether to set or clear the bits</param>
  28774. <returns>the value of holder with the specified bits set or cleared</returns>
  28775. </member>
  28776. <member name="M:NPOI.Util.BitField.SetShort(System.Int16)">
  28777. <summary>
  28778. Set the bits.
  28779. </summary>
  28780. <param name="holder">the short data containing the bits we're interested in</param>
  28781. <returns>the value of holder with the specified bits set to 1</returns>
  28782. </member>
  28783. <member name="M:NPOI.Util.BitField.SetShortBoolean(System.Int16,System.Boolean)">
  28784. <summary>
  28785. Set a boolean BitField
  28786. </summary>
  28787. <param name="holder">the short data containing the bits we're interested in</param>
  28788. <param name="flag">indicating whether to set or clear the bits</param>
  28789. <returns>the value of holder with the specified bits set or cleared</returns>
  28790. </member>
  28791. <member name="M:NPOI.Util.BitField.SetShortValue(System.Int16,System.Int16)">
  28792. <summary>
  28793. Obtain the value for the specified BitField, appropriately
  28794. shifted right, as a short. Many users of a BitField will want
  28795. to treat the specified bits as an int value, and will not want
  28796. to be aware that the value is stored as a BitField (and so
  28797. shifted left so many bits)
  28798. </summary>
  28799. <param name="holder">the short data containing the bits we're interested in</param>
  28800. <param name="value">the new value for the specified bits</param>
  28801. <returns>the selected bits, shifted right appropriately</returns>
  28802. </member>
  28803. <member name="M:NPOI.Util.BitField.SetValue(System.Int32,System.Int32)">
  28804. <summary>
  28805. Sets the value.
  28806. </summary>
  28807. <param name="holder">the byte data containing the bits we're interested in</param>
  28808. <param name="value">The value.</param>
  28809. <returns></returns>
  28810. </member>
  28811. <member name="M:NPOI.Util.BitField.SetByteBoolean(System.Byte,System.Boolean)">
  28812. <summary>
  28813. Set a boolean BitField
  28814. </summary>
  28815. <param name="holder"> the byte data containing the bits we're interested in</param>
  28816. <param name="flag">indicating whether to set or clear the bits</param>
  28817. <returns>the value of holder with the specified bits set or cleared</returns>
  28818. </member>
  28819. <member name="M:NPOI.Util.BitField.ClearByte(System.Byte)">
  28820. <summary>
  28821. Clears the bits.
  28822. </summary>
  28823. <param name="holder">the byte data containing the bits we're interested in</param>
  28824. <returns>the value of holder with the specified bits cleared</returns>
  28825. </member>
  28826. <member name="M:NPOI.Util.BitField.SetByte(System.Byte)">
  28827. <summary>
  28828. Set the bits.
  28829. </summary>
  28830. <param name="holder">the byte data containing the bits we're interested in</param>
  28831. <returns>the value of holder with the specified bits set to 1</returns>
  28832. </member>
  28833. <member name="T:NPOI.Util.BitFieldFactory">
  28834. <summary>
  28835. Returns immutable Btfield instances.
  28836. @author Jason Height (jheight at apache dot org)
  28837. </summary>
  28838. </member>
  28839. <member name="M:NPOI.Util.BitFieldFactory.GetInstance(System.Int32)">
  28840. <summary>
  28841. Gets the instance.
  28842. </summary>
  28843. <param name="mask">The mask.</param>
  28844. <returns></returns>
  28845. </member>
  28846. <member name="T:NPOI.Util.BlockingInputStream">
  28847. Implementation of a BlockingInputStream to provide data to
  28848. RawDataBlock that expects data in 512 byte chunks. Useful to read
  28849. data from slow (ie, non FileInputStream) sources, for example when
  28850. Reading an OLE2 Document over a network.
  28851. Possible extentions: add a timeout. Curently a call to Read(byte[]) on this
  28852. class is blocking, so use at your own peril if your underlying stream blocks.
  28853. @author Jens Gerhard
  28854. @author aviks - documentation cleanups.
  28855. </member>
  28856. <member name="M:NPOI.Util.BlockingInputStream.Read(System.Byte[])">
  28857. We had to revert to byte per byte Reading to keep
  28858. with slow network connections on one hand, without
  28859. missing the end-of-file.
  28860. This is the only method that does its own thing in this class
  28861. everything else is delegated to aggregated stream.
  28862. THIS IS A BLOCKING BLOCK READ!!!
  28863. </member>
  28864. <member name="M:NPOI.Util.BoundedInputStream.#ctor(NPOI.Util.ByteArrayInputStream,System.Int64)">
  28865. <summary>
  28866. Creates a new <c>BoundedInputStream</c> that wraps the given input
  28867. stream and limits it to a certain size.
  28868. </summary>
  28869. <param name="in1">The wrapped input stream</param>
  28870. <param name="size">The maximum number of bytes to return</param>
  28871. </member>
  28872. <member name="M:NPOI.Util.BoundedInputStream.#ctor(NPOI.Util.ByteArrayInputStream)">
  28873. <summary>
  28874. Creates a new <c>BoundedInputStream</c> that wraps the given input
  28875. stream and is unlimited.
  28876. </summary>
  28877. <param name="in1">The wrapped input stream</param>
  28878. </member>
  28879. <member name="M:NPOI.Util.BoundedInputStream.Read">
  28880. <summary>
  28881. Invokes the delegate's <code>read()</code> method if
  28882. the current position is less than the limit.
  28883. </summary>
  28884. <returns>the byte read or -1 if the end of stream
  28885. or the limit has been reached.</returns>
  28886. <exception cref="T:System.IO.IOException">if an I/O error occurs</exception>
  28887. </member>
  28888. <member name="M:NPOI.Util.ByteBuffer.Remaining">
  28889. <summary>
  28890. Returns the number of elements between the current position and the limit.
  28891. </summary>
  28892. <returns>The number of elements remaining in this buffer</returns>
  28893. </member>
  28894. <member name="M:NPOI.Util.ByteBuffer.HasRemaining">
  28895. <summary>
  28896. Tells whether there are any elements between the current position and the limit.
  28897. </summary>
  28898. <returns>true if, and only if, there is at least one element remaining in this buffer</returns>
  28899. </member>
  28900. <member name="T:NPOI.Util.ByteField">
  28901. <summary>
  28902. representation of a byte (8-bit) field at a fixed location within a
  28903. byte array
  28904. @author Marc Johnson (mjohnson at apache dot org
  28905. </summary>
  28906. </member>
  28907. <member name="M:NPOI.Util.ByteField.#ctor(System.Int32)">
  28908. <summary>
  28909. Initializes a new instance of the <see cref="T:NPOI.Util.ByteField"/> class.
  28910. </summary>
  28911. <param name="offset">The offset.</param>
  28912. </member>
  28913. <member name="M:NPOI.Util.ByteField.#ctor(System.Int32,System.Byte)">
  28914. <summary>
  28915. Initializes a new instance of the <see cref="T:NPOI.Util.ByteField"/> class.
  28916. </summary>
  28917. <param name="offset">The offset.</param>
  28918. <param name="value">The value.</param>
  28919. </member>
  28920. <member name="M:NPOI.Util.ByteField.#ctor(System.Int32,System.Byte[])">
  28921. <summary>
  28922. Initializes a new instance of the <see cref="T:NPOI.Util.ByteField"/> class.
  28923. </summary>
  28924. <param name="offset">The offset.</param>
  28925. <param name="data">The data.</param>
  28926. </member>
  28927. <member name="M:NPOI.Util.ByteField.#ctor(System.Int32,System.Byte,System.Byte[])">
  28928. <summary>
  28929. Initializes a new instance of the <see cref="T:NPOI.Util.ByteField"/> class.
  28930. </summary>
  28931. <param name="offset">The offset.</param>
  28932. <param name="_value">The _value.</param>
  28933. <param name="data">The data.</param>
  28934. </member>
  28935. <member name="P:NPOI.Util.ByteField.Value">
  28936. <summary>
  28937. Gets or sets the value.
  28938. </summary>
  28939. <value>The value.</value>
  28940. </member>
  28941. <member name="M:NPOI.Util.ByteField.ReadFromBytes(System.Byte[])">
  28942. <summary>
  28943. set the value from its offset into an array of bytes
  28944. </summary>
  28945. <param name="data">the byte array from which the value is to be read</param>
  28946. </member>
  28947. <member name="M:NPOI.Util.ByteField.ReadFromStream(System.IO.Stream)">
  28948. <summary>
  28949. set the value from an Stream
  28950. </summary>
  28951. <param name="stream">the Stream from which the value is to be read</param>
  28952. </member>
  28953. <member name="M:NPOI.Util.ByteField.Set(System.Byte,System.Byte[])">
  28954. <summary>
  28955. set the ByteField's current value and write it to a byte array
  28956. </summary>
  28957. <param name="value">value to be set</param>
  28958. <param name="data">the byte array to write the value to</param>
  28959. </member>
  28960. <member name="M:NPOI.Util.ByteField.ToString">
  28961. <summary>
  28962. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  28963. </summary>
  28964. <returns>
  28965. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  28966. </returns>
  28967. </member>
  28968. <member name="M:NPOI.Util.ByteField.WriteToBytes(System.Byte[])">
  28969. <summary>
  28970. write the value out to an array of bytes at the appropriate offset
  28971. </summary>
  28972. <param name="data">the array of bytes to which the value is to be written</param>
  28973. </member>
  28974. <member name="T:NPOI.Util.ClassID">
  28975. <summary>
  28976. Represents a class ID (16 bytes). Unlike other little-endian
  28977. type the {@link ClassID} is not just 16 bytes stored in the wrong
  28978. order. Instead, it is a double word (4 bytes) followed by two
  28979. words (2 bytes each) followed by 8 bytes.
  28980. @author Rainer Klute
  28981. <a href="mailto:klute@rainer-klute.de">klute@rainer-klute.de</a>
  28982. @version $Id: ClassID.java 489730 2006-12-22 19:18:16Z bayard $
  28983. @since 2002-02-09
  28984. </summary>
  28985. </member>
  28986. <member name="F:NPOI.Util.ClassID.bytes">
  28987. The bytes making out the class ID in correct order,
  28988. i.e. big-endian.
  28989. </member>
  28990. <member name="M:NPOI.Util.ClassID.#ctor(System.Byte[],System.Int32)">
  28991. <summary>
  28992. Creates a <see cref="T:NPOI.Util.ClassID"/> and Reads its value from a byte array.
  28993. </summary>
  28994. <param name="src">The byte array to Read from.</param>
  28995. <param name="offset">The offset of the first byte to Read.</param>
  28996. </member>
  28997. <member name="M:NPOI.Util.ClassID.#ctor">
  28998. <summary>
  28999. Creates a <see cref="T:NPOI.Util.ClassID"/> and initializes its value with 0x00 bytes.
  29000. </summary>
  29001. </member>
  29002. <member name="M:NPOI.Util.ClassID.#ctor(System.String)">
  29003. <p>Creates a {@link ClassID} from a human-readable representation of the Class ID in standard
  29004. format <code>"{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}"</code>.</p>
  29005. @param externalForm representation of the Class ID represented by this object.
  29006. </member>
  29007. <member name="F:NPOI.Util.ClassID.LENGTH">
  29008. The number of bytes occupied by this object in the byte
  29009. stream.
  29010. </member>
  29011. <member name="P:NPOI.Util.ClassID.Length">
  29012. <summary>
  29013. Gets the length.
  29014. </summary>
  29015. <value>The number of bytes occupied by this object in the byte stream.</value>
  29016. </member>
  29017. <member name="P:NPOI.Util.ClassID.Bytes">
  29018. <summary>
  29019. Gets or sets the bytes making out the class ID. They are returned in correct order, i.e. big-endian.
  29020. </summary>
  29021. <value>the bytes making out the class ID..</value>
  29022. </member>
  29023. <member name="M:NPOI.Util.ClassID.Read(System.Byte[],System.Int32)">
  29024. <summary>
  29025. Reads the class ID's value from a byte array by turning little-endian into big-endian.
  29026. </summary>
  29027. <param name="src">The byte array to Read from</param>
  29028. <param name="offset">The offset within the </param>
  29029. <returns>A byte array containing the class ID.</returns>
  29030. </member>
  29031. <member name="M:NPOI.Util.ClassID.Write(System.Byte[],System.Int32)">
  29032. <summary>
  29033. Writes the class ID to a byte array in the little-endian format.
  29034. </summary>
  29035. <param name="dst">The byte array to Write to.</param>
  29036. <param name="offset">The offset within the </param>
  29037. </member>
  29038. <member name="M:NPOI.Util.ClassID.Equals(System.Object)">
  29039. <summary>
  29040. Checks whether this ClassID is equal to another
  29041. object.
  29042. </summary>
  29043. <param name="o">the object to compare this PropertySet with</param>
  29044. <returns>true if the objects are equal, else
  29045. false</returns>
  29046. </member>
  29047. <member name="M:NPOI.Util.ClassID.GetHashCode">
  29048. <summary>
  29049. Serves as a hash function for a particular type.
  29050. </summary>
  29051. <returns>
  29052. A hash code for the current <see cref="T:System.Object"/>.
  29053. </returns>
  29054. </member>
  29055. <member name="M:NPOI.Util.ClassID.ToString">
  29056. <summary>
  29057. Returns a human-Readable representation of the Class ID in standard
  29058. format <c>"{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}"</c>.
  29059. </summary>
  29060. <returns>
  29061. A String representation of the Class ID represented by this object..
  29062. </returns>
  29063. </member>
  29064. <member name="T:NPOI.Util.CodePageUtil">
  29065. Utilities for working with Microsoft CodePages.
  29066. <p>Provides constants for understanding numeric codepages,
  29067. along with utilities to translate these into Java Character Sets.</p>
  29068. </member>
  29069. <member name="F:NPOI.Util.CodePageUtil.CP_037">
  29070. <p>Codepage 037, a special case</p>
  29071. </member>
  29072. <member name="F:NPOI.Util.CodePageUtil.CP_SJIS">
  29073. <p>Codepage for SJIS</p>
  29074. </member>
  29075. <member name="F:NPOI.Util.CodePageUtil.CP_GBK">
  29076. <p>Codepage for GBK, aka MS936</p>
  29077. </member>
  29078. <member name="F:NPOI.Util.CodePageUtil.CP_MS949">
  29079. <p>Codepage for MS949</p>
  29080. </member>
  29081. <member name="F:NPOI.Util.CodePageUtil.CP_UTF16">
  29082. <p>Codepage for UTF-16</p>
  29083. </member>
  29084. <member name="F:NPOI.Util.CodePageUtil.CP_UTF16_BE">
  29085. <p>Codepage for UTF-16 big-endian</p>
  29086. </member>
  29087. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1250">
  29088. <p>Codepage for Windows 1250</p>
  29089. </member>
  29090. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1251">
  29091. <p>Codepage for Windows 1251</p>
  29092. </member>
  29093. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1252">
  29094. <p>Codepage for Windows 1252</p>
  29095. </member>
  29096. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1253">
  29097. <p>Codepage for Windows 1253</p>
  29098. </member>
  29099. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1254">
  29100. <p>Codepage for Windows 1254</p>
  29101. </member>
  29102. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1255">
  29103. <p>Codepage for Windows 1255</p>
  29104. </member>
  29105. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1256">
  29106. <p>Codepage for Windows 1256</p>
  29107. </member>
  29108. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1257">
  29109. <p>Codepage for Windows 1257</p>
  29110. </member>
  29111. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1258">
  29112. <p>Codepage for Windows 1258</p>
  29113. </member>
  29114. <member name="F:NPOI.Util.CodePageUtil.CP_JOHAB">
  29115. <p>Codepage for Johab</p>
  29116. </member>
  29117. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_ROMAN">
  29118. <p>Codepage for Macintosh Roman (Java: MacRoman)</p>
  29119. </member>
  29120. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_JAPAN">
  29121. <p>Codepage for Macintosh Japan (Java: unknown - use SJIS, cp942 or
  29122. cp943)</p>
  29123. </member>
  29124. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_CHINESE_TRADITIONAL">
  29125. <p>Codepage for Macintosh Chinese Traditional (Java: unknown - use Big5,
  29126. MS950, or cp937)</p>
  29127. </member>
  29128. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_KOREAN">
  29129. <p>Codepage for Macintosh Korean (Java: unknown - use EUC_KR or
  29130. cp949)</p>
  29131. </member>
  29132. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_ARABIC">
  29133. <p>Codepage for Macintosh Arabic (Java: MacArabic)</p>
  29134. </member>
  29135. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_HEBREW">
  29136. <p>Codepage for Macintosh Hebrew (Java: MacHebrew)</p>
  29137. </member>
  29138. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_GREEK">
  29139. <p>Codepage for Macintosh Greek (Java: MacGreek)</p>
  29140. </member>
  29141. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_CYRILLIC">
  29142. <p>Codepage for Macintosh Cyrillic (Java: MacCyrillic)</p>
  29143. </member>
  29144. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_CHINESE_SIMPLE">
  29145. <p>Codepage for Macintosh Chinese Simplified (Java: unknown - use
  29146. EUC_CN, ISO2022_CN_GB, MS936 or cp935)</p>
  29147. </member>
  29148. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_ROMANIA">
  29149. <p>Codepage for Macintosh Romanian (Java: MacRomania)</p>
  29150. </member>
  29151. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_UKRAINE">
  29152. <p>Codepage for Macintosh Ukrainian (Java: MacUkraine)</p>
  29153. </member>
  29154. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_THAI">
  29155. <p>Codepage for Macintosh Thai (Java: MacThai)</p>
  29156. </member>
  29157. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_CENTRAL_EUROPE">
  29158. <p>Codepage for Macintosh Central Europe (Latin-2)
  29159. (Java: MacCentralEurope)</p>
  29160. </member>
  29161. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_ICELAND">
  29162. <p>Codepage for Macintosh Iceland (Java: MacIceland)</p>
  29163. </member>
  29164. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_TURKISH">
  29165. <p>Codepage for Macintosh Turkish (Java: MacTurkish)</p>
  29166. </member>
  29167. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_CROATIAN">
  29168. <p>Codepage for Macintosh Croatian (Java: MacCroatian)</p>
  29169. </member>
  29170. <member name="F:NPOI.Util.CodePageUtil.CP_US_ACSII">
  29171. <p>Codepage for US-ASCII</p>
  29172. </member>
  29173. <member name="F:NPOI.Util.CodePageUtil.CP_KOI8_R">
  29174. <p>Codepage for KOI8-R</p>
  29175. </member>
  29176. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_1">
  29177. <p>Codepage for ISO-8859-1</p>
  29178. </member>
  29179. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_2">
  29180. <p>Codepage for ISO-8859-2</p>
  29181. </member>
  29182. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_3">
  29183. <p>Codepage for ISO-8859-3</p>
  29184. </member>
  29185. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_4">
  29186. <p>Codepage for ISO-8859-4</p>
  29187. </member>
  29188. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_5">
  29189. <p>Codepage for ISO-8859-5</p>
  29190. </member>
  29191. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_6">
  29192. <p>Codepage for ISO-8859-6</p>
  29193. </member>
  29194. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_7">
  29195. <p>Codepage for ISO-8859-7</p>
  29196. </member>
  29197. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_8">
  29198. <p>Codepage for ISO-8859-8</p>
  29199. </member>
  29200. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_9">
  29201. <p>Codepage for ISO-8859-9</p>
  29202. </member>
  29203. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_2022_JP1">
  29204. <p>Codepage for ISO-2022-JP</p>
  29205. </member>
  29206. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_2022_JP2">
  29207. <p>Another codepage for ISO-2022-JP</p>
  29208. </member>
  29209. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_2022_JP3">
  29210. <p>Yet another codepage for ISO-2022-JP</p>
  29211. </member>
  29212. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_2022_KR">
  29213. <p>Codepage for ISO-2022-KR</p>
  29214. </member>
  29215. <member name="F:NPOI.Util.CodePageUtil.CP_EUC_JP">
  29216. <p>Codepage for EUC-JP</p>
  29217. </member>
  29218. <member name="F:NPOI.Util.CodePageUtil.CP_EUC_KR">
  29219. <p>Codepage for EUC-KR</p>
  29220. </member>
  29221. <member name="F:NPOI.Util.CodePageUtil.CP_GB2312">
  29222. <p>Codepage for GB2312</p>
  29223. </member>
  29224. <member name="F:NPOI.Util.CodePageUtil.CP_GB18030">
  29225. <p>Codepage for GB18030</p>
  29226. </member>
  29227. <member name="F:NPOI.Util.CodePageUtil.CP_US_ASCII2">
  29228. <p>Another codepage for US-ASCII</p>
  29229. </member>
  29230. <member name="F:NPOI.Util.CodePageUtil.CP_UTF8">
  29231. <p>Codepage for UTF-8</p>
  29232. </member>
  29233. <member name="F:NPOI.Util.CodePageUtil.CP_UNICODE">
  29234. <p>Codepage for Unicode</p>
  29235. </member>
  29236. <member name="M:NPOI.Util.CodePageUtil.GetBytesInCodePage(System.String,System.Int32)">
  29237. Converts a string into bytes, in the equivalent character encoding
  29238. to the supplied codepage number.
  29239. @param string The string to convert
  29240. @param codepage The codepage number
  29241. </member>
  29242. <member name="M:NPOI.Util.CodePageUtil.GetStringFromCodePage(System.Byte[],System.Int32)">
  29243. Converts the bytes into a String, based on the equivalent character encoding
  29244. to the supplied codepage number.
  29245. @param string The byte of the string to convert
  29246. @param codepage The codepage number
  29247. </member>
  29248. <member name="M:NPOI.Util.CodePageUtil.GetStringFromCodePage(System.Byte[],System.Int32,System.Int32,System.Int32)">
  29249. Converts the bytes into a String, based on the equivalent character encoding
  29250. to the supplied codepage number.
  29251. @param string The byte of the string to convert
  29252. @param codepage The codepage number
  29253. </member>
  29254. <member name="M:NPOI.Util.CodePageUtil.CodepageToEncoding(System.Int32)">
  29255. <p>Turns a codepage number into the equivalent character encoding's
  29256. name.</p>
  29257. @param codepage The codepage number
  29258. @return The character encoding's name. If the codepage number is 65001,
  29259. the encoding name is "UTF-8". All other positive numbers are mapped to
  29260. "cp" followed by the number, e.g. if the codepage number is 1252 the
  29261. returned character encoding name will be "cp1252".
  29262. @exception UnsupportedEncodingException if the specified codepage is
  29263. less than zero.
  29264. </member>
  29265. <member name="T:NPOI.Util.Collections.HashSet`1">
  29266. <summary>
  29267. This class comes from Java
  29268. </summary>
  29269. </member>
  29270. <member name="M:NPOI.Util.Collections.HashSet`1.#ctor">
  29271. <summary>
  29272. Initializes a new instance of the class.
  29273. </summary>
  29274. </member>
  29275. <member name="M:NPOI.Util.Collections.HashSet`1.Add(`0)">
  29276. <summary>
  29277. Adds the specified o.
  29278. </summary>
  29279. <param name="o">The o.</param>
  29280. </member>
  29281. <member name="M:NPOI.Util.Collections.HashSet`1.Contains(`0)">
  29282. <summary>
  29283. Determines whether [contains] [the specified o].
  29284. </summary>
  29285. <param name="o">The o.</param>
  29286. <returns>
  29287. <c>true</c> if [contains] [the specified o]; otherwise, <c>false</c>.
  29288. </returns>
  29289. </member>
  29290. <member name="M:NPOI.Util.Collections.HashSet`1.CopyTo(`0[],System.Int32)">
  29291. <summary>
  29292. Copies the elements of the <see cref="T:System.Collections.ICollection"/> to an <see cref="T:System.Array"/>, starting at a particular <see cref="T:System.Array"/> index.
  29293. </summary>
  29294. <param name="array">The one-dimensional <see cref="T:System.Array"/> that is the destination of the elements copied from <see cref="T:System.Collections.ICollection"/>. The <see cref="T:System.Array"/> must have zero-based indexing.</param>
  29295. <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  29296. <exception cref="T:System.ArgumentNullException">
  29297. <paramref name="array"/> is null.
  29298. </exception>
  29299. <exception cref="T:System.ArgumentOutOfRangeException">
  29300. <paramref name="index"/> is less than zero.
  29301. </exception>
  29302. <exception cref="T:System.ArgumentException">
  29303. <paramref name="array"/> is multidimensional.
  29304. -or-
  29305. <paramref name="index"/> is equal to or greater than the length of <paramref name="array"/>.
  29306. -or-
  29307. The number of elements in the source <see cref="T:System.Collections.ICollection"/> is greater than the available space from <paramref name="index"/> to the end of the destination <paramref name="array"/>.
  29308. </exception>
  29309. <exception cref="T:System.ArgumentException">
  29310. The type of the source <see cref="T:System.Collections.ICollection"/> cannot be cast automatically to the type of the destination <paramref name="array"/>.
  29311. </exception>
  29312. </member>
  29313. <member name="P:NPOI.Util.Collections.HashSet`1.Count">
  29314. <summary>
  29315. Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  29316. </summary>
  29317. <value></value>
  29318. <returns>
  29319. The number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  29320. </returns>
  29321. </member>
  29322. <member name="M:NPOI.Util.Collections.HashSet`1.GetEnumerator">
  29323. <summary>
  29324. Returns an enumerator that iterates through a collection.
  29325. </summary>
  29326. <returns>
  29327. An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection.
  29328. </returns>
  29329. </member>
  29330. <member name="M:NPOI.Util.Collections.HashSet`1.Remove(`0)">
  29331. <summary>
  29332. Removes the specified o.
  29333. </summary>
  29334. <param name="o">The o.</param>
  29335. </member>
  29336. <member name="M:NPOI.Util.Collections.HashSet`1.Clear">
  29337. <summary>
  29338. Removes all of the elements from this set.
  29339. The set will be empty after this call returns.
  29340. </summary>
  29341. </member>
  29342. <member name="T:NPOI.Util.Collections.Properties">
  29343. <summary>
  29344. This class comes from Java
  29345. </summary>
  29346. </member>
  29347. <member name="M:NPOI.Util.Collections.Properties.#ctor">
  29348. <summary>
  29349. Initializes a new instance of the <see cref="T:NPOI.Util.Collections.Properties"/> class.
  29350. </summary>
  29351. </member>
  29352. <member name="M:NPOI.Util.Collections.Properties.Remove(System.String)">
  29353. <summary>
  29354. Removes the specified key.
  29355. </summary>
  29356. <param name="key">The key.</param>
  29357. <returns></returns>
  29358. </member>
  29359. <member name="M:NPOI.Util.Collections.Properties.GetEnumerator">
  29360. <summary>
  29361. Gets the enumerator.
  29362. </summary>
  29363. <returns></returns>
  29364. </member>
  29365. <member name="M:NPOI.Util.Collections.Properties.ContainsKey(System.String)">
  29366. <summary>
  29367. Determines whether the specified key contains key.
  29368. </summary>
  29369. <param name="key">The key.</param>
  29370. <returns>
  29371. <c>true</c> if the specified key contains key; otherwise, <c>false</c>.
  29372. </returns>
  29373. </member>
  29374. <member name="M:NPOI.Util.Collections.Properties.Add(System.String,System.String)">
  29375. <summary>
  29376. Adds the specified key.
  29377. </summary>
  29378. <param name="key">The key.</param>
  29379. <param name="value">The value.</param>
  29380. </member>
  29381. <member name="P:NPOI.Util.Collections.Properties.Count">
  29382. <summary>
  29383. Gets the count.
  29384. </summary>
  29385. <value>The count.</value>
  29386. </member>
  29387. <member name="P:NPOI.Util.Collections.Properties.Item(System.String)">
  29388. <summary>
  29389. Gets or sets the <see cref="T:System.String"/> with the specified key.
  29390. </summary>
  29391. <value></value>
  29392. </member>
  29393. <member name="P:NPOI.Util.Collections.Properties.Keys">
  29394. <summary>
  29395. Gets the keys.
  29396. </summary>
  29397. <value>The keys.</value>
  29398. </member>
  29399. <member name="M:NPOI.Util.Collections.Properties.Clear">
  29400. <summary>
  29401. Clears this instance.
  29402. </summary>
  29403. </member>
  29404. <member name="M:NPOI.Util.Collections.Properties.Load(System.IO.Stream)">
  29405. <summary>
  29406. Loads the specified in stream.
  29407. </summary>
  29408. <param name="inStream">The in stream.</param>
  29409. </member>
  29410. <member name="M:NPOI.Util.Collections.Properties.LoadConvert(System.String)">
  29411. <summary>
  29412. Loads the convert.
  29413. </summary>
  29414. <param name="theString">The string.</param>
  29415. <returns></returns>
  29416. <remarks>
  29417. Converts encoded &#92;uxxxx to unicode chars
  29418. and changes special saved chars to their original forms
  29419. </remarks>
  29420. </member>
  29421. <member name="M:NPOI.Util.Collections.Properties.ContinueLine(System.String)">
  29422. <summary>
  29423. Continues the line.
  29424. </summary>
  29425. <param name="line">The line.</param>
  29426. <returns></returns>
  29427. </member>
  29428. <member name="T:NPOI.Util.CRC32">
  29429. <summary>
  29430. CRC Verification
  29431. </summary>
  29432. </member>
  29433. <member name="M:NPOI.Util.CRC32.#ctor">
  29434. <summary>
  29435. Initializes a new instance of the <see cref="T:NPOI.Util.CRC32"/> class.
  29436. </summary>
  29437. </member>
  29438. <member name="M:NPOI.Util.CRC32.ByteCRC(System.Byte[]@)">
  29439. <summary>
  29440. CRC Bytes.
  29441. </summary>
  29442. <param name="buffer">The buffer.</param>
  29443. <returns></returns>
  29444. </member>
  29445. <member name="M:NPOI.Util.CRC32.StringCRC(System.String)">
  29446. <summary>
  29447. String CRC
  29448. </summary>
  29449. <param name="sInputString">the string</param>
  29450. <returns></returns>
  29451. </member>
  29452. <member name="M:NPOI.Util.CRC32.FileCRC(System.String)">
  29453. <summary>
  29454. File CRC
  29455. </summary>
  29456. <param name="sInputFilename">the input file</param>
  29457. <returns></returns>
  29458. </member>
  29459. <member name="M:NPOI.Util.CRC32.StreamCRC(System.IO.Stream)">
  29460. <summary>
  29461. Stream CRC
  29462. </summary>
  29463. <param name="inFile">the input stream</param>
  29464. <returns></returns>
  29465. </member>
  29466. <member name="T:NPOI.Util.IDelayableLittleEndianOutput">
  29467. <summary>
  29468. Implementors of this interface allow client code to 'delay' writing to a certain section of a
  29469. data output stream.<br/>
  29470. A typical application is for writing BIFF records when the size is not known until well after
  29471. the header has been written. The client code can call <see cref="M:NPOI.Util.IDelayableLittleEndianOutput.CreateDelayedOutput"/>
  29472. to reserve two bytes of the output for the 'ushort size' header field. The delayed output can
  29473. be written at any stage.
  29474. </summary>
  29475. <remarks>@author Josh Micich</remarks>
  29476. </member>
  29477. <member name="M:NPOI.Util.IDelayableLittleEndianOutput.CreateDelayedOutput(System.Int32)">
  29478. <summary>
  29479. Creates an output stream intended for outputting a sequence of <c>size</c> bytes.
  29480. </summary>
  29481. <param name="size"></param>
  29482. <returns></returns>
  29483. </member>
  29484. <member name="T:NPOI.Util.FixedField">
  29485. <summary>
  29486. behavior of a field at a fixed location within a byte array
  29487. @author Marc Johnson (mjohnson at apache dot org
  29488. </summary>
  29489. </member>
  29490. <member name="M:NPOI.Util.FixedField.ReadFromBytes(System.Byte[])">
  29491. <summary>
  29492. set the value from its offset into an array of bytes
  29493. </summary>
  29494. <param name="data">the byte array from which the value is to be read</param>
  29495. </member>
  29496. <member name="M:NPOI.Util.FixedField.ReadFromStream(System.IO.Stream)">
  29497. <summary>
  29498. set the value from an Stream
  29499. </summary>
  29500. <param name="stream">the Stream from which the value is to be read</param>
  29501. </member>
  29502. <member name="M:NPOI.Util.FixedField.ToString">
  29503. <summary>
  29504. return the value as a String
  29505. </summary>
  29506. <returns></returns>
  29507. </member>
  29508. <member name="M:NPOI.Util.FixedField.WriteToBytes(System.Byte[])">
  29509. <summary>
  29510. write the value out to an array of bytes at the appropriate offset
  29511. </summary>
  29512. <param name="data">the array of bytes to which the value is to be written</param>
  29513. </member>
  29514. <member name="T:NPOI.Util.HexDump">
  29515. <summary>
  29516. dump data in hexadecimal format; derived from a HexDump utility I
  29517. wrote in June 2001.
  29518. @author Marc Johnson
  29519. @author Glen Stampoultzis (glens at apache.org)
  29520. </summary>
  29521. </member>
  29522. <member name="F:NPOI.Util.HexDump.DIGITS_LOWER">
  29523. Used to build output as Hex
  29524. </member>
  29525. <member name="F:NPOI.Util.HexDump.DIGITS_UPPER">
  29526. Used to build output as Hex
  29527. </member>
  29528. <member name="M:NPOI.Util.HexDump.Dump(System.Byte[],System.Int64,System.Int32,System.Int32)">
  29529. dump an array of bytes to a String
  29530. @param data the byte array to be dumped
  29531. @param offset its offset, whatever that might mean
  29532. @param index initial index into the byte array
  29533. @param length number of characters to output
  29534. @exception ArrayIndexOutOfBoundsException if the index is
  29535. outside the data array's bounds
  29536. @return output string
  29537. </member>
  29538. <member name="M:NPOI.Util.HexDump.Dump(System.IO.Stream,System.IO.Stream,System.Int32,System.Int32)">
  29539. Dumps <code>bytesToDump</code> bytes to an output stream.
  29540. @param in The stream to read from
  29541. @param out The output stream
  29542. @param start The index to use as the starting position for the left hand side label
  29543. @param bytesToDump The number of bytes to output. Use -1 to read until the end of file.
  29544. </member>
  29545. <member name="M:NPOI.Util.HexDump.ShortToHex(System.Int32)">
  29546. <summary>
  29547. Shorts to hex.
  29548. </summary>
  29549. <param name="value">The value.</param>
  29550. <returns>char array of 2 (zero padded) uppercase hex chars and prefixed with '0x'</returns>
  29551. </member>
  29552. <member name="M:NPOI.Util.HexDump.ByteToHex(System.Int32)">
  29553. <summary>
  29554. Bytes to hex.
  29555. </summary>
  29556. <param name="value">The value.</param>
  29557. <returns>char array of 1 (zero padded) uppercase hex chars and prefixed with '0x'</returns>
  29558. </member>
  29559. <member name="M:NPOI.Util.HexDump.IntToHex(System.Int32)">
  29560. <summary>
  29561. Ints to hex.
  29562. </summary>
  29563. <param name="value">The value.</param>
  29564. <returns>char array of 4 (zero padded) uppercase hex chars and prefixed with '0x'</returns>
  29565. </member>
  29566. <member name="M:NPOI.Util.HexDump.LongToHex(System.Int64)">
  29567. <summary>
  29568. char array of 4 (zero padded) uppercase hex chars and prefixed with '0x'
  29569. </summary>
  29570. <param name="value">The value.</param>
  29571. <returns>char array of 4 (zero padded) uppercase hex chars and prefixed with '0x'</returns>
  29572. </member>
  29573. <member name="M:NPOI.Util.HexDump.ToHexChars(System.Int64,System.Int32)">
  29574. <summary>
  29575. Toes the hex chars.
  29576. </summary>
  29577. <param name="pValue">The p value.</param>
  29578. <param name="nBytes">The n bytes.</param>
  29579. <returns>char array of uppercase hex chars, zero padded and prefixed with '0x'</returns>
  29580. </member>
  29581. <member name="M:NPOI.Util.HexRead.ReadData(System.String)">
  29582. <summary>
  29583. This method reads hex data from a filename and returns a byte array.
  29584. The file may contain line comments that are preceeded with a # symbol.
  29585. </summary>
  29586. <param name="filename">The filename to read</param>
  29587. <returns>The bytes read from the file.</returns>
  29588. <exception cref="T:System.IO.IOException">If there was a problem while reading the file.</exception>
  29589. </member>
  29590. <member name="M:NPOI.Util.HexRead.ReadData(System.IO.Stream,System.String)">
  29591. <summary>
  29592. Same as ReadData(String) except that this method allows you to specify sections within
  29593. a file. Sections are referenced using section headers in the form:
  29594. </summary>
  29595. <param name="stream">The stream.</param>
  29596. <param name="section">The section.</param>
  29597. <returns></returns>
  29598. </member>
  29599. <member name="M:NPOI.Util.HexRead.ReadData(System.String,System.String)">
  29600. <summary>
  29601. Reads the data.
  29602. </summary>
  29603. <param name="filename">The filename.</param>
  29604. <param name="section">The section.</param>
  29605. <returns></returns>
  29606. </member>
  29607. <member name="M:NPOI.Util.HexRead.ReadData(System.IO.Stream,System.Int32)">
  29608. <summary>
  29609. Reads the data.
  29610. </summary>
  29611. <param name="stream">The stream.</param>
  29612. <param name="eofChar">The EOF char.</param>
  29613. <returns></returns>
  29614. </member>
  29615. <member name="M:NPOI.Util.HexRead.ReadFromString(System.String)">
  29616. <summary>
  29617. Reads from string.
  29618. </summary>
  29619. <param name="data">The data.</param>
  29620. <returns></returns>
  29621. </member>
  29622. <member name="M:NPOI.Util.HexRead.ReadToEOL(System.IO.Stream)">
  29623. <summary>
  29624. Reads to EOL.
  29625. </summary>
  29626. <param name="stream">The stream.</param>
  29627. </member>
  29628. <member name="T:NPOI.Util.InputStream">
  29629. <summary>
  29630. This abstract class is the superclass of all classes representing
  29631. an input stream of bytes.
  29632. <para> Applications that need to define a subclass of <see cref="T:NPOI.Util.InputStream"/>
  29633. must always provide a method that returns the next byte of input.</para>
  29634. </summary>
  29635. <seealso cref="T:System.IO.Stream" />
  29636. </member>
  29637. <member name="M:NPOI.Util.InputStream.Read">
  29638. <summary>
  29639. Reads the next byte of data from the input stream. The value byte is
  29640. returned as an <c>int</c> in the range <c>0</c> to
  29641. <c>255</c>. If no byte is available because the end of the stream
  29642. has been reached, the value <c>-1</c> is returned. This method
  29643. blocks until input data is available, the end of the stream is detected,
  29644. or an exception is thrown.
  29645. A subclass must provide an implementation of this method.
  29646. </summary>
  29647. <returns>
  29648. the next byte of data, or <c>-1</c> if the end of the
  29649. stream is reached.
  29650. </returns>
  29651. <exception cref="T:System.IO.IOException">if an I/O error occurs</exception>
  29652. </member>
  29653. <member name="M:NPOI.Util.InputStream.Read(System.Byte[])">
  29654. <summary>
  29655. <para>
  29656. Reads some number of bytes from the input stream and stores them into
  29657. the buffer array <c>b</c>. The number of bytes actually read is
  29658. returned as an integer. This method blocks until input data is
  29659. available, end of file is detected, or an exception is thrown.
  29660. </para>
  29661. <para>
  29662. If the length of <c>b</c> is zero, then no bytes are read and
  29663. <c>0</c> is returned; otherwise, there is an attempt to read at
  29664. least one byte. If no byte is available because the stream is at the
  29665. end of the file, the value <c>0</c> is returned; otherwise, at
  29666. least one byte is read and stored into <c>b</c>.
  29667. </para>
  29668. <para>
  29669. <p> The first byte read is stored into element <c>b[0]</c>, the
  29670. next one into <c>b[1]</c>, and so on. The number of bytes read is,
  29671. at most, equal to the length of <c>b</c>. Let <i>k</i> be the
  29672. number of bytes actually read; these bytes will be stored in elements
  29673. <c>b[0]</c> through <c>b[</c><i>k</i><c>-1]</c>,
  29674. leaving elements <c>b[</c><i>k</i><c>]</c> through
  29675. <c>b[b.length-1]</c> unaffected.</p>
  29676. </para>
  29677. <para>
  29678. <p> The <c>read(b)</c> method for class <c>InputStream</c>
  29679. has the same effect as: <pre><c> read(b, 0, b.length) </c></pre></p>
  29680. </para>
  29681. </summary>
  29682. <param name="b">the buffer into which the data is read.</param>
  29683. <returns>
  29684. the total number of bytes read into the buffer, or
  29685. <c>0</c> if there is no more data because the end of
  29686. the stream has been reached.
  29687. </returns>
  29688. <exception cref="T:System.IO.IOException">If the first byte cannot be read for any reason
  29689. other than the end of the file, if the input stream has been closed, or
  29690. if some other I/O error occurs.</exception>
  29691. <exception cref="T:System.NullReferenceException">if <c>b</c> is <c>null</c>.</exception>
  29692. <see cref="M:NPOI.Util.InputStream.Read(System.Byte[],System.Int32,System.Int32)"/>
  29693. </member>
  29694. <member name="M:NPOI.Util.InputStream.Read(System.Byte[],System.Int32,System.Int32)">
  29695. <summary>
  29696. <para>
  29697. Reads up to <c>len</c> bytes of data from the input stream into
  29698. an array of bytes. An attempt is made to read as many as
  29699. <c>len</c> bytes, but a smaller number may be read.
  29700. The number of bytes actually read is returned as an integer.
  29701. </para>
  29702. <para>
  29703. <p> This method blocks until input data is available, end of file is
  29704. detected, or an exception is thrown.</p>
  29705. </para>
  29706. <para>
  29707. <p> If <c>len</c> is zero, then no bytes are read and
  29708. <c>0</c> is returned; otherwise, there is an attempt to read at
  29709. least one byte. If no byte is available because the stream is at end of
  29710. file, the value <c>0</c> is returned; otherwise, at least one
  29711. byte is read and stored into <c>b</c>.</p>
  29712. </para>
  29713. <para>
  29714. <p> The first byte read is stored into element <c>b[off]</c>, the
  29715. next one into <c>b[off+1]</c>, and so on. The number of bytes read
  29716. is, at most, equal to <c>len</c>. Let <i>k</i> be the number of
  29717. bytes actually read; these bytes will be stored in elements
  29718. <c>b[off]</c> through <c>b[off+</c><i>k</i><c>-1]</c>,
  29719. leaving elements <c>b[off+</c><i>k</i><c>]</c> through
  29720. <c>b[off+len-1]</c> unaffected.</p>
  29721. </para>
  29722. <para>
  29723. <p> In every case, elements <c>b[0]</c> through
  29724. <c>b[off]</c> and elements <c>b[off+len]</c> through
  29725. <c>b[b.length-1]</c> are unaffected.</p>
  29726. </para>
  29727. <para>
  29728. <p> The <c>read(b,</c> <c>off,</c> <c>len)</c> method
  29729. for class <c>InputStream</c> simply calls the method
  29730. <c>read()</c> repeatedly. If the first such call results in an
  29731. <c>IOException</c>, that exception is returned from the call to
  29732. the <c>read(b,</c> <c>off,</c> <c>len)</c> method. If
  29733. any subsequent call to <c>read()</c> results in a
  29734. <c>IOException</c>, the exception is caught and treated as if it
  29735. were end of file; the bytes read up to that point are stored into
  29736. <c>b</c> and the number of bytes read before the exception
  29737. occurred is returned. The default implementation of this method blocks
  29738. until the requested amount of input data <c>len</c> has been read,
  29739. end of file is detected, or an exception is thrown. Subclasses are encouraged
  29740. to provide a more efficient implementation of this method.</p>
  29741. </para>
  29742. </summary>
  29743. <param name="b">the buffer into which the data is read.</param>
  29744. <param name="off">the start offset in array <c>b</c> at which the data is written.</param>
  29745. <param name="len">the maximum number of bytes to read.</param>
  29746. <returns>
  29747. the total number of bytes read into the buffer, or
  29748. <c>0</c> if there is no more data because the end of
  29749. the stream has been reached.</returns>
  29750. <exception cref="T:System.IO.IOException">If the first byte cannot be read for any reason
  29751. other than end of file, or if the input stream has been closed, or if
  29752. some other I/O error occurs.</exception>
  29753. <exception cref="T:System.NullReferenceException">If <c>b</c> is <c>null</c>.</exception>
  29754. <exception cref="T:System.IndexOutOfRangeException">If <c>off</c> is negative,
  29755. <c>len</c> is negative, or <c>len</c> is greater than
  29756. <c>b.length - off</c></exception>
  29757. <see cref="M:NPOI.Util.InputStream.Read"/>
  29758. </member>
  29759. <member name="M:NPOI.Util.InputStream.Skip(System.Int64)">
  29760. <summary>
  29761. <para>
  29762. Skips over and discards <c>n</c> bytes of data from this input
  29763. stream. The <c>skip</c> method may, for a variety of reasons, end
  29764. up skipping over some smaller number of bytes, possibly <c>0</c>.
  29765. This may result from any of a number of conditions; reaching end of file
  29766. before <c>n</c> bytes have been skipped is only one possibility.
  29767. The actual number of bytes skipped is returned. If {@code n} is
  29768. negative, the {@code skip} method for class {@code InputStream} always
  29769. returns 0, and no bytes are skipped. Subclasses may handle the negative
  29770. value differently.
  29771. </para>
  29772. <para>
  29773. <p> The <c>skip</c> method of this class creates a
  29774. byte array and then repeatedly reads into it until <c>n</c> bytes
  29775. have been read or the end of the stream has been reached. Subclasses are
  29776. encouraged to provide a more efficient implementation of this method.
  29777. For instance, the implementation may depend on the ability to seek.</p>
  29778. </para>
  29779. </summary>
  29780. <param name="n">the number of bytes to be skipped.</param>
  29781. <returns>the actual number of bytes skipped.</returns>
  29782. <exception cref="T:System.IO.IOException">if the stream does not support seek,
  29783. or if some other I/O error occurs.
  29784. </exception>
  29785. </member>
  29786. <member name="M:NPOI.Util.InputStream.Available">
  29787. <summary>
  29788. <para>
  29789. Returns an estimate of the number of bytes that can be read (or
  29790. skipped over) from this input stream without blocking by the next
  29791. invocation of a method for this input stream. The next invocation
  29792. might be the same thread or another thread. A single read or skip of this
  29793. many bytes will not block, but may read or skip fewer bytes.
  29794. </para>
  29795. <para>
  29796. <p> Note that while some implementations of <see cref="T:NPOI.Util.InputStream"/> will return
  29797. the total number of bytes in the stream, many will not. It is
  29798. never correct to use the return value of this method to allocate
  29799. a buffer intended to hold all data in this stream.</p>
  29800. </para>
  29801. <para>
  29802. <p> A subclass' implementation of this method may choose to throw an
  29803. <see cref="T:System.IO.IOException"/> if this input stream has been closed by
  29804. invoking the <see cref="M:NPOI.Util.InputStream.Close"/> method.</p>
  29805. </para>
  29806. <para>
  29807. <p> The <see cref="M:NPOI.Util.InputStream.Available"/> method for class <see cref="T:NPOI.Util.InputStream"/> always
  29808. returns {@code 0}.</p>
  29809. </para>
  29810. <para><p> This method should be overridden by subclasses.</p></para>
  29811. </summary>
  29812. <exception cref="T:System.IO.IOException">if an I/O error occurs.</exception>
  29813. </member>
  29814. <member name="M:NPOI.Util.InputStream.Close">
  29815. <summary>
  29816. <para>
  29817. Closes this input stream and releases any system resources associated
  29818. with the stream.
  29819. </para>
  29820. <para><p> The <c>Close</c> method of <c>InputStream</c> does nothing.</p></para>
  29821. </summary>
  29822. <exception cref="T:System.IO.IOException">if an I/O error occurs.</exception>
  29823. </member>
  29824. <member name="M:NPOI.Util.InputStream.Mark(System.Int32)">
  29825. <summary>
  29826. <para>
  29827. Marks the current position in this input stream. A subsequent call to
  29828. the <c>reset</c> method repositions this stream at the last marked
  29829. position so that subsequent reads re-read the same bytes.
  29830. </para>
  29831. <para>
  29832. <p> The <c>readlimit</c> arguments tells this input stream to
  29833. allow that many bytes to be read before the mark position gets
  29834. invalidated.</p>
  29835. </para>
  29836. <para>
  29837. <p> The general contract of <c>mark</c> is that, if the method
  29838. <c>markSupported</c> returns <c>true</c>, the stream somehow
  29839. remembers all the bytes read after the call to <c>mark</c> and
  29840. stands ready to supply those same bytes again if and whenever the method
  29841. <c>reset</c> is called. However, the stream is not required to
  29842. remember any data at all if more than <c>readlimit</c> bytes are
  29843. read from the stream before <c>reset</c> is called.</p>
  29844. </para>
  29845. <para><p> Marking a closed stream should not have any effect on the stream.</p></para>
  29846. <para>
  29847. <p> The <c>mark</c> method of <c>InputStream</c> does
  29848. nothing.</p>
  29849. </para>
  29850. </summary>
  29851. <param name="readlimit">the maximum limit of bytes that can be read before
  29852. the mark position becomes invalid.
  29853. </param>
  29854. <see cref="M:NPOI.Util.InputStream.Reset"/>
  29855. </member>
  29856. <member name="M:NPOI.Util.InputStream.Reset">
  29857. <summary>
  29858. <para>
  29859. Repositions this stream to the position at the time the
  29860. <c>mark</c> method was last called on this input stream.
  29861. </para>
  29862. <para><p> The general contract of <c>reset</c> is:</p></para>
  29863. <para>
  29864. <ul>
  29865. <li> If the method <c>markSupported</c> returns
  29866. <c>true</c>, then:
  29867. <ul><li> If the method <c>mark</c> has not been called since
  29868. the stream was created, or the number of bytes read from the stream
  29869. since <c>mark</c> was last called is larger than the argument
  29870. to <c>mark</c> at that last call, then an
  29871. <c>IOException</c> might be thrown.</li>
  29872. <li> If such an <c>IOException</c> is not thrown, then the
  29873. stream is reset to a state such that all the bytes read since the
  29874. most recent call to <c>mark</c> (or since the start of the
  29875. file, if <c>mark</c> has not been called) will be resupplied
  29876. to subsequent callers of the <c>read</c> method, followed by
  29877. any bytes that otherwise would have been the next input data as of
  29878. the time of the call to <c>reset</c>. </li>
  29879. <li> If the method <c>markSupported</c> returns
  29880. <c>false</c>, then:
  29881. <ul><li> The call to <c>reset</c> may throw an
  29882. <c>IOException</c>.</li>
  29883. <li> If an <c>IOException</c> is not thrown, then the stream
  29884. is reset to a fixed state that depends on the particular type of the
  29885. input stream and how it was created. The bytes that will be supplied
  29886. to subsequent callers of the <c>read</c> method depend on the
  29887. particular type of the input stream. </li></ul></li></ul></li></ul>
  29888. </para>
  29889. <para>
  29890. <p>The method <c>reset</c> for class <c>InputStream</c>
  29891. does nothing except throw an <c>IOException</c>.</p>
  29892. </para>
  29893. </summary>
  29894. </member>
  29895. <member name="M:NPOI.Util.InputStream.MarkSupported">
  29896. <summary>
  29897. Tests if this input stream supports the <c>mark</c> and
  29898. <c>reset</c> methods. Whether or not <c>mark</c> and
  29899. <c>reset</c> are supported is an invariant property of a
  29900. particular input stream instance. The <c>markSupported</c> method
  29901. of <c>InputStream</c> returns <c>false</c>.
  29902. </summary>
  29903. <returns>
  29904. <c>true</c> if this stream instance supports the mark
  29905. and reset methods; <c>false</c> otherwise.
  29906. <see cref="M:NPOI.Util.InputStream.Mark(System.Int32)"/>
  29907. <see cref="M:NPOI.Util.InputStream.Reset"/>
  29908. </returns>
  29909. </member>
  29910. <member name="M:NPOI.Util.IntegerField.#ctor(System.Int32)">
  29911. <summary>
  29912. construct the <see cref="T:NPOI.Util.IntegerField"/> with its offset into its containing byte array class.
  29913. </summary>
  29914. <param name="offset">offset of the field within its byte array.</param>
  29915. </member>
  29916. <member name="M:NPOI.Util.IntegerField.#ctor(System.Int32,System.Int32)">
  29917. <summary>
  29918. construct the <see cref="T:NPOI.Util.IntegerField"/> with its offset into its containing
  29919. byte array and initialize its value
  29920. </summary>
  29921. <param name="offset">offset of the field within its byte array</param>
  29922. <param name="value">the initial value</param>
  29923. </member>
  29924. <member name="M:NPOI.Util.IntegerField.#ctor(System.Int32,System.Byte[])">
  29925. <summary>
  29926. Construct the <see cref="T:NPOI.Util.IntegerField"/> with its offset into its containing
  29927. byte array and initialize its value from its byte array
  29928. </summary>
  29929. <param name="offset">offset of the field within its byte array</param>
  29930. <param name="data">the byte array to Read the value from</param>
  29931. </member>
  29932. <member name="M:NPOI.Util.IntegerField.#ctor(System.Int32,System.Int32,System.Byte[])">
  29933. <summary>
  29934. construct the <see cref="T:NPOI.Util.IntegerField"/> with its offset into its containing
  29935. byte array, initialize its value, and write the value to a byte
  29936. </summary>
  29937. <param name="offset">offset of the field within its byte array</param>
  29938. <param name="value">the initial value</param>
  29939. <param name="data">the byte array to write the value to</param>
  29940. </member>
  29941. <member name="P:NPOI.Util.IntegerField.Value">
  29942. <summary>
  29943. get or Set the IntegerField's current value
  29944. </summary>
  29945. <value>The value.</value>
  29946. <returns></returns>
  29947. </member>
  29948. <member name="M:NPOI.Util.IntegerField.Set(System.Int32,System.Byte[])">
  29949. <summary>
  29950. Set the IntegerField's current value and write it to a byte array
  29951. </summary>
  29952. <param name="value">value to be Set</param>
  29953. <param name="data">the byte array to write the value to</param>
  29954. </member>
  29955. <member name="M:NPOI.Util.IntegerField.ReadFromBytes(System.Byte[])">
  29956. <summary>
  29957. Set the value from its offset into an array of bytes
  29958. </summary>
  29959. <param name="data">The data.</param>
  29960. </member>
  29961. <member name="M:NPOI.Util.IntegerField.ReadFromStream(System.IO.Stream)">
  29962. <summary>
  29963. Set the value from an Stream
  29964. </summary>
  29965. <param name="stream">the Stream from which the value is to be Read</param>
  29966. </member>
  29967. <member name="M:NPOI.Util.IntegerField.WriteToBytes(System.Byte[])">
  29968. <summary>
  29969. write the value out to an array of bytes at the appropriate offset
  29970. </summary>
  29971. <param name="data"> the array of bytes to which the value is to be written </param>
  29972. </member>
  29973. <member name="M:NPOI.Util.IntegerField.Write(System.Int32,System.Int32,System.Byte[])">
  29974. <summary>
  29975. Same as using the constructor <see cref="T:NPOI.Util.IntegerField"/> with the same
  29976. parameter list. Avoid creation of an useless object.
  29977. </summary>
  29978. <param name="offset">offset of the field within its byte array</param>
  29979. <param name="value">the initial value</param>
  29980. <param name="data">the byte array to write the value to</param>
  29981. </member>
  29982. <member name="M:NPOI.Util.IntegerField.ToString">
  29983. <summary>
  29984. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  29985. </summary>
  29986. <returns>
  29987. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  29988. </returns>
  29989. </member>
  29990. <member name="T:NPOI.Util.IntList">
  29991. <summary>
  29992. A List of int's; as full an implementation of the java.Util.List interface as possible, with an eye toward minimal creation of objects
  29993. the mimicry of List is as follows:
  29994. <ul>
  29995. <li> if possible, operations designated 'optional' in the List
  29996. interface are attempted</li>
  29997. <li> wherever the List interface refers to an Object, substitute
  29998. int</li>
  29999. <li> wherever the List interface refers to a Collection or List,
  30000. substitute IntList</li>
  30001. </ul>
  30002. the mimicry is not perfect, however:
  30003. <ul>
  30004. <li> operations involving Iterators or ListIterators are not
  30005. supported</li>
  30006. <li> Remove(Object) becomes RemoveValue to distinguish it from
  30007. Remove(int index)</li>
  30008. <li> subList is not supported</li>
  30009. </ul>
  30010. @author Marc Johnson
  30011. </summary>
  30012. </member>
  30013. <member name="M:NPOI.Util.IntList.#ctor">
  30014. <summary>
  30015. create an IntList of default size
  30016. </summary>
  30017. </member>
  30018. <member name="M:NPOI.Util.IntList.#ctor(NPOI.Util.IntList)">
  30019. <summary>
  30020. create a copy of an existing IntList
  30021. </summary>
  30022. <param name="list">the existing IntList</param>
  30023. </member>
  30024. <member name="M:NPOI.Util.IntList.#ctor(System.Int32,System.Int32)">
  30025. <summary>
  30026. create an IntList with a predefined Initial size
  30027. </summary>
  30028. <param name="initialCapacity">the size for the internal array</param>
  30029. <param name="fillvalue"></param>
  30030. </member>
  30031. <member name="M:NPOI.Util.IntList.Add(System.Int32,System.Int32)">
  30032. <summary>
  30033. add the specfied value at the specified index
  30034. </summary>
  30035. <param name="index">the index where the new value is to be Added</param>
  30036. <param name="value">the new value</param>
  30037. </member>
  30038. <member name="M:NPOI.Util.IntList.Add(System.Int32)">
  30039. <summary>
  30040. Appends the specified element to the end of this list
  30041. </summary>
  30042. <param name="value">element to be Appended to this list.</param>
  30043. <returns>return true (as per the general contract of the Collection.add method</returns>
  30044. </member>
  30045. <member name="M:NPOI.Util.IntList.AddAll(NPOI.Util.IntList)">
  30046. <summary>
  30047. Appends all of the elements in the specified collection to the
  30048. end of this list, in the order that they are returned by the
  30049. specified collection's iterator. The behavior of this
  30050. operation is unspecified if the specified collection is
  30051. modified while the operation is in progress. (Note that this
  30052. will occur if the specified collection is this list, and it's
  30053. nonempty.)
  30054. </summary>
  30055. <param name="c">collection whose elements are to be Added to this list.</param>
  30056. <returns>return true if this list Changed as a result of the call.</returns>
  30057. </member>
  30058. <member name="M:NPOI.Util.IntList.AddAll(System.Int32,NPOI.Util.IntList)">
  30059. <summary>
  30060. Inserts all of the elements in the specified collection into
  30061. this list at the specified position. Shifts the element
  30062. currently at that position (if any) and any subsequent elements
  30063. to the right (increases their indices). The new elements will
  30064. appear in this list in the order that they are returned by the
  30065. specified collection's iterator. The behavior of this
  30066. operation is unspecified if the specified collection is
  30067. modified while the operation is in progress. (Note that this
  30068. will occur if the specified collection is this list, and it's
  30069. nonempty.)
  30070. </summary>
  30071. <param name="index">index at which to insert first element from the specified collection.</param>
  30072. <param name="c">elements to be inserted into this list.</param>
  30073. <returns>return true if this list Changed as a result of the call.</returns>
  30074. </member>
  30075. <member name="M:NPOI.Util.IntList.Clear">
  30076. <summary>
  30077. Removes all of the elements from this list. This list will be
  30078. empty After this call returns (unless it throws an exception).
  30079. </summary>
  30080. </member>
  30081. <member name="M:NPOI.Util.IntList.Contains(System.Int32)">
  30082. <summary>
  30083. Returns true if this list Contains the specified element. More
  30084. formally, returns true if and only if this list Contains at
  30085. least one element e such that o == e
  30086. </summary>
  30087. <param name="o">element whose presence in this list is to be Tested.</param>
  30088. <returns>return true if this list Contains the specified element.</returns>
  30089. </member>
  30090. <member name="M:NPOI.Util.IntList.ContainsAll(NPOI.Util.IntList)">
  30091. <summary>
  30092. Returns true if this list Contains all of the elements of the
  30093. specified collection.
  30094. </summary>
  30095. <param name="c">collection to be Checked for Containment in this list.</param>
  30096. <returns>return true if this list Contains all of the elements of the specified collection.</returns>
  30097. </member>
  30098. <member name="M:NPOI.Util.IntList.Equals(System.Object)">
  30099. <summary>
  30100. Compares the specified object with this list for Equality.
  30101. Returns true if and only if the specified object is also a
  30102. list, both lists have the same size, and all corresponding
  30103. pairs of elements in the two lists are Equal. (Two elements e1
  30104. and e2 are equal if e1 == e2.) In other words, two lists are
  30105. defined to be equal if they contain the same elements in the
  30106. same order. This defInition ensures that the Equals method
  30107. works properly across different implementations of the List
  30108. interface.
  30109. </summary>
  30110. <param name="o">the object to be Compared for Equality with this list.</param>
  30111. <returns>return true if the specified object is equal to this list.</returns>
  30112. </member>
  30113. <member name="M:NPOI.Util.IntList.Get(System.Int32)">
  30114. <summary>
  30115. Returns the element at the specified position in this list.
  30116. </summary>
  30117. <param name="index">index of element to return.</param>
  30118. <returns>return the element at the specified position in this list.</returns>
  30119. </member>
  30120. <member name="M:NPOI.Util.IntList.GetHashCode">
  30121. <summary>
  30122. Returns the hash code value for this list. The hash code of a
  30123. list is defined to be the result of the following calculation:
  30124. <code>
  30125. hashCode = 1;
  30126. Iterator i = list.Iterator();
  30127. while (i.HasNext()) {
  30128. Object obj = i.Next();
  30129. hashCode = 31*hashCode + (obj==null ? 0 : obj.HashCode());
  30130. }
  30131. </code>
  30132. This ensures that list1.Equals(list2) implies that
  30133. list1.HashCode()==list2.HashCode() for any two lists, list1 and
  30134. list2, as required by the general contract of Object.HashCode.
  30135. </summary>
  30136. <returns>return the hash code value for this list.</returns>
  30137. </member>
  30138. <member name="M:NPOI.Util.IntList.IndexOf(System.Int32)">
  30139. <summary>
  30140. Returns the index in this list of the first occurrence of the
  30141. specified element, or -1 if this list does not contain this
  30142. element. More formally, returns the lowest index i such that
  30143. (o == Get(i)), or -1 if there is no such index.
  30144. </summary>
  30145. <param name="o">element to search for.</param>
  30146. <returns>return the index in this list of the first occurrence of the
  30147. specified element, or -1 if this list does not contain
  30148. this element.</returns>
  30149. </member>
  30150. <member name="M:NPOI.Util.IntList.IsEmpty">
  30151. <summary>
  30152. Returns true if this list Contains no elements.
  30153. </summary>
  30154. <returns>return true if this list Contains no elements.</returns>
  30155. </member>
  30156. <member name="M:NPOI.Util.IntList.LastIndexOf(System.Int32)">
  30157. <summary>
  30158. Returns the index in this list of the last occurrence of the
  30159. specified element, or -1 if this list does not contain this
  30160. element. More formally, returns the highest index i such that
  30161. (o == Get(i)), or -1 if there is no such index.
  30162. </summary>
  30163. <param name="o">element to search for.</param>
  30164. <returns>the index in this list of the last occurrence of the
  30165. specified element, or -1 if this list does not contain
  30166. this element.
  30167. </returns>
  30168. </member>
  30169. <member name="M:NPOI.Util.IntList.Remove(System.Int32)">
  30170. <summary>
  30171. Removes the element at the specified position in this list.
  30172. Shifts any subsequent elements to the left (subtracts one from
  30173. their indices). Returns the element that was Removed from the
  30174. list.
  30175. </summary>
  30176. <param name="index">the index of the element to Removed.</param>
  30177. <returns>return the element previously at the specified position.</returns>
  30178. </member>
  30179. <member name="M:NPOI.Util.IntList.RemoveValue(System.Int32)">
  30180. <summary>
  30181. Removes the first occurrence in this list of the specified
  30182. element (optional operation). If this list does not contain
  30183. the element, it is unChanged. More formally, Removes the
  30184. element with the lowest index i such that (o.Equals(get(i)))
  30185. (if such an element exists).
  30186. </summary>
  30187. <param name="o">element to be Removed from this list, if present.</param>
  30188. <returns>return true if this list Contained the specified element.</returns>
  30189. </member>
  30190. <member name="M:NPOI.Util.IntList.RemoveAll(NPOI.Util.IntList)">
  30191. <summary>
  30192. Removes from this list all the elements that are Contained in
  30193. the specified collection
  30194. </summary>
  30195. <param name="c">collection that defines which elements will be Removed from the list.</param>
  30196. <returns>return true if this list Changed as a result of the call.</returns>
  30197. </member>
  30198. <member name="M:NPOI.Util.IntList.RetainAll(NPOI.Util.IntList)">
  30199. <summary>
  30200. Retains only the elements in this list that are Contained in
  30201. the specified collection. In other words, Removes from this
  30202. list all the elements that are not Contained in the specified
  30203. collection.
  30204. </summary>
  30205. <param name="c">collection that defines which elements this Set will retain.</param>
  30206. <returns>return true if this list Changed as a result of the call.</returns>
  30207. </member>
  30208. <member name="M:NPOI.Util.IntList.Set(System.Int32,System.Int32)">
  30209. <summary>
  30210. Replaces the element at the specified position in this list with the specified element
  30211. </summary>
  30212. <param name="index">index of element to Replace.</param>
  30213. <param name="element">element to be stored at the specified position.</param>
  30214. <returns>the element previously at the specified position.</returns>
  30215. </member>
  30216. <member name="M:NPOI.Util.IntList.Size">
  30217. <summary>
  30218. Returns the number of elements in this list. If this list
  30219. Contains more than Int32.MaxValue elements, returns
  30220. Int32.MaxValue.
  30221. </summary>
  30222. <returns>the number of elements in this IntList</returns>
  30223. </member>
  30224. <member name="P:NPOI.Util.IntList.Count">
  30225. <summary>
  30226. the number of elements in this IntList
  30227. </summary>
  30228. </member>
  30229. <member name="M:NPOI.Util.IntList.ToArray">
  30230. <summary>
  30231. Returns an array Containing all of the elements in this list in
  30232. proper sequence. Obeys the general contract of the
  30233. Collection.ToArray method.
  30234. </summary>
  30235. <returns>an array Containing all of the elements in this list in proper sequence.</returns>
  30236. </member>
  30237. <member name="M:NPOI.Util.IntList.ToArray(System.Int32[])">
  30238. <summary>
  30239. Returns an array Containing all of the elements in this list in
  30240. proper sequence. Obeys the general contract of the
  30241. Collection.ToArray(Object[]) method.
  30242. </summary>
  30243. <param name="a">the array into which the elements of this list are to
  30244. be stored, if it is big enough; otherwise, a new array
  30245. is allocated for this purpose.</param>
  30246. <returns>return an array Containing the elements of this list.</returns>
  30247. </member>
  30248. <member name="T:NPOI.Util.IntMapper`1">
  30249. <summary>
  30250. A List of objects that are indexed AND keyed by an int; also allows for Getting
  30251. the index of a value in the list
  30252. <p>I am happy is someone wants to re-implement this without using the
  30253. internal list and hashmap. If so could you please make sure that
  30254. you can add elements half way into the list and have the value-key mappings
  30255. update</p>
  30256. </summary>
  30257. <typeparam name="T"></typeparam>
  30258. <remarks>@author Jason Height</remarks>
  30259. </member>
  30260. <member name="M:NPOI.Util.IntMapper`1.#ctor">
  30261. <summary>
  30262. create an IntMapper of default size
  30263. </summary>
  30264. </member>
  30265. <member name="M:NPOI.Util.IntMapper`1.Add(`0)">
  30266. <summary>
  30267. Appends the specified element to the end of this list
  30268. </summary>
  30269. <param name="value">element to be Appended to this list.</param>
  30270. <returns>return true (as per the general contract of the Collection.add method)</returns>
  30271. </member>
  30272. <member name="P:NPOI.Util.IntMapper`1.Size">
  30273. <summary>
  30274. Gets the size.
  30275. </summary>
  30276. </member>
  30277. <member name="P:NPOI.Util.IntMapper`1.Item(System.Int32)">
  30278. <summary>
  30279. Gets the T object at the specified index.
  30280. </summary>
  30281. <param name="index"></param>
  30282. <returns></returns>
  30283. </member>
  30284. <member name="M:NPOI.Util.IntMapper`1.GetIndex(`0)">
  30285. <summary>
  30286. Gets the index of T object.
  30287. </summary>
  30288. <param name="o">The o.</param>
  30289. <returns></returns>
  30290. </member>
  30291. <member name="M:NPOI.Util.IntMapper`1.GetEnumerator">
  30292. <summary>
  30293. Gets the enumerator.
  30294. </summary>
  30295. <returns></returns>
  30296. </member>
  30297. <member name="F:NPOI.Util.IOUtils.BYTE_ARRAY_MAX_OVERRIDE">
  30298. <summary>
  30299. The current set global allocation limit override,
  30300. -1 means limits are applied per record type.
  30301. The current set global allocation limit override,
  30302. </summary>
  30303. </member>
  30304. <member name="F:NPOI.Util.IOUtils.MAX_BYTE_ARRAY_INIT_SIZE">
  30305. <summary>
  30306. The max init size of ByteArrayOutputStream.
  30307. -1 means init size of ByteArrayOutputStream could be up to Integer.MAX_VALUE
  30308. </summary>
  30309. </member>
  30310. <member name="F:NPOI.Util.IOUtils.DEFAULT_BUFFER_SIZE">
  30311. <summary>
  30312. The default size of the bytearray used while reading input streams. This is meant to be pretty small.
  30313. </summary>
  30314. </member>
  30315. <member name="M:NPOI.Util.IOUtils.PeekFirst8Bytes(NPOI.Util.InputStream)">
  30316. <summary>
  30317. Peeks at the first 8 bytes of the stream. Returns those bytes, but
  30318. with the stream unaffected. Requires a stream that supports mark/reset,
  30319. or a PushbackInputStream. If the stream has &gt;0 but &lt;8 bytes,
  30320. remaining bytes will be zero.
  30321. @throws EmptyFileException if the stream is empty
  30322. </summary>
  30323. </member>
  30324. <member name="M:NPOI.Util.IOUtils.ToByteArray(System.IO.Stream)">
  30325. <summary>
  30326. Reads all the data from the input stream, and returns
  30327. the bytes Read.
  30328. </summary>
  30329. <param name="stream">The stream.</param>
  30330. <returns></returns>
  30331. <remarks>Tony Qu changed the code</remarks>
  30332. </member>
  30333. <member name="M:NPOI.Util.IOUtils.ToByteArray(System.IO.Stream,System.Int32)">
  30334. <summary>
  30335. Reads up to {@code length} bytes from the input stream, and returns the bytes read.
  30336. </summary>
  30337. <param name="stream"></param>
  30338. <param name="length"></param>
  30339. <returns></returns>
  30340. </member>
  30341. <member name="M:NPOI.Util.IOUtils.ReadFully(System.IO.Stream,System.Byte[])">
  30342. <summary>
  30343. Reads the fully.
  30344. </summary>
  30345. <param name="stream">The stream.</param>
  30346. <param name="b">The b.</param>
  30347. <returns></returns>
  30348. </member>
  30349. <member name="M:NPOI.Util.IOUtils.ReadFully(System.IO.Stream,System.Byte[],System.Int32,System.Int32)">
  30350. <summary>
  30351. Same as the normal InputStream#read(byte[], int, int), but tries to ensure
  30352. that the buffer is filled completely if possible, i.e. b.remaining()
  30353. returns 0.
  30354. If the end of file is reached before any bytes are Read, returns -1.
  30355. If the end of the file is reached after some bytes are read, returns the
  30356. number of bytes read. If the end of the file isn't reached before the
  30357. buffer has no more remaining capacity, will return the number of bytes
  30358. that were read.
  30359. </summary>
  30360. <param name="stream">the stream from which the data is read.</param>
  30361. <param name="b">the buffer into which the data is read.</param>
  30362. <param name="off">the start offset in array b at which the data is written.</param>
  30363. <param name="len">the maximum number of bytes to read.</param>
  30364. <returns></returns>
  30365. </member>
  30366. <member name="M:NPOI.Util.IOUtils.Copy(System.IO.Stream,System.IO.Stream)">
  30367. <summary>
  30368. Copies all the data from the given InputStream to the OutputStream. It
  30369. leaves both streams open, so you will still need to close them once done.
  30370. </summary>
  30371. <param name="inp"></param>
  30372. <param name="out1"></param>
  30373. </member>
  30374. <member name="M:NPOI.Util.IOUtils.CloseQuietly(System.IO.Stream)">
  30375. <summary>
  30376. Quietly (no exceptions) close Closable resource. In case of error it will
  30377. be printed to {@link IOUtils} class logger.
  30378. </summary>
  30379. <param name="closeable">resource to close</param>
  30380. </member>
  30381. <member name="T:NPOI.Util.LittleEndian">
  30382. <summary>
  30383. a utility class for handling little-endian numbers, which the 80x86 world is
  30384. replete with. The methods are all static, and input/output is from/to byte
  30385. arrays, or from InputStreams.
  30386. </summary>
  30387. <remarks>
  30388. @author Marc Johnson (mjohnson at apache dot org)
  30389. @author Andrew Oliver (acoliver at apache dot org)
  30390. </remarks>
  30391. </member>
  30392. <member name="M:NPOI.Util.LittleEndian.#ctor">
  30393. <summary>
  30394. Initializes a new instance of the <see cref="T:NPOI.Util.LittleEndian"/> class.
  30395. </summary>
  30396. </member>
  30397. <member name="M:NPOI.Util.LittleEndian.GetShort(System.Byte[],System.Int32)">
  30398. <summary>
  30399. get a short value from a byte array
  30400. </summary>
  30401. <param name="data">the byte array</param>
  30402. <param name="offset">a starting offset into the byte array</param>
  30403. <returns>the short (16-bit) value</returns>
  30404. </member>
  30405. <member name="M:NPOI.Util.LittleEndian.GetUShort(System.Byte[],System.Int32)">
  30406. <summary>
  30407. get an unsigned short value from a byte array
  30408. </summary>
  30409. <param name="data">the byte array</param>
  30410. <param name="offset">a starting offset into the byte array</param>
  30411. <returns>the unsigned short (16-bit) value in an integer</returns>
  30412. </member>
  30413. <member name="M:NPOI.Util.LittleEndian.GetShort(System.Byte[])">
  30414. <summary>
  30415. get a short value from a byte array
  30416. </summary>
  30417. <param name="data">a starting offset into the byte array</param>
  30418. <returns>the short (16-bit) value</returns>
  30419. </member>
  30420. <member name="M:NPOI.Util.LittleEndian.GetUShort(System.Byte[])">
  30421. <summary>
  30422. get a short value from a byte array
  30423. </summary>
  30424. <param name="data">the unsigned short (16-bit) value in an integer</param>
  30425. <returns></returns>
  30426. </member>
  30427. <member name="M:NPOI.Util.LittleEndian.GetInt(System.Byte[],System.Int32)">
  30428. <summary>
  30429. get an int value from a byte array
  30430. </summary>
  30431. <param name="data">the byte array</param>
  30432. <param name="offset">a starting offset into the byte array</param>
  30433. <returns>the int (32-bit) value</returns>
  30434. </member>
  30435. <member name="M:NPOI.Util.LittleEndian.GetInt(System.Byte[])">
  30436. <summary>
  30437. get an int value from the beginning of a byte array
  30438. </summary>
  30439. <param name="data">the byte array</param>
  30440. <returns>the int (32-bit) value</returns>
  30441. </member>
  30442. <member name="M:NPOI.Util.LittleEndian.GetUInt(System.Byte[],System.Int32)">
  30443. <summary>
  30444. Gets the U int.
  30445. </summary>
  30446. <param name="data">the byte array</param>
  30447. <param name="offset">a starting offset into the byte array</param>
  30448. <returns>the unsigned int (32-bit) value in a long</returns>
  30449. </member>
  30450. <member name="M:NPOI.Util.LittleEndian.GetUInt(System.Byte[])">
  30451. <summary>
  30452. Gets the U int.
  30453. </summary>
  30454. <param name="data">the byte array</param>
  30455. <returns>the unsigned int (32-bit) value in a long</returns>
  30456. </member>
  30457. <member name="M:NPOI.Util.LittleEndian.GetLong(System.Byte[],System.Int32)">
  30458. <summary>
  30459. get a long value from a byte array
  30460. </summary>
  30461. <param name="data">the byte array</param>
  30462. <param name="offset">a starting offset into the byte array</param>
  30463. <returns>the long (64-bit) value</returns>
  30464. </member>
  30465. <member name="M:NPOI.Util.LittleEndian.GetDouble(System.Byte[],System.Int32)">
  30466. <summary>
  30467. get a double value from a byte array, reads it in little endian format
  30468. then converts the resulting revolting IEEE 754 (curse them) floating
  30469. point number to a c# double
  30470. </summary>
  30471. <param name="data">the byte array</param>
  30472. <param name="offset">a starting offset into the byte array</param>
  30473. <returns>the double (64-bit) value</returns>
  30474. </member>
  30475. <member name="M:NPOI.Util.LittleEndian.PutShort(System.Byte[],System.Int32,System.Int16)">
  30476. <summary>
  30477. Puts the short.
  30478. </summary>
  30479. <param name="data">the byte array</param>
  30480. <param name="offset">a starting offset into the byte array</param>
  30481. <param name="value">The value.</param>
  30482. </member>
  30483. <member name="M:NPOI.Util.LittleEndian.PutByte(System.Byte[],System.Int32,System.Int32)">
  30484. <summary>
  30485. Added for consistency with other put~() methods
  30486. </summary>
  30487. <param name="data">the byte array</param>
  30488. <param name="offset">a starting offset into the byte array</param>
  30489. <param name="value">The value.</param>
  30490. </member>
  30491. <member name="M:NPOI.Util.LittleEndian.PutUShort(System.Byte[],System.Int32,System.Int32)">
  30492. <summary>
  30493. Puts the U short.
  30494. </summary>
  30495. <param name="data">the byte array</param>
  30496. <param name="offset">a starting offset into the byte array</param>
  30497. <param name="value">The value.</param>
  30498. </member>
  30499. <member name="M:NPOI.Util.LittleEndian.PutShort(System.IO.Stream,System.Int16)">
  30500. Put signed short into output stream
  30501. @param value
  30502. the short (16-bit) value
  30503. @param outputStream
  30504. output stream
  30505. @throws IOException
  30506. if an I/O error occurs
  30507. </member>
  30508. <member name="M:NPOI.Util.LittleEndian.PutInt(System.Byte[],System.Int32,System.Int32)">
  30509. <summary>
  30510. put an int value into a byte array
  30511. </summary>
  30512. <param name="data">the byte array</param>
  30513. <param name="offset">a starting offset into the byte array</param>
  30514. <param name="value">the int (32-bit) value</param>
  30515. </member>
  30516. <member name="M:NPOI.Util.LittleEndian.PutInt(System.Int32,System.IO.Stream)">
  30517. <summary>
  30518. Put int into output stream
  30519. </summary>
  30520. <param name="value">the int (32-bit) value</param>
  30521. <param name="outputStream">output stream</param>
  30522. </member>
  30523. <member name="M:NPOI.Util.LittleEndian.PutLong(System.Byte[],System.Int32,System.Int64)">
  30524. <summary>
  30525. put a long value into a byte array
  30526. </summary>
  30527. <param name="data">the byte array</param>
  30528. <param name="offset">a starting offset into the byte array</param>
  30529. <param name="value">the long (64-bit) value</param>
  30530. </member>
  30531. <member name="M:NPOI.Util.LittleEndian.PutDouble(System.Byte[],System.Int32,System.Double)">
  30532. <summary>
  30533. put a double value into a byte array
  30534. </summary>
  30535. <param name="data">the byte array</param>
  30536. <param name="offset">a starting offset into the byte array</param>
  30537. <param name="value">the double (64-bit) value</param>
  30538. </member>
  30539. <member name="M:NPOI.Util.LittleEndian.ReadShort(System.IO.Stream)">
  30540. <summary>
  30541. Reads the short.
  30542. </summary>
  30543. <param name="stream">The stream.</param>
  30544. <returns></returns>
  30545. </member>
  30546. <member name="M:NPOI.Util.LittleEndian.ReadInt(System.IO.Stream)">
  30547. <summary>
  30548. get an int value from an Stream
  30549. </summary>
  30550. <param name="stream">the Stream from which the int is to be read</param>
  30551. <returns>the int (32-bit) value</returns>
  30552. <exception cref="T:System.IO.IOException">will be propagated back to the caller</exception>
  30553. <exception cref="T:NPOI.Util.BufferUnderrunException">if the stream cannot provide enough bytes</exception>
  30554. </member>
  30555. <member name="M:NPOI.Util.LittleEndian.ReadLong(System.IO.Stream)">
  30556. <summary>
  30557. get a long value from a Stream
  30558. </summary>
  30559. <param name="stream">the Stream from which the long is to be read</param>
  30560. <returns>the long (64-bit) value</returns>
  30561. <exception cref="T:System.IO.IOException">will be propagated back to the caller</exception>
  30562. <exception cref="T:NPOI.Util.BufferUnderrunException">if the stream cannot provide enough bytes</exception>
  30563. </member>
  30564. <member name="M:NPOI.Util.LittleEndian.UByteToInt(System.Byte)">
  30565. <summary>
  30566. Us the byte to int.
  30567. </summary>
  30568. <param name="b">The b.</param>
  30569. <returns></returns>
  30570. </member>
  30571. <member name="M:NPOI.Util.LittleEndian.GetByteArray(System.Byte[],System.Int32,System.Int32)">
  30572. <summary>
  30573. Copy a portion of a byte array
  30574. </summary>
  30575. <param name="data"> the original byte array</param>
  30576. <param name="offset">Where to start copying from.</param>
  30577. <param name="size">Number of bytes to copy.</param>
  30578. <returns>The byteArray value</returns>
  30579. <exception cref="T:System.IndexOutOfRangeException">
  30580. if copying would cause access ofdata outside array bounds.
  30581. </exception>
  30582. </member>
  30583. <member name="M:NPOI.Util.LittleEndian.GetUByte(System.Byte[])">
  30584. <summary>
  30585. Gets the unsigned byte.
  30586. </summary>
  30587. <param name="data">the byte array</param>
  30588. <returns></returns>
  30589. </member>
  30590. <member name="M:NPOI.Util.LittleEndian.GetUByte(System.Byte[],System.Int32)">
  30591. <summary>
  30592. Gets the unsigned byte.
  30593. </summary>
  30594. <param name="data">the byte array</param>
  30595. <param name="offset">a starting offset into the byte array</param>
  30596. <returns></returns>
  30597. </member>
  30598. <member name="M:NPOI.Util.LittleEndian.PutDouble(System.Byte[],System.Double)">
  30599. <summary>
  30600. Puts the double.
  30601. </summary>
  30602. <param name="data">the byte array</param>
  30603. <param name="value">The value.</param>
  30604. </member>
  30605. <member name="M:NPOI.Util.LittleEndian.PutDouble(System.Double,System.IO.Stream)">
  30606. put a double value into a byte array
  30607. @param value
  30608. the double (64-bit) value
  30609. @param outputStream
  30610. output stream
  30611. @throws IOException
  30612. if an I/O error occurs
  30613. </member>
  30614. <member name="M:NPOI.Util.LittleEndian.PutUInt(System.Int64,System.IO.Stream)">
  30615. Put unsigned int into output stream
  30616. @param value
  30617. the int (32-bit) value
  30618. @param outputStream
  30619. output stream
  30620. @throws IOException
  30621. if an I/O error occurs
  30622. </member>
  30623. <member name="M:NPOI.Util.LittleEndian.PutUInt(System.Byte[],System.Int32,System.UInt32)">
  30624. <summary>
  30625. Puts the uint.
  30626. </summary>
  30627. <param name="data">the byte array</param>
  30628. <param name="offset">a starting offset into the byte array</param>
  30629. <param name="value">The value.</param>
  30630. </member>
  30631. <member name="M:NPOI.Util.LittleEndian.PutLong(System.Byte[],System.Int64)">
  30632. <summary>
  30633. Puts the long.
  30634. </summary>
  30635. <param name="data">the byte array</param>
  30636. <param name="value">The value.</param>
  30637. </member>
  30638. <member name="M:NPOI.Util.LittleEndian.PutLong(System.Int64,System.IO.Stream)">
  30639. Put long into output stream
  30640. @param value
  30641. the long (64-bit) value
  30642. @param outputStream
  30643. output stream
  30644. @throws IOException
  30645. if an I/O error occurs
  30646. </member>
  30647. <member name="M:NPOI.Util.LittleEndian.PutULong(System.Byte[],System.UInt64)">
  30648. <summary>
  30649. Puts the long.
  30650. </summary>
  30651. <param name="data">the byte array</param>
  30652. <param name="value">The value.</param>
  30653. </member>
  30654. <member name="M:NPOI.Util.LittleEndian.PutULong(System.Byte[],System.Int32,System.UInt64)">
  30655. <summary>
  30656. Puts the ulong.
  30657. </summary>
  30658. <param name="data">the byte array</param>
  30659. <param name="offset">a starting offset into the byte array</param>
  30660. <param name="value">The value.</param>
  30661. </member>
  30662. <member name="M:NPOI.Util.LittleEndian.PutNumber(System.Byte[],System.Int32,System.Int64,System.Int32)">
  30663. <summary>
  30664. Puts the number.
  30665. </summary>
  30666. <param name="data">the byte array</param>
  30667. <param name="offset">a starting offset into the byte array</param>
  30668. <param name="value">The value.</param>
  30669. <param name="size">The size.</param>
  30670. </member>
  30671. <member name="M:NPOI.Util.LittleEndian.PutNumber(System.Byte[],System.Int32,System.UInt64,System.Int32)">
  30672. <summary>
  30673. Puts the number.
  30674. </summary>
  30675. <param name="data">the byte array</param>
  30676. <param name="offset">a starting offset into the byte array</param>
  30677. <param name="value">The value.</param>
  30678. <param name="size">The size.</param>
  30679. </member>
  30680. <member name="M:NPOI.Util.LittleEndian.PutShortArray(System.Byte[],System.Int32,System.Int16[])">
  30681. <summary>
  30682. Puts the short array.
  30683. </summary>
  30684. <param name="data">the byte array</param>
  30685. <param name="offset">a starting offset into the byte array</param>
  30686. <param name="value">The value.</param>
  30687. </member>
  30688. <member name="M:NPOI.Util.LittleEndian.PutUShort(System.Byte[],System.Int32)">
  30689. <summary>
  30690. Puts the U short.
  30691. </summary>
  30692. <param name="data">the byte array</param>
  30693. <param name="value">The value.</param>
  30694. </member>
  30695. <member name="M:NPOI.Util.LittleEndian.PutUShort(System.Int32,System.IO.Stream)">
  30696. Put unsigned short into output stream
  30697. @param value
  30698. the unsigned short (16-bit) value
  30699. @param outputStream
  30700. output stream
  30701. @throws IOException
  30702. if an I/O error occurs
  30703. </member>
  30704. <member name="M:NPOI.Util.LittleEndian.ReadFromStream(System.IO.Stream,System.Int32)">
  30705. <summary>
  30706. Reads from stream.
  30707. </summary>
  30708. <param name="stream">The stream.</param>
  30709. <param name="size">The size.</param>
  30710. <returns></returns>
  30711. </member>
  30712. <member name="M:NPOI.Util.LittleEndian.ReadULong(System.IO.Stream)">
  30713. <summary>
  30714. Reads the long.
  30715. </summary>
  30716. <param name="stream">The stream.</param>
  30717. <returns></returns>
  30718. </member>
  30719. <member name="T:NPOI.Util.LittleEndianByteArrayInputStream">
  30720. <summary>
  30721. Adapts a plain byte array to <see cref="T:NPOI.Util.ILittleEndianInput"/>
  30722. </summary>
  30723. <remarks>@author Josh Micich</remarks>
  30724. </member>
  30725. <member name="T:NPOI.Util.LittleEndianByteArrayOutputStream">
  30726. <summary>
  30727. Adapts a plain byte array to <see cref="T:NPOI.Util.ILittleEndianOutput"/>
  30728. </summary>
  30729. <remarks>@author Josh Micich</remarks>
  30730. </member>
  30731. <member name="T:NPOI.Util.ILittleEndianInput">
  30732. @author Josh Micich
  30733. </member>
  30734. <member name="T:NPOI.Util.LittleEndianInputStream">
  30735. <summary>
  30736. <para>Wraps an <see cref="T:System.IO.Stream"/> providing <see cref="T:NPOI.Util.ILittleEndianInput"/><p/></para>
  30737. <para>
  30738. This class does not buffer any input, so the stream Read position maintained
  30739. by this class is consistent with that of the inner stream.
  30740. </para>
  30741. </summary>
  30742. <remarks>
  30743. @author Josh Micich
  30744. </remarks>
  30745. </member>
  30746. <member name="M:NPOI.Util.LittleEndianInputStream.Read(System.Byte[])">
  30747. <summary>
  30748. <para>
  30749. Reads up to <c>byte.length</c> bytes of data from this
  30750. input stream into an array of bytes. This method blocks until some
  30751. input is available.
  30752. </para>
  30753. <para>simulate java FilterInputStream</para>
  30754. </summary>
  30755. <param name="b"></param>
  30756. <returns></returns>
  30757. </member>
  30758. <member name="M:NPOI.Util.LittleEndianInputStream.Read(System.Byte[],System.Int32,System.Int32)">
  30759. <summary>
  30760. <para>
  30761. Reads up to <c>len</c> bytes of data from this input stream
  30762. into an array of bytes.If<c> len</c> is not zero, the method
  30763. blocks until some input is available; otherwise, no
  30764. bytes are read and<c>0</c> is returned.
  30765. </para>
  30766. <para>simulate java FilterInputStream</para>
  30767. </summary>
  30768. <param name="b"></param>
  30769. <param name="off"></param>
  30770. <param name="len"></param>
  30771. <returns></returns>
  30772. </member>
  30773. <member name="T:NPOI.Util.ILittleEndianOutput">
  30774. @author Josh Micich
  30775. </member>
  30776. <member name="T:NPOI.Util.LittleEndianOutputStream">
  30777. <summary>
  30778. Wraps an <see cref="T:System.IO.Stream"/> providing <see cref="T:NPOI.Util.ILittleEndianOutput"/>
  30779. </summary>
  30780. <remarks>@author Josh Micich</remarks>
  30781. </member>
  30782. <member name="T:NPOI.Util.LocaleUtil">
  30783. This utility class is used to set locale and time zone settings beside
  30784. of the JDK internal {@link java.util.Locale#setDefault(Locale)} and
  30785. {@link java.util.TimeZone#setDefault(TimeZone)} methods, because
  30786. the locale/time zone specific handling of certain office documents -
  30787. maybe for different time zones / locales ... - shouldn't affect
  30788. other java components.
  30789. </member>
  30790. <member name="F:NPOI.Util.LocaleUtil.TIMEZONE_UTC">
  30791. Excel doesn't store TimeZone information in the file, so if in doubt,
  30792. use UTC to perform calculations
  30793. </member>
  30794. <member name="F:NPOI.Util.LocaleUtil.CHARSET_1252">
  30795. Default encoding for unknown byte encodings of native files
  30796. (at least it's better than to rely on a platform dependent encoding
  30797. for legacy stuff ...)
  30798. </member>
  30799. <member name="M:NPOI.Util.LocaleUtil.SetUserTimeZone(System.TimeZoneInfo)">
  30800. As time zone information is not stored in any format, it can be
  30801. set before any date calculations take place.
  30802. This setting is specific to the current thread.
  30803. @param timezone the timezone under which date calculations take place
  30804. </member>
  30805. <member name="M:NPOI.Util.LocaleUtil.GetUserTimeZoneInfo">
  30806. @return the time zone which is used for date calculations, defaults to UTC
  30807. </member>
  30808. <member name="M:NPOI.Util.LocaleUtil.SetUserLocale(System.Globalization.CultureInfo)">
  30809. Sets default user locale.
  30810. This setting is specific to the current thread.
  30811. </member>
  30812. <member name="M:NPOI.Util.LocaleUtil.GetUserLocale">
  30813. @return the default user locale, defaults to {@link Locale#ROOT}
  30814. </member>
  30815. <member name="M:NPOI.Util.LocaleUtil.GetLocaleCalendar">
  30816. @return a calendar for the user locale and time zone
  30817. </member>
  30818. <member name="M:NPOI.Util.LocaleUtil.GetLocaleCalendar(System.Int32,System.Int32,System.Int32)">
  30819. Convenience method - month is 0-based as in java.util.Calendar
  30820. @param year
  30821. @param month
  30822. @param day
  30823. @return a calendar for the user locale and time zone, and the given date
  30824. </member>
  30825. <member name="M:NPOI.Util.LocaleUtil.GetLocaleCalendar(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  30826. Convenience method - month is 0-based as in java.util.Calendar
  30827. @param year
  30828. @param month
  30829. @param day
  30830. @param hour
  30831. @param minute
  30832. @param second
  30833. @return a calendar for the user locale and time zone, and the given date
  30834. </member>
  30835. <member name="M:NPOI.Util.LocaleUtil.GetLocaleCalendar(System.TimeZoneInfo)">
  30836. @return a calendar for the user locale and time zone
  30837. </member>
  30838. <member name="M:NPOI.Util.LocaleUtil.GetLocaleCalendar(System.TimeZone)">
  30839. @return a calendar for the user locale and time zone
  30840. </member>
  30841. <member name="M:NPOI.Util.LongField.#ctor(System.Int32)">
  30842. <summary>
  30843. construct the <see cref="T:NPOI.Util.LongField"/> with its offset into its containing byte array
  30844. </summary>
  30845. <param name="offset">The offset.</param>
  30846. </member>
  30847. <member name="M:NPOI.Util.LongField.#ctor(System.Int32,System.Int64)">
  30848. <summary>
  30849. construct the LongField with its offset into its containing
  30850. byte array and initialize its value
  30851. </summary>
  30852. <param name="offset">offset of the field within its byte array</param>
  30853. <param name="value">the initial value</param>
  30854. </member>
  30855. <member name="M:NPOI.Util.LongField.#ctor(System.Int32,System.Byte[])">
  30856. <summary>
  30857. Construct the <see cref="T:NPOI.Util.LongField"/> class with its offset into its containing
  30858. byte array and initialize its value from its byte array
  30859. </summary>
  30860. <param name="offset">The offset of the field within its byte array</param>
  30861. <param name="data">the byte array to read the value from</param>
  30862. </member>
  30863. <member name="M:NPOI.Util.LongField.#ctor(System.Int32,System.Int64,System.Byte[])">
  30864. <summary>
  30865. construct the <see cref="T:NPOI.Util.LongField"/> class with its offset into its containing
  30866. byte array, initialize its value, and write the value to a byte
  30867. array
  30868. </summary>
  30869. <param name="offset">offset of the field within its byte array</param>
  30870. <param name="value">the initial value</param>
  30871. <param name="data">the byte array to write the value to</param>
  30872. </member>
  30873. <member name="P:NPOI.Util.LongField.Value">
  30874. <summary>
  30875. Getg or sets the LongField's current value
  30876. </summary>
  30877. <value>The current value</value>
  30878. </member>
  30879. <member name="M:NPOI.Util.LongField.Set(System.Int64,System.Byte[])">
  30880. <summary>
  30881. set the LongField's current value and write it to a byte array
  30882. </summary>
  30883. <param name="value">value to be set</param>
  30884. <param name="data">the byte array to write the value to</param>
  30885. </member>
  30886. <member name="M:NPOI.Util.LongField.ReadFromBytes(System.Byte[])">
  30887. <summary>
  30888. set the value from its offset into an array of bytes
  30889. </summary>
  30890. <param name="data">the byte array from which the value is to be read</param>
  30891. </member>
  30892. <member name="M:NPOI.Util.LongField.ReadFromStream(System.IO.Stream)">
  30893. <summary>
  30894. set the value from an Stream
  30895. </summary>
  30896. <param name="stream">the Stream from which the value is to be</param>
  30897. </member>
  30898. <member name="M:NPOI.Util.LongField.WriteToBytes(System.Byte[])">
  30899. <summary>
  30900. write the value out to an array of bytes at the appropriate offset
  30901. </summary>
  30902. <param name="data">the array of bytes to which the value is to be written</param>
  30903. </member>
  30904. <member name="M:NPOI.Util.LongField.Write(System.Int32,System.Int64,System.Byte[])">
  30905. <summary>
  30906. Same as using the constructor <see cref="T:NPOI.Util.LongField"/> with the same
  30907. parameter list. Avoid creation of an useless object.
  30908. </summary>
  30909. <param name="offset">offset of the field within its byte array</param>
  30910. <param name="value">the initial value</param>
  30911. <param name="data">the byte array to write the value to</param>
  30912. </member>
  30913. <member name="M:NPOI.Util.LongField.ToString">
  30914. <summary>
  30915. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  30916. </summary>
  30917. <returns>
  30918. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  30919. </returns>
  30920. </member>
  30921. <member name="T:NPOI.Util.LZWDecompresser">
  30922. This class provides common functionality for the
  30923. various LZW implementations in the different file
  30924. formats.
  30925. It's currently used by HDGF and HMEF.
  30926. Two good resources on LZW are:
  30927. http://en.wikipedia.org/wiki/LZW
  30928. http://marknelson.us/1989/10/01/lzw-data-compression/
  30929. </member>
  30930. <member name="F:NPOI.Util.LZWDecompresser.maskMeansCompressed">
  30931. Does the mask bit mean it's compressed or uncompressed?
  30932. </member>
  30933. <member name="F:NPOI.Util.LZWDecompresser.codeLengthIncrease">
  30934. How much to append to the code length in the stream
  30935. to Get the real code length? Normally 2 or 3
  30936. </member>
  30937. <member name="F:NPOI.Util.LZWDecompresser.positionIsBigEndian">
  30938. Does the 12 bits of the position Get stored in
  30939. Little Endian or Big Endian form?
  30940. This controls whether a pos+length of 0x12 0x34
  30941. becomes a position of 0x123 or 0x312
  30942. </member>
  30943. <member name="M:NPOI.Util.LZWDecompresser.populateDictionary(System.Byte[])">
  30944. Populates the dictionary, and returns where in it
  30945. to begin writing new codes.
  30946. Generally, if the dictionary is pre-populated, then new
  30947. codes should be placed at the end of that block.
  30948. Equally, if the dictionary is left with all zeros, then
  30949. usually the new codes can go in at the start.
  30950. </member>
  30951. <member name="M:NPOI.Util.LZWDecompresser.adjustDictionaryOffset(System.Int32)">
  30952. Adjusts the position offset if needed when looking
  30953. something up in the dictionary.
  30954. </member>
  30955. <member name="M:NPOI.Util.LZWDecompresser.decompress(System.IO.Stream)">
  30956. Decompresses the given input stream, returning the array of bytes
  30957. of the decompressed input.
  30958. </member>
  30959. <member name="M:NPOI.Util.LZWDecompresser.decompress(System.IO.Stream,System.IO.Stream)">
  30960. Perform a streaming decompression of the input.
  30961. Works by:
  30962. 1) Reading a flag byte, the 8 bits of which tell you if the
  30963. following 8 codes are compressed our un-compressed
  30964. 2) Consider the 8 bits in turn
  30965. 3) If the bit is Set, the next code is un-compressed, so
  30966. add it to the dictionary and output it
  30967. 4) If the bit isn't Set, then read in the length and start
  30968. position in the dictionary, and output the bytes there
  30969. 5) Loop until we've done all 8 bits, then read in the next
  30970. flag byte
  30971. </member>
  30972. <member name="M:NPOI.Util.LZWDecompresser.fromInt(System.Int32)">
  30973. Given an integer, turn it into a java byte, handling
  30974. the wrapping.
  30975. This is a convenience method
  30976. </member>
  30977. <member name="M:NPOI.Util.LZWDecompresser.fromByte(System.Byte)">
  30978. Given a java byte, turn it into an integer between 0
  30979. and 255 (i.e. handle the unwrapping).
  30980. This is a convenience method
  30981. </member>
  30982. <member name="T:NPOI.Util.NullLogger">
  30983. <summary>
  30984. A Logger class that strives to make it as easy as possible for
  30985. developers to write Log calls, while simultaneously making those
  30986. calls as cheap as possible by performing lazy evaluation of the Log
  30987. message.
  30988. @author Marc Johnson (mjohnson at apache dot org)
  30989. @author Glen Stampoultzis (glens at apache.org)
  30990. @author Nicola Ken Barozzi (nicolaken at apache.org)
  30991. </summary>
  30992. </member>
  30993. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object)">
  30994. Log a message
  30995. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30996. @param obj1 The object to Log.
  30997. </member>
  30998. <member name="M:NPOI.Util.NullLogger.Check(System.Int32)">
  30999. Check if a Logger is enabled to Log at the specified level
  31000. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31001. </member>
  31002. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object)">
  31003. Log a message. Lazily appends Object parameters together.
  31004. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31005. @param obj1 first object to place in the message
  31006. @param obj2 second object to place in the message
  31007. </member>
  31008. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object)">
  31009. Log a message. Lazily appends Object parameters together.
  31010. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31011. @param obj1 first Object to place in the message
  31012. @param obj2 second Object to place in the message
  31013. @param obj3 third Object to place in the message
  31014. </member>
  31015. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object)">
  31016. Log a message. Lazily appends Object parameters together.
  31017. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31018. @param obj1 first Object to place in the message
  31019. @param obj2 second Object to place in the message
  31020. @param obj3 third Object to place in the message
  31021. @param obj4 fourth Object to place in the message
  31022. </member>
  31023. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object)">
  31024. Log a message. Lazily appends Object parameters together.
  31025. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31026. @param obj1 first Object to place in the message
  31027. @param obj2 second Object to place in the message
  31028. @param obj3 third Object to place in the message
  31029. @param obj4 fourth Object to place in the message
  31030. @param obj5 fifth Object to place in the message
  31031. </member>
  31032. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  31033. Log a message. Lazily appends Object parameters together.
  31034. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31035. @param obj1 first Object to place in the message
  31036. @param obj2 second Object to place in the message
  31037. @param obj3 third Object to place in the message
  31038. @param obj4 fourth Object to place in the message
  31039. @param obj5 fifth Object to place in the message
  31040. @param obj6 sixth Object to place in the message
  31041. </member>
  31042. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  31043. Log a message. Lazily appends Object parameters together.
  31044. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31045. @param obj1 first Object to place in the message
  31046. @param obj2 second Object to place in the message
  31047. @param obj3 third Object to place in the message
  31048. @param obj4 fourth Object to place in the message
  31049. @param obj5 fifth Object to place in the message
  31050. @param obj6 sixth Object to place in the message
  31051. @param obj7 seventh Object to place in the message
  31052. </member>
  31053. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  31054. Log a message. Lazily appends Object parameters together.
  31055. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31056. @param obj1 first Object to place in the message
  31057. @param obj2 second Object to place in the message
  31058. @param obj3 third Object to place in the message
  31059. @param obj4 fourth Object to place in the message
  31060. @param obj5 fifth Object to place in the message
  31061. @param obj6 sixth Object to place in the message
  31062. @param obj7 seventh Object to place in the message
  31063. @param obj8 eighth Object to place in the message
  31064. </member>
  31065. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Exception)">
  31066. Log a message
  31067. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31068. @param obj1 The object to Log. This is converted to a string.
  31069. @param exception An exception to be Logged
  31070. </member>
  31071. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Exception)">
  31072. Log a message. Lazily appends Object parameters together.
  31073. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31074. @param obj1 first Object to place in the message
  31075. @param obj2 second Object to place in the message
  31076. @param exception An exception to be Logged
  31077. </member>
  31078. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Exception)">
  31079. Log a message. Lazily appends Object parameters together.
  31080. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31081. @param obj1 first Object to place in the message
  31082. @param obj2 second Object to place in the message
  31083. @param obj3 third object to place in the message
  31084. @param exception An error message to be Logged
  31085. </member>
  31086. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  31087. Log a message. Lazily appends Object parameters together.
  31088. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31089. @param obj1 first Object to place in the message
  31090. @param obj2 second Object to place in the message
  31091. @param obj3 third object to place in the message
  31092. @param obj4 fourth object to place in the message
  31093. @param exception An exception to be Logged
  31094. </member>
  31095. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  31096. Log a message. Lazily appends Object parameters together.
  31097. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31098. @param obj1 first Object to place in the message
  31099. @param obj2 second Object to place in the message
  31100. @param obj3 third object to place in the message
  31101. @param obj4 fourth object to place in the message
  31102. @param obj5 fifth object to place in the message
  31103. @param exception An exception to be Logged
  31104. </member>
  31105. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  31106. Log a message. Lazily appends Object parameters together.
  31107. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31108. @param obj1 first Object to place in the message
  31109. @param obj2 second Object to place in the message
  31110. @param obj3 third object to place in the message
  31111. @param obj4 fourth object to place in the message
  31112. @param obj5 fifth object to place in the message
  31113. @param obj6 sixth object to place in the message
  31114. @param exception An exception to be Logged
  31115. </member>
  31116. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  31117. Log a message. Lazily appends Object parameters together.
  31118. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31119. @param obj1 first Object to place in the message
  31120. @param obj2 second Object to place in the message
  31121. @param obj3 third object to place in the message
  31122. @param obj4 fourth object to place in the message
  31123. @param obj5 fifth object to place in the message
  31124. @param obj6 sixth object to place in the message
  31125. @param obj7 seventh object to place in the message
  31126. @param exception An exception to be Logged
  31127. </member>
  31128. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  31129. Log a message. Lazily appends Object parameters together.
  31130. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31131. @param obj1 first Object to place in the message
  31132. @param obj2 second Object to place in the message
  31133. @param obj3 third object to place in the message
  31134. @param obj4 fourth object to place in the message
  31135. @param obj5 fifth object to place in the message
  31136. @param obj6 sixth object to place in the message
  31137. @param obj7 seventh object to place in the message
  31138. @param obj8 eighth object to place in the message
  31139. @param exception An exception to be Logged
  31140. </member>
  31141. <member name="F:NPOI.Util.PngUtils.PNG_FILE_HEADER">
  31142. File header for PNG format.
  31143. </member>
  31144. <member name="M:NPOI.Util.PngUtils.MatchesPngHeader(System.Byte[],System.Int32)">
  31145. Checks if the offset matches the PNG header.
  31146. @param data the data to check.
  31147. @param offset the offset to check at.
  31148. @return {@code true} if the offset matches.
  31149. </member>
  31150. <member name="F:NPOI.Util.POILogFactory._loggers">
  31151. Map of POILogger instances, with classes as keys
  31152. </member>
  31153. <member name="F:NPOI.Util.POILogFactory._nullLogger">
  31154. A common instance of NullLogger, as it does nothing
  31155. we only need the one
  31156. </member>
  31157. <member name="F:NPOI.Util.POILogFactory._loggerClassName">
  31158. The name of the class to use. Initialised the
  31159. first time we need it
  31160. </member>
  31161. <member name="M:NPOI.Util.POILogFactory.#ctor">
  31162. <summary>
  31163. Initializes a new instance of the <see cref="T:NPOI.Util.POILogFactory"/> class.
  31164. </summary>
  31165. </member>
  31166. <member name="M:NPOI.Util.POILogFactory.GetLogger(System.Type)">
  31167. <summary>
  31168. Get a logger, based on a class name
  31169. </summary>
  31170. <param name="type">the class whose name defines the log</param>
  31171. <returns>a POILogger for the specified class</returns>
  31172. </member>
  31173. <member name="M:NPOI.Util.POILogFactory.GetLogger(System.String)">
  31174. <summary>
  31175. Get a logger, based on a String
  31176. </summary>
  31177. <param name="cat">the String that defines the log</param>
  31178. <returns>a POILogger for the specified class</returns>
  31179. </member>
  31180. <member name="M:NPOI.Util.POILogger.#ctor">
  31181. package scope so it cannot be instantiated outside of the util
  31182. package. You need a POILogger? Go to the POILogFactory for one
  31183. </member>
  31184. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object)">
  31185. Log a message
  31186. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31187. @param obj1 The object to Log. This is converted to a string.
  31188. </member>
  31189. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Exception)">
  31190. Log a message
  31191. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31192. @param obj1 The object to Log. This is converted to a string.
  31193. @param exception An exception to be Logged
  31194. </member>
  31195. <member name="M:NPOI.Util.POILogger.Check(System.Int32)">
  31196. Check if a Logger is enabled to Log at the specified level
  31197. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31198. </member>
  31199. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object)">
  31200. Log a message. Lazily appends Object parameters together.
  31201. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31202. @param obj1 first object to place in the message
  31203. @param obj2 second object to place in the message
  31204. </member>
  31205. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object)">
  31206. Log a message. Lazily appends Object parameters together.
  31207. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31208. @param obj1 first Object to place in the message
  31209. @param obj2 second Object to place in the message
  31210. @param obj3 third Object to place in the message
  31211. </member>
  31212. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object)">
  31213. Log a message. Lazily appends Object parameters together.
  31214. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31215. @param obj1 first Object to place in the message
  31216. @param obj2 second Object to place in the message
  31217. @param obj3 third Object to place in the message
  31218. @param obj4 fourth Object to place in the message
  31219. </member>
  31220. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object)">
  31221. Log a message. Lazily appends Object parameters together.
  31222. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31223. @param obj1 first Object to place in the message
  31224. @param obj2 second Object to place in the message
  31225. @param obj3 third Object to place in the message
  31226. @param obj4 fourth Object to place in the message
  31227. @param obj5 fifth Object to place in the message
  31228. </member>
  31229. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  31230. Log a message. Lazily appends Object parameters together.
  31231. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31232. @param obj1 first Object to place in the message
  31233. @param obj2 second Object to place in the message
  31234. @param obj3 third Object to place in the message
  31235. @param obj4 fourth Object to place in the message
  31236. @param obj5 fifth Object to place in the message
  31237. @param obj6 sixth Object to place in the message
  31238. </member>
  31239. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  31240. Log a message. Lazily appends Object parameters together.
  31241. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31242. @param obj1 first Object to place in the message
  31243. @param obj2 second Object to place in the message
  31244. @param obj3 third Object to place in the message
  31245. @param obj4 fourth Object to place in the message
  31246. @param obj5 fifth Object to place in the message
  31247. @param obj6 sixth Object to place in the message
  31248. @param obj7 seventh Object to place in the message
  31249. </member>
  31250. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  31251. Log a message. Lazily appends Object parameters together.
  31252. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31253. @param obj1 first Object to place in the message
  31254. @param obj2 second Object to place in the message
  31255. @param obj3 third Object to place in the message
  31256. @param obj4 fourth Object to place in the message
  31257. @param obj5 fifth Object to place in the message
  31258. @param obj6 sixth Object to place in the message
  31259. @param obj7 seventh Object to place in the message
  31260. @param obj8 eighth Object to place in the message
  31261. </member>
  31262. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Exception)">
  31263. Log an exception, without a message
  31264. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31265. @param exception An exception to be Logged
  31266. </member>
  31267. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Exception)">
  31268. Log a message. Lazily appends Object parameters together.
  31269. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31270. @param obj1 first Object to place in the message
  31271. @param obj2 second Object to place in the message
  31272. @param exception An exception to be Logged
  31273. </member>
  31274. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Exception)">
  31275. Log a message. Lazily appends Object parameters together.
  31276. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31277. @param obj1 first Object to place in the message
  31278. @param obj2 second Object to place in the message
  31279. @param obj3 third object to place in the message
  31280. @param exception An error message to be Logged
  31281. </member>
  31282. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  31283. Log a message. Lazily appends Object parameters together.
  31284. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31285. @param obj1 first Object to place in the message
  31286. @param obj2 second Object to place in the message
  31287. @param obj3 third object to place in the message
  31288. @param obj4 fourth object to place in the message
  31289. @param exception An exception to be Logged
  31290. </member>
  31291. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  31292. Log a message. Lazily appends Object parameters together.
  31293. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31294. @param obj1 first Object to place in the message
  31295. @param obj2 second Object to place in the message
  31296. @param obj3 third object to place in the message
  31297. @param obj4 fourth object to place in the message
  31298. @param obj5 fifth object to place in the message
  31299. @param exception An exception to be Logged
  31300. </member>
  31301. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  31302. Log a message. Lazily appends Object parameters together.
  31303. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31304. @param obj1 first Object to place in the message
  31305. @param obj2 second Object to place in the message
  31306. @param obj3 third object to place in the message
  31307. @param obj4 fourth object to place in the message
  31308. @param obj5 fifth object to place in the message
  31309. @param obj6 sixth object to place in the message
  31310. @param exception An exception to be Logged
  31311. </member>
  31312. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  31313. Log a message. Lazily appends Object parameters together.
  31314. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31315. @param obj1 first Object to place in the message
  31316. @param obj2 second Object to place in the message
  31317. @param obj3 third object to place in the message
  31318. @param obj4 fourth object to place in the message
  31319. @param obj5 fifth object to place in the message
  31320. @param obj6 sixth object to place in the message
  31321. @param obj7 seventh object to place in the message
  31322. @param exception An exception to be Logged
  31323. </member>
  31324. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  31325. Log a message. Lazily appends Object parameters together.
  31326. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  31327. @param obj1 first Object to place in the message
  31328. @param obj2 second Object to place in the message
  31329. @param obj3 third object to place in the message
  31330. @param obj4 fourth object to place in the message
  31331. @param obj5 fifth object to place in the message
  31332. @param obj6 sixth object to place in the message
  31333. @param obj7 seventh object to place in the message
  31334. @param obj8 eighth object to place in the message
  31335. @param exception An exception to be Logged
  31336. </member>
  31337. <member name="M:NPOI.Util.PushbackInputStream.ReadByte">
  31338. <summary>
  31339. Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.
  31340. </summary>
  31341. <returns>
  31342. The unsigned byte cast to an Int32, or -1 if at the end of the stream.
  31343. </returns>
  31344. <exception cref="T:System.NotSupportedException">
  31345. The stream does not support reading.
  31346. </exception>
  31347. <exception cref="T:System.ObjectDisposedException">
  31348. Methods were called after the stream was closed.
  31349. </exception>
  31350. </member>
  31351. <member name="M:NPOI.Util.PushbackInputStream.Unread(System.Int32)">
  31352. <summary>
  31353. Unreads the specified b.
  31354. </summary>
  31355. <param name="b">The b.</param>
  31356. </member>
  31357. <member name="P:NPOI.Util.PushbackInputStream.CanRead">
  31358. <summary>
  31359. When overridden in a derived class, gets a value indicating whether the current stream supports reading.
  31360. </summary>
  31361. <value></value>
  31362. <returns>true if the stream supports reading; otherwise, false.
  31363. </returns>
  31364. </member>
  31365. <member name="M:NPOI.Util.PushbackInputStream.Unread(System.Byte[],System.Int32,System.Int32)">
  31366. <summary>
  31367. Pushes back a portion of an array of bytes by copying it to the front
  31368. of the pushback buffer.
  31369. </summary>
  31370. <param name="b">the byte array to push back.</param>
  31371. <param name="off">the start offset of the data.</param>
  31372. <param name="len">the number of bytes to push back.</param>
  31373. </member>
  31374. <member name="P:NPOI.Util.PushbackInputStream.CanSeek">
  31375. <summary>
  31376. When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
  31377. </summary>
  31378. <value></value>
  31379. <returns>true if the stream supports seeking; otherwise, false.
  31380. </returns>
  31381. </member>
  31382. <member name="P:NPOI.Util.PushbackInputStream.CanWrite">
  31383. <summary>
  31384. When overridden in a derived class, gets a value indicating whether the current stream supports writing.
  31385. </summary>
  31386. <value></value>
  31387. <returns>true if the stream supports writing; otherwise, false.
  31388. </returns>
  31389. </member>
  31390. <member name="P:NPOI.Util.PushbackInputStream.Length">
  31391. <summary>
  31392. When overridden in a derived class, gets the length in bytes of the stream.
  31393. </summary>
  31394. <value></value>
  31395. <returns>
  31396. A long value representing the length of the stream in bytes.
  31397. </returns>
  31398. <exception cref="T:System.NotSupportedException">
  31399. A class derived from Stream does not support seeking.
  31400. </exception>
  31401. <exception cref="T:System.ObjectDisposedException">
  31402. Methods were called after the stream was closed.
  31403. </exception>
  31404. </member>
  31405. <member name="P:NPOI.Util.PushbackInputStream.Position">
  31406. <summary>
  31407. When overridden in a derived class, gets or sets the position within the current stream.
  31408. </summary>
  31409. <value></value>
  31410. <returns>
  31411. The current position within the stream.
  31412. </returns>
  31413. <exception cref="T:System.IO.IOException">
  31414. An I/O error occurs.
  31415. </exception>
  31416. <exception cref="T:System.NotSupportedException">
  31417. The stream does not support seeking.
  31418. </exception>
  31419. <exception cref="T:System.ObjectDisposedException">
  31420. Methods were called after the stream was closed.
  31421. </exception>
  31422. </member>
  31423. <member name="M:NPOI.Util.PushbackInputStream.Close">
  31424. <summary>
  31425. Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.
  31426. </summary>
  31427. </member>
  31428. <member name="M:NPOI.Util.PushbackInputStream.Flush">
  31429. <summary>
  31430. When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.
  31431. </summary>
  31432. <exception cref="T:System.IO.IOException">
  31433. An I/O error occurs.
  31434. </exception>
  31435. </member>
  31436. <member name="M:NPOI.Util.PushbackInputStream.Seek(System.Int64,System.IO.SeekOrigin)">
  31437. <summary>
  31438. When overridden in a derived class, sets the position within the current stream.
  31439. </summary>
  31440. <param name="offset">A byte offset relative to the <paramref name="origin"/> parameter.</param>
  31441. <param name="origin">A value of type <see cref="T:System.IO.SeekOrigin"/> indicating the reference point used to obtain the new position.</param>
  31442. <returns>
  31443. The new position within the current stream.
  31444. </returns>
  31445. <exception cref="T:System.IO.IOException">
  31446. An I/O error occurs.
  31447. </exception>
  31448. <exception cref="T:System.NotSupportedException">
  31449. The stream does not support seeking, such as if the stream is constructed from a pipe or console output.
  31450. </exception>
  31451. <exception cref="T:System.ObjectDisposedException">
  31452. Methods were called after the stream was closed.
  31453. </exception>
  31454. </member>
  31455. <member name="M:NPOI.Util.PushbackInputStream.SetLength(System.Int64)">
  31456. <summary>
  31457. When overridden in a derived class, sets the length of the current stream.
  31458. </summary>
  31459. <param name="value">The desired length of the current stream in bytes.</param>
  31460. <exception cref="T:System.IO.IOException">
  31461. An I/O error occurs.
  31462. </exception>
  31463. <exception cref="T:System.NotSupportedException">
  31464. The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output.
  31465. </exception>
  31466. <exception cref="T:System.ObjectDisposedException">
  31467. Methods were called after the stream was closed.
  31468. </exception>
  31469. </member>
  31470. <member name="M:NPOI.Util.PushbackInputStream.Write(System.Byte[],System.Int32,System.Int32)">
  31471. <summary>
  31472. When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
  31473. </summary>
  31474. <param name="buffer">An array of bytes. This method copies <paramref name="count"/> bytes from <paramref name="buffer"/> to the current stream.</param>
  31475. <param name="offset">The zero-based byte offset in <paramref name="buffer"/> at which to begin copying bytes to the current stream.</param>
  31476. <param name="count">The number of bytes to be written to the current stream.</param>
  31477. <exception cref="T:System.ArgumentException">
  31478. The sum of <paramref name="offset"/> and <paramref name="count"/> is greater than the buffer length.
  31479. </exception>
  31480. <exception cref="T:System.ArgumentNullException">
  31481. <paramref name="buffer"/> is null.
  31482. </exception>
  31483. <exception cref="T:System.ArgumentOutOfRangeException">
  31484. <paramref name="offset"/> or <paramref name="count"/> is negative.
  31485. </exception>
  31486. <exception cref="T:System.IO.IOException">
  31487. An I/O error occurs.
  31488. </exception>
  31489. <exception cref="T:System.NotSupportedException">
  31490. The stream does not support writing.
  31491. </exception>
  31492. <exception cref="T:System.ObjectDisposedException">
  31493. Methods were called after the stream was closed.
  31494. </exception>
  31495. </member>
  31496. <member name="M:NPOI.Util.PushbackInputStream.WriteByte(System.Byte)">
  31497. <summary>
  31498. Writes a byte to the current position in the stream and advances the position within the stream by one byte.
  31499. </summary>
  31500. <param name="value">The byte to write to the stream.</param>
  31501. <exception cref="T:System.IO.IOException">
  31502. An I/O error occurs.
  31503. </exception>
  31504. <exception cref="T:System.NotSupportedException">
  31505. The stream does not support writing, or the stream is already closed.
  31506. </exception>
  31507. <exception cref="T:System.ObjectDisposedException">
  31508. Methods were called after the stream was closed.
  31509. </exception>
  31510. </member>
  31511. <member name="M:NPOI.Util.PushbackStream.ReadByte">
  31512. <summary>
  31513. Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.
  31514. </summary>
  31515. <returns>
  31516. The unsigned byte cast to an Int32, or -1 if at the end of the stream.
  31517. </returns>
  31518. <exception cref="T:System.NotSupportedException">
  31519. The stream does not support reading.
  31520. </exception>
  31521. <exception cref="T:System.ObjectDisposedException">
  31522. Methods were called after the stream was closed.
  31523. </exception>
  31524. </member>
  31525. <member name="M:NPOI.Util.PushbackStream.Read(System.Byte[],System.Int32,System.Int32)">
  31526. <summary>
  31527. When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
  31528. </summary>
  31529. <param name="buffer">An array of bytes. When this method returns, the buffer contains the specified byte array with the values between <paramref name="offset"/> and (<paramref name="offset"/> + <paramref name="count"/> - 1) replaced by the bytes read from the current source.</param>
  31530. <param name="offset">The zero-based byte offset in <paramref name="buffer"/> at which to begin storing the data read from the current stream.</param>
  31531. <param name="count">The maximum number of bytes to be read from the current stream.</param>
  31532. <returns>
  31533. The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.
  31534. </returns>
  31535. <exception cref="T:System.ArgumentException">
  31536. The sum of <paramref name="offset"/> and <paramref name="count"/> is larger than the buffer length.
  31537. </exception>
  31538. <exception cref="T:System.ArgumentNullException">
  31539. <paramref name="buffer"/> is null.
  31540. </exception>
  31541. <exception cref="T:System.ArgumentOutOfRangeException">
  31542. <paramref name="offset"/> or <paramref name="count"/> is negative.
  31543. </exception>
  31544. <exception cref="T:System.IO.IOException">
  31545. An I/O error occurs.
  31546. </exception>
  31547. <exception cref="T:System.NotSupportedException">
  31548. The stream does not support reading.
  31549. </exception>
  31550. <exception cref="T:System.ObjectDisposedException">
  31551. Methods were called after the stream was closed.
  31552. </exception>
  31553. </member>
  31554. <member name="M:NPOI.Util.PushbackStream.Unread(System.Int32)">
  31555. <summary>
  31556. Unreads the specified b.
  31557. </summary>
  31558. <param name="b">The b.</param>
  31559. </member>
  31560. <member name="P:NPOI.Util.PushbackStream.CanRead">
  31561. <summary>
  31562. When overridden in a derived class, gets a value indicating whether the current stream supports reading.
  31563. </summary>
  31564. <value></value>
  31565. <returns>true if the stream supports reading; otherwise, false.
  31566. </returns>
  31567. </member>
  31568. <member name="P:NPOI.Util.PushbackStream.CanSeek">
  31569. <summary>
  31570. When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
  31571. </summary>
  31572. <value></value>
  31573. <returns>true if the stream supports seeking; otherwise, false.
  31574. </returns>
  31575. </member>
  31576. <member name="P:NPOI.Util.PushbackStream.CanWrite">
  31577. <summary>
  31578. When overridden in a derived class, gets a value indicating whether the current stream supports writing.
  31579. </summary>
  31580. <value></value>
  31581. <returns>true if the stream supports writing; otherwise, false.
  31582. </returns>
  31583. </member>
  31584. <member name="P:NPOI.Util.PushbackStream.Length">
  31585. <summary>
  31586. When overridden in a derived class, gets the length in bytes of the stream.
  31587. </summary>
  31588. <value></value>
  31589. <returns>
  31590. A long value representing the length of the stream in bytes.
  31591. </returns>
  31592. <exception cref="T:System.NotSupportedException">
  31593. A class derived from Stream does not support seeking.
  31594. </exception>
  31595. <exception cref="T:System.ObjectDisposedException">
  31596. Methods were called after the stream was closed.
  31597. </exception>
  31598. </member>
  31599. <member name="P:NPOI.Util.PushbackStream.Position">
  31600. <summary>
  31601. When overridden in a derived class, gets or sets the position within the current stream.
  31602. </summary>
  31603. <value></value>
  31604. <returns>
  31605. The current position within the stream.
  31606. </returns>
  31607. <exception cref="T:System.IO.IOException">
  31608. An I/O error occurs.
  31609. </exception>
  31610. <exception cref="T:System.NotSupportedException">
  31611. The stream does not support seeking.
  31612. </exception>
  31613. <exception cref="T:System.ObjectDisposedException">
  31614. Methods were called after the stream was closed.
  31615. </exception>
  31616. </member>
  31617. <member name="M:NPOI.Util.PushbackStream.Close">
  31618. <summary>
  31619. Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.
  31620. </summary>
  31621. </member>
  31622. <member name="M:NPOI.Util.PushbackStream.Flush">
  31623. <summary>
  31624. When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.
  31625. </summary>
  31626. <exception cref="T:System.IO.IOException">
  31627. An I/O error occurs.
  31628. </exception>
  31629. </member>
  31630. <member name="M:NPOI.Util.PushbackStream.Seek(System.Int64,System.IO.SeekOrigin)">
  31631. <summary>
  31632. When overridden in a derived class, sets the position within the current stream.
  31633. </summary>
  31634. <param name="offset">A byte offset relative to the <paramref name="origin"/> parameter.</param>
  31635. <param name="origin">A value of type <see cref="T:System.IO.SeekOrigin"/> indicating the reference point used to obtain the new position.</param>
  31636. <returns>
  31637. The new position within the current stream.
  31638. </returns>
  31639. <exception cref="T:System.IO.IOException">
  31640. An I/O error occurs.
  31641. </exception>
  31642. <exception cref="T:System.NotSupportedException">
  31643. The stream does not support seeking, such as if the stream is constructed from a pipe or console output.
  31644. </exception>
  31645. <exception cref="T:System.ObjectDisposedException">
  31646. Methods were called after the stream was closed.
  31647. </exception>
  31648. </member>
  31649. <member name="M:NPOI.Util.PushbackStream.SetLength(System.Int64)">
  31650. <summary>
  31651. When overridden in a derived class, sets the length of the current stream.
  31652. </summary>
  31653. <param name="value">The desired length of the current stream in bytes.</param>
  31654. <exception cref="T:System.IO.IOException">
  31655. An I/O error occurs.
  31656. </exception>
  31657. <exception cref="T:System.NotSupportedException">
  31658. The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output.
  31659. </exception>
  31660. <exception cref="T:System.ObjectDisposedException">
  31661. Methods were called after the stream was closed.
  31662. </exception>
  31663. </member>
  31664. <member name="M:NPOI.Util.PushbackStream.Write(System.Byte[],System.Int32,System.Int32)">
  31665. <summary>
  31666. When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
  31667. </summary>
  31668. <param name="buffer">An array of bytes. This method copies <paramref name="count"/> bytes from <paramref name="buffer"/> to the current stream.</param>
  31669. <param name="offset">The zero-based byte offset in <paramref name="buffer"/> at which to begin copying bytes to the current stream.</param>
  31670. <param name="count">The number of bytes to be written to the current stream.</param>
  31671. <exception cref="T:System.ArgumentException">
  31672. The sum of <paramref name="offset"/> and <paramref name="count"/> is greater than the buffer length.
  31673. </exception>
  31674. <exception cref="T:System.ArgumentNullException">
  31675. <paramref name="buffer"/> is null.
  31676. </exception>
  31677. <exception cref="T:System.ArgumentOutOfRangeException">
  31678. <paramref name="offset"/> or <paramref name="count"/> is negative.
  31679. </exception>
  31680. <exception cref="T:System.IO.IOException">
  31681. An I/O error occurs.
  31682. </exception>
  31683. <exception cref="T:System.NotSupportedException">
  31684. The stream does not support writing.
  31685. </exception>
  31686. <exception cref="T:System.ObjectDisposedException">
  31687. Methods were called after the stream was closed.
  31688. </exception>
  31689. </member>
  31690. <member name="M:NPOI.Util.PushbackStream.WriteByte(System.Byte)">
  31691. <summary>
  31692. Writes a byte to the current position in the stream and advances the position within the stream by one byte.
  31693. </summary>
  31694. <param name="value">The byte to write to the stream.</param>
  31695. <exception cref="T:System.IO.IOException">
  31696. An I/O error occurs.
  31697. </exception>
  31698. <exception cref="T:System.NotSupportedException">
  31699. The stream does not support writing, or the stream is already closed.
  31700. </exception>
  31701. <exception cref="T:System.ObjectDisposedException">
  31702. Methods were called after the stream was closed.
  31703. </exception>
  31704. </member>
  31705. <member name="T:NPOI.Util.RecordFormatException">
  31706. A common exception thrown by our binary format Parsers
  31707. (especially HSSF and DDF), when they hit invalid
  31708. format or data when Processing a record.
  31709. </member>
  31710. <member name="T:NPOI.Util.RLEDecompressingInputStream">
  31711. <summary>
  31712. Wrapper of InputStream which provides Run Length Encoding (RLE)
  31713. decompression on the fly. Uses MS-OVBA decompression algorithm. See
  31714. http://download.microsoft.com/download/2/4/8/24862317-78F0-4C4B-B355-C7B2C1D997DB/[MS-OVBA].pdf
  31715. </summary>
  31716. <seealso cref="T:NPOI.Util.InputStream" />
  31717. </member>
  31718. <member name="F:NPOI.Util.RLEDecompressingInputStream.POWER2">
  31719. <summary>
  31720. Bitmasks for performance
  31721. </summary>
  31722. </member>
  31723. <member name="F:NPOI.Util.RLEDecompressingInputStream.input">
  31724. <summary>
  31725. the wrapped inputstream
  31726. </summary>
  31727. </member>
  31728. <member name="F:NPOI.Util.RLEDecompressingInputStream.buf">
  31729. <summary>
  31730. a byte buffer with size 4096 for storing a single chunk
  31731. </summary>
  31732. </member>
  31733. <member name="F:NPOI.Util.RLEDecompressingInputStream.pos">
  31734. <summary>
  31735. the current position in the byte buffer for Reading
  31736. </summary>
  31737. </member>
  31738. <member name="F:NPOI.Util.RLEDecompressingInputStream.len">
  31739. <summary>
  31740. the number of bytes in the byte buffer
  31741. </summary>
  31742. </member>
  31743. <member name="M:NPOI.Util.RLEDecompressingInputStream.#ctor(System.IO.Stream)">
  31744. <summary>
  31745. Creates a new wrapper RLE Decompression InputStream.
  31746. </summary>
  31747. <param name="input">in The stream to wrap with the RLE Decompression</param>
  31748. <exception cref="T:System.IO.IOException"></exception>
  31749. </member>
  31750. <!-- Badly formed XML comment ignored for member "M:NPOI.Util.RLEDecompressingInputStream.ReadChunk" -->
  31751. <member name="M:NPOI.Util.RLEDecompressingInputStream.GetCopyLenBits(System.Int32)">
  31752. <summary>
  31753. Helper method to determine how many bits in the CopyToken are used for the CopyLength.
  31754. </summary>
  31755. <param name="offset"></param>
  31756. <returns>returns the number of bits in the copy token (a value between 4 and 12)</returns>
  31757. </member>
  31758. <member name="M:NPOI.Util.RLEDecompressingInputStream.ReadShort">
  31759. <summary>
  31760. Convenience method for read a 2-bytes short in little endian encoding.
  31761. </summary>
  31762. <returns>short value from the stream, -1 if end of stream is reached</returns>
  31763. <exception cref="T:System.IO.IOException"></exception>
  31764. </member>
  31765. <member name="M:NPOI.Util.RLEDecompressingInputStream.ReadInt">
  31766. <summary>
  31767. Convenience method for read a 4-bytes int in little endian encoding.
  31768. </summary>
  31769. <returns>integer value from the stream, -1 if end of stream is reached</returns>
  31770. <exception cref="T:System.IO.IOException"></exception>
  31771. </member>
  31772. <member name="M:NPOI.Util.ShortField.#ctor(System.Int32)">
  31773. <summary>
  31774. construct the ShortField with its offset into its containing
  31775. byte array
  31776. </summary>
  31777. <param name="offset">offset of the field within its byte array</param>
  31778. <exception cref="T:System.IndexOutOfRangeException">if offset is negative</exception>
  31779. </member>
  31780. <member name="M:NPOI.Util.ShortField.#ctor(System.Int32,System.Int16)">
  31781. <summary>
  31782. construct the ShortField with its offset into its containing byte array and initialize its value
  31783. </summary>
  31784. <param name="offset">offset of the field within its byte array</param>
  31785. <param name="value">the initial value</param>
  31786. <exception cref="T:System.IndexOutOfRangeException">if offset is negative</exception>
  31787. </member>
  31788. <member name="M:NPOI.Util.ShortField.#ctor(System.Int32,System.Byte[])">
  31789. <summary>
  31790. Construct the ShortField with its offset into its containing
  31791. byte array and initialize its value from its byte array
  31792. </summary>
  31793. <param name="offset">offset of the field within its byte array</param>
  31794. <param name="data">the byte array to read the value from</param>
  31795. <exception cref="T:System.IndexOutOfRangeException">if the offset is not
  31796. within the range of 0..(data.length - 1)</exception>
  31797. </member>
  31798. <member name="M:NPOI.Util.ShortField.#ctor(System.Int32,System.Int16,System.Byte[]@)">
  31799. <summary>
  31800. construct the ShortField with its offset into its containing
  31801. byte array, initialize its value, and write its value to its
  31802. byte array
  31803. </summary>
  31804. <param name="offset">offset of the field within its byte array</param>
  31805. <param name="value">the initial value</param>
  31806. <param name="data">the byte array to write the value to</param>
  31807. <exception cref="T:System.IndexOutOfRangeException">if offset is negative</exception>
  31808. </member>
  31809. <member name="P:NPOI.Util.ShortField.Value">
  31810. <summary>
  31811. Gets or sets the value.
  31812. </summary>
  31813. <value>The value.</value>
  31814. </member>
  31815. <member name="M:NPOI.Util.ShortField.Set(System.Int16,System.Byte[]@)">
  31816. <summary>
  31817. set the ShortField's current value and write it to a byte array
  31818. </summary>
  31819. <param name="value">value to be set</param>
  31820. <param name="data">the byte array to write the value to</param>
  31821. <exception cref="T:System.IndexOutOfRangeException">if the offset is out
  31822. of range</exception>
  31823. </member>
  31824. <member name="M:NPOI.Util.ShortField.ReadFromBytes(System.Byte[])">
  31825. <summary>
  31826. set the value from its offset into an array of bytes
  31827. </summary>
  31828. <param name="data">the byte array from which the value is to be read</param>
  31829. <exception cref="T:System.IndexOutOfRangeException">if the offset is out
  31830. of range</exception>
  31831. </member>
  31832. <member name="M:NPOI.Util.ShortField.ReadFromStream(System.IO.Stream)">
  31833. <summary>
  31834. set the value from an Stream
  31835. </summary>
  31836. <param name="stream">the Stream from which the value is to be
  31837. read</param>
  31838. <exception cref="T:System.IO.IOException">if an IOException is thrown from reading
  31839. the Stream</exception>
  31840. <exception cref="T:NPOI.Util.BufferUnderrunException">if there is not enough data
  31841. available from the Stream</exception>
  31842. </member>
  31843. <member name="M:NPOI.Util.ShortField.WriteToBytes(System.Byte[])">
  31844. <summary>
  31845. write the value out to an array of bytes at the appropriate
  31846. offset
  31847. </summary>
  31848. <param name="data">the array of bytes to which the value is to be
  31849. written</param>
  31850. <exception cref="T:System.IndexOutOfRangeException">if the offset is out
  31851. of range</exception>
  31852. </member>
  31853. <member name="M:NPOI.Util.ShortField.Write(System.Int32,System.Int16,System.Byte[]@)">
  31854. <summary>
  31855. Same as using the constructor <see cref="T:NPOI.Util.ShortField"/> with the same
  31856. parameter list. Avoid creation of an useless object.
  31857. </summary>
  31858. <param name="offset">offset of the field within its byte array</param>
  31859. <param name="value">the initial value</param>
  31860. <param name="data">the byte array to write the value to</param>
  31861. </member>
  31862. <member name="M:NPOI.Util.ShortField.ToString">
  31863. <summary>
  31864. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  31865. </summary>
  31866. <returns>
  31867. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  31868. </returns>
  31869. </member>
  31870. <member name="T:NPOI.Util.ShortList">
  31871. <summary>
  31872. A List of short's; as full an implementation of the java.Util.List
  31873. interface as possible, with an eye toward minimal creation of
  31874. objects
  31875. the mimicry of List is as follows:
  31876. <ul>
  31877. <li> if possible, operations designated 'optional' in the List
  31878. interface are attempted</li>
  31879. <li> wherever the List interface refers to an Object, substitute
  31880. short</li>
  31881. <li> wherever the List interface refers to a Collection or List,
  31882. substitute shortList</li>
  31883. </ul>
  31884. the mimicry is not perfect, however:
  31885. <ul>
  31886. <li> operations involving Iterators or ListIterators are not
  31887. supported</li>
  31888. <li> Remove(Object) becomes RemoveValue to distinguish it from
  31889. Remove(short index)</li>
  31890. <li> subList is not supported</li>
  31891. </ul>
  31892. </summary>
  31893. </member>
  31894. <member name="M:NPOI.Util.ShortList.#ctor">
  31895. <summary>
  31896. create an shortList of default size
  31897. </summary>
  31898. </member>
  31899. <member name="M:NPOI.Util.ShortList.#ctor(NPOI.Util.ShortList)">
  31900. <summary>
  31901. create a copy of an existing shortList
  31902. </summary>
  31903. <param name="list">the existing shortList</param>
  31904. </member>
  31905. <member name="M:NPOI.Util.ShortList.#ctor(System.Int32)">
  31906. <summary>
  31907. create an shortList with a predefined Initial size
  31908. </summary>
  31909. <param name="InitialCapacity">the size for the internal array</param>
  31910. </member>
  31911. <member name="M:NPOI.Util.ShortList.Add(System.Int32,System.Int16)">
  31912. <summary>
  31913. add the specfied value at the specified index
  31914. </summary>
  31915. <param name="index">the index where the new value is to be Added</param>
  31916. <param name="value">the new value</param>
  31917. </member>
  31918. <member name="M:NPOI.Util.ShortList.Add(System.Int16)">
  31919. <summary>
  31920. Appends the specified element to the end of this list
  31921. </summary>
  31922. <param name="value">element to be Appended to this list.</param>
  31923. <returns>return true (as per the general contract of the Collection.add method).</returns>
  31924. </member>
  31925. <member name="M:NPOI.Util.ShortList.AddAll(NPOI.Util.ShortList)">
  31926. <summary>
  31927. Appends all of the elements in the specified collection to the
  31928. end of this list, in the order that they are returned by the
  31929. specified collection's iterator. The behavior of this
  31930. operation is unspecified if the specified collection is
  31931. modified while the operation is in progress. (Note that this
  31932. will occur if the specified collection is this list, and it's
  31933. nonempty.)
  31934. </summary>
  31935. <param name="c">collection whose elements are to be Added to this list.</param>
  31936. <returns>return true if this list Changed as a result of the call.</returns>
  31937. </member>
  31938. <member name="M:NPOI.Util.ShortList.AddAll(System.Int32,NPOI.Util.ShortList)">
  31939. <summary>
  31940. Inserts all of the elements in the specified collection into
  31941. this list at the specified position. Shifts the element
  31942. currently at that position (if any) and any subsequent elements
  31943. to the right (increases their indices). The new elements will
  31944. appear in this list in the order that they are returned by the
  31945. specified collection's iterator. The behavior of this
  31946. operation is unspecified if the specified collection is
  31947. modified while the operation is in progress. (Note that this
  31948. will occur if the specified collection is this list, and it's
  31949. nonempty.)
  31950. </summary>
  31951. <param name="index">index at which to insert first element from the specified collection.</param>
  31952. <param name="c">elements to be inserted into this list.</param>
  31953. <returns>return true if this list Changed as a result of the call.</returns>
  31954. <exception cref="T:System.IndexOutOfRangeException"> if the index is out of range (index &lt; 0 || index &gt; size())</exception>
  31955. </member>
  31956. <member name="M:NPOI.Util.ShortList.Clear">
  31957. <summary>
  31958. Removes all of the elements from this list. This list will be
  31959. empty After this call returns (unless it throws an exception).
  31960. </summary>
  31961. </member>
  31962. <member name="M:NPOI.Util.ShortList.Contains(System.Int16)">
  31963. <summary>
  31964. Returns true if this list Contains the specified element. More
  31965. formally, returns true if and only if this list Contains at
  31966. least one element e such that o == e
  31967. </summary>
  31968. <param name="o">element whose presence in this list is to be Tested.</param>
  31969. <returns>return true if this list Contains the specified element.</returns>
  31970. </member>
  31971. <member name="M:NPOI.Util.ShortList.ContainsAll(NPOI.Util.ShortList)">
  31972. <summary>
  31973. Returns true if this list Contains all of the elements of the specified collection.
  31974. </summary>
  31975. <param name="c">collection to be Checked for Containment in this list.</param>
  31976. <returns>return true if this list Contains all of the elements of the specified collection.</returns>
  31977. </member>
  31978. <member name="M:NPOI.Util.ShortList.Equals(System.Object)">
  31979. <summary>
  31980. Compares the specified object with this list for Equality.
  31981. Returns true if and only if the specified object is also a
  31982. list, both lists have the same size, and all corresponding
  31983. pairs of elements in the two lists are Equal. (Two elements e1
  31984. and e2 are equal if e1 == e2.) In other words, two lists are
  31985. defined to be equal if they contain the same elements in the
  31986. same order. This defInition ensures that the Equals method
  31987. works properly across different implementations of the List
  31988. interface.
  31989. </summary>
  31990. <param name="o">the object to be Compared for Equality with this list.</param>
  31991. <returns>return true if the specified object is equal to this list.</returns>
  31992. </member>
  31993. <member name="M:NPOI.Util.ShortList.Get(System.Int32)">
  31994. <summary>
  31995. Returns the element at the specified position in this list.
  31996. </summary>
  31997. <param name="index">index of element to return.</param>
  31998. <returns>return the element at the specified position in this list.</returns>
  31999. </member>
  32000. <member name="M:NPOI.Util.ShortList.GetHashCode">
  32001. <summary>
  32002. Returns the hash code value for this list. The hash code of a
  32003. list is defined to be the result of the following calculation:
  32004. <code>
  32005. hashCode = 1;
  32006. Iterator i = list.Iterator();
  32007. while (i.HasNext()) {
  32008. Object obj = i.Next();
  32009. hashCode = 31*hashCode + (obj==null ? 0 : obj.HashCode());
  32010. }
  32011. </code>
  32012. This ensures that list1.Equals(list2) implies that
  32013. list1.HashCode()==list2.HashCode() for any two lists, list1 and
  32014. list2, as required by the general contract of Object.HashCode.
  32015. </summary>
  32016. <returns>return the hash code value for this list.</returns>
  32017. </member>
  32018. <member name="M:NPOI.Util.ShortList.IndexOf(System.Int16)">
  32019. <summary>
  32020. Returns the index in this list of the first occurrence of the
  32021. specified element, or -1 if this list does not contain this
  32022. element. More formally, returns the lowest index i such that
  32023. (o == Get(i)), or -1 if there is no such index.
  32024. </summary>
  32025. <param name="o">element to search for.</param>
  32026. <returns>the index in this list of the first occurrence of the
  32027. specified element, or -1 if this list does not contain
  32028. this element.
  32029. </returns>
  32030. </member>
  32031. <member name="M:NPOI.Util.ShortList.IsEmpty">
  32032. <summary>
  32033. Returns true if this list Contains no elements.
  32034. </summary>
  32035. <returns>return true if this list Contains no elements.</returns>
  32036. </member>
  32037. <member name="M:NPOI.Util.ShortList.LastIndexOf(System.Int16)">
  32038. <summary>
  32039. Returns the index in this list of the last occurrence of the
  32040. specified element, or -1 if this list does not contain this
  32041. element. More formally, returns the highest index i such that
  32042. (o == Get(i)), or -1 if there is no such index.
  32043. </summary>
  32044. <param name="o">element to search for.</param>
  32045. <returns>return the index in this list of the last occurrence of the
  32046. specified element, or -1 if this list does not contain this element.</returns>
  32047. </member>
  32048. <member name="M:NPOI.Util.ShortList.Remove(System.Int32)">
  32049. <summary>
  32050. Removes the element at the specified position in this list.
  32051. Shifts any subsequent elements to the left (subtracts one from
  32052. their indices). Returns the element that was Removed from the
  32053. list.
  32054. </summary>
  32055. <param name="index">the index of the element to Removed.</param>
  32056. <returns>return the element previously at the specified position.</returns>
  32057. </member>
  32058. <member name="M:NPOI.Util.ShortList.RemoveValue(System.Int16)">
  32059. <summary>
  32060. Removes the first occurrence in this list of the specified
  32061. element (optional operation). If this list does not contain
  32062. the element, it is unChanged. More formally, Removes the
  32063. element with the lowest index i such that (o.Equals(get(i)))
  32064. (if such an element exists).
  32065. </summary>
  32066. <param name="o">element to be Removed from this list, if present.</param>
  32067. <returns>return true if this list Contained the specified element.</returns>
  32068. </member>
  32069. <member name="M:NPOI.Util.ShortList.RemoveAll(NPOI.Util.ShortList)">
  32070. <summary>
  32071. Removes from this list all the elements that are Contained in the specified collection
  32072. </summary>
  32073. <param name="c">collection that defines which elements will be removed from this list.</param>
  32074. <returns>return true if this list Changed as a result of the call.</returns>
  32075. </member>
  32076. <member name="M:NPOI.Util.ShortList.RetainAll(NPOI.Util.ShortList)">
  32077. <summary>
  32078. Retains only the elements in this list that are Contained in
  32079. the specified collection. In other words, Removes from this
  32080. list all the elements that are not Contained in the specified
  32081. collection.
  32082. </summary>
  32083. <param name="c">collection that defines which elements this Set will retain.</param>
  32084. <returns>return true if this list Changed as a result of the call.</returns>
  32085. </member>
  32086. <member name="M:NPOI.Util.ShortList.Set(System.Int32,System.Int16)">
  32087. <summary>
  32088. Replaces the element at the specified position in this list with the specified element
  32089. </summary>
  32090. <param name="index">index of element to Replace.</param>
  32091. <param name="element">element to be stored at the specified position.</param>
  32092. <returns>return the element previously at the specified position.</returns>
  32093. </member>
  32094. <member name="M:NPOI.Util.ShortList.Size">
  32095. <summary>
  32096. Returns the number of elements in this list. If this list
  32097. Contains more than Int32.MaxValue elements, returns
  32098. Int32.MaxValue.
  32099. </summary>
  32100. <returns>return the number of elements in this shortList</returns>
  32101. </member>
  32102. <member name="P:NPOI.Util.ShortList.Count">
  32103. <summary>
  32104. the number of elements in this shortList
  32105. </summary>
  32106. </member>
  32107. <member name="M:NPOI.Util.ShortList.ToArray">
  32108. <summary>
  32109. Returns an array Containing all of the elements in this list in
  32110. proper sequence. Obeys the general contract of the
  32111. Collection.ToArray method.
  32112. </summary>
  32113. <returns>an array Containing all of the elements in this list in
  32114. proper sequence.</returns>
  32115. </member>
  32116. <member name="M:NPOI.Util.ShortList.ToArray(System.Int16[])">
  32117. <summary>
  32118. Returns an array Containing all of the elements in this list in
  32119. proper sequence. Obeys the general contract of the
  32120. Collection.ToArray(Object[]) method.
  32121. </summary>
  32122. <param name="a">the array into which the elements of this list are to
  32123. be stored, if it is big enough; otherwise, a new array
  32124. is allocated for this purpose.</param>
  32125. <returns>return an array Containing the elements of this list.</returns>
  32126. </member>
  32127. <member name="T:NPOI.Util.StringUtil">
  32128. <summary>
  32129. Title: String Utility Description: Collection of string handling utilities
  32130. @author Andrew C. Oliver
  32131. @author Sergei Kozello (sergeikozello at mail.ru)
  32132. @author Toshiaki Kamoshida (kamoshida.toshiaki at future dot co dot jp)
  32133. @since May 10, 2002
  32134. @version 1.0
  32135. </summary>
  32136. </member>
  32137. <member name="M:NPOI.Util.StringUtil.#ctor">
  32138. Constructor for the StringUtil object
  32139. </member>
  32140. <member name="M:NPOI.Util.StringUtil.GetFromUnicodeLE(System.Byte[],System.Int32,System.Int32)">
  32141. <summary>
  32142. Given a byte array of 16-bit unicode characters in Little Endian
  32143. Format (most important byte last), return a Java String representation
  32144. of it.
  32145. { 0x16, 0x00 } -0x16
  32146. </summary>
  32147. <param name="str">the byte array to be converted</param>
  32148. <param name="offset">the initial offset into the
  32149. byte array. it is assumed that string[ offset ] and string[ offset + 1 ] contain the first 16-bit unicode character</param>
  32150. <param name="len">the Length of the string</param>
  32151. <returns>the converted string</returns>
  32152. </member>
  32153. <member name="M:NPOI.Util.StringUtil.GetFromUnicodeLE(System.Byte[])">
  32154. <summary>
  32155. Given a byte array of 16-bit unicode characters in little endian
  32156. Format (most important byte last), return a Java String representation
  32157. of it.
  32158. { 0x16, 0x00 } -0x16
  32159. </summary>
  32160. <param name="str">the byte array to be converted</param>
  32161. <returns>the converted string</returns>
  32162. </member>
  32163. <member name="M:NPOI.Util.StringUtil.GetToUnicodeLE(System.String)">
  32164. Convert String to 16-bit unicode characters in little endian format
  32165. @param string the string
  32166. @return the byte array of 16-bit unicode characters
  32167. </member>
  32168. <member name="M:NPOI.Util.StringUtil.GetFromUnicodeBE(System.Byte[],System.Int32,System.Int32)">
  32169. <summary>
  32170. Given a byte array of 16-bit unicode characters in big endian
  32171. Format (most important byte first), return a Java String representation
  32172. of it.
  32173. { 0x00, 0x16 } -0x16
  32174. </summary>
  32175. <param name="str">the byte array to be converted</param>
  32176. <param name="offset">the initial offset into the
  32177. byte array. it is assumed that string[ offset ] and string[ offset + 1 ] contain the first 16-bit unicode character</param>
  32178. <param name="len">the Length of the string</param>
  32179. <returns> the converted string</returns>
  32180. </member>
  32181. <member name="M:NPOI.Util.StringUtil.GetFromUnicodeBE(System.Byte[])">
  32182. <summary>
  32183. Given a byte array of 16-bit unicode characters in big endian
  32184. Format (most important byte first), return a Java String representation
  32185. of it.
  32186. { 0x00, 0x16 } -0x16
  32187. </summary>
  32188. <param name="str">the byte array to be converted</param>
  32189. <returns>the converted string</returns>
  32190. </member>
  32191. <member name="M:NPOI.Util.StringUtil.GetFromCompressedUnicode(System.Byte[],System.Int32,System.Int32)">
  32192. <summary>
  32193. Read 8 bit data (in IsO-8859-1 codepage) into a (unicode) Java
  32194. String and return.
  32195. (In Excel terms, read compressed 8 bit unicode as a string)
  32196. </summary>
  32197. <param name="str">byte array to read</param>
  32198. <param name="offset">offset to read byte array</param>
  32199. <param name="len">Length to read byte array</param>
  32200. <returns>generated String instance by reading byte array</returns>
  32201. </member>
  32202. <member name="M:NPOI.Util.StringUtil.PutCompressedUnicode(System.String,System.Byte[],System.Int32)">
  32203. <summary>
  32204. Takes a unicode (java) string, and returns it as 8 bit data (in IsO-8859-1
  32205. codepage).
  32206. (In Excel terms, write compressed 8 bit unicode)
  32207. </summary>
  32208. <param name="input">the String containing the data to be written</param>
  32209. <param name="output">the byte array to which the data Is to be written</param>
  32210. <param name="offset">an offset into the byte arrat at which the data Is start when written</param>
  32211. </member>
  32212. <member name="M:NPOI.Util.StringUtil.PutUnicodeLE(System.String,System.Byte[],System.Int32)">
  32213. <summary>
  32214. Takes a unicode string, and returns it as little endian (most
  32215. important byte last) bytes in the supplied byte array.
  32216. (In Excel terms, write uncompressed unicode)
  32217. </summary>
  32218. <param name="input">the String containing the unicode data to be written</param>
  32219. <param name="output">the byte array to hold the uncompressed unicode, should be twice the Length of the String</param>
  32220. <param name="offset">the offset to start writing into the byte array</param>
  32221. </member>
  32222. <member name="M:NPOI.Util.StringUtil.PutUnicodeBE(System.String,System.Byte[],System.Int32)">
  32223. <summary>
  32224. Takes a unicode string, and returns it as big endian (most
  32225. important byte first) bytes in the supplied byte array.
  32226. (In Excel terms, write uncompressed unicode)
  32227. </summary>
  32228. <param name="input">the String containing the unicode data to be written</param>
  32229. <param name="output">the byte array to hold the uncompressed unicode, should be twice the Length of the String.</param>
  32230. <param name="offset">the offset to start writing into the byte array</param>
  32231. </member>
  32232. <member name="M:NPOI.Util.StringUtil.GetPreferredEncoding">
  32233. <summary>
  32234. Gets the preferred encoding.
  32235. </summary>
  32236. <returns>the encoding we want to use, currently hardcoded to IsO-8859-1</returns>
  32237. </member>
  32238. <member name="M:NPOI.Util.StringUtil.HasMultibyte(System.String)">
  32239. <summary>
  32240. check the parameter Has multibyte character
  32241. </summary>
  32242. <param name="value"> string to check</param>
  32243. <returns>
  32244. <c>true</c> if Has at least one multibyte character; otherwise, <c>false</c>.
  32245. </returns>
  32246. </member>
  32247. <member name="M:NPOI.Util.StringUtil.ReadUnicodeString(NPOI.Util.ILittleEndianInput)">
  32248. InputStream <c>in</c> is expected to contain:
  32249. <ol>
  32250. <li>ushort nChars</li>
  32251. <li>byte is16BitFlag</li>
  32252. <li>byte[]/char[] characterData</li>
  32253. </ol>
  32254. For this encoding, the is16BitFlag is always present even if nChars==0.
  32255. </member>
  32256. <member name="M:NPOI.Util.StringUtil.ReadUnicodeString(NPOI.Util.ILittleEndianInput,System.Int32)">
  32257. InputStream <c>in</c> is expected to contain:
  32258. <ol>
  32259. <li>byte is16BitFlag</li>
  32260. <li>byte[]/char[] characterData</li>
  32261. </ol>
  32262. For this encoding, the is16BitFlag is always present even if nChars==0.
  32263. <br/>
  32264. This method should be used when the nChars field is <em>not</em> stored
  32265. as a ushort immediately before the is16BitFlag. Otherwise, {@link
  32266. #readUnicodeString(LittleEndianInput)} can be used.
  32267. </member>
  32268. <member name="M:NPOI.Util.StringUtil.WriteUnicodeString(NPOI.Util.ILittleEndianOutput,System.String)">
  32269. OutputStream <c>out</c> will get:
  32270. <ol>
  32271. <li>ushort nChars</li>
  32272. <li>byte is16BitFlag</li>
  32273. <li>byte[]/char[] characterData</li>
  32274. </ol>
  32275. For this encoding, the is16BitFlag is always present even if nChars==0.
  32276. </member>
  32277. <member name="M:NPOI.Util.StringUtil.WriteUnicodeStringFlagAndData(NPOI.Util.ILittleEndianOutput,System.String)">
  32278. OutputStream <c>out</c> will get:
  32279. <ol>
  32280. <li>byte is16BitFlag</li>
  32281. <li>byte[]/char[] characterData</li>
  32282. </ol>
  32283. For this encoding, the is16BitFlag is always present even if nChars==0.
  32284. <br/>
  32285. This method should be used when the nChars field is <em>not</em> stored
  32286. as a ushort immediately before the is16BitFlag. Otherwise, {@link
  32287. #writeUnicodeString(LittleEndianOutput, String)} can be used.
  32288. </member>
  32289. <member name="M:NPOI.Util.StringUtil.GetEncodedSize(System.String)">
  32290. <summary>
  32291. Gets the number of bytes that would be written by WriteUnicodeString(LittleEndianOutput, String)
  32292. </summary>
  32293. <param name="value">The value.</param>
  32294. <returns></returns>
  32295. </member>
  32296. <member name="M:NPOI.Util.StringUtil.IsUnicodeString(System.String)">
  32297. <summary>
  32298. Checks to see if a given String needs to be represented as Unicode
  32299. </summary>
  32300. <param name="value">The value.</param>
  32301. <returns>
  32302. <c>true</c> if string needs Unicode to be represented.; otherwise, <c>false</c>.
  32303. </returns>
  32304. <remarks>Tony Qu change the logic</remarks>
  32305. </member>
  32306. <member name="M:NPOI.Util.StringUtil.ToHexString(System.String)">
  32307. <summary>
  32308. Encodes non-US-ASCII characters in a string, good for encoding file names for download
  32309. http://www.acriticsreview.com/List.aspx?listid=42
  32310. </summary>
  32311. <param name="s"></param>
  32312. <returns></returns>
  32313. </member>
  32314. <member name="M:NPOI.Util.StringUtil.ToHexString(System.Char)">
  32315. <summary>
  32316. Encodes a non-US-ASCII character.
  32317. </summary>
  32318. <param name="chr"></param>
  32319. <returns></returns>
  32320. </member>
  32321. <member name="M:NPOI.Util.StringUtil.ToHexString(System.Int16)">
  32322. <summary>
  32323. Encodes a non-US-ASCII character.
  32324. </summary>
  32325. <param name="chr"></param>
  32326. <returns></returns>
  32327. </member>
  32328. <member name="M:NPOI.Util.StringUtil.ToHexString(System.Int32)">
  32329. <summary>
  32330. Encodes a non-US-ASCII character.
  32331. </summary>
  32332. <param name="chr"></param>
  32333. <returns></returns>
  32334. </member>
  32335. <member name="M:NPOI.Util.StringUtil.ToHexString(System.Int64)">
  32336. <summary>
  32337. Encodes a non-US-ASCII character.
  32338. </summary>
  32339. <param name="chr"></param>
  32340. <returns></returns>
  32341. </member>
  32342. <member name="M:NPOI.Util.StringUtil.NeedToEncode(System.Char)">
  32343. <summary>
  32344. Determines if the character needs to be encoded.
  32345. http://www.acriticsreview.com/List.aspx?listid=42
  32346. </summary>
  32347. <param name="chr"></param>
  32348. <returns></returns>
  32349. </member>
  32350. <member name="M:NPOI.Util.StringUtil.MapMsCodepointString(System.String)">
  32351. Some strings may contain encoded characters of the unicode private use area.
  32352. Currently the characters of the symbol fonts are mapped to the corresponding
  32353. characters in the normal unicode range.
  32354. @param string the original string
  32355. @return the string with mapped characters
  32356. @see <a href="http://www.alanwood.net/unicode/private_use_area.html#symbol">Private Use Area (symbol)</a>
  32357. @see <a href="http://www.alanwood.net/demos/symbol.html">Symbol font - Unicode alternatives for Greek and special characters in HTML</a>
  32358. </member>
  32359. <member name="F:NPOI.Util.StringUtil.MIN_HIGH_SURROGATE">
  32360. The minimum value of a
  32361. <a href="http://www.unicode.org/glossary/#high_surrogate_code_unit">
  32362. Unicode high-surrogate code unit</a>
  32363. in the UTF-16 encoding, constant {@code '\u005CuD800'}.
  32364. A high-surrogate is also known as a <i>leading-surrogate</i>.
  32365. @since 1.5
  32366. </member>
  32367. <member name="F:NPOI.Util.StringUtil.MAX_HIGH_SURROGATE">
  32368. The maximum value of a
  32369. <a href="http://www.unicode.org/glossary/#high_surrogate_code_unit">
  32370. Unicode high-surrogate code unit</a>
  32371. in the UTF-16 encoding, constant {@code '\u005CuDBFF'}.
  32372. A high-surrogate is also known as a <i>leading-surrogate</i>.
  32373. @since 1.5
  32374. </member>
  32375. <member name="F:NPOI.Util.StringUtil.MIN_LOW_SURROGATE">
  32376. The minimum value of a
  32377. <a href="http://www.unicode.org/glossary/#low_surrogate_code_unit">
  32378. Unicode low-surrogate code unit</a>
  32379. in the UTF-16 encoding, constant {@code '\u005CuDC00'}.
  32380. A low-surrogate is also known as a <i>trailing-surrogate</i>.
  32381. @since 1.5
  32382. </member>
  32383. <member name="F:NPOI.Util.StringUtil.MAX_LOW_SURROGATE">
  32384. The maximum value of a
  32385. <a href="http://www.unicode.org/glossary/#low_surrogate_code_unit">
  32386. Unicode low-surrogate code unit</a>
  32387. in the UTF-16 encoding, constant {@code '\u005CuDFFF'}.
  32388. A low-surrogate is also known as a <i>trailing-surrogate</i>.
  32389. @since 1.5
  32390. </member>
  32391. <member name="M:NPOI.Util.StringUtil.toCodePoint(System.Char,System.Char)">
  32392. Converts the specified surrogate pair to its supplementary code
  32393. point value. This method does not validate the specified
  32394. surrogate pair. The caller must validate it using {@link
  32395. #isSurrogatePair(char, char) isSurrogatePair} if necessary.
  32396. @param high the high-surrogate code unit
  32397. @param low the low-surrogate code unit
  32398. @return the supplementary code point composed from the
  32399. specified surrogate pair.
  32400. @since 1.5
  32401. </member>
  32402. <member name="M:NPOI.Util.StringUtil.CharCount(System.Int32)">
  32403. Determines the number of {@code char} values needed to
  32404. represent the specified character (Unicode code point). If the
  32405. specified character is equal to or greater than 0x10000, then
  32406. the method returns 2. Otherwise, the method returns 1.
  32407. This method doesn't validate the specified character to be a
  32408. valid Unicode code point. The caller must validate the
  32409. character value using {@link #isValidCodePoint(int) isValidCodePoint}
  32410. if necessary.
  32411. @param codePoint the character (Unicode code point) to be tested.
  32412. @return 2 if the character is a valid supplementary character; 1 otherwise.
  32413. @see Character#isSupplementaryCodePoint(int)
  32414. @since 1.5
  32415. </member>
  32416. <member name="T:NPOI.Util.SystemOutLogger">
  32417. <summary>
  32418. A logger class that strives to make it as easy as possible for
  32419. developers to write log calls, while simultaneously making those
  32420. calls as cheap as possible by performing lazy Evaluation of the log
  32421. message.
  32422. </summary>
  32423. <remarks>
  32424. @author Marc Johnson (mjohnson at apache dot org)
  32425. @author Glen Stampoultzis (glens at apache.org)
  32426. @author Nicola Ken Barozzi (nicolaken at apache.org)
  32427. </remarks>
  32428. </member>
  32429. <member name="M:NPOI.Util.SystemOutLogger.Log(System.Int32,System.Object)">
  32430. <summary>
  32431. Log a message
  32432. </summary>
  32433. <param name="level">One of DEBUG, INFO, WARN, ERROR, FATAL</param>
  32434. <param name="obj1">The object to log.</param>
  32435. </member>
  32436. <member name="M:NPOI.Util.SystemOutLogger.Log(System.Int32,System.Object,System.Exception)">
  32437. <summary>
  32438. Log a message
  32439. </summary>
  32440. <param name="level"> One of DEBUG, INFO, WARN, ERROR, FATAL</param>
  32441. <param name="obj1">The object to log. This is Converted to a string.</param>
  32442. <param name="exception">An exception to be logged</param>
  32443. </member>
  32444. <member name="M:NPOI.Util.SystemOutLogger.Check(System.Int32)">
  32445. <summary>
  32446. Check if a logger is enabled to log at the specified level
  32447. </summary>
  32448. <param name="level">One of DEBUG, INFO, WARN, ERROR, FATAL</param>
  32449. <returns></returns>
  32450. </member>
  32451. <member name="M:NPOI.Util.TempFile.CreateTempFile(System.String,System.String)">
  32452. Creates a temporary file. Files are collected into one directory and by default are
  32453. deleted on exit from the VM. Files can be kept by defining the system property
  32454. <c>poi.keep.tmp.files</c>.
  32455. Dont forget to close all files or it might not be possible to delete them.
  32456. </member>
  32457. <member name="T:NPOI.Util.ULongField">
  32458. <summary>
  32459. </summary>
  32460. </member>
  32461. <member name="M:NPOI.Util.ULongField.#ctor(System.Int32)">
  32462. <summary>
  32463. construct the <see cref="T:NPOI.Util.LongField"/> with its offset into its containing byte array
  32464. </summary>
  32465. <param name="offset">The offset.</param>
  32466. </member>
  32467. <member name="M:NPOI.Util.ULongField.#ctor(System.Int32,System.UInt64)">
  32468. <summary>
  32469. construct the LongField with its offset into its containing
  32470. byte array and initialize its value
  32471. </summary>
  32472. <param name="offset">offset of the field within its byte array</param>
  32473. <param name="value">the initial value</param>
  32474. </member>
  32475. <member name="M:NPOI.Util.ULongField.#ctor(System.Int32,System.Byte[])">
  32476. <summary>
  32477. Construct the <see cref="T:NPOI.Util.LongField"/> class with its offset into its containing
  32478. byte array and initialize its value from its byte array
  32479. </summary>
  32480. <param name="offset">The offset of the field within its byte array</param>
  32481. <param name="data">the byte array to read the value from</param>
  32482. </member>
  32483. <member name="M:NPOI.Util.ULongField.#ctor(System.Int32,System.UInt64,System.Byte[])">
  32484. <summary>
  32485. construct the <see cref="T:NPOI.Util.LongField"/> class with its offset into its containing
  32486. byte array, initialize its value, and write the value to a byte
  32487. array
  32488. </summary>
  32489. <param name="offset">offset of the field within its byte array</param>
  32490. <param name="value">the initial value</param>
  32491. <param name="data">the byte array to write the value to</param>
  32492. </member>
  32493. <member name="P:NPOI.Util.ULongField.Value">
  32494. <summary>
  32495. Getg or sets the LongField's current value
  32496. </summary>
  32497. <value>The current value</value>
  32498. </member>
  32499. <member name="M:NPOI.Util.ULongField.Set(System.UInt64,System.Byte[])">
  32500. <summary>
  32501. set the LongField's current value and write it to a byte array
  32502. </summary>
  32503. <param name="value">value to be set</param>
  32504. <param name="data">the byte array to write the value to</param>
  32505. </member>
  32506. <member name="M:NPOI.Util.ULongField.ReadFromBytes(System.Byte[])">
  32507. <summary>
  32508. set the value from its offset into an array of bytes
  32509. </summary>
  32510. <param name="data">the byte array from which the value is to be read</param>
  32511. </member>
  32512. <member name="M:NPOI.Util.ULongField.ReadFromStream(System.IO.Stream)">
  32513. <summary>
  32514. set the value from an Stream
  32515. </summary>
  32516. <param name="stream">the Stream from which the value is to be</param>
  32517. </member>
  32518. <member name="M:NPOI.Util.ULongField.WriteToBytes(System.Byte[])">
  32519. <summary>
  32520. write the value out to an array of bytes at the appropriate offset
  32521. </summary>
  32522. <param name="data">the array of bytes to which the value is to be written</param>
  32523. </member>
  32524. <member name="M:NPOI.Util.ULongField.ToString">
  32525. <summary>
  32526. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  32527. </summary>
  32528. <returns>
  32529. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  32530. </returns>
  32531. </member>
  32532. <member name="T:NPOI.Util.Units">
  32533. @author Yegor Kozlov
  32534. </member>
  32535. <member name="F:NPOI.Util.Units.EMU_PER_PIXEL">
  32536. In Escher absolute distances are specified in
  32537. English Metric Units (EMUs), occasionally referred to as A units;
  32538. there are 360000 EMUs per centimeter, 914400 EMUs per inch, 12700 EMUs per point.
  32539. </member>
  32540. <member name="F:NPOI.Util.Units.MASTER_DPI">
  32541. Master DPI (576 pixels per inch).
  32542. Used by the reference coordinate system in PowerPoint (HSLF)
  32543. </member>
  32544. <member name="F:NPOI.Util.Units.PIXEL_DPI">
  32545. Pixels DPI (96 pixels per inch)
  32546. </member>
  32547. <member name="F:NPOI.Util.Units.POINT_DPI">
  32548. Points DPI (72 pixels per inch)
  32549. </member>
  32550. <member name="M:NPOI.Util.Units.ToEMU(System.Double)">
  32551. <summary>
  32552. Converts points to EMUs
  32553. </summary>
  32554. <param name="value"></param>
  32555. <returns>EMUs</returns>
  32556. </member>
  32557. <member name="M:NPOI.Util.Units.PixelToEMU(System.Int32)">
  32558. Converts pixels to EMUs
  32559. @param pixels pixels
  32560. @return EMUs
  32561. </member>
  32562. <member name="M:NPOI.Util.Units.FixedPointToDecimal(System.Int32)">
  32563. Converts a value of type FixedPoint to a decimal number
  32564. @param fixedPoint
  32565. @return decimal number
  32566. @see <a href="http://msdn.microsoft.com/en-us/library/dd910765(v=office.12).aspx">[MS-OSHARED] - 2.2.1.6 FixedPoint</a>
  32567. </member>
  32568. <member name="M:NPOI.Util.Units.DoubleToFixedPoint(System.Double)">
  32569. Converts a value of type floating point to a FixedPoint
  32570. @param floatPoint
  32571. @return fixedPoint
  32572. @see <a href="http://msdn.microsoft.com/en-us/library/dd910765(v=office.12).aspx">[MS-OSHARED] - 2.2.1.6 FixedPoint</a>
  32573. </member>
  32574. <member name="T:NPOI.SS.Extractor.IExcelExtractor">
  32575. Common interface for Excel text extractors, covering
  32576. HSSF and XSSF
  32577. </member>
  32578. <member name="P:NPOI.SS.Extractor.IExcelExtractor.Text">
  32579. Retreives the text contents of the file
  32580. </member>
  32581. <member name="T:NPOI.SS.Format.CellDateFormatter">
  32582. Formats a date value.
  32583. @author Ken Arnold, Industrious Media LLC
  32584. </member>
  32585. <member name="M:NPOI.SS.Format.CellDateFormatter.#ctor(System.String)">
  32586. Creates a new date formatter with the given specification.
  32587. @param format The format.
  32588. </member>
  32589. <member name="M:NPOI.SS.Format.CellDateFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  32590. {@inheritDoc}
  32591. </member>
  32592. <member name="M:NPOI.SS.Format.CellDateFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  32593. {@inheritDoc}
  32594. <p/>
  32595. For a date, this is <tt>"mm/d/y"</tt>.
  32596. </member>
  32597. <member name="T:NPOI.SS.Format.CellElapsedFormatter">
  32598. This class : printing out an elapsed time format.
  32599. @author Ken Arnold, Industrious Media LLC
  32600. </member>
  32601. <member name="M:NPOI.SS.Format.CellElapsedFormatter.#ctor(System.String)">
  32602. Creates a elapsed time formatter.
  32603. @param pattern The pattern to Parse.
  32604. </member>
  32605. <member name="M:NPOI.SS.Format.CellElapsedFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  32606. {@inheritDoc}
  32607. </member>
  32608. <member name="M:NPOI.SS.Format.CellElapsedFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  32609. {@inheritDoc}
  32610. <p/>
  32611. For a date, this is <tt>"mm/d/y"</tt>.
  32612. </member>
  32613. <!-- Badly formed XML comment ignored for member "T:NPOI.SS.Format.CellFormat" -->
  32614. <member name="T:NPOI.SS.Format.CellFormat.GeneralCellFormat">
  32615. Format a value as it would be were no format specified. This is also
  32616. used when the format specified is <tt>General</tt>.
  32617. </member>
  32618. <member name="F:NPOI.SS.Format.CellFormat.formatCache">
  32619. Maps a format string to its Parsed version for efficiencies sake.
  32620. </member>
  32621. <member name="M:NPOI.SS.Format.CellFormat.GetInstance(System.String)">
  32622. Returns a {@link CellFormat} that applies the given format. Two calls
  32623. with the same format may or may not return the same object.
  32624. @param format The format.
  32625. @return A {@link CellFormat} that applies the given format.
  32626. </member>
  32627. <member name="M:NPOI.SS.Format.CellFormat.#ctor(System.String)">
  32628. Creates a new object.
  32629. @param format The format.
  32630. </member>
  32631. <member name="M:NPOI.SS.Format.CellFormat.Apply(System.Object)">
  32632. Returns the result of Applying the format to the given value. If the
  32633. value is a number (a type of {@link Number} object), the correct number
  32634. format type is chosen; otherwise it is considered a text object.
  32635. @param value The value
  32636. @return The result, in a {@link CellFormatResult}.
  32637. </member>
  32638. <member name="M:NPOI.SS.Format.CellFormat.Apply(System.DateTime,System.Double)">
  32639. Returns the result of applying the format to the given date.
  32640. @param date The date.
  32641. @param numericValue The numeric value for the date.
  32642. @return The result, in a {@link CellFormatResult}.
  32643. </member>
  32644. <member name="M:NPOI.SS.Format.CellFormat.Apply(NPOI.SS.UserModel.ICell)">
  32645. Fetches the appropriate value from the cell, and returns the result of
  32646. Applying it to the appropriate format. For formula cells, the computed
  32647. value is what is used.
  32648. @param c The cell.
  32649. @return The result, in a {@link CellFormatResult}.
  32650. </member>
  32651. <member name="M:NPOI.SS.Format.CellFormat.GetApplicableFormatPart(System.Object)">
  32652. Returns the {@link CellFormatPart} that applies to the value. Result
  32653. depends on how many parts the cell format has, the cell value and any
  32654. conditions. The value must be a {@link Number}.
  32655. @param value The value.
  32656. @return The {@link CellFormatPart} that applies to the value.
  32657. </member>
  32658. <member name="M:NPOI.SS.Format.CellFormat.UltimateType(NPOI.SS.UserModel.ICell)">
  32659. Returns the ultimate cell type, following the results of formulas. If
  32660. the cell is a {@link Cell#CELL_TYPE_FORMULA}, this returns the result of
  32661. {@link Cell#getCachedFormulaResultType()}. Otherwise this returns the
  32662. result of {@link Cell#getCellType()}.
  32663. @param cell The cell.
  32664. @return The ultimate type of this cell.
  32665. </member>
  32666. <member name="M:NPOI.SS.Format.CellFormat.Equals(System.Object)">
  32667. Returns <tt>true</tt> if the other object is a {@link CellFormat} object
  32668. with the same format.
  32669. @param obj The other object.
  32670. @return <tt>true</tt> if the two objects are Equal.
  32671. </member>
  32672. <member name="M:NPOI.SS.Format.CellFormat.GetHashCode">
  32673. Returns a hash code for the format.
  32674. @return A hash code for the format.
  32675. </member>
  32676. <member name="T:NPOI.SS.Format.CellFormatCondition">
  32677. This object represents a condition in a cell format.
  32678. @author Ken Arnold, Industrious Media LLC
  32679. </member>
  32680. <member name="M:NPOI.SS.Format.CellFormatCondition.GetInstance(System.String,System.String)">
  32681. Returns an instance of a condition object.
  32682. @param opString The operator as a string. One of <tt>"&lt;"</tt>,
  32683. <tt>"&lt;="</tt>, <tt>">"</tt>, <tt>">="</tt>,
  32684. <tt>"="</tt>, <tt>"=="</tt>, <tt>"!="</tt>, or
  32685. <tt>"&lt;>"</tt>.
  32686. @param constStr The constant (such as <tt>"12"</tt>).
  32687. @return A condition object for the given condition.
  32688. </member>
  32689. <member name="M:NPOI.SS.Format.CellFormatCondition.Pass(System.Double)">
  32690. Returns <tt>true</tt> if the given value passes the constraint's test.
  32691. @param value The value to compare against.
  32692. @return <tt>true</tt> if the given value passes the constraint's test.
  32693. </member>
  32694. <member name="T:NPOI.SS.Format.CellFormatPart">
  32695. Objects of this class represent a single part of a cell format expression.
  32696. Each cell can have up to four of these for positive, zero, negative, and text
  32697. values.
  32698. <p/>
  32699. Each format part can contain a color, a condition, and will always contain a
  32700. format specification. For example <tt>"[Red][>=10]#"</tt> has a color
  32701. (<tt>[Red]</tt>), a condition (<tt>>=10</tt>) and a format specification
  32702. (<tt>#</tt>).
  32703. <p/>
  32704. This class also Contains patterns for matching the subparts of format
  32705. specification. These are used internally, but are made public in case other
  32706. code has use for them.
  32707. @author Ken Arnold, Industrious Media LLC
  32708. </member>
  32709. <member name="F:NPOI.SS.Format.CellFormatPart.COLOR_PAT">
  32710. Pattern for the color part of a cell format part.
  32711. </member>
  32712. <member name="F:NPOI.SS.Format.CellFormatPart.CONDITION_PAT">
  32713. Pattern for the condition part of a cell format part.
  32714. </member>
  32715. <member name="F:NPOI.SS.Format.CellFormatPart.SPECIFICATION_PAT">
  32716. Pattern for the format specification part of a cell format part.
  32717. </member>
  32718. <member name="F:NPOI.SS.Format.CellFormatPart.CURRENCY_PAT">
  32719. Pattern for the currency symbol part of a cell format part
  32720. </member>
  32721. <member name="F:NPOI.SS.Format.CellFormatPart.FORMAT_PAT">
  32722. Pattern for an entire cell single part.
  32723. </member>
  32724. <member name="F:NPOI.SS.Format.CellFormatPart.COLOR_GROUP">
  32725. Within {@link #FORMAT_PAT}, the group number for the matched color.
  32726. </member>
  32727. <member name="F:NPOI.SS.Format.CellFormatPart.CONDITION_OPERATOR_GROUP">
  32728. Within {@link #FORMAT_PAT}, the group number for the operator in the
  32729. condition.
  32730. </member>
  32731. <member name="F:NPOI.SS.Format.CellFormatPart.CONDITION_VALUE_GROUP">
  32732. Within {@link #FORMAT_PAT}, the group number for the value in the
  32733. condition.
  32734. </member>
  32735. <member name="F:NPOI.SS.Format.CellFormatPart.SPECIFICATION_GROUP">
  32736. Within {@link #FORMAT_PAT}, the group number for the format
  32737. specification.
  32738. </member>
  32739. <member name="M:NPOI.SS.Format.CellFormatPart.#ctor(System.String)">
  32740. Create an object to represent a format part.
  32741. @param desc The string to Parse.
  32742. </member>
  32743. <member name="M:NPOI.SS.Format.CellFormatPart.Applies(System.Object)">
  32744. Returns <tt>true</tt> if this format part applies to the given value. If
  32745. the value is a number and this is part has a condition, returns
  32746. <tt>true</tt> only if the number passes the condition. Otherwise, this
  32747. allways return <tt>true</tt>.
  32748. @param valueObject The value to Evaluate.
  32749. @return <tt>true</tt> if this format part applies to the given value.
  32750. </member>
  32751. <member name="M:NPOI.SS.Format.CellFormatPart.FindGroup(System.Text.RegularExpressions.Regex,System.String,System.String)">
  32752. Returns the number of the first group that is the same as the marker
  32753. string. Starts from group 1.
  32754. @param pat The pattern to use.
  32755. @param str The string to match against the pattern.
  32756. @param marker The marker value to find the group of.
  32757. @return The matching group number.
  32758. @throws ArgumentException No group matches the marker.
  32759. </member>
  32760. <member name="M:NPOI.SS.Format.CellFormatPart.GetColor(System.Text.RegularExpressions.Match)">
  32761. Returns the color specification from the matcher, or <tt>null</tt> if
  32762. there is none.
  32763. @param m The matcher for the format part.
  32764. @return The color specification or <tt>null</tt>.
  32765. </member>
  32766. <member name="M:NPOI.SS.Format.CellFormatPart.GetCondition(System.Text.RegularExpressions.Match)">
  32767. Returns the condition specification from the matcher, or <tt>null</tt> if
  32768. there is none.
  32769. @param m The matcher for the format part.
  32770. @return The condition specification or <tt>null</tt>.
  32771. </member>
  32772. <member name="M:NPOI.SS.Format.CellFormatPart.GetCellFormatType(System.Text.RegularExpressions.Match)">
  32773. Returns the CellFormatType object implied by the format specification for
  32774. the format part.
  32775. @param matcher The matcher for the format part.
  32776. @return The CellFormatType.
  32777. </member>
  32778. <member name="M:NPOI.SS.Format.CellFormatPart.GetFormatter(System.Text.RegularExpressions.Match)">
  32779. Returns the formatter object implied by the format specification for the
  32780. format part.
  32781. @param matcher The matcher for the format part.
  32782. @return The formatter.
  32783. </member>
  32784. <member name="M:NPOI.SS.Format.CellFormatPart.formatType(System.String)">
  32785. Returns the type of format.
  32786. @param fdesc The format specification
  32787. @return The type of format.
  32788. </member>
  32789. <member name="M:NPOI.SS.Format.CellFormatPart.QuoteSpecial(System.String,NPOI.SS.Format.CellFormatType)">
  32790. Returns a version of the original string that has any special characters
  32791. quoted (or escaped) as appropriate for the cell format type. The format
  32792. type object is queried to see what is special.
  32793. @param repl The original string.
  32794. @param type The format type representation object.
  32795. @return A version of the string with any special characters Replaced.
  32796. @see CellFormatType#isSpecial(char)
  32797. </member>
  32798. <member name="M:NPOI.SS.Format.CellFormatPart.Apply(System.Object)">
  32799. Apply this format part to the given value. This returns a {@link
  32800. CellFormatResult} object with the results.
  32801. @param value The value to apply this format part to.
  32802. @return A {@link CellFormatResult} object Containing the results of
  32803. Applying the format to the value.
  32804. </member>
  32805. <member name="P:NPOI.SS.Format.CellFormatPart.CellFormatType">
  32806. Returns the CellFormatType object implied by the format specification for
  32807. the format part.
  32808. @return The CellFormatType.
  32809. </member>
  32810. <member name="P:NPOI.SS.Format.CellFormatPart.HasCondition">
  32811. Returns <tt>true</tt> if this format part has a condition.
  32812. @return <tt>true</tt> if this format part has a condition.
  32813. </member>
  32814. <member name="M:NPOI.SS.Format.CellFormatPart.ExpandChar(System.String)">
  32815. Expands a character. This is only partly done, because we don't have the
  32816. correct info. In Excel, this would be expanded to fill the rest of the
  32817. cell, but we don't know, in general, what the "rest of the cell" is1.
  32818. @param part The character to be repeated is the second character in this
  32819. string.
  32820. @return The character repeated three times.
  32821. </member>
  32822. <member name="M:NPOI.SS.Format.CellFormatPart.Group(System.Text.RegularExpressions.Match,System.Int32)">
  32823. Returns the string from the group, or <tt>""</tt> if the group is
  32824. <tt>null</tt>.
  32825. @param m The matcher.
  32826. @param g The group number.
  32827. @return The group or <tt>""</tt>.
  32828. </member>
  32829. <member name="T:NPOI.SS.Format.CellFormatResult">
  32830. This object Contains the result of Applying a cell format or cell format part
  32831. to a value.
  32832. @author Ken Arnold, Industrious Media LLC
  32833. @see CellFormatPart#Apply(Object)
  32834. @see CellFormat#Apply(Object)
  32835. </member>
  32836. <member name="P:NPOI.SS.Format.CellFormatResult.Applies">
  32837. This is <tt>true</tt> if no condition was given that applied to the
  32838. value, or if the condition is satisfied. If a condition is relevant, and
  32839. when applied the value fails the test, this is <tt>false</tt>.
  32840. </member>
  32841. <member name="P:NPOI.SS.Format.CellFormatResult.Text">
  32842. The resulting text. This will never be <tt>null</tt>.
  32843. </member>
  32844. <member name="P:NPOI.SS.Format.CellFormatResult.TextColor">
  32845. The color the format Sets, or <tt>null</tt> if the format Sets no color.
  32846. This will always be <tt>null</tt> if {@link #applies} is <tt>false</tt>.
  32847. </member>
  32848. <member name="M:NPOI.SS.Format.CellFormatResult.#ctor(System.Boolean,System.String,SixLabors.ImageSharp.PixelFormats.Rgb24)">
  32849. Creates a new format result object.
  32850. @param applies The value for {@link #applies}.
  32851. @param text The value for {@link #text}.
  32852. @param textColor The value for {@link #textColor}.
  32853. </member>
  32854. <member name="T:NPOI.SS.Format.CellFormatter">
  32855. This is the abstract supertype for the various cell formatters.
  32856. @author Ken Arnold, Industrious Media LLC
  32857. </member>
  32858. <member name="F:NPOI.SS.Format.CellFormatter.format">
  32859. The original specified format.
  32860. </member>
  32861. <member name="F:NPOI.SS.Format.CellFormatter.LOCALE">
  32862. This is the locale used to Get a consistent format result from which to
  32863. work.
  32864. </member>
  32865. <member name="M:NPOI.SS.Format.CellFormatter.#ctor(System.String)">
  32866. Creates a new formatter object, storing the format in {@link #format}.
  32867. @param format The format.
  32868. </member>
  32869. <member name="M:NPOI.SS.Format.CellFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  32870. Format a value according the format string.
  32871. @param toAppendTo The buffer to append to.
  32872. @param value The value to format.
  32873. </member>
  32874. <member name="M:NPOI.SS.Format.CellFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  32875. Format a value according to the type, in the most basic way.
  32876. @param toAppendTo The buffer to append to.
  32877. @param value The value to format.
  32878. </member>
  32879. <member name="M:NPOI.SS.Format.CellFormatter.Format(System.Object)">
  32880. Formats the value, returning the resulting string.
  32881. @param value The value to format.
  32882. @return The value, formatted.
  32883. </member>
  32884. <member name="M:NPOI.SS.Format.CellFormatter.SimpleFormat(System.Object)">
  32885. Formats the value in the most basic way, returning the resulting string.
  32886. @param value The value to format.
  32887. @return The value, formatted.
  32888. </member>
  32889. <member name="M:NPOI.SS.Format.CellFormatter.Quote(System.String)">
  32890. Returns the input string, surrounded by quotes.
  32891. @param str The string to quote.
  32892. @return The input string, surrounded by quotes.
  32893. </member>
  32894. <member name="T:NPOI.SS.Format.CellFormatType">
  32895. The different kinds of formats that the formatter understands.
  32896. @author Ken Arnold, Industrious Media LLC
  32897. </member>
  32898. <member name="F:NPOI.SS.Format.CellFormatType.GENERAL">
  32899. The general (default) format; also used for <tt>"General"</tt>.
  32900. </member>
  32901. <member name="F:NPOI.SS.Format.CellFormatType.NUMBER">
  32902. A numeric format.
  32903. </member>
  32904. <member name="F:NPOI.SS.Format.CellFormatType.DATE">
  32905. A date format.
  32906. </member>
  32907. <member name="F:NPOI.SS.Format.CellFormatType.ELAPSED">
  32908. An elapsed time format.
  32909. </member>
  32910. <member name="F:NPOI.SS.Format.CellFormatType.TEXT">
  32911. A text format.
  32912. </member>
  32913. <member name="M:NPOI.SS.Format.CellFormatType.IsSpecial(System.Char)">
  32914. Returns <tt>true</tt> if the format is special and needs to be quoted.
  32915. @param ch The character to test.
  32916. @return <tt>true</tt> if the format is special and needs to be quoted.
  32917. </member>
  32918. <member name="M:NPOI.SS.Format.CellFormatType.Formatter(System.String)">
  32919. Returns a new formatter of the appropriate type, for the given pattern.
  32920. The pattern must be appropriate for the type.
  32921. @param pattern The pattern to use.
  32922. @return A new formatter of the appropriate type, for the given pattern.
  32923. </member>
  32924. <member name="T:NPOI.SS.Format.CellGeneralFormatter">
  32925. A formatter for the default "General" cell format.
  32926. @author Ken Arnold, Industrious Media LLC
  32927. </member>
  32928. <member name="M:NPOI.SS.Format.CellGeneralFormatter.#ctor">
  32929. Creates a new general formatter.
  32930. </member>
  32931. <member name="M:NPOI.SS.Format.CellGeneralFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  32932. The general style is not quite the same as any other, or any combination
  32933. of others.
  32934. @param toAppendTo The buffer to append to.
  32935. @param value The value to format.
  32936. </member>
  32937. <member name="M:NPOI.SS.Format.CellGeneralFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  32938. Equivalent to {@link #formatValue(StringBuilder,Object)}. {@inheritDoc}.
  32939. </member>
  32940. <member name="T:NPOI.SS.Format.CellNumberFormatter">
  32941. This class : printing out a value using a number format.
  32942. @author Ken Arnold, Industrious Media LLC
  32943. </member>
  32944. <member name="T:NPOI.SS.Format.CellNumberFormatter.GeneralNumberFormatter">
  32945. <summary>
  32946. The CellNumberFormatter.simpleValue() method uses the SIMPLE_NUMBER
  32947. CellFormatter defined here. The CellFormat.GENERAL_FORMAT CellFormat
  32948. no longer uses the SIMPLE_NUMBER CellFormatter.
  32949. Note that the simpleValue()/SIMPLE_NUMBER CellFormatter format
  32950. ("#" for integer values, and "#.#" for floating-point values) is
  32951. different from the 'General' format for numbers ("#" for integer
  32952. values and "#.#########" for floating-point values).
  32953. </summary>
  32954. </member>
  32955. <member name="T:NPOI.SS.Format.CellNumberFormatter.Special">
  32956. This class is used to mark where the special characters in the format
  32957. are, as opposed to the other characters that are simply printed.
  32958. </member>
  32959. <member name="M:NPOI.SS.Format.CellNumberFormatter.#ctor(System.String)">
  32960. Creates a new cell number formatter.
  32961. @param format The format to Parse.
  32962. </member>
  32963. <member name="M:NPOI.SS.Format.CellNumberFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  32964. {@inheritDoc}
  32965. </member>
  32966. <member name="M:NPOI.SS.Format.CellNumberFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  32967. {@inheritDoc}
  32968. <p/>
  32969. For a number, this is <tt>"#"</tt> for integer values, and <tt>"#.#"</tt>
  32970. for floating-point values.
  32971. </member>
  32972. <member name="T:NPOI.SS.Format.CellNumberPartHandler">
  32973. Internal helper class for CellNumberFormatter
  32974. </member>
  32975. <member name="T:NPOI.SS.Format.CellNumberStringMod">
  32976. Internal helper class for CellNumberFormatter
  32977. This class represents a single modification to a result string. The way
  32978. this works is complicated, but so is numeric formatting. In general, for
  32979. most formats, we use a DecimalFormat object that will Put the string out
  32980. in a known format, usually with all possible leading and trailing zeros.
  32981. We then walk through the result and the original format, and note any
  32982. modifications that need to be made. Finally, we go through and apply
  32983. them all, dealing with overlapping modifications.
  32984. </member>
  32985. <member name="T:NPOI.SS.Format.CellTextFormatter">
  32986. This class : printing out text.
  32987. @author Ken Arnold, Industrious Media LLC
  32988. </member>
  32989. <member name="M:NPOI.SS.Format.CellTextFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  32990. {@inheritDoc}
  32991. </member>
  32992. <member name="M:NPOI.SS.Format.CellTextFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  32993. {@inheritDoc}
  32994. <p/>
  32995. For text, this is just printing the text.
  32996. </member>
  32997. <member name="F:NPOI.SS.Format.SimpleFraction.denominator">
  32998. The denominator.
  32999. </member>
  33000. <member name="F:NPOI.SS.Format.SimpleFraction.numerator">
  33001. The numerator.
  33002. </member>
  33003. <member name="M:NPOI.SS.Format.SimpleFraction.BuildFractionExactDenominator(System.Double,System.Int32)">
  33004. Create a fraction given a double value and a denominator.
  33005. @param val double value of fraction
  33006. @param exactDenom the exact denominator
  33007. @return a SimpleFraction with the given values set.
  33008. </member>
  33009. <member name="M:NPOI.SS.Format.SimpleFraction.BuildFractionMaxDenominator(System.Double,System.Int32)">
  33010. Create a fraction given the double value and either the maximum error
  33011. allowed or the maximum number of denominator digits.
  33012. @param value the double value to convert to a fraction.
  33013. @param maxDenominator maximum denominator value allowed.
  33014. @throws RuntimeException if the continued fraction failed to
  33015. converge.
  33016. @throws IllegalArgumentException if value > Integer.MAX_VALUE
  33017. </member>
  33018. <member name="M:NPOI.SS.Format.SimpleFraction.BuildFractionMaxDenominator(System.Double,System.Double,System.Int32,System.Int32)">
  33019. Create a fraction given the double value and either the maximum error
  33020. allowed or the maximum number of denominator digits.
  33021. <p>
  33022. References:
  33023. <ul>
  33024. <li><a href="http://mathworld.wolfram.com/ContinuedFraction.html">
  33025. Continued Fraction</a> equations (11) and (22)-(26)</li>
  33026. </ul>
  33027. </p>
  33028. Based on org.apache.commons.math.fraction.Fraction from Apache Commons-Math.
  33029. YK: The only reason of having this class is to avoid dependency on the Commons-Math jar.
  33030. @param value the double value to convert to a fraction.
  33031. @param epsilon maximum error allowed. The resulting fraction is within
  33032. <code>epsilon</code> of <code>value</code>, in absolute terms.
  33033. @param maxDenominator maximum denominator value allowed.
  33034. @param maxIterations maximum number of convergents
  33035. @throws RuntimeException if the continued fraction failed to
  33036. converge.
  33037. @throws IllegalArgumentException if value > Integer.MAX_VALUE
  33038. </member>
  33039. <member name="M:NPOI.SS.Format.SimpleFraction.#ctor(System.Int32,System.Int32)">
  33040. Create a fraction given a numerator and denominator.
  33041. @param numerator
  33042. @param denominator maxDenominator The maximum allowed value for denominator
  33043. </member>
  33044. <member name="P:NPOI.SS.Format.SimpleFraction.Denominator">
  33045. Access the denominator.
  33046. @return the denominator.
  33047. </member>
  33048. <member name="P:NPOI.SS.Format.SimpleFraction.Numerator">
  33049. Access the numerator.
  33050. @return the numerator.
  33051. </member>
  33052. <member name="M:NPOI.SS.Formula.Atp.AnalysisToolPak.GetSupportedFunctionNames">
  33053. Returns a collection of ATP function names implemented by POI.
  33054. @return an array of supported functions
  33055. @since 3.8 beta6
  33056. </member>
  33057. <member name="M:NPOI.SS.Formula.Atp.AnalysisToolPak.GetNotSupportedFunctionNames">
  33058. Returns a collection of ATP function names NOT implemented by POI.
  33059. @return an array of not supported functions
  33060. @since 3.8 beta6
  33061. </member>
  33062. <member name="M:NPOI.SS.Formula.Atp.AnalysisToolPak.RegisterFunction(System.String,NPOI.SS.Formula.Functions.FreeRefFunction)">
  33063. Register a ATP function in runtime.
  33064. @param name the function name
  33065. @param func the functoin to register
  33066. @throws ArgumentException if the function is unknown or already registered.
  33067. @since 3.8 beta6
  33068. </member>
  33069. <member name="T:NPOI.SS.Formula.Atp.ArgumentsEvaluator">
  33070. Evaluator for formula arguments.
  33071. @author jfaenomoto@gmail.com
  33072. </member>
  33073. <member name="M:NPOI.SS.Formula.Atp.ArgumentsEvaluator.EvaluateDateArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  33074. Evaluate a generic {@link ValueEval} argument to a double value that represents a date in POI.
  33075. @param arg {@link ValueEval} an argument.
  33076. @param srcCellRow number cell row.
  33077. @param srcCellCol number cell column.
  33078. @return a double representing a date in POI.
  33079. @throws EvaluationException exception upon argument evaluation.
  33080. </member>
  33081. <member name="M:NPOI.SS.Formula.Atp.ArgumentsEvaluator.EvaluateDatesArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  33082. Evaluate a generic {@link ValueEval} argument to an array of double values that represents dates in POI.
  33083. @param arg {@link ValueEval} an argument.
  33084. @param srcCellRow number cell row.
  33085. @param srcCellCol number cell column.
  33086. @return an array of doubles representing dates in POI.
  33087. @throws EvaluationException exception upon argument evaluation.
  33088. </member>
  33089. <member name="M:NPOI.SS.Formula.Atp.ArgumentsEvaluator.EvaluateNumberArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  33090. Evaluate a generic {@link ValueEval} argument to a double value.
  33091. @param arg {@link ValueEval} an argument.
  33092. @param srcCellRow number cell row.
  33093. @param srcCellCol number cell column.
  33094. @return a double value.
  33095. @throws EvaluationException exception upon argument evaluation.
  33096. </member>
  33097. <member name="T:NPOI.SS.Formula.Atp.DateParser">
  33098. Parser for java dates.
  33099. @author jfaenomoto@gmail.com
  33100. </member>
  33101. <member name="M:NPOI.SS.Formula.Atp.DateParser.ParseDate(System.String)">
  33102. Parses a date from a string.
  33103. @param strVal a string with a date pattern.
  33104. @return a date parsed from argument.
  33105. @throws EvaluationException exception upon parsing.
  33106. </member>
  33107. <member name="M:NPOI.SS.Formula.Atp.DateParser.MakeDate(System.Int32,System.Int32,System.Int32)">
  33108. @param month 1-based
  33109. </member>
  33110. <member name="T:NPOI.SS.Formula.Atp.Maxifs">
  33111. Implementation for the function MAXIFS
  33112. <p>
  33113. Syntax: MAXIFS(data_range, criteria_range1, criteria1, [criteria_range2, criteria2])
  33114. </p>
  33115. </member>
  33116. <member name="T:NPOI.SS.Formula.Atp.Minifs">
  33117. Implementation for the function MINIFS
  33118. <p>
  33119. Syntax: MINIFS(min_range, criteria_range1, criteria1, [criteria_range2, criteria2])
  33120. </p>
  33121. </member>
  33122. <member name="T:NPOI.SS.Formula.Atp.MRound">
  33123. Implementation of Excel 'Analysis ToolPak' function MROUND()<br/>
  33124. Returns a number rounded to the desired multiple.<p/>
  33125. <b>Syntax</b><br/>
  33126. <b>MROUND</b>(<b>number</b>, <b>multiple</b>)
  33127. <p/>
  33128. @author Yegor Kozlov
  33129. </member>
  33130. <member name="T:NPOI.SS.Formula.Atp.NetworkdaysFunction">
  33131. Implementation of Excel 'Analysis ToolPak' function NETWORKDAYS()<br/>
  33132. Returns the number of workdays given a starting and an ending date, considering an interval of holidays. A workday is any non
  33133. saturday/sunday date.
  33134. <p/>
  33135. <b>Syntax</b><br/>
  33136. <b>NETWORKDAYS</b>(<b>startDate</b>, <b>endDate</b>, holidays)
  33137. <p/>
  33138. @author jfaenomoto@gmail.com
  33139. </member>
  33140. <member name="M:NPOI.SS.Formula.Atp.NetworkdaysFunction.#ctor(NPOI.SS.Formula.Atp.ArgumentsEvaluator)">
  33141. Constructor.
  33142. @param anEvaluator an injected {@link ArgumentsEvaluator}.
  33143. </member>
  33144. <member name="M:NPOI.SS.Formula.Atp.NetworkdaysFunction.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  33145. Evaluate for NETWORKDAYS. Given two dates and a optional date or interval of holidays, determines how many working days are there
  33146. between those dates.
  33147. @return {@link ValueEval} for the number of days between two dates.
  33148. </member>
  33149. <member name="T:NPOI.SS.Formula.Atp.ParityFunction">
  33150. Implementation of Excel 'Analysis ToolPak' function ISEVEN() ISODD()<br/>
  33151. @author Josh Micich
  33152. </member>
  33153. <member name="T:NPOI.SS.Formula.Atp.RandBetween">
  33154. * Implementation of Excel 'Analysis ToolPak' function RANDBETWEEN()<br/>
  33155. *
  33156. * Returns a random integer number between the numbers you specify.<p/>
  33157. *
  33158. * <b>Syntax</b><br/>
  33159. * <b>RANDBETWEEN</b>(<b>bottom</b>, <b>top</b>)<p/>
  33160. *
  33161. * <b>bottom</b> is the smallest integer RANDBETWEEN will return.<br/>
  33162. * <b>top</b> is the largest integer RANDBETWEEN will return.<br/>
  33163. * @author Brendan Nolan
  33164. </member>
  33165. <member name="M:NPOI.SS.Formula.Atp.RandBetween.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  33166. Evaluate for RANDBETWEEN(). Must be given two arguments. Bottom must be greater than top.
  33167. Bottom is rounded up and top value is rounded down. After rounding top has to be set greater
  33168. than top.
  33169. @see org.apache.poi.ss.formula.functions.FreeRefFunction#evaluate(org.apache.poi.ss.formula.eval.ValueEval[], org.apache.poi.ss.formula.OperationEvaluationContext)
  33170. </member>
  33171. <member name="T:NPOI.SS.Formula.Atp.WorkdayCalculator">
  33172. A calculator for workdays, considering dates as excel representations.
  33173. @author jfaenomoto@gmail.com
  33174. </member>
  33175. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.#ctor">
  33176. Constructor.
  33177. </member>
  33178. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.CalculateWorkdays(System.Double,System.Double,System.Double[])">
  33179. Calculate how many workdays are there between a start and an end date, as excel representations, considering a range of holidays.
  33180. @param start start date.
  33181. @param end end date.
  33182. @param holidays an array of holidays.
  33183. @return number of workdays between start and end dates, including both dates.
  33184. </member>
  33185. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.CalculateWorkdays(System.Double,System.Int32,System.Double[])">
  33186. Calculate the workday past x workdays from a starting date, considering a range of holidays.
  33187. @param start start date.
  33188. @param workdays number of workdays to be past from starting date.
  33189. @param holidays an array of holidays.
  33190. @return date past x workdays.
  33191. </member>
  33192. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.CalculateWorkdays(System.Double,System.Int32,System.Int32,System.Double[])">
  33193. Calculate the workday past x workdays from a starting date, considering a range of holidays.
  33194. @param start start date.
  33195. @param workdays number of workdays to be past from starting date.
  33196. @param weekendType weekend parameter (see https://support.microsoft.com/en-us/office/workday-intl-function-a378391c-9ba7-4678-8a39-39611a9bf81d)
  33197. @param holidays an array of holidays.
  33198. @return date past x workdays.
  33199. </member>
  33200. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.isHoliday(System.Double,System.Double[])">
  33201. @param aDate a given date.
  33202. @param holidays an array of holidays.
  33203. @return <code>true</code> if date is a holiday, <code>false</code> otherwise.
  33204. </member>
  33205. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.PastDaysOfWeek(System.Double,System.Double,System.DayOfWeek)">
  33206. Calculates how many days of week past between a start and an end date.
  33207. @param start start date.
  33208. @param end end date.
  33209. @param dayOfWeek a day of week as represented by {@link Calendar} constants.
  33210. @return how many days of week past in this interval.
  33211. </member>
  33212. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.CalculateNonWeekendHolidays(System.Double,System.Double,System.Double[])">
  33213. Calculates how many holidays in a list are workdays, considering an interval of dates.
  33214. @param start start date.
  33215. @param end end date.
  33216. @param holidays an array of holidays.
  33217. @return number of holidays that occur in workdays, between start and end dates.
  33218. </member>
  33219. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.IsWeekend(System.Double)">
  33220. @param aDate a given date.
  33221. @return <code>true</code> if date is weekend, <code>false</code> otherwise.
  33222. </member>
  33223. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.IsHoliday(System.Double,System.Double[])">
  33224. @param aDate a given date.
  33225. @param holidays an array of holidays.
  33226. @return <code>true</code> if date is a holiday, <code>false</code> otherwise.
  33227. </member>
  33228. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.IsNonWorkday(System.Double,System.Double[])">
  33229. @param aDate a given date.
  33230. @param holidays an array of holidays.
  33231. @return <code>1</code> is not a workday, <code>0</code> otherwise.
  33232. </member>
  33233. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.IsInARange(System.Double,System.Double,System.Double)">
  33234. @param start start date.
  33235. @param end end date.
  33236. @param aDate a date to be analyzed.
  33237. @return <code>true</code> if aDate is between start and end dates, <code>false</code> otherwise.
  33238. </member>
  33239. <member name="T:NPOI.SS.Formula.Atp.WorkdayFunction">
  33240. Implementation of Excel 'Analysis ToolPak' function WORKDAY()<br/>
  33241. Returns the date past a number of workdays beginning at a start date, considering an interval of holidays. A workday is any non
  33242. saturday/sunday date.
  33243. <p/>
  33244. <b>Syntax</b><br/>
  33245. <b>WORKDAY</b>(<b>startDate</b>, <b>days</b>, holidays)
  33246. <p/>
  33247. @author jfaenomoto@gmail.com
  33248. </member>
  33249. <member name="M:NPOI.SS.Formula.Atp.WorkdayFunction.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  33250. Evaluate for WORKDAY. Given a date, a number of days and a optional date or interval of holidays, determines which date it is past
  33251. number of parametrized workdays.
  33252. @return {@link ValueEval} with date as its value.
  33253. </member>
  33254. <member name="M:NPOI.SS.Formula.Atp.WorkdayIntlFunction.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  33255. Evaluate for WORKDAY. Given a date, a number of days and a optional date or interval of holidays, determines which date it is past
  33256. number of parametrized workdays.
  33257. @return {@link ValueEval} with date as its value.
  33258. </member>
  33259. <member name="T:NPOI.SS.Formula.Atp.YearFrac">
  33260. Implementation of Excel 'Analysis ToolPak' function YEARFRAC()<br/>
  33261. Returns the fraction of the year spanned by two dates.<p/>
  33262. <b>Syntax</b><br/>
  33263. <b>YEARFRAC</b>(<b>startDate</b>, <b>endDate</b>, basis)<p/>
  33264. The <b>basis</b> optionally specifies the behaviour of YEARFRAC as follows:
  33265. <table border="0" cellpadding="1" cellspacing="0" summary="basis parameter description">
  33266. <tr><th>Value</th><th>Days per Month</th><th>Days per Year</th></tr>
  33267. <tr align='center'><td>0 (default)</td><td>30</td><td>360</td></tr>
  33268. <tr align='center'><td>1</td><td>actual</td><td>actual</td></tr>
  33269. <tr align='center'><td>2</td><td>actual</td><td>360</td></tr>
  33270. <tr align='center'><td>3</td><td>actual</td><td>365</td></tr>
  33271. <tr align='center'><td>4</td><td>30</td><td>360</td></tr>
  33272. </table>
  33273. </member>
  33274. <member name="T:NPOI.SS.Formula.Atp.YearFracCalculator">
  33275. <summary>
  33276. Internal calculation methods for Excel 'Analysis ToolPak' function YEARFRAC()
  33277. Algorithm inspired by www.dwheeler.com/yearfrac
  33278. @author Josh Micich
  33279. </summary>
  33280. <remarks>
  33281. Date Count convention
  33282. http://en.wikipedia.org/wiki/Day_count_convention
  33283. </remarks>
  33284. <remarks>
  33285. Office Online Help on YEARFRAC
  33286. http://office.microsoft.com/en-us/excel/HP052093441033.aspx
  33287. </remarks>
  33288. </member>
  33289. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.MS_PER_HOUR">
  33290. use UTC time-zone to avoid daylight savings issues
  33291. </member>
  33292. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.LONG_MONTH_LEN">
  33293. the length of normal long months i.e. 31
  33294. </member>
  33295. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.SHORT_MONTH_LEN">
  33296. the length of normal short months i.e. 30
  33297. </member>
  33298. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Calculate(System.Double,System.Double,System.Int32)">
  33299. <summary>
  33300. Calculates YEARFRAC()
  33301. </summary>
  33302. <param name="pStartDateVal">The start date.</param>
  33303. <param name="pEndDateVal">The end date.</param>
  33304. <param name="basis">The basis value.</param>
  33305. <returns></returns>
  33306. </member>
  33307. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis0(System.Int32,System.Int32)">
  33308. <summary>
  33309. Basis 0, 30/360 date convention
  33310. </summary>
  33311. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  33312. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  33313. <returns></returns>
  33314. </member>
  33315. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis1(System.Int32,System.Int32)">
  33316. <summary>
  33317. Basis 1, Actual/Actual date convention
  33318. </summary>
  33319. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  33320. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  33321. <returns></returns>
  33322. </member>
  33323. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis2(System.Int32,System.Int32)">
  33324. <summary>
  33325. Basis 2, Actual/360 date convention
  33326. </summary>
  33327. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  33328. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  33329. <returns></returns>
  33330. </member>
  33331. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis3(System.Double,System.Double)">
  33332. <summary>
  33333. Basis 3, Actual/365 date convention
  33334. </summary>
  33335. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  33336. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  33337. <returns></returns>
  33338. </member>
  33339. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis4(System.Int32,System.Int32)">
  33340. <summary>
  33341. Basis 4, European 30/360 date convention
  33342. </summary>
  33343. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  33344. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  33345. <returns></returns>
  33346. </member>
  33347. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.CalculateAdjusted(NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate,NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate,System.Int32,System.Int32)">
  33348. <summary>
  33349. Calculates the adjusted.
  33350. </summary>
  33351. <param name="startDate">The start date.</param>
  33352. <param name="endDate">The end date.</param>
  33353. <param name="date1day">The date1day.</param>
  33354. <param name="date2day">The date2day.</param>
  33355. <returns></returns>
  33356. </member>
  33357. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.IsLastDayOfMonth(NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate)">
  33358. <summary>
  33359. Determines whether [is last day of month] [the specified date].
  33360. </summary>
  33361. <param name="date">The date.</param>
  33362. <returns>
  33363. <c>true</c> if [is last day of month] [the specified date]; otherwise, <c>false</c>.
  33364. </returns>
  33365. </member>
  33366. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.GetLastDayOfMonth(NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate)">
  33367. <summary>
  33368. Gets the last day of month.
  33369. </summary>
  33370. <param name="date">The date.</param>
  33371. <returns></returns>
  33372. </member>
  33373. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.ShouldCountFeb29(NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate,NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate)">
  33374. <summary>
  33375. Assumes dates are no more than 1 year apart.
  33376. </summary>
  33377. <param name="start">The start.</param>
  33378. <param name="end">The end.</param>
  33379. <returns><c>true</c>
  33380. if dates both within a leap year, or span a period including Feb 29</returns>
  33381. </member>
  33382. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.DateDiff(System.Int64,System.Int64)">
  33383. <summary>
  33384. return the whole number of days between the two time-stamps. Both time-stamps are
  33385. assumed to represent 12:00 midnight on the respective day.
  33386. </summary>
  33387. <param name="startDateTicks">The start date ticks.</param>
  33388. <param name="endDateTicks">The end date ticks.</param>
  33389. <returns></returns>
  33390. </member>
  33391. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.AverageYearLength(System.Int32,System.Int32)">
  33392. <summary>
  33393. Averages the length of the year.
  33394. </summary>
  33395. <param name="startYear">The start year.</param>
  33396. <param name="endYear">The end year.</param>
  33397. <returns></returns>
  33398. </member>
  33399. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.IsLeapYear(System.Int32)">
  33400. <summary>
  33401. determine Leap Year
  33402. </summary>
  33403. <param name="i">the year</param>
  33404. <returns></returns>
  33405. </member>
  33406. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.IsGreaterThanOneYear(NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate,NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate)">
  33407. <summary>
  33408. Determines whether [is greater than one year] [the specified start].
  33409. </summary>
  33410. <param name="start">The start date.</param>
  33411. <param name="end">The end date.</param>
  33412. <returns>
  33413. <c>true</c> if [is greater than one year] [the specified start]; otherwise, <c>false</c>.
  33414. </returns>
  33415. </member>
  33416. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.CreateDate(System.Int32)">
  33417. <summary>
  33418. Creates the date.
  33419. </summary>
  33420. <param name="dayCount">The day count.</param>
  33421. <returns></returns>
  33422. </member>
  33423. <member name="T:NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate">
  33424. <summary>
  33425. Simple Date Wrapper
  33426. </summary>
  33427. </member>
  33428. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate.month">
  33429. 1-based month
  33430. </member>
  33431. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate.day">
  33432. day of month
  33433. </member>
  33434. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate.ticks">
  33435. milliseconds since 1970
  33436. </member>
  33437. <member name="T:NPOI.SS.Formula.BaseFormulaEvaluator">
  33438. Common functionality across file formats for Evaluating formula cells.<p/>
  33439. </member>
  33440. <member name="M:NPOI.SS.Formula.BaseFormulaEvaluator.SetupEnvironment(System.String[],NPOI.SS.Formula.BaseFormulaEvaluator[])">
  33441. Coordinates several formula Evaluators together so that formulas that involve external
  33442. references can be Evaluated.
  33443. @param workbookNames the simple file names used to identify the workbooks in formulas
  33444. with external links (for example "MyData.xls" as used in a formula "[MyData.xls]Sheet1!A1")
  33445. @param Evaluators all Evaluators for the full Set of workbooks required by the formulas.
  33446. </member>
  33447. <member name="M:NPOI.SS.Formula.BaseFormulaEvaluator.ClearAllCachedResultValues">
  33448. Should be called whenever there are major Changes (e.g. moving sheets) to input cells
  33449. in the Evaluated workbook. If performance is not critical, a single call to this method
  33450. may be used instead of many specific calls to the Notify~ methods.
  33451. Failure to call this method After changing cell values will cause incorrect behaviour
  33452. of the Evaluate~ methods of this class
  33453. </member>
  33454. <member name="M:NPOI.SS.Formula.BaseFormulaEvaluator.Evaluate(NPOI.SS.UserModel.ICell)">
  33455. If cell Contains a formula, the formula is Evaluated and returned,
  33456. else the CellValue simply copies the appropriate cell value from
  33457. the cell and also its cell type. This method should be preferred over
  33458. EvaluateInCell() when the call should not modify the contents of the
  33459. original cell.
  33460. @param cell may be <code>null</code> signifying that the cell is not present (or blank)
  33461. @return <code>null</code> if the supplied cell is <code>null</code> or blank
  33462. </member>
  33463. <member name="M:NPOI.SS.Formula.BaseFormulaEvaluator.EvaluateInCell(NPOI.SS.UserModel.ICell)">
  33464. If cell Contains formula, it Evaluates the formula, and
  33465. Puts the formula result back into the cell, in place
  33466. of the old formula.
  33467. Else if cell does not contain formula, this method leaves
  33468. the cell unChanged.
  33469. Note that the same instance of HSSFCell is returned to
  33470. allow chained calls like:
  33471. <pre>
  33472. int EvaluatedCellType = Evaluator.EvaluateInCell(cell).CellType;
  33473. </pre>
  33474. Be aware that your cell value will be Changed to hold the
  33475. result of the formula. If you simply want the formula
  33476. value computed for you, use {@link #EvaluateFormulaCellEnum(Cell)}}
  33477. @param cell
  33478. @return the {@code cell} that was passed in, allowing for chained calls
  33479. </member>
  33480. <member name="M:NPOI.SS.Formula.BaseFormulaEvaluator.EvaluateFormulaCell(NPOI.SS.UserModel.ICell)">
  33481. If cell Contains formula, it Evaluates the formula, and saves the result of the formula. The
  33482. cell remains as a formula cell. If the cell does not contain formula, this method returns -1
  33483. and leaves the cell unChanged.
  33484. Note that the type of the <em>formula result</em> is returned, so you know what kind of
  33485. cached formula result is also stored with the formula.
  33486. <pre>
  33487. int EvaluatedCellType = Evaluator.EvaluateFormulaCell(cell);
  33488. </pre>
  33489. Be aware that your cell will hold both the formula, and the result. If you want the cell
  33490. Replaced with the result of the formula, use {@link #EvaluateInCell(NPOI.SS.UserModel.Cell)}
  33491. @param cell The cell to Evaluate
  33492. @return -1 for non-formula cells, or the type of the <em>formula result</em>
  33493. </member>
  33494. <member name="M:NPOI.SS.Formula.BaseFormulaEvaluator.EvaluateFormulaCellEnum(NPOI.SS.UserModel.ICell)">
  33495. If cell Contains formula, it Evaluates the formula,
  33496. and saves the result of the formula. The cell
  33497. remains as a formula cell.
  33498. Else if cell does not contain formula, this method leaves
  33499. the cell unChanged.
  33500. Note that the type of the formula result is returned,
  33501. so you know what kind of value is also stored with
  33502. the formula.
  33503. <pre>
  33504. ICellType EvaluatedCellType = Evaluator.EvaluateFormulaCellEnum(cell);
  33505. </pre>
  33506. Be aware that your cell will hold both the formula,
  33507. and the result. If you want the cell Replaced with
  33508. the result of the formula, use {@link #Evaluate(NPOI.SS.UserModel.Cell)} }
  33509. @param cell The cell to Evaluate
  33510. @return The type of the formula result (the cell's type remains as CellType.FORMULA however)
  33511. If cell is not a formula cell, returns {@link CellType#_NONE} rather than throwing an exception.
  33512. @since POI 3.15 beta 3
  33513. </member>
  33514. <member name="M:NPOI.SS.Formula.BaseFormulaEvaluator.EvaluateAllFormulaCells(NPOI.SS.UserModel.IWorkbook)">
  33515. Loops over all cells in all sheets of the supplied
  33516. workbook.
  33517. For cells that contain formulas, their formulas are
  33518. Evaluated, and the results are saved. These cells
  33519. remain as formula cells.
  33520. For cells that do not contain formulas, no Changes
  33521. are made.
  33522. This is a helpful wrapper around looping over all
  33523. cells, and calling EvaluateFormulaCell on each one.
  33524. </member>
  33525. <member name="P:NPOI.SS.Formula.BaseFormulaEvaluator.IgnoreMissingWorkbooks">
  33526. {@inheritDoc}
  33527. </member>
  33528. <member name="P:NPOI.SS.Formula.BaseFormulaEvaluator.DebugEvaluationOutputForNextEval">
  33529. {@inheritDoc}
  33530. </member>
  33531. <member name="T:NPOI.SS.Formula.CellCacheEntry">
  33532. Stores the parameters that identify the evaluation of one cell.<br/>
  33533. </member>
  33534. <member name="M:NPOI.SS.Formula.CellCacheEntry.RecurseClearCachedFormulaResults">
  33535. Calls formulaCell.SetFormulaResult(null, null) recursively all the way up the tree of
  33536. dependencies. Calls usedCell.ClearConsumingCell(fc) for each child of a cell that Is
  33537. Cleared along the way.
  33538. @param formulaCells
  33539. </member>
  33540. <member name="M:NPOI.SS.Formula.CellCacheEntry.RecurseClearCachedFormulaResults(NPOI.SS.Formula.IEvaluationListener,System.Int32)">
  33541. Identical To {@link #RecurseClearCachedFormulaResults()} except for the listener call-backs
  33542. </member>
  33543. <member name="T:NPOI.SS.Formula.CellEvaluationFrame">
  33544. Stores details about the current evaluation of a cell.<br/>
  33545. </member>
  33546. <member name="M:NPOI.SS.Formula.CellEvaluationFrame.AddSensitiveInputCell(NPOI.SS.Formula.CellCacheEntry)">
  33547. @param inputCell a cell directly used by the formula of this evaluation frame
  33548. </member>
  33549. <member name="M:NPOI.SS.Formula.CellEvaluationFrame.GetSensitiveInputCells">
  33550. @return never <c>null</c>, (possibly empty) array of all cells directly used while
  33551. evaluating the formula of this frame.
  33552. </member>
  33553. <member name="T:NPOI.SS.Formula.CollaboratingWorkbooksEnvironment">
  33554. Manages a collection of {@link WorkbookEvaluator}s, in order To support evaluation of formulas
  33555. across spreadsheets.<p/>
  33556. For POI internal use only
  33557. @author Josh Micich
  33558. </member>
  33559. <member name="M:NPOI.SS.Formula.CollaboratingWorkbooksEnvironment.Unhook">
  33560. </member>
  33561. <member name="T:NPOI.SS.Formula.Constant.ConstantValueParser">
  33562. To support Constant Values (2.5.7) as required by the CRN record.
  33563. This class is also used for two dimensional arrays which are encoded by
  33564. EXTERNALNAME (5.39) records and Array tokens.<p/>
  33565. @author Josh Micich
  33566. </member>
  33567. <member name="M:NPOI.SS.Formula.Constant.ConstantValueParser.GetEncodedSize(System.Object)">
  33568. @return encoded size without the 'type' code byte
  33569. </member>
  33570. <member name="T:NPOI.SS.Formula.Constant.ErrorConstant">
  33571. <summary>
  33572. Represents a constant error code value as encoded in a constant values array.
  33573. This class is a type-safe wrapper for a 16-bit int value performing a similar job to
  33574. <c>ErrorEval</c>
  33575. </summary>
  33576. <remarks> @author Josh Micich</remarks>
  33577. </member>
  33578. <member name="M:NPOI.SS.Formula.Constant.ErrorConstant.#ctor(System.Int32)">
  33579. <summary>
  33580. Initializes a new instance of the <see cref="T:NPOI.SS.Formula.Constant.ErrorConstant"/> class.
  33581. </summary>
  33582. <param name="errorCode">The error code.</param>
  33583. </member>
  33584. <member name="P:NPOI.SS.Formula.Constant.ErrorConstant.ErrorCode">
  33585. <summary>
  33586. Gets the error code.
  33587. </summary>
  33588. <value>The error code.</value>
  33589. </member>
  33590. <member name="P:NPOI.SS.Formula.Constant.ErrorConstant.Text">
  33591. <summary>
  33592. Gets the text.
  33593. </summary>
  33594. <value>The text.</value>
  33595. </member>
  33596. <member name="M:NPOI.SS.Formula.Constant.ErrorConstant.ValueOf(System.Int32)">
  33597. <summary>
  33598. Values the of.
  33599. </summary>
  33600. <param name="errorCode">The error code.</param>
  33601. <returns></returns>
  33602. </member>
  33603. <member name="M:NPOI.SS.Formula.Constant.ErrorConstant.ToString">
  33604. <summary>
  33605. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  33606. </summary>
  33607. <returns>
  33608. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  33609. </returns>
  33610. </member>
  33611. <member name="M:NPOI.SS.Formula.DataValidationEvaluator.IsType(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.CellType)">
  33612. * Note that this assumes the cell cached value is up to date and in sync with data edits
  33613. *
  33614. * @param cell The {@link Cell} to check.
  33615. * @param type The {@link CellType} to check for.
  33616. * @return true if the cell or cached cell formula result type match the given type
  33617. </member>
  33618. <member name="T:NPOI.SS.Formula.EvaluationCache">
  33619. Performance optimisation for {@link HSSFFormulaEvaluator}. This class stores previously
  33620. calculated values of already visited cells, To avoid unnecessary re-calculation when the
  33621. same cells are referenced multiple times
  33622. @author Josh Micich
  33623. </member>
  33624. <member name="F:NPOI.SS.Formula.EvaluationCache._evaluationListener">
  33625. only used for testing. <c>null</c> otherwise
  33626. </member>
  33627. <member name="M:NPOI.SS.Formula.EvaluationCache.Clear">
  33628. Should be called whenever there are Changes To input cells in the evaluated workbook.
  33629. </member>
  33630. <member name="T:NPOI.SS.Formula.IEvaluationCell">
  33631. Abstracts a cell for the purpose of formula evaluation. This interface represents both formula
  33632. and non-formula cells.<br/>
  33633. Implementors of this class must implement {@link #HashCode()} and {@link #Equals(Object)}
  33634. To provide an <em>identity</em> relationship based on the underlying HSSF or XSSF cell <p/>
  33635. For POI internal use only
  33636. @author Josh Micich
  33637. </member>
  33638. <member name="T:NPOI.SS.Formula.EvaluationConditionalFormatRule.ValueAndFormat">
  33639. Note: this class has a natural ordering that is inconsistent with equals.
  33640. </member>
  33641. <member name="M:NPOI.SS.Formula.EvaluationConditionalFormatRule.ValueAndFormat.CompareTo(NPOI.SS.Formula.EvaluationConditionalFormatRule.ValueAndFormat)">
  33642. Note: this class has a natural ordering that is inconsistent with equals.
  33643. @param o
  33644. @return value comparison
  33645. </member>
  33646. <member name="F:NPOI.SS.Formula.EvaluationConditionalFormatRule.meaningfulRegionValues">
  33647. Depending on the rule type, it may want to know about certain values in the region when evaluating {@link #matches(CellReference)},
  33648. such as top 10, unique, duplicate, average, etc. This collection stores those if needed so they are not repeatedly calculated
  33649. </member>
  33650. <member name="T:NPOI.SS.Formula.IEvaluationName">
  33651. Abstracts a name record for formula evaluation.<br/>
  33652. For POI internal use only
  33653. @author Josh Micich
  33654. </member>
  33655. <member name="T:NPOI.SS.Formula.IEvaluationSheet">
  33656. Abstracts a sheet for the purpose of formula evaluation.<br/>
  33657. For POI internal use only
  33658. @author Josh Micich
  33659. </member>
  33660. <member name="M:NPOI.SS.Formula.IEvaluationSheet.GetCell(System.Int32,System.Int32)">
  33661. @return <c>null</c> if there is no cell at the specified coordinates
  33662. </member>
  33663. <member name="M:NPOI.SS.Formula.IEvaluationSheet.ClearAllCachedResultValues">
  33664. Propagated from {@link EvaluationWorkbook#clearAllCachedResultValues()} to clear locally cached data.
  33665. @see WorkbookEvaluator#clearAllCachedResultValues()
  33666. @see EvaluationWorkbook#clearAllCachedResultValues()
  33667. </member>
  33668. <member name="T:NPOI.SS.Formula.EvaluationTracker">
  33669. <summary>
  33670. Instances of this class keep track of multiple dependent cell evaluations due
  33671. To recursive calls To <see cref="M:NPOI.SS.Formula.WorkbookEvaluator.Evaluate(NPOI.SS.Formula.IEvaluationCell)"/>
  33672. The main purpose of this class is To detect an attempt To evaluate a cell
  33673. that is already being evaluated. In other words, it detects circular
  33674. references in spreadsheet formulas.
  33675. </summary>
  33676. <remarks>
  33677. @author Josh Micich
  33678. </remarks>
  33679. </member>
  33680. <member name="M:NPOI.SS.Formula.EvaluationTracker.StartEvaluate(NPOI.SS.Formula.FormulaCellCacheEntry)">
  33681. Notifies this evaluation tracker that evaluation of the specified cell Is
  33682. about To start.<br/>
  33683. In the case of a <c>true</c> return code, the caller should
  33684. continue evaluation of the specified cell, and also be sure To call
  33685. <c>endEvaluate()</c> when complete.<br/>
  33686. In the case of a <c>null</c> return code, the caller should
  33687. return an evaluation result of
  33688. <c>ErrorEval.CIRCULAR_REF_ERROR</c>, and not call <c>endEvaluate()</c>.
  33689. <br/>
  33690. @return <c>false</c> if the specified cell is already being evaluated
  33691. </member>
  33692. <member name="M:NPOI.SS.Formula.EvaluationTracker.EndEvaluate(NPOI.SS.Formula.CellCacheEntry)">
  33693. Notifies this evaluation tracker that the evaluation of the specified cell is complete. <p/>
  33694. Every successful call To <c>startEvaluate</c> must be followed by a call To <c>endEvaluate</c> (recommended in a finally block) To enable
  33695. proper tracking of which cells are being evaluated at any point in time.<p/>
  33696. Assuming a well behaved client, parameters To this method would not be
  33697. required. However, they have been included To assert correct behaviour,
  33698. and form more meaningful error messages.
  33699. </member>
  33700. <member name="T:NPOI.SS.Formula.IEvaluationWorkbook">
  33701. Abstracts a workbook for the purpose of formula evaluation.<br/>
  33702. For POI internal use only
  33703. @author Josh Micich
  33704. </member>
  33705. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.GetSheetIndex(NPOI.SS.Formula.IEvaluationSheet)">
  33706. @return -1 if the specified sheet is from a different book
  33707. </member>
  33708. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.GetExternalSheet(System.Int32)">
  33709. HSSF Only - fetch the external-style sheet details
  33710. <p>Return will have no workbook set if it's actually in our own workbook</p>
  33711. </member>
  33712. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.GetExternalSheet(System.String,System.String,System.Int32)">
  33713. XSSF Only - fetch the external-style sheet details
  33714. <p>Return will have no workbook set if it's actually in our own workbook</p>
  33715. </member>
  33716. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.ConvertFromExternSheetIndex(System.Int32)">
  33717. HSSF Only - convert an external sheet index to an internal sheet index,
  33718. for an external-style reference to one of this workbook's own sheets
  33719. </member>
  33720. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.GetExternalName(System.Int32,System.Int32)">
  33721. HSSF Only - fetch the external-style name details
  33722. </member>
  33723. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.GetExternalName(System.String,System.String,System.Int32)">
  33724. XSSF Only - fetch the external-style name details
  33725. </member>
  33726. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.ClearAllCachedResultValues">
  33727. Propagated from {@link WorkbookEvaluator#clearAllCachedResultValues()} to clear locally cached data.
  33728. Implementations must call the same method on all referenced {@link EvaluationSheet} instances, as well as clearing local caches.
  33729. @see WorkbookEvaluator#clearAllCachedResultValues()
  33730. </member>
  33731. <member name="T:NPOI.SS.Formula.Eval.AreaEval">
  33732. Evaluation of 2D (Row+Column) and 3D (Sheet+Row+Column) areas
  33733. </member>
  33734. <member name="P:NPOI.SS.Formula.Eval.AreaEval.FirstRow">
  33735. returns the 0-based index of the first row in
  33736. this area.
  33737. </member>
  33738. <member name="P:NPOI.SS.Formula.Eval.AreaEval.LastRow">
  33739. returns the 0-based index of the last row in
  33740. this area.
  33741. </member>
  33742. <member name="P:NPOI.SS.Formula.Eval.AreaEval.FirstColumn">
  33743. returns the 0-based index of the first col in
  33744. this area.
  33745. </member>
  33746. <member name="P:NPOI.SS.Formula.Eval.AreaEval.LastColumn">
  33747. returns the 0-based index of the last col in
  33748. this area.
  33749. </member>
  33750. <member name="M:NPOI.SS.Formula.Eval.AreaEval.Contains(System.Int32,System.Int32)">
  33751. returns true if the cell at row and col specified
  33752. as absolute indexes in the sheet is contained in
  33753. this area.
  33754. @param row
  33755. @param col
  33756. </member>
  33757. <member name="M:NPOI.SS.Formula.Eval.AreaEval.ContainsColumn(System.Int32)">
  33758. returns true if the specified col is in range
  33759. @param col
  33760. </member>
  33761. <member name="M:NPOI.SS.Formula.Eval.AreaEval.ContainsRow(System.Int32)">
  33762. returns true if the specified row is in range
  33763. @param row
  33764. </member>
  33765. <member name="M:NPOI.SS.Formula.Eval.AreaEval.GetAbsoluteValue(System.Int32,System.Int32)">
  33766. @return the ValueEval from within this area at the specified row and col index. Never
  33767. <code>null</code> (possibly {@link BlankEval}). The specified indexes should be absolute
  33768. indexes in the sheet and not relative indexes within the area.
  33769. </member>
  33770. <member name="M:NPOI.SS.Formula.Eval.AreaEval.GetRelativeValue(System.Int32,System.Int32)">
  33771. @return the ValueEval from within this area at the specified relativeRowIndex and
  33772. relativeColumnIndex. Never <c>null</c> (possibly {@link BlankEval}). The
  33773. specified indexes should relative to the top left corner of this area.
  33774. </member>
  33775. <member name="M:NPOI.SS.Formula.Eval.AreaEval.Offset(System.Int32,System.Int32,System.Int32,System.Int32)">
  33776. Creates an {@link AreaEval} offset by a relative amount from from the upper left cell
  33777. of this area
  33778. </member>
  33779. <member name="T:NPOI.SS.Formula.Eval.AreaEvalBase">
  33780. @author Josh Micich
  33781. </member>
  33782. <member name="M:NPOI.SS.Formula.Eval.AreaEvalBase.IsSubTotal(System.Int32,System.Int32)">
  33783. @return whether cell at rowIndex and columnIndex is a subtotal.
  33784. By default return false which means 'don't care about subtotals'
  33785. </member>
  33786. <member name="T:NPOI.SS.Formula.Eval.BlankEval">
  33787. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt; This class is a
  33788. marker class. It is a special value for empty cells.
  33789. </member>
  33790. <member name="T:NPOI.SS.Formula.Eval.BoolEval">
  33791. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33792. </member>
  33793. <member name="M:NPOI.SS.Formula.Eval.BoolEval.ValueOf(System.Boolean)">
  33794. Convenience method for the following:<br/>
  33795. <c>(b ? BoolEval.TRUE : BoolEval.FALSE)</c>
  33796. @return a <c>BoolEval</c> instance representing <c>b</c>.
  33797. </member>
  33798. <member name="T:NPOI.SS.Formula.Eval.ConcatEval">
  33799. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33800. </member>
  33801. <member name="T:NPOI.SS.Formula.Eval.ErrorEval">
  33802. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33803. </member>
  33804. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.NULL_INTERSECTION">
  33805. <b>#NULL!</b> - Intersection of two cell ranges is empty
  33806. </member>
  33807. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.DIV_ZERO">
  33808. <b>#DIV/0!</b> - Division by zero
  33809. </member>
  33810. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.VALUE_INVALID">
  33811. <b>#VALUE!</b> - Wrong type of operand
  33812. </member>
  33813. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.REF_INVALID">
  33814. <b>#REF!</b> - Illegal or deleted cell reference
  33815. </member>
  33816. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.NAME_INVALID">
  33817. <b>#NAME?</b> - Wrong function or range name
  33818. </member>
  33819. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.NUM_ERROR">
  33820. <b>#NUM!</b> - Value range overflow
  33821. </member>
  33822. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.NA">
  33823. <b>#N/A</b> - Argument or function not available
  33824. </member>
  33825. <member name="M:NPOI.SS.Formula.Eval.ErrorEval.ValueOf(System.Int32)">
  33826. Translates an Excel internal error code into the corresponding POI ErrorEval instance
  33827. @param errorCode
  33828. </member>
  33829. <member name="M:NPOI.SS.Formula.Eval.ErrorEval.GetText(System.Int32)">
  33830. Converts error codes to text. Handles non-standard error codes OK.
  33831. For debug/test purposes (and for formatting error messages).
  33832. @return the String representation of the specified Excel error code.
  33833. </member>
  33834. <member name="T:NPOI.SS.Formula.Eval.Eval">
  33835. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33836. </member>
  33837. <member name="T:NPOI.SS.Formula.Eval.EvaluationException">
  33838. This class is used to simplify error handling logic <i>within</i> operator and function
  33839. implementations. Note - <c>OperationEval.Evaluate()</c> and <c>Function.Evaluate()</c>
  33840. method signatures do not throw this exception so it cannot propagate outside.<p/>
  33841. Here is an example coded without <c>EvaluationException</c>, to show how it can help:
  33842. <pre>
  33843. public Eval Evaluate(Eval[] args, int srcRow, short srcCol) {
  33844. // ...
  33845. Eval arg0 = args[0];
  33846. if(arg0 is ErrorEval) {
  33847. return arg0;
  33848. }
  33849. if(!(arg0 is AreaEval)) {
  33850. return ErrorEval.VALUE_INVALID;
  33851. }
  33852. double temp = 0;
  33853. AreaEval area = (AreaEval)arg0;
  33854. ValueEval[] values = area.LittleEndianConstants.BYTE_SIZE;
  33855. for (int i = 0; i &lt; values.Length; i++) {
  33856. ValueEval ve = values[i];
  33857. if(ve is ErrorEval) {
  33858. return ve;
  33859. }
  33860. if(!(ve is NumericValueEval)) {
  33861. return ErrorEval.VALUE_INVALID;
  33862. }
  33863. temp += ((NumericValueEval)ve).NumberValue;
  33864. }
  33865. // ...
  33866. }
  33867. </pre>
  33868. In this example, if any error is encountered while Processing the arguments, an error is
  33869. returned immediately. This code is difficult to refactor due to all the points where errors
  33870. are returned.<br/>
  33871. Using <c>EvaluationException</c> allows the error returning code to be consolidated to one
  33872. place.<p/>
  33873. <pre>
  33874. public Eval Evaluate(Eval[] args, int srcRow, short srcCol) {
  33875. try {
  33876. // ...
  33877. AreaEval area = GetAreaArg(args[0]);
  33878. double temp = sumValues(area.LittleEndianConstants.BYTE_SIZE);
  33879. // ...
  33880. } catch (EvaluationException e) {
  33881. return e.GetErrorEval();
  33882. }
  33883. }
  33884. private static AreaEval GetAreaArg(Eval arg0){
  33885. if (arg0 is ErrorEval) {
  33886. throw new EvaluationException((ErrorEval) arg0);
  33887. }
  33888. if (arg0 is AreaEval) {
  33889. return (AreaEval) arg0;
  33890. }
  33891. throw EvaluationException.InvalidValue();
  33892. }
  33893. private double sumValues(ValueEval[] values){
  33894. double temp = 0;
  33895. for (int i = 0; i &lt; values.Length; i++) {
  33896. ValueEval ve = values[i];
  33897. if (ve is ErrorEval) {
  33898. throw new EvaluationException((ErrorEval) ve);
  33899. }
  33900. if (!(ve is NumericValueEval)) {
  33901. throw EvaluationException.InvalidValue();
  33902. }
  33903. temp += ((NumericValueEval) ve).NumberValue;
  33904. }
  33905. return temp;
  33906. }
  33907. </pre>
  33908. It is not mandatory to use EvaluationException, doing so might give the following advantages:<br/>
  33909. - Methods can more easily be extracted, allowing for re-use.<br/>
  33910. - Type management (typecasting etc) is simpler because error conditions have been Separated from
  33911. intermediate calculation values.<br/>
  33912. - Fewer local variables are required. Local variables can have stronger types.<br/>
  33913. - It is easier to mimic common Excel error handling behaviour (exit upon encountering first
  33914. error), because exceptions conveniently propagate up the call stack regardless of execution
  33915. points or the number of levels of nested calls.<p/>
  33916. <b>Note</b> - Only standard evaluation errors are represented by <c>EvaluationException</c> (
  33917. i.e. conditions expected to be encountered when evaluating arbitrary Excel formulas). Conditions
  33918. that could never occur in an Excel spReadsheet should result in runtime exceptions. Care should
  33919. be taken to not translate any POI internal error into an Excel evaluation error code.
  33920. @author Josh Micich
  33921. </member>
  33922. <member name="M:NPOI.SS.Formula.Eval.EvaluationException.InvalidValue">
  33923. <b>#VALUE!</b> - Wrong type of operand
  33924. </member>
  33925. <member name="M:NPOI.SS.Formula.Eval.EvaluationException.InvalidRef">
  33926. <b>#REF!</b> - Illegal or deleted cell reference
  33927. </member>
  33928. <member name="M:NPOI.SS.Formula.Eval.EvaluationException.NumberError">
  33929. <b>#NUM!</b> - Value range overflow
  33930. </member>
  33931. <member name="T:NPOI.SS.Formula.Eval.ExternalNameEval">
  33932. Evaluation of a Name defined in a Sheet or Workbook scope
  33933. </member>
  33934. <member name="T:NPOI.SS.Formula.Eval.Forked.ForkedEvaluationCell">
  33935. Represents a cell being used for forked Evaluation that has had a value Set different from the
  33936. corresponding cell in the shared master workbook.
  33937. @author Josh Micich
  33938. </member>
  33939. <member name="F:NPOI.SS.Formula.Eval.Forked.ForkedEvaluationCell._masterCell">
  33940. corresponding cell from master workbook
  33941. </member>
  33942. <member name="T:NPOI.SS.Formula.Eval.Forked.ForkedEvaluationSheet">
  33943. Represents a sheet being used for forked Evaluation. Initially, objects of this class contain
  33944. only the cells from the master workbook. By calling {@link #getOrCreateUpdatableCell(int, int)},
  33945. the master cell object is logically Replaced with a {@link ForkedEvaluationCell} instance, which
  33946. will be used in all subsequent Evaluations.
  33947. @author Josh Micich
  33948. </member>
  33949. <member name="F:NPOI.SS.Formula.Eval.Forked.ForkedEvaluationSheet._sharedCellsByRowCol">
  33950. Only cells which have been split are Put in this map. (This has been done to conserve memory).
  33951. </member>
  33952. <member name="T:NPOI.SS.Formula.Eval.Forked.ForkedEvaluationWorkbook">
  33953. Represents a workbook being used for forked Evaluation. Most operations are delegated to the
  33954. shared master workbook, except those that potentially involve cell values that may have been
  33955. updated After a call to {@link #getOrCreateUpdatableCell(String, int, int)}.
  33956. </member>
  33957. <member name="T:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator">
  33958. An alternative workbook Evaluator that saves memory in situations where a single workbook is
  33959. concurrently and independently Evaluated many times. With standard formula Evaluation, around
  33960. 90% of memory consumption is due to loading of the {@link HSSFWorkbook} or {@link NPOI.xssf.usermodel.XSSFWorkbook}.
  33961. This class enables a 'master workbook' to be loaded just once and shared between many Evaluation
  33962. clients. Each Evaluation client Creates its own {@link ForkedEvaluator} and can Set cell values
  33963. that will be used for local Evaluations (and don't disturb Evaluations on other Evaluators).
  33964. @author Josh Micich
  33965. </member>
  33966. <member name="M:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator.Create(NPOI.SS.UserModel.IWorkbook,NPOI.SS.Formula.IStabilityClassifier,NPOI.SS.Formula.UDF.UDFFinder)">
  33967. @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
  33968. </member>
  33969. <member name="M:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator.UpdateCell(System.String,System.Int32,System.Int32,NPOI.SS.Formula.Eval.ValueEval)">
  33970. Sets the specified cell to the supplied <tt>value</tt>
  33971. @param sheetName the name of the sheet Containing the cell
  33972. @param rowIndex zero based
  33973. @param columnIndex zero based
  33974. </member>
  33975. <member name="M:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator.CopyUpdatedCells(NPOI.SS.UserModel.IWorkbook)">
  33976. Copies the values of all updated cells (modified by calls to {@link
  33977. #updateCell(String, int, int, ValueEval)}) to the supplied <tt>workbook</tt>.<br/>
  33978. Typically, the supplied <tt>workbook</tt> is a writable copy of the 'master workbook',
  33979. but at the very least it must contain sheets with the same names.
  33980. </member>
  33981. <member name="M:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator.Evaluate(System.String,System.Int32,System.Int32)">
  33982. If cell Contains a formula, the formula is Evaluated and returned,
  33983. else the CellValue simply copies the appropriate cell value from
  33984. the cell and also its cell type. This method should be preferred over
  33985. EvaluateInCell() when the call should not modify the contents of the
  33986. original cell.
  33987. @param sheetName the name of the sheet Containing the cell
  33988. @param rowIndex zero based
  33989. @param columnIndex zero based
  33990. @return <code>null</code> if the supplied cell is <code>null</code> or blank
  33991. </member>
  33992. <member name="M:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator.SetupEnvironment(System.String[],NPOI.SS.Formula.Eval.Forked.ForkedEvaluator[])">
  33993. Coordinates several formula Evaluators together so that formulas that involve external
  33994. references can be Evaluated.
  33995. @param workbookNames the simple file names used to identify the workbooks in formulas
  33996. with external links (for example "MyData.xls" as used in a formula "[MyData.xls]Sheet1!A1")
  33997. @param Evaluators all Evaluators for the full Set of workbooks required by the formulas.
  33998. </member>
  33999. <member name="T:NPOI.SS.Formula.Eval.FunctionEval">
  34000. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34001. </member>
  34002. <member name="T:NPOI.SS.Formula.Eval.FunctionEval.FunctionID">
  34003. Some function IDs that require special treatment
  34004. </member>
  34005. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.IF">
  34006. 1
  34007. </member>
  34008. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.OFFSET">
  34009. 78
  34010. </member>
  34011. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.CHOOSE">
  34012. 100
  34013. </member>
  34014. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.INDIRECT">
  34015. 148
  34016. </member>
  34017. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.EXTERNAL_FUNC">
  34018. 255
  34019. </member>
  34020. <member name="M:NPOI.SS.Formula.Eval.FunctionEval.ProduceFunctions">
  34021. @see https://www.openoffice.org/sc/excelfileformat.pdf
  34022. </member>
  34023. <member name="M:NPOI.SS.Formula.Eval.FunctionEval.RegisterFunction(System.String,NPOI.SS.Formula.Functions.Function)">
  34024. Register a new function in runtime.
  34025. @param name the function name
  34026. @param func the functoin to register
  34027. @throws ArgumentException if the function is unknown or already registered.
  34028. @since 3.8 beta6
  34029. </member>
  34030. <member name="M:NPOI.SS.Formula.Eval.FunctionEval.GetSupportedFunctionNames">
  34031. Returns a collection of function names implemented by POI.
  34032. @return an array of supported functions
  34033. @since 3.8 beta6
  34034. </member>
  34035. <member name="M:NPOI.SS.Formula.Eval.FunctionEval.GetNotSupportedFunctionNames">
  34036. Returns an array of function names NOT implemented by POI.
  34037. @return an array of not supported functions
  34038. @since 3.8 beta6
  34039. </member>
  34040. <member name="T:NPOI.SS.Formula.Eval.FunctionNameEval">
  34041. @author Josh Micich
  34042. </member>
  34043. <member name="M:NPOI.SS.Formula.Eval.FunctionNameEval.#ctor(System.String)">
  34044. Creates a NameEval representing a function name
  34045. </member>
  34046. <member name="T:NPOI.SS.Formula.Eval.IntersectionEval">
  34047. @author Josh Micich
  34048. </member>
  34049. <member name="M:NPOI.SS.Formula.Eval.IntersectionEval.ResolveRange(NPOI.SS.Formula.Eval.AreaEval,NPOI.SS.Formula.Eval.AreaEval)">
  34050. @return simple rectangular {@link AreaEval} which represents the intersection of areas
  34051. <c>aeA</c> and <c>aeB</c>. If the two areas do not intersect, the result is <code>null</code>.
  34052. </member>
  34053. <member name="T:NPOI.SS.Formula.Eval.NotImplementedFunctionException">
  34054. An exception thrown by implementors of {@link FormulaEvaluator} when
  34055. attempting to evaluate a formula which requires a function that POI
  34056. does not (yet) support.
  34057. </member>
  34058. <member name="T:NPOI.SS.Formula.Eval.NumberEval">
  34059. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34060. </member>
  34061. <member name="T:NPOI.SS.Formula.Eval.NumericValueEval">
  34062. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34063. </member>
  34064. <member name="T:NPOI.SS.Formula.Eval.OperandResolver">
  34065. Provides functionality for evaluating arguments to functions and operators.
  34066. @author Josh Micich
  34067. </member>
  34068. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.GetSingleValue(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  34069. Retrieves a single value from a variety of different argument types according to standard
  34070. Excel rules. Does not perform any type conversion.
  34071. @param arg the Evaluated argument as passed to the function or operator.
  34072. @param srcCellRow used when arg is a single column AreaRef
  34073. @param srcCellCol used when arg is a single row AreaRef
  34074. @return a <c>NumberEval</c>, <c>StringEval</c>, <c>BoolEval</c> or <c>BlankEval</c>.
  34075. Never <c>null</c> or <c>ErrorEval</c>.
  34076. @throws EvaluationException(#VALUE!) if srcCellRow or srcCellCol do not properly index into
  34077. an AreaEval. If the actual value retrieved is an ErrorEval, a corresponding
  34078. EvaluationException is thrown.
  34079. </member>
  34080. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.ChooseSingleElementFromArea(NPOI.SS.Formula.Eval.AreaEval,System.Int32,System.Int32)">
  34081. Implements (some perhaps not well known) Excel functionality to select a single cell from an
  34082. area depending on the coordinates of the calling cell. Here is an example demonstrating
  34083. both selection from a single row area and a single column area in the same formula.
  34084. <table border="1" cellpAdding="1" cellspacing="1" summary="sample spReadsheet">
  34085. <tr><th> </th><th> A </th><th> B </th><th> C </th><th> D </th></tr>
  34086. <tr><th>1</th><td>15</td><td>20</td><td>25</td><td> </td></tr>
  34087. <tr><th>2</th><td> </td><td> </td><td> </td><td>200</td></tr>
  34088. <tr><th>3</th><td> </td><td> </td><td> </td><td>300</td></tr>
  34089. <tr><th>3</th><td> </td><td> </td><td> </td><td>400</td></tr>
  34090. </table>
  34091. If the formula "=1000+A1:B1+D2:D3" is put into the 9 cells from A2 to C4, the spReadsheet
  34092. will look like this:
  34093. <table border="1" cellpAdding="1" cellspacing="1" summary="sample spReadsheet">
  34094. <tr><th> </th><th> A </th><th> B </th><th> C </th><th> D </th></tr>
  34095. <tr><th>1</th><td>15</td><td>20</td><td>25</td><td> </td></tr>
  34096. <tr><th>2</th><td>1215</td><td>1220</td><td>#VALUE!</td><td>200</td></tr>
  34097. <tr><th>3</th><td>1315</td><td>1320</td><td>#VALUE!</td><td>300</td></tr>
  34098. <tr><th>4</th><td>#VALUE!</td><td>#VALUE!</td><td>#VALUE!</td><td>400</td></tr>
  34099. </table>
  34100. Note that the row area (A1:B1) does not include column C and the column area (D2:D3) does
  34101. not include row 4, so the values in C1(=25) and D4(=400) are not accessible to the formula
  34102. as written, but in the 4 cells A2:B3, the row and column selection works ok.<p/>
  34103. The same concept is extended to references across sheets, such that even multi-row,
  34104. multi-column areas can be useful.<p/>
  34105. Of course with carefully (or carelessly) chosen parameters, cyclic references can occur and
  34106. hence this method <b>can</b> throw a 'circular reference' EvaluationException. Note that
  34107. this method does not attempt to detect cycles. Every cell in the specified Area <c>ae</c>
  34108. has already been Evaluated prior to this method call. Any cell (or cell<b>s</b>) part of
  34109. <c>ae</c> that would incur a cyclic reference error if selected by this method, will
  34110. already have the value <c>ErrorEval.CIRCULAR_REF_ERROR</c> upon entry to this method. It
  34111. is assumed logic exists elsewhere to produce this behaviour.
  34112. @return whatever the selected cell's Evaluated value Is. Never <c>null</c>. Never
  34113. <c>ErrorEval</c>.
  34114. @if there is a problem with indexing into the area, or if the
  34115. Evaluated cell has an error.
  34116. </member>
  34117. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.ChooseSingleElementFromAreaInternal(NPOI.SS.Formula.Eval.AreaEval,System.Int32,System.Int32)">
  34118. @return possibly <c>ErrorEval</c>, and <c>null</c>
  34119. </member>
  34120. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.CoerceValueToInt(NPOI.SS.Formula.Eval.ValueEval)">
  34121. Applies some conversion rules if the supplied value is not already an integer.<br/>
  34122. Value is first Coerced to a <c>double</c> ( See <c>CoerceValueTodouble()</c> ).<p/>
  34123. Excel typically Converts doubles to integers by truncating toward negative infinity.<br/>
  34124. The equivalent java code Is:<br/>
  34125. <c>return (int)Math.floor(d);</c><br/>
  34126. <b>not</b>:<br/>
  34127. <c>return (int)d; // wrong - rounds toward zero</c>
  34128. </member>
  34129. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.CoerceValueToDouble(NPOI.SS.Formula.Eval.ValueEval)">
  34130. Applies some conversion rules if the supplied value is not already a number.
  34131. Note - <c>BlankEval</c> is not supported and must be handled by the caller.
  34132. @param ev must be a <c>NumberEval</c>, <c>StringEval</c> or <c>BoolEval</c>
  34133. @return actual, Parsed or interpreted double value (respectively).
  34134. @throws EvaluationException(#VALUE!) only if a StringEval is supplied and cannot be Parsed
  34135. as a double (See <c>Parsedouble()</c> for allowable formats).
  34136. @throws Exception if the supplied parameter is not <c>NumberEval</c>,
  34137. <c>StringEval</c> or <c>BoolEval</c>
  34138. </member>
  34139. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.ParseDouble(System.String)">
  34140. Converts a string to a double using standard rules that Excel would use.<br/>
  34141. Tolerates currency prefixes, commas, leading and trailing spaces.<p/>
  34142. Some examples:<br/>
  34143. " 123 " -&gt; 123.0<br/>
  34144. ".123" -&gt; 0.123<br/>
  34145. These not supported yet:<br/>
  34146. " $ 1,000.00 " -&gt; 1000.0<br/>
  34147. "$1.25E4" -&gt; 12500.0<br/>
  34148. "5**2" -&gt; 500<br/>
  34149. "250%" -&gt; 2.5<br/>
  34150. @param text
  34151. @return <c>null</c> if the specified text cannot be Parsed as a number
  34152. </member>
  34153. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.CoerceValueToString(NPOI.SS.Formula.Eval.ValueEval)">
  34154. @param ve must be a <c>NumberEval</c>, <c>StringEval</c>, <c>BoolEval</c>, or <c>BlankEval</c>
  34155. @return the Converted string value. never <c>null</c>
  34156. </member>
  34157. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.CoerceValueToBoolean(NPOI.SS.Formula.Eval.ValueEval,System.Boolean)">
  34158. @return <c>null</c> to represent blank values
  34159. @throws EvaluationException if ve is an ErrorEval, or if a string value cannot be converted
  34160. </member>
  34161. <!-- Badly formed XML comment ignored for member "M:NPOI.SS.Formula.Eval.OperandResolver.GetElementFromArray(NPOI.SS.Formula.Eval.AreaEval,NPOI.SS.Formula.IEvaluationCell)" -->
  34162. <member name="T:NPOI.SS.Formula.Eval.OperationEval">
  34163. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34164. </member>
  34165. <member name="T:NPOI.SS.Formula.Eval.PercentEval">
  34166. Implementation of Excel formula token '%'. <p/>
  34167. @author Josh Micich
  34168. </member>
  34169. <member name="T:NPOI.SS.Formula.Eval.RangeEval">
  34170. @author Josh Micich
  34171. </member>
  34172. <member name="T:NPOI.SS.Formula.Eval.RefEval">
  34173. @author Amol S Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34174. RefEval is the base interface for Ref2D and Ref3DEval. Basically a RefEval
  34175. impl should contain reference to the original ReferencePtg or Ref3DPtg as
  34176. well as the "value" resulting from the evaluation of the cell
  34177. reference. Thus if the HSSFCell has type CELL_TYPE_NUMERIC, the contained
  34178. value object should be of type NumberEval; if cell type is CELL_TYPE_STRING,
  34179. contained value object should be of type StringEval
  34180. </member>
  34181. <member name="M:NPOI.SS.Formula.Eval.RefEval.GetInnerValueEval(System.Int32)">
  34182. The (possibly Evaluated) ValueEval contained
  34183. in this RefEval. eg. if cell A1 Contains "test"
  34184. then in a formula referring to cell A1
  34185. the RefEval representing
  34186. A1 will return as the InnerValueEval the
  34187. object of concrete type StringEval
  34188. </member>
  34189. <member name="P:NPOI.SS.Formula.Eval.RefEval.Column">
  34190. returns the zero based column index.
  34191. </member>
  34192. <member name="P:NPOI.SS.Formula.Eval.RefEval.Row">
  34193. returns the zero based row index.
  34194. </member>
  34195. <member name="P:NPOI.SS.Formula.Eval.RefEval.NumberOfSheets">
  34196. returns the number of sheets this applies to
  34197. </member>
  34198. <member name="M:NPOI.SS.Formula.Eval.RefEval.Offset(System.Int32,System.Int32,System.Int32,System.Int32)">
  34199. Creates an {@link AreaEval} offset by a relative amount from this RefEval
  34200. </member>
  34201. <member name="T:NPOI.SS.Formula.Eval.EqualEval">
  34202. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34203. </member>
  34204. <member name="T:NPOI.SS.Formula.Eval.GreaterEqualEval">
  34205. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34206. </member>
  34207. <member name="T:NPOI.SS.Formula.Eval.GreaterThanEval">
  34208. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34209. </member>
  34210. <member name="T:NPOI.SS.Formula.Eval.LessEqualEval">
  34211. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34212. </member>
  34213. <member name="T:NPOI.SS.Formula.Eval.LessThanEval">
  34214. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34215. </member>
  34216. <member name="T:NPOI.SS.Formula.Eval.NotEqualEval">
  34217. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34218. </member>
  34219. <member name="T:NPOI.SS.Formula.Eval.RelationalOperationEval">
  34220. @author Amol S. Deshmukh &lt; amolweb at ya hoo Dot com &gt;
  34221. </member>
  34222. <member name="T:NPOI.SS.Formula.Eval.StringEval">
  34223. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34224. </member>
  34225. <member name="T:NPOI.SS.Formula.Eval.StringValueEval">
  34226. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34227. </member>
  34228. <member name="P:NPOI.SS.Formula.Eval.StringValueEval.StringValue">
  34229. @return never <code>null</code>, possibly empty string.
  34230. </member>
  34231. <member name="T:NPOI.SS.Formula.Eval.AddEval">
  34232. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34233. This is a documentation of the observed behaviour of
  34234. the '+' operator in Excel:
  34235. - 1+TRUE = 2
  34236. - 1+FALSE = 1
  34237. - 1+"true" = #VALUE!
  34238. - 1+"1" = 2
  34239. - 1+A1 = #VALUE if A1 Contains "1"
  34240. - 1+A1 = 2 if A1 Contains ="1"
  34241. - 1+A1 = 2 if A1 Contains TRUE or =TRUE
  34242. - 1+A1 = #VALUE! if A1 Contains "TRUE" or ="TRUE"
  34243. </member>
  34244. <member name="T:NPOI.SS.Formula.Eval.DivideEval">
  34245. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34246. </member>
  34247. <member name="T:NPOI.SS.Formula.Eval.MultiplyEval">
  34248. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34249. </member>
  34250. <member name="T:NPOI.SS.Formula.Eval.PowerEval">
  34251. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34252. </member>
  34253. <member name="T:NPOI.SS.Formula.Eval.SubtractEval">
  34254. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34255. </member>
  34256. <member name="T:NPOI.SS.Formula.Eval.UnaryMinusEval">
  34257. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34258. </member>
  34259. <member name="T:NPOI.SS.Formula.Eval.UnaryPlusEval">
  34260. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34261. </member>
  34262. <member name="T:NPOI.SS.Formula.Eval.ValueEval">
  34263. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34264. </member>
  34265. <member name="T:NPOI.SS.Formula.IExternSheetReferenceToken">
  34266. Should be implemented by any {@link Ptg} subclass that needs Has an extern sheet index <br/>
  34267. For POI internal use only
  34268. @author Josh Micich
  34269. </member>
  34270. <member name="T:NPOI.SS.Formula.Formula">
  34271. Encapsulates an encoded formula token array.
  34272. @author Josh Micich
  34273. </member>
  34274. <member name="F:NPOI.SS.Formula.Formula._byteEncoding">
  34275. immutable
  34276. </member>
  34277. <member name="M:NPOI.SS.Formula.Formula.Read(System.Int32,NPOI.Util.ILittleEndianInput)">
  34278. Convenience method for {@link #read(int, LittleEndianInput, int)}
  34279. </member>
  34280. <member name="M:NPOI.SS.Formula.Formula.Read(System.Int32,NPOI.Util.ILittleEndianInput,System.Int32)">
  34281. When there are no array constants present, <c>encodedTokenLen</c>==<c>totalEncodedLen</c>
  34282. @param encodedTokenLen number of bytes in the stream taken by the plain formula tokens
  34283. @param totalEncodedLen the total number of bytes in the formula (includes trailing encoding
  34284. for array constants, but does not include 2 bytes for initial <c>ushort encodedTokenLen</c> field.
  34285. @return A new formula object as read from the stream. Possibly empty, never <code>null</code>.
  34286. </member>
  34287. <member name="M:NPOI.SS.Formula.Formula.Serialize(NPOI.Util.ILittleEndianOutput)">
  34288. Writes The formula encoding is includes:
  34289. <ul>
  34290. <li>ushort tokenDataLen</li>
  34291. <li>tokenData</li>
  34292. <li>arrayConstantData (if present)</li>
  34293. </ul>
  34294. </member>
  34295. <member name="P:NPOI.SS.Formula.Formula.EncodedSize">
  34296. @return total formula encoding length. The formula encoding includes:
  34297. <ul>
  34298. <li>ushort tokenDataLen</li>
  34299. <li>tokenData</li>
  34300. <li>arrayConstantData (optional)</li>
  34301. </ul>
  34302. Note - this value is different to <c>tokenDataLength</c>
  34303. </member>
  34304. <member name="P:NPOI.SS.Formula.Formula.EncodedTokenSize">
  34305. This method is often used when the formula length does not appear immediately before
  34306. the encoded token data.
  34307. @return the encoded length of the plain formula tokens. This does <em>not</em> include
  34308. the leading ushort field, nor any trailing array constant data.
  34309. </member>
  34310. <member name="M:NPOI.SS.Formula.Formula.Create(NPOI.SS.Formula.PTG.Ptg[])">
  34311. Creates a {@link Formula} object from a supplied {@link Ptg} array.
  34312. Handles <code>null</code>s OK.
  34313. @param ptgs may be <code>null</code>
  34314. @return Never <code>null</code> (Possibly empty if the supplied <c>ptgs</c> is <code>null</code>)
  34315. </member>
  34316. <member name="M:NPOI.SS.Formula.Formula.GetTokens(NPOI.SS.Formula.Formula)">
  34317. Gets the {@link Ptg} array from the supplied {@link Formula}.
  34318. Handles <code>null</code>s OK.
  34319. @param formula may be <code>null</code>
  34320. @return possibly <code>null</code> (if the supplied <c>formula</c> is <code>null</code>)
  34321. </member>
  34322. <member name="P:NPOI.SS.Formula.Formula.ExpReference">
  34323. Gets the locator for the corresponding {@link SharedFormulaRecord}, {@link ArrayRecord} or
  34324. {@link TableRecord} if this formula belongs to such a grouping. The {@link CellReference}
  34325. returned by this method will match the top left corner of the range of that grouping.
  34326. The return value is usually not the same as the location of the cell containing this formula.
  34327. @return the firstRow &amp; firstColumn of an array formula or shared formula that this formula
  34328. belongs to. <code>null</code> if this formula is not part of an array or shared formula.
  34329. </member>
  34330. <member name="T:NPOI.SS.Formula.FormulaCellCache">
  34331. @author Josh Micich
  34332. </member>
  34333. <member name="M:NPOI.SS.Formula.FormulaCellCache.Get(NPOI.SS.Formula.IEvaluationCell)">
  34334. @return <c>null</c> if not found
  34335. </member>
  34336. <member name="T:NPOI.SS.Formula.FormulaCellCacheEntry">
  34337. Stores the cached result of a formula evaluation, along with the Set of sensititive input cells
  34338. </member>
  34339. <member name="F:NPOI.SS.Formula.FormulaCellCacheEntry._sensitiveInputCells">
  34340. Cells 'used' in the current evaluation of the formula corresponding To this cache entry
  34341. If any of the following cells Change, this cache entry needs To be Cleared
  34342. </member>
  34343. <member name="T:NPOI.SS.Formula.FormulaCellCacheEntrySet">
  34344. A custom implementation of {@link java.util.HashSet} in order To reduce memory consumption.
  34345. Profiling tests (Oct 2008) have shown that each element {@link FormulaCellCacheEntry} takes
  34346. around 32 bytes To store in a HashSet, but around 6 bytes To store here. For Spreadsheets with
  34347. thousands of formula cells with multiple interdependencies, the savings can be very significant.
  34348. @author Josh Micich
  34349. </member>
  34350. <member name="T:NPOI.SS.Formula.FormulaParseException">
  34351. <summary>
  34352. Specific exception thrown when a supplied formula does not Parse properly.
  34353. Primarily used by test cases when testing for specific parsing exceptions.
  34354. </summary>
  34355. </member>
  34356. <member name="M:NPOI.SS.Formula.FormulaParseException.#ctor(System.String)">
  34357. <summary>
  34358. This class was given package scope until it would become Clear that it is useful to general client code.
  34359. </summary>
  34360. <param name="msg"></param>
  34361. </member>
  34362. <member name="F:NPOI.SS.Formula.FormulaParser.look">
  34363. Lookahead Character.
  34364. Gets value '\0' when the input string is exhausted
  34365. </member>
  34366. <member name="F:NPOI.SS.Formula.FormulaParser._inIntersection">
  34367. Tracks whether the run of whitespace preceeding "look" could be an
  34368. intersection operator. See GetChar.
  34369. </member>
  34370. <member name="M:NPOI.SS.Formula.FormulaParser.#ctor(System.String,NPOI.SS.Formula.IFormulaParsingWorkbook,System.Int32,System.Int32)">
  34371. Create the formula Parser, with the string that is To be
  34372. Parsed against the supplied workbook.
  34373. A later call the Parse() method To return ptg list in
  34374. rpn order, then call the GetRPNPtg() To retrive the
  34375. Parse results.
  34376. This class is recommended only for single threaded use.
  34377. If you only have a usermodel.HSSFWorkbook, and not a
  34378. model.Workbook, then use the convenience method on
  34379. usermodel.HSSFFormulaEvaluator
  34380. </member>
  34381. <member name="M:NPOI.SS.Formula.FormulaParser.Parse(System.String,NPOI.SS.Formula.IFormulaParsingWorkbook,NPOI.SS.Formula.FormulaType,System.Int32,System.Int32)">
  34382. * Parse a formula into a array of tokens
  34383. * Side effect: creates name (Workbook.createName) if formula contains unrecognized names (names are likely UDFs)
  34384. *
  34385. * @param formula the formula to parse
  34386. * @param workbook the parent workbook
  34387. * @param formulaType the type of the formula, see {@link FormulaType}
  34388. * @param sheetIndex the 0-based index of the sheet this formula belongs to.
  34389. * @param rowIndex - the related cell's row index in 0-based form (-1 if the formula is not cell related)
  34390. * used to handle structured references that have the "#This Row" quantifier.
  34391. * The sheet index is required to resolve sheet-level names. <code>-1</code> means that
  34392. * the scope of the name will be ignored and the parser will match names only by name
  34393. *
  34394. * @return array of parsed tokens
  34395. * @throws FormulaParseException if the formula is unparsable
  34396. </member>
  34397. <member name="M:NPOI.SS.Formula.FormulaParser.ParseStructuredReference(System.String,NPOI.SS.Formula.IFormulaParsingWorkbook,System.Int32)">
  34398. Parse a structured reference. Converts the structured
  34399. reference to the area that represent it.
  34400. @param tableText - The structured reference text
  34401. @param workbook - the parent workbook
  34402. @param rowIndex - the 0-based cell's row index ( used to handle "#This Row" quantifiers )
  34403. @return the area that being represented by the structured reference.
  34404. </member>
  34405. <member name="M:NPOI.SS.Formula.FormulaParser.GetChar">
  34406. Read New Character From Input Stream
  34407. </member>
  34408. <member name="M:NPOI.SS.Formula.FormulaParser.expected(System.String)">
  34409. Report What Was Expected
  34410. </member>
  34411. <member name="M:NPOI.SS.Formula.FormulaParser.IsAlpha(System.Char)">
  34412. Recognize an Alpha Character
  34413. </member>
  34414. <member name="M:NPOI.SS.Formula.FormulaParser.IsDigit(System.Char)">
  34415. Recognize a Decimal Digit
  34416. </member>
  34417. <member name="M:NPOI.SS.Formula.FormulaParser.IsAlNum(System.Char)">
  34418. Recognize an Alphanumeric
  34419. </member>
  34420. <member name="M:NPOI.SS.Formula.FormulaParser.IsWhite(System.Char)">
  34421. Recognize White Space
  34422. </member>
  34423. <member name="M:NPOI.SS.Formula.FormulaParser.SkipWhite">
  34424. Skip Over Leading White Space
  34425. </member>
  34426. <member name="M:NPOI.SS.Formula.FormulaParser.Match(System.Char)">
  34427. Consumes the next input character if it is equal To the one specified otherwise throws an
  34428. unchecked exception. This method does <b>not</b> consume whitespace (before or after the
  34429. matched character).
  34430. </member>
  34431. <member name="M:NPOI.SS.Formula.FormulaParser.GetNum">
  34432. Get a Number
  34433. </member>
  34434. <member name="M:NPOI.SS.Formula.FormulaParser.NeedsMemFunc(NPOI.SS.Formula.ParseNode)">
  34435. From OOO doc: "Whenever one operand of the reference subexpression is a function,
  34436. a defined name, a 3D reference, or an external reference (and no error occurs),
  34437. a tMemFunc token is used"
  34438. </member>
  34439. <member name="M:NPOI.SS.Formula.FormulaParser.IsValidDefinedNameChar(System.Char)">
  34440. @return <c>true</c> if the specified character may be used in a defined name
  34441. </member>
  34442. <member name="M:NPOI.SS.Formula.FormulaParser.CheckValidRangeOperand(System.String,System.Int32,NPOI.SS.Formula.ParseNode)">
  34443. @param currentParsePosition used to format a potential error message
  34444. </member>
  34445. <member name="M:NPOI.SS.Formula.FormulaParser.IsValidRangeOperand(NPOI.SS.Formula.ParseNode)">
  34446. @return false if sub-expression represented the specified ParseNode definitely
  34447. cannot appear on either side of the range (':') operator
  34448. </member>
  34449. <member name="M:NPOI.SS.Formula.FormulaParser.ParseRangeable">
  34450. Parses area refs (things which could be the operand of ':') and simple factors
  34451. Examples
  34452. <pre>
  34453. A$1
  34454. $A$1 : $B1
  34455. A1 ....... C2
  34456. Sheet1 !$A1
  34457. a..b!A1
  34458. 'my sheet'!A1
  34459. .my.sheet!A1
  34460. 'my sheet':'my alt sheet'!A1
  34461. .my.sheet1:.my.sheet2!$B$2
  34462. my.named..range.
  34463. 'my sheet'!my.named.range
  34464. .my.sheet!my.named.range
  34465. foo.bar(123.456, "abc")
  34466. 123.456
  34467. "abc"
  34468. true
  34469. [Foo.xls]!$A$1
  34470. [Foo.xls]'my sheet'!$A$1
  34471. [Foo.xls]!my.named.range
  34472. </pre>
  34473. </member>
  34474. <member name="M:NPOI.SS.Formula.FormulaParser.ParseStructuredReference(System.String)">
  34475. Parses a structured reference, returns it as area reference.
  34476. Examples:
  34477. <pre>
  34478. Table1[col]
  34479. Table1[[#Totals],[col]]
  34480. Table1[#Totals]
  34481. Table1[#All]
  34482. Table1[#Data]
  34483. Table1[#Headers]
  34484. Table1[#Totals]
  34485. Table1[#This Row]
  34486. Table1[[#All],[col]]
  34487. Table1[[#Headers],[col]]
  34488. Table1[[#Totals],[col]]
  34489. Table1[[#All],[col1]:[col2]]
  34490. Table1[[#Data],[col1]:[col2]]
  34491. Table1[[#Headers],[col1]:[col2]]
  34492. Table1[[#Totals],[col1]:[col2]]
  34493. Table1[[#Headers],[#Data],[col2]]
  34494. Table1[[#This Row], [col1]]
  34495. Table1[ [col1]:[col2] ]
  34496. </pre>
  34497. @param tableName
  34498. @return
  34499. </member>
  34500. <member name="M:NPOI.SS.Formula.FormulaParser.ParseAsColumnQuantifier">
  34501. Tries to parse the next as column - can contain whitespace
  34502. Caller should save pointer.
  34503. @return
  34504. </member>
  34505. <member name="M:NPOI.SS.Formula.FormulaParser.ParseAsSpecialQuantifier">
  34506. Tries to parse the next as special quantifier
  34507. Caller should save pointer.
  34508. @return
  34509. </member>
  34510. <member name="M:NPOI.SS.Formula.FormulaParser.ParseNonRange(System.Int32)">
  34511. Parses simple factors that are not primitive ranges or range components
  34512. i.e. '!', ':'(and equiv '...') do not appear
  34513. Examples
  34514. <pre>
  34515. my.named...range.
  34516. foo.bar(123.456, "abc")
  34517. 123.456
  34518. "abc"
  34519. true
  34520. </pre>
  34521. </member>
  34522. <member name="M:NPOI.SS.Formula.FormulaParser.CreateAreaRefParseNode(NPOI.SS.Formula.SheetIdentifier,NPOI.SS.Formula.FormulaParser.SimpleRangePart,NPOI.SS.Formula.FormulaParser.SimpleRangePart)">
  34523. @param sheetIden may be <code>null</code>
  34524. @param part1
  34525. @param part2 may be <code>null</code>
  34526. </member>
  34527. <member name="M:NPOI.SS.Formula.FormulaParser.ParseSimpleRangePart">
  34528. Parses out a potential LHS or RHS of a ':' intended to produce a plain AreaRef. Normally these are
  34529. proper cell references but they could also be row or column refs like "$AC" or "10"
  34530. @return <code>null</code> (and leaves {@link #_pointer} unchanged if a proper range part does not parse out
  34531. </member>
  34532. <member name="M:NPOI.SS.Formula.FormulaParser.ReduceRangeExpression(NPOI.SS.Formula.PTG.Ptg,NPOI.SS.Formula.PTG.Ptg)">
  34533. "A1", "B3" -> "A1:B3"
  34534. "sheet1!A1", "B3" -> "sheet1!A1:B3"
  34535. @return <c>null</c> if the range expression cannot / shouldn't be reduced.
  34536. </member>
  34537. <member name="T:NPOI.SS.Formula.FormulaParser.SimpleRangePart">
  34538. A1, $A1, A$1, $A$1, A, 1
  34539. </member>
  34540. <member name="M:NPOI.SS.Formula.FormulaParser.SimpleRangePart.IsCompatibleForArea(NPOI.SS.Formula.FormulaParser.SimpleRangePart)">
  34541. @return <c>true</c> if the two range parts can be combined in an
  34542. {@link AreaPtg} ( Note - the explicit range operator (:) may still be valid
  34543. when this method returns <c>false</c> )
  34544. </member>
  34545. <member name="M:NPOI.SS.Formula.FormulaParser.ParseSheetName">
  34546. Note - caller should reset {@link #_pointer} upon <code>null</code> result
  34547. @return The sheet name as an identifier <code>null</code> if '!' is not found in the right place
  34548. </member>
  34549. <member name="M:NPOI.SS.Formula.FormulaParser.ParseSheetRange(System.String,NPOI.SS.Formula.NameIdentifier)">
  34550. If we have something that looks like [book]Sheet1: or
  34551. Sheet1, see if it's actually a range eg Sheet1:Sheet2!
  34552. </member>
  34553. <member name="M:NPOI.SS.Formula.FormulaParser.IsUnquotedSheetNameChar(System.Char)">
  34554. very similar to {@link SheetNameFormatter#isSpecialChar(char)}
  34555. </member>
  34556. <member name="M:NPOI.SS.Formula.FormulaParser.IsValidCellReference(System.String)">
  34557. @return <c>true</c> if the specified name is a valid cell reference
  34558. </member>
  34559. <member name="M:NPOI.SS.Formula.FormulaParser.Function(System.String)">
  34560. Note - Excel Function names are 'case aware but not case sensitive'. This method may end
  34561. up creating a defined name record in the workbook if the specified name is not an internal
  34562. Excel Function, and Has not been encountered before.
  34563. Side effect: creates workbook name if name is not recognized (name is probably a UDF)
  34564. @param name case preserved Function name (as it was entered/appeared in the formula).
  34565. </member>
  34566. <member name="M:NPOI.SS.Formula.FormulaParser.AddName(System.String)">
  34567. Adds a name (named range or user defined function) to underlying workbook's names table
  34568. @param functionName
  34569. </member>
  34570. <member name="M:NPOI.SS.Formula.FormulaParser.GetFunction(System.String,NPOI.SS.Formula.PTG.Ptg,NPOI.SS.Formula.ParseNode[])">
  34571. * Generates the variable Function ptg for the formula.
  34572. *
  34573. * For IF Formulas, Additional PTGs are Added To the Tokens
  34574. * @param name a {@link NamePtg} or {@link NameXPtg} or <code>null</code>
  34575. * @return Ptg a null is returned if we're in an IF formula, it needs extreme manipulation and is handled in this Function
  34576. </member>
  34577. <member name="M:NPOI.SS.Formula.FormulaParser.Arguments">
  34578. Get arguments To a Function
  34579. </member>
  34580. <member name="M:NPOI.SS.Formula.FormulaParser.PowerFactor">
  34581. Parse and Translate a Math Factor
  34582. </member>
  34583. <member name="M:NPOI.SS.Formula.FormulaParser.ParseSimpleFactor">
  34584. factors (without ^ or % )
  34585. </member>
  34586. <member name="M:NPOI.SS.Formula.FormulaParser.GetNumberPtgFromString(System.String,System.String,System.String)">
  34587. Get a PTG for an integer from its string representation.
  34588. return Int or Number Ptg based on size of input
  34589. </member>
  34590. <member name="M:NPOI.SS.Formula.FormulaParser.Term">
  34591. Parse and Translate a Math Term
  34592. </member>
  34593. <member name="M:NPOI.SS.Formula.FormulaParser.AdditiveExpression">
  34594. Parse and Translate an Expression
  34595. </member>
  34596. <member name="M:NPOI.SS.Formula.FormulaParser.Parse">
  34597. API call To execute the parsing of the formula
  34598. </member>
  34599. <member name="T:NPOI.SS.Formula.IFormulaParsingWorkbook">
  34600. Abstracts a workbook for the purpose of formula parsing.<br/>
  34601. For POI internal use only
  34602. @author Josh Micich
  34603. </member>
  34604. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetName(System.String,System.Int32)">
  34605. <summary>
  34606. named range name matching is case insensitive
  34607. </summary>
  34608. <param name="name">The name.</param>
  34609. <param name="sheetIndex">Index of the sheet.</param>
  34610. <returns></returns>
  34611. </member>
  34612. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.CreateName">
  34613. <summary>
  34614. Return the underlying workbook
  34615. </summary>
  34616. <returns></returns>
  34617. </member>
  34618. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetTable(System.String)">
  34619. <summary>
  34620. XSSF Only - gets a table that exists in the worksheet
  34621. </summary>
  34622. <param name="name"></param>
  34623. <returns></returns>
  34624. </member>
  34625. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetNameXPtg(System.String,NPOI.SS.Formula.SheetIdentifier)">
  34626. <summary>
  34627. Return an external name (named range, function, user-defined function) Ptg
  34628. </summary>
  34629. <param name="name">The name.</param>
  34630. <param name="sheet"></param>
  34631. <returns></returns>
  34632. </member>
  34633. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.Get3DReferencePtg(NPOI.SS.Util.CellReference,NPOI.SS.Formula.SheetIdentifier)">
  34634. <summary>
  34635. Produce the appropriate Ptg for a 3d cell reference
  34636. </summary>
  34637. <param name="cell"></param>
  34638. <param name="sheet"></param>
  34639. <returns></returns>
  34640. </member>
  34641. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.Get3DReferencePtg(NPOI.SS.Util.AreaReference,NPOI.SS.Formula.SheetIdentifier)">
  34642. <summary>
  34643. Produce the appropriate Ptg for a 3d area reference
  34644. </summary>
  34645. <param name="area"></param>
  34646. <param name="sheet"></param>
  34647. <returns></returns>
  34648. </member>
  34649. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetExternalSheetIndex(System.String)">
  34650. <summary>
  34651. Gets the externSheet index for a sheet from this workbook
  34652. </summary>
  34653. <param name="sheetName">Name of the sheet.</param>
  34654. <returns></returns>
  34655. </member>
  34656. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetExternalSheetIndex(System.String,System.String)">
  34657. <summary>
  34658. Gets the externSheet index for a sheet from an external workbook
  34659. </summary>
  34660. <param name="workbookName">Name of the workbook, e.g. "BudGet.xls"</param>
  34661. <param name="sheetName">a name of a sheet in that workbook</param>
  34662. <returns></returns>
  34663. </member>
  34664. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetSpreadsheetVersion">
  34665. <summary>
  34666. Returns an enum holding spReadhseet properties specific to an Excel version (
  34667. max column and row numbers, max arguments to a function, etc.)
  34668. </summary>
  34669. <returns></returns>
  34670. </member>
  34671. <member name="T:NPOI.SS.Formula.FormulaRenderer">
  34672. Common logic for rendering formulas.<br/>
  34673. For POI internal use only
  34674. @author Josh Micich
  34675. </member>
  34676. <member name="M:NPOI.SS.Formula.FormulaRenderer.ToFormulaString(NPOI.SS.Formula.IFormulaRenderingWorkbook,NPOI.SS.Formula.PTG.Ptg[])">
  34677. Static method To convert an array of {@link Ptg}s in RPN order
  34678. To a human readable string format in infix mode.
  34679. @param book used for defined names and 3D references
  34680. @param ptgs must not be <c>null</c>
  34681. @return a human readable String
  34682. </member>
  34683. <member name="T:NPOI.SS.Formula.IFormulaRenderingWorkbook">
  34684. Abstracts a workbook for the purpose of converting formula To text.<br/>
  34685. For POI internal use only
  34686. @author Josh Micich
  34687. </member>
  34688. <member name="M:NPOI.SS.Formula.IFormulaRenderingWorkbook.GetExternalSheet(System.Int32)">
  34689. @return <c>null</c> if externSheetIndex refers To a sheet inside the current workbook
  34690. </member>
  34691. <member name="M:NPOI.SS.Formula.IFormulaRenderingWorkbook.GetSheetFirstNameByExternSheet(System.Int32)">
  34692. @return the name of the (first) sheet referred to by the given external sheet index
  34693. </member>
  34694. <member name="M:NPOI.SS.Formula.IFormulaRenderingWorkbook.GetSheetLastNameByExternSheet(System.Int32)">
  34695. @return the name of the (last) sheet referred to by the given external sheet index
  34696. </member>
  34697. <member name="T:NPOI.SS.Formula.FormulaShifter">
  34698. @author Josh Micich
  34699. </member>
  34700. <member name="F:NPOI.SS.Formula.FormulaShifter._externSheetIndex">
  34701. <summary>
  34702. Extern sheet index of sheet where moving is occurring
  34703. </summary>
  34704. </member>
  34705. <member name="F:NPOI.SS.Formula.FormulaShifter._sheetName">
  34706. <summary>
  34707. Sheet name of the sheet where moving is occurring, used for
  34708. updating XSSF style 3D references on row shifts.
  34709. </summary>
  34710. </member>
  34711. <member name="M:NPOI.SS.Formula.FormulaShifter.#ctor(System.Int32,System.String,System.Int32,System.Int32,System.Int32,NPOI.SS.Formula.FormulaShifter.ShiftMode,NPOI.SS.SpreadsheetVersion)">
  34712. <summary>
  34713. Create an instance for Shifting row. For example, this will be
  34714. called on <see cref="M:NPOI.HSSF.UserModel.HSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32)"/>
  34715. </summary>
  34716. <param name="externSheetIndex"></param>
  34717. <param name="sheetName"></param>
  34718. <param name="firstMovedIndex"></param>
  34719. <param name="lastMovedIndex"></param>
  34720. <param name="amountToMove"></param>
  34721. <param name="mode"></param>
  34722. <param name="version"></param>
  34723. <exception cref="T:System.ArgumentException"></exception>
  34724. </member>
  34725. <member name="M:NPOI.SS.Formula.FormulaShifter.#ctor(System.Int32,System.Int32)">
  34726. <summary>
  34727. Create an instance for shifting sheets. For example, this will be
  34728. called on <see cref="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSheetOrder(System.String,System.Int32)"/>
  34729. </summary>
  34730. <param name="srcSheetIndex"></param>
  34731. <param name="dstSheetIndex"></param>
  34732. </member>
  34733. <member name="M:NPOI.SS.Formula.FormulaShifter.AdjustFormula(NPOI.SS.Formula.PTG.Ptg[],System.Int32)">
  34734. <summary>
  34735. </summary>
  34736. <param name="ptgs">if necessary, will get modified by this method</param>
  34737. <param name="currentExternSheetIx">the extern sheet index of the
  34738. sheet that contains the formula being adjusted</param>
  34739. <returns><code>true</code> if a change was made to the formula tokens</returns>
  34740. </member>
  34741. <member name="M:NPOI.SS.Formula.FormulaShifter.AdjustPtgDueToRowMove(NPOI.SS.Formula.PTG.Ptg,System.Int32)">
  34742. <summary>
  34743. </summary>
  34744. <param name="ptg"></param>
  34745. <param name="currentExternSheetIx"></param>
  34746. <returns>in-place modified ptg (if row move would cause Ptg to
  34747. change), deleted ref ptg (if row move causes an error),
  34748. or null (if no Ptg change is needed)</returns>
  34749. </member>
  34750. <member name="M:NPOI.SS.Formula.FormulaShifter.AdjustPtgDueToRowCopy(NPOI.SS.Formula.PTG.Ptg)">
  34751. <summary>
  34752. Call this on any ptg reference contained in a row of cells that was
  34753. copied. If the ptg reference is relative, the references will be
  34754. shifted by the distance that the rows were copied. In the future
  34755. similar functions could be written due to column copying or
  34756. individual cell copying. Just make sure to only call
  34757. adjustPtgDueToRowCopy on formula cells that are copied (unless row
  34758. shifting, where references outside of the shifted region need to be
  34759. updated to reflect the shift, a copy is self-contained).
  34760. </summary>
  34761. <param name="ptg">the ptg to shift</param>
  34762. <returns>deleted ref ptg, in-place modified ptg, or null
  34763. <para>If Ptg would be shifted off the first or last row of a sheet,
  34764. return deleted ref </para>
  34765. <para>If Ptg needs to be changed, modifies Ptg in-place </para>
  34766. <para>If Ptg doesn't need to be changed, returns <code>null</code>
  34767. </para></returns>
  34768. </member>
  34769. <member name="M:NPOI.SS.Formula.FormulaShifter.RowCopyRefPtg(NPOI.SS.Formula.PTG.RefPtgBase)">
  34770. <summary>
  34771. Modifies rptg in-place and return a reference to rptg if the cell
  34772. reference would move due to a row copy operation
  34773. </summary>
  34774. <param name="rptg"></param>
  34775. <returns><code>null</code> or {@link #RefErrorPtg} if no change was
  34776. made</returns>
  34777. </member>
  34778. <member name="M:NPOI.SS.Formula.FormulaShifter.RowCopyAreaPtg(NPOI.SS.Formula.PTG.AreaPtgBase)">
  34779. <summary>
  34780. Modifies aptg in-place and return a reference to aptg if the first
  34781. or last row of of the Area reference would move due to a row
  34782. copy operation
  34783. </summary>
  34784. <param name="aptg"></param>
  34785. <returns><code>null</code> or <see cref="T:NPOI.SS.Formula.PTG.AreaErrPtg"/>if no change
  34786. was made</returns>
  34787. </member>
  34788. <member name="T:NPOI.SS.Formula.FormulaType">
  34789. <summary>
  34790. Enumeration of various formula types. For internal use only
  34791. </summary>
  34792. </member>
  34793. <member name="T:NPOI.SS.Formula.FormulaUsedBlankCellSet">
  34794. Optimisation - compacts many blank cell references used by a single formula.
  34795. @author Josh Micich
  34796. </member>
  34797. <member name="T:NPOI.SS.Formula.Functions.Address">
  34798. Creates a text reference as text, given specified row and column numbers.
  34799. @author Aniket Banerjee (banerjee@google.com)
  34800. </member>
  34801. <member name="P:NPOI.SS.Formula.Functions.SubtotalInstance.IsSubtotalCounted">
  34802. ignore nested subtotals.
  34803. </member>
  34804. <member name="T:NPOI.SS.Formula.Functions.Percentile">
  34805. Returns the k-th percentile of values in a range. You can use this function to establish a threshold of
  34806. acceptance. For example, you can decide to examine candidates who score above the 90th percentile.
  34807. PERCENTILE(array,k)
  34808. Array is the array or range of data that defines relative standing.
  34809. K is the percentile value in the range 0..1, inclusive.
  34810. <strong>Remarks</strong>
  34811. <ul>
  34812. <li>if array is empty or Contains more than 8,191 data points, PERCENTILE returns the #NUM! error value.</li>
  34813. <li>If k is nonnumeric, PERCENTILE returns the #VALUE! error value.</li>
  34814. <li>If k is &lt; 0 or if k &gt; 1, PERCENTILE returns the #NUM! error value.</li>
  34815. <li>If k is not a multiple of 1/(n - 1), PERCENTILE interpolates to determine the value at the k-th percentile.</li>
  34816. </ul>
  34817. </member>
  34818. <member name="T:NPOI.SS.Formula.Functions.AggregateFunction">
  34819. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34820. </member>
  34821. <member name="M:NPOI.SS.Formula.Functions.ArrayFunction.EvaluateArray(NPOI.SS.Formula.Eval.ValueEval[],System.Int32,System.Int32)">
  34822. <summary>
  34823. - Excel uses the error code #NUM! instead of IEEE NaN, so when numeric functions evaluate to Double#NaN be sure to translate the result to ErrorEval#NUM_ERROR.
  34824. </summary>
  34825. <param name="args">the evaluated function arguments. Empty values are represented with BlankEval or MissingArgEval, never <code>null</code></param>
  34826. <param name="srcRowIndex">row index of the cell containing the formula under evaluation</param>
  34827. <param name="srcColumnIndex">column index of the cell containing the formula under evaluation</param>
  34828. <returns> The evaluated result, possibly an ErrorEval, never <code>null</code></returns>
  34829. </member>
  34830. <member name="T:NPOI.SS.Formula.Functions.AverageIf">
  34831. Implementation for the Excel function SUMIF<p>
  34832. Syntax : <br/>
  34833. AVERAGEIF ( <b>range</b>, <b>criteria</b>, avg_range ) <br/>
  34834. <table border="0" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
  34835. <tr><th>range</th><td>The range over which criteria is applied. Also used for included values when the third parameter is not present</td></tr>
  34836. <tr><th>criteria</th><td>The value or expression used to filter rows from <b>range</b></td></tr>
  34837. <tr><th>avg_range</th><td>Locates the top-left corner of the corresponding range of addends - values to be included (after being selected by the criteria)</td></tr>
  34838. </table><br/>
  34839. </p>
  34840. @author Josh Micich
  34841. </member>
  34842. <member name="T:NPOI.SS.Formula.Functions.AverageIfs">
  34843. Implementation for the Excel function AverageIfs<br/>
  34844. <p>
  34845. Syntax : <br/>
  34846. AverageIfs ( <b>average_range</b>, <b>criteria_range1</b>, <b>criteria1</b>,
  34847. [<b>criteria_range2</b>, <b>criteria2</b>], ...) <br/>
  34848. <ul>
  34849. <li><b>average_range</b> Required. One or more cells to get the average, including numbers or names, ranges,
  34850. or cell references that contain numbers. Blank and text values are ignored.</li>
  34851. <li><b>criteria1_range</b> Required. The first range in which
  34852. to evaluate the associated criteria.</li>
  34853. <li><b>criteria1</b> Required. The criteria in the form of a number, expression,
  34854. cell reference, or text that define which cells in the criteria_range1
  34855. argument will be counted</li>
  34856. <li><b> criteria_range2, criteria2, ...</b> Optional. Additional ranges and their associated criteria.
  34857. Up to 127 range/criteria pairs are allowed.</li>
  34858. </ul>
  34859. </p>
  34860. @author Yegor Kozlov
  34861. </member>
  34862. <member name="M:NPOI.SS.Formula.Functions.AverageIfs.ValidateCriteriaRanges(NPOI.SS.Formula.Eval.AreaEval[],NPOI.SS.Formula.Eval.AreaEval)">
  34863. Verify that each <code>criteriaRanges</code> argument contains the same number of rows and columns
  34864. as the <code>avgRange</code> argument
  34865. @throws EvaluationException if
  34866. </member>
  34867. <member name="M:NPOI.SS.Formula.Functions.AverageIfs.GetAvgFromMatchingCells(NPOI.SS.Formula.Eval.AreaEval[],NPOI.SS.Formula.Functions.IMatchPredicate[],NPOI.SS.Formula.Eval.AreaEval)">
  34868. @param ranges criteria ranges, each range must be of the same dimensions as <code>aeAvg</code>
  34869. @param predicates array of predicates, a predicate for each value in <code>ranges</code>
  34870. @param aeAvg the range to calculate
  34871. @return the computed value
  34872. </member>
  34873. <member name="T:NPOI.SS.Formula.Functions.BaseNumberUtils">
  34874. <p>Some utils for Converting from and to any base</p>
  34875. @author cedric dot walter @ gmail dot com
  34876. </member>
  34877. <member name="T:NPOI.SS.Formula.Functions.Bin2Dec">
  34878. Implementation for Excel Bin2Dec() function.<p/>
  34879. <p/>
  34880. <b>Syntax</b>:<br/> <b>Bin2Dec </b>(<b>number</b>)<br/>
  34881. <p/>
  34882. Converts a binary number to decimal.
  34883. <p/>
  34884. Number is the binary number you want to convert. Number cannot contain more than 10 characters (10 bits).
  34885. The most significant bit of number is the sign bit. The remaining 9 bits are magnitude bits.
  34886. Negative numbers are represented using two's-complement notation.
  34887. <p/>
  34888. Remark
  34889. If number is not a valid binary number, or if number contains more than 10 characters (10 bits),
  34890. BIN2DEC returns the #NUM! error value.
  34891. @author cedric dot walter @ gmail dot com
  34892. </member>
  34893. <member name="T:NPOI.SS.Formula.Functions.BooleanFunction">
  34894. Here are the general rules concerning Boolean functions:
  34895. <ol>
  34896. <li> Blanks are ignored (not either true or false) </li>
  34897. <li> Strings are ignored if part of an area ref or cell ref, otherwise they must be 'true' or 'false'</li>
  34898. <li> Numbers: 0 is false. Any other number is TRUE </li>
  34899. <li> Areas: *all* cells in area are evaluated according to the above rules</li>
  34900. </ol>
  34901. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34902. </member>
  34903. <member name="T:NPOI.SS.Formula.Functions.False">
  34904. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34905. </member>
  34906. <member name="T:NPOI.SS.Formula.Functions.True">
  34907. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34908. </member>
  34909. <member name="T:NPOI.SS.Formula.Functions.CalendarFieldFunction">
  34910. Implementation of Excel functions Date parsing functions:
  34911. Date - DAY, MONTH and YEAR
  34912. Time - HOUR, MINUTE and SECOND
  34913. @author Others (not mentioned in code)
  34914. @author Thies Wellpott
  34915. </member>
  34916. <member name="T:NPOI.SS.Formula.Functions.Ceiling">
  34917. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34918. </member>
  34919. <member name="T:NPOI.SS.Formula.Functions.Choose">
  34920. @author Josh Micich
  34921. </member>
  34922. <member name="T:NPOI.SS.Formula.Functions.Code">
  34923. Implementation for Excel CODE () function.<p/>
  34924. <p/>
  34925. <b>Syntax</b>:<br/> <b>CODE </b>(<b>text</b> )<br/>
  34926. <p/>
  34927. Returns a numeric code for the first character in a text string. The returned code corresponds to the character set used by your computer.
  34928. <p/>
  34929. text The text for which you want the code of the first character.
  34930. @author cedric dot walter @ gmail dot com
  34931. </member>
  34932. <member name="T:NPOI.SS.Formula.Functions.Columns">
  34933. Implementation for Excel COLUMNS function.
  34934. @author Josh Micich
  34935. </member>
  34936. <member name="T:NPOI.SS.Formula.Functions.Combin">
  34937. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34938. </member>
  34939. <member name="T:NPOI.SS.Formula.Functions.Complex">
  34940. Implementation for Excel COMPLEX () function.<p/>
  34941. <p/>
  34942. <b>Syntax</b>:<br/> <b>COMPLEX </b>(<b>real_num</b>,<b>i_num</b>,<b>suffix </b> )<br/>
  34943. <p/>
  34944. Converts real and imaginary coefficients into a complex number of the form x + yi or x + yj.
  34945. <p/>
  34946. <p/>
  34947. All complex number functions accept "i" and "j" for suffix, but neither "I" nor "J".
  34948. Using uppercase results in the #VALUE! error value. All functions that accept two
  34949. or more complex numbers require that all suffixes match.
  34950. <p/>
  34951. <b>real_num</b> The real coefficient of the complex number.
  34952. If this argument is nonnumeric, this function returns the #VALUE! error value.
  34953. <p/>
  34954. <p/>
  34955. <b>i_num</b> The imaginary coefficient of the complex number.
  34956. If this argument is nonnumeric, this function returns the #VALUE! error value.
  34957. <p/>
  34958. <p/>
  34959. <b>suffix</b> The suffix for the imaginary component of the complex number.
  34960. <ul>
  34961. <li>If omitted, suffix is assumed to be "i".</li>
  34962. <li>If suffix is neither "i" nor "j", COMPLEX returns the #VALUE! error value.</li>
  34963. </ul>
  34964. @author cedric dot walter @ gmail dot com
  34965. </member>
  34966. <member name="T:NPOI.SS.Formula.Functions.Count">
  34967. Counts the number of cells that contain numeric data within
  34968. the list of arguments.
  34969. Excel Syntax
  34970. COUNT(value1,value2,...)
  34971. Value1, value2, ... are 1 to 30 arguments representing the values or ranges to be Counted.
  34972. TODO: Check this properly Matches excel on edge cases
  34973. like formula cells, error cells etc
  34974. </member>
  34975. <member name="M:NPOI.SS.Formula.Functions.Count.SubtotalInstance">
  34976. Create an instance of Count to use in {@link Subtotal}
  34977. <p>
  34978. If there are other subtotals within argument refs (or nested subtotals),
  34979. these nested subtotals are ignored to avoid double counting.
  34980. </p>
  34981. @see Subtotal
  34982. </member>
  34983. <member name="T:NPOI.SS.Formula.Functions.Counta">
  34984. Counts the number of cells that contain data within the list of arguments.
  34985. Excel Syntax
  34986. COUNTA(value1,value2,...)
  34987. Value1, value2, ... are 1 to 30 arguments representing the values or ranges to be Counted.
  34988. @author Josh Micich
  34989. </member>
  34990. <member name="M:NPOI.SS.Formula.Functions.Counta.SubtotalPredicate.Matches(NPOI.SS.Formula.TwoDEval,System.Int32,System.Int32)">
  34991. don't count cells that are subtotals
  34992. </member>
  34993. <member name="T:NPOI.SS.Formula.Functions.Countblank">
  34994. Implementation for the function COUNTBLANK
  34995. <p>
  34996. Syntax: COUNTBLANK ( range )
  34997. <table border="0" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
  34998. <tr><th>range </th><td>is the range of cells to count blanks</td></tr>
  34999. </table>
  35000. </p>
  35001. @author Mads Mohr Christensen
  35002. </member>
  35003. <member name="T:NPOI.SS.Formula.Functions.Countif">
  35004. Implementation for the function COUNTIF<p/>
  35005. Syntax: COUNTIF ( range, criteria )
  35006. <table border="0" cellpAdding="1" cellspacing="0" summary="Parameter descriptions">
  35007. <tr><th>range </th><td>is the range of cells to be Counted based on the criteria</td></tr>
  35008. <tr><th>criteria</th><td>is used to determine which cells to Count</td></tr>
  35009. </table>
  35010. <p/>
  35011. @author Josh Micich
  35012. </member>
  35013. <member name="P:NPOI.SS.Formula.Functions.Countif.CmpOp.Length">
  35014. @return number of characters used to represent this operator
  35015. </member>
  35016. <member name="M:NPOI.SS.Formula.Functions.Countif.StringMatcher.GetWildCardPattern(System.String)">
  35017. <summary>
  35018. Translates Excel countif wildcard strings into .NET regex strings
  35019. </summary>
  35020. <param name="value">Excel wildcard expression</param>
  35021. <returns>return null if the specified value contains no special wildcard characters.</returns>
  35022. </member>
  35023. <member name="M:NPOI.SS.Formula.Functions.Countif.CountMatchingCellsInArea(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Functions.IMatchPredicate)">
  35024. @return the number of evaluated cells in the range that match the specified criteria
  35025. </member>
  35026. <member name="M:NPOI.SS.Formula.Functions.Countif.EvaluateCriteriaArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  35027. @return the de-referenced criteria arg (possibly {@link ErrorEval})
  35028. </member>
  35029. <member name="M:NPOI.SS.Formula.Functions.Countif.CreateGeneralMatchPredicate(NPOI.SS.Formula.Eval.StringEval)">
  35030. When the second argument is a string, many things are possible
  35031. </member>
  35032. <member name="M:NPOI.SS.Formula.Functions.Countif.CreateCriteriaPredicate(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  35033. Creates a criteria predicate object for the supplied criteria arg
  35034. @return <code>null</code> if the arg evaluates to blank.
  35035. </member>
  35036. <member name="M:NPOI.SS.Formula.Functions.Countif.ParseBoolean(System.String)">
  35037. bool literals ('TRUE', 'FALSE') treated similarly but NOT same as numbers.
  35038. </member>
  35039. <member name="T:NPOI.SS.Formula.Functions.Countifs">
  35040. Implementation for the function COUNTIFS
  35041. <p>
  35042. Syntax: COUNTIFS(criteria_range1, criteria1, [criteria_range2, criteria2])
  35043. </p>
  35044. </member>
  35045. <member name="T:NPOI.SS.Formula.Functions.IMatchPredicate">
  35046. Common interface for the matching criteria.
  35047. </member>
  35048. <member name="T:NPOI.SS.Formula.Functions.CountUtils">
  35049. Common logic for COUNT, COUNTA and COUNTIF
  35050. @author Josh Micich
  35051. </member>
  35052. <member name="M:NPOI.SS.Formula.Functions.CountUtils.CountMatchingCellsInRef(NPOI.SS.Formula.Eval.RefEval,NPOI.SS.Formula.Functions.IMatchPredicate)">
  35053. @return the number of evaluated cells in the range that match the specified criteria
  35054. </member>
  35055. <member name="M:NPOI.SS.Formula.Functions.CountUtils.CountMatchingCellsInArea(NPOI.SS.Formula.ThreeDEval,NPOI.SS.Formula.Functions.IMatchPredicate)">
  35056. @return the number of evaluated cells in the range that match the specified criteria
  35057. </member>
  35058. <member name="T:NPOI.SS.Formula.Functions.DateFunc">
  35059. @author Pavel Krupets (pkrupets at palmtreebusiness dot com)
  35060. </member>
  35061. <member name="M:NPOI.SS.Formula.Functions.DateFunc.Evaluate(System.Int32,System.Int32,System.Int32)">
  35062. * Note - works with Java Calendar months, not Excel months
  35063. * Java Calendar month = Excel month + 1
  35064. </member>
  35065. <member name="T:NPOI.SS.Formula.Functions.Days360">
  35066. <p>Calculates the number of days between two dates based on a 360-day year
  35067. (twelve 30-day months), which is used in some accounting calculations. Use
  35068. this function to help compute payments if your accounting system is based on
  35069. twelve 30-day months.</p>
  35070. {@code DAYS360(start_date,end_date,[method])}
  35071. <ul>
  35072. <li>Start_date, end_date (required):<br/>
  35073. The two dates between which you want to know the number of days.<br/>
  35074. If start_date occurs after end_date, the DAYS360 function returns a negative number.</li>
  35075. <li>Method (optional):<br/>
  35076. A logical value that specifies whether to use the U.S. or European method in the calculation</li>
  35077. <li>Method set to false or omitted:<br/>
  35078. the DAYS360 function uses the U.S. (NASD) method. If the starting date is the 31st of a month,
  35079. it becomes equal to the 30th of the same month. If the ending date is the 31st of a month and
  35080. the starting date is earlier than the 30th of a month, the ending date becomes equal to the
  35081. 1st of the next month, otherwise the ending date becomes equal to the 30th of the same month.
  35082. The month February and leap years are handled in the following way:<br/>
  35083. On a non-leap year the function {@code =DAYS360("2/28/93", "3/1/93", FALSE)} returns 1 day
  35084. because the DAYS360 function ignores the extra days added to February.<br/>
  35085. On a leap year the function {@code =DAYS360("2/29/96","3/1/96", FALSE)} returns 1 day for
  35086. the same reason.</li>
  35087. <li>Method Set to true:<br/>
  35088. When you set the method parameter to TRUE, the DAYS360 function uses the European method.
  35089. Starting dates or ending dates that occur on the 31st of a month become equal to the 30th of
  35090. the same month. The month February and leap years are handled in the following way:<br/>
  35091. On a non-leap year the function {@code =DAYS360("2/28/93", "3/1/93", TRUE)} returns
  35092. 3 days because the DAYS360 function is counting the extra days added to February to give
  35093. February 30 days.<br/>
  35094. On a leap year the function {@code =DAYS360("2/29/96", "3/1/96", TRUE)} returns
  35095. 2 days for the same reason.</li>
  35096. </ul>
  35097. @see <a href="https://support.microsoft.com/en-us/kb/235575">DAYS360 Function Produces Different Values Depending on the Version of Excel</a>
  35098. </member>
  35099. <member name="T:NPOI.SS.Formula.Functions.Dec2Bin">
  35100. Implementation for Excel Bin2Dec() function.<p/>
  35101. <p/>
  35102. <b>Syntax</b>:<br/> <b>Bin2Dec </b>(<b>number</b>,<b>[places]</b> )<br/>
  35103. <p/>
  35104. Converts a decimal number to binary.
  35105. <p/>
  35106. The DEC2BIN function syntax has the following arguments:
  35107. <ul>
  35108. <li>Number Required. The decimal integer you want to Convert. If number is negative, valid place values are ignored and DEC2BIN returns a 10-character (10-bit) binary number in which the most significant bit is the sign bit. The remaining 9 bits are magnitude bits. Negative numbers are represented using two's-complement notation.</li>
  35109. <li>Places Optional. The number of characters to use. If places is omitted, DEC2BIN uses the minimum number of characters necessary. Places is useful for pAdding the return value with leading 0s (zeros).</li>
  35110. </ul>
  35111. <p/>
  35112. Remarks
  35113. <ul>
  35114. <li>If number &lt; -512 or if number &gt; 511, DEC2BIN returns the #NUM! error value.</li>
  35115. <li>If number is nonnumeric, DEC2BIN returns the #VALUE! error value.</li>
  35116. <li>If DEC2BIN requires more than places characters, it returns the #NUM! error value.</li>
  35117. <li>If places is not an integer, it is tRuncated.</li>
  35118. <li>If places is nonnumeric, DEC2BIN returns the #VALUE! error value.</li>
  35119. <li>If places is zero or negative, DEC2BIN returns the #NUM! error value.</li>
  35120. </ul>
  35121. @author cedric dot walter @ gmail dot com
  35122. </member>
  35123. <member name="T:NPOI.SS.Formula.Functions.Dec2Hex">
  35124. Implementation for Excel DELTA() function.<p/>
  35125. <p/>
  35126. <b>Syntax</b>:<br/> <b>DEC2HEX </b>(<b>number</b>,<b>places</b> )<br/>
  35127. <p/>
  35128. Converts a decimal number to hexadecimal.
  35129. The decimal integer you want to Convert. If number is negative, places is ignored
  35130. and this function returns a 10-character (40-bit) hexadecimal number in which the
  35131. most significant bit is the sign bit. The remaining 39 bits are magnitude bits.
  35132. Negative numbers are represented using two's-complement notation.
  35133. <ul>
  35134. <li>If number &lt; -549,755,813,888 or if number &gt; 549,755,813,887, this function returns the #NUM! error value.</li>
  35135. <li>If number is nonnumeric, this function returns the #VALUE! error value.</li>
  35136. </ul>
  35137. <h2>places</h2>
  35138. The number of characters to use. The places argument is useful for pAdding the
  35139. return value with leading 0s (zeros).
  35140. <ul>
  35141. <li>If this argument is omitted, this function uses the minimum number of characters necessary.</li>
  35142. <li>If this function requires more than places characters, it returns the #NUM! error value.</li>
  35143. <li>If this argument is nonnumeric, this function returns the #VALUE! error value.</li>
  35144. <li>If this argument is negative, this function returns the #NUM! error value.</li>
  35145. <li>If this argument Contains a decimal value, this function ignores the numbers to the right side of the decimal point.</li>
  35146. </ul>
  35147. @author cedric dot walter @ gmail dot com
  35148. </member>
  35149. <member name="T:NPOI.SS.Formula.Functions.Degrees">
  35150. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35151. </member>
  35152. <member name="T:NPOI.SS.Formula.Functions.Delta">
  35153. Implementation for Excel DELTA() function.<p/>
  35154. <p/>
  35155. <b>Syntax</b>:<br/> <b>DELTA </b>(<b>number1</b>,<b>number2</b> )<br/>
  35156. <p/>
  35157. Tests whether two values are Equal. Returns 1 if number1 = number2; returns 0 otherwise.
  35158. Use this function to filter a Set of values. For example, by summing several DELTA functions
  35159. you calculate the count of equal pairs. This function is also known as the Kronecker Delta function.
  35160. <ul>
  35161. <li>If number1 is nonnumeric, DELTA returns the #VALUE! error value.</li>
  35162. <li>If number2 is nonnumeric, DELTA returns the #VALUE! error value.</li>
  35163. </ul>
  35164. @author cedric dot walter @ gmail dot com
  35165. </member>
  35166. <member name="T:NPOI.SS.Formula.Functions.DGet">
  35167. Implementation of the DGet function:
  35168. Finds the value of a column in an area with given conditions.
  35169. TODO:
  35170. - wildcards ? and * in string conditions
  35171. - functions as conditions
  35172. </member>
  35173. <member name="T:NPOI.SS.Formula.Functions.DMin">
  35174. Implementation of the DMin function:
  35175. Finds the minimum value of a column in an area with given conditions.
  35176. TODO:
  35177. - wildcards ? and * in string conditions
  35178. - functions as conditions
  35179. </member>
  35180. <member name="T:NPOI.SS.Formula.Functions.Dollar">
  35181. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35182. </member>
  35183. <member name="T:NPOI.SS.Formula.Functions.DStarRunner">
  35184. This class performs a D* calculation. It takes an {@link IDStarAlgorithm} object and
  35185. uses it for calculating the result value. Iterating a database and Checking the
  35186. entries against the Set of conditions is done here.
  35187. </member>
  35188. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.GetColumnForName(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Eval.AreaEval)">
  35189. @param nameValueEval Must not be a RefEval or AreaEval. Thus make sure resolveReference() is called on the value first!
  35190. @param db
  35191. @return
  35192. @throws EvaluationException
  35193. </member>
  35194. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.GetColumnForString(NPOI.SS.Formula.Eval.AreaEval,System.String)">
  35195. For a given database returns the column number for a column heading.
  35196. @param db Database.
  35197. @param name Column heading.
  35198. @return Corresponding column number.
  35199. @If it's not possible to turn all headings into strings.
  35200. </member>
  35201. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.FullFillsConditions(NPOI.SS.Formula.Eval.AreaEval,System.Int32,NPOI.SS.Formula.Eval.AreaEval)">
  35202. Checks a row in a database against a condition database.
  35203. @param db Database.
  35204. @param row The row in the database to Check.
  35205. @param cdb The condition database to use for Checking.
  35206. @return Whether the row matches the conditions.
  35207. @If references could not be Resolved or comparison
  35208. operators and operands didn't match.
  35209. </member>
  35210. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.testNormalCondition(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Eval.ValueEval)">
  35211. Test a value against a simple (&lt; &gt; &lt;= &gt;= = starts-with) condition string.
  35212. @param value The value to Check.
  35213. @param condition The condition to check for.
  35214. @return Whether the condition holds.
  35215. @If comparison operator and operands don't match.
  35216. </member>
  35217. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.testNumericCondition(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Functions.DStarRunner.Operator,System.String)">
  35218. Test whether a value matches a numeric condition.
  35219. @param valueEval Value to Check.
  35220. @param op Comparator to use.
  35221. @param condition Value to check against.
  35222. @return whether the condition holds.
  35223. @If it's impossible to turn the condition into a number.
  35224. </member>
  35225. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.ResolveReference(NPOI.SS.Formula.Eval.AreaEval,System.Int32,System.Int32)">
  35226. Resolve a ValueEval that's in an AreaEval.
  35227. @param db AreaEval from which the cell to resolve is retrieved.
  35228. @param dbRow Relative row in the AreaEval.
  35229. @param dbCol Relative column in the AreaEval.
  35230. @return A ValueEval that is a NumberEval, StringEval, BoolEval, BlankEval or ErrorEval.
  35231. </member>
  35232. <member name="T:NPOI.SS.Formula.Functions.EDate">
  35233. Implementation of Excel 'Analysis ToolPak' function EDATE()<br/>
  35234. Adds a specified number of months to the specified date.<p/>
  35235. <b>Syntax</b><br/>
  35236. <b>EDATE</b>(<b>date</b>, <b>number</b>)
  35237. <p/>
  35238. @author Tomas Herceg
  35239. </member>
  35240. <member name="T:NPOI.SS.Formula.Functions.EOMonth">
  35241. Implementation for the Excel EOMONTH() function.<p/>
  35242. <p/>
  35243. EOMONTH() returns the date of the last day of a month..<p/>
  35244. <p/>
  35245. <b>Syntax</b>:<br/>
  35246. <b>EOMONTH</b>(<b>start_date</b>,<b>months</b>)<p/>
  35247. <p/>
  35248. <b>start_date</b> is the starting date of the calculation
  35249. <b>months</b> is the number of months to be Added to <b>start_date</b>,
  35250. to give a new date. For this new date, <b>EOMONTH</b> returns the date of
  35251. the last day of the month. <b>months</b> may be positive (in the future),
  35252. zero or negative (in the past).
  35253. </member>
  35254. <member name="T:NPOI.SS.Formula.Functions.Errortype">
  35255. Implementation for the ERROR.TYPE() Excel function.
  35256. <p>
  35257. <b>Syntax:</b><br/>
  35258. <b>ERROR.TYPE</b>(<b>errorValue</b>)</p>
  35259. <p>
  35260. Returns a number corresponding to the error type of the supplied argument.</p>
  35261. <p>
  35262. <table border="1" cellpadding="1" cellspacing="1" summary="Return values for ERROR.TYPE()">
  35263. <tr><td>errorValue</td><td>Return Value</td></tr>
  35264. <tr><td>#NULL!</td><td>1</td></tr>
  35265. <tr><td>#DIV/0!</td><td>2</td></tr>
  35266. <tr><td>#VALUE!</td><td>3</td></tr>
  35267. <tr><td>#REF!</td><td>4</td></tr>
  35268. <tr><td>#NAME?</td><td>5</td></tr>
  35269. <tr><td>#NUM!</td><td>6</td></tr>
  35270. <tr><td>#N/A!</td><td>7</td></tr>
  35271. <tr><td>everything else</td><td>#N/A!</td></tr>
  35272. </table>
  35273. Note - the results of ERROR.TYPE() are different to the constants defined in
  35274. <tt>ErrorConstants</tt>.
  35275. </p>
  35276. @author Josh Micich
  35277. </member>
  35278. <member name="T:NPOI.SS.Formula.Functions.Even">
  35279. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35280. </member>
  35281. <member name="T:NPOI.SS.Formula.Functions.Exp">
  35282. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35283. </member>
  35284. <member name="T:NPOI.SS.Formula.Functions.Fact">
  35285. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35286. </member>
  35287. <member name="T:NPOI.SS.Formula.Functions.FactDouble">
  35288. Implementation for Excel FACTDOUBLE() function.<p/>
  35289. <p/>
  35290. <b>Syntax</b>:<br/> <b>FACTDOUBLE </b>(<b>number</b>)<br/>
  35291. <p/>
  35292. Returns the double factorial of a number.
  35293. <p/>
  35294. Number is the value for which to return the double factorial. If number is not an integer, it is truncated.
  35295. <p/>
  35296. Remarks
  35297. <ul>
  35298. <li>If number is nonnumeric, FACTDOUBLE returns the #VALUE! error value.</li>
  35299. <li>If number is negative, FACTDOUBLE returns the #NUM! error value.</li>
  35300. </ul>
  35301. Use a cache for more speed of previously calculated factorial
  35302. @author cedric dot walter @ gmail dot com
  35303. </member>
  35304. <member name="T:NPOI.SS.Formula.Functions.Finance">
  35305. Implementation of the financial functions pmt, fv, ppmt, ipmt.
  35306. @author Mike Argyriou micharg@gmail.com
  35307. </member>
  35308. <member name="M:NPOI.SS.Formula.Functions.Finance.PMT(System.Double,System.Int32,System.Double,System.Double,System.Int32)">
  35309. Emulates Excel/Calc's PMT(interest_rate, number_payments, PV, FV, Type)
  35310. function, which calculates the payments for a loan or the future value of an investment
  35311. @param r
  35312. - periodic interest rate represented as a decimal.
  35313. @param nper
  35314. - number of total payments / periods.
  35315. @param pv
  35316. - present value -- borrowed or invested principal.
  35317. @param fv
  35318. - future value of loan or annuity.
  35319. @param type
  35320. - when payment is made: beginning of period is 1; end, 0.
  35321. @return <code>double</code> representing periodic payment amount.
  35322. </member>
  35323. <member name="M:NPOI.SS.Formula.Functions.Finance.PMT(System.Double,System.Int32,System.Double,System.Double)">
  35324. Overloaded pmt() call omitting type, which defaults to 0.
  35325. @see #pmt(double, int, double, double, int)
  35326. </member>
  35327. <member name="M:NPOI.SS.Formula.Functions.Finance.PMT(System.Double,System.Int32,System.Double)">
  35328. Overloaded pmt() call omitting fv and type, which both default to 0.
  35329. @see #pmt(double, int, double, double, int)
  35330. </member>
  35331. <member name="M:NPOI.SS.Formula.Functions.Finance.IPMT(System.Double,System.Int32,System.Int32,System.Double,System.Double,System.Int32)">
  35332. Emulates Excel/Calc's IPMT(interest_rate, period, number_payments, PV,
  35333. FV, Type) function, which calculates the portion of the payment at a
  35334. given period that is the interest on previous balance.
  35335. @param r
  35336. - periodic interest rate represented as a decimal.
  35337. @param per
  35338. - period (payment number) to check value at.
  35339. @param nper
  35340. - number of total payments / periods.
  35341. @param pv
  35342. - present value -- borrowed or invested principal.
  35343. @param fv
  35344. - future value of loan or annuity.
  35345. @param type
  35346. - when payment is made: beginning of period is 1; end, 0.
  35347. @return <code>double</code> representing interest portion of payment.
  35348. @see #pmt(double, int, double, double, int)
  35349. @see #fv(double, int, double, double, int)
  35350. </member>
  35351. <member name="M:NPOI.SS.Formula.Functions.Finance.PPMT(System.Double,System.Int32,System.Int32,System.Double,System.Double,System.Int32)">
  35352. Emulates Excel/Calc's PPMT(interest_rate, period, number_payments, PV,
  35353. FV, Type) function, which calculates the portion of the payment at a
  35354. given period that will apply to principal.
  35355. @param r
  35356. - periodic interest rate represented as a decimal.
  35357. @param per
  35358. - period (payment number) to check value at.
  35359. @param nper
  35360. - number of total payments / periods.
  35361. @param pv
  35362. - present value -- borrowed or invested principal.
  35363. @param fv
  35364. - future value of loan or annuity.
  35365. @param type
  35366. - when payment is made: beginning of period is 1; end, 0.
  35367. @return <code>double</code> representing principal portion of payment.
  35368. @see #pmt(double, int, double, double, int)
  35369. @see #ipmt(double, int, int, double, double, bool)
  35370. </member>
  35371. <member name="M:NPOI.SS.Formula.Functions.Finance.FV(System.Double,System.Int32,System.Double,System.Double,System.Int32)">
  35372. Emulates Excel/Calc's FV(interest_rate, number_payments, payment, PV,
  35373. Type) function, which calculates future value or principal at period N.
  35374. @param r
  35375. - periodic interest rate represented as a decimal.
  35376. @param nper
  35377. - number of total payments / periods.
  35378. @param pmt
  35379. - periodic payment amount.
  35380. @param pv
  35381. - present value -- borrowed or invested principal.
  35382. @param type
  35383. - when payment is made: beginning of period is 1; end, 0.
  35384. @return <code>double</code> representing future principal value.
  35385. </member>
  35386. <member name="M:NPOI.SS.Formula.Functions.Finance.FV(System.Double,System.Int32,System.Double,System.Double)">
  35387. Overloaded fv() call omitting type, which defaults to 0.
  35388. @see #fv(double, int, double, double, int)
  35389. </member>
  35390. <member name="T:NPOI.SS.Formula.Functions.FinanceFunction">
  35391. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35392. Super class for all Evals for financial function evaluation.
  35393. </member>
  35394. <member name="T:NPOI.SS.Formula.Functions.FinanceLib">
  35395. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35396. This class Is a functon library for common fiscal functions.
  35397. <b>Glossary of terms/abbreviations:</b>
  35398. <br/>
  35399. <ul>
  35400. <li><em>FV:</em> Future Value</li>
  35401. <li><em>PV:</em> Present Value</li>
  35402. <li><em>NPV:</em> Net Present Value</li>
  35403. <li><em>PMT:</em> (Periodic) Payment</li>
  35404. </ul>
  35405. For more info on the terms/abbreviations please use the references below
  35406. (hyperlinks are subject to Change):
  35407. <br/>Online References:
  35408. <ol>
  35409. <li>GNU Emacs Calc 2.02 Manual: http://theory.uwinnipeg.ca/gnu/calc/calc_203.html</li>
  35410. <li>Yahoo Financial Glossary: http://biz.yahoo.com/f/g/nn.html#y</li>
  35411. <li>MS Excel function reference: http://office.microsoft.com/en-us/assistance/CH062528251033.aspx</li>
  35412. </ol>
  35413. <h3>Implementation Notes:</h3>
  35414. Symbols used in the formulae that follow:<br/>
  35415. <ul>
  35416. <li>p: present value</li>
  35417. <li>f: future value</li>
  35418. <li>n: number of periods</li>
  35419. <li>y: payment (in each period)</li>
  35420. <li>r: rate</li>
  35421. <li>^: the power operator (NOT the java bitwise XOR operator!)</li>
  35422. </ul>
  35423. [From MS Excel function reference] Following are some of the key formulas
  35424. that are used in this implementation:
  35425. <pre>
  35426. p(1+r)^n + y(1+rt)((1+r)^n-1)/r + f=0 ...{when r!=0}
  35427. ny + p + f=0 ...{when r=0}
  35428. </pre>
  35429. </member>
  35430. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.fv(System.Double,System.Double,System.Double,System.Double,System.Boolean)">
  35431. Future value of an amount given the number of payments, rate, amount
  35432. of individual payment, present value and bool value indicating whether
  35433. payments are due at the beginning of period
  35434. (false => payments are due at end of period)
  35435. @param r rate
  35436. @param n num of periods
  35437. @param y pmt per period
  35438. @param p future value
  35439. @param t type (true=pmt at end of period, false=pmt at begining of period)
  35440. </member>
  35441. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.pv(System.Double,System.Double,System.Double,System.Double,System.Boolean)">
  35442. Present value of an amount given the number of future payments, rate, amount
  35443. of individual payment, future value and bool value indicating whether
  35444. payments are due at the beginning of period
  35445. (false => payments are due at end of period)
  35446. @param r
  35447. @param n
  35448. @param y
  35449. @param f
  35450. @param t
  35451. </member>
  35452. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.npv(System.Double,System.Double[])">
  35453. calculates the Net Present Value of a principal amount
  35454. given the disCount rate and a sequence of cash flows
  35455. (supplied as an array). If the amounts are income the value should
  35456. be positive, else if they are payments and not income, the
  35457. value should be negative.
  35458. @param r
  35459. @param cfs cashflow amounts
  35460. </member>
  35461. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.pmt(System.Double,System.Double,System.Double,System.Double,System.Boolean)">
  35462. @param r
  35463. @param n
  35464. @param p
  35465. @param f
  35466. @param t
  35467. </member>
  35468. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.nper(System.Double,System.Double,System.Double,System.Double,System.Boolean)">
  35469. @param r
  35470. @param y
  35471. @param p
  35472. @param f
  35473. @param t
  35474. </member>
  35475. <member name="T:NPOI.SS.Formula.Functions.Fixed0ArgFunction">
  35476. Convenience base class for functions that only take zero arguments.
  35477. @author Josh Micich
  35478. </member>
  35479. <member name="T:NPOI.SS.Formula.Functions.Fixed1ArgFunction">
  35480. Convenience base class for functions that must take exactly one argument.
  35481. @author Josh Micich
  35482. </member>
  35483. <member name="T:NPOI.SS.Formula.Functions.Fixed2ArgFunction">
  35484. Convenience base class for functions that must take exactly two arguments.
  35485. @author Josh Micich
  35486. </member>
  35487. <member name="T:NPOI.SS.Formula.Functions.Fixed3ArgFunction">
  35488. Convenience base class for functions that must take exactly three arguments.
  35489. @author Josh Micich
  35490. </member>
  35491. <member name="T:NPOI.SS.Formula.Functions.Fixed4ArgFunction">
  35492. Convenience base class for functions that must take exactly four arguments.
  35493. @author Josh Micich
  35494. </member>
  35495. <member name="T:NPOI.SS.Formula.Functions.Floor">
  35496. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35497. </member>
  35498. <member name="T:NPOI.SS.Formula.Functions.FreeRefFunction">
  35499. For most Excel functions, involving references ((cell, area), (2d, 3d)), the references are
  35500. passed in as arguments, and the exact location remains fixed. However, a select few Excel
  35501. functions have the ability to access cells that were not part of any reference passed as an
  35502. argument.<br/>
  35503. Two important functions with this feature are <b>INDIRECT</b> and <b>OFFSet</b><p/>
  35504. In POI, the <c>HSSFFormulaEvaluator</c> Evaluates every cell in each reference argument before
  35505. calling the function. This means that functions using fixed references do not need access to
  35506. the rest of the workbook to execute. Hence the <c>Evaluate()</c> method on the common
  35507. interface <c>Function</c> does not take a workbook parameter.
  35508. This interface recognises the requirement of some functions to freely Create and Evaluate
  35509. references beyond those passed in as arguments.
  35510. @author Josh Micich
  35511. </member>
  35512. <member name="M:NPOI.SS.Formula.Functions.FreeRefFunction.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  35513. @param args the pre-Evaluated arguments for this function. args is never <code>null</code>,
  35514. nor are any of its elements.
  35515. @param ec primarily used to identify the source cell Containing the formula being Evaluated.
  35516. may also be used to dynamically create reference evals.
  35517. @return never <code>null</code>. Possibly an instance of <c>ErrorEval</c> in the case of
  35518. a specified Excel error (Exceptions are never thrown to represent Excel errors).
  35519. </member>
  35520. <member name="T:NPOI.SS.Formula.Functions.Function">
  35521. <summary>
  35522. Function serves as a marker interface.
  35523. </summary>
  35524. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35525. </member>
  35526. <member name="M:NPOI.SS.Formula.Functions.Function.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],System.Int32,System.Int32)">
  35527. <summary>
  35528. Evaluates the specified args.
  35529. </summary>
  35530. <param name="args">the evaluated function arguments. Empty values are represented with BlankEval or MissingArgEval</param>
  35531. <param name="srcRowIndex">row index of the cell containing the formula under evaluation</param>
  35532. <param name="srcColumnIndex">column index of the cell containing the formula under evaluation</param>
  35533. <returns></returns>
  35534. </member>
  35535. <member name="T:NPOI.SS.Formula.Functions.Function0Arg">
  35536. Implemented by all functions that can be called with zero arguments
  35537. @author Josh Micich
  35538. </member>
  35539. <member name="M:NPOI.SS.Formula.Functions.Function0Arg.Evaluate(System.Int32,System.Int32)">
  35540. see {@link Function#Evaluate(ValueEval[], int, int)}
  35541. </member>
  35542. <member name="T:NPOI.SS.Formula.Functions.Function1Arg">
  35543. Implemented by all functions that can be called with one argument
  35544. @author Josh Micich
  35545. </member>
  35546. <member name="M:NPOI.SS.Formula.Functions.Function1Arg.Evaluate(System.Int32,System.Int32,NPOI.SS.Formula.Eval.ValueEval)">
  35547. see {@link Function#Evaluate(ValueEval[], int, int)}
  35548. </member>
  35549. <member name="T:NPOI.SS.Formula.Functions.Function2Arg">
  35550. Implemented by all functions that can be called with two arguments
  35551. @author Josh Micich
  35552. </member>
  35553. <member name="M:NPOI.SS.Formula.Functions.Function2Arg.Evaluate(System.Int32,System.Int32,NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Eval.ValueEval)">
  35554. see {@link Function#Evaluate(ValueEval[], int, int)}
  35555. </member>
  35556. <member name="T:NPOI.SS.Formula.Functions.Function3Arg">
  35557. Implemented by all functions that can be called with three arguments
  35558. @author Josh Micich
  35559. </member>
  35560. <member name="M:NPOI.SS.Formula.Functions.Function3Arg.Evaluate(System.Int32,System.Int32,NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Eval.ValueEval)">
  35561. see {@link Function#Evaluate(ValueEval[], int, int)}
  35562. </member>
  35563. <member name="T:NPOI.SS.Formula.Functions.Function4Arg">
  35564. Implemented by all functions that can be called with four arguments
  35565. @author Josh Micich
  35566. </member>
  35567. <member name="M:NPOI.SS.Formula.Functions.Function4Arg.Evaluate(System.Int32,System.Int32,NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Eval.ValueEval)">
  35568. see {@link Function#Evaluate(ValueEval[], int, int)}
  35569. </member>
  35570. <member name="T:NPOI.SS.Formula.Functions.Hex2Dec">
  35571. Implementation for Excel HEX2DEC() function.<p/>
  35572. <p/>
  35573. <b>Syntax</b>:<br/> <b>HEX2DEC </b>(<b>number</b>)<br/>
  35574. <p/>
  35575. Converts a hexadecimal number to decimal.
  35576. <p/>
  35577. Number is the hexadecimal number you want to Convert. Number cannot contain more than 10 characters (40 bits).
  35578. The most significant bit of number is the sign bit.
  35579. The remaining 39 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
  35580. Remark
  35581. If number is not a valid hexadecimal number, HEX2DEC returns the #NUM! error value.
  35582. @author cedric dot walter @ gmail dot com
  35583. </member>
  35584. <member name="T:NPOI.SS.Formula.Functions.Hlookup">
  35585. Implementation of the HLOOKUP() function.<p/>
  35586. HLOOKUP Finds a column in a lookup table by the first row value and returns the value from another row.<br/>
  35587. <b>Syntax</b>:<br/>
  35588. <b>HLOOKUP</b>(<b>lookup_value</b>, <b>table_array</b>, <b>row_index_num</b>, range_lookup)<p/>
  35589. <b>lookup_value</b> The value to be found in the first column of the table array.<br/>
  35590. <b>table_array</b> An area reference for the lookup data. <br/>
  35591. <b>row_index_num</b> a 1 based index specifying which row value of the lookup data will be returned.<br/>
  35592. <b>range_lookup</b> If TRUE (default), HLOOKUP Finds the largest value less than or equal to
  35593. the lookup_value. If FALSE, only exact Matches will be considered<br/>
  35594. @author Josh Micich
  35595. </member>
  35596. <member name="M:NPOI.SS.Formula.Functions.Hlookup.CreateResultColumnVector(NPOI.SS.Formula.Eval.AreaEval,System.Int32)">
  35597. Returns one column from an <c>AreaEval</c>
  35598. @(#VALUE!) if colIndex Is negative, (#REF!) if colIndex Is too high
  35599. </member>
  35600. <member name="T:NPOI.SS.Formula.Functions.Hyperlink">
  35601. Implementation of Excel HYPERLINK function.<p/>
  35602. In Excel this function has special behaviour - it causes the displayed cell value to behave like
  35603. a hyperlink in the GUI. From an evaluation perspective however, it is very simple.<p/>
  35604. <b>Syntax</b>:<br/>
  35605. <b>HYPERLINK</b>(<b>link_location</b>, friendly_name)<p/>
  35606. <b>link_location</b> The URL of the hyperlink <br/>
  35607. <b>friendly_name</b> (optional) the value to display<p/>
  35608. Returns last argument. Leaves type unchanged (does not convert to {@link org.apache.poi.ss.formula.eval.StringEval}).
  35609. @author Wayne Clingingsmith
  35610. </member>
  35611. <member name="T:NPOI.SS.Formula.Functions.IDStarAlgorithm">
  35612. Interface specifying how an algorithm to be used by {@link DStarRunner} should look like.
  35613. Each implementing class should correspond to one of the D* functions.
  35614. </member>
  35615. <member name="M:NPOI.SS.Formula.Functions.IDStarAlgorithm.ProcessMatch(NPOI.SS.Formula.Eval.ValueEval)">
  35616. Process a match that is found during a run through a database.
  35617. @param eval ValueEval of the cell in the matching row. References will already be Resolved.
  35618. @return Whether we should continue iterating through the database.
  35619. </member>
  35620. <member name="P:NPOI.SS.Formula.Functions.IDStarAlgorithm.Result">
  35621. Return a result ValueEval that will be the result of the calculation.
  35622. This is always called at the end of a run through the database.
  35623. @return a ValueEval
  35624. </member>
  35625. <member name="T:NPOI.SS.Formula.Functions.IfFunc">
  35626. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35627. </member>
  35628. <member name="T:NPOI.SS.Formula.Functions.Imaginary">
  35629. Implementation for Excel IMAGINARY() function.<p/>
  35630. <p/>
  35631. <b>Syntax</b>:<br/> <b>IMAGINARY </b>(<b>Inumber</b>)<br/>
  35632. <p/>
  35633. Returns the imaginary coefficient of a complex number in x + yi or x + yj text format.
  35634. <p/>
  35635. Inumber is a complex number for which you want the imaginary coefficient.
  35636. <p/>
  35637. Remarks
  35638. <ul>
  35639. <li>Use COMPLEX to convert real and imaginary coefficients into a complex number.</li>
  35640. </ul>
  35641. @author cedric dot walter @ gmail dot com
  35642. </member>
  35643. <member name="T:NPOI.SS.Formula.Functions.ImReal">
  35644. Implementation for Excel ImReal() function.<p/>
  35645. <p/>
  35646. <b>Syntax</b>:<br/> <b>ImReal </b>(<b>Inumber</b>)<br/>
  35647. <p/>
  35648. Returns the real coefficient of a complex number in x + yi or x + yj text format.
  35649. <p/>
  35650. Inumber A complex number for which you want the real coefficient.
  35651. <p/>
  35652. Remarks
  35653. <ul>
  35654. <li>If inumber is not in the form x + yi or x + yj, this function returns the #NUM! error value.</li>
  35655. <li>Use COMPLEX to convert real and imaginary coefficients into a complex number.</li>
  35656. </ul>
  35657. @author cedric dot walter @ gmail dot com
  35658. </member>
  35659. <member name="T:NPOI.SS.Formula.Functions.Index">
  35660. Implementation for the Excel function INDEX
  35661. Syntax : <br/>
  35662. INDEX ( reference, row_num[, column_num [, area_num]])<br/>
  35663. INDEX ( array, row_num[, column_num])
  35664. <table border="0" cellpAdding="1" cellspacing="0" summary="Parameter descriptions">
  35665. <tr><th>reference</th><td>typically an area reference, possibly a union of areas</td></tr>
  35666. <tr><th>array</th><td>a literal array value (currently not supported)</td></tr>
  35667. <tr><th>row_num</th><td>selects the row within the array or area reference</td></tr>
  35668. <tr><th>column_num</th><td>selects column within the array or area reference. default Is 1</td></tr>
  35669. <tr><th>area_num</th><td>used when reference Is a union of areas</td></tr>
  35670. </table>
  35671. @author Josh Micich
  35672. </member>
  35673. <member name="M:NPOI.SS.Formula.Functions.Index.GetValueFromArea(NPOI.SS.Formula.Eval.AreaEval,System.Int32,System.Int32,System.Boolean,System.Int32,System.Int32)">
  35674. @param colArgWasPassed <c>false</c> if the INDEX argument lIst had just 2 items
  35675. (exactly 1 comma). If anything Is passed for the <c>column_num</c> argument
  35676. (including {@link BlankEval} or {@link MIssingArgEval}) this parameter will be
  35677. <c>true</c>. ThIs parameter is needed because error codes are slightly
  35678. different when only 2 args are passed.
  35679. </member>
  35680. <member name="M:NPOI.SS.Formula.Functions.Index.ResolveIndexArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  35681. @param arg a 1-based index.
  35682. @return the Resolved 1-based index. Zero if the arg was missing or blank
  35683. @throws EvaluationException if the arg Is an error value evaluates to a negative numeric value
  35684. </member>
  35685. <member name="T:NPOI.SS.Formula.Functions.Indirect">
  35686. Implementation for Excel function INDIRECT<p/>
  35687. INDIRECT() returns the cell or area reference denoted by the text argument.<p/>
  35688. <b>Syntax</b>:<br/>
  35689. <b>INDIRECT</b>(<b>ref_text</b>,isA1Style)<p/>
  35690. <b>ref_text</b> a string representation of the desired reference as it would normally be written
  35691. in a cell formula.<br/>
  35692. <b>isA1Style</b> (default TRUE) specifies whether the ref_text should be interpreted as A1-style
  35693. or R1C1-style.
  35694. @author Josh Micich
  35695. </member>
  35696. <member name="M:NPOI.SS.Formula.Functions.Indirect.ParseWorkbookAndSheetName(System.String)">
  35697. @return array of length 2: {workbookName, sheetName,}. Second element will always be
  35698. present. First element may be null if sheetName is unqualified.
  35699. Returns <code>null</code> if text cannot be parsed.
  35700. </member>
  35701. <member name="M:NPOI.SS.Formula.Functions.Indirect.UnescapeString(System.String)">
  35702. @return <code>null</code> if there is a syntax error in any escape sequence
  35703. (the typical syntax error is a single quote character not followed by another).
  35704. </member>
  35705. <member name="T:NPOI.SS.Formula.Functions.Int">
  35706. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35707. </member>
  35708. <member name="T:NPOI.SS.Formula.Functions.Intercept">
  35709. Implementation of Excel function INTERCEPT()<p/>
  35710. Calculates the INTERCEPT of the linear regression line that is used to predict y values from x values<br/>
  35711. (http://introcs.cs.princeton.edu/java/97data/LinearRegression.java.html)
  35712. <b>Syntax</b>:<br/>
  35713. <b>INTERCEPT</b>(<b>arrayX</b>, <b>arrayY</b>)<p/>
  35714. @author Johan Karlsteen
  35715. </member>
  35716. <member name="T:NPOI.SS.Formula.Functions.Irr">
  35717. Calculates the internal rate of return.
  35718. Syntax is IRR(values) or IRR(values,guess)
  35719. @author Marcel May
  35720. @author Yegor Kozlov
  35721. @see <a href="http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution">Wikipedia on IRR</a>
  35722. @see <a href="http://office.microsoft.com/en-us/excel-help/irr-HP005209146.aspx">Excel IRR</a>
  35723. </member>
  35724. <member name="M:NPOI.SS.Formula.Functions.Irr.irr(System.Double[])">
  35725. Computes the internal rate of return using an estimated irr of 10 percent.
  35726. @param income the income values.
  35727. @return the irr.
  35728. </member>
  35729. <member name="M:NPOI.SS.Formula.Functions.Irr.irr(System.Double[],System.Double)">
  35730. Calculates IRR using the Newton-Raphson Method.
  35731. <p>
  35732. Starting with the guess, the method cycles through the calculation until the result
  35733. is accurate within 0.00001 percent. If IRR can't find a result that works
  35734. after 20 tries, the Double.NaN is returned.
  35735. </p>
  35736. <p>
  35737. The implementation is inspired by the NewtonSolver from the Apache Commons-Math library,
  35738. @see <a href="http://commons.apache.org">http://commons.apache.org</a>
  35739. </p>
  35740. @param values the income values.
  35741. @param guess the initial guess of irr.
  35742. @return the irr value. The method returns <code>Double.NaN</code>
  35743. if the maximum iteration count is exceeded
  35744. @see <a href="http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution">
  35745. http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution</a>
  35746. @see <a href="http://en.wikipedia.org/wiki/Newton%27s_method">
  35747. http://en.wikipedia.org/wiki/Newton%27s_method</a>
  35748. </member>
  35749. <member name="T:NPOI.SS.Formula.Functions.LinearRegressionFunction">
  35750. Base class for linear regression functions.
  35751. Calculates the linear regression line that is used to predict y values from x values<br/>
  35752. (http://introcs.cs.princeton.edu/java/97data/LinearRegression.java.html)
  35753. <b>Syntax</b>:<br/>
  35754. <b>INTERCEPT</b>(<b>arrayX</b>, <b>arrayY</b>)<p/>
  35755. or
  35756. <b>SLOPE</b>(<b>arrayX</b>, <b>arrayY</b>)<p/>
  35757. @author Johan Karlsteen
  35758. </member>
  35759. <member name="T:NPOI.SS.Formula.Functions.Isblank">
  35760. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35761. </member>
  35762. <member name="T:NPOI.SS.Formula.Functions.Iserr">
  35763. contribute by Pavel Egorov
  35764. https://github.com/xoposhiy/npoi/commit/27b34a2389030c7115a666ace65daafda40d61af
  35765. Implementation of Excel <tt>ISERR()</tt> function.<p/>
  35766. <b>Syntax</b>:<br/>
  35767. <b>ISERR</b>(<b>value</b>)<p/>
  35768. <b>value</b> The value to be tested<p/>
  35769. Returns the logical value <tt>TRUE</tt> if value refers to any error value except
  35770. <tt>'#N/A'</tt>; otherwise, it returns <tt>FALSE</tt>.
  35771. </member>
  35772. <member name="T:NPOI.SS.Formula.Functions.Iserror">
  35773. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35774. </member>
  35775. <member name="T:NPOI.SS.Formula.Functions.Islogical">
  35776. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35777. </member>
  35778. <member name="T:NPOI.SS.Formula.Functions.Isna">
  35779. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35780. </member>
  35781. <member name="T:NPOI.SS.Formula.Functions.Isnontext">
  35782. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35783. </member>
  35784. <member name="T:NPOI.SS.Formula.Functions.Isnumber">
  35785. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35786. </member>
  35787. <member name="T:NPOI.SS.Formula.Functions.Isref">
  35788. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35789. </member>
  35790. <member name="T:NPOI.SS.Formula.Functions.Istext">
  35791. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35792. </member>
  35793. <member name="T:NPOI.SS.Formula.Functions.LogicalFunction">
  35794. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35795. </member>
  35796. <member name="M:NPOI.SS.Formula.Functions.LogicalFunction.Evaluate(NPOI.SS.Formula.Eval.ValueEval)">
  35797. @param arg any {@link ValueEval}, potentially {@link BlankEval} or {@link ErrorEval}.
  35798. </member>
  35799. <member name="T:NPOI.SS.Formula.Functions.Lookup">
  35800. Implementation of Excel function LOOKUP.<p/>
  35801. LOOKUP Finds an index row in a lookup table by the first column value and returns the value from another column.
  35802. <b>Syntax</b>:<br/>
  35803. <b>VLOOKUP</b>(<b>lookup_value</b>, <b>lookup_vector</b>, result_vector)<p/>
  35804. <b>lookup_value</b> The value to be found in the lookup vector.<br/>
  35805. <b>lookup_vector</b> An area reference for the lookup data. <br/>
  35806. <b>result_vector</b> Single row or single column area reference from which the result value Is chosen.<br/>
  35807. @author Josh Micich
  35808. </member>
  35809. <member name="T:NPOI.SS.Formula.Functions.LookupUtils">
  35810. Common functionality used by VLOOKUP, HLOOKUP, LOOKUP and MATCH
  35811. @author Josh Micich
  35812. </member>
  35813. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.CreateVector(NPOI.SS.Formula.TwoDEval)">
  35814. @return <c>null</c> if the supplied area is neither a single row nor a single colum
  35815. </member>
  35816. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.ResolveRowOrColIndexArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  35817. Processes the third argument to VLOOKUP, or HLOOKUP (<b>col_index_num</b>
  35818. or <b>row_index_num</b> respectively).<br/>
  35819. Sample behaviour:
  35820. <table border="0" cellpAdding="1" cellspacing="2" summary="Sample behaviour">
  35821. <tr><th>Input Return</th><th>Value </th><th>Thrown Error</th></tr>
  35822. <tr><td>5</td><td>4</td><td> </td></tr>
  35823. <tr><td>2.9</td><td>2</td><td> </td></tr>
  35824. <tr><td>"5"</td><td>4</td><td> </td></tr>
  35825. <tr><td>"2.18e1"</td><td>21</td><td> </td></tr>
  35826. <tr><td>"-$2"</td><td>-3</td><td>*</td></tr>
  35827. <tr><td>FALSE</td><td>-1</td><td>*</td></tr>
  35828. <tr><td>TRUE</td><td>0</td><td> </td></tr>
  35829. <tr><td>"TRUE"</td><td> </td><td>#REF!</td></tr>
  35830. <tr><td>"abc"</td><td> </td><td>#REF!</td></tr>
  35831. <tr><td>""</td><td> </td><td>#REF!</td></tr>
  35832. <tr><td>&lt;blank&gt;</td><td> </td><td>#VALUE!</td></tr>
  35833. </table><br/>
  35834. * Note - out of range errors (both too high and too low) are handled by the caller.
  35835. @return column or row index as a zero-based value
  35836. </member>
  35837. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.ResolveTableArrayArg(NPOI.SS.Formula.Eval.ValueEval)">
  35838. The second argument (table_array) should be an area ref, but can actually be a cell ref, in
  35839. which case it Is interpreted as a 1x1 area ref. Other scalar values cause #VALUE! error.
  35840. </member>
  35841. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.ResolveRangeLookupArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  35842. Resolves the last (optional) parameter (<b>range_lookup</b>) to the VLOOKUP and HLOOKUP functions.
  35843. @param rangeLookupArg
  35844. @param srcCellRow
  35845. @param srcCellCol
  35846. @return
  35847. @throws EvaluationException
  35848. </member>
  35849. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.lookupFirstIndexOfValue(NPOI.SS.Formula.Functions.LookupValueComparer,NPOI.SS.Formula.Functions.ValueVector,NPOI.SS.Formula.Functions.LookupUtils.MatchMode)">
  35850. Finds first (lowest index) exact occurrence of specified value.
  35851. @param lookupComparer the value to be found in column or row vector
  35852. @param vector the values to be searched. For VLOOKUP this Is the first column of the
  35853. tableArray. For HLOOKUP this Is the first row of the tableArray.
  35854. @return zero based index into the vector, -1 if value cannot be found
  35855. </member>
  35856. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.lookupLastIndexOfValue(NPOI.SS.Formula.Functions.LookupValueComparer,NPOI.SS.Formula.Functions.ValueVector,NPOI.SS.Formula.Functions.LookupUtils.MatchMode)">
  35857. Finds last (greatest index) matching occurrence of specified value.
  35858. @param lookupComparer the value to be found in column or row vector
  35859. @param vector the values to be searched. For VLOOKUP this is the first column of the
  35860. tableArray. For HLOOKUP this is the first row of the tableArray.
  35861. @param matchMode
  35862. @return zero based index into the vector, -1 if value cannot be found
  35863. </member>
  35864. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.PerformBinarySearch(NPOI.SS.Formula.Functions.ValueVector,NPOI.SS.Formula.Functions.LookupValueComparer)">
  35865. Excel has funny behaviour when the some elements in the search vector are the wrong type.
  35866. </member>
  35867. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.HandleMidValueTypeMismatch(NPOI.SS.Formula.Functions.LookupValueComparer,NPOI.SS.Formula.Functions.ValueVector,NPOI.SS.Formula.Functions.BinarySearchIndexes,System.Int32)">
  35868. Excel seems to handle mismatched types initially by just stepping 'mid' ix forward to the
  35869. first compatible value.
  35870. @param midIx 'mid' index (value which has the wrong type)
  35871. @return usually -1, signifying that the BinarySearchIndex has been narrowed to the new mid
  35872. index. Zero or greater signifies that an exact match for the lookup value was found
  35873. </member>
  35874. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.FindLastIndexInRunOfEqualValues(NPOI.SS.Formula.Functions.LookupValueComparer,NPOI.SS.Formula.Functions.ValueVector,System.Int32,System.Int32)">
  35875. Once the binary search has found a single match, (V/H)LOOKUP steps one by one over subsequent
  35876. values to choose the last matching item.
  35877. </member>
  35878. <member name="T:NPOI.SS.Formula.Functions.CompareResult">
  35879. Enumeration to support <b>4</b> valued comparison results.<p/>
  35880. Excel lookup functions have complex behaviour in the case where the lookup array has mixed
  35881. types, and/or Is Unordered. Contrary to suggestions in some Excel documentation, there
  35882. does not appear to be a Universal ordering across types. The binary search algorithm used
  35883. Changes behaviour when the Evaluated 'mid' value has a different type to the lookup value.<p/>
  35884. A simple int might have done the same job, but there Is risk in confusion with the well
  35885. known <c>Comparable.CompareTo()</c> and <c>Comparator.Compare()</c> which both use
  35886. a ubiquitous 3 value result encoding.
  35887. </member>
  35888. <member name="T:NPOI.SS.Formula.Functions.BinarySearchIndexes">
  35889. Encapsulates some standard binary search functionality so the Unusual Excel behaviour can
  35890. be clearly distinguished.
  35891. </member>
  35892. <member name="M:NPOI.SS.Formula.Functions.BinarySearchIndexes.GetMidIx">
  35893. @return -1 if the search range Is empty
  35894. </member>
  35895. <member name="T:NPOI.SS.Formula.Functions.ValueVector">
  35896. Represents a single row or column within an <c>AreaEval</c>.
  35897. </member>
  35898. <member name="M:NPOI.SS.Formula.Functions.LookupValueComparer.CompareTo(NPOI.SS.Formula.Eval.ValueEval)">
  35899. @return one of 4 instances or <c>CompareResult</c>: <c>LESS_THAN</c>, <c>EQUAL</c>,
  35900. <c>GREATER_THAN</c> or <c>TYPE_MISMATCH</c>
  35901. </member>
  35902. <member name="M:NPOI.SS.Formula.Functions.LookupValueComparerBase.GetValueAsString">
  35903. used only for debug purposes
  35904. </member>
  35905. <member name="T:NPOI.SS.Formula.Functions.Match">
  35906. Implementation for the MATCH() Excel function.<p/>
  35907. <b>Syntax:</b><br/>
  35908. <b>MATCH</b>(<b>lookup_value</b>, <b>lookup_array</b>, match_type)<p/>
  35909. Returns a 1-based index specifying at what position in the <b>lookup_array</b> the specified
  35910. <b>lookup_value</b> Is found.<p/>
  35911. Specific matching behaviour can be modified with the optional <b>match_type</b> parameter.
  35912. <table border="0" cellpAdding="1" cellspacing="0" summary="match_type parameter description">
  35913. <tr><th>Value</th><th>Matching Behaviour</th></tr>
  35914. <tr><td>1</td><td>(default) Find the largest value that Is less than or equal to lookup_value.
  35915. The lookup_array must be in ascending <i>order</i>*.</td></tr>
  35916. <tr><td>0</td><td>Find the first value that Is exactly equal to lookup_value.
  35917. The lookup_array can be in any order.</td></tr>
  35918. <tr><td>-1</td><td>Find the smallest value that Is greater than or equal to lookup_value.
  35919. The lookup_array must be in descending <i>order</i>*.</td></tr>
  35920. </table>
  35921. * Note regarding <i>order</i> - For the <b>match_type</b> cases that require the lookup_array to
  35922. be ordered, MATCH() can produce incorrect results if this requirement Is not met. Observed
  35923. behaviour in Excel Is to return the lowest index value for which every item after that index
  35924. breaks the match rule.<br/>
  35925. The (ascending) sort order expected by MATCH() Is:<br/>
  35926. numbers (low to high), strings (A to Z), bool (FALSE to TRUE)<br/>
  35927. MATCH() ignores all elements in the lookup_array with a different type to the lookup_value.
  35928. Type conversion of the lookup_array elements Is never performed.
  35929. @author Josh Micich
  35930. </member>
  35931. <member name="M:NPOI.SS.Formula.Functions.Match.FindIndexOfValue(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Functions.ValueVector,System.Boolean,System.Boolean)">
  35932. @return zero based index
  35933. </member>
  35934. <member name="T:NPOI.SS.Formula.Functions.MathX">
  35935. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35936. This class Is an extension to the standard math library
  35937. provided by java.lang.Math class. It follows the Math class
  35938. in that it has a private constructor and all static methods.
  35939. </member>
  35940. <member name="M:NPOI.SS.Formula.Functions.MathX.Round(System.Double,System.Int32)">
  35941. Returns a value rounded to p digits after decimal.
  35942. If p Is negative, then the number Is rounded to
  35943. places to the left of the decimal point. eg.
  35944. 10.23 rounded to -1 will give: 10. If p Is zero,
  35945. the returned value Is rounded to the nearest integral
  35946. value.
  35947. If n Is negative, the resulting value Is obtained
  35948. as the round value of absolute value of n multiplied
  35949. by the sign value of n (@see MathX.sign(double d)).
  35950. Thus, -0.6666666 rounded to p=0 will give -1 not 0.
  35951. If n Is NaN, returned value Is NaN.
  35952. @param n
  35953. @param p
  35954. </member>
  35955. <member name="M:NPOI.SS.Formula.Functions.MathX.RoundUp(System.Double,System.Int32)">
  35956. Returns a value rounded-up to p digits after decimal.
  35957. If p Is negative, then the number Is rounded to
  35958. places to the left of the decimal point. eg.
  35959. 10.23 rounded to -1 will give: 20. If p Is zero,
  35960. the returned value Is rounded to the nearest integral
  35961. value.
  35962. If n Is negative, the resulting value Is obtained
  35963. as the round-up value of absolute value of n multiplied
  35964. by the sign value of n (@see MathX.sign(double d)).
  35965. Thus, -0.2 rounded-up to p=0 will give -1 not 0.
  35966. If n Is NaN, returned value Is NaN.
  35967. @param n
  35968. @param p
  35969. </member>
  35970. <member name="M:NPOI.SS.Formula.Functions.MathX.RoundDown(System.Double,System.Int32)">
  35971. Returns a value rounded to p digits after decimal.
  35972. If p Is negative, then the number Is rounded to
  35973. places to the left of the decimal point. eg.
  35974. 10.23 rounded to -1 will give: 10. If p Is zero,
  35975. the returned value Is rounded to the nearest integral
  35976. value.
  35977. If n Is negative, the resulting value Is obtained
  35978. as the round-up value of absolute value of n multiplied
  35979. by the sign value of n (@see MathX.sign(double d)).
  35980. Thus, -0.8 rounded-down to p=0 will give 0 not -1.
  35981. If n Is NaN, returned value Is NaN.
  35982. @param n
  35983. @param p
  35984. </member>
  35985. <member name="M:NPOI.SS.Formula.Functions.MathX.Average(System.Double[])">
  35986. average of all values
  35987. @param values
  35988. </member>
  35989. <member name="M:NPOI.SS.Formula.Functions.MathX.Sum(System.Double[])">
  35990. sum of all values
  35991. @param values
  35992. </member>
  35993. <member name="M:NPOI.SS.Formula.Functions.MathX.Sumsq(System.Double[])">
  35994. sum of squares of all values
  35995. @param values
  35996. </member>
  35997. <member name="M:NPOI.SS.Formula.Functions.MathX.Product(System.Double[])">
  35998. product of all values
  35999. @param values
  36000. </member>
  36001. <member name="M:NPOI.SS.Formula.Functions.MathX.Min(System.Double[])">
  36002. min of all values. If supplied array Is zero Length,
  36003. double.POSITIVE_INFINITY Is returned.
  36004. @param values
  36005. </member>
  36006. <member name="M:NPOI.SS.Formula.Functions.MathX.Max(System.Double[])">
  36007. min of all values. If supplied array Is zero Length,
  36008. double.NEGATIVE_INFINITY Is returned.
  36009. @param values
  36010. </member>
  36011. <member name="M:NPOI.SS.Formula.Functions.MathX.Floor(System.Double,System.Double)">
  36012. Note: this function Is different from java.lang.Math.floor(..).
  36013. When n and s are "valid" arguments, the returned value Is: Math.floor(n/s) * s;
  36014. <br/>
  36015. n and s are invalid if any of following conditions are true:
  36016. <ul>
  36017. <li>s Is zero</li>
  36018. <li>n Is negative and s Is positive</li>
  36019. <li>n Is positive and s Is negative</li>
  36020. </ul>
  36021. In all such cases, double.NaN Is returned.
  36022. @param n
  36023. @param s
  36024. </member>
  36025. <member name="M:NPOI.SS.Formula.Functions.MathX.Ceiling(System.Double,System.Double)">
  36026. Note: this function Is different from java.lang.Math.ceil(..).
  36027. When n and s are "valid" arguments, the returned value Is: Math.ceiling(n/s) * s;
  36028. <br/>
  36029. n and s are invalid if any of following conditions are true:
  36030. <ul>
  36031. <li>s Is zero</li>
  36032. <li>n Is negative and s Is positive</li>
  36033. <li>n Is positive and s Is negative</li>
  36034. </ul>
  36035. In all such cases, double.NaN Is returned.
  36036. @param n
  36037. @param s
  36038. </member>
  36039. <member name="M:NPOI.SS.Formula.Functions.MathX.Factorial(System.Int32)">
  36040. <br/> for all n >= 1; factorial n = n * (n-1) * (n-2) * ... * 1
  36041. <br/> else if n == 0; factorial n = 1
  36042. <br/> else if n &lt; 0; factorial n = double.NaN
  36043. <br/> Loss of precision can occur if n Is large enough.
  36044. If n Is large so that the resulting value would be greater
  36045. than double.MAX_VALUE; double.POSITIVE_INFINITY Is returned.
  36046. If n &lt; 0, double.NaN Is returned.
  36047. @param n
  36048. </member>
  36049. <member name="M:NPOI.SS.Formula.Functions.MathX.Mod(System.Double,System.Double)">
  36050. returns the remainder resulting from operation:
  36051. n / d.
  36052. <br/> The result has the sign of the divisor.
  36053. <br/> Examples:
  36054. <ul>
  36055. <li>mod(3.4, 2) = 1.4</li>
  36056. <li>mod(-3.4, 2) = 0.6</li>
  36057. <li>mod(-3.4, -2) = -1.4</li>
  36058. <li>mod(3.4, -2) = -0.6</li>
  36059. </ul>
  36060. If d == 0, result Is NaN
  36061. @param n
  36062. @param d
  36063. </member>
  36064. <member name="M:NPOI.SS.Formula.Functions.MathX.Acosh(System.Double)">
  36065. inverse hyperbolic cosine
  36066. @param d
  36067. </member>
  36068. <member name="M:NPOI.SS.Formula.Functions.MathX.Asinh(System.Double)">
  36069. inverse hyperbolic sine
  36070. @param d
  36071. </member>
  36072. <member name="M:NPOI.SS.Formula.Functions.MathX.Atanh(System.Double)">
  36073. inverse hyperbolic tangent
  36074. @param d
  36075. </member>
  36076. <member name="M:NPOI.SS.Formula.Functions.MathX.Cosh(System.Double)">
  36077. hyperbolic cosine
  36078. @param d
  36079. </member>
  36080. <member name="M:NPOI.SS.Formula.Functions.MathX.Sinh(System.Double)">
  36081. hyperbolic sine
  36082. @param d
  36083. </member>
  36084. <member name="M:NPOI.SS.Formula.Functions.MathX.Tanh(System.Double)">
  36085. hyperbolic tangent
  36086. @param d
  36087. </member>
  36088. <member name="M:NPOI.SS.Formula.Functions.MathX.SumProduct(System.Double[][])">
  36089. returns the sum of product of corresponding double value in each
  36090. subarray. It Is the responsibility of the caller to Ensure that
  36091. all the subarrays are of equal Length. If the subarrays are
  36092. not of equal Length, the return value can be Unpredictable.
  36093. @param arrays
  36094. </member>
  36095. <member name="M:NPOI.SS.Formula.Functions.MathX.Sumx2my2(System.Double[],System.Double[])">
  36096. returns the sum of difference of squares of corresponding double
  36097. value in each subarray: ie. sigma (xarr[i]^2-yarr[i]^2)
  36098. <br/>
  36099. It Is the responsibility of the caller
  36100. to Ensure that the two subarrays are of equal Length. If the
  36101. subarrays are not of equal Length, the return value can be
  36102. Unpredictable.
  36103. @param xarr
  36104. @param yarr
  36105. </member>
  36106. <member name="M:NPOI.SS.Formula.Functions.MathX.Sumx2py2(System.Double[],System.Double[])">
  36107. returns the sum of sum of squares of corresponding double
  36108. value in each subarray: ie. sigma (xarr[i]^2 + yarr[i]^2)
  36109. <br/>
  36110. It Is the responsibility of the caller
  36111. to Ensure that the two subarrays are of equal Length. If the
  36112. subarrays are not of equal Length, the return value can be
  36113. Unpredictable.
  36114. @param xarr
  36115. @param yarr
  36116. </member>
  36117. <member name="M:NPOI.SS.Formula.Functions.MathX.Sumxmy2(System.Double[],System.Double[])">
  36118. returns the sum of squares of difference of corresponding double
  36119. value in each subarray: ie. sigma ( (xarr[i]-yarr[i])^2 )
  36120. <br/>
  36121. It Is the responsibility of the caller
  36122. to Ensure that the two subarrays are of equal Length. If the
  36123. subarrays are not of equal Length, the return value can be
  36124. Unpredictable.
  36125. @param xarr
  36126. @param yarr
  36127. </member>
  36128. <member name="M:NPOI.SS.Formula.Functions.MathX.NChooseK(System.Int32,System.Int32)">
  36129. returns the total number of combinations possible when
  36130. k items are chosen out of total of n items. If the number
  36131. Is too large, loss of precision may occur (since returned
  36132. value Is double). If the returned value Is larger than
  36133. double.MAX_VALUE, double.POSITIVE_INFINITY Is returned.
  36134. If either of the parameters Is negative, double.NaN Is returned.
  36135. @param n
  36136. @param k
  36137. </member>
  36138. <member name="T:NPOI.SS.Formula.Functions.MinaMaxa">
  36139. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36140. </member>
  36141. <member name="T:NPOI.SS.Formula.Functions.Mirr">
  36142. Calculates Modified internal rate of return. Syntax is MIRR(cash_flow_values, finance_rate, reinvest_rate)
  36143. <p>Returns the modified internal rate of return for a series of periodic cash flows. MIRR considers both the cost
  36144. of the investment and the interest received on reinvestment of cash.</p>
  36145. Values is an array or a reference to cells that contain numbers. These numbers represent a series of payments (negative values) and income (positive values) occurring at regular periods.
  36146. <ul>
  36147. <li>Values must contain at least one positive value and one negative value to calculate the modified internal rate of return. Otherwise, MIRR returns the #DIV/0! error value.</li>
  36148. <li>If an array or reference argument Contains text, logical values, or empty cells, those values are ignored; however, cells with the value zero are included.</li>
  36149. </ul>
  36150. Finance_rate is the interest rate you pay on the money used in the cash flows.
  36151. Reinvest_rate is the interest rate you receive on the cash flows as you reinvest them.
  36152. @author Carlos Delgado (carlos dot del dot est at gmail dot com)
  36153. @author Cédric Walter (cedric dot walter at gmail dot com)
  36154. @see <a href="http://en.wikipedia.org/wiki/MIRR">Wikipedia on MIRR</a>
  36155. @see <a href="http://office.microsoft.com/en-001/excel-help/mirr-HP005209180.aspx">Excel MIRR</a>
  36156. @see {@link Irr}
  36157. </member>
  36158. <member name="T:NPOI.SS.Formula.Functions.Mod">
  36159. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36160. </member>
  36161. <member name="T:NPOI.SS.Formula.Functions.Mode">
  36162. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36163. </member>
  36164. <member name="M:NPOI.SS.Formula.Functions.Mode.Evaluate(System.Double[])">
  36165. if v is zero length or contains no duplicates, return value is
  36166. Double.NaN. Else returns the value that occurs most times and if there is
  36167. a tie, returns the first such value.
  36168. @param v
  36169. </member>
  36170. <member name="T:NPOI.SS.Formula.Functions.MultiOperandNumericFunction">
  36171. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36172. This Is the base class for all excel function evaluator
  36173. classes that take variable number of operands, and
  36174. where the order of operands does not matter
  36175. </member>
  36176. <member name="P:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.MaxNumOperands">
  36177. Maximum number of operands accepted by this function.
  36178. Subclasses may override to Change default value.
  36179. </member>
  36180. <member name="P:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.IsSubtotalCounted">
  36181. Whether to count nested subtotals.
  36182. </member>
  36183. <member name="M:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.CollectValues(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Functions.MultiOperandNumericFunction.DoubleList)">
  36184. Collects values from a single argument
  36185. </member>
  36186. <member name="M:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.GetNumberArray(NPOI.SS.Formula.Eval.ValueEval[])">
  36187. Returns a double array that contains values for the numeric cells
  36188. from among the list of operands. Blanks and Blank equivalent cells
  36189. are ignored. Error operands or cells containing operands of type
  36190. that are considered invalid and would result in #VALUE! error in
  36191. excel cause this function to return <c>null</c>.
  36192. @return never <c>null</c>
  36193. </member>
  36194. <member name="M:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.AreSubArraysConsistent(System.Double[][])">
  36195. Ensures that a two dimensional array has all sub-arrays present and the same Length
  36196. @return <c>false</c> if any sub-array Is missing, or Is of different Length
  36197. </member>
  36198. <member name="T:NPOI.SS.Formula.Functions.Na">
  36199. Implementation of Excel function NA()
  36200. @author Josh Micich
  36201. </member>
  36202. <member name="T:NPOI.SS.Formula.Functions.NotImplementedFunction">
  36203. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36204. This Is the default implementation of a Function class.
  36205. The default behaviour Is to return a non-standard ErrorEval
  36206. "ErrorEval.FUNCTION_NOT_IMPLEMENTED". This error should alert
  36207. the user that the formula contained a function that Is not
  36208. yet implemented.
  36209. </member>
  36210. <member name="T:NPOI.SS.Formula.Functions.Now">
  36211. Implementation of Excel NOW() Function
  36212. @author Frank Taffelt
  36213. </member>
  36214. <member name="T:NPOI.SS.Formula.Functions.Abs">
  36215. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36216. </member>
  36217. <member name="T:NPOI.SS.Formula.Functions.Acos">
  36218. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36219. </member>
  36220. <member name="T:NPOI.SS.Formula.Functions.Acosh">
  36221. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36222. Support for hyperbolic trig functions was Added as a part of
  36223. Java distribution only in JDK1.5. This class uses custom
  36224. naive implementation based on formulas at:
  36225. http://www.math2.org/math/trig/hyperbolics.htm
  36226. These formulas seem to agree with excel's implementation.
  36227. </member>
  36228. <member name="T:NPOI.SS.Formula.Functions.Asin">
  36229. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36230. </member>
  36231. <member name="T:NPOI.SS.Formula.Functions.Asinh">
  36232. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36233. Support for hyperbolic trig functions was Added as a part of
  36234. Java distribution only in JDK1.5. This class uses custom
  36235. naive implementation based on formulas at:
  36236. http://www.math2.org/math/trig/hyperbolics.htm
  36237. These formulas seem to agree with excel's implementation.
  36238. </member>
  36239. <member name="T:NPOI.SS.Formula.Functions.Atan">
  36240. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36241. </member>
  36242. <member name="T:NPOI.SS.Formula.Functions.Atan2">
  36243. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36244. </member>
  36245. <member name="T:NPOI.SS.Formula.Functions.Atanh">
  36246. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36247. Support for hyperbolic trig functions was Added as a part of
  36248. Java distribution only in JDK1.5. This class uses custom
  36249. naive implementation based on formulas at:
  36250. http://www.math2.org/math/trig/hyperbolics.htm
  36251. These formulas seem to agree with excel's implementation.
  36252. </member>
  36253. <member name="T:NPOI.SS.Formula.Functions.Cos">
  36254. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36255. </member>
  36256. <member name="T:NPOI.SS.Formula.Functions.Cosh">
  36257. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36258. </member>
  36259. <member name="T:NPOI.SS.Formula.Functions.Ln">
  36260. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36261. </member>
  36262. <member name="T:NPOI.SS.Formula.Functions.Log">
  36263. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36264. Log: LOG(number,[base])
  36265. </member>
  36266. <member name="T:NPOI.SS.Formula.Functions.Log10">
  36267. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36268. </member>
  36269. <member name="T:NPOI.SS.Formula.Functions.NumericFunction">
  36270. @author Amol S. Deshmukh &lt; amolweb at yahoo dot com &gt;
  36271. </member>
  36272. <member name="T:NPOI.SS.Formula.Functions.Pi">
  36273. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36274. </member>
  36275. <member name="M:NPOI.SS.Formula.Functions.Poisson.IsDefaultResult(System.Double,System.Double)">
  36276. This checks is x = 0 and the mean = 0.
  36277. Excel currently returns the value 1 where as the
  36278. maths common implementation will error.
  36279. @param x The number.
  36280. @param mean The mean.
  36281. @return If a default value should be returned.
  36282. </member>
  36283. <member name="F:NPOI.SS.Formula.Functions.Poisson.FACTORIALS">
  36284. All long-representable factorials
  36285. </member>
  36286. <member name="T:NPOI.SS.Formula.Functions.Rand">
  36287. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36288. </member>
  36289. <member name="T:NPOI.SS.Formula.Functions.Sin">
  36290. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36291. </member>
  36292. <member name="T:NPOI.SS.Formula.Functions.Sinh">
  36293. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36294. </member>
  36295. <member name="T:NPOI.SS.Formula.Functions.Sqrt">
  36296. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36297. </member>
  36298. <member name="T:NPOI.SS.Formula.Functions.Tan">
  36299. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36300. </member>
  36301. <member name="T:NPOI.SS.Formula.Functions.Tanh">
  36302. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36303. </member>
  36304. <member name="T:NPOI.SS.Formula.Functions.Oct2Dec">
  36305. <p>Implementation for Excel Oct2Dec() function.</p>
  36306. <p>
  36307. Converts an octal number to decimal.
  36308. </p>
  36309. <p>
  36310. <b>Syntax</b>:<br/> <b>Oct2Dec </b>(<b>number</b> )
  36311. </p>
  36312. <p/>
  36313. Number is the octal number you want to Convert. Number may not contain more than 10 octal characters (30 bits).
  36314. The most significant bit of number is the sign bit. The remaining 29 bits are magnitude bits.
  36315. Negative numbers are represented using two's-complement notation..
  36316. <p/>
  36317. If number is not a valid octal number, OCT2DEC returns the #NUM! error value.
  36318. @author cedric dot walter @ gmail dot com
  36319. </member>
  36320. <member name="T:NPOI.SS.Formula.Functions.Odd">
  36321. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36322. </member>
  36323. <member name="T:NPOI.SS.Formula.Functions.Offset">
  36324. Implementation for Excel function OFFSet()<p/>
  36325. OFFSet returns an area reference that Is a specified number of rows and columns from a
  36326. reference cell or area.<p/>
  36327. <b>Syntax</b>:<br/>
  36328. <b>OFFSet</b>(<b>reference</b>, <b>rows</b>, <b>cols</b>, height, width)<p/>
  36329. <b>reference</b> Is the base reference.<br/>
  36330. <b>rows</b> Is the number of rows up or down from the base reference.<br/>
  36331. <b>cols</b> Is the number of columns left or right from the base reference.<br/>
  36332. <b>height</b> (default same height as base reference) Is the row Count for the returned area reference.<br/>
  36333. <b>width</b> (default same width as base reference) Is the column Count for the returned area reference.<br/>
  36334. @author Josh Micich
  36335. </member>
  36336. <member name="T:NPOI.SS.Formula.Functions.Offset.EvalEx">
  36337. Exceptions are used within this class to help simplify flow control when error conditions
  36338. are enCountered
  36339. </member>
  36340. <member name="T:NPOI.SS.Formula.Functions.Offset.LinearOffsetRange">
  36341. A one dimensional base + offset. Represents either a row range or a column range.
  36342. Two instances of this class toGether specify an area range.
  36343. </member>
  36344. <member name="M:NPOI.SS.Formula.Functions.Offset.LinearOffsetRange.NormaliseAndTranslate(System.Int32)">
  36345. Moves the range by the specified translation amount.<p/>
  36346. This method also 'normalises' the range: Excel specifies that the width and height
  36347. parameters (Length field here) cannot be negative. However, OFFSet() does produce
  36348. sensible results in these cases. That behavior Is replicated here. <p/>
  36349. @param translationAmount may be zero negative or positive
  36350. @return the equivalent <c>LinearOffsetRange</c> with a positive Length, moved by the
  36351. specified translationAmount.
  36352. </member>
  36353. <member name="T:NPOI.SS.Formula.Functions.Offset.BaseRef">
  36354. Encapsulates either an area or cell reference which may be 2d or 3d.
  36355. </member>
  36356. <member name="M:NPOI.SS.Formula.Functions.Offset.EvaluateIntArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  36357. OFFSet's numeric arguments (2..5) have similar Processing rules
  36358. </member>
  36359. <member name="M:NPOI.SS.Formula.Functions.Offset.ConvertDoubleToInt(System.Double)">
  36360. Fractional values are silently truncated by Excel.
  36361. Truncation Is toward negative infinity.
  36362. </member>
  36363. <member name="T:NPOI.SS.Formula.Functions.PercentRank">
  36364. <summary>
  36365. Implementation of 'Analysis Toolpak' the Excel function PERCENTRANK()
  36366. </summary>
  36367. </member>
  36368. <member name="T:NPOI.SS.Formula.Functions.Pmt">
  36369. Implementation for the PMT() Excel function.<p/>
  36370. <b>Syntax:</b><br/>
  36371. <b>PMT</b>(<b>rate</b>, <b>nper</b>, <b>pv</b>, fv, type)<p/>
  36372. Returns the constant repayment amount required for a loan assuming a constant interest rate.<p/>
  36373. <b>rate</b> the loan interest rate.<br/>
  36374. <b>nper</b> the number of loan repayments.<br/>
  36375. <b>pv</b> the present value of the future payments (or principle).<br/>
  36376. <b>fv</b> the future value (default zero) surplus cash at the end of the loan lifetime.<br/>
  36377. <b>type</b> whether payments are due at the beginning(1) or end(0 - default) of each payment period.<br/>
  36378. </member>
  36379. <member name="T:NPOI.SS.Formula.Functions.Power">
  36380. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36381. </member>
  36382. <member name="T:NPOI.SS.Formula.Functions.PPMT">
  36383. Compute the interest portion of a payment.
  36384. @author Mike Argyriou micharg@gmail.com
  36385. </member>
  36386. <member name="T:NPOI.SS.Formula.Functions.Quotient">
  36387. <p>Implementation for Excel QUOTIENT () function.</p>
  36388. <p>
  36389. <b>Syntax</b>:<br/> <b>QUOTIENT</b>(<b>Numerator</b>,<b>Denominator</b>)<br/>
  36390. </p>
  36391. <p>
  36392. Numerator is the dividend.
  36393. Denominator is the divisor.
  36394. Returns the integer portion of a division. Use this function when you want to discard the remainder of a division.
  36395. </p>
  36396. If either enumerator/denominator is non numeric, QUOTIENT returns the #VALUE! error value.
  36397. If denominator is Equals to zero, QUOTIENT returns the #DIV/0! error value.
  36398. @author cedric dot walter @ gmail dot com
  36399. </member>
  36400. <member name="T:NPOI.SS.Formula.Functions.Radians">
  36401. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36402. </member>
  36403. <member name="T:NPOI.SS.Formula.Functions.Rank">
  36404. * Returns the rank of a number in a list of numbers. The rank of a number is its size relative to other values in a list.
  36405. * Syntax:
  36406. * RANK(number,ref,order)
  36407. * Number is the number whose rank you want to find.
  36408. * Ref is an array of, or a reference to, a list of numbers. Nonnumeric values in ref are ignored.
  36409. * Order is a number specifying how to rank number.
  36410. * If order is 0 (zero) or omitted, Microsoft Excel ranks number as if ref were a list sorted in descending order.
  36411. * If order is any nonzero value, Microsoft Excel ranks number as if ref were a list sorted in ascending order.
  36412. *
  36413. * @author Rubin Wang
  36414. </member>
  36415. <member name="T:NPOI.SS.Formula.Functions.Rate">
  36416. Implements the Excel Rate function
  36417. </member>
  36418. <member name="M:NPOI.SS.Formula.Functions.Rate.CheckValue(System.Double)">
  36419. Excel does not support infinities and NaNs, rather, it gives a #NUM! error in these cases
  36420. @throws EvaluationException (#NUM!) if result is NaN or Infinity
  36421. </member>
  36422. <member name="T:NPOI.SS.Formula.Functions.Rept">
  36423. Implementation for Excel REPT () function.<p/>
  36424. <p/>
  36425. <b>Syntax</b>:<br/> <b>REPT </b>(<b>text</b>,<b>number_times</b> )<br/>
  36426. <p/>
  36427. Repeats text a given number of times. Use REPT to fill a cell with a number of instances of a text string.
  36428. text : text The text that you want to repeat.
  36429. number_times: A positive number specifying the number of times to repeat text.
  36430. If number_times is 0 (zero), REPT returns "" (empty text).
  36431. If this argument contains a decimal value, this function ignores the numbers to the right side of the decimal point.
  36432. The result of the REPT function cannot be longer than 32,767 characters, or REPT returns #VALUE!.
  36433. @author cedric dot walter @ gmail dot com
  36434. </member>
  36435. <member name="T:NPOI.SS.Formula.Functions.Roman">
  36436. Implementation for Excel WeekNum() function.<p/>
  36437. <p/>
  36438. <b>Syntax</b>:<br/> <b>WeekNum </b>(<b>Serial_num</b>,<b>Return_type</b>)<br/>
  36439. <p/>
  36440. Returns a number that indicates where the week falls numerically within a year.
  36441. <p/>
  36442. <p/>
  36443. Serial_num is a date within the week. Dates should be entered by using the DATE function,
  36444. or as results of other formulas or functions. For example, use DATE(2008,5,23)
  36445. for the 23rd day of May, 2008. Problems can occur if dates are entered as text.
  36446. Return_type is a number that determines on which day the week begins. The default is 1.
  36447. 1 Week begins on Sunday. Weekdays are numbered 1 through 7.
  36448. 2 Week begins on Monday. Weekdays are numbered 1 through 7.
  36449. @author cedric dot walter @ gmail dot com
  36450. </member>
  36451. <member name="M:NPOI.SS.Formula.Functions.Roman.integerToRoman(System.Int32)">
  36452. Classic conversion.
  36453. @param number
  36454. @return
  36455. </member>
  36456. <member name="M:NPOI.SS.Formula.Functions.Roman.MakeConcise(System.String,System.Int32)">
  36457. Use conversion rule to factor some parts and make them more concise
  36458. @param result
  36459. @param form
  36460. @return
  36461. </member>
  36462. <member name="T:NPOI.SS.Formula.Functions.Rows">
  36463. Implementation for Excel ROWS function.
  36464. @author Josh Micich
  36465. </member>
  36466. <member name="T:NPOI.SS.Formula.Functions.Slope">
  36467. Implementation of Excel function SLOPE()<p/>
  36468. Calculates the SLOPE of the linear regression line that is used to predict y values from x values<br/>
  36469. (http://introcs.cs.princeton.edu/java/97data/LinearRegression.java.html)
  36470. <b>Syntax</b>:<br/>
  36471. <b>SLOPE</b>(<b>arrayX</b>, <b>arrayY</b>)<p/>
  36472. @author Johan Karlsteen
  36473. </member>
  36474. <member name="T:NPOI.SS.Formula.Functions.StatsLib">
  36475. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36476. Library for common statistics functions
  36477. </member>
  36478. <member name="M:NPOI.SS.Formula.Functions.StatsLib.avedev(System.Double[])">
  36479. returns the mean of deviations from mean.
  36480. @param v
  36481. </member>
  36482. <member name="M:NPOI.SS.Formula.Functions.StatsLib.mode(System.Double[])">
  36483. if v Is zero Length or Contains no duplicates, return value
  36484. Is double.NaN. Else returns the value that occurs most times
  36485. and if there Is a tie, returns the first such value.
  36486. @param v
  36487. </member>
  36488. <member name="T:NPOI.SS.Formula.Functions.Subtotal">
  36489. Implementation for the Excel function SUBTOTAL<p>
  36490. <b>Syntax :</b> <br/>
  36491. SUBTOTAL ( <b>functionCode</b>, <b>ref1</b>, ref2 ... ) <br/>
  36492. <table border="1" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
  36493. <tr><td><b>functionCode</b></td><td>(1-11) Selects the underlying aggregate function to be used (see table below)</td></tr>
  36494. <tr><td><b>ref1</b>, ref2 ...</td><td>Arguments to be passed to the underlying aggregate function</td></tr>
  36495. </table><br/>
  36496. </p>
  36497. <table border="1" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
  36498. <tr><th>functionCode</th><th>Aggregate Function</th></tr>
  36499. <tr align='center'><td>1</td><td>AVERAGE</td></tr>
  36500. <tr align='center'><td>2</td><td>COUNT</td></tr>
  36501. <tr align='center'><td>3</td><td>COUNTA</td></tr>
  36502. <tr align='center'><td>4</td><td>MAX</td></tr>
  36503. <tr align='center'><td>5</td><td>MIN</td></tr>
  36504. <tr align='center'><td>6</td><td>PRODUCT</td></tr>
  36505. <tr align='center'><td>7</td><td>STDEV</td></tr>
  36506. <tr align='center'><td>8</td><td>STDEVP *</td></tr>
  36507. <tr align='center'><td>9</td><td>SUM</td></tr>
  36508. <tr align='center'><td>10</td><td>VAR *</td></tr>
  36509. <tr align='center'><td>11</td><td>VARP *</td></tr>
  36510. <tr align='center'><td>101-111</td><td>*</td></tr>
  36511. </table><br/>
  36512. * Not implemented in POI yet. Functions 101-111 are the same as functions 1-11 but with
  36513. the option 'ignore hidden values'.
  36514. <p/>
  36515. @author Paul Tomlin &lt; pault at bulk sms dot com &gt;
  36516. </member>
  36517. <member name="T:NPOI.SS.Formula.Functions.Sumif">
  36518. Implementation for the Excel function SUMIF<p>
  36519. Syntax : <br/>
  36520. SUMIF ( <b>range</b>, <b>criteria</b>, sum_range ) <br/>
  36521. <table border="0" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
  36522. <tr><th>range</th><td>The range over which criteria is applied. Also used for addend values when the third parameter is not present</td></tr>
  36523. <tr><th>criteria</th><td>The value or expression used to filter rows from <b>range</b></td></tr>
  36524. <tr><th>sum_range</th><td>Locates the top-left corner of the corresponding range of addends - values to be added (after being selected by the criteria)</td></tr>
  36525. </table><br/>
  36526. </p>
  36527. @author Josh Micich
  36528. </member>
  36529. <member name="M:NPOI.SS.Formula.Functions.Sumif.CreateSumRange(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Eval.AreaEval)">
  36530. @return a range of the same dimensions as aeRange using eval to define the top left corner.
  36531. @throws EvaluationException if eval is not a reference
  36532. </member>
  36533. <member name="T:NPOI.SS.Formula.Functions.Sumifs">
  36534. Implementation for the Excel function SUMIFS<br/>
  36535. <p>
  36536. Syntax : <br/>
  36537. SUMIFS ( <b>sum_range</b>, <b>criteria_range1</b>, <b>criteria1</b>,
  36538. [<b>criteria_range2</b>, <b>criteria2</b>], ...) <br/>
  36539. <ul>
  36540. <li><b>sum_range</b> Required. One or more cells to sum, including numbers or names, ranges,
  36541. or cell references that contain numbers. Blank and text values are ignored.</li>
  36542. <li><b>criteria1_range</b> Required. The first range in which
  36543. to evaluate the associated criteria.</li>
  36544. <li><b>criteria1</b> Required. The criteria in the form of a number, expression,
  36545. cell reference, or text that define which cells in the criteria_range1
  36546. argument will be added</li>
  36547. <li><b> criteria_range2, criteria2, ...</b> Optional. Additional ranges and their associated criteria.
  36548. Up to 127 range/criteria pairs are allowed.</li>
  36549. </ul>
  36550. </p>
  36551. @author Yegor Kozlov
  36552. </member>
  36553. <member name="M:NPOI.SS.Formula.Functions.Sumifs.ValidateCriteria(NPOI.SS.Formula.Functions.IMatchPredicate[])">
  36554. Verify that each <code>criteria</code> predicate is valid, i.e. not an error
  36555. @throws EvaluationException if there are criteria which resulted in Errors.
  36556. </member>
  36557. <member name="M:NPOI.SS.Formula.Functions.Sumifs.ValidateCriteriaRanges(NPOI.SS.Formula.Eval.AreaEval[],NPOI.SS.Formula.Eval.AreaEval)">
  36558. Verify that each <code>criteriaRanges</code> argument contains the same number of rows and columns
  36559. as the <code>sumRange</code> argument
  36560. @throws EvaluationException if
  36561. </member>
  36562. <member name="M:NPOI.SS.Formula.Functions.Sumifs.CalcMatchingCells(NPOI.SS.Formula.Eval.AreaEval[],NPOI.SS.Formula.Functions.IMatchPredicate[],NPOI.SS.Formula.Eval.AreaEval,System.Double,System.Func{System.Double,System.Nullable{System.Double},System.Double})">
  36563. @param ranges criteria ranges, each range must be of the same dimensions as <code>aeSum</code>
  36564. @param predicates array of predicates, a predicate for each value in <code>ranges</code>
  36565. @param aeSum the range to sum
  36566. @return the computed value
  36567. </member>
  36568. <member name="M:NPOI.SS.Formula.Functions.Sumifs.ReadValue(NPOI.SS.Formula.Eval.AreaEval,System.Int32,System.Int32)">
  36569. Reads the numeric values from the row/col of the specified area - other values return the indicated missing value.
  36570. </member>
  36571. <member name="M:NPOI.SS.Formula.Functions.Sumproduct.GetProductTerm(NPOI.SS.Formula.Eval.ValueEval,System.Boolean)">
  36572. Determines a <c>double</c> value for the specified <c>ValueEval</c>.
  36573. @param IsScalarProduct <c>false</c> for SUMPRODUCTs over area refs.
  36574. @throws EvalEx if <c>ve</c> represents an error value.
  36575. <p/>
  36576. Note - string values and empty cells are interpreted differently depending on
  36577. <c>isScalarProduct</c>. For scalar products, if any term Is blank or a string, the
  36578. error (#VALUE!) Is raised. For area (sum)products, if any term Is blank or a string, the
  36579. result Is zero.
  36580. </member>
  36581. <member name="T:NPOI.SS.Formula.Functions.Concatenate">
  36582. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36583. </member>
  36584. <member name="T:NPOI.SS.Formula.Functions.Exact">
  36585. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36586. </member>
  36587. <member name="T:NPOI.SS.Formula.Functions.LeftRight">
  36588. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36589. </member>
  36590. <member name="T:NPOI.SS.Formula.Functions.Len">
  36591. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36592. </member>
  36593. <member name="T:NPOI.SS.Formula.Functions.Lower">
  36594. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36595. </member>
  36596. <member name="T:NPOI.SS.Formula.Functions.Mid">
  36597. <summary>
  36598. An implementation of the MID function
  36599. MID returns a specific number of
  36600. Chars from a text string, starting at the specified position.
  36601. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org;
  36602. </summary>
  36603. </member>
  36604. <member name="T:NPOI.SS.Formula.Functions.Proper">
  36605. <summary>
  36606. Implementation of the PROPER function:
  36607. Normalizes all words (separated by non-word characters) by
  36608. making the first letter upper and the rest lower case.
  36609. </summary>
  36610. </member>
  36611. <member name="T:NPOI.SS.Formula.Functions.Replace">
  36612. An implementation of the Replace function:
  36613. Replaces part of a text string based on the number of Chars
  36614. you specify, with another text string.
  36615. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org &gt;
  36616. </member>
  36617. <member name="M:NPOI.SS.Formula.Functions.Replace.EvaluateFunc(NPOI.SS.Formula.Eval.ValueEval[],System.Int32,System.Int32)">
  36618. Replaces part of a text string based on the number of Chars
  36619. you specify, with another text string.
  36620. @see org.apache.poi.hssf.record.formula.eval.Eval
  36621. </member>
  36622. <member name="T:NPOI.SS.Formula.Functions.Substitute">
  36623. An implementation of the SUBSTITUTE function:
  36624. Substitutes text in a text string with new text, some number of times.
  36625. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org &gt;
  36626. </member>
  36627. <member name="M:NPOI.SS.Formula.Functions.Substitute.EvaluateFunc(NPOI.SS.Formula.Eval.ValueEval[],System.Int32,System.Int32)">
  36628. Substitutes text in a text string with new text, some number of times.
  36629. @see org.apache.poi.hssf.record.formula.eval.Eval
  36630. </member>
  36631. <member name="T:NPOI.SS.Formula.Functions.Text">
  36632. An implementation of the TEXT function
  36633. TEXT returns a number value formatted with the given number formatting string.
  36634. This function is not a complete implementation of the Excel function, but
  36635. handles most of the common cases. All work is passed down to
  36636. {@link DataFormatter} to be done, as this works much the same as the
  36637. display focused work that that does.
  36638. </member>
  36639. <member name="T:NPOI.SS.Formula.Functions.TextFunction">
  36640. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36641. </member>
  36642. <member name="F:NPOI.SS.Formula.Functions.TextFunction.TRIM">
  36643. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org &gt;
  36644. <summary>
  36645. An implementation of the TRIM function:
  36646. <para>
  36647. Removes leading and trailing spaces from value if evaluated operand value is string.
  36648. </para>
  36649. </summary>
  36650. </member>
  36651. <member name="F:NPOI.SS.Formula.Functions.TextFunction.MID">
  36652. <summary>
  36653. An implementation of the MID function
  36654. MID returns a specific number of
  36655. characters from a text string, starting at the specified position.
  36656. Syntax: MID(text, start_num, num_chars)
  36657. </summary>
  36658. </member>
  36659. <member name="F:NPOI.SS.Formula.Functions.TextFunction.FIND">
  36660. @author Torstein Tauno Svendsen (torstei@officenet.no)
  36661. <summary>
  36662. Implementation of the FIND() function.
  36663. <para>
  36664. Syntax: FIND(Find_text, within_text, start_num)
  36665. </para>
  36666. <para> FIND returns the character position of the first (case sensitive) occurrence of
  36667. Find_text inside within_text. The third parameter,
  36668. start_num, is optional (default=1) and specifies where to start searching
  36669. from. Character positions are 1-based.</para>
  36670. </summary>
  36671. </member>
  36672. <member name="F:NPOI.SS.Formula.Functions.TextFunction.SEARCH">
  36673. <summary>
  36674. Implementation of the FIND() function. SEARCH is a case-insensitive version of FIND()
  36675. <para>
  36676. Syntax: SEARCH(Find_text, within_text, start_num)
  36677. </para>
  36678. </summary>
  36679. </member>
  36680. <member name="T:NPOI.SS.Formula.Functions.Trim">
  36681. An implementation of the TRIM function:
  36682. Removes leading and trailing spaces from value if Evaluated operand
  36683. value Is string.
  36684. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org &gt;
  36685. </member>
  36686. <member name="T:NPOI.SS.Formula.Functions.Upper">
  36687. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36688. </member>
  36689. <member name="T:NPOI.SS.Formula.Functions.TimeFunc">
  36690. Implementation for the Excel function TIME
  36691. @author Steven Butler (sebutler @ gmail dot com)
  36692. Based on POI {@link DateFunc}
  36693. </member>
  36694. <member name="M:NPOI.SS.Formula.Functions.TimeFunc.Evaluate(System.Int32,System.Int32,System.Int32)">
  36695. Converts the supplied hours, minutes and seconds to an Excel time value.
  36696. @param ds array of 3 doubles Containing hours, minutes and seconds.
  36697. Non-integer inputs are tRuncated to an integer before further calculation
  36698. of the time value.
  36699. @return An Excel representation of a time of day.
  36700. If the time value represents more than a day, the days are Removed from
  36701. the result, leaving only the time of day component.
  36702. @throws NPOI.SS.Formula.Eval.EvaluationException
  36703. If any of the arguments are greater than 32767 or the hours
  36704. minutes and seconds when combined form a time value less than 0, the function
  36705. Evaluates to an error.
  36706. </member>
  36707. <member name="F:NPOI.SS.Formula.Functions.Value.MIN_DISTANCE_BETWEEN_THOUSANDS_SEPARATOR">
  36708. "1,0000" is valid, "1,00" is not
  36709. </member>
  36710. <member name="M:NPOI.SS.Formula.Functions.Value.ConvertTextToNumber(System.String)">
  36711. TODO see if the same functionality is needed in {@link OperandResolver#parseDouble(String)}
  36712. @return <code>null</code> if there is any problem converting the text
  36713. </member>
  36714. <member name="T:NPOI.SS.Formula.Functions.Var1or2ArgFunction">
  36715. Convenience base class for any function which must take two or three
  36716. arguments
  36717. @author Josh Micich
  36718. </member>
  36719. <member name="T:NPOI.SS.Formula.Functions.Var2or3ArgFunction">
  36720. Convenience base class for any function which must take two or three
  36721. arguments
  36722. @author Josh Micich
  36723. </member>
  36724. <member name="T:NPOI.SS.Formula.Functions.Var3or4ArgFunction">
  36725. Convenience base class for any function which must take three or four
  36726. arguments
  36727. @author Josh Micich
  36728. </member>
  36729. <member name="T:NPOI.SS.Formula.Functions.Vlookup">
  36730. Implementation of the VLOOKUP() function.<p/>
  36731. VLOOKUP Finds a row in a lookup table by the first column value and returns the value from another column.<br/>
  36732. <b>Syntax</b>:<br/>
  36733. <b>VLOOKUP</b>(<b>lookup_value</b>, <b>table_array</b>, <b>col_index_num</b>, range_lookup)<p/>
  36734. <b>lookup_value</b> The value to be found in the first column of the table array.<br/>
  36735. <b>table_array</b> An area reference for the lookup data. <br/>
  36736. <b>col_index_num</b> a 1 based index specifying which column value of the lookup data will be returned.<br/>
  36737. <b>range_lookup</b> If TRUE (default), VLOOKUP Finds the largest value less than or equal to
  36738. the lookup_value. If FALSE, only exact Matches will be considered<br/>
  36739. @author Josh Micich
  36740. </member>
  36741. <member name="M:NPOI.SS.Formula.Functions.Vlookup.CreateResultColumnVector(NPOI.SS.Formula.TwoDEval,System.Int32)">
  36742. Returns one column from an <c>AreaEval</c>
  36743. @(#VALUE!) if colIndex Is negative, (#REF!) if colIndex Is too high
  36744. </member>
  36745. <member name="T:NPOI.SS.Formula.Functions.WeekdayFunc">
  36746. Implementation for the Excel function WEEKDAY
  36747. @author Thies Wellpott
  36748. </member>
  36749. <member name="M:NPOI.SS.Formula.Functions.WeekdayFunc.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],System.Int32,System.Int32)">
  36750. * Perform WEEKDAY(date, returnOption) function.
  36751. * Note: Parameter texts are from German EXCEL-2010 help.
  36752. * Parameters in args[]:
  36753. * args[0] serialDate
  36754. * EXCEL-date value
  36755. * Standardmaessig ist der 1. Januar 1900 die fortlaufende Zahl 1 und
  36756. * der 1. Januar 2008 die fortlaufende Zahl 39.448, da dieser Tag nach 39.448 Tagen
  36757. * auf den 01.01.1900 folgt.
  36758. * @return Option (optional)
  36759. * Bestimmt den Rueckgabewert:
  36760. 1 oder nicht angegeben Zahl 1 (Sonntag) bis 7 (Samstag). Verhaelt sich wie fruehere Microsoft Excel-Versionen.
  36761. 2 Zahl 1 (Montag) bis 7 (Sonntag).
  36762. 3 Zahl 0 (Montag) bis 6 (Sonntag).
  36763. 11 Die Zahlen 1 (Montag) bis 7 (Sonntag)
  36764. 12 Die Zahlen 1 (Dienstag) bis 7 (Montag)
  36765. 13 Die Zahlen 1 (Mittwoch) bis 7 (Dienstag)
  36766. 14 Die Zahlen 1 (Donnerstag) bis 7 (Mittwoch)
  36767. 15 Die Zahlen 1 (Freitag) bis 7 (Donnerstag)
  36768. 16 Die Zahlen 1 (Samstag) bis 7 (Freitag)
  36769. 17 Die Zahlen 1 (Sonntag) bis 7 (Samstag)
  36770. </member>
  36771. <member name="T:NPOI.SS.Formula.Functions.WeekNum">
  36772. Implementation for Excel WeekNum() function.<p/>
  36773. <p/>
  36774. <b>Syntax</b>:<br/> <b>WeekNum </b>(<b>Serial_num</b>,<b>Return_type</b>)<br/>
  36775. <p/>
  36776. Returns a number that indicates where the week falls numerically within a year.
  36777. <p/>
  36778. <p/>
  36779. Serial_num is a date within the week. Dates should be entered by using the DATE function,
  36780. or as results of other formulas or functions. For example, use DATE(2008,5,23)
  36781. for the 23rd day of May, 2008. Problems can occur if dates are entered as text.
  36782. Return_type is a number that determines on which day the week begins. The default is 1.
  36783. 1 Week begins on Sunday. Weekdays are numbered 1 through 7.
  36784. 2 Week begins on Monday. Weekdays are numbered 1 through 7.
  36785. @author cedric dot walter @ gmail dot com
  36786. </member>
  36787. <member name="T:NPOI.SS.Formula.Functions.XYNumericFunction">
  36788. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  36789. </member>
  36790. <member name="M:NPOI.SS.Formula.Functions.XYNumericFunction.CreateAccumulator">
  36791. Constructs a new instance of the Accumulator used to calculated this function
  36792. </member>
  36793. <member name="T:NPOI.SS.Formula.Function.FunctionDataBuilder">
  36794. Temporarily collects <c>FunctionMetadata</c> instances for creation of a
  36795. <c>FunctionMetadataRegistry</c>.
  36796. @author Josh Micich
  36797. </member>
  36798. <member name="F:NPOI.SS.Formula.Function.FunctionDataBuilder._mutatingFunctionIndexes">
  36799. stores indexes of all functions with footnotes (i.e. whose definitions might Change)
  36800. </member>
  36801. <member name="T:NPOI.SS.Formula.Function.FunctionMetadata">
  36802. Holds information about Excel built-in functions.
  36803. @author Josh Micich
  36804. </member>
  36805. <member name="T:NPOI.SS.Formula.Function.FunctionMetadataReader">
  36806. Converts the text meta-data file into a <c>FunctionMetadataRegistry</c>
  36807. @author Josh Micich
  36808. </member>
  36809. <member name="F:NPOI.SS.Formula.Function.FunctionMetadataReader.ELLIPSIS">
  36810. plain ASCII text metadata file uses three dots for ellipsis
  36811. </member>
  36812. <member name="M:NPOI.SS.Formula.Function.FunctionMetadataReader.ValidateFunctionName(System.String)">
  36813. Makes sure that footnote digits from the original OOO document have not been accidentally
  36814. left behind
  36815. </member>
  36816. <member name="T:NPOI.SS.Formula.Function.FunctionMetadataRegistry">
  36817. Allows clients to Get <c>FunctionMetadata</c> instances for any built-in function of Excel.
  36818. @author Josh Micich
  36819. </member>
  36820. <member name="F:NPOI.SS.Formula.Function.FunctionMetadataRegistry.FUNCTION_NAME_IF">
  36821. The name of the IF function (i.e. "IF"). Extracted as a constant for clarity.
  36822. </member>
  36823. <member name="M:NPOI.SS.Formula.Function.FunctionMetadataRegistry.LookupIndexByName(System.String)">
  36824. Resolves a built-in function index.
  36825. @param name uppercase function name
  36826. @return a negative value if the function name is not found.
  36827. This typically occurs for external functions.
  36828. </member>
  36829. <member name="T:NPOI.SS.Formula.ICacheEntry">
  36830. A (mostly) opaque interface To allow test clients To trace cache values
  36831. Each spreadsheet cell Gets one unique cache entry instance. These objects
  36832. are safe To use as keys in {@link java.util.HashMap}s
  36833. </member>
  36834. <member name="T:NPOI.SS.Formula.IEvaluationListener">
  36835. Tests can implement this class To track the internal working of the {@link WorkbookEvaluator}.<br/>
  36836. For POI internal testing use only
  36837. @author Josh Micich
  36838. </member>
  36839. <member name="M:NPOI.SS.Formula.IEvaluationListener.SortDependentCachedValues(NPOI.SS.Formula.ICacheEntry[])">
  36840. Internally, formula {@link ICacheEntry}s are stored in Sets which may Change ordering due
  36841. To seemingly trivial Changes. This method is provided To make the order of call-backs To
  36842. {@link #onClearDependentCachedValue(ICacheEntry, int)} more deterministic.
  36843. </member>
  36844. <member name="T:NPOI.SS.Formula.IStabilityClassifier">
  36845. Used to help optimise cell evaluation result caching by allowing applications to specify which
  36846. parts of a workbook are <em>final</em>.<br/>
  36847. The term <b>final</b> is introduced here to denote immutability or 'having constant definition'.
  36848. This classification refers to potential actions (on the evaluated workbook) by the evaluating
  36849. application. It does not refer to operations performed by the evaluator ({@link
  36850. WorkbookEvaluator}).<br/>
  36851. <br/>
  36852. <b>General guidelines</b>:
  36853. <ul>
  36854. <li>a plain value cell can be marked as 'final' if it will not be changed after the first call
  36855. to {@link WorkbookEvaluator#evaluate(EvaluationCell)}.
  36856. </li>
  36857. <li>a formula cell can be marked as 'final' if its formula will not be changed after the first
  36858. call to {@link WorkbookEvaluator#evaluate(EvaluationCell)}. This remains true even if changes
  36859. in dependent values may cause the evaluated value to change.</li>
  36860. <li>plain value cells should be marked as 'not final' if their plain value value may change.
  36861. </li>
  36862. <li>formula cells should be marked as 'not final' if their formula definition may change.</li>
  36863. <li>cells which may switch between plain value and formula should also be marked as 'not final'.
  36864. </li>
  36865. </ul>
  36866. <b>Notes</b>:
  36867. <ul>
  36868. <li>If none of the spreadsheet cells is expected to have its definition changed after evaluation
  36869. begins, every cell can be marked as 'final'. This is the most efficient / least resource
  36870. intensive option.</li>
  36871. <li>To retain freedom to change any cell definition at any time, an application may classify all
  36872. cells as 'not final'. This freedom comes at the expense of greater memory consumption.</li>
  36873. <li>For the purpose of these classifications, setting the cached formula result of a cell (for
  36874. example in {@link HSSFFormulaEvaluator#evaluateFormulaCell(org.apache.poi.ss.usermodel.Cell)})
  36875. does not constitute changing the definition of the cell.</li>
  36876. <li>Updating cells which have been classified as 'final' will cause the evaluator to behave
  36877. unpredictably (typically ignoring the update).</li>
  36878. </ul>
  36879. @author Josh Micich
  36880. </member>
  36881. <member name="F:NPOI.SS.Formula.IStabilityClassifier.TOTALLY_IMMUTABLE">
  36882. Convenience implementation for situations where all cell definitions remain fixed after
  36883. evaluation begins.
  36884. </member>
  36885. <member name="M:NPOI.SS.Formula.IStabilityClassifier.IsCellFinal(System.Int32,System.Int32,System.Int32)">
  36886. Checks if a cell's value(/formula) is fixed - in other words - not expected to be modified
  36887. between calls to the evaluator. (Note - this is an independent concept from whether a
  36888. formula cell's evaluated value may change during successive calls to the evaluator).
  36889. @param sheetIndex zero based index into workbook sheet list
  36890. @param rowIndex zero based row index of cell
  36891. @param columnIndex zero based column index of cell
  36892. @return <c>false</c> if the evaluating application may need to modify the specified
  36893. cell between calls to the evaluator.
  36894. </member>
  36895. <member name="T:NPOI.SS.Formula.LazyAreaEval">
  36896. Provides Lazy Evaluation to 3D Ranges
  36897. </member>
  36898. <member name="M:NPOI.SS.Formula.LazyAreaEval.IsSubTotal(System.Int32,System.Int32)">
  36899. @return whether cell at rowIndex and columnIndex is a subtotal
  36900. </member>
  36901. <member name="T:NPOI.SS.Formula.LazyRefEval">
  36902. Provides Lazy Evaluation to a 3D Reference
  36903. TODO Provide access to multiple sheets where present
  36904. </member>
  36905. <member name="T:NPOI.SS.Formula.OperandClassTransformer">
  36906. This class performs 'operand class' transformation. Non-base Tokens are classified into three
  36907. operand classes:
  36908. <ul>
  36909. <li>reference</li>
  36910. <li>value</li>
  36911. <li>array</li>
  36912. </ul>
  36913. <p/>
  36914. The operand class chosen for each Token depends on the formula type and the Token's place
  36915. in the formula. If POI Gets the operand class wrong, Excel <em>may</em> interpret the formula
  36916. incorrectly. This condition is typically manifested as a formula cell that displays as '#VALUE!',
  36917. but resolves correctly when the user presses F2, enter.<p/>
  36918. The logic implemented here was partially inspired by the description in
  36919. "OpenOffice.org's Documentation of the Microsoft Excel File Format". The model presented there
  36920. seems To be inconsistent with observed Excel behaviour (These differences have not been fully
  36921. investigated). The implementation in this class Has been heavily modified in order To satisfy
  36922. concrete examples of how Excel performs the same logic (see TestRVA).<p/>
  36923. Hopefully, as Additional important test cases are identified and Added To the test suite,
  36924. patterns might become more obvious in this code and allow for simplification.
  36925. @author Josh Micich
  36926. </member>
  36927. <member name="M:NPOI.SS.Formula.OperandClassTransformer.TransformFormula(NPOI.SS.Formula.ParseNode)">
  36928. Traverses the supplied formula parse tree, calling <c>Ptg.SetClass()</c> for each non-base
  36929. Token To Set its operand class.
  36930. </member>
  36931. <member name="M:NPOI.SS.Formula.OperandClassTransformer.TransformNode(NPOI.SS.Formula.ParseNode,System.Byte,System.Boolean)">
  36932. @param callerForceArrayFlag <c>true</c> if one of the current node's parents is a
  36933. function Ptg which Has been Changed from default 'V' To 'A' type (due To requirements on
  36934. the function return value).
  36935. </member>
  36936. <member name="T:NPOI.SS.Formula.OperationEvaluationContext">
  36937. Contains all the contextual information required to Evaluate an operation
  36938. within a formula
  36939. For POI internal use only
  36940. @author Josh Micich
  36941. </member>
  36942. <member name="M:NPOI.SS.Formula.OperationEvaluationContext.CreateExternSheetRefEvaluator(System.String,System.String)">
  36943. @return <code>null</code> if either workbook or sheet is not found
  36944. </member>
  36945. <member name="M:NPOI.SS.Formula.OperationEvaluationContext.GetDynamicReference(System.String,System.String,System.String,System.String,System.Boolean)">
  36946. Resolves a cell or area reference dynamically.
  36947. @param workbookName the name of the workbook Containing the reference. If <code>null</code>
  36948. the current workbook is assumed. Note - to Evaluate formulas which use multiple workbooks,
  36949. a {@link CollaboratingWorkbooksEnvironment} must be set up.
  36950. @param sheetName the name of the sheet Containing the reference. May be <code>null</code>
  36951. (when <c>workbookName</c> is also null) in which case the current workbook and sheet is
  36952. assumed.
  36953. @param refStrPart1 the single cell reference or first part of the area reference. Must not
  36954. be <code>null</code>.
  36955. @param refStrPart2 the second part of the area reference. For single cell references this
  36956. parameter must be <code>null</code>
  36957. @param isA1Style specifies the format for <c>refStrPart1</c> and <c>refStrPart2</c>.
  36958. Pass <c>true</c> for 'A1' style and <c>false</c> for 'R1C1' style.
  36959. TODO - currently POI only supports 'A1' reference style
  36960. @return a {@link RefEval} or {@link AreaEval}
  36961. </member>
  36962. <member name="T:NPOI.SS.Formula.OperationEvaluatorFactory">
  36963. This class Creates <c>OperationEval</c> instances To help evaluate <c>OperationPtg</c>
  36964. formula Tokens.
  36965. @author Josh Micich
  36966. </member>
  36967. <member name="M:NPOI.SS.Formula.OperationEvaluatorFactory.Evaluate(NPOI.SS.Formula.PTG.OperationPtg,NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  36968. returns the OperationEval concrete impl instance corresponding
  36969. to the supplied operationPtg
  36970. </member>
  36971. <member name="T:NPOI.SS.Formula.ParseNode">
  36972. Represents a syntactic element from a formula by encapsulating the corresponding <c>Ptg</c>
  36973. Token. Each <c>ParseNode</c> may have child <c>ParseNode</c>s in the case when the wrapped
  36974. <c>Ptg</c> is non-atomic.
  36975. </member>
  36976. <member name="M:NPOI.SS.Formula.ParseNode.ToTokenArray(NPOI.SS.Formula.ParseNode)">
  36977. Collects the array of <c>Ptg</c> Tokens for the specified tree.
  36978. </member>
  36979. <member name="M:NPOI.SS.Formula.ParseNode.CollectIfPtgs(NPOI.SS.Formula.ParseNode.TokenCollector)">
  36980. The IF() function Gets marked up with two or three tAttr Tokens.
  36981. Similar logic will be required for CHOOSE() when it is supported
  36982. See excelfileformat.pdf sec 3.10.5 "tAttr (19H)
  36983. </member>
  36984. <member name="T:NPOI.SS.Formula.PlainCellCache">
  36985. @author Josh Micich
  36986. </member>
  36987. <member name="T:NPOI.SS.Formula.PlainValueCellCacheEntry">
  36988. Used for non-formula cells, primarily To keep track of the referencing (formula) cells.
  36989. @author Josh Micich
  36990. </member>
  36991. <member name="T:NPOI.SS.Formula.PTG.AbstractFunctionPtg">
  36992. This class provides the base functionality for Excel sheet functions
  36993. There are two kinds of function Ptgs - tFunc and tFuncVar
  36994. Therefore, this class will have ONLY two subclasses
  36995. @author Avik Sengupta
  36996. @author Andrew C. Oliver (acoliver at apache dot org)
  36997. </member>
  36998. <member name="F:NPOI.SS.Formula.PTG.AbstractFunctionPtg.FUNCTION_NAME_IF">
  36999. The name of the IF function (i.e. "IF"). Extracted as a constant for clarity.
  37000. </member>
  37001. <member name="F:NPOI.SS.Formula.PTG.AbstractFunctionPtg.FUNCTION_INDEX_EXTERNAL">
  37002. All external functions have function index 255
  37003. </member>
  37004. <member name="P:NPOI.SS.Formula.PTG.AbstractFunctionPtg.IsExternalFunction">
  37005. external functions Get some special Processing
  37006. @return <c>true</c> if this is an external function
  37007. </member>
  37008. <member name="M:NPOI.SS.Formula.PTG.AbstractFunctionPtg.IsBuiltInFunctionName(System.String)">
  37009. Used to detect whether a function name found in a formula is one of the standard excel functions
  37010. The name matching is case insensitive.
  37011. @return <c>true</c> if the name specifies a standard worksheet function,
  37012. <c>false</c> if the name should be assumed to be an external function.
  37013. </member>
  37014. <member name="M:NPOI.SS.Formula.PTG.AbstractFunctionPtg.LookupIndex(System.String)">
  37015. Resolves internal function names into function indexes.
  37016. The name matching is case insensitive.
  37017. @return the standard worksheet function index if found, otherwise <c>FUNCTION_INDEX_EXTERNAL</c>
  37018. </member>
  37019. <member name="T:NPOI.SS.Formula.PTG.AddPtg">
  37020. Addition operator PTG the "+" binomial operator. If you need more
  37021. explanation than that then well...We really can't help you here.
  37022. @author Andrew C. Oliver (acoliver@apache.org)
  37023. @author Jason Height (jheight at chariot dot net dot au)
  37024. </member>
  37025. <member name="M:NPOI.SS.Formula.PTG.AddPtg.ToFormulaString(System.String[])">
  37026. implementation of method from OperationsPtg
  37027. </member>
  37028. <member name="T:NPOI.SS.Formula.PTG.Area2DPtgBase">
  37029. Common superclass of 2-D area refs
  37030. </member>
  37031. <member name="T:NPOI.SS.Formula.PTG.Area3DPtg">
  37032. <p>Title: Area 3D Ptg - 3D reference (Sheet + Area)</p>
  37033. <p>Description: Defined an area in Extern Sheet. </p>
  37034. <p>REFERENCE: </p>
  37035. This is HSSF only, as it matches the HSSF file format way of
  37036. referring to the sheet by an extern index. The XSSF equivalent
  37037. is {@link Area3DPxg}
  37038. </member>
  37039. <member name="M:NPOI.SS.Formula.PTG.Area3DPtg.ToFormulaString(NPOI.SS.Formula.IFormulaRenderingWorkbook)">
  37040. @return text representation of this area reference that can be used in text
  37041. formulas. The sheet name will get properly delimited if required.
  37042. </member>
  37043. <member name="T:NPOI.SS.Formula.PTG.Area3DPxg">
  37044. <p>Title: XSSF Area 3D Reference (Sheet + Area)</p>
  37045. <p>Description: Defined an area in an external or different sheet. </p>
  37046. <p>REFERENCE: </p>
  37047. <p>This is XSSF only, as it stores the sheet / book references
  37048. in String form. The HSSF equivalent using indexes is {@link Area3DPtg}</p>
  37049. </member>
  37050. <member name="T:NPOI.SS.Formula.PTG.AreaErrPtg">
  37051. AreaErr - handles deleted cell area references.
  37052. @author Daniel Noll (daniel at nuix dot com dot au)
  37053. </member>
  37054. <member name="T:NPOI.SS.Formula.PTG.AreaI">
  37055. Common interface for AreaPtg and Area3DPtg, and their
  37056. child classes.
  37057. </member>
  37058. <member name="P:NPOI.SS.Formula.PTG.AreaI.FirstRow">
  37059. @return the first row in the area
  37060. </member>
  37061. <member name="P:NPOI.SS.Formula.PTG.AreaI.LastRow">
  37062. @return last row in the range (x2 in x1,y1-x2,y2)
  37063. </member>
  37064. <member name="P:NPOI.SS.Formula.PTG.AreaI.FirstColumn">
  37065. @return the first column number in the area.
  37066. </member>
  37067. <member name="P:NPOI.SS.Formula.PTG.AreaI.LastColumn">
  37068. @return lastcolumn in the area
  37069. </member>
  37070. <member name="T:NPOI.SS.Formula.PTG.AreaNPtg">
  37071. Specifies a rectangular area of cells A1:A4 for instance.
  37072. @author Jason Height (jheight at chariot dot net dot au)
  37073. </member>
  37074. <member name="T:NPOI.SS.Formula.PTG.AreaPtg">
  37075. Specifies a rectangular area of cells A1:A4 for instance.
  37076. @author Jason Height (jheight at chariot dot net dot au)
  37077. </member>
  37078. <member name="T:NPOI.SS.Formula.PTG.AreaPtgBase">
  37079. Specifies a rectangular area of cells A1:A4 for instance.
  37080. @author andy
  37081. @author Jason Height (jheight at chariot dot net dot au)
  37082. </member>
  37083. <member name="M:NPOI.SS.Formula.PTG.AreaPtgBase.NotImplemented">
  37084. TODO - (May-2008) fix subclasses of AreaPtg 'AreaN~' which are used in shared formulas.
  37085. see similar comment in ReferencePtg
  37086. </member>
  37087. <member name="F:NPOI.SS.Formula.PTG.AreaPtgBase.field_1_first_row">
  37088. zero based, Unsigned 16 bit
  37089. </member>
  37090. <member name="F:NPOI.SS.Formula.PTG.AreaPtgBase.field_2_last_row">
  37091. zero based, Unsigned 16 bit
  37092. </member>
  37093. <member name="F:NPOI.SS.Formula.PTG.AreaPtgBase.field_3_first_column">
  37094. zero based, Unsigned 8 bit
  37095. </member>
  37096. <member name="F:NPOI.SS.Formula.PTG.AreaPtgBase.field_4_last_column">
  37097. zero based, Unsigned 8 bit
  37098. </member>
  37099. <member name="M:NPOI.SS.Formula.PTG.AreaPtgBase.SortTopLeftToBottomRight">
  37100. Sort the first and last row and columns in-place to the preferred (top left:bottom right) order
  37101. Note: Sort only occurs when an instance is constructed or when this method is called.
  37102. <p>For example, <code>$E5:B$10</code> becomes <code>B5:$E$10</code></p>
  37103. </member>
  37104. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.FirstRow">
  37105. @return the first row in the area
  37106. </member>
  37107. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.LastRow">
  37108. @return last row in the range (x2 in x1,y1-x2,y2)
  37109. </member>
  37110. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.FirstColumn">
  37111. @return the first column number in the area.
  37112. </member>
  37113. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.IsFirstRowRelative">
  37114. @return whether or not the first row is a relative reference or not.
  37115. </member>
  37116. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.IsFirstColRelative">
  37117. @return Isrelative first column to relative or not
  37118. </member>
  37119. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.LastColumn">
  37120. @return lastcolumn in the area
  37121. </member>
  37122. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.LastColumnRaw">
  37123. @return last column and bitmask (the raw field)
  37124. </member>
  37125. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.IsLastRowRelative">
  37126. @return last row relative or not
  37127. </member>
  37128. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.IsLastColRelative">
  37129. @return lastcol relative or not
  37130. </member>
  37131. <member name="M:NPOI.SS.Formula.PTG.AreaPtgBase.SetLastColumnRaw(System.Int16)">
  37132. Set the last column irrespective of the bitmasks
  37133. </member>
  37134. <member name="T:NPOI.SS.Formula.PTG.ArrayPtg">
  37135. ArrayPtg - handles arrays
  37136. The ArrayPtg is a little weird, the size of the Ptg when parsing initially only
  37137. includes the Ptg sid and the reserved bytes. The next Ptg in the expression then follows.
  37138. It is only after the "size" of all the Ptgs is met, that the ArrayPtg data is actually
  37139. held after this. So Ptg.CreateParsedExpression keeps track of the number of
  37140. ArrayPtg elements and need to Parse the data upto the FORMULA record size.
  37141. @author Jason Height (jheight at chariot dot net dot au)
  37142. </member>
  37143. <member name="F:NPOI.SS.Formula.PTG.ArrayPtg.PLAIN_TOKEN_SIZE">
  37144. The size of the plain tArray token written within the standard formula tokens
  37145. (not including the data which comes after all formula tokens)
  37146. </member>
  37147. <member name="M:NPOI.SS.Formula.PTG.ArrayPtg.#ctor(System.Object[][])">
  37148. @param values2d array values arranged in rows
  37149. </member>
  37150. <member name="M:NPOI.SS.Formula.PTG.ArrayPtg.GetValueIndex(System.Int32,System.Int32)">
  37151. Note - (2D) array elements are stored column by column
  37152. @return the index into the internal 1D array for the specified column and row
  37153. </member>
  37154. <member name="P:NPOI.SS.Formula.PTG.ArrayPtg.Size">
  37155. This size includes the size of the array Ptg plus the Array Ptg Token value size
  37156. </member>
  37157. <member name="T:NPOI.SS.Formula.PTG.ArrayPtg.Initial">
  37158. Represents the initial plain tArray token (without the constant data that trails the whole
  37159. formula). Objects of this class are only temporary and cannot be used as {@link Ptg}s.
  37160. These temporary objects get converted to {@link ArrayPtg} by the
  37161. {@link #finishReading(LittleEndianInput)} method.
  37162. </member>
  37163. <member name="M:NPOI.SS.Formula.PTG.ArrayPtg.Initial.FinishReading(NPOI.Util.ILittleEndianInput)">
  37164. Read in the actual token (array) values. This occurs
  37165. AFTER the last Ptg in the expression.
  37166. See page 304-305 of Excel97-2007BinaryFileFormat(xls)Specification.pdf
  37167. </member>
  37168. <member name="T:NPOI.SS.Formula.PTG.AttrPtg">
  37169. "Special Attributes"
  37170. This seems to be a Misc Stuff and Junk record. One function it serves Is
  37171. in SUM functions (i.e. SUM(A1:A3) causes an area PTG then an ATTR with the SUM option Set)
  37172. @author andy
  37173. @author Jason Height (jheight at chariot dot net dot au)
  37174. </member>
  37175. <member name="F:NPOI.SS.Formula.PTG.AttrPtg._jumpTable">
  37176. only used for tAttrChoose: table of offsets to starts of args
  37177. </member>
  37178. <member name="F:NPOI.SS.Formula.PTG.AttrPtg._chooseFuncOffset">
  37179. only used for tAttrChoose: offset to the tFuncVar for CHOOSE()
  37180. </member>
  37181. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.SpaceBefore">
  37182. 00H = Spaces before the next token (not allowed before tParen token)
  37183. </member>
  37184. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.CrBefore">
  37185. 01H = Carriage returns before the next token (not allowed before tParen token)
  37186. </member>
  37187. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.SpaceBeforeOpenParen">
  37188. 02H = Spaces before opening parenthesis (only allowed before tParen token)
  37189. </member>
  37190. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.CrBeforeOpenParen">
  37191. 03H = Carriage returns before opening parenthesis (only allowed before tParen token)
  37192. </member>
  37193. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.SpaceBeforeCloseParen">
  37194. 04H = Spaces before closing parenthesis (only allowed before tParen, tFunc, and tFuncVar tokens)
  37195. </member>
  37196. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.CrBeforeCloseParen">
  37197. 05H = Carriage returns before closing parenthesis (only allowed before tParen, tFunc, and tFuncVar tokens)
  37198. </member>
  37199. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.SpaceAfterEquality">
  37200. 06H = Spaces following the equality sign (only in macro sheets)
  37201. </member>
  37202. <member name="M:NPOI.SS.Formula.PTG.AttrPtg.CreateSpace(NPOI.SS.Formula.PTG.AttrPtg.SpaceType,System.Int32)">
  37203. <summary>
  37204. Creates the space.
  37205. </summary>
  37206. <param name="type">a constant from SpaceType</param>
  37207. <param name="count">The count.</param>
  37208. </member>
  37209. <member name="M:NPOI.SS.Formula.PTG.AttrPtg.CreateIf(System.Int32)">
  37210. <summary>
  37211. Creates if.
  37212. </summary>
  37213. <param name="dist">distance (in bytes) to start of either
  37214. tFuncVar(IF) token (when false parameter is not present).</param>
  37215. </member>
  37216. <member name="M:NPOI.SS.Formula.PTG.AttrPtg.CreateSkip(System.Int32)">
  37217. <summary>
  37218. Creates the skip.
  37219. </summary>
  37220. <param name="dist">distance (in bytes) to position behind tFuncVar(IF) token (minus 1).</param>
  37221. </member>
  37222. <member name="T:NPOI.SS.Formula.PTG.BoolPtg">
  37223. bool (bool)
  37224. Stores a (java) bool value in a formula.
  37225. @author Paul Krause (pkrause at soundbite dot com)
  37226. @author Andrew C. Oliver (acoliver at apache dot org)
  37227. @author Jason Height (jheight at chariot dot net dot au)
  37228. </member>
  37229. <member name="T:NPOI.SS.Formula.PTG.ConcatPtg">
  37230. @author andy
  37231. @author Jason Height (jheight at chariot dot net dot au)
  37232. </member>
  37233. <member name="T:NPOI.SS.Formula.PTG.ControlPtg">
  37234. Common baseclass for
  37235. tExp
  37236. tTbl
  37237. tParen
  37238. tNlr
  37239. tAttr
  37240. tSheet
  37241. tEndSheet
  37242. </member>
  37243. <member name="T:NPOI.SS.Formula.PTG.Deleted3DPxg">
  37244. An XSSF only representation of a reference to a deleted area
  37245. </member>
  37246. <member name="T:NPOI.SS.Formula.PTG.DeletedArea3DPtg">
  37247. Title: Deleted Area 3D Ptg - 3D referecnce (Sheet + Area)
  37248. Description: Defined a area in Extern Sheet.
  37249. REFERENCE:
  37250. @author Patrick Luby
  37251. @version 1.0-pre
  37252. </member>
  37253. <member name="T:NPOI.SS.Formula.PTG.DeletedRef3DPtg">
  37254. Title: Deleted Reference 3D Ptg
  37255. Description: Defined a cell in extern sheet.
  37256. REFERENCE:
  37257. @author Patrick Luby
  37258. @version 1.0-pre
  37259. </member>
  37260. <member name="M:NPOI.SS.Formula.PTG.DeletedRef3DPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  37261. Creates new DeletedRef3DPtg
  37262. </member>
  37263. <member name="T:NPOI.SS.Formula.PTG.DividePtg">
  37264. This PTG implements the standard binomial divide "/"
  37265. @author Andrew C. Oliver acoliver at apache dot org
  37266. @author Jason Height (jheight at chariot dot net dot au)
  37267. </member>
  37268. <member name="T:NPOI.SS.Formula.PTG.EqualPtg">
  37269. @author andy
  37270. </member>
  37271. <member name="T:NPOI.SS.Formula.PTG.ErrPtg">
  37272. @author Daniel Noll (daniel at nuix dot com dot au)
  37273. </member>
  37274. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.NULL_INTERSECTION">
  37275. <b>#NULL!</b> - Intersection of two cell ranges is empty
  37276. </member>
  37277. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.DIV_ZERO">
  37278. <b>#DIV/0!</b> - Division by zero
  37279. </member>
  37280. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.VALUE_INVALID">
  37281. <b>#VALUE!</b> - Wrong type of operand
  37282. </member>
  37283. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.REF_INVALID">
  37284. <b>#REF!</b> - Illegal or deleted cell reference
  37285. </member>
  37286. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.NAME_INVALID">
  37287. <b>#NAME?</b> - Wrong function or range name
  37288. </member>
  37289. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.NUM_ERROR">
  37290. <b>#NUM!</b> - Value range overflow
  37291. </member>
  37292. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.N_A">
  37293. <b>#N/A</b> - Argument or function not available
  37294. </member>
  37295. <member name="M:NPOI.SS.Formula.PTG.ErrPtg.#ctor(System.Int32)">
  37296. Creates new ErrPtg
  37297. </member>
  37298. <member name="T:NPOI.SS.Formula.PTG.ExpPtg">
  37299. @author andy
  37300. @author Jason Height (jheight at chariot dot net dot au)
  37301. @author dmui (save existing implementation)
  37302. </member>
  37303. <member name="T:NPOI.SS.Formula.PTG.FuncPtg">
  37304. @author aviks
  37305. @author Jason Height (jheight at chariot dot net dot au)
  37306. @author Danny Mui (dmui at apache dot org) (Leftover handling)
  37307. </member>
  37308. <member name="T:NPOI.SS.Formula.PTG.FuncVarPtg">
  37309. @author Jason Height (jheight at chariot dot net dot au)
  37310. </member>
  37311. <member name="F:NPOI.SS.Formula.PTG.FuncVarPtg.SUM">
  37312. Single instance of this token for 'sum() taking a single argument'
  37313. </member>
  37314. <member name="M:NPOI.SS.Formula.PTG.FuncVarPtg.Create(NPOI.Util.ILittleEndianInput)">
  37315. Creates new function pointer from a byte array
  37316. usually called while reading an excel file.
  37317. </member>
  37318. <member name="M:NPOI.SS.Formula.PTG.FuncVarPtg.Create(System.String,System.Int32)">
  37319. Create a function ptg from a string tokenised by the parser
  37320. </member>
  37321. <member name="T:NPOI.SS.Formula.PTG.GreaterEqualPtg">
  37322. PTG class to implement greater or equal to
  37323. @author fred at stsci dot edu
  37324. </member>
  37325. <member name="T:NPOI.SS.Formula.PTG.GreaterThanPtg">
  37326. Greater than operator PTG ">"
  37327. @author Cameron Riley (criley at ekmail.com)
  37328. </member>
  37329. <member name="P:NPOI.SS.Formula.PTG.GreaterThanPtg.NumberOfOperands">
  37330. Get the number of operands for the Less than operator
  37331. @return int the number of operands
  37332. </member>
  37333. <member name="M:NPOI.SS.Formula.PTG.GreaterThanPtg.ToFormulaString(System.String[])">
  37334. Implementation of method from OperationsPtg
  37335. @param operands a String array of operands
  37336. @return String the Formula as a String
  37337. </member>
  37338. <member name="T:NPOI.SS.Formula.PTG.IntersectionPtg">
  37339. @author Daniel Noll (daniel at nuix dot com dot au)
  37340. </member>
  37341. <member name="M:NPOI.SS.Formula.PTG.IntersectionPtg.ToFormulaString">
  37342. Implementation of method from Ptg
  37343. </member>
  37344. <member name="M:NPOI.SS.Formula.PTG.IntersectionPtg.ToFormulaString(System.String[])">
  37345. implementation of method from OperationsPtg
  37346. </member>
  37347. <member name="T:NPOI.SS.Formula.PTG.IntPtg">
  37348. Integer (unsigned short integer)
  37349. Stores an Unsigned short value (java int) in a formula
  37350. @author Andrew C. Oliver (acoliver at apache dot org)
  37351. @author Jason Height (jheight at chariot dot net dot au)
  37352. </member>
  37353. <member name="M:NPOI.SS.Formula.PTG.IntPtg.IsInRange(System.Int32)">
  37354. Excel represents integers 0..65535 with the tInt token.
  37355. @return <c>true</c> if the specified value is within the range of values
  37356. <c>IntPtg</c> can represent.
  37357. </member>
  37358. <member name="T:NPOI.SS.Formula.PTG.LessEqualPtg">
  37359. Ptg class to implement less than or equal
  37360. @author fred at stsci dot edu
  37361. </member>
  37362. <member name="T:NPOI.SS.Formula.PTG.LessThanPtg">
  37363. Less than operator PTG "&lt;". The SID is taken from the
  37364. Openoffice.orgs Documentation of the Excel File Format,
  37365. Table 3.5.7
  37366. @author Cameron Riley (criley at ekmail.com)
  37367. </member>
  37368. <member name="F:NPOI.SS.Formula.PTG.LessThanPtg.sid">
  37369. the sid for the less than operator as hex
  37370. </member>
  37371. <member name="F:NPOI.SS.Formula.PTG.LessThanPtg.LESSTHAN">
  37372. identifier for LESS THAN char
  37373. </member>
  37374. <member name="P:NPOI.SS.Formula.PTG.LessThanPtg.NumberOfOperands">
  37375. Get the number of operands for the Less than operator
  37376. @return int the number of operands
  37377. </member>
  37378. <member name="M:NPOI.SS.Formula.PTG.LessThanPtg.ToFormulaString(System.String[])">
  37379. Implementation of method from OperationsPtg
  37380. @param operands a String array of operands
  37381. @return String the Formula as a String
  37382. </member>
  37383. <member name="T:NPOI.SS.Formula.PTG.MemAreaPtg">
  37384. @author Daniel Noll (daniel at nuix dot com dot au)
  37385. </member>
  37386. <member name="M:NPOI.SS.Formula.PTG.MemAreaPtg.#ctor(System.Int32)">
  37387. Creates new MemAreaPtg
  37388. </member>
  37389. <member name="T:NPOI.SS.Formula.PTG.MemErrPtg">
  37390. @author andy
  37391. @author Jason Height (jheight at chariot dot net dot au)
  37392. @author Daniel Noll (daniel at nuix dot com dot au)
  37393. </member>
  37394. <member name="M:NPOI.SS.Formula.PTG.MemErrPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  37395. Creates new MemErrPtg
  37396. </member>
  37397. <member name="T:NPOI.SS.Formula.PTG.MemFuncPtg">
  37398. @author Glen Stampoultzis (glens at apache.org)
  37399. </member>
  37400. <member name="M:NPOI.SS.Formula.PTG.MemFuncPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  37401. Creates new function pointer from a byte array
  37402. usually called while Reading an excel file.
  37403. </member>
  37404. <member name="T:NPOI.SS.Formula.PTG.MissingArgPtg">
  37405. Missing Function Arguments
  37406. Avik Sengupta &lt;avik at apache.org&gt;
  37407. @author Jason Height (jheight at chariot dot net dot au)
  37408. </member>
  37409. <member name="T:NPOI.SS.Formula.PTG.MultiplyPtg">
  37410. Implements the standard mathmatical multiplication - *
  37411. @author Andrew C. Oliver (acoliver at apache dot org)
  37412. @author Jason Height (jheight at chariot dot net dot au)
  37413. </member>
  37414. <member name="T:NPOI.SS.Formula.PTG.NamePtg">
  37415. @author andy
  37416. @author Jason Height (jheight at chariot dot net dot au)
  37417. </member>
  37418. <member name="F:NPOI.SS.Formula.PTG.NamePtg.field_1_label_index">
  37419. one-based index to defined name record
  37420. </member>
  37421. <member name="M:NPOI.SS.Formula.PTG.NamePtg.#ctor(System.Int32)">
  37422. @param nameIndex zero-based index to name within workbook
  37423. </member>
  37424. <member name="M:NPOI.SS.Formula.PTG.NamePtg.#ctor(NPOI.Util.ILittleEndianInput)">
  37425. Creates new NamePtg
  37426. </member>
  37427. <member name="P:NPOI.SS.Formula.PTG.NamePtg.Index">
  37428. @return zero based index to a defined name record in the LinkTable
  37429. </member>
  37430. <member name="T:NPOI.SS.Formula.PTG.NameXPtg">
  37431. A Name, be that a Named Range or a Function / User Defined
  37432. Function, addressed in the HSSF External Sheet style.
  37433. This is HSSF only, as it matches the HSSF file format way of
  37434. referring to the sheet by an extern index. The XSSF equivalent
  37435. is {@link NameXPxg}
  37436. </member>
  37437. <member name="F:NPOI.SS.Formula.PTG.NameXPtg._sheetRefIndex">
  37438. index to REF entry in externsheet record
  37439. </member>
  37440. <member name="F:NPOI.SS.Formula.PTG.NameXPtg._nameNumber">
  37441. index to defined name or externname table(1 based)
  37442. </member>
  37443. <member name="F:NPOI.SS.Formula.PTG.NameXPtg._reserved">
  37444. reserved must be 0
  37445. </member>
  37446. <member name="M:NPOI.SS.Formula.PTG.NameXPtg.#ctor(System.Int32,System.Int32)">
  37447. @param sheetRefIndex index to REF entry in externsheet record
  37448. @param nameIndex index to defined name or externname table
  37449. </member>
  37450. <member name="T:NPOI.SS.Formula.PTG.NameXPxg">
  37451. A Name, be that a Named Range or a Function / User Defined
  37452. Function, Addressed in the HSSF External Sheet style.
  37453. <p>This is XSSF only, as it stores the sheet / book references
  37454. in String form. The HSSF equivalent using indexes is {@link NameXPtg}</p>
  37455. </member>
  37456. <member name="T:NPOI.SS.Formula.PTG.NotEqualPtg">
  37457. Ptg class to implement not equal
  37458. @author fred at stsci dot edu
  37459. </member>
  37460. <member name="T:NPOI.SS.Formula.PTG.NumberPtg">
  37461. Number
  37462. Stores a floating point value in a formula
  37463. value stored in a 8 byte field using IEEE notation
  37464. @author Avik Sengupta
  37465. @author Jason Height (jheight at chariot dot net dot au)
  37466. </member>
  37467. <member name="M:NPOI.SS.Formula.PTG.NumberPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  37468. Create a NumberPtg from a byte array Read from disk
  37469. </member>
  37470. <member name="M:NPOI.SS.Formula.PTG.NumberPtg.#ctor(System.String)">
  37471. Create a NumberPtg from a string representation of the number
  37472. Number format is not checked, it is expected to be validated in the parser
  37473. that calls this method.
  37474. @param value : String representation of a floating point number
  37475. </member>
  37476. <member name="T:NPOI.SS.Formula.PTG.OperandPtg">
  37477. @author Josh Micich
  37478. </member>
  37479. <member name="P:NPOI.SS.Formula.PTG.OperandPtg.IsBaseToken">
  37480. All Operand <c>Ptg</c>s are classifed ('relative', 'value', 'array')
  37481. </member>
  37482. <member name="T:NPOI.SS.Formula.PTG.OperationPtg">
  37483. defines a Ptg that is an operation instead of an operand
  37484. @author andy
  37485. </member>
  37486. <member name="M:NPOI.SS.Formula.PTG.OperationPtg.ToFormulaString(System.String[])">
  37487. returns a string representation of the operations
  37488. the Length of the input array should equal the number returned by
  37489. @see #GetNumberOfOperands
  37490. </member>
  37491. <member name="P:NPOI.SS.Formula.PTG.OperationPtg.NumberOfOperands">
  37492. The number of operands expected by the operations
  37493. </member>
  37494. <member name="T:NPOI.SS.Formula.PTG.ParenthesisPtg">
  37495. While formula tokens are stored in RPN order and thus do not need parenthesis for
  37496. precedence reasons, Parenthesis tokens ARE written to Ensure that user entered
  37497. parenthesis are Displayed as-is on Reading back
  37498. Avik Sengupta &lt;lists@aviksengupta.com&gt;
  37499. Andrew C. Oliver (acoliver at apache dot org)
  37500. @author Jason Height (jheight at chariot dot net dot au)
  37501. </member>
  37502. <member name="T:NPOI.SS.Formula.PTG.PercentPtg">
  37503. Percent PTG.
  37504. @author Daniel Noll (daniel at nuix.com.au)
  37505. </member>
  37506. <member name="T:NPOI.SS.Formula.PTG.PowerPtg">
  37507. @author andy
  37508. @author Jason Height (jheight at chariot dot net dot au)
  37509. </member>
  37510. <member name="T:NPOI.SS.Formula.PTG.Ptg">
  37511. <c>Ptg</c> represents a syntactic token in a formula. 'PTG' is an acronym for
  37512. '<b>p</b>arse <b>t</b>hin<b>g</b>'. Originally, the name referred to the single
  37513. byte identifier at the start of the token, but in POI, <c>Ptg</c> encapsulates
  37514. the whole formula token (initial byte + value data).
  37515. <c>Ptg</c>s are logically arranged in a tree representing the structure of the
  37516. Parsed formula. However, in BIFF files <c>Ptg</c>s are written/Read in
  37517. <em>Reverse-Polish Notation</em> order. The RPN ordering also simplifies formula
  37518. evaluation logic, so POI mostly accesses <c>Ptg</c>s in the same way.
  37519. @author andy
  37520. @author avik
  37521. @author Jason Height (jheight at chariot dot net dot au)
  37522. </member>
  37523. <member name="M:NPOI.SS.Formula.PTG.Ptg.ReadTokens(System.Int32,NPOI.Util.ILittleEndianInput)">
  37524. Reads <c>size</c> bytes of the input stream, to Create an array of <c>Ptg</c>s.
  37525. Extra data (beyond <c>size</c>) may be Read if and <c>ArrayPtg</c>s are present.
  37526. </member>
  37527. <member name="M:NPOI.SS.Formula.PTG.Ptg.Clone">
  37528. @return a distinct copy of this <c>Ptg</c> if the class is mutable, or the same instance
  37529. if the class is immutable.
  37530. </member>
  37531. <member name="M:NPOI.SS.Formula.PTG.Ptg.GetEncodedSize(NPOI.SS.Formula.PTG.Ptg[])">
  37532. This method will return the same result as {@link #getEncodedSizeWithoutArrayData(Ptg[])}
  37533. if there are no array tokens present.
  37534. @return the full size taken to encode the specified <c>Ptg</c>s
  37535. </member>
  37536. <member name="M:NPOI.SS.Formula.PTG.Ptg.GetEncodedSizeWithoutArrayData(NPOI.SS.Formula.PTG.Ptg[])">
  37537. Used to calculate value that should be encoded at the start of the encoded Ptg token array;
  37538. @return the size of the encoded Ptg tokens not including any trailing array data.
  37539. </member>
  37540. <member name="M:NPOI.SS.Formula.PTG.Ptg.SerializePtgs(NPOI.SS.Formula.PTG.Ptg[],System.Byte[],System.Int32)">
  37541. Writes the ptgs to the data buffer, starting at the specified offset.
  37542. <br/>
  37543. The 2 byte encode Length field is <b>not</b> written by this method.
  37544. @return number of bytes written
  37545. </member>
  37546. <member name="P:NPOI.SS.Formula.PTG.Ptg.Size">
  37547. @return the encoded Length of this Ptg, including the initial Ptg type identifier byte.
  37548. </member>
  37549. <member name="P:NPOI.SS.Formula.PTG.Ptg.IsBaseToken">
  37550. @return <c>false</c> if this token is classified as 'reference', 'value', or 'array'
  37551. </member>
  37552. <member name="M:NPOI.SS.Formula.PTG.Ptg.Write(NPOI.Util.ILittleEndianOutput)">
  37553. Write this Ptg to a byte array
  37554. </member>
  37555. <member name="M:NPOI.SS.Formula.PTG.Ptg.ToFormulaString">
  37556. return a string representation of this token alone
  37557. </member>
  37558. <member name="M:NPOI.SS.Formula.PTG.Ptg.ToString">
  37559. Overridden toString method to Ensure object hash is not printed.
  37560. This helps Get rid of gratuitous diffs when comparing two dumps
  37561. Subclasses may output more relevant information by overriding this method
  37562. </member>
  37563. <member name="P:NPOI.SS.Formula.PTG.Ptg.PtgClass">
  37564. @return the 'operand class' (REF/VALUE/ARRAY) for this Ptg
  37565. </member>
  37566. <member name="P:NPOI.SS.Formula.PTG.Ptg.RVAType">
  37567. Debug / diagnostic method to get this token's 'operand class' type.
  37568. @return 'R' for 'reference', 'V' for 'value', 'A' for 'array' and '.' for base tokens
  37569. </member>
  37570. <member name="T:NPOI.SS.Formula.PTG.Pxg">
  37571. An XSSF only special kind of Ptg, which stores the sheet / book
  37572. reference in string form.
  37573. </member>
  37574. <member name="T:NPOI.SS.Formula.PTG.Pxg3D">
  37575. An XSSF only special kind of Ptg, which stores a range of
  37576. sheet / book references in string form.
  37577. </member>
  37578. <member name="T:NPOI.SS.Formula.PTG.RangePtg">
  37579. @author Daniel Noll (daniel at nuix dot com dot au)
  37580. </member>
  37581. <member name="M:NPOI.SS.Formula.PTG.RangePtg.ToFormulaString(System.String[])">
  37582. implementation of method from OperationsPtg
  37583. </member>
  37584. <member name="T:NPOI.SS.Formula.PTG.Ref2DPtgBase">
  37585. @author Josh Micich
  37586. </member>
  37587. <member name="M:NPOI.SS.Formula.PTG.Ref2DPtgBase.#ctor(System.String)">
  37588. Takes in a String representation of a cell reference and fills out the
  37589. numeric fields.
  37590. </member>
  37591. <member name="T:NPOI.SS.Formula.PTG.Ref3DPtg">
  37592. Title: Reference 3D Ptg
  37593. Description: Defined a cell in extern sheet.
  37594. REFERENCE:
  37595. @author Libin Roman (Vista Portal LDT. Developer)
  37596. @author Jason Height (jheight at chariot dot net dot au)
  37597. @version 1.0-pre
  37598. </member>
  37599. <member name="F:NPOI.SS.Formula.PTG.Ref3DPtg.rowRelative">
  37600. Field 2
  37601. - lower 8 bits is the zero based Unsigned byte column index
  37602. - bit 16 - IsRowRelative
  37603. - bit 15 - IsColumnRelative
  37604. </member>
  37605. <member name="M:NPOI.SS.Formula.PTG.Ref3DPtg.#ctor">
  37606. Creates new AreaPtg
  37607. </member>
  37608. <member name="M:NPOI.SS.Formula.PTG.Ref3DPtg.ToFormulaString(NPOI.SS.Formula.IFormulaRenderingWorkbook)">
  37609. @return text representation of this cell reference that can be used in text
  37610. formulas. The sheet name will Get properly delimited if required.
  37611. </member>
  37612. <member name="T:NPOI.SS.Formula.PTG.Ref3DPxg">
  37613. <p>Title: XSSF 3D Reference</p>
  37614. <p>Description: Defines a cell in an external or different sheet.</p>
  37615. <p>REFERENCE: </p>
  37616. <p>This is XSSF only, as it stores the sheet / book references
  37617. in String form. The HSSF equivalent using indexes is {@link Ref3DPtg}</p>
  37618. </member>
  37619. <member name="T:NPOI.SS.Formula.PTG.RefErrorPtg">
  37620. RefError - handles deleted cell reference
  37621. @author Jason Height (jheight at chariot dot net dot au)
  37622. </member>
  37623. <member name="T:NPOI.SS.Formula.PTG.RefNPtg">
  37624. RefNPtg
  37625. @author Jason Height (jheight at apache dot com)
  37626. </member>
  37627. <member name="M:NPOI.SS.Formula.PTG.RefNPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  37628. Creates new ValueReferencePtg
  37629. </member>
  37630. <member name="T:NPOI.SS.Formula.PTG.RefPtg">
  37631. ReferencePtg - handles references (such as A1, A2, IA4)
  37632. @author Andrew C. Oliver (acoliver@apache.org)
  37633. @author Jason Height (jheight at chariot dot net dot au)
  37634. </member>
  37635. <member name="M:NPOI.SS.Formula.PTG.RefPtg.#ctor(System.String)">
  37636. Takes in a String representation of a cell reference and Fills out the
  37637. numeric fields.
  37638. </member>
  37639. <member name="T:NPOI.SS.Formula.PTG.RefPtgBase">
  37640. ReferencePtgBase - handles references (such as A1, A2, IA4)
  37641. @author Andrew C. Oliver (acoliver@apache.org)
  37642. @author Jason Height (jheight at chariot dot net dot au)
  37643. </member>
  37644. <member name="F:NPOI.SS.Formula.PTG.RefPtgBase.field_1_row">
  37645. The row index - zero based Unsigned 16 bit value
  37646. </member>
  37647. <member name="F:NPOI.SS.Formula.PTG.RefPtgBase.field_2_col">
  37648. Field 2
  37649. - lower 8 bits is the zero based Unsigned byte column index
  37650. - bit 16 - IsRowRelative
  37651. - bit 15 - IsColumnRelative
  37652. </member>
  37653. <member name="M:NPOI.SS.Formula.PTG.RefPtgBase.#ctor(System.String)">
  37654. Takes in a String representation of a cell reference and Fills out the
  37655. numeric fields.
  37656. </member>
  37657. <member name="P:NPOI.SS.Formula.PTG.RefPtgBase.Row">
  37658. Returns the row number as a short, which will be
  37659. wrapped (negative) for values between 32769 and 65535
  37660. </member>
  37661. <member name="P:NPOI.SS.Formula.PTG.RefPtgBase.RowAsInt">
  37662. Returns the row number as an int, between 0 and 65535
  37663. </member>
  37664. <member name="T:NPOI.SS.Formula.PTG.ScalarConstantPtg">
  37665. @author Josh Micich
  37666. </member>
  37667. <member name="T:NPOI.SS.Formula.PTG.StringPtg">
  37668. String Stores a String value in a formula value stored in the format
  37669. &lt;Length 2 bytes&gt;char[]
  37670. @author Werner Froidevaux
  37671. @author Jason Height (jheight at chariot dot net dot au)
  37672. @author Bernard Chesnoy
  37673. </member>
  37674. <member name="F:NPOI.SS.Formula.PTG.StringPtg.FORMULA_DELIMITER">
  37675. the Char (")used in formulas to delimit string literals
  37676. </member>
  37677. <member name="F:NPOI.SS.Formula.PTG.StringPtg.field_1_Length">
  37678. NOTE: OO doc says 16bit Length, but BiffViewer says 8 Book says something
  37679. totally different, so don't look there!
  37680. </member>
  37681. <member name="M:NPOI.SS.Formula.PTG.StringPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  37682. Create a StringPtg from a stream
  37683. </member>
  37684. <member name="M:NPOI.SS.Formula.PTG.StringPtg.#ctor(System.String)">
  37685. Create a StringPtg from a string representation of the number Number
  37686. format Is not Checked, it Is expected to be Validated in the Parser that
  37687. calls this method.
  37688. @param value :
  37689. String representation of a floating point number
  37690. </member>
  37691. <member name="T:NPOI.SS.Formula.PTG.SubtractPtg">
  37692. @author andy
  37693. @author Jason Height (jheight at chariot dot net dot au)
  37694. </member>
  37695. <member name="T:NPOI.SS.Formula.PTG.TblPtg">
  37696. This ptg indicates a data table.
  37697. It only occurs in a FORMULA record, never in an
  37698. ARRAY or NAME record. When ptgTbl occurs in a
  37699. formula, it is the only token in the formula.
  37700. This indicates that the cell containing the
  37701. formula is an interior cell in a data table;
  37702. the table description is found in a TABLE
  37703. record. Rows and columns which contain input
  37704. values to be substituted in the table do
  37705. not contain ptgTbl.
  37706. See page 811 of the june 08 binary docs.
  37707. </member>
  37708. <member name="F:NPOI.SS.Formula.PTG.TblPtg.field_1_first_row">
  37709. The row number of the upper left corner
  37710. </member>
  37711. <member name="F:NPOI.SS.Formula.PTG.TblPtg.field_2_first_col">
  37712. The column number of the upper left corner
  37713. </member>
  37714. <member name="T:NPOI.SS.Formula.PTG.UnaryMinusPtg">
  37715. Unary Plus operator
  37716. does not have any effect on the operand
  37717. @author Avik Sengupta
  37718. </member>
  37719. <member name="M:NPOI.SS.Formula.PTG.UnaryMinusPtg.ToFormulaString(System.String[])">
  37720. implementation of method from OperationsPtg
  37721. </member>
  37722. <member name="T:NPOI.SS.Formula.PTG.UnaryPlusPtg">
  37723. Unary Plus operator
  37724. does not have any effect on the operand
  37725. @author Avik Sengupta
  37726. </member>
  37727. <member name="M:NPOI.SS.Formula.PTG.UnaryPlusPtg.ToFormulaString(System.String[])">
  37728. implementation of method from OperationsPtg
  37729. </member>
  37730. <member name="T:NPOI.SS.Formula.PTG.UnionPtg">
  37731. @author Glen Stampoultzis (glens at apache.org)
  37732. </member>
  37733. <member name="M:NPOI.SS.Formula.PTG.UnionPtg.ToFormulaString(System.String[])">
  37734. implementation of method from OperationsPtg
  37735. </member>
  37736. <member name="T:NPOI.SS.Formula.PTG.UnknownPtg">
  37737. @author andy
  37738. @author Jason Height (jheight at chariot dot net dot au)
  37739. </member>
  37740. <member name="M:NPOI.SS.Formula.PTG.UnknownPtg.#ctor">
  37741. Creates new UnknownPtg
  37742. </member>
  37743. <member name="T:NPOI.SS.Formula.PTG.ValueOperatorPtg">
  37744. Common baseclass of all value operators.
  37745. Subclasses include all Unary and binary operators except for the reference operators (IntersectionPtg, RangePtg, UnionPtg)
  37746. @author Josh Micich
  37747. </member>
  37748. <member name="P:NPOI.SS.Formula.PTG.ValueOperatorPtg.IsBaseToken">
  37749. All Operator <c>Ptg</c>s are base tokens (i.e. are not RVA classified)
  37750. </member>
  37751. <member name="T:NPOI.SS.Formula.PTG.SharedFormula">
  37752. Encapsulates logic to convert shared formulaa into non shared equivalent
  37753. </member>
  37754. <member name="M:NPOI.SS.Formula.PTG.SharedFormula.ConvertSharedFormulas(NPOI.SS.Formula.PTG.Ptg[],System.Int32,System.Int32)">
  37755. Creates a non shared formula from the shared formula counterpart, i.e.
  37756. Converts the shared formula into the equivalent {@link org.apache.poi.ss.formula.ptg.Ptg} array that it would have,
  37757. were it not shared.
  37758. @param ptgs parsed tokens of the shared formula
  37759. @param formulaRow
  37760. @param formulaColumn
  37761. </member>
  37762. <member name="T:NPOI.SS.Formula.SheetNameFormatter">
  37763. Formats sheet names for use in formula expressions.
  37764. @author Josh Micich
  37765. </member>
  37766. <member name="M:NPOI.SS.Formula.SheetNameFormatter.Format(System.String)">
  37767. Used to format sheet names as they would appear in cell formula expressions.
  37768. @return the sheet name UnChanged if there is no need for delimiting. Otherwise the sheet
  37769. name is enclosed in single quotes ('). Any single quotes which were already present in the
  37770. sheet name will be converted to double single quotes ('').
  37771. </member>
  37772. <member name="M:NPOI.SS.Formula.SheetNameFormatter.AppendFormat(System.Text.StringBuilder,System.String)">
  37773. Convenience method for when a StringBuilder is already available
  37774. @param out - sheet name will be Appended here possibly with delimiting quotes
  37775. </member>
  37776. <member name="M:NPOI.SS.Formula.SheetNameFormatter.IsSpecialChar(System.Char)">
  37777. @return <c>true</c> if the presence of the specified Char in a sheet name would
  37778. require the sheet name to be delimited in formulas. This includes every non-alphanumeric
  37779. Char besides Underscore '_'.
  37780. </member>
  37781. <member name="M:NPOI.SS.Formula.SheetNameFormatter.CellReferenceIsWithinRange(System.String,System.String)">
  37782. Used to decide whether sheet names like 'AB123' need delimiting due to the fact that they
  37783. look like cell references.
  37784. <p/>
  37785. This code is currently being used for translating formulas represented with <code>Ptg</code>
  37786. tokens into human readable text form. In formula expressions, a sheet name always has a
  37787. trailing '!' so there is little chance for ambiguity. It doesn't matter too much what this
  37788. method returns but it is worth noting the likely consumers of these formula text strings:
  37789. <ol>
  37790. <li>POI's own formula parser</li>
  37791. <li>Visual reading by human</li>
  37792. <li>VBA automation entry into Excel cell contents e.g. ActiveCell.Formula = "=c64!A1"</li>
  37793. <li>Manual entry into Excel cell contents</li>
  37794. <li>Some third party formula parser</li>
  37795. </ol>
  37796. At the time of writing, POI's formula parser tolerates cell-like sheet names in formulas
  37797. with or without delimiters. The same goes for Excel(2007), both manual and automated entry.
  37798. <p/>
  37799. For better or worse this implementation attempts to replicate Excel's formula renderer.
  37800. Excel uses range checking on the apparent 'row' and 'column' components. Note however that
  37801. the maximum sheet size varies across versions.
  37802. @see org.apache.poi.hssf.util.CellReference
  37803. </member>
  37804. <member name="M:NPOI.SS.Formula.SheetNameFormatter.NameLooksLikePlainCellReference(System.String)">
  37805. Note - this method assumes the specified rawSheetName has only letters and digits. It
  37806. cannot be used to match absolute or range references (using the dollar or colon char).
  37807. Some notable cases:
  37808. <blockquote><table border="0" cellpAdding="1" cellspacing="0"
  37809. summary="Notable cases.">
  37810. <tr><th>Input </th><th>Result </th><th>Comments</th></tr>
  37811. <tr><td>"A1" </td><td>true</td><td> </td></tr>
  37812. <tr><td>"a111" </td><td>true</td><td> </td></tr>
  37813. <tr><td>"AA" </td><td>false</td><td> </td></tr>
  37814. <tr><td>"aa1" </td><td>true</td><td> </td></tr>
  37815. <tr><td>"A1A" </td><td>false</td><td> </td></tr>
  37816. <tr><td>"A1A1" </td><td>false</td><td> </td></tr>
  37817. <tr><td>"A$1:$C$20" </td><td>false</td><td>Not a plain cell reference</td></tr>
  37818. <tr><td>"SALES20080101" </td><td>true</td>
  37819. <td>Still needs delimiting even though well out of range</td></tr>
  37820. </table></blockquote>
  37821. @return <c>true</c> if there is any possible ambiguity that the specified rawSheetName
  37822. could be interpreted as a valid cell name.
  37823. </member>
  37824. <member name="T:NPOI.SS.Formula.SheetRangeEvaluator">
  37825. Evaluator for returning cells or sheets for a range of sheets
  37826. </member>
  37827. <member name="T:NPOI.SS.Formula.SheetRefEvaluator">
  37828. @author Josh Micich
  37829. </member>
  37830. <member name="M:NPOI.SS.Formula.SheetRefEvaluator.IsSubTotal(System.Int32,System.Int32)">
  37831. @return whether cell at rowIndex and columnIndex is a subtotal
  37832. @see org.apache.poi.ss.formula.functions.Subtotal
  37833. </member>
  37834. <member name="T:NPOI.SS.Formula.ThreeDEval">
  37835. Optional Extension to the likes of {@link AreaEval} and
  37836. {@link NPOI.SS.Formula.Eval.AreaEvalBase},
  37837. which allows for looking up 3D (sheet+row+column) Evaluations
  37838. </member>
  37839. <member name="M:NPOI.SS.Formula.ThreeDEval.GetValue(System.Int32,System.Int32,System.Int32)">
  37840. @param sheetIndex sheet index (zero based)
  37841. @param rowIndex relative row index (zero based)
  37842. @param columnIndex relative column index (zero based)
  37843. @return element at the specified row and column position
  37844. </member>
  37845. <member name="T:NPOI.SS.Formula.TwoDEval">
  37846. Common interface of {@link AreaEval} and {@link org.apache.poi.ss.formula.eval.AreaEvalBase},
  37847. for 2D (row+column) evaluations
  37848. </member>
  37849. <member name="M:NPOI.SS.Formula.TwoDEval.GetValue(System.Int32,System.Int32)">
  37850. @param rowIndex relative row index (zero based)
  37851. @param columnIndex relative column index (zero based)
  37852. @return element at the specified row and column position
  37853. </member>
  37854. <member name="P:NPOI.SS.Formula.TwoDEval.IsRow">
  37855. @return <c>true</c> if the area has just a single row, this also includes
  37856. the trivial case when the area has just a single cell.
  37857. </member>
  37858. <member name="P:NPOI.SS.Formula.TwoDEval.IsColumn">
  37859. @return <c>true</c> if the area has just a single column, this also includes
  37860. the trivial case when the area has just a single cell.
  37861. </member>
  37862. <member name="M:NPOI.SS.Formula.TwoDEval.GetRow(System.Int32)">
  37863. @param rowIndex relative row index (zero based)
  37864. @return a single row {@link TwoDEval}
  37865. </member>
  37866. <member name="M:NPOI.SS.Formula.TwoDEval.GetColumn(System.Int32)">
  37867. @param columnIndex relative column index (zero based)
  37868. @return a single column {@link TwoDEval}
  37869. </member>
  37870. <member name="M:NPOI.SS.Formula.TwoDEval.IsSubTotal(System.Int32,System.Int32)">
  37871. @return true if the cell at row and col is a subtotal
  37872. </member>
  37873. <member name="T:NPOI.SS.Formula.UDF.AggregatingUDFFinder">
  37874. Collects Add-in libraries and VB macro functions toGether into one UDF Finder
  37875. @author PUdalau
  37876. </member>
  37877. <member name="M:NPOI.SS.Formula.UDF.AggregatingUDFFinder.FindFunction(System.String)">
  37878. <summary>
  37879. Returns executor by specified name.
  37880. </summary>
  37881. <param name="name">Name of function.</param>
  37882. <returns>Function executor. null if not found</returns>
  37883. </member>
  37884. <member name="M:NPOI.SS.Formula.UDF.AggregatingUDFFinder.Add(NPOI.SS.Formula.UDF.UDFFinder)">
  37885. <summary>
  37886. Add a new toolpack
  37887. </summary>
  37888. <param name="toolPack"></param>
  37889. </member>
  37890. <member name="T:NPOI.SS.Formula.UDF.DefaultUDFFinder">
  37891. Default UDF Finder - for Adding your own user defined functions.
  37892. @author PUdalau
  37893. </member>
  37894. <member name="T:NPOI.SS.Formula.UDF.IndexedUDFFinder">
  37895. A UDFFinder that can retrieve functions both by name and by fake index.
  37896. @author Yegor Kozlov
  37897. </member>
  37898. <member name="T:NPOI.SS.Formula.UDF.UDFFinder">
  37899. Common interface for "Add-in" libraries and user defined function libraries.
  37900. @author PUdalau
  37901. </member>
  37902. <member name="M:NPOI.SS.Formula.UDF.UDFFinder.FindFunction(System.String)">
  37903. Returns executor by specified name. Returns <code>null</code> if the function name is unknown.
  37904. @param name Name of function.
  37905. @return Function executor.
  37906. </member>
  37907. <member name="T:NPOI.SS.Formula.WorkbookDependentFormula">
  37908. Should be implemented by any {@link Ptg} subclass that needs a workbook To render its formula.
  37909. <br/>
  37910. For POI internal use only
  37911. @author Josh Micich
  37912. </member>
  37913. <member name="T:NPOI.SS.Formula.WorkbookEvaluator">
  37914. Evaluates formula cells.<p/>
  37915. For performance reasons, this class keeps a cache of all previously calculated intermediate
  37916. cell values. Be sure To call {@link #ClearCache()} if any workbook cells are Changed between
  37917. calls To evaluate~ methods on this class.<br/>
  37918. For POI internal use only
  37919. @author Josh Micich
  37920. </member>
  37921. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetSheetName(System.Int32)">
  37922. also for debug use. Used in ToString methods
  37923. </member>
  37924. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.ClearAllCachedResultValues">
  37925. Should be called whenever there are Changes To input cells in the evaluated workbook.
  37926. Failure To call this method after changing cell values will cause incorrect behaviour
  37927. of the evaluate~ methods of this class
  37928. </member>
  37929. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.NotifyUpdateCell(NPOI.SS.Formula.IEvaluationCell)">
  37930. Should be called To tell the cell value cache that the specified (value or formula) cell
  37931. Has Changed.
  37932. </member>
  37933. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.NotifyDeleteCell(NPOI.SS.Formula.IEvaluationCell)">
  37934. Should be called To tell the cell value cache that the specified cell Has just been
  37935. deleted.
  37936. </member>
  37937. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetSheetIndex(System.String)">
  37938. Case-insensitive.
  37939. @return -1 if sheet with specified name does not exist
  37940. </member>
  37941. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.Evaluate(System.String,NPOI.SS.Util.CellReference)">
  37942. Evaluate a formula outside a cell value, e.g. conditional format rules or data validation expressions
  37943. @param formula to evaluate
  37944. @param ref defines the optional sheet and row/column base for the formula, if it is relative
  37945. @return value
  37946. </member>
  37947. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.EvaluateAny(NPOI.SS.Formula.IEvaluationCell,System.Int32,System.Int32,System.Int32,NPOI.SS.Formula.EvaluationTracker)">
  37948. @return never <c>null</c>, never {@link BlankEval}
  37949. </member>
  37950. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.AddExceptionInfo(System.NotImplementedException,System.Int32,System.Int32,System.Int32)">
  37951. Adds the current cell reference to the exception for easier debugging.
  37952. Would be nice to get the formula text as well, but that seems to require
  37953. too much digging around and casting to get the FormulaRenderingWorkbook.
  37954. </member>
  37955. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetValueFromNonFormulaCell(NPOI.SS.Formula.IEvaluationCell)">
  37956. Gets the value from a non-formula cell.
  37957. @param cell may be <c>null</c>
  37958. @return {@link BlankEval} if cell is <c>null</c> or blank, never <c>null</c>
  37959. </member>
  37960. <member name="F:NPOI.SS.Formula.WorkbookEvaluator.dbgEvaluationOutputForNextEval">
  37961. whether print detailed messages about the next formula evaluation
  37962. </member>
  37963. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.CountTokensToBeSkipped(NPOI.SS.Formula.PTG.Ptg[],System.Int32,System.Int32)">
  37964. Calculates the number of tokens that the evaluator should skip upon reaching a tAttrSkip.
  37965. @return the number of tokens (starting from <c>startIndex+1</c>) that need to be skipped
  37966. to achieve the specified <c>distInBytes</c> skip distance.
  37967. </member>
  37968. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.DereferenceResult(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  37969. Dereferences a single value from any AreaEval or RefEval evaluation result.
  37970. If the supplied evaluationResult is just a plain value, it is returned as-is.
  37971. @return a <c>NumberEval</c>, <c>StringEval</c>, <c>BoolEval</c>,
  37972. <c>BlankEval</c> or <c>ErrorEval</c>. Never <c>null</c>.
  37973. </member>
  37974. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.DereferenceResult(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.OperationEvaluationContext)">
  37975. Dereferences a single value from any AreaEval or RefEval evaluation
  37976. result. If the supplied evaluationResult is just a plain value, it is
  37977. returned as-is.
  37978. @return a {@link NumberEval}, {@link StringEval}, {@link BoolEval}, or
  37979. {@link ErrorEval}. Never <code>null</code>. {@link BlankEval} is
  37980. converted to {@link NumberEval#ZERO}
  37981. </member>
  37982. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetEvalForPtg(NPOI.SS.Formula.PTG.Ptg,NPOI.SS.Formula.OperationEvaluationContext)">
  37983. returns an appropriate Eval impl instance for the Ptg. The Ptg must be
  37984. one of: Area3DPtg, AreaPtg, ReferencePtg, Ref3DPtg, IntPtg, NumberPtg,
  37985. StringPtg, BoolPtg <br/>special Note: OperationPtg subtypes cannot be
  37986. passed here!
  37987. </member>
  37988. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.EvaluateReference(NPOI.SS.Formula.IEvaluationSheet,System.Int32,System.Int32,System.Int32,NPOI.SS.Formula.EvaluationTracker)">
  37989. Used by the lazy ref evals whenever they need To Get the value of a contained cell.
  37990. </member>
  37991. <member name="P:NPOI.SS.Formula.WorkbookEvaluator.IgnoreMissingWorkbooks">
  37992. Whether to ignore missing references to external workbooks and
  37993. use cached formula results in the main workbook instead.
  37994. <p>
  37995. In some cases exetrnal workbooks referenced by formulas in the main workbook are not avaiable.
  37996. With this method you can control how POI handles such missing references:
  37997. <ul>
  37998. <li>by default ignoreMissingWorkbooks=false and POI throws {@link WorkbookNotFoundException}
  37999. if an external reference cannot be resolved</li>
  38000. <li>if ignoreMissingWorkbooks=true then POI uses cached formula result
  38001. that already exists in the main workbook</li>
  38002. </ul>
  38003. </p>
  38004. @param ignore whether to ignore missing references to external workbooks
  38005. @see <a href="https://issues.apache.org/bugzilla/show_bug.cgi?id=52575">Bug 52575 for details</a>
  38006. </member>
  38007. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetSupportedFunctionNames">
  38008. Return a collection of functions that POI can evaluate
  38009. @return names of functions supported by POI
  38010. </member>
  38011. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetNotSupportedFunctionNames">
  38012. Return a collection of functions that POI does not support
  38013. @return names of functions NOT supported by POI
  38014. </member>
  38015. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.RegisterFunction(System.String,NPOI.SS.Formula.Functions.FreeRefFunction)">
  38016. Register a ATP function in runtime.
  38017. @param name the function name
  38018. @param func the functoin to register
  38019. @throws IllegalArgumentException if the function is unknown or already registered.
  38020. @since 3.8 beta6
  38021. </member>
  38022. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.RegisterFunction(System.String,NPOI.SS.Formula.Functions.Function)">
  38023. Register a function in runtime.
  38024. @param name the function name
  38025. @param func the functoin to register
  38026. @throws IllegalArgumentException if the function is unknown or already registered.
  38027. @since 3.8 beta6
  38028. </member>
  38029. <member name="T:NPOI.SS.Formula.IWorkbookEvaluatorProvider">
  38030. Provides access to a {@link WorkbookEvaluator}, eg for use with
  38031. {@link CollaboratingWorkbooksEnvironment}
  38032. For POI internal use only
  38033. </member>
  38034. <member name="M:NPOI.SS.Formula.IWorkbookEvaluatorProvider.GetWorkbookEvaluator">
  38035. Provide the underlying WorkbookEvaluator
  38036. </member>
  38037. <member name="T:NPOI.SS.SpreadsheetVersion">
  38038. This enum allows spReadsheets from multiple Excel versions to be handled by the common code.
  38039. Properties of this enum correspond to attributes of the <i>spReadsheet</i> that are easily
  38040. discernable to the user. It is not intended to deal with low-level issues like file formats.
  38041. <p/>
  38042. @author Josh Micich
  38043. @author Yegor Kozlov
  38044. </member>
  38045. <member name="F:NPOI.SS.SpreadsheetVersion.EXCEL97">
  38046. Excel97 format aka BIFF8
  38047. <ul>
  38048. <li>The total number of available columns is 256 (2^8)</li>
  38049. <li>The total number of available rows is 64k (2^16)</li>
  38050. <li>The maximum number of arguments to a function is 30</li>
  38051. <li>Number of conditional format conditions on a cell is 3</li>
  38052. <li>Length of text cell contents is unlimited </li>
  38053. <li>Length of text cell contents is 32767</li>
  38054. </ul>
  38055. </member>
  38056. <member name="F:NPOI.SS.SpreadsheetVersion.EXCEL2007">
  38057. Excel2007
  38058. <ul>
  38059. <li>The total number of available columns is 16K (2^14)</li>
  38060. <li>The total number of available rows is 1M (2^20)</li>
  38061. <li>The maximum number of arguments to a function is 255</li>
  38062. <li>Number of conditional format conditions on a cell is unlimited
  38063. (actually limited by available memory in Excel)</li>
  38064. <li>Length of text cell contents is unlimited </li>
  38065. </ul>
  38066. </member>
  38067. <member name="P:NPOI.SS.SpreadsheetVersion.DefaultExtension">
  38068. @return the default file extension of spReadsheet
  38069. </member>
  38070. <member name="P:NPOI.SS.SpreadsheetVersion.MaxRows">
  38071. @return the maximum number of usable rows in each spReadsheet
  38072. </member>
  38073. <member name="P:NPOI.SS.SpreadsheetVersion.LastRowIndex">
  38074. @return the last (maximum) valid row index, equals to <code> GetMaxRows() - 1 </code>
  38075. </member>
  38076. <member name="P:NPOI.SS.SpreadsheetVersion.MaxColumns">
  38077. @return the maximum number of usable columns in each spReadsheet
  38078. </member>
  38079. <member name="P:NPOI.SS.SpreadsheetVersion.LastColumnIndex">
  38080. @return the last (maximum) valid column index, equals to <code> GetMaxColumns() - 1 </code>
  38081. </member>
  38082. <member name="P:NPOI.SS.SpreadsheetVersion.MaxFunctionArgs">
  38083. @return the maximum number arguments that can be passed to a multi-arg function (e.g. COUNTIF)
  38084. </member>
  38085. <member name="P:NPOI.SS.SpreadsheetVersion.MaxConditionalFormats">
  38086. @return the maximum number of conditional format conditions on a cell
  38087. </member>
  38088. <member name="P:NPOI.SS.SpreadsheetVersion.LastColumnName">
  38089. @return the last valid column index in a ALPHA-26 representation
  38090. (<code>IV</code> or <code>XFD</code>).
  38091. </member>
  38092. <member name="P:NPOI.SS.SpreadsheetVersion.MaxCellStyles">
  38093. @return the maximum number of cell styles per spreadsheet
  38094. </member>
  38095. <member name="P:NPOI.SS.SpreadsheetVersion.MaxTextLength">
  38096. @return the maximum length of a text cell
  38097. </member>
  38098. <member name="T:NPOI.SS.UserModel.IAutoFilter">
  38099. Represents autofiltering for the specified worksheet.
  38100. <p>
  38101. Filtering data is a quick and easy way to find and work with a subset of data in a range of cells or table.
  38102. For example, you can filter to see only the values that you specify, filter to see the top or bottom values,
  38103. or filter to quickly see duplicate values.
  38104. </p>
  38105. TODO YK: For now (Aug 2010) POI only supports Setting a basic autofilter on a range of cells.
  38106. In future, when we support more auto-filter functions like custom criteria, sort, etc. we will add
  38107. corresponding methods to this interface.
  38108. </member>
  38109. <member name="F:NPOI.SS.UserModel.BorderDiagonal.None">
  38110. <summary>
  38111. No diagional border
  38112. </summary>
  38113. </member>
  38114. <member name="F:NPOI.SS.UserModel.BorderDiagonal.Backward">
  38115. <summary>
  38116. Backward diagional border, from left-top to right-bottom
  38117. </summary>
  38118. </member>
  38119. <member name="F:NPOI.SS.UserModel.BorderDiagonal.Forward">
  38120. <summary>
  38121. Forward diagional border, from right-top to left-bottom
  38122. </summary>
  38123. </member>
  38124. <member name="F:NPOI.SS.UserModel.BorderDiagonal.Both">
  38125. <summary>
  38126. Both forward and backward diagional border
  38127. </summary>
  38128. </member>
  38129. <member name="T:NPOI.SS.UserModel.IBorderFormatting">
  38130. <summary>
  38131. High level representation for Border Formatting component
  38132. of Conditional Formatting settings
  38133. </summary>
  38134. </member>
  38135. <member name="T:NPOI.SS.UserModel.BorderStyle">
  38136. <summary>
  38137. The enumeration value indicating the line style of a border in a cell
  38138. </summary>
  38139. </member>
  38140. <member name="F:NPOI.SS.UserModel.BorderStyle.None">
  38141. <summary>
  38142. No border
  38143. </summary>
  38144. </member>
  38145. <member name="F:NPOI.SS.UserModel.BorderStyle.Thin">
  38146. <summary>
  38147. Thin border
  38148. </summary>
  38149. </member>
  38150. <member name="F:NPOI.SS.UserModel.BorderStyle.Medium">
  38151. <summary>
  38152. Medium border
  38153. </summary>
  38154. </member>
  38155. <member name="F:NPOI.SS.UserModel.BorderStyle.Dashed">
  38156. <summary>
  38157. dash border
  38158. </summary>
  38159. </member>
  38160. <member name="F:NPOI.SS.UserModel.BorderStyle.Dotted">
  38161. <summary>
  38162. dot border
  38163. </summary>
  38164. </member>
  38165. <member name="F:NPOI.SS.UserModel.BorderStyle.Thick">
  38166. <summary>
  38167. Thick border
  38168. </summary>
  38169. </member>
  38170. <member name="F:NPOI.SS.UserModel.BorderStyle.Double">
  38171. <summary>
  38172. double-line border
  38173. </summary>
  38174. </member>
  38175. <member name="F:NPOI.SS.UserModel.BorderStyle.Hair">
  38176. <summary>
  38177. hair-line border
  38178. </summary>
  38179. </member>
  38180. <member name="F:NPOI.SS.UserModel.BorderStyle.MediumDashed">
  38181. <summary>
  38182. Medium dashed border
  38183. </summary>
  38184. </member>
  38185. <member name="F:NPOI.SS.UserModel.BorderStyle.DashDot">
  38186. <summary>
  38187. dash-dot border
  38188. </summary>
  38189. </member>
  38190. <member name="F:NPOI.SS.UserModel.BorderStyle.MediumDashDot">
  38191. <summary>
  38192. medium dash-dot border
  38193. </summary>
  38194. </member>
  38195. <member name="F:NPOI.SS.UserModel.BorderStyle.DashDotDot">
  38196. <summary>
  38197. dash-dot-dot border
  38198. </summary>
  38199. </member>
  38200. <member name="F:NPOI.SS.UserModel.BorderStyle.MediumDashDotDot">
  38201. <summary>
  38202. medium dash-dot-dot border
  38203. </summary>
  38204. </member>
  38205. <member name="F:NPOI.SS.UserModel.BorderStyle.SlantedDashDot">
  38206. <summary>
  38207. slanted dash-dot border
  38208. </summary>
  38209. </member>
  38210. <member name="T:NPOI.SS.UserModel.BuiltinFormats">
  38211. Utility to identify built-in formats. The following is a list of the formats as
  38212. returned by this class.<p/>
  38213. <p/>
  38214. 0, "General"<br/>
  38215. 1, "0"<br/>
  38216. 2, "0.00"<br/>
  38217. 3, "#,##0"<br/>
  38218. 4, "#,##0.00"<br/>
  38219. 5, "$#,##0_);($#,##0)"<br/>
  38220. 6, "$#,##0_);[Red]($#,##0)"<br/>
  38221. 7, "$#,##0.00);($#,##0.00)"<br/>
  38222. 8, "$#,##0.00_);[Red]($#,##0.00)"<br/>
  38223. 9, "0%"<br/>
  38224. 0xa, "0.00%"<br/>
  38225. 0xb, "0.00E+00"<br/>
  38226. 0xc, "# ?/?"<br/>
  38227. 0xd, "# ??/??"<br/>
  38228. 0xe, "m/d/yy"<br/>
  38229. 0xf, "d-mmm-yy"<br/>
  38230. 0x10, "d-mmm"<br/>
  38231. 0x11, "mmm-yy"<br/>
  38232. 0x12, "h:mm AM/PM"<br/>
  38233. 0x13, "h:mm:ss AM/PM"<br/>
  38234. 0x14, "h:mm"<br/>
  38235. 0x15, "h:mm:ss"<br/>
  38236. 0x16, "m/d/yy h:mm"<br/>
  38237. <p/>
  38238. // 0x17 - 0x24 reserved for international and undocumented
  38239. 0x25, "#,##0_);(#,##0)"<br/>
  38240. 0x26, "#,##0_);[Red](#,##0)"<br/>
  38241. 0x27, "#,##0.00_);(#,##0.00)"<br/>
  38242. 0x28, "#,##0.00_);[Red](#,##0.00)"<br/>
  38243. 0x29, "_(*#,##0_);_(*(#,##0);_(* \"-\"_);_(@_)"<br/>
  38244. 0x2a, "_($*#,##0_);_($*(#,##0);_($* \"-\"_);_(@_)"<br/>
  38245. 0x2b, "_(*#,##0.00_);_(*(#,##0.00);_(*\"-\"??_);_(@_)"<br/>
  38246. 0x2c, "_($*#,##0.00_);_($*(#,##0.00);_($*\"-\"??_);_(@_)"<br/>
  38247. 0x2d, "mm:ss"<br/>
  38248. 0x2e, "[h]:mm:ss"<br/>
  38249. 0x2f, "mm:ss.0"<br/>
  38250. 0x30, "##0.0E+0"<br/>
  38251. 0x31, "@" - This is text format.<br/>
  38252. 0x31 "text" - Alias for "@"<br/>
  38253. <p/>
  38254. @author Yegor Kozlov
  38255. Modified 6/17/09 by Stanislav Shor - positive formats don't need starting '('
  38256. </member>
  38257. <member name="F:NPOI.SS.UserModel.BuiltinFormats.FIRST_USER_DEFINED_FORMAT_INDEX">
  38258. The first user-defined number format starts at 164.
  38259. </member>
  38260. <member name="M:NPOI.SS.UserModel.BuiltinFormats.GetAll">
  38261. @return array of built-in data formats
  38262. </member>
  38263. <member name="M:NPOI.SS.UserModel.BuiltinFormats.GetBuiltinFormat(System.Int32)">
  38264. Get the format string that matches the given format index
  38265. @param index of a built in format
  38266. @return string represented at index of format or <code>null</code> if there is not a built-in format at that index
  38267. </member>
  38268. <member name="M:NPOI.SS.UserModel.BuiltinFormats.GetBuiltinFormat(System.String)">
  38269. Get the format index that matches the given format string.
  38270. <p>
  38271. Automatically converts "text" to excel's format string to represent text.
  38272. </p>
  38273. @param pFmt string matching a built-in format
  38274. @return index of format or -1 if undefined.
  38275. </member>
  38276. <member name="T:NPOI.SS.UserModel.ICell">
  38277. High level representation of a cell in a row of a spreadsheet.
  38278. <p>
  38279. Cells can be numeric, formula-based or string-based (text). The cell type
  38280. specifies this. String cells cannot conatin numbers and numeric cells cannot
  38281. contain strings (at least according to our model). Client apps should do the
  38282. conversions themselves. Formula cells have the formula string, as well as
  38283. the formula result, which can be numeric or string.
  38284. </p>
  38285. <p>
  38286. Cells should have their number (0 based) before being Added to a row.
  38287. </p>
  38288. </member>
  38289. <member name="P:NPOI.SS.UserModel.ICell.ColumnIndex">
  38290. <summary>
  38291. zero-based column index of a column in a sheet.
  38292. </summary>
  38293. </member>
  38294. <member name="P:NPOI.SS.UserModel.ICell.RowIndex">
  38295. <summary>
  38296. zero-based row index of a row in the sheet that contains this cell
  38297. </summary>
  38298. </member>
  38299. <member name="P:NPOI.SS.UserModel.ICell.Sheet">
  38300. <summary>
  38301. the sheet this cell belongs to
  38302. </summary>
  38303. </member>
  38304. <member name="P:NPOI.SS.UserModel.ICell.Row">
  38305. <summary>
  38306. the row this cell belongs to
  38307. </summary>
  38308. </member>
  38309. <member name="P:NPOI.SS.UserModel.ICell.CellType">
  38310. <summary>
  38311. Set the cells type (numeric, formula or string)
  38312. </summary>
  38313. <p>If the cell currently contains a value, the value will
  38314. be converted to match the new type, if possible. Formatting
  38315. is generally lost in the process however.</p>
  38316. <p>If what you want to do is get a String value for your
  38317. numeric cell, <i>stop!</i>. This is not the way to do it.
  38318. Instead, for fetching the string value of a numeric or boolean
  38319. or date cell, use {@link DataFormatter} instead.</p>
  38320. </member>
  38321. <member name="M:NPOI.SS.UserModel.ICell.SetCellType(NPOI.SS.UserModel.CellType)">
  38322. <summary>
  38323. Set the cells type (numeric, formula or string)
  38324. </summary>
  38325. <param name="cellType"></param>
  38326. </member>
  38327. <member name="P:NPOI.SS.UserModel.ICell.CachedFormulaResultType">
  38328. <summary>
  38329. Only valid for formula cells
  38330. </summary>
  38331. </member>
  38332. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(System.Double)">
  38333. <summary>
  38334. Set a numeric value for the cell
  38335. </summary>
  38336. <param name="value">the numeric value to set this cell to. For formulas we'll set the
  38337. precalculated value, for numerics we'll set its value. For other types we will change
  38338. the cell to a numeric cell and set its value.
  38339. </param>
  38340. </member>
  38341. <member name="M:NPOI.SS.UserModel.ICell.SetCellErrorValue(System.Byte)">
  38342. <summary>
  38343. Set a error value for the cell
  38344. </summary>
  38345. <param name="value">the error value to set this cell to. For formulas we'll set the
  38346. precalculated value , for errors we'll set its value. For other types we will change
  38347. the cell to an error cell and set its value.
  38348. </param>
  38349. </member>
  38350. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(System.DateTime)">
  38351. <summary>
  38352. Converts the supplied date to its equivalent Excel numeric value and Sets that into the cell.
  38353. </summary>
  38354. <param name="value">the numeric value to set this cell to. For formulas we'll set the
  38355. precalculated value, for numerics we'll set its value. For other types we will change
  38356. the cell to a numerics cell and set its value.
  38357. </param>
  38358. </member>
  38359. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(NPOI.SS.UserModel.IRichTextString)">
  38360. <summary>
  38361. Set a rich string value for the cell.
  38362. </summary>
  38363. <param name="value">value to set the cell to. For formulas we'll set the formula
  38364. string, for String cells we'll set its value. For other types we will
  38365. change the cell to a string cell and set its value.
  38366. If value is null then we will change the cell to a Blank cell.
  38367. </param>
  38368. </member>
  38369. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(System.String)">
  38370. <summary>
  38371. Set a string value for the cell.
  38372. </summary>
  38373. <param name="value">value to set the cell to. For formulas we'll set the formula
  38374. string, for String cells we'll set its value. For other types we will
  38375. change the cell to a string cell and set its value.
  38376. If value is null then we will change the cell to a blank cell.
  38377. </param>
  38378. </member>
  38379. <member name="M:NPOI.SS.UserModel.ICell.CopyCellTo(System.Int32)">
  38380. <summary>
  38381. Copy the cell to the target index. If the target cell exists, a new cell will be inserted before the existing cell.
  38382. </summary>
  38383. <param name="targetIndex">target index</param>
  38384. <returns>the new copied cell object</returns>
  38385. </member>
  38386. <member name="P:NPOI.SS.UserModel.ICell.CellFormula">
  38387. <summary>
  38388. Return a formula for the cell
  38389. </summary>
  38390. <exception cref="T:System.InvalidOperationException">if the cell type returned by GetCellType() is not CELL_TYPE_FORMULA </exception>
  38391. </member>
  38392. <member name="M:NPOI.SS.UserModel.ICell.RemoveFormula">
  38393. <summary>
  38394. Removes formula, if any.
  38395. If cell was blank, leaves it as is.
  38396. If it is a part of an array formula group, blanks the cell.
  38397. If has a regular formula, removes the formula preserving the "cached" value.
  38398. </summary>
  38399. </member>
  38400. <member name="M:NPOI.SS.UserModel.ICell.SetCellFormula(System.String)">
  38401. <summary>
  38402. Sets formula for this cell.
  38403. </summary>
  38404. <param name="formula">the formula to Set, e.g. <code>"SUM(C4:E4)"</code>.</param>
  38405. </member>
  38406. <member name="P:NPOI.SS.UserModel.ICell.NumericCellValue">
  38407. <summary>
  38408. Get the value of the cell as a number.
  38409. </summary>
  38410. <exception cref="T:System.InvalidOperationException">if the cell type returned by GetCellType() is CELL_TYPE_STRING</exception>
  38411. <exception cref="T:System.FormatException">if the cell value isn't a parsable double</exception>
  38412. </member>
  38413. <member name="P:NPOI.SS.UserModel.ICell.DateCellValue">
  38414. <summary>
  38415. Get the value of the cell as a date.
  38416. </summary>
  38417. <exception cref="T:System.InvalidOperationException">if the cell type returned by GetCellType() is CELL_TYPE_STRING</exception>
  38418. <exception cref="T:System.FormatException">if the cell value isn't a parsable double</exception>
  38419. </member>
  38420. <member name="P:NPOI.SS.UserModel.ICell.RichStringCellValue">
  38421. <summary>
  38422. Get the value of the cell RichTextString
  38423. </summary>
  38424. </member>
  38425. <member name="P:NPOI.SS.UserModel.ICell.ErrorCellValue">
  38426. <summary>
  38427. Get the value of the cell as an error code.
  38428. </summary>
  38429. </member>
  38430. <member name="P:NPOI.SS.UserModel.ICell.StringCellValue">
  38431. <summary>
  38432. Get the value of the cell as a string
  38433. </summary>
  38434. </member>
  38435. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(System.Boolean)">
  38436. <summary>
  38437. Set a bool value for the cell
  38438. </summary>
  38439. <param name="value"></param>
  38440. </member>
  38441. <member name="P:NPOI.SS.UserModel.ICell.BooleanCellValue">
  38442. <summary>
  38443. Get the value of the cell as a bool.
  38444. </summary>
  38445. </member>
  38446. <member name="P:NPOI.SS.UserModel.ICell.CellStyle">
  38447. <summary>
  38448. get or set the cell's style.
  38449. If set the style for the cell. The style should be an CellStyle created/retreived from the Workbook.
  38450. To change the style of a cell without affecting other cells that use the same style,
  38451. use CellUtil#setCellStyleProperties
  38452. </summary>
  38453. </member>
  38454. <member name="M:NPOI.SS.UserModel.ICell.SetAsActiveCell">
  38455. <summary>
  38456. Sets this cell as the active cell for the worksheet
  38457. </summary>
  38458. </member>
  38459. <member name="P:NPOI.SS.UserModel.ICell.Address">
  38460. Gets the address of this cell
  38461. @return <code>A1</code> style address of this cell
  38462. @since 3.14beta2
  38463. </member>
  38464. <member name="P:NPOI.SS.UserModel.ICell.CellComment">
  38465. <summary>
  38466. comment associated with this cell
  38467. </summary>
  38468. </member>
  38469. <member name="M:NPOI.SS.UserModel.ICell.RemoveCellComment">
  38470. <summary>
  38471. Removes the comment for this cell, if there is one.
  38472. </summary>
  38473. </member>
  38474. <member name="P:NPOI.SS.UserModel.ICell.Hyperlink">
  38475. <summary>
  38476. hyperlink associated with this cell
  38477. </summary>
  38478. </member>
  38479. <member name="M:NPOI.SS.UserModel.ICell.RemoveHyperlink">
  38480. <summary>
  38481. Removes the hyperlink for this cell, if there is one.
  38482. </summary>
  38483. </member>
  38484. <member name="P:NPOI.SS.UserModel.ICell.ArrayFormulaRange">
  38485. <summary>
  38486. Only valid for array formula cells
  38487. </summary>
  38488. <returns>range of the array formula group that the cell belongs to.</returns>
  38489. </member>
  38490. <member name="P:NPOI.SS.UserModel.ICell.IsPartOfArrayFormulaGroup">
  38491. <summary>
  38492. if this cell is part of group of cells having a common array formula.
  38493. </summary>
  38494. </member>
  38495. <member name="M:NPOI.SS.UserModel.CellCopyPolicy.#ctor">
  38496. Default CellCopyPolicy, uses default policy
  38497. For custom CellCopyPolicy, use {@link Builder} class
  38498. </member>
  38499. <member name="M:NPOI.SS.UserModel.CellCopyPolicy.#ctor(NPOI.SS.UserModel.CellCopyPolicy)">
  38500. Copy constructor
  38501. @param other policy to copy
  38502. </member>
  38503. <member name="M:NPOI.SS.UserModel.CellCopyPolicy.Builder.#ctor">
  38504. Builder class for CellCopyPolicy
  38505. </member>
  38506. <member name="P:NPOI.SS.UserModel.CellCopyPolicy.IsCopyCellValue">
  38507. @return the copyCellValue
  38508. </member>
  38509. <member name="P:NPOI.SS.UserModel.CellCopyPolicy.IsCopyCellStyle">
  38510. @return the copyCellStyle
  38511. </member>
  38512. <member name="P:NPOI.SS.UserModel.CellCopyPolicy.IsCopyCellFormula">
  38513. @return the copyCellFormula
  38514. </member>
  38515. <member name="P:NPOI.SS.UserModel.CellCopyPolicy.IsCopyHyperlink">
  38516. @return the copyHyperlink
  38517. </member>
  38518. <member name="P:NPOI.SS.UserModel.CellCopyPolicy.IsMergeHyperlink">
  38519. @return the mergeHyperlink
  38520. </member>
  38521. <member name="P:NPOI.SS.UserModel.CellCopyPolicy.IsCopyRowHeight">
  38522. @return the copyRowHeight
  38523. </member>
  38524. <member name="P:NPOI.SS.UserModel.CellCopyPolicy.IsCondenseRows">
  38525. If condenseRows is true, a discontinuities in srcRows will be Removed when copied to destination
  38526. For example:
  38527. Sheet.CopyRows({Row(1), Row(2), Row(5)}, 11, policy) results in rows 1, 2, and 5
  38528. being copied to rows 11, 12, and 13 if condenseRows is True, or rows 11, 11, 15 if condenseRows is false
  38529. @return the condenseRows
  38530. </member>
  38531. <member name="P:NPOI.SS.UserModel.CellCopyPolicy.IsCopyMergedRegions">
  38532. @return the copyMergedRegions
  38533. </member>
  38534. <member name="P:NPOI.SS.UserModel.ICellRange`1.Size">
  38535. Gets the number of cells in this range.
  38536. @return <tt>height * width </tt>
  38537. </member>
  38538. <member name="P:NPOI.SS.UserModel.ICellRange`1.ReferenceText">
  38539. @return the text format of this range. Single cell ranges are formatted
  38540. like single cell references (e.g. 'A1' instead of 'A1:A1').
  38541. </member>
  38542. <member name="P:NPOI.SS.UserModel.ICellRange`1.TopLeftCell">
  38543. @return the cell at relative coordinates (0,0). Never <code>null</code>.
  38544. </member>
  38545. <member name="M:NPOI.SS.UserModel.ICellRange`1.GetCell(System.Int32,System.Int32)">
  38546. @param relativeRowIndex must be between <tt>0</tt> and <tt>height-1</tt>
  38547. @param relativeColumnIndex must be between <tt>0</tt> and <tt>width-1</tt>
  38548. @return the cell at the specified coordinates. Never <code>null</code>.
  38549. </member>
  38550. <member name="P:NPOI.SS.UserModel.ICellRange`1.FlattenedCells">
  38551. @return a flattened array of all the cells in this {@link CellRange}
  38552. </member>
  38553. <member name="P:NPOI.SS.UserModel.ICellRange`1.Cells">
  38554. @return a 2-D array of all the cells in this {@link CellRange}. The first
  38555. array dimension is the row index (values <tt>0...height-1</tt>)
  38556. and the second dimension is the column index (values <tt>0...width-1</tt>)
  38557. </member>
  38558. <member name="P:NPOI.SS.UserModel.ICellStyle.ShrinkToFit">
  38559. <summary>
  38560. the Cell should be auto-sized to shrink to fit if the text is too long
  38561. </summary>
  38562. </member>
  38563. <member name="P:NPOI.SS.UserModel.ICellStyle.Index">
  38564. get the index within the Workbook (sequence within the collection of ExtnededFormat objects)
  38565. @return unique index number of the underlying record this style represents (probably you don't care
  38566. unless you're comparing which one is which)
  38567. </member>
  38568. <member name="P:NPOI.SS.UserModel.ICellStyle.DataFormat">
  38569. get the index of the format
  38570. @see DataFormat
  38571. </member>
  38572. <member name="M:NPOI.SS.UserModel.ICellStyle.GetDataFormatString">
  38573. Get the format string
  38574. </member>
  38575. <member name="M:NPOI.SS.UserModel.ICellStyle.SetFont(NPOI.SS.UserModel.IFont)">
  38576. set the font for this style
  38577. @param font a font object Created or retreived from the Workbook object
  38578. @see Workbook#CreateFont()
  38579. @see Workbook#GetFontAt(short)
  38580. </member>
  38581. <member name="P:NPOI.SS.UserModel.ICellStyle.FontIndex">
  38582. Gets the index of the font for this style
  38583. @see Workbook#GetFontAt(short)
  38584. </member>
  38585. <member name="P:NPOI.SS.UserModel.ICellStyle.IsHidden">
  38586. get whether the cell's using this style are to be hidden
  38587. @return hidden - whether the cell using this style should be hidden
  38588. </member>
  38589. <member name="P:NPOI.SS.UserModel.ICellStyle.IsLocked">
  38590. get whether the cell's using this style are to be locked
  38591. @return hidden - whether the cell using this style should be locked
  38592. </member>
  38593. <member name="P:NPOI.SS.UserModel.ICellStyle.Alignment">
  38594. get the type of horizontal alignment for the cell
  38595. @return align - the type of alignment
  38596. @see #ALIGN_GENERAL
  38597. @see #ALIGN_LEFT
  38598. @see #ALIGN_CENTER
  38599. @see #ALIGN_RIGHT
  38600. @see #ALIGN_FILL
  38601. @see #ALIGN_JUSTIFY
  38602. @see #ALIGN_CENTER_SELECTION
  38603. </member>
  38604. <member name="P:NPOI.SS.UserModel.ICellStyle.WrapText">
  38605. get whether the text should be wrapped
  38606. @return wrap text or not
  38607. </member>
  38608. <member name="P:NPOI.SS.UserModel.ICellStyle.VerticalAlignment">
  38609. get the type of vertical alignment for the cell
  38610. @return align the type of alignment
  38611. @see #VERTICAL_TOP
  38612. @see #VERTICAL_CENTER
  38613. @see #VERTICAL_BOTTOM
  38614. @see #VERTICAL_JUSTIFY
  38615. </member>
  38616. <member name="P:NPOI.SS.UserModel.ICellStyle.Rotation">
  38617. get the degree of rotation for the text in the cell
  38618. Note: HSSF uses values from -90 to 90 degrees, whereas XSSF
  38619. uses values from 0 to 180 degrees. The implementations of this method will map between these two value-ranges
  38620. accordingly, however the corresponding getter is returning values in the range mandated by the current type
  38621. of Excel file-format that this CellStyle is applied to.
  38622. @return rotation degrees (between -90 and 90 degrees)
  38623. </member>
  38624. <member name="P:NPOI.SS.UserModel.ICellStyle.Indention">
  38625. get the number of spaces to indent the text in the cell
  38626. @return indent - number of spaces
  38627. </member>
  38628. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderLeft">
  38629. get the type of border to use for the left border of the cell
  38630. @return border type
  38631. @see #BORDER_NONE
  38632. @see #BORDER_THIN
  38633. @see #BORDER_MEDIUM
  38634. @see #BORDER_DASHED
  38635. @see #BORDER_DOTTED
  38636. @see #BORDER_THICK
  38637. @see #BORDER_DOUBLE
  38638. @see #BORDER_HAIR
  38639. @see #BORDER_MEDIUM_DASHED
  38640. @see #BORDER_DASH_DOT
  38641. @see #BORDER_MEDIUM_DASH_DOT
  38642. @see #BORDER_DASH_DOT_DOT
  38643. @see #BORDER_MEDIUM_DASH_DOT_DOT
  38644. @see #BORDER_SLANTED_DASH_DOT
  38645. </member>
  38646. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderRight">
  38647. get the type of border to use for the right border of the cell
  38648. @return border type
  38649. @see #BORDER_NONE
  38650. @see #BORDER_THIN
  38651. @see #BORDER_MEDIUM
  38652. @see #BORDER_DASHED
  38653. @see #BORDER_DOTTED
  38654. @see #BORDER_THICK
  38655. @see #BORDER_DOUBLE
  38656. @see #BORDER_HAIR
  38657. @see #BORDER_MEDIUM_DASHED
  38658. @see #BORDER_DASH_DOT
  38659. @see #BORDER_MEDIUM_DASH_DOT
  38660. @see #BORDER_DASH_DOT_DOT
  38661. @see #BORDER_MEDIUM_DASH_DOT_DOT
  38662. @see #BORDER_SLANTED_DASH_DOT
  38663. </member>
  38664. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderTop">
  38665. get the type of border to use for the top border of the cell
  38666. @return border type
  38667. @see #BORDER_NONE
  38668. @see #BORDER_THIN
  38669. @see #BORDER_MEDIUM
  38670. @see #BORDER_DASHED
  38671. @see #BORDER_DOTTED
  38672. @see #BORDER_THICK
  38673. @see #BORDER_DOUBLE
  38674. @see #BORDER_HAIR
  38675. @see #BORDER_MEDIUM_DASHED
  38676. @see #BORDER_DASH_DOT
  38677. @see #BORDER_MEDIUM_DASH_DOT
  38678. @see #BORDER_DASH_DOT_DOT
  38679. @see #BORDER_MEDIUM_DASH_DOT_DOT
  38680. @see #BORDER_SLANTED_DASH_DOT
  38681. </member>
  38682. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderBottom">
  38683. get the type of border to use for the bottom border of the cell
  38684. @return border type
  38685. @see #BORDER_NONE
  38686. @see #BORDER_THIN
  38687. @see #BORDER_MEDIUM
  38688. @see #BORDER_DASHED
  38689. @see #BORDER_DOTTED
  38690. @see #BORDER_THICK
  38691. @see #BORDER_DOUBLE
  38692. @see #BORDER_HAIR
  38693. @see #BORDER_MEDIUM_DASHED
  38694. @see #BORDER_DASH_DOT
  38695. @see #BORDER_MEDIUM_DASH_DOT
  38696. @see #BORDER_DASH_DOT_DOT
  38697. @see #BORDER_MEDIUM_DASH_DOT_DOT
  38698. @see #BORDER_SLANTED_DASH_DOT
  38699. </member>
  38700. <member name="P:NPOI.SS.UserModel.ICellStyle.LeftBorderColor">
  38701. get the color to use for the left border
  38702. </member>
  38703. <member name="P:NPOI.SS.UserModel.ICellStyle.RightBorderColor">
  38704. get the color to use for the left border
  38705. @return the index of the color defInition
  38706. </member>
  38707. <member name="P:NPOI.SS.UserModel.ICellStyle.TopBorderColor">
  38708. get the color to use for the top border
  38709. @return hhe index of the color defInition
  38710. </member>
  38711. <member name="P:NPOI.SS.UserModel.ICellStyle.BottomBorderColor">
  38712. get the color to use for the left border
  38713. @return the index of the color defInition
  38714. </member>
  38715. <member name="P:NPOI.SS.UserModel.ICellStyle.FillPattern">
  38716. get the fill pattern (??) - set to 1 to fill with foreground color
  38717. @return fill pattern
  38718. </member>
  38719. <member name="P:NPOI.SS.UserModel.ICellStyle.FillBackgroundColor">
  38720. get the background fill color
  38721. @return fill color
  38722. </member>
  38723. <member name="P:NPOI.SS.UserModel.ICellStyle.FillForegroundColor">
  38724. get the foreground fill color
  38725. @return fill color
  38726. </member>
  38727. <member name="M:NPOI.SS.UserModel.ICellStyle.CloneStyleFrom(NPOI.SS.UserModel.ICellStyle)">
  38728. Clones all the style information from another
  38729. CellStyle, onto this one. This
  38730. CellStyle will then have all the same
  38731. properties as the source, but the two may
  38732. be edited independently.
  38733. Any stylings on this CellStyle will be lost!
  38734. The source CellStyle could be from another
  38735. Workbook if you like. This allows you to
  38736. copy styles from one Workbook to another.
  38737. However, both of the CellStyles will need
  38738. to be of the same type (HSSFCellStyle or
  38739. XSSFCellStyle)
  38740. </member>
  38741. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderDiagonalColor">
  38742. <summary>
  38743. Gets or sets the color to use for the diagional border
  38744. </summary>
  38745. <value>The index of the color definition.</value>
  38746. </member>
  38747. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderDiagonalLineStyle">
  38748. <summary>
  38749. Gets or sets the line type to use for the diagional border
  38750. </summary>
  38751. <value>The line type.</value>
  38752. </member>
  38753. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderDiagonal">
  38754. <summary>
  38755. Gets or sets the type of diagional border
  38756. </summary>.
  38757. <value>The border diagional type.</value>
  38758. </member>
  38759. <member name="P:NPOI.SS.UserModel.ICellStyle.FillBackgroundColorColor">
  38760. Gets the color object representing the current
  38761. background fill, resolving indexes using
  38762. the supplied workbook.
  38763. This will work for both indexed and rgb
  38764. defined colors.
  38765. </member>
  38766. <member name="P:NPOI.SS.UserModel.ICellStyle.FillForegroundColorColor">
  38767. Gets the color object representing the current
  38768. foreground fill, resolving indexes using
  38769. the supplied workbook.
  38770. This will work for both indexed and rgb
  38771. defined colors.
  38772. </member>
  38773. <member name="T:NPOI.SS.UserModel.CellValue">
  38774. Mimics the 'data view' of a cell. This allows formula Evaluator
  38775. to return a CellValue instead of precasting the value to String
  38776. or Number or bool type.
  38777. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  38778. </member>
  38779. <member name="P:NPOI.SS.UserModel.CellValue.BooleanValue">
  38780. @return Returns the boolValue.
  38781. </member>
  38782. <member name="P:NPOI.SS.UserModel.CellValue.NumberValue">
  38783. @return Returns the numberValue.
  38784. </member>
  38785. <member name="P:NPOI.SS.UserModel.CellValue.StringValue">
  38786. @return Returns the stringValue.
  38787. </member>
  38788. <member name="P:NPOI.SS.UserModel.CellValue.CellType">
  38789. @return Returns the cellType.
  38790. </member>
  38791. <member name="P:NPOI.SS.UserModel.CellValue.ErrorValue">
  38792. @return Returns the errorValue.
  38793. </member>
  38794. <member name="T:NPOI.SS.UserModel.IChart">
  38795. High level representation of a chart.
  38796. @author Roman Kashitsyn
  38797. </member>
  38798. <member name="P:NPOI.SS.UserModel.IChart.ChartDataFactory">
  38799. @return an appropriate ChartDataFactory implementation
  38800. </member>
  38801. <member name="P:NPOI.SS.UserModel.IChart.ChartAxisFactory">
  38802. @return an appropriate ChartAxisFactory implementation
  38803. </member>
  38804. <member name="M:NPOI.SS.UserModel.IChart.GetOrCreateLegend">
  38805. @return chart legend instance
  38806. </member>
  38807. <member name="M:NPOI.SS.UserModel.IChart.DeleteLegend">
  38808. Delete current chart legend.
  38809. </member>
  38810. <member name="M:NPOI.SS.UserModel.IChart.GetAxis">
  38811. @return list of all chart axis
  38812. </member>
  38813. <member name="M:NPOI.SS.UserModel.IChart.Plot(NPOI.SS.UserModel.Charts.IChartData,NPOI.SS.UserModel.Charts.IChartAxis[])">
  38814. Plots specified data on the chart.
  38815. @param data a data to plot
  38816. </member>
  38817. <member name="T:NPOI.SS.UserModel.Charts.IAreaChartData`2">
  38818. <summary>
  38819. Data for an Area Chart
  38820. </summary>
  38821. </member>
  38822. <member name="M:NPOI.SS.UserModel.Charts.IAreaChartData`2.AddSeries(NPOI.SS.UserModel.Charts.IChartDataSource{`0},NPOI.SS.UserModel.Charts.IChartDataSource{`1})">
  38823. <summary>
  38824. Adds the series.
  38825. </summary>
  38826. <param name="categories">The categories data source.</param>
  38827. <param name="values">The values data source.</param>
  38828. <returns>Created series.</returns>
  38829. </member>
  38830. <member name="M:NPOI.SS.UserModel.Charts.IAreaChartData`2.GetSeries">
  38831. <summary>
  38832. Return list of all series.
  38833. </summary>
  38834. </member>
  38835. <member name="M:NPOI.SS.UserModel.Charts.IAreaChartSeries`2.GetCategoryAxisData">
  38836. <summary>
  38837. Return data source used for category axis data.
  38838. </summary>
  38839. </member>
  38840. <member name="M:NPOI.SS.UserModel.Charts.IAreaChartSeries`2.GetValues">
  38841. <summary>
  38842. Return data source used for value axis.
  38843. </summary>
  38844. </member>
  38845. <member name="T:NPOI.SS.UserModel.Charts.AxisCrossBetween">
  38846. Specifies the possible crossing states of an axis.
  38847. @author Roman Kashitsyn
  38848. </member>
  38849. <member name="F:NPOI.SS.UserModel.Charts.AxisCrossBetween.Between">
  38850. Specifies the value axis shall cross the category axis
  38851. between data markers.
  38852. </member>
  38853. <member name="F:NPOI.SS.UserModel.Charts.AxisCrossBetween.MidpointCategory">
  38854. Specifies the value axis shall cross the category axis at
  38855. the midpoint of a category.
  38856. </member>
  38857. <member name="T:NPOI.SS.UserModel.Charts.AxisCrosses">
  38858. Specifies the possible crossing points for an axis.
  38859. @author Roman Kashitsyn
  38860. </member>
  38861. <member name="F:NPOI.SS.UserModel.Charts.AxisCrosses.AutoZero">
  38862. The category axis crosses at the zero point of the value axis (if
  38863. possible), or the minimum value (if the minimum is greater than zero) or
  38864. the maximum (if the maximum is less than zero).
  38865. </member>
  38866. <member name="F:NPOI.SS.UserModel.Charts.AxisCrosses.Min">
  38867. The axis crosses at the maximum value.
  38868. </member>
  38869. <member name="F:NPOI.SS.UserModel.Charts.AxisCrosses.Max">
  38870. Axis crosses at the minimum value of the chart.
  38871. </member>
  38872. <member name="T:NPOI.SS.UserModel.Charts.AxisOrientation">
  38873. Specifies the possible ways to place a picture on a data point, series, wall, or floor.
  38874. @author Roman Kashitsyn
  38875. </member>
  38876. <member name="F:NPOI.SS.UserModel.Charts.AxisOrientation.MaxToMin">
  38877. Specifies that the values on the axis shall be reversed
  38878. so they go from maximum to minimum.
  38879. </member>
  38880. <member name="F:NPOI.SS.UserModel.Charts.AxisOrientation.MinToMax">
  38881. Specifies that the axis values shall be in the usual
  38882. order, minimum to maximum.
  38883. </member>
  38884. <member name="T:NPOI.SS.UserModel.Charts.AxisPosition">
  38885. Enumeration of all possible axis positions.
  38886. @author Roman Kashitsyn
  38887. </member>
  38888. <member name="T:NPOI.SS.UserModel.Charts.IBarChartData`2">
  38889. <summary>
  38890. Data for a Bar Chart
  38891. </summary>
  38892. <typeparam name="Tx"></typeparam>
  38893. <typeparam name="Ty"></typeparam>
  38894. </member>
  38895. <member name="M:NPOI.SS.UserModel.Charts.IBarChartData`2.AddSeries(NPOI.SS.UserModel.Charts.IChartDataSource{`0},NPOI.SS.UserModel.Charts.IChartDataSource{`1})">
  38896. <summary>
  38897. Adds the series.
  38898. </summary>
  38899. <param name="categories">The categories data source.</param>
  38900. <param name="values">The values data source.</param>
  38901. <returns>Created series.</returns>
  38902. </member>
  38903. <member name="M:NPOI.SS.UserModel.Charts.IBarChartData`2.GetSeries">
  38904. @return list of all series.
  38905. </member>
  38906. <member name="M:NPOI.SS.UserModel.Charts.IBarChartSeries`2.GetCategoryAxisData">
  38907. @return data source used for category axis data.
  38908. </member>
  38909. <member name="M:NPOI.SS.UserModel.Charts.IBarChartSeries`2.GetValues">
  38910. @return data source used for value axis.
  38911. </member>
  38912. <member name="T:NPOI.SS.UserModel.Charts.IChartAxis">
  38913. High level representation of chart axis.
  38914. @author Roman Kashitsyn
  38915. </member>
  38916. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Id">
  38917. @return axis id
  38918. </member>
  38919. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Position">
  38920. get or set axis position
  38921. </member>
  38922. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.NumberFormat">
  38923. get or set axis number format
  38924. </member>
  38925. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.IsSetLogBase">
  38926. @return true if log base is defined, false otherwise
  38927. </member>
  38928. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.LogBase">
  38929. @param logBase a number between 2 and 1000 (inclusive)
  38930. @return axis log base or 0.0 if not Set
  38931. @throws ArgumentException if log base not within allowed range
  38932. </member>
  38933. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.IsSetMinimum">
  38934. @return true if minimum value is defined, false otherwise
  38935. </member>
  38936. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Minimum">
  38937. get or set axis minimum
  38938. 0.0 if not Set
  38939. </member>
  38940. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.IsSetMaximum">
  38941. @return true if maximum value is defined, false otherwise
  38942. </member>
  38943. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Maximum">
  38944. get or set axis maximum
  38945. 0.0 if not Set
  38946. </member>
  38947. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Orientation">
  38948. get or set axis orientation
  38949. </member>
  38950. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Crosses">
  38951. get or set axis cross type
  38952. </member>
  38953. <member name="M:NPOI.SS.UserModel.Charts.IChartAxis.CrossAxis(NPOI.SS.UserModel.Charts.IChartAxis)">
  38954. Declare this axis cross another axis.
  38955. @param axis that this axis should cross
  38956. </member>
  38957. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.IsVisible">
  38958. @return visibility of the axis.
  38959. </member>
  38960. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.MajorTickMark">
  38961. @return major tick mark.
  38962. </member>
  38963. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.MinorTickMark">
  38964. @return minor tick mark.
  38965. </member>
  38966. <member name="T:NPOI.SS.UserModel.Charts.IChartAxisFactory">
  38967. <summary>
  38968. A factory for different chart axis.
  38969. </summary>
  38970. <remarks>@author Roman Kashitsyn</remarks>
  38971. </member>
  38972. <member name="M:NPOI.SS.UserModel.Charts.IChartAxisFactory.CreateValueAxis(NPOI.SS.UserModel.Charts.AxisPosition)">
  38973. <summary>
  38974. returns new value axis
  38975. </summary>
  38976. <param name="pos"></param>
  38977. <returns></returns>
  38978. </member>
  38979. <member name="T:NPOI.SS.UserModel.Charts.IChartData">
  38980. <summary>
  38981. A base for all chart data types.
  38982. </summary>
  38983. <remarks>
  38984. @author Roman Kashitsyn
  38985. </remarks>
  38986. </member>
  38987. <member name="M:NPOI.SS.UserModel.Charts.IChartData.FillChart(NPOI.SS.UserModel.IChart,NPOI.SS.UserModel.Charts.IChartAxis[])">
  38988. <summary>
  38989. Fills a chart with data specified by implementation.
  38990. </summary>
  38991. <param name="chart">a chart to fill in</param>
  38992. <param name="axis">chart axis to use</param>
  38993. </member>
  38994. <member name="T:NPOI.SS.UserModel.Charts.IChartDataFactory">
  38995. <summary>
  38996. A factory for different chart data types.
  38997. </summary>
  38998. <remarks>
  38999. @author Roman Kashitsyn
  39000. </remarks>
  39001. </member>
  39002. <member name="M:NPOI.SS.UserModel.Charts.IChartDataFactory.CreateScatterChartData``2">
  39003. <summary>
  39004. returns an appropriate ScatterChartData instance
  39005. </summary>
  39006. <returns></returns>
  39007. </member>
  39008. <member name="P:NPOI.SS.UserModel.Charts.IChartDataSource`1.PointCount">
  39009. Return number of points contained by data source.
  39010. @return number of points contained by data source
  39011. </member>
  39012. <member name="M:NPOI.SS.UserModel.Charts.IChartDataSource`1.GetPointAt(System.Int32)">
  39013. Returns point value at specified index.
  39014. @param index index to value from
  39015. @return point value at specified index.
  39016. @throws {@code IndexOutOfBoundsException} if index
  39017. parameter not in range {@code 0 &lt;= index &lt;= pointCount}
  39018. </member>
  39019. <member name="P:NPOI.SS.UserModel.Charts.IChartDataSource`1.IsReference">
  39020. Returns {@code true} if charts data source is valid cell range.
  39021. @return {@code true} if charts data source is valid cell range
  39022. </member>
  39023. <member name="P:NPOI.SS.UserModel.Charts.IChartDataSource`1.IsNumeric">
  39024. Returns {@code true} if data source points should be treated as numbers.
  39025. @return {@code true} if data source points should be treated as numbers
  39026. </member>
  39027. <member name="P:NPOI.SS.UserModel.Charts.IChartDataSource`1.FormulaString">
  39028. Returns formula representation of the data source. It is only applicable
  39029. for data source that is valid cell range.
  39030. @return formula representation of the data source
  39031. @throws {@code UnsupportedOperationException} if the data source is not a
  39032. reference.
  39033. </member>
  39034. <member name="T:NPOI.SS.UserModel.Charts.IChartLegend">
  39035. <summary>
  39036. High level representation of chart legend.
  39037. </summary>
  39038. <remarks>@author Roman Kashitsyn</remarks>
  39039. </member>
  39040. <member name="P:NPOI.SS.UserModel.Charts.IChartLegend.Position">
  39041. <summary>
  39042. legend position
  39043. </summary>
  39044. <returns></returns>
  39045. </member>
  39046. <member name="P:NPOI.SS.UserModel.Charts.IChartLegend.IsOverlay">
  39047. <summary>
  39048. If true the legend is positioned over the chart area otherwise
  39049. the legend is displayed next to it.
  39050. Default is no overlay.
  39051. </summary>
  39052. </member>
  39053. <member name="M:NPOI.SS.UserModel.Charts.IChartSeries.SetTitle(System.String)">
  39054. Sets the title of the series as a string literal.
  39055. @param title
  39056. </member>
  39057. <member name="M:NPOI.SS.UserModel.Charts.IChartSeries.SetTitle(NPOI.SS.Util.CellReference)">
  39058. Sets the title of the series as a cell reference.
  39059. @param titleReference
  39060. </member>
  39061. <member name="M:NPOI.SS.UserModel.Charts.IChartSeries.GetTitleString">
  39062. @return title as string literal.
  39063. </member>
  39064. <member name="M:NPOI.SS.UserModel.Charts.IChartSeries.GetTitleCellReference">
  39065. @return title as cell reference.
  39066. </member>
  39067. <member name="M:NPOI.SS.UserModel.Charts.IChartSeries.GetTitleType">
  39068. @return title type.
  39069. </member>
  39070. <member name="T:NPOI.SS.UserModel.Charts.IColumnChartData`2">
  39071. <summary>
  39072. Data for a Column Chart
  39073. </summary>
  39074. </member>
  39075. <member name="M:NPOI.SS.UserModel.Charts.IColumnChartData`2.AddSeries(NPOI.SS.UserModel.Charts.IChartDataSource{`0},NPOI.SS.UserModel.Charts.IChartDataSource{`1})">
  39076. <summary>
  39077. Adds the series.
  39078. </summary>
  39079. <param name="categories">The categories data source.</param>
  39080. <param name="values">The values data source.</param>
  39081. <returns>Created series.</returns>
  39082. </member>
  39083. <member name="M:NPOI.SS.UserModel.Charts.IColumnChartData`2.GetSeries">
  39084. <summary>
  39085. Returns list of all series.
  39086. </summary>
  39087. </member>
  39088. <member name="M:NPOI.SS.UserModel.Charts.IColumnChartSeries`2.GetCategoryAxisData">
  39089. <summary>
  39090. Return data source used for category axis data.
  39091. </summary>
  39092. </member>
  39093. <member name="M:NPOI.SS.UserModel.Charts.IColumnChartSeries`2.GetValues">
  39094. <summary>
  39095. Return data source used for value axis.
  39096. </summary>
  39097. </member>
  39098. <member name="T:NPOI.SS.UserModel.Charts.LayoutMode">
  39099. <summary>
  39100. Specifies the possible ways to store a chart element's position.
  39101. </summary>
  39102. <remarks>
  39103. @author Roman Kashitsyn
  39104. </remarks>
  39105. </member>
  39106. <member name="F:NPOI.SS.UserModel.Charts.LayoutMode.Edge">
  39107. <summary>
  39108. Specifies that the Width or Height shall be interpreted as the Right or Bottom of the chart element.
  39109. </summary>
  39110. </member>
  39111. <member name="F:NPOI.SS.UserModel.Charts.LayoutMode.Factor">
  39112. <summary>
  39113. Specifies that the Width or Height shall be interpreted as the width or Height of the chart element.
  39114. </summary>
  39115. </member>
  39116. <member name="T:NPOI.SS.UserModel.Charts.LayoutTarget">
  39117. <summary>
  39118. Specifies whether to layout the plot area by its inside (not including axis
  39119. and axis labels) or outside (including axis and axis labels).
  39120. </summary>
  39121. <remarks>
  39122. @author Roman Kashitsyn
  39123. </remarks>
  39124. </member>
  39125. <member name="F:NPOI.SS.UserModel.Charts.LayoutTarget.Inner">
  39126. <summary>
  39127. Specifies that the plot area size shall determine the size of the plot area, not including the tick marks and axis labels.
  39128. </summary>
  39129. </member>
  39130. <member name="F:NPOI.SS.UserModel.Charts.LayoutTarget.Outer">
  39131. <summary>
  39132. Specifies that the plot area size shall determine the
  39133. size of the plot area, the tick marks, and the axis
  39134. labels.
  39135. </summary>
  39136. </member>
  39137. <member name="T:NPOI.SS.UserModel.Charts.LegendPosition">
  39138. <summary>
  39139. Enumeration of all possible chart legend positions.
  39140. </summary>
  39141. <remarks>
  39142. @author Roman Kashitsyn
  39143. </remarks>
  39144. </member>
  39145. <member name="T:NPOI.SS.UserModel.Charts.ILineChartData`2">
  39146. <summary>
  39147. Data for a Line Chart
  39148. </summary>
  39149. <typeparam name="Tx"></typeparam>
  39150. <typeparam name="Ty"></typeparam>
  39151. </member>
  39152. <member name="M:NPOI.SS.UserModel.Charts.ILineChartData`2.GetSeries">
  39153. @return list of all series.
  39154. </member>
  39155. <member name="M:NPOI.SS.UserModel.Charts.ILineChartSeries`2.GetCategoryAxisData">
  39156. @return data source used for category axis data.
  39157. </member>
  39158. <member name="M:NPOI.SS.UserModel.Charts.ILineChartSeries`2.GetValues">
  39159. @return data source used for value axis.
  39160. </member>
  39161. <member name="T:NPOI.SS.UserModel.Charts.IManualLayout">
  39162. High level representation of chart element manual layout.
  39163. @author Roman Kashitsyn
  39164. </member>
  39165. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetTarget(NPOI.SS.UserModel.Charts.LayoutTarget)">
  39166. Sets the layout target.
  39167. @param target new layout target.
  39168. </member>
  39169. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetTarget">
  39170. Returns current layout target.
  39171. @return current layout target
  39172. </member>
  39173. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetXMode(NPOI.SS.UserModel.Charts.LayoutMode)">
  39174. Sets the x-coordinate layout mode.
  39175. @param mode new x-coordinate layout mode.
  39176. </member>
  39177. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetXMode">
  39178. Returns current x-coordinnate layout mode.
  39179. @return current x-coordinate layout mode.
  39180. </member>
  39181. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetYMode(NPOI.SS.UserModel.Charts.LayoutMode)">
  39182. Sets the y-coordinate layout mode.
  39183. @param mode new y-coordinate layout mode.
  39184. </member>
  39185. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetYMode">
  39186. Returns current y-coordinate layout mode.
  39187. @return current y-coordinate layout mode.
  39188. </member>
  39189. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetX">
  39190. Returns the x location of the chart element.
  39191. @return the x location (left) of the chart element or 0.0 if
  39192. not Set.
  39193. </member>
  39194. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetX(System.Double)">
  39195. Specifies the x location (left) of the chart element as a
  39196. fraction of the width of the chart. If Left Mode is Factor,
  39197. then the position is relative to the default position for the
  39198. chart element.
  39199. </member>
  39200. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetY">
  39201. Returns current y location of the chart element.
  39202. @return the y location (top) of the chart element or 0.0 if not
  39203. Set.
  39204. </member>
  39205. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetY(System.Double)">
  39206. Specifies the y location (top) of the chart element as a
  39207. fraction of the height of the chart. If Top Mode is Factor,
  39208. then the position is relative to the default position for the
  39209. chart element.
  39210. </member>
  39211. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetWidthMode(NPOI.SS.UserModel.Charts.LayoutMode)">
  39212. Specifies how to interpret the Width element for this manual
  39213. layout.
  39214. @param mode new width layout mode of this manual layout.
  39215. </member>
  39216. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetWidthMode">
  39217. Returns current width mode of this manual layout.
  39218. @return width mode of this manual layout.
  39219. </member>
  39220. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetHeightMode(NPOI.SS.UserModel.Charts.LayoutMode)">
  39221. Specifies how to interpret the Height element for this manual
  39222. layout.
  39223. @param mode new height mode of this manual layout.
  39224. </member>
  39225. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetHeightMode">
  39226. Returns current height mode of this
  39227. @return height mode of this manual layout.
  39228. </member>
  39229. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetWidthRatio(System.Double)">
  39230. Specifies the width (if Width Mode is Factor) or right (if
  39231. Width Mode is Edge) of the chart element as a fraction of the
  39232. width of the chart.
  39233. @param ratio a fraction of the width of the chart.
  39234. </member>
  39235. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetWidthRatio">
  39236. Returns current fraction of the width of the chart.
  39237. @return fraction of the width of the chart or 0.0 if not Set.
  39238. </member>
  39239. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetHeightRatio(System.Double)">
  39240. Specifies the height (if Height Mode is Factor) or bottom (if
  39241. Height Mode is edge) of the chart element as a fraction of the
  39242. height of the chart.
  39243. @param ratio a fraction of the height of the chart.
  39244. </member>
  39245. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetHeightRatio">
  39246. Returns current fraction of the height of the chart.
  39247. @return fraction of the height of the chart or 0.0 if not Set.
  39248. </member>
  39249. <member name="T:NPOI.SS.UserModel.Charts.ManuallyPositionable">
  39250. Abstraction of chart element that can be positioned with manual
  39251. layout.
  39252. @author Roman Kashitsyn
  39253. </member>
  39254. <member name="M:NPOI.SS.UserModel.Charts.ManuallyPositionable.GetManualLayout">
  39255. Returns manual layout for the chart element.
  39256. @return manual layout for the chart element.
  39257. </member>
  39258. <member name="T:NPOI.SS.UserModel.Charts.IPieChartData`2">
  39259. <summary>
  39260. Data for a Pie Chart
  39261. </summary>
  39262. </member>
  39263. <member name="M:NPOI.SS.UserModel.Charts.IPieChartData`2.AddSeries(NPOI.SS.UserModel.Charts.IChartDataSource{`0},NPOI.SS.UserModel.Charts.IChartDataSource{`1})">
  39264. <summary>
  39265. Adds the series.
  39266. </summary>
  39267. <param name="categories">The categories data source.</param>
  39268. <param name="values">The values data source.</param>
  39269. <returns>Created series.</returns>
  39270. </member>
  39271. <member name="M:NPOI.SS.UserModel.Charts.IPieChartData`2.GetSeries">
  39272. <summary>
  39273. Return list of all series.
  39274. </summary>
  39275. </member>
  39276. <member name="M:NPOI.SS.UserModel.Charts.IPieChartSeries`2.GetCategoryAxisData">
  39277. <summary>
  39278. Return data source used for category axis data.
  39279. </summary>
  39280. </member>
  39281. <member name="M:NPOI.SS.UserModel.Charts.IPieChartSeries`2.GetValues">
  39282. <summary>
  39283. Return data source used for value axis.
  39284. </summary>
  39285. </member>
  39286. <member name="T:NPOI.SS.UserModel.Charts.IScatterChartData`2">
  39287. Data for a Scatter Chart
  39288. </member>
  39289. <member name="M:NPOI.SS.UserModel.Charts.IScatterChartData`2.AddSeries(NPOI.SS.UserModel.Charts.IChartDataSource{`0},NPOI.SS.UserModel.Charts.IChartDataSource{`1})">
  39290. @param xs data source to be used for X axis values
  39291. @param ys data source to be used for Y axis values
  39292. @return a new scatter charts series
  39293. </member>
  39294. <member name="M:NPOI.SS.UserModel.Charts.IScatterChartData`2.GetSeries">
  39295. @return list of all series
  39296. </member>
  39297. <member name="T:NPOI.SS.UserModel.Charts.IScatterChartSeries`2">
  39298. Represents scatter charts serie.
  39299. @author Roman Kashitsyn
  39300. </member>
  39301. <member name="M:NPOI.SS.UserModel.Charts.IScatterChartSeries`2.GetXValues">
  39302. @return data source used for X axis values
  39303. </member>
  39304. <member name="M:NPOI.SS.UserModel.Charts.IScatterChartSeries`2.GetYValues">
  39305. @return data source used for Y axis values
  39306. </member>
  39307. <member name="T:NPOI.SS.UserModel.Charts.IValueAxis">
  39308. @author Roman Kashitsyn
  39309. </member>
  39310. <member name="M:NPOI.SS.UserModel.Charts.IValueAxis.GetCrossBetween">
  39311. @return cross between type
  39312. </member>
  39313. <member name="M:NPOI.SS.UserModel.Charts.IValueAxis.SetCrossBetween(NPOI.SS.UserModel.Charts.AxisCrossBetween)">
  39314. @param crossBetween cross between type
  39315. </member>
  39316. <member name="F:NPOI.SS.UserModel.AnchorType.MoveAndResize">
  39317. Move and Resize With Anchor Cells
  39318. <p>
  39319. Specifies that the current drawing shall move and
  39320. resize to maintain its row and column anchors (i.e. the
  39321. object is anchored to the actual from and to row and column)
  39322. </p>
  39323. </member>
  39324. <member name="F:NPOI.SS.UserModel.AnchorType.MoveDontResize">
  39325. Move With Cells but Do Not Resize
  39326. <p>
  39327. Specifies that the current drawing shall move with its
  39328. row and column (i.e. the object is anchored to the
  39329. actual from row and column), but that the size shall remain absolute.
  39330. </p>
  39331. <p>
  39332. If Additional rows/columns are Added between the from and to locations of the drawing,
  39333. the drawing shall move its to anchors as needed to maintain this same absolute size.
  39334. </p>
  39335. </member>
  39336. <member name="F:NPOI.SS.UserModel.AnchorType.DontMoveAndResize">
  39337. Do Not Move or Resize With Underlying Rows/Columns
  39338. <p>
  39339. Specifies that the current start and end positions shall
  39340. be maintained with respect to the distances from the
  39341. absolute start point of the worksheet.
  39342. </p>
  39343. <p>
  39344. If Additional rows/columns are Added before the
  39345. drawing, the drawing shall move its anchors as needed
  39346. to maintain this same absolute position.
  39347. </p>
  39348. </member>
  39349. <member name="T:NPOI.SS.UserModel.IClientAnchor">
  39350. A client anchor is attached to an excel worksheet. It anchors against a
  39351. top-left and bottom-right cell.
  39352. @author Yegor Kozlov
  39353. </member>
  39354. <member name="P:NPOI.SS.UserModel.IClientAnchor.Col1">
  39355. Returns the column (0 based) of the first cell.
  39356. @return 0-based column of the first cell.
  39357. </member>
  39358. <member name="P:NPOI.SS.UserModel.IClientAnchor.Col2">
  39359. Returns the column (0 based) of the second cell.
  39360. @return 0-based column of the second cell.
  39361. </member>
  39362. <member name="P:NPOI.SS.UserModel.IClientAnchor.Row1">
  39363. Returns the row (0 based) of the first cell.
  39364. @return 0-based row of the first cell.
  39365. </member>
  39366. <member name="P:NPOI.SS.UserModel.IClientAnchor.Row2">
  39367. Returns the row (0 based) of the second cell.
  39368. @return 0-based row of the second cell.
  39369. </member>
  39370. <member name="P:NPOI.SS.UserModel.IClientAnchor.Dx1">
  39371. Returns the x coordinate within the first cell
  39372. @return the x coordinate within the first cell
  39373. </member>
  39374. <member name="P:NPOI.SS.UserModel.IClientAnchor.Dy1">
  39375. Returns the y coordinate within the first cell
  39376. @return the y coordinate within the first cell
  39377. </member>
  39378. <member name="P:NPOI.SS.UserModel.IClientAnchor.Dy2">
  39379. Sets the y coordinate within the second cell
  39380. @return the y coordinate within the second cell
  39381. </member>
  39382. <member name="P:NPOI.SS.UserModel.IClientAnchor.Dx2">
  39383. Returns the x coordinate within the second cell
  39384. @return the x coordinate within the second cell
  39385. </member>
  39386. <member name="P:NPOI.SS.UserModel.IClientAnchor.AnchorType">
  39387. s the anchor type
  39388. <p>
  39389. 0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells.
  39390. </p>
  39391. @return the anchor type
  39392. @see #MOVE_AND_RESIZE
  39393. @see #MOVE_DONT_RESIZE
  39394. @see #DONT_MOVE_AND_RESIZE
  39395. </member>
  39396. <member name="T:NPOI.SS.UserModel.IColorScaleFormatting">
  39397. High level representation for the Color Scale / Colour Scale /
  39398. Color Gradient Formatting component of Conditional Formatting Settings
  39399. </member>
  39400. <!-- Badly formed XML comment ignored for member "P:NPOI.SS.UserModel.IColorScaleFormatting.NumControlPoints" -->
  39401. <member name="P:NPOI.SS.UserModel.IColorScaleFormatting.Colors">
  39402. get or sets the list of colours that are interpolated
  39403. between.The number must match {@link #getNumControlPoints()}
  39404. </member>
  39405. <member name="P:NPOI.SS.UserModel.IColorScaleFormatting.Thresholds">
  39406. Gets the list of thresholds
  39407. </member>
  39408. <member name="M:NPOI.SS.UserModel.IColorScaleFormatting.CreateThreshold">
  39409. Creates a new, empty Threshold
  39410. </member>
  39411. <member name="P:NPOI.SS.UserModel.IComment.Visible">
  39412. Sets whether this comment is visible.
  39413. @return <c>true</c> if the comment is visible, <c>false</c> otherwise
  39414. </member>
  39415. <member name="P:NPOI.SS.UserModel.IComment.Address">
  39416. <summary>
  39417. Get or set the address of the cell that this comment is attached to
  39418. </summary>
  39419. </member>
  39420. <member name="M:NPOI.SS.UserModel.IComment.SetAddress(System.Int32,System.Int32)">
  39421. Set the address of the cell that this comment is attached to
  39422. @param row
  39423. @param col
  39424. </member>
  39425. <member name="P:NPOI.SS.UserModel.IComment.Row">
  39426. Return the row of the cell that Contains the comment
  39427. @return the 0-based row of the cell that Contains the comment
  39428. </member>
  39429. <member name="P:NPOI.SS.UserModel.IComment.Column">
  39430. Return the column of the cell that Contains the comment
  39431. @return the 0-based column of the cell that Contains the comment
  39432. </member>
  39433. <member name="P:NPOI.SS.UserModel.IComment.Author">
  39434. Name of the original comment author
  39435. @return the name of the original author of the comment
  39436. </member>
  39437. <member name="P:NPOI.SS.UserModel.IComment.String">
  39438. Fetches the rich text string of the comment
  39439. </member>
  39440. <member name="P:NPOI.SS.UserModel.IComment.ClientAnchor">
  39441. Return defines position of this anchor in the sheet.
  39442. The anchor is the yellow box/balloon that is rendered on top of the sheets
  39443. when the comment is visible.
  39444. To associate a comment with a different cell, use {@link #setAddress}.
  39445. @return defines position of this anchor in the sheet
  39446. </member>
  39447. <member name="T:NPOI.SS.UserModel.ComparisonOperator">
  39448. The conditional format operators used for "Highlight Cells That Contain..." rules.
  39449. <p>
  39450. For example, "highlight cells that begin with "M2" and contain "Mountain Gear".
  39451. </p>
  39452. @author Dmitriy Kumshayev
  39453. @author Yegor Kozlov
  39454. </member>
  39455. <member name="F:NPOI.SS.UserModel.ComparisonOperator.Between">
  39456. 'Between' operator
  39457. </member>
  39458. <member name="F:NPOI.SS.UserModel.ComparisonOperator.NotBetween">
  39459. 'Not between' operator
  39460. </member>
  39461. <member name="F:NPOI.SS.UserModel.ComparisonOperator.Equal">
  39462. 'Equal to' operator
  39463. </member>
  39464. <member name="F:NPOI.SS.UserModel.ComparisonOperator.NotEqual">
  39465. 'Not equal to' operator
  39466. </member>
  39467. <member name="F:NPOI.SS.UserModel.ComparisonOperator.GreaterThan">
  39468. 'Greater than' operator
  39469. </member>
  39470. <member name="F:NPOI.SS.UserModel.ComparisonOperator.LessThan">
  39471. 'Less than' operator
  39472. </member>
  39473. <member name="F:NPOI.SS.UserModel.ComparisonOperator.GreaterThanOrEqual">
  39474. 'Greater than or equal to' operator
  39475. </member>
  39476. <member name="F:NPOI.SS.UserModel.ComparisonOperator.LessThanOrEqual">
  39477. 'Less than or equal to' operator
  39478. </member>
  39479. <member name="T:NPOI.SS.UserModel.IConditionalFormatting">
  39480. The ConditionalFormatting class encapsulates all Settings of Conditional Formatting.
  39481. The class can be used
  39482. <UL>
  39483. <LI>
  39484. to make a copy ConditionalFormatting Settings.
  39485. </LI>
  39486. For example:
  39487. <PRE>
  39488. ConditionalFormatting cf = sheet.GetConditionalFormattingAt(index);
  39489. newSheet.AddConditionalFormatting(cf);
  39490. </PRE>
  39491. <LI>
  39492. or to modify existing Conditional Formatting Settings (formatting regions and/or rules).
  39493. </LI>
  39494. </UL>
  39495. Use {@link NPOI.HSSF.UserModel.Sheet#getSheetConditionalFormatting()} to Get access to an instance of this class.
  39496. To create a new Conditional Formatting Set use the following approach:
  39497. <PRE>
  39498. // Define a Conditional Formatting rule, which triggers formatting
  39499. // when cell's value is greater or equal than 100.0 and
  39500. // applies patternFormatting defined below.
  39501. ConditionalFormattingRule rule = sheet.CreateConditionalFormattingRule(
  39502. ComparisonOperator.GE,
  39503. "100.0", // 1st formula
  39504. null // 2nd formula is not used for comparison operator GE
  39505. );
  39506. // Create pattern with red background
  39507. PatternFormatting patternFmt = rule.CretePatternFormatting();
  39508. patternFormatting.FillBackgroundColor(IndexedColor.RED.Index);
  39509. // Define a region Containing first column
  39510. Region [] regions =
  39511. {
  39512. new Region(1,(short)1,-1,(short)1)
  39513. };
  39514. // Apply Conditional Formatting rule defined above to the regions
  39515. sheet.AddConditionalFormatting(regions, rule);
  39516. </PRE>
  39517. @author Dmitriy Kumshayev
  39518. @author Yegor Kozlov
  39519. </member>
  39520. <member name="M:NPOI.SS.UserModel.IConditionalFormatting.GetFormattingRanges">
  39521. @return array of <c>CellRangeAddress</c>s. Never <code>null</code>
  39522. </member>
  39523. <member name="M:NPOI.SS.UserModel.IConditionalFormatting.SetRule(System.Int32,NPOI.SS.UserModel.IConditionalFormattingRule)">
  39524. Replaces an existing Conditional Formatting rule at position idx.
  39525. Excel allows to create up to 3 Conditional Formatting rules.
  39526. This method can be useful to modify existing Conditional Formatting rules.
  39527. @param idx position of the rule. Should be between 0 and 2.
  39528. @param cfRule - Conditional Formatting rule
  39529. </member>
  39530. <member name="M:NPOI.SS.UserModel.IConditionalFormatting.AddRule(NPOI.SS.UserModel.IConditionalFormattingRule)">
  39531. Add a Conditional Formatting rule.
  39532. Excel allows to create up to 3 Conditional Formatting rules.
  39533. @param cfRule - Conditional Formatting rule
  39534. </member>
  39535. <member name="M:NPOI.SS.UserModel.IConditionalFormatting.GetRule(System.Int32)">
  39536. @return the Conditional Formatting rule at position idx.
  39537. </member>
  39538. <member name="P:NPOI.SS.UserModel.IConditionalFormatting.NumberOfRules">
  39539. @return number of Conditional Formatting rules.
  39540. </member>
  39541. <member name="T:NPOI.SS.UserModel.IConditionalFormattingRule">
  39542. Represents a description of a conditional formatting rule
  39543. @author Dmitriy Kumshayev
  39544. @author Yegor Kozlov
  39545. </member>
  39546. <member name="M:NPOI.SS.UserModel.IConditionalFormattingRule.CreateBorderFormatting">
  39547. Create a new border formatting structure if it does not exist,
  39548. otherwise just return existing object.
  39549. @return - border formatting object, never returns <code>null</code>.
  39550. </member>
  39551. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.BorderFormatting">
  39552. @return - border formatting object if defined, <code>null</code> otherwise
  39553. </member>
  39554. <member name="M:NPOI.SS.UserModel.IConditionalFormattingRule.CreateFontFormatting">
  39555. Create a new font formatting structure if it does not exist,
  39556. otherwise just return existing object.
  39557. @return - font formatting object, never returns <code>null</code>.
  39558. </member>
  39559. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.FontFormatting">
  39560. @return - font formatting object if defined, <code>null</code> otherwise
  39561. </member>
  39562. <member name="M:NPOI.SS.UserModel.IConditionalFormattingRule.CreatePatternFormatting">
  39563. Create a new pattern formatting structure if it does not exist,
  39564. otherwise just return existing object.
  39565. @return - pattern formatting object, never returns <code>null</code>.
  39566. </member>
  39567. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.PatternFormatting">
  39568. @return - pattern formatting object if defined, <code>null</code> otherwise
  39569. </member>
  39570. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.DataBarFormatting">
  39571. @return - databar / data-bar formatting object if defined, <code>null</code> otherwise
  39572. </member>
  39573. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.MultiStateFormatting">
  39574. @return - icon / multi-state formatting object if defined, <code>null</code> otherwise
  39575. </member>
  39576. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.ColorScaleFormatting">
  39577. @return color scale / color grate formatting object if defined, <code>null</code> otherwise
  39578. </member>
  39579. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.ConditionType">
  39580. Type of conditional formatting rule.
  39581. <p>
  39582. MUST be either {@link #CONDITION_TYPE_CELL_VALUE_IS} or {@link #CONDITION_TYPE_FORMULA}
  39583. </p>
  39584. @return the type of condition
  39585. </member>
  39586. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.ComparisonOperation">
  39587. The comparison function used when the type of conditional formatting is Set to
  39588. {@link #CONDITION_TYPE_CELL_VALUE_IS}
  39589. <p>
  39590. MUST be a constant from {@link ComparisonOperator}
  39591. </p>
  39592. @return the conditional format operator
  39593. </member>
  39594. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.Formula1">
  39595. The formula used to Evaluate the first operand for the conditional formatting rule.
  39596. <p>
  39597. If the condition type is {@link #CONDITION_TYPE_CELL_VALUE_IS},
  39598. this field is the first operand of the comparison.
  39599. If type is {@link #CONDITION_TYPE_FORMULA}, this formula is used
  39600. to determine if the conditional formatting is applied.
  39601. </p>
  39602. <p>
  39603. If comparison type is {@link #CONDITION_TYPE_FORMULA} the formula MUST be a Boolean function
  39604. </p>
  39605. @return the first formula
  39606. </member>
  39607. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.Formula2">
  39608. The formula used to Evaluate the second operand of the comparison when
  39609. comparison type is {@link #CONDITION_TYPE_CELL_VALUE_IS} and operator
  39610. is either {@link ComparisonOperator#BETWEEN} or {@link ComparisonOperator#NOT_BETWEEN}
  39611. @return the second formula
  39612. </member>
  39613. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.Text">
  39614. <summary>
  39615. XSSF rules store textual condition values as an attribute and also as a formula that needs shifting. Using the attribute is simpler/faster.
  39616. HSSF rules don't have this and return null. We can fall back on the formula for those (AFAIK).
  39617. @return condition text if it exists, or null
  39618. </summary>
  39619. </member>
  39620. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.Priority">
  39621. <summary>
  39622. The priority of the rule, if defined, otherwise 0.
  39623. For XSSF, this should always be set.For HSSF, only newer style rules
  39624. have this set, older ones will return 0.
  39625. </summary>
  39626. <returns></returns>
  39627. </member>
  39628. <member name="T:NPOI.SS.UserModel.IConditionalFormattingThreshold">
  39629. The Threshold / CFVO / Conditional Formatting Value Object.
  39630. <p>This defines how to calculate the ranges for a conditional
  39631. formatting rule, eg which values Get a Green Traffic Light
  39632. icon and which Yellow or Red.</p>
  39633. </member>
  39634. <member name="P:NPOI.SS.UserModel.IConditionalFormattingThreshold.RangeType">
  39635. Get the Range Type used
  39636. </member>
  39637. <member name="P:NPOI.SS.UserModel.IConditionalFormattingThreshold.Formula">
  39638. Changes the Range Type used
  39639. <p>If you change the range type, you need to
  39640. ensure that the Formula and Value parameters
  39641. are compatible with it before saving</p>
  39642. Formula to use to calculate the threshold,
  39643. or <code>null</code> if no formula
  39644. </member>
  39645. <member name="P:NPOI.SS.UserModel.IConditionalFormattingThreshold.Value">
  39646. Sets the formula used to calculate the threshold,
  39647. or unsets it if <code>null</code> is given.
  39648. Gets the value used for the threshold, or
  39649. <code>null</code> if there isn't one.
  39650. </member>
  39651. <member name="F:NPOI.SS.UserModel.RangeType.NUMBER">
  39652. Number / Parameter
  39653. </member>
  39654. <member name="F:NPOI.SS.UserModel.RangeType.MIN">
  39655. The minimum value from the range
  39656. </member>
  39657. <member name="F:NPOI.SS.UserModel.RangeType.MAX">
  39658. The maximum value from the range
  39659. </member>
  39660. <member name="F:NPOI.SS.UserModel.RangeType.PERCENT">
  39661. Percent of the way from the mi to the max value in the range
  39662. </member>
  39663. <member name="F:NPOI.SS.UserModel.RangeType.PERCENTILE">
  39664. The minimum value of the cell that is in X percentile of the range
  39665. </member>
  39666. <member name="F:NPOI.SS.UserModel.RangeType.FORMULA">
  39667. Formula result
  39668. </member>
  39669. <member name="F:NPOI.SS.UserModel.RangeType.id">
  39670. Numeric ID of the type
  39671. </member>
  39672. <member name="F:NPOI.SS.UserModel.RangeType.name">
  39673. Name (system) of the type
  39674. </member>
  39675. <member name="P:NPOI.SS.UserModel.IConditionFilterData.AboveAverage">
  39676. @return true if the flag is missing or set to true
  39677. </member>
  39678. <member name="P:NPOI.SS.UserModel.IConditionFilterData.Bottom">
  39679. @return true if the flag is set
  39680. </member>
  39681. <member name="P:NPOI.SS.UserModel.IConditionFilterData.EqualAverage">
  39682. @return true if the flag is set
  39683. </member>
  39684. <member name="P:NPOI.SS.UserModel.IConditionFilterData.Percent">
  39685. @return true if the flag is set
  39686. </member>
  39687. <member name="P:NPOI.SS.UserModel.IConditionFilterData.Rank">
  39688. @return value, or 0 if not used/defined
  39689. </member>
  39690. <member name="P:NPOI.SS.UserModel.IConditionFilterData.StdDev">
  39691. @return value, or 0 if not used/defined
  39692. </member>
  39693. <member name="T:NPOI.SS.UserModel.ConditionType">
  39694. Represents a type of a conditional formatting rule
  39695. </member>
  39696. <member name="F:NPOI.SS.UserModel.ConditionType.CellValueIs">
  39697. This conditional formatting rule compares a cell value
  39698. to a formula calculated result, using an operator
  39699. </member>
  39700. <member name="F:NPOI.SS.UserModel.ConditionType.Formula">
  39701. This conditional formatting rule contains a formula to evaluate.
  39702. When the formula result is true, the cell is highlighted.
  39703. </member>
  39704. <member name="F:NPOI.SS.UserModel.ConditionType.ColorScale">
  39705. This conditional formatting rule contains a color scale,
  39706. with the cell background set according to a gradient.
  39707. </member>
  39708. <member name="F:NPOI.SS.UserModel.ConditionType.DataBar">
  39709. This conditional formatting rule sets a data bar, with the
  39710. cell populated with bars based on their values
  39711. </member>
  39712. <member name="F:NPOI.SS.UserModel.ConditionType.Filter">
  39713. This conditional formatting rule that files the values
  39714. </member>
  39715. <member name="F:NPOI.SS.UserModel.ConditionType.IconSet">
  39716. This conditional formatting rule sets a data bar, with the
  39717. cell populated with bars based on their values
  39718. </member>
  39719. <member name="T:NPOI.SS.UserModel.ICreationHelper">
  39720. An object that handles instantiating concrete
  39721. classes of the various instances one needs for
  39722. HSSF and XSSF.
  39723. Works around a major shortcoming in Java, where we
  39724. can't have static methods on interfaces or abstract
  39725. classes.
  39726. This allows you to get the appropriate class for
  39727. a given interface, without you having to worry
  39728. about if you're dealing with HSSF or XSSF, despite
  39729. Java being quite rubbish.
  39730. </member>
  39731. <member name="M:NPOI.SS.UserModel.ICreationHelper.CreateRichTextString(System.String)">
  39732. Creates a new RichTextString instance
  39733. @param text The text to Initialise the RichTextString with
  39734. </member>
  39735. <member name="M:NPOI.SS.UserModel.ICreationHelper.CreateDataFormat">
  39736. Creates a new DataFormat instance
  39737. </member>
  39738. <member name="M:NPOI.SS.UserModel.ICreationHelper.CreateHyperlink(NPOI.SS.UserModel.HyperlinkType)">
  39739. Creates a new Hyperlink, of the given type
  39740. </member>
  39741. <member name="M:NPOI.SS.UserModel.ICreationHelper.CreateFormulaEvaluator">
  39742. Creates FormulaEvaluator - an object that Evaluates formula cells.
  39743. @return a FormulaEvaluator instance
  39744. </member>
  39745. <member name="M:NPOI.SS.UserModel.ICreationHelper.CreateExtendedColor">
  39746. Creates a XSSF-style Color object, used for extended sheet
  39747. formattings and conditional formattings
  39748. </member>
  39749. <member name="T:NPOI.SS.UserModel.IDataBarFormatting">
  39750. High level representation for the DataBar Formatting
  39751. component of Conditional Formatting Settings
  39752. </member>
  39753. <member name="P:NPOI.SS.UserModel.IDataBarFormatting.IsLeftToRight">
  39754. Is the bar Drawn from Left-to-Right, or from
  39755. Right-to-Left
  39756. </member>
  39757. <member name="P:NPOI.SS.UserModel.IDataBarFormatting.IsIconOnly">
  39758. Should Icon + Value be displayed, or only the Icon?
  39759. </member>
  39760. <member name="P:NPOI.SS.UserModel.IDataBarFormatting.WidthMin">
  39761. How much of the cell width, in %, should be given to
  39762. the min value?
  39763. </member>
  39764. <member name="P:NPOI.SS.UserModel.IDataBarFormatting.WidthMax">
  39765. How much of the cell width, in %, should be given to
  39766. the max value?
  39767. </member>
  39768. <member name="P:NPOI.SS.UserModel.IDataBarFormatting.MinThreshold">
  39769. The threshold that defines "everything from here down is minimum"
  39770. </member>
  39771. <member name="P:NPOI.SS.UserModel.IDataBarFormatting.MaxThreshold">
  39772. The threshold that defines "everything from here up is maximum"
  39773. </member>
  39774. <member name="T:NPOI.SS.UserModel.DataConsolidateFunction">
  39775. Enum mapping the values of STDataConsolidateFunction
  39776. </member>
  39777. <member name="M:NPOI.SS.UserModel.IDataFormat.GetFormat(System.String)">
  39778. get the format index that matches the given format string.
  39779. Creates a new format if one is not found. Aliases text to the proper format.
  39780. @param format string matching a built in format
  39781. @return index of format.
  39782. </member>
  39783. <member name="M:NPOI.SS.UserModel.IDataFormat.GetFormat(System.Int16)">
  39784. get the format string that matches the given format index
  39785. @param index of a format
  39786. @return string represented at index of format or null if there is not a format at that index
  39787. </member>
  39788. <!-- Badly formed XML comment ignored for member "T:NPOI.SS.UserModel.DataFormatter" -->
  39789. <member name="F:NPOI.SS.UserModel.DataFormatter.numPattern">
  39790. Pattern to find a number FormatBase: "0" or "#"
  39791. </member>
  39792. <member name="F:NPOI.SS.UserModel.DataFormatter.amPmPattern">
  39793. Pattern to find "AM/PM" marker
  39794. </member>
  39795. <member name="F:NPOI.SS.UserModel.DataFormatter.localePatternGroup">
  39796. A regex to find patterns like [$$-1009] and [$�-452].
  39797. Note that we don't currently process these into locales
  39798. </member>
  39799. <member name="F:NPOI.SS.UserModel.DataFormatter.fractionPattern">
  39800. A regex to identify a fraction pattern.
  39801. This requires that replaceAll("\\?", "#") has already been called
  39802. </member>
  39803. <member name="F:NPOI.SS.UserModel.DataFormatter.fractionStripper">
  39804. A regex to strip junk out of fraction formats
  39805. </member>
  39806. <member name="F:NPOI.SS.UserModel.DataFormatter.alternateGrouping">
  39807. A regex to detect if an alternate grouping character is used
  39808. in a numeric format
  39809. </member>
  39810. <member name="F:NPOI.SS.UserModel.DataFormatter.invalidDateTimeString">
  39811. Cells formatted with a date or time format and which contain invalid date or time values
  39812. show 255 pound signs ("#").
  39813. </member>
  39814. <member name="F:NPOI.SS.UserModel.DataFormatter.decimalSymbols">
  39815. The decimal symbols of the locale used for formatting values.
  39816. </member>
  39817. <member name="F:NPOI.SS.UserModel.DataFormatter.dateSymbols">
  39818. The date symbols of the locale used for formatting values.
  39819. </member>
  39820. <member name="F:NPOI.SS.UserModel.DataFormatter.defaultDateformat">
  39821. A default date format, if no date format was given
  39822. </member>
  39823. <member name="F:NPOI.SS.UserModel.DataFormatter.generalNumberFormat">
  39824. <em>General</em> FormatBase for whole numbers.
  39825. </member>
  39826. <member name="F:NPOI.SS.UserModel.DataFormatter.defaultNumFormat">
  39827. A default FormatBase to use when a number pattern cannot be Parsed.
  39828. </member>
  39829. <member name="F:NPOI.SS.UserModel.DataFormatter.logger">
  39830. For logging any problems we find
  39831. </member>
  39832. <member name="F:NPOI.SS.UserModel.DataFormatter.localeIsAdapting">
  39833. stores if the locale should change according to {@link LocaleUtil#getUserLocale()}
  39834. </member>
  39835. <member name="M:NPOI.SS.UserModel.DataFormatter.#ctor(System.Boolean)">
  39836. Creates a formatter using the {@link Locale#getDefault() default locale}.
  39837. @param emulateCSV whether to emulate CSV output.
  39838. </member>
  39839. <member name="M:NPOI.SS.UserModel.DataFormatter.#ctor(System.Globalization.CultureInfo)">
  39840. Creates a formatter using the given locale.
  39841. </member>
  39842. <member name="M:NPOI.SS.UserModel.DataFormatter.#ctor(System.Globalization.CultureInfo,System.Boolean)">
  39843. Creates a formatter using the given locale.
  39844. @param emulateCSV whether to emulate CSV output.
  39845. </member>
  39846. <member name="M:NPOI.SS.UserModel.DataFormatter.#ctor(System.Globalization.CultureInfo,System.Boolean,System.Boolean)">
  39847. Constructor
  39848. </member>
  39849. <member name="M:NPOI.SS.UserModel.DataFormatter.GetFormat(NPOI.SS.UserModel.ICell)">
  39850. Return a FormatBase for the given cell if one exists, otherwise try to
  39851. Create one. This method will return <c>null</c> if the any of the
  39852. following is true:
  39853. <ul>
  39854. <li>the cell's style is null</li>
  39855. <li>the style's data FormatBase string is null or empty</li>
  39856. <li>the FormatBase string cannot be recognized as either a number or date</li>
  39857. </ul>
  39858. @param cell The cell to retrieve a FormatBase for
  39859. @return A FormatBase for the FormatBase String
  39860. </member>
  39861. <member name="M:NPOI.SS.UserModel.DataFormatter.CreateFormat(NPOI.SS.UserModel.ICell)">
  39862. Create and return a FormatBase based on the FormatBase string from a cell's
  39863. style. If the pattern cannot be Parsed, return a default pattern.
  39864. @param cell The Excel cell
  39865. @return A FormatBase representing the excel FormatBase. May return null.
  39866. </member>
  39867. <member name="M:NPOI.SS.UserModel.DataFormatter.GetDefaultFormat(NPOI.SS.UserModel.ICell)">
  39868. Returns a default FormatBase for a cell.
  39869. @param cell The cell
  39870. @return a default FormatBase
  39871. </member>
  39872. <member name="M:NPOI.SS.UserModel.DataFormatter.GetFormattedDateString(NPOI.SS.UserModel.ICell)">
  39873. Returns the Formatted value of an Excel date as a <c>String</c> based
  39874. on the cell's <c>DataFormat</c>. i.e. "Thursday, January 02, 2003"
  39875. , "01/02/2003" , "02-Jan" , etc.
  39876. @param cell The cell
  39877. @return a Formatted date string
  39878. </member>
  39879. <member name="M:NPOI.SS.UserModel.DataFormatter.GetFormattedNumberString(NPOI.SS.UserModel.ICell)">
  39880. Returns the Formatted value of an Excel number as a <c>String</c>
  39881. based on the cell's <c>DataFormat</c>. Supported Formats include
  39882. currency, percents, decimals, phone number, SSN, etc.:
  39883. "61.54%", "$100.00", "(800) 555-1234".
  39884. @param cell The cell
  39885. @return a Formatted number string
  39886. </member>
  39887. <member name="M:NPOI.SS.UserModel.DataFormatter.FormatRawCellContents(System.Double,System.Int32,System.String)">
  39888. Formats the given raw cell value, based on the supplied
  39889. FormatBase index and string, according to excel style rules.
  39890. @see #FormatCellValue(Cell)
  39891. </member>
  39892. <member name="M:NPOI.SS.UserModel.DataFormatter.PerformDateFormatting(System.DateTime,NPOI.SS.Util.FormatBase)">
  39893. Performs Excel-style date formatting, using the
  39894. supplied Date and format
  39895. </member>
  39896. <member name="M:NPOI.SS.UserModel.DataFormatter.FormatRawCellContents(System.Double,System.Int32,System.String,System.Boolean)">
  39897. Formats the given raw cell value, based on the supplied
  39898. format index and string, according to excel style rules.
  39899. @see #formatCellValue(Cell)
  39900. </member>
  39901. <member name="M:NPOI.SS.UserModel.DataFormatter.FormatCellValue(NPOI.SS.UserModel.ICell)">
  39902. Returns the Formatted value of a cell as a <c>String</c> regardless
  39903. of the cell type. If the Excel FormatBase pattern cannot be Parsed then the
  39904. cell value will be Formatted using a default FormatBase.
  39905. When passed a null or blank cell, this method will return an empty
  39906. String (""). Formulas in formula type cells will not be evaluated.
  39907. @param cell The cell
  39908. @return the Formatted cell value as a String
  39909. </member>
  39910. <member name="M:NPOI.SS.UserModel.DataFormatter.FormatCellValue(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.IFormulaEvaluator)">
  39911. Returns the Formatted value of a cell as a <c>String</c> regardless
  39912. of the cell type. If the Excel FormatBase pattern cannot be Parsed then the
  39913. cell value will be Formatted using a default FormatBase.
  39914. When passed a null or blank cell, this method will return an empty
  39915. String (""). Formula cells will be evaluated using the given
  39916. {@link HSSFFormulaEvaluator} if the evaluator is non-null. If the
  39917. evaluator is null, then the formula String will be returned. The caller
  39918. is responsible for setting the currentRow on the evaluator
  39919. @param cell The cell (can be null)
  39920. @param evaluator The HSSFFormulaEvaluator (can be null)
  39921. @return a string value of the cell
  39922. </member>
  39923. <member name="M:NPOI.SS.UserModel.DataFormatter.SetDefaultNumberFormat(NPOI.SS.Util.FormatBase)">
  39924. Sets a default number FormatBase to be used when the Excel FormatBase cannot be
  39925. Parsed successfully. <b>Note:</b> This is a fall back for when an error
  39926. occurs while parsing an Excel number FormatBase pattern. This will not
  39927. affect cells with the <em>General</em> FormatBase.
  39928. The value that will be passed to the FormatBase's FormatBase method (specified
  39929. by <c>java.text.FormatBase#FormatBase</c>) will be a double value from a
  39930. numeric cell. Therefore the code in the FormatBase method should expect a
  39931. <c>Number</c> value.
  39932. @param FormatBase A FormatBase instance to be used as a default
  39933. @see java.text.FormatBase#FormatBase
  39934. </member>
  39935. <member name="M:NPOI.SS.UserModel.DataFormatter.AddFormat(System.String,NPOI.SS.Util.FormatBase)">
  39936. Adds a new FormatBase to the available formats.
  39937. The value that will be passed to the FormatBase's FormatBase method (specified
  39938. by <c>java.text.FormatBase#FormatBase</c>) will be a double value from a
  39939. numeric cell. Therefore the code in the FormatBase method should expect a
  39940. <c>Number</c> value.
  39941. @param excelformatStr The data FormatBase string
  39942. @param FormatBase A FormatBase instance
  39943. </member>
  39944. <member name="M:NPOI.SS.UserModel.DataFormatter.Update(System.IObservable{System.Object},System.Object)">
  39945. Update formats when locale has been changed
  39946. @param observable usually this is our own Observable instance
  39947. @param localeObj only reacts on Locale objects
  39948. </member>
  39949. <member name="T:NPOI.SS.UserModel.DataFormatter.CellFormatResultWrapper">
  39950. Workaround until we merge {@link DataFormatter} with {@link CellFormat}.
  39951. Constant, non-cachable wrapper around a {@link CellFormatResult}
  39952. </member>
  39953. <member name="T:NPOI.SS.UserModel.ERRORSTYLE">
  39954. Error style constants for error box
  39955. </member>
  39956. <member name="F:NPOI.SS.UserModel.ERRORSTYLE.STOP">
  39957. STOP style
  39958. </member>
  39959. <member name="F:NPOI.SS.UserModel.ERRORSTYLE.WARNING">
  39960. WARNING style
  39961. </member>
  39962. <member name="F:NPOI.SS.UserModel.ERRORSTYLE.INFO">
  39963. INFO style
  39964. </member>
  39965. <member name="P:NPOI.SS.UserModel.IDataValidation.ErrorStyle">
  39966. <summary>
  39967. get or set the error style for error box
  39968. </summary>
  39969. </member>
  39970. <member name="P:NPOI.SS.UserModel.IDataValidation.EmptyCellAllowed">
  39971. <summary>
  39972. Setting this allows an empty object as a valid value. Retrieve the settings for empty cells allowed.
  39973. @return True if this object should treats empty as valid value , false otherwise
  39974. </summary>
  39975. <value><c>true</c> if this object should treats empty as valid value, <c>false</c> otherwise</value>
  39976. </member>
  39977. <member name="P:NPOI.SS.UserModel.IDataValidation.SuppressDropDownArrow">
  39978. <summary>
  39979. Useful for list validation objects .
  39980. Useful only list validation objects . This method always returns false if the object isn't a list validation object
  39981. </summary>
  39982. </member>
  39983. <member name="P:NPOI.SS.UserModel.IDataValidation.ShowPromptBox">
  39984. Sets the behaviour when a cell which belongs to this object is selected
  39985. <value><c>true</c> if an prompt box should be displayed , <c>false</c> otherwise</value>
  39986. </member>
  39987. <member name="P:NPOI.SS.UserModel.IDataValidation.ShowErrorBox">
  39988. Sets the behaviour when an invalid value is entered
  39989. <value><c>true</c> if an error box should be displayed , <c>false</c> otherwise</value>
  39990. </member>
  39991. <member name="M:NPOI.SS.UserModel.IDataValidation.CreatePromptBox(System.String,System.String)">
  39992. Sets the title and text for the prompt box . Prompt box is displayed when
  39993. the user selects a cell which belongs to this validation object . In
  39994. order for a prompt box to be displayed you should also use method
  39995. SetShowPromptBox( bool show )
  39996. @param title The prompt box's title
  39997. @param text The prompt box's text
  39998. </member>
  39999. <member name="P:NPOI.SS.UserModel.IDataValidation.PromptBoxTitle">
  40000. @return Prompt box's title or <code>null</code>
  40001. </member>
  40002. <member name="P:NPOI.SS.UserModel.IDataValidation.PromptBoxText">
  40003. @return Prompt box's text or <code>null</code>
  40004. </member>
  40005. <member name="M:NPOI.SS.UserModel.IDataValidation.CreateErrorBox(System.String,System.String)">
  40006. Sets the title and text for the error box . Error box is displayed when
  40007. the user enters an invalid value int o a cell which belongs to this
  40008. validation object . In order for an error box to be displayed you should
  40009. also use method SetShowErrorBox( bool show )
  40010. @param title The error box's title
  40011. @param text The error box's text
  40012. </member>
  40013. <member name="P:NPOI.SS.UserModel.IDataValidation.ErrorBoxTitle">
  40014. @return Error box's title or <code>null</code>
  40015. </member>
  40016. <member name="P:NPOI.SS.UserModel.IDataValidation.ErrorBoxText">
  40017. @return Error box's text or <code>null</code>
  40018. </member>
  40019. <member name="M:NPOI.SS.UserModel.IDataValidationConstraint.GetValidationType">
  40020. <summary>
  40021. return data validation type of this constraint
  40022. </summary>
  40023. <returns></returns>
  40024. </member>
  40025. <member name="P:NPOI.SS.UserModel.IDataValidationConstraint.Operator">
  40026. <summary>
  40027. get or set then comparison operator for this constraint
  40028. </summary>
  40029. </member>
  40030. <member name="P:NPOI.SS.UserModel.IDataValidationConstraint.ExplicitListValues">
  40031. <summary>
  40032. If validation type is {@link ValidationType#LIST}
  40033. and <code>formula1</code> was comma-separated literal values rather than a range or named range,
  40034. returns list of literal values.
  40035. Otherwise returns <code>null</code>.
  40036. </summary>
  40037. </member>
  40038. <member name="P:NPOI.SS.UserModel.IDataValidationConstraint.Formula1">
  40039. <summary>
  40040. get or set the formula for expression 1. May be <code>null</code>
  40041. </summary>
  40042. </member>
  40043. <member name="P:NPOI.SS.UserModel.IDataValidationConstraint.Formula2">
  40044. <summary>
  40045. get or set the formula for expression 2. May be <code>null</code>
  40046. </summary>
  40047. </member>
  40048. <member name="T:NPOI.SS.UserModel.ValidationType">
  40049. ValidationType enum
  40050. </member>
  40051. <member name="F:NPOI.SS.UserModel.ValidationType.ANY">
  40052. 'Any value' type - value not restricted
  40053. </member>
  40054. <member name="F:NPOI.SS.UserModel.ValidationType.INTEGER">
  40055. int ('Whole number') type
  40056. </member>
  40057. <member name="F:NPOI.SS.UserModel.ValidationType.DECIMAL">
  40058. Decimal type
  40059. </member>
  40060. <member name="F:NPOI.SS.UserModel.ValidationType.LIST">
  40061. List type ( combo box type )
  40062. </member>
  40063. <member name="F:NPOI.SS.UserModel.ValidationType.DATE">
  40064. Date type
  40065. </member>
  40066. <member name="F:NPOI.SS.UserModel.ValidationType.TIME">
  40067. Time type
  40068. </member>
  40069. <member name="F:NPOI.SS.UserModel.ValidationType.TEXT_LENGTH">
  40070. String length type
  40071. </member>
  40072. <member name="F:NPOI.SS.UserModel.ValidationType.FORMULA">
  40073. Formula ( 'Custom' ) type
  40074. </member>
  40075. <member name="T:NPOI.SS.UserModel.OperatorType">
  40076. Condition operator enum
  40077. </member>
  40078. <member name="F:NPOI.SS.UserModel.OperatorType.IGNORED">
  40079. default value to supply when the operator type is not used
  40080. </member>
  40081. <member name="T:NPOI.SS.UserModel.IDataValidationHelper">
  40082. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  40083. </member>
  40084. <member name="T:NPOI.SS.UserModel.DateUtil">
  40085. <summary>
  40086. Contains methods for dealing with Excel dates.
  40087. @author Michael Harhen
  40088. @author Glen Stampoultzis (glens at apache.org)
  40089. @author Dan Sherman (dsherman at Isisph.com)
  40090. @author Hack Kampbjorn (hak at 2mba.dk)
  40091. @author Alex Jacoby (ajacoby at gmail.com)
  40092. @author Pavel Krupets (pkrupets at palmtreebusiness dot com)
  40093. @author Thies Wellpott
  40094. </summary>
  40095. </member>
  40096. <member name="F:NPOI.SS.UserModel.DateUtil.date_ptrn1">
  40097. The following patterns are used in {@link #isADateFormat(int, String)}
  40098. </member>
  40099. <member name="M:NPOI.SS.UserModel.DateUtil.absoluteDay(System.DateTime,System.Boolean)">
  40100. <summary>
  40101. Given a Calendar, return the number of days since 1899/12/31.
  40102. </summary>
  40103. <param name="cal">the date</param>
  40104. <param name="use1904windowing">if set to <c>true</c> [use1904windowing].</param>
  40105. <returns>number of days since 1899/12/31</returns>
  40106. </member>
  40107. <member name="M:NPOI.SS.UserModel.DateUtil.DaysInPriorYears(System.Int32,System.Boolean)">
  40108. <summary>
  40109. Return the number of days in prior years since 1900
  40110. </summary>
  40111. <param name="yr">a year (1900 &lt; yr &gt; 4000).</param>
  40112. <param name="use1904windowing"></param>
  40113. <returns>number of days in years prior to yr</returns>
  40114. </member>
  40115. <member name="M:NPOI.SS.UserModel.DateUtil.GetExcelDate(System.DateTime)">
  40116. <summary>
  40117. Given a Date, Converts it into a double representing its internal Excel representation,
  40118. which Is the number of days since 1/1/1900. Fractional days represent hours, minutes, and seconds.
  40119. </summary>
  40120. <param name="date">Excel representation of Date (-1 if error - test for error by Checking for less than 0.1)</param>
  40121. <returns>the Date</returns>
  40122. </member>
  40123. <member name="M:NPOI.SS.UserModel.DateUtil.GetExcelDate(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean)">
  40124. <summary>
  40125. Gets the excel date.
  40126. </summary>
  40127. <param name="year">The year.</param>
  40128. <param name="month">The month.</param>
  40129. <param name="day">The day.</param>
  40130. <param name="hour">The hour.</param>
  40131. <param name="minute">The minute.</param>
  40132. <param name="second">The second.</param>
  40133. <param name="use1904windowing">Should 1900 or 1904 date windowing be used?</param>
  40134. <returns></returns>
  40135. </member>
  40136. <member name="M:NPOI.SS.UserModel.DateUtil.GetExcelDate(System.DateTime,System.Boolean)">
  40137. <summary>
  40138. Given a Date, Converts it into a double representing its internal Excel representation,
  40139. which Is the number of days since 1/1/1900. Fractional days represent hours, minutes, and seconds.
  40140. </summary>
  40141. <param name="date">The date.</param>
  40142. <param name="use1904windowing">Should 1900 or 1904 date windowing be used?</param>
  40143. <returns>Excel representation of Date (-1 if error - test for error by Checking for less than 0.1)</returns>
  40144. </member>
  40145. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaDate(System.Double)">
  40146. <summary>
  40147. Given an Excel date with using 1900 date windowing, and converts it to a java.util.Date.
  40148. Excel Dates and Times are stored without any timezone
  40149. information. If you know (through other means) that your file
  40150. uses a different TimeZone to the system default, you can use
  40151. this version of the getJavaDate() method to handle it.
  40152. </summary>
  40153. <param name="date">The Excel date.</param>
  40154. <returns>null if date is not a valid Excel date</returns>
  40155. </member>
  40156. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaDate(System.Double,System.Boolean)">
  40157. Given an Excel date with either 1900 or 1904 date windowing,
  40158. Converts it to a Date.
  40159. NOTE: If the default <c>TimeZone</c> in Java uses Daylight
  40160. Saving Time then the conversion back to an Excel date may not give
  40161. the same value, that Is the comparison
  40162. <CODE>excelDate == GetExcelDate(GetJavaDate(excelDate,false))</CODE>
  40163. Is not always true. For example if default timezone Is
  40164. <c>Europe/Copenhagen</c>, on 2004-03-28 the minute after
  40165. 01:59 CET Is 03:00 CEST, if the excel date represents a time between
  40166. 02:00 and 03:00 then it Is Converted to past 03:00 summer time
  40167. @param date The Excel date.
  40168. @param use1904windowing true if date uses 1904 windowing,
  40169. or false if using 1900 date windowing.
  40170. @return Java representation of the date, or null if date Is not a valid Excel date
  40171. @see TimeZone
  40172. </member>
  40173. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaDate(System.Double,System.Boolean,System.TimeZoneInfo)">
  40174. Given an Excel date with either 1900 or 1904 date windowing,
  40175. converts it to a java.util.Date.
  40176. Excel Dates and Times are stored without any timezone
  40177. information. If you know (through other means) that your file
  40178. uses a different TimeZone to the system default, you can use
  40179. this version of the getJavaDate() method to handle it.
  40180. @param date The Excel date.
  40181. @param tz The TimeZone to evaluate the date in
  40182. @param use1904windowing true if date uses 1904 windowing,
  40183. or false if using 1900 date windowing.
  40184. @return Java representation of the date, or null if date is not a valid Excel date
  40185. </member>
  40186. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaDate(System.Double,System.Boolean,System.TimeZone)">
  40187. Given an Excel date with either 1900 or 1904 date windowing,
  40188. converts it to a java.util.Date.
  40189. Excel Dates and Times are stored without any timezone
  40190. information. If you know (through other means) that your file
  40191. uses a different TimeZone to the system default, you can use
  40192. this version of the getJavaDate() method to handle it.
  40193. @param date The Excel date.
  40194. @param tz The TimeZone to evaluate the date in
  40195. @param use1904windowing true if date uses 1904 windowing,
  40196. or false if using 1900 date windowing.
  40197. @return Java representation of the date, or null if date is not a valid Excel date
  40198. </member>
  40199. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaDate(System.Double,System.Boolean,System.TimeZoneInfo,System.Boolean)">
  40200. Given an Excel date with either 1900 or 1904 date windowing,
  40201. converts it to a java.util.Date.
  40202. Excel Dates and Times are stored without any timezone
  40203. information. If you know (through other means) that your file
  40204. uses a different TimeZone to the system default, you can use
  40205. this version of the getJavaDate() method to handle it.
  40206. @param date The Excel date.
  40207. @param tz The TimeZone to evaluate the date in
  40208. @param use1904windowing true if date uses 1904 windowing,
  40209. or false if using 1900 date windowing.
  40210. @param roundSeconds round to closest second
  40211. @return Java representation of the date, or null if date is not a valid Excel date
  40212. </member>
  40213. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaDate(System.Double,System.Boolean,System.TimeZone,System.Boolean)">
  40214. Given an Excel date with either 1900 or 1904 date windowing,
  40215. converts it to a java.util.Date.
  40216. Excel Dates and Times are stored without any timezone
  40217. information. If you know (through other means) that your file
  40218. uses a different TimeZone to the system default, you can use
  40219. this version of the getJavaDate() method to handle it.
  40220. @param date The Excel date.
  40221. @param tz The TimeZone to evaluate the date in
  40222. @param use1904windowing true if date uses 1904 windowing,
  40223. or false if using 1900 date windowing.
  40224. @param roundSeconds round to closest second
  40225. @return Java representation of the date, or null if date is not a valid Excel date
  40226. </member>
  40227. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaCalendar(System.Double,System.Boolean)">
  40228. Get EXCEL date as Java Calendar with given time zone.
  40229. @param date The Excel date.
  40230. @param use1904windowing true if date uses 1904 windowing,
  40231. or false if using 1900 date windowing.
  40232. @param timeZone The TimeZone to evaluate the date in
  40233. @return Java representation of the date, or null if date is not a valid Excel date
  40234. </member>
  40235. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaCalendar(System.Double,System.Boolean,System.TimeZoneInfo,System.Boolean)">
  40236. <summary>
  40237. Get EXCEL date as Java Calendar (with default time zone). This is like GetJavaDate(double, boolean) but returns a Calendar object.
  40238. </summary>
  40239. <param name="date">The Excel date.</param>
  40240. <param name="use1904windowing">true if date uses 1904 windowing, or false if using 1900 date windowing.</param>
  40241. <param name="timeZone"></param>
  40242. <param name="roundSeconds"></param>
  40243. <returns>null if date is not a valid Excel date</returns>
  40244. </member>
  40245. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaCalendar(System.Double,System.Boolean,System.TimeZone,System.Boolean)">
  40246. <summary>
  40247. Get EXCEL date as Java Calendar (with default time zone). This is like GetJavaDate(double, boolean) but returns a Calendar object.
  40248. </summary>
  40249. <param name="date">The Excel date.</param>
  40250. <param name="use1904windowing">true if date uses 1904 windowing, or false if using 1900 date windowing.</param>
  40251. <param name="timeZone"></param>
  40252. <param name="roundSeconds"></param>
  40253. <returns>null if date is not a valid Excel date</returns>
  40254. </member>
  40255. <member name="M:NPOI.SS.UserModel.DateUtil.ConvertTime(System.String)">
  40256. <summary>
  40257. Converts a string of format "HH:MM" or "HH:MM:SS" to its (Excel) numeric equivalent
  40258. </summary>
  40259. <param name="timeStr">The time STR.</param>
  40260. <returns> a double between 0 and 1 representing the fraction of the day</returns>
  40261. </member>
  40262. <member name="M:NPOI.SS.UserModel.DateUtil.ConvertTimeInternal(System.String)">
  40263. <summary>
  40264. Converts the time internal.
  40265. </summary>
  40266. <param name="timeStr">The time STR.</param>
  40267. <returns></returns>
  40268. </member>
  40269. <member name="M:NPOI.SS.UserModel.DateUtil.IsADateFormat(System.Int32,System.String)">
  40270. <summary>
  40271. Given a format ID and its format String, will Check to see if the
  40272. format represents a date format or not.
  40273. Firstly, it will Check to see if the format ID corresponds to an
  40274. internal excel date format (eg most US date formats)
  40275. If not, it will Check to see if the format string only Contains
  40276. date formatting Chars (ymd-/), which covers most
  40277. non US date formats.
  40278. </summary>
  40279. <param name="formatIndex">The index of the format, eg from ExtendedFormatRecord.GetFormatIndex</param>
  40280. <param name="formatString">The format string, eg from FormatRecord.GetFormatString</param>
  40281. <returns>
  40282. <c>true</c> if [is A date format] [the specified format index]; otherwise, <c>false</c>.
  40283. </returns>
  40284. </member>
  40285. <member name="M:NPOI.SS.UserModel.DateUtil.ParseYYYYMMDDDate(System.String)">
  40286. <summary>
  40287. Converts a string of format "YYYY/MM/DD" to its (Excel) numeric equivalent
  40288. </summary>
  40289. <param name="dateStr">The date STR.</param>
  40290. <returns>a double representing the (integer) number of days since the start of the Excel epoch</returns>
  40291. </member>
  40292. <member name="M:NPOI.SS.UserModel.DateUtil.ParseYYYYMMDDDateInternal(System.String)">
  40293. <summary>
  40294. Parses the YYYYMMDD date internal.
  40295. </summary>
  40296. <param name="timeStr">The time string.</param>
  40297. <returns></returns>
  40298. </member>
  40299. <member name="M:NPOI.SS.UserModel.DateUtil.ParseInt(System.String,System.String,System.Int32)">
  40300. <summary>
  40301. Parses the int.
  40302. </summary>
  40303. <param name="strVal">The string value.</param>
  40304. <param name="fieldName">Name of the field.</param>
  40305. <param name="rangeMax">The range max.</param>
  40306. <returns></returns>
  40307. </member>
  40308. <member name="M:NPOI.SS.UserModel.DateUtil.ParseInt(System.String,System.String,System.Int32,System.Int32)">
  40309. <summary>
  40310. Parses the int.
  40311. </summary>
  40312. <param name="strVal">The STR val.</param>
  40313. <param name="fieldName">Name of the field.</param>
  40314. <param name="lowerLimit">The lower limit.</param>
  40315. <param name="upperLimit">The upper limit.</param>
  40316. <returns></returns>
  40317. </member>
  40318. <member name="M:NPOI.SS.UserModel.DateUtil.IsInternalDateFormat(System.Int32)">
  40319. <summary>
  40320. Given a format ID this will Check whether the format represents an internal excel date format or not.
  40321. </summary>
  40322. <param name="format">The format.</param>
  40323. </member>
  40324. <member name="M:NPOI.SS.UserModel.DateUtil.IsCellDateFormatted(NPOI.SS.UserModel.ICell)">
  40325. <summary>
  40326. Check if a cell Contains a date
  40327. Since dates are stored internally in Excel as double values
  40328. we infer it Is a date if it Is formatted as such.
  40329. </summary>
  40330. <param name="cell">The cell.</param>
  40331. </member>
  40332. <member name="M:NPOI.SS.UserModel.DateUtil.IsCellInternalDateFormatted(NPOI.SS.UserModel.ICell)">
  40333. <summary>
  40334. Check if a cell contains a date, Checking only for internal excel date formats.
  40335. As Excel stores a great many of its dates in "non-internal" date formats, you will not normally want to use this method.
  40336. </summary>
  40337. <param name="cell">The cell.</param>
  40338. </member>
  40339. <member name="M:NPOI.SS.UserModel.DateUtil.IsValidExcelDate(System.Double)">
  40340. <summary>
  40341. Given a double, Checks if it Is a valid Excel date.
  40342. </summary>
  40343. <param name="value">the double value.</param>
  40344. <returns>
  40345. <c>true</c> if [is valid excel date] [the specified value]; otherwise, <c>false</c>.
  40346. </returns>
  40347. </member>
  40348. <member name="T:NPOI.SS.UserModel.IDrawing">
  40349. @author Yegor Kozlov
  40350. </member>
  40351. <member name="M:NPOI.SS.UserModel.IDrawing.CreatePicture(NPOI.SS.UserModel.IClientAnchor,System.Int32)">
  40352. Creates a picture.
  40353. @param anchor the client anchor describes how this picture is
  40354. attached to the sheet.
  40355. @param pictureIndex the index of the picture in the workbook collection
  40356. of pictures.
  40357. @return the newly created picture.
  40358. </member>
  40359. <member name="M:NPOI.SS.UserModel.IDrawing.CreateCellComment(NPOI.SS.UserModel.IClientAnchor)">
  40360. Creates a comment.
  40361. @param anchor the client anchor describes how this comment is attached
  40362. to the sheet.
  40363. @return the newly created comment.
  40364. </member>
  40365. <member name="M:NPOI.SS.UserModel.IDrawing.CreateChart(NPOI.SS.UserModel.IClientAnchor)">
  40366. Creates a chart.
  40367. @param anchor the client anchor describes how this chart is attached to
  40368. the sheet.
  40369. @return the newly created chart
  40370. </member>
  40371. <member name="M:NPOI.SS.UserModel.IDrawing.CreateAnchor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  40372. Creates a new client anchor and sets the top-left and bottom-right
  40373. coordinates of the anchor.
  40374. @param dx1 the x coordinate in EMU within the first cell.
  40375. @param dy1 the y coordinate in EMU within the first cell.
  40376. @param dx2 the x coordinate in EMU within the second cell.
  40377. @param dy2 the y coordinate in EMU within the second cell.
  40378. @param col1 the column (0 based) of the first cell.
  40379. @param row1 the row (0 based) of the first cell.
  40380. @param col2 the column (0 based) of the second cell.
  40381. @param row2 the row (0 based) of the second cell.
  40382. @return the newly created client anchor
  40383. </member>
  40384. <member name="T:NPOI.SS.UserModel.Drawing.MSOFillType">
  40385. <summary>
  40386. the type of fill to display with the shape or the background of the slide.
  40387. </summary>
  40388. </member>
  40389. <member name="F:NPOI.SS.UserModel.Drawing.MSOFillType.Solid">
  40390. <summary>
  40391. A solid fill
  40392. </summary>
  40393. </member>
  40394. <member name="F:NPOI.SS.UserModel.Drawing.MSOFillType.Pattern">
  40395. <summary>
  40396. A patterned fill
  40397. </summary>
  40398. </member>
  40399. <member name="F:NPOI.SS.UserModel.Drawing.MSOFillType.Texture">
  40400. <summary>
  40401. A textured fill
  40402. </summary>
  40403. </member>
  40404. <member name="F:NPOI.SS.UserModel.Drawing.MSOFillType.Picture">
  40405. <summary>
  40406. A picture fill
  40407. </summary>
  40408. </member>
  40409. <member name="F:NPOI.SS.UserModel.Drawing.MSOFillType.Shade">
  40410. <summary>
  40411. A gradient fill that starts and ends with defined endpoints
  40412. </summary>
  40413. </member>
  40414. <member name="F:NPOI.SS.UserModel.Drawing.MSOFillType.ShadeCenter">
  40415. <summary>
  40416. A gradient fill that starts and ends based on the bounds of the shape
  40417. </summary>
  40418. </member>
  40419. <member name="F:NPOI.SS.UserModel.Drawing.MSOFillType.ShadeShape">
  40420. <summary>
  40421. A gradient fill that starts on the outline of the shape and ends at a point defined within the shape
  40422. </summary>
  40423. </member>
  40424. <member name="F:NPOI.SS.UserModel.Drawing.MSOFillType.ShadeScale">
  40425. <summary>
  40426. A gradient fill that starts on the outline of the shape and ends at a point defined within the shape.
  40427. The fill angle is scaled by the aspect ratio of the shape
  40428. </summary>
  40429. </member>
  40430. <member name="F:NPOI.SS.UserModel.Drawing.MSOFillType.ShadeTitle">
  40431. <summary>
  40432. A gradient fill interpreted by the host application
  40433. </summary>
  40434. </member>
  40435. <member name="F:NPOI.SS.UserModel.Drawing.MSOFillType.Background">
  40436. <summary>
  40437. A fill that matches the background fill
  40438. </summary>
  40439. </member>
  40440. <member name="T:NPOI.SS.UserModel.ExcelGeneralNumberFormat">
  40441. A format that formats a double as Excel would, ignoring FieldPosition.
  40442. All other operations are unsupported.
  40443. </member>
  40444. <member name="T:NPOI.SS.UserModel.ExcelStyleDateFormatter">
  40445. A wrapper around a {@link SimpleDateFormat} instance,
  40446. which handles a few Excel-style extensions that
  40447. are not supported by {@link SimpleDateFormat}.
  40448. Currently, the extensions are around the handling
  40449. of elapsed time, eg rendering 1 day 2 hours
  40450. as 26 hours.
  40451. </member>
  40452. <member name="M:NPOI.SS.UserModel.ExcelStyleDateFormatter.ProcessFormatPattern(System.String)">
  40453. Takes a format String, and Replaces Excel specific bits
  40454. with our detection sequences
  40455. </member>
  40456. <member name="M:NPOI.SS.UserModel.ExcelStyleDateFormatter.SetDateToBeFormatted(System.Double)">
  40457. Used to let us know what the date being
  40458. formatted is, in Excel terms, which we
  40459. may wish to use when handling elapsed
  40460. times.
  40461. </member>
  40462. <member name="T:NPOI.SS.UserModel.ExtendedColor">
  40463. Represents a XSSF-style color (based on either a
  40464. {@link NPOI.XSSF.UserModel.XSSFColor} or a
  40465. {@link NPOI.HSSF.Record.Common.ExtendedColor}
  40466. </member>
  40467. <member name="P:NPOI.SS.UserModel.ExtendedColor.IsAuto">
  40468. A bool value indicating the color is automatic
  40469. </member>
  40470. <member name="P:NPOI.SS.UserModel.ExtendedColor.IsIndexed">
  40471. A bool value indicating the color is indexed
  40472. </member>
  40473. <member name="P:NPOI.SS.UserModel.ExtendedColor.IsRGB">
  40474. A bool value indicating the color is RGB / ARGB
  40475. </member>
  40476. <member name="P:NPOI.SS.UserModel.ExtendedColor.IsThemed">
  40477. A bool value indicating the color is from a Theme
  40478. </member>
  40479. <member name="P:NPOI.SS.UserModel.ExtendedColor.Index">
  40480. Indexed Color value, if {@link #isIndexed()} is true
  40481. </member>
  40482. <member name="P:NPOI.SS.UserModel.ExtendedColor.Theme">
  40483. Index of Theme color, if {@link #isThemed()} is true
  40484. </member>
  40485. <member name="P:NPOI.SS.UserModel.ExtendedColor.RGB">
  40486. Standard Red Green Blue ctColor value (RGB).
  40487. If there was an A (Alpha) value, it will be stripped.
  40488. </member>
  40489. <member name="P:NPOI.SS.UserModel.ExtendedColor.ARGB">
  40490. Standard Alpha Red Green Blue ctColor value (ARGB).
  40491. </member>
  40492. <member name="P:NPOI.SS.UserModel.ExtendedColor.StoredRGB">
  40493. RGB or ARGB or null
  40494. </member>
  40495. <member name="P:NPOI.SS.UserModel.ExtendedColor.RGBWithTint">
  40496. Standard Red Green Blue ctColor value (RGB) with applied tint.
  40497. Alpha values are ignored.
  40498. </member>
  40499. <member name="P:NPOI.SS.UserModel.ExtendedColor.ARGBHex">
  40500. Return the ARGB value in hex format, eg FF00FF00.
  40501. Works for both regular and indexed colours.
  40502. Sets the ARGB value from hex format, eg FF0077FF.
  40503. Only works for regular (non-indexed) colours
  40504. </member>
  40505. <member name="P:NPOI.SS.UserModel.ExtendedColor.Tint">
  40506. Specifies the tint value applied to the ctColor.
  40507. <p>
  40508. If tint is supplied, then it is applied to the RGB value of the ctColor to determine the final
  40509. ctColor applied.
  40510. </p>
  40511. <p>
  40512. The tint value is stored as a double from -1.0 .. 1.0, where -1.0 means 100% darken and
  40513. 1.0 means 100% lighten. Also, 0.0 means no Change.
  40514. </p>
  40515. <p>
  40516. In loading the RGB value, it is Converted to HLS where HLS values are (0..HLSMAX), where
  40517. HLSMAX is currently 255.
  40518. </p>
  40519. Here are some examples of how to apply tint to ctColor:
  40520. <blockquote>
  40521. <pre>
  40522. If (tint &lt; 0)
  40523. Lum' = Lum * (1.0 + tint)
  40524. For example: Lum = 200; tint = -0.5; Darken 50%
  40525. Lum' = 200 * (0.5) =&gt; 100
  40526. For example: Lum = 200; tint = -1.0; Darken 100% (make black)
  40527. Lum' = 200 * (1.0-1.0) =&gt; 0
  40528. If (tint &gt; 0)
  40529. Lum' = Lum * (1.0-tint) + (HLSMAX - HLSMAX * (1.0-tint))
  40530. For example: Lum = 100; tint = 0.75; Lighten 75%
  40531. Lum' = 100 * (1-.75) + (HLSMAX - HLSMAX*(1-.75))
  40532. = 100 * .25 + (255 - 255 * .25)
  40533. = 25 + (255 - 63) = 25 + 192 = 217
  40534. For example: Lum = 100; tint = 1.0; Lighten 100% (make white)
  40535. Lum' = 100 * (1-1) + (HLSMAX - HLSMAX*(1-1))
  40536. = 100 * 0 + (255 - 255 * 0)
  40537. = 0 + (255 - 0) = 255
  40538. </pre>
  40539. </blockquote>
  40540. @return the tint value
  40541. </member>
  40542. <member name="T:NPOI.SS.UserModel.FillPattern">
  40543. The enumeration value indicating the style of fill pattern being used for a cell format.
  40544. </member>
  40545. <member name="F:NPOI.SS.UserModel.FillPattern.NoFill">
  40546. No background
  40547. </member>
  40548. <member name="F:NPOI.SS.UserModel.FillPattern.SolidForeground">
  40549. Solidly Filled
  40550. </member>
  40551. <member name="F:NPOI.SS.UserModel.FillPattern.FineDots">
  40552. Small fine dots
  40553. </member>
  40554. <member name="F:NPOI.SS.UserModel.FillPattern.AltBars">
  40555. Wide dots
  40556. </member>
  40557. <member name="F:NPOI.SS.UserModel.FillPattern.SparseDots">
  40558. Sparse dots
  40559. </member>
  40560. <member name="F:NPOI.SS.UserModel.FillPattern.ThickHorizontalBands">
  40561. Thick horizontal bands
  40562. </member>
  40563. <member name="F:NPOI.SS.UserModel.FillPattern.ThickVerticalBands">
  40564. Thick vertical bands
  40565. </member>
  40566. <member name="F:NPOI.SS.UserModel.FillPattern.ThickBackwardDiagonals">
  40567. Thick backward facing diagonals
  40568. </member>
  40569. <member name="F:NPOI.SS.UserModel.FillPattern.ThickForwardDiagonals">
  40570. Thick forward facing diagonals
  40571. </member>
  40572. <member name="F:NPOI.SS.UserModel.FillPattern.BigSpots">
  40573. Large spots
  40574. </member>
  40575. <member name="F:NPOI.SS.UserModel.FillPattern.Bricks">
  40576. Brick-like layout
  40577. </member>
  40578. <member name="F:NPOI.SS.UserModel.FillPattern.ThinHorizontalBands">
  40579. Thin horizontal bands
  40580. </member>
  40581. <member name="F:NPOI.SS.UserModel.FillPattern.ThinVerticalBands">
  40582. Thin vertical bands
  40583. </member>
  40584. <member name="F:NPOI.SS.UserModel.FillPattern.ThinBackwardDiagonals">
  40585. Thin backward diagonal
  40586. </member>
  40587. <member name="F:NPOI.SS.UserModel.FillPattern.ThinForwardDiagonals">
  40588. Thin forward diagonal
  40589. </member>
  40590. <member name="F:NPOI.SS.UserModel.FillPattern.Squares">
  40591. Squares
  40592. </member>
  40593. <member name="F:NPOI.SS.UserModel.FillPattern.Diamonds">
  40594. Diamonds
  40595. </member>
  40596. <member name="F:NPOI.SS.UserModel.FillPattern.LessDots">
  40597. Less Dots
  40598. </member>
  40599. <member name="F:NPOI.SS.UserModel.FillPattern.LeastDots">
  40600. Least Dots
  40601. </member>
  40602. <member name="F:NPOI.SS.UserModel.FontUnderlineType.None">
  40603. not underlined
  40604. </member>
  40605. <member name="F:NPOI.SS.UserModel.FontUnderlineType.Single">
  40606. single (normal) underline
  40607. </member>
  40608. <member name="F:NPOI.SS.UserModel.FontUnderlineType.Double">
  40609. double underlined
  40610. </member>
  40611. <member name="F:NPOI.SS.UserModel.FontUnderlineType.SingleAccounting">
  40612. accounting style single underline
  40613. </member>
  40614. <member name="F:NPOI.SS.UserModel.FontUnderlineType.DoubleAccounting">
  40615. accounting style double underline
  40616. </member>
  40617. <member name="F:NPOI.SS.UserModel.FontSuperScript.None">
  40618. no type Offsetting (not super or subscript)
  40619. </member>
  40620. <member name="F:NPOI.SS.UserModel.FontSuperScript.Super">
  40621. superscript
  40622. </member>
  40623. <member name="F:NPOI.SS.UserModel.FontSuperScript.Sub">
  40624. subscript
  40625. </member>
  40626. <member name="F:NPOI.SS.UserModel.FontColor.None">
  40627. <summary>
  40628. Allow accessing the Initial value.
  40629. </summary>
  40630. </member>
  40631. <member name="F:NPOI.SS.UserModel.FontColor.Normal">
  40632. normal type of black color.
  40633. </member>
  40634. <member name="F:NPOI.SS.UserModel.FontColor.Red">
  40635. Dark Red color
  40636. </member>
  40637. <member name="F:NPOI.SS.UserModel.FontBoldWeight.None">
  40638. <summary>
  40639. Allow accessing the Initial value.
  40640. </summary>
  40641. </member>
  40642. <member name="F:NPOI.SS.UserModel.FontBoldWeight.Normal">
  40643. Normal boldness (not bold)
  40644. </member>
  40645. <member name="F:NPOI.SS.UserModel.FontBoldWeight.Bold">
  40646. Bold boldness (bold)
  40647. </member>
  40648. <member name="P:NPOI.SS.UserModel.IFont.FontName">
  40649. <summary>
  40650. get the name for the font (i.e. Arial)
  40651. </summary>
  40652. </member>
  40653. <member name="P:NPOI.SS.UserModel.IFont.FontHeight">
  40654. <summary>
  40655. Get the font height in unit's of 1/20th of a point.
  40656. </summary>
  40657. <remarks>
  40658. Maybe you might want to use the GetFontHeightInPoints which matches to the familiar 10, 12, 14 etc..
  40659. </remarks>
  40660. <see cref="P:NPOI.SS.UserModel.IFont.FontHeightInPoints"/>
  40661. </member>
  40662. <member name="P:NPOI.SS.UserModel.IFont.FontHeightInPoints">
  40663. <summary>
  40664. Get the font height in points.
  40665. </summary>
  40666. <remarks>
  40667. This will return the same font height that is shown in Excel, such as 10 or 14 or 28.
  40668. </remarks>
  40669. <see cref="P:NPOI.SS.UserModel.IFont.FontHeight"/>
  40670. </member>
  40671. <member name="P:NPOI.SS.UserModel.IFont.IsItalic">
  40672. <summary>
  40673. get whether to use italics or not
  40674. </summary>
  40675. </member>
  40676. <member name="P:NPOI.SS.UserModel.IFont.IsStrikeout">
  40677. <summary>
  40678. get whether to use a strikeout horizontal line through the text or not
  40679. </summary>
  40680. </member>
  40681. <member name="P:NPOI.SS.UserModel.IFont.Color">
  40682. get the color for the font
  40683. @return color to use
  40684. @see #COLOR_NORMAL
  40685. @see #COLOR_RED
  40686. @see NPOI.HSSF.usermodel.HSSFPalette#GetColor(short)
  40687. </member>
  40688. <member name="P:NPOI.SS.UserModel.IFont.TypeOffset">
  40689. <summary>
  40690. get type of text underlining to use
  40691. </summary>
  40692. </member>
  40693. <member name="P:NPOI.SS.UserModel.IFont.Underline">
  40694. <summary>
  40695. get type of text underlining to use
  40696. </summary>
  40697. </member>
  40698. <member name="P:NPOI.SS.UserModel.IFont.Charset">
  40699. <summary>
  40700. get character-set to use.
  40701. </summary>
  40702. <value>ANSI_CHARSET,DEFAULT_CHARSET,SYMBOL_CHARSET </value>
  40703. </member>
  40704. <member name="P:NPOI.SS.UserModel.IFont.Index">
  40705. <summary>
  40706. get the index within the Workbook (sequence within the collection of Font objects)
  40707. </summary>
  40708. </member>
  40709. <member name="M:NPOI.SS.UserModel.IFont.CloneStyleFrom(NPOI.SS.UserModel.IFont)">
  40710. <summary>
  40711. Copies the style from another font into this one
  40712. </summary>
  40713. </member>
  40714. <member name="T:NPOI.SS.UserModel.FontCharset">
  40715. Charset represents the basic set of characters associated with a font (that it can display), and
  40716. corresponds to the ANSI codepage (8-bit or DBCS) of that character set used by a given language.
  40717. @author Gisella Bronzetti
  40718. </member>
  40719. <member name="P:NPOI.SS.UserModel.FontCharset.Value">
  40720. Returns value of this charset
  40721. @return value of this charset
  40722. </member>
  40723. <member name="T:NPOI.SS.UserModel.FontFamily">
  40724. The font family this font belongs to. A font family is a set of fonts having common stroke width and serif
  40725. characteristics. The font name overrides when there are conflicting values.
  40726. @author Gisella Bronzetti
  40727. </member>
  40728. <member name="P:NPOI.SS.UserModel.FontFamily.Value">
  40729. Returns index of this font family
  40730. @return index of this font family
  40731. </member>
  40732. <member name="T:NPOI.SS.UserModel.IFontFormatting">
  40733. High level representation for Font Formatting component
  40734. of Conditional Formatting Settings
  40735. @author Dmitriy Kumshayev
  40736. @author Yegor Kozlov
  40737. </member>
  40738. <member name="P:NPOI.SS.UserModel.IFontFormatting.EscapementType">
  40739. <summary>
  40740. get or set the type of super or subscript for the font
  40741. </summary>
  40742. </member>
  40743. <member name="P:NPOI.SS.UserModel.IFontFormatting.FontColorIndex">
  40744. <summary>
  40745. get or set font color index
  40746. </summary>
  40747. </member>
  40748. <member name="P:NPOI.SS.UserModel.IFontFormatting.FontColor">
  40749. <summary>
  40750. get or set the colour of the font, or null if no colour applied
  40751. </summary>
  40752. </member>
  40753. <member name="P:NPOI.SS.UserModel.IFontFormatting.FontHeight">
  40754. <summary>
  40755. get or set the height of the font in 1/20th point units
  40756. </summary>
  40757. </member>
  40758. <member name="P:NPOI.SS.UserModel.IFontFormatting.UnderlineType">
  40759. <summary>
  40760. get or set the type of underlining for the font
  40761. </summary>
  40762. </member>
  40763. <member name="P:NPOI.SS.UserModel.IFontFormatting.IsBold">
  40764. Get whether the font weight is Set to bold or not
  40765. @return bold - whether the font is bold or not
  40766. </member>
  40767. <member name="P:NPOI.SS.UserModel.IFontFormatting.IsItalic">
  40768. @return true if font style was Set to <i>italic</i>
  40769. </member>
  40770. <member name="M:NPOI.SS.UserModel.IFontFormatting.SetFontStyle(System.Boolean,System.Boolean)">
  40771. Set font style options.
  40772. @param italic - if true, Set posture style to italic, otherwise to normal
  40773. @param bold if true, Set font weight to bold, otherwise to normal
  40774. </member>
  40775. <member name="M:NPOI.SS.UserModel.IFontFormatting.ResetFontStyle">
  40776. Set font style options to default values (non-italic, non-bold)
  40777. </member>
  40778. <member name="T:NPOI.SS.UserModel.FontScheme">
  40779. Defines the font scheme to which this font belongs.
  40780. When a font defInition is part of a theme defInition, then the font is categorized as either a major or minor font scheme component.
  40781. When a new theme is chosen, every font that is part of a theme defInition is updated to use the new major or minor font defInition for that
  40782. theme.
  40783. Usually major fonts are used for styles like headings, and minor fonts are used for body and paragraph text.
  40784. @author Gisella Bronzetti
  40785. </member>
  40786. <member name="T:NPOI.SS.UserModel.FontUnderline">
  40787. the different types of possible underline formatting
  40788. @author Gisella Bronzetti
  40789. </member>
  40790. <member name="F:NPOI.SS.UserModel.FontUnderline.SINGLE">
  40791. Single-line underlining under each character in the cell.
  40792. The underline is drawn through the descenders of
  40793. characters such as g and p..
  40794. </member>
  40795. <member name="F:NPOI.SS.UserModel.FontUnderline.DOUBLE">
  40796. Double-line underlining under each character in the
  40797. cell. underlines are drawn through the descenders of
  40798. characters such as g and p.
  40799. </member>
  40800. <member name="F:NPOI.SS.UserModel.FontUnderline.SINGLE_ACCOUNTING">
  40801. Single-line accounting underlining under each
  40802. character in the cell. The underline is drawn under the
  40803. descenders of characters such as g and p.
  40804. </member>
  40805. <member name="F:NPOI.SS.UserModel.FontUnderline.DOUBLE_ACCOUNTING">
  40806. Double-line accounting underlining under each
  40807. character in the cell. The underlines are drawn under
  40808. the descenders of characters such as g and p.
  40809. </member>
  40810. <member name="F:NPOI.SS.UserModel.FontUnderline.NONE">
  40811. No underline.
  40812. </member>
  40813. <member name="T:NPOI.SS.UserModel.IFooter">
  40814. <summary>
  40815. Common defInition of a HSSF or XSSF page footer.
  40816. For a list of all the different fields that can be
  40817. placed into a footer, such as page number,
  40818. bold, underline etc, see
  40819. </summary>
  40820. </member>
  40821. <member name="T:NPOI.SS.UserModel.FormulaErrorEnum">
  40822. Enumerates error values in SpreadsheetML formula calculations.
  40823. See also OOO's excelfileformat.pdf (2.5.6)
  40824. </member>
  40825. <member name="F:NPOI.SS.UserModel.FormulaError.NULL">
  40826. Intended to indicate when two areas are required to intersect, but do not.
  40827. <p>Example:
  40828. In the case of SUM(B1 C1), the space between B1 and C1 is treated as the binary
  40829. intersection operator, when a comma was intended. end example]
  40830. </p>
  40831. </member>
  40832. <member name="F:NPOI.SS.UserModel.FormulaError.DIV0">
  40833. Intended to indicate when any number, including zero, is divided by zero.
  40834. Note: However, any error code divided by zero results in that error code.
  40835. </member>
  40836. <member name="F:NPOI.SS.UserModel.FormulaError.VALUE">
  40837. Intended to indicate when an incompatible type argument is passed to a function, or
  40838. an incompatible type operand is used with an operator.
  40839. <p>Example:
  40840. In the case of a function argument, text was expected, but a number was provided
  40841. </p>
  40842. </member>
  40843. <member name="F:NPOI.SS.UserModel.FormulaError.REF">
  40844. Intended to indicate when a cell reference is invalid.
  40845. <p>Example:
  40846. If a formula Contains a reference to a cell, and then the row or column Containing that cell is deleted,
  40847. a #REF! error results. If a worksheet does not support 20,001 columns,
  40848. OFFSET(A1,0,20000) will result in a #REF! error.
  40849. </p>
  40850. </member>
  40851. <member name="F:NPOI.SS.UserModel.FormulaError.NUM">
  40852. Intended to indicate when an argument to a function has a compatible type, but has a
  40853. value that is outside the domain over which that function is defined. (This is known as
  40854. a domain error.)
  40855. <p>Example:
  40856. Certain calls to ASIN, ATANH, FACT, and SQRT might result in domain errors.
  40857. </p>
  40858. Intended to indicate that the result of a function cannot be represented in a value of
  40859. the specified type, typically due to extreme magnitude. (This is known as a range
  40860. error.)
  40861. <p>Example: FACT(1000) might result in a range error. </p>
  40862. </member>
  40863. <member name="F:NPOI.SS.UserModel.FormulaError.NA">
  40864. Intended to indicate when a designated value is not available.
  40865. <p>Example:
  40866. Some functions, such as SUMX2MY2, perform a series of operations on corresponding
  40867. elements in two arrays. If those arrays do not have the same number of elements, then
  40868. for some elements in the longer array, there are no corresponding elements in the
  40869. shorter one; that is, one or more values in the shorter array are not available.
  40870. </p>
  40871. This error value can be produced by calling the function NA
  40872. </member>
  40873. <member name="F:NPOI.SS.UserModel.FormulaError.CIRCULAR_REF">
  40874. POI specific code to indicate that there is a circular reference
  40875. in the formula
  40876. </member>
  40877. <member name="F:NPOI.SS.UserModel.FormulaError.FUNCTION_NOT_IMPLEMENTED">
  40878. POI specific code to indicate that the funcition required is
  40879. not implemented in POI
  40880. </member>
  40881. <member name="P:NPOI.SS.UserModel.FormulaError.Code">
  40882. @return numeric code of the error
  40883. </member>
  40884. <member name="P:NPOI.SS.UserModel.FormulaError.LongCode">
  40885. @return long (internal) numeric code of the error
  40886. </member>
  40887. <member name="P:NPOI.SS.UserModel.FormulaError.String">
  40888. @return string representation of the error
  40889. </member>
  40890. <member name="T:NPOI.SS.UserModel.IFormulaEvaluator">
  40891. Evaluates formula cells.<p/>
  40892. For performance reasons, this class keeps a cache of all previously calculated intermediate
  40893. cell values. Be sure to call {@link #ClearAllCachedResultValues()} if any workbook cells are Changed between
  40894. calls to Evaluate~ methods on this class.
  40895. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  40896. @author Josh Micich
  40897. </member>
  40898. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.ClearAllCachedResultValues">
  40899. Should be called whenever there are Changes to input cells in the Evaluated workbook.
  40900. Failure to call this method after changing cell values will cause incorrect behaviour
  40901. of the Evaluate~ methods of this class
  40902. </member>
  40903. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.NotifySetFormula(NPOI.SS.UserModel.ICell)">
  40904. Should be called to tell the cell value cache that the specified (value or formula) cell
  40905. has Changed.
  40906. Failure to call this method after changing cell values will cause incorrect behaviour
  40907. of the Evaluate~ methods of this class
  40908. </member>
  40909. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.NotifyDeleteCell(NPOI.SS.UserModel.ICell)">
  40910. Should be called to tell the cell value cache that the specified cell has just become a
  40911. formula cell, or the formula text has Changed
  40912. </member>
  40913. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.NotifyUpdateCell(NPOI.SS.UserModel.ICell)">
  40914. Should be called to tell the cell value cache that the specified (value or formula) cell
  40915. has changed.
  40916. Failure to call this method after changing cell values will cause incorrect behaviour
  40917. of the evaluate~ methods of this class
  40918. </member>
  40919. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.Evaluate(NPOI.SS.UserModel.ICell)">
  40920. If cell Contains a formula, the formula is Evaluated and returned,
  40921. else the CellValue simply copies the appropriate cell value from
  40922. the cell and also its cell type. This method should be preferred over
  40923. EvaluateInCell() when the call should not modify the contents of the
  40924. original cell.
  40925. @param cell
  40926. </member>
  40927. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.EvaluateAll">
  40928. Loops over all cells in all sheets of the associated workbook.
  40929. For cells that contain formulas, their formulas are evaluated,
  40930. and the results are saved. These cells remain as formula cells.
  40931. For cells that do not contain formulas, no changes are made.
  40932. This is a helpful wrapper around looping over all cells, and
  40933. calling evaluateFormulaCell on each one.
  40934. </member>
  40935. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.EvaluateFormulaCell(NPOI.SS.UserModel.ICell)">
  40936. If cell Contains formula, it Evaluates the formula,
  40937. and saves the result of the formula. The cell
  40938. remains as a formula cell.
  40939. Else if cell does not contain formula, this method leaves
  40940. the cell unChanged.
  40941. Note that the type of the formula result is returned,
  40942. so you know what kind of value is also stored with
  40943. the formula.
  40944. <pre>
  40945. int EvaluatedCellType = Evaluator.evaluateFormulaCell(cell);
  40946. </pre>
  40947. Be aware that your cell will hold both the formula,
  40948. and the result. If you want the cell Replaced with
  40949. the result of the formula, use {@link #EvaluateInCell(Cell)}
  40950. @param cell The cell to Evaluate
  40951. @return The type of the formula result, i.e. -1 if the cell is not a formula,
  40952. or one of Cell.CELL_TYPE_NUMERIC, Cell.CELL_TYPE_STRING, Cell.CELL_TYPE_BOOLEAN, Cell.CELL_TYPE_ERROR
  40953. Note: the cell's type remains as Cell.CELL_TYPE_FORMULA however.
  40954. </member>
  40955. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.EvaluateInCell(NPOI.SS.UserModel.ICell)">
  40956. If cell Contains formula, it Evaluates the formula, and
  40957. Puts the formula result back into the cell, in place
  40958. of the old formula.
  40959. Else if cell does not contain formula, this method leaves
  40960. the cell unChanged.
  40961. Note that the same instance of Cell is returned to
  40962. allow chained calls like:
  40963. <pre>
  40964. int EvaluatedCellType = Evaluator.evaluateInCell(cell).getCellType();
  40965. </pre>
  40966. Be aware that your cell value will be Changed to hold the
  40967. result of the formula. If you simply want the formula
  40968. value comPuted for you, use {@link #EvaluateFormulaCell(Cell)}
  40969. @param cell
  40970. </member>
  40971. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.SetupReferencedWorkbooks(System.Collections.Generic.Dictionary{System.String,NPOI.SS.UserModel.IFormulaEvaluator})">
  40972. Sets up the Formula Evaluator to be able to reference and resolve
  40973. links to other workbooks, eg [Test.xls]Sheet1!A1.
  40974. For a workbook referenced as [Test.xls]Sheet1!A1, you should
  40975. supply a map containing the key Test.xls (no square brackets),
  40976. and an open FormulaEvaluator onto that Workbook.
  40977. @param otherWorkbooks Map of workbook names (no square brackets) to an evaluator on that workbook
  40978. </member>
  40979. <member name="P:NPOI.SS.UserModel.IFormulaEvaluator.IgnoreMissingWorkbooks">
  40980. Whether to ignore missing references to external workbooks and
  40981. use cached formula results in the main workbook instead.
  40982. <br/>
  40983. In some cases external workbooks referenced by formulas in the main workbook are not available.
  40984. With this method you can control how POI handles such missing references:
  40985. <ul>
  40986. <li>by default ignoreMissingWorkbooks=false and POI throws
  40987. {@link org.apache.poi.ss.formula.CollaboratingWorkbooksEnvironment.WorkbookNotFoundException}
  40988. if an external reference cannot be resolved</li>
  40989. <li>if ignoreMissingWorkbooks=true then POI uses cached formula result
  40990. that already exists in the main workbook</li>
  40991. </ul>
  40992. @param ignore whether to ignore missing references to external workbooks
  40993. </member>
  40994. <member name="P:NPOI.SS.UserModel.IFormulaEvaluator.DebugEvaluationOutputForNextEval">
  40995. * Perform detailed output of formula evaluation for next evaluation only?
  40996. * Is for developer use only (also developers using POI for their XLS files).
  40997. * Log-Level WARN is for basic info, INFO for detailed information. These quite
  40998. * high levels are used because you have to explicitly enable this specific logging.
  40999. * @param value whether to perform detailed output
  41000. </member>
  41001. <member name="T:NPOI.SS.UserModel.FractionFormat">
  41002. <p>Format class that handles Excel style fractions, such as "# #/#" and "#/###"</p>
  41003. <p>As of this writing, this is still not 100% accurate, but it does a reasonable job
  41004. of trying to mimic Excel's fraction calculations. It does not currently
  41005. maintain Excel's spacing.</p>
  41006. <p>This class relies on a method lifted nearly verbatim from org.apache.math.fraction.
  41007. If further uses for Commons Math are found, we will consider Adding it as a dependency.
  41008. For now, we have in-lined the one method to keep things simple.</p>
  41009. </member>
  41010. <member name="M:NPOI.SS.UserModel.FractionFormat.#ctor(System.String,System.String)">
  41011. Single parameter ctor
  41012. @param denomFormatString The format string for the denominator
  41013. </member>
  41014. <member name="T:NPOI.SS.UserModel.IHeader">
  41015. <summary>
  41016. Common defInition of a HSSF or XSSF page header.
  41017. For a list of all the different fields that can be
  41018. placed into a header, such as page number,
  41019. bold, underline etc, see
  41020. </summary>
  41021. </member>
  41022. <member name="T:NPOI.SS.UserModel.IHeaderFooter">
  41023. <summary>
  41024. Common interface for NPOI.SS.UserModel.Header and NPOI.SS.UserModel.Footer
  41025. </summary>
  41026. </member>
  41027. <member name="P:NPOI.SS.UserModel.IHeaderFooter.Left">
  41028. <summary>
  41029. Gets or sets the left side of the header or footer.
  41030. </summary>
  41031. <value>The string representing the left side.</value>
  41032. </member>
  41033. <member name="P:NPOI.SS.UserModel.IHeaderFooter.Center">
  41034. <summary>
  41035. Gets or sets the center of the header or footer.
  41036. </summary>
  41037. <value>The string representing the center.</value>
  41038. </member>
  41039. <member name="P:NPOI.SS.UserModel.IHeaderFooter.Right">
  41040. <summary>
  41041. Gets or sets the right side of the header or footer.
  41042. </summary>
  41043. <value>The string representing the right side.</value>
  41044. </member>
  41045. <member name="M:NPOI.SS.UserModel.Helpers.BaseRowColShifter.updateFormulas(NPOI.SS.Formula.FormulaShifter)">
  41046. Update formulas.
  41047. </member>
  41048. <member name="M:NPOI.SS.UserModel.Helpers.BaseRowColShifter.shiftMergedRegions(System.Int32,System.Int32,System.Int32)">
  41049. Shifts, grows, or shrinks the merged regions due to a row shift
  41050. ({@link RowShifter}) or column shift ({@link ColumnShifter}).
  41051. Merged regions that are completely overlaid by shifting will be deleted.
  41052. @param start the first row or column to be shifted
  41053. @param end the last row or column to be shifted
  41054. @param n the number of rows or columns to shift
  41055. @return a list of affected merged regions, excluding contain deleted ones
  41056. </member>
  41057. <member name="M:NPOI.SS.UserModel.Helpers.BaseRowColShifter.updateConditionalFormatting(NPOI.SS.Formula.FormulaShifter)">
  41058. Update conditional formatting
  41059. @param formulaShifter The {@link FormulaShifter} to use
  41060. </member>
  41061. <member name="M:NPOI.SS.UserModel.Helpers.BaseRowColShifter.updateHyperlinks(NPOI.SS.Formula.FormulaShifter)">
  41062. Shift the Hyperlink anchors (not the hyperlink text, even if the hyperlink
  41063. is of type LINK_DOCUMENT and refers to a cell that was shifted). Hyperlinks
  41064. do not track the content they point to.
  41065. @param formulaShifter the formula shifting policy
  41066. </member>
  41067. <member name="T:NPOI.SS.UserModel.Helpers.RowShifter">
  41068. <summary>
  41069. Helper for Shifting rows up or down
  41070. This abstract class exists to consolidate duplicated code between XSSFRowShifter
  41071. and HSSFRowShifter(currently methods sprinkled throughout HSSFSheet)
  41072. </summary>
  41073. </member>
  41074. <member name="M:NPOI.SS.UserModel.Helpers.RowShifter.ShiftMergedRegions(System.Int32,System.Int32,System.Int32)">
  41075. <summary>
  41076. Shifts, grows, or shrinks the merged regions due to a row Shift.
  41077. Merged regions that are completely overlaid by Shifting will be deleted.
  41078. </summary>
  41079. <param name="startRow">the row to start Shifting</param>
  41080. <param name="endRow">the row to end Shifting</param>
  41081. <param name="n">the number of rows to shift</param>
  41082. <returns>an array of affected merged regions, doesn't contain deleted ones</returns>
  41083. </member>
  41084. <member name="M:NPOI.SS.UserModel.Helpers.RowShifter.ValidateShiftParameters(System.Int32,System.Int32,System.Int32)">
  41085. <summary>
  41086. Verify that the given column indices and step denote a valid range of columns to shift
  41087. </summary>
  41088. <param name="firstShiftColumnIndex">the column to start shifting</param>
  41089. <param name="lastShiftColumnIndex">the column to end shifting</param>
  41090. <param name="step">length of the shifting step</param>
  41091. <exception cref="T:System.ArgumentException"></exception>
  41092. </member>
  41093. <member name="M:NPOI.SS.UserModel.Helpers.RowShifter.ValidateShiftLeftParameters(System.Int32,System.Int32,System.Int32)">
  41094. <summary>
  41095. Verify that the given column indices and step denote a valid range of columns to shift to the left
  41096. </summary>
  41097. <param name="firstShiftColumnIndex">the column to start shifting</param>
  41098. <param name="lastShiftColumnIndex">the column to end shifting</param>
  41099. <param name="step">length of the shifting step</param>
  41100. <exception cref="T:System.InvalidOperationException"></exception>
  41101. </member>
  41102. <member name="M:NPOI.SS.UserModel.Helpers.RowShifter.UpdateNamedRanges(NPOI.SS.Formula.FormulaShifter)">
  41103. <summary>
  41104. Updated named ranges
  41105. </summary>
  41106. <param name="Shifter"></param>
  41107. </member>
  41108. <member name="M:NPOI.SS.UserModel.Helpers.RowShifter.UpdateFormulas(NPOI.SS.Formula.FormulaShifter)">
  41109. <summary>
  41110. Update formulas.
  41111. </summary>
  41112. <param name="Shifter"></param>
  41113. </member>
  41114. <member name="M:NPOI.SS.UserModel.Helpers.RowShifter.UpdateRowFormulas(NPOI.SS.UserModel.IRow,NPOI.SS.Formula.FormulaShifter)">
  41115. <summary>
  41116. Update the formulas in specified row using the formula Shifting policy specified by Shifter
  41117. </summary>
  41118. <param name="row">the row to update the formulas on</param>
  41119. <param name="Shifter">the formula Shifting policy</param>
  41120. </member>
  41121. <member name="M:NPOI.SS.UserModel.Helpers.RowShifter.UpdateHyperlinks(NPOI.SS.Formula.FormulaShifter)">
  41122. <summary>
  41123. Shift the Hyperlink anchors (not the hyperlink text, even if the hyperlink
  41124. is of type LINK_DOCUMENT and refers to a cell that was Shifted). Hyperlinks
  41125. do not track the content they point to.
  41126. </summary>
  41127. <param name="Shifter">the formula Shifting policy</param>
  41128. </member>
  41129. <member name="T:NPOI.SS.UserModel.HorizontalAlignment">
  41130. The enumeration value indicating horizontal alignment of a cell,
  41131. i.e., whether it is aligned general, left, right, horizontally centered, Filled (replicated),
  41132. justified, centered across multiple cells, or distributed.
  41133. </member>
  41134. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.General">
  41135. The horizontal alignment is general-aligned. Text data is left-aligned.
  41136. Numbers, dates, and times are rightaligned. Boolean types are centered.
  41137. Changing the alignment does not change the type of data.
  41138. </member>
  41139. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Left">
  41140. The horizontal alignment is left-aligned, even in Rightto-Left mode.
  41141. Aligns contents at the left edge of the cell. If an indent amount is specified, the contents of
  41142. the cell is indented from the left by the specified number of character spaces. The character spaces are
  41143. based on the default font and font size for the workbook.
  41144. </member>
  41145. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Center">
  41146. The horizontal alignment is centered, meaning the text is centered across the cell.
  41147. </member>
  41148. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Right">
  41149. The horizontal alignment is right-aligned, meaning that cell contents are aligned at the right edge of the cell,
  41150. even in Right-to-Left mode.
  41151. </member>
  41152. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Justify">
  41153. The horizontal alignment is justified (flush left and right).
  41154. For each line of text, aligns each line of the wrapped text in a cell to the right and left
  41155. (except the last line). If no single line of text wraps in the cell, then the text is not justified.
  41156. </member>
  41157. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Fill">
  41158. Indicates that the value of the cell should be Filled
  41159. across the entire width of the cell. If blank cells to the right also have the fill alignment,
  41160. they are also Filled with the value, using a convention similar to centerContinuous.
  41161. <p>
  41162. Additional rules:
  41163. <ol>
  41164. <li>Only whole values can be Appended, not partial values.</li>
  41165. <li>The column will not be widened to 'best fit' the Filled value</li>
  41166. <li>If Appending an Additional occurrence of the value exceeds the boundary of the cell
  41167. left/right edge, don't append the Additional occurrence of the value.</li>
  41168. <li>The display value of the cell is Filled, not the underlying raw number.</li>
  41169. </ol>
  41170. </p>
  41171. </member>
  41172. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.CenterSelection">
  41173. The horizontal alignment is centered across multiple cells.
  41174. The information about how many cells to span is expressed in the Sheet Part,
  41175. in the row of the cell in question. For each cell that is spanned in the alignment,
  41176. a cell element needs to be written out, with the same style Id which references the centerContinuous alignment.
  41177. </member>
  41178. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Distributed">
  41179. Indicates that each 'word' in each line of text inside the cell is evenly distributed
  41180. across the width of the cell, with flush right and left margins.
  41181. <p>
  41182. When there is also an indent value to apply, both the left and right side of the cell
  41183. are pAdded by the indent value.
  41184. </p>
  41185. <p> A 'word' is a set of characters with no space character in them. </p>
  41186. <p> Two lines inside a cell are Separated by a carriage return. </p>
  41187. </member>
  41188. <member name="F:NPOI.SS.UserModel.HyperlinkType.Url">
  41189. <summary>
  41190. Link to an existing file or web page
  41191. </summary>
  41192. </member>
  41193. <member name="F:NPOI.SS.UserModel.HyperlinkType.Document">
  41194. <summary>
  41195. Link to a place in this document
  41196. </summary>
  41197. </member>
  41198. <member name="F:NPOI.SS.UserModel.HyperlinkType.Email">
  41199. <summary>
  41200. Link to an E-mail Address
  41201. </summary>
  41202. </member>
  41203. <member name="F:NPOI.SS.UserModel.HyperlinkType.File">
  41204. <summary>
  41205. Link to a file
  41206. </summary>
  41207. </member>
  41208. <member name="T:NPOI.SS.UserModel.IHyperlink">
  41209. <summary>
  41210. Represents an Excel hyperlink.
  41211. </summary>
  41212. </member>
  41213. <member name="P:NPOI.SS.UserModel.IHyperlink.Address">
  41214. <summary>
  41215. Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, patrh to a file, etc.
  41216. </summary>
  41217. </member>
  41218. <member name="P:NPOI.SS.UserModel.IHyperlink.Label">
  41219. <summary>
  41220. text label for this hyperlink
  41221. </summary>
  41222. </member>
  41223. <member name="P:NPOI.SS.UserModel.IHyperlink.Type">
  41224. <summary>
  41225. the type of this hyperlink
  41226. </summary>
  41227. </member>
  41228. <member name="P:NPOI.SS.UserModel.IHyperlink.FirstRow">
  41229. <summary>
  41230. the row of the first cell that Contains the hyperlink
  41231. </summary>
  41232. </member>
  41233. <member name="P:NPOI.SS.UserModel.IHyperlink.LastRow">
  41234. <summary>
  41235. the row of the last cell that Contains the hyperlink
  41236. </summary>
  41237. </member>
  41238. <member name="P:NPOI.SS.UserModel.IHyperlink.FirstColumn">
  41239. <summary>
  41240. the column of the first cell that Contains the hyperlink
  41241. </summary>
  41242. </member>
  41243. <member name="P:NPOI.SS.UserModel.IHyperlink.LastColumn">
  41244. <summary>
  41245. the column of the last cell that Contains the hyperlink
  41246. </summary>
  41247. </member>
  41248. <member name="P:NPOI.SS.UserModel.IIconMultiStateFormatting.IconSet">
  41249. <summary>
  41250. Get or set the Icon Set used
  41251. </summary>
  41252. </member>
  41253. <member name="P:NPOI.SS.UserModel.IIconMultiStateFormatting.IsIconOnly">
  41254. Changes the Icon Set used
  41255. <p>If the new Icon Set has a different number of
  41256. icons to the old one, you <em>must</em> update the
  41257. thresholds before saving!</p>
  41258. Should Icon + Value be displayed, or only the Icon?
  41259. </member>
  41260. <member name="P:NPOI.SS.UserModel.IIconMultiStateFormatting.Thresholds">
  41261. Gets the list of thresholds
  41262. Sets the of thresholds. The number must match
  41263. {@link IconSet#num} for the current {@link #getIconSet()}
  41264. </member>
  41265. <member name="M:NPOI.SS.UserModel.IIconMultiStateFormatting.CreateThreshold">
  41266. Creates a new, empty Threshold
  41267. </member>
  41268. <member name="F:NPOI.SS.UserModel.IconSet.GYR_3_ARROW">
  41269. Green Up / Yellow Side / Red Down arrows
  41270. </member>
  41271. <member name="F:NPOI.SS.UserModel.IconSet.GREY_3_ARROWS">
  41272. Grey Up / Side / Down arrows
  41273. </member>
  41274. <member name="F:NPOI.SS.UserModel.IconSet.GYR_3_FLAGS">
  41275. Green / Yellow / Red flags
  41276. </member>
  41277. <member name="F:NPOI.SS.UserModel.IconSet.GYR_3_TRAFFIC_LIGHTS">
  41278. Green / Yellow / Red traffic lights (no background). Default
  41279. </member>
  41280. <member name="F:NPOI.SS.UserModel.IconSet.GYR_3_TRAFFIC_LIGHTS_BOX">
  41281. Green / Yellow / Red traffic lights on a black square background.
  41282. Note, MS-XLS docs v20141018 say this is id=5 but seems to be id=4
  41283. </member>
  41284. <member name="F:NPOI.SS.UserModel.IconSet.GYR_3_SHAPES">
  41285. Green Circle / Yellow Triangle / Red Diamond.
  41286. Note, MS-XLS docs v20141018 say this is id=4 but seems to be id=5
  41287. </member>
  41288. <member name="F:NPOI.SS.UserModel.IconSet.GYR_3_SYMBOLS_CIRCLE">
  41289. Green Tick / Yellow ! / Red Cross on a circle background
  41290. </member>
  41291. <member name="F:NPOI.SS.UserModel.IconSet.GYR_3_SYMBOLS">
  41292. Green Tick / Yellow ! / Red Cross (no background)
  41293. </member>
  41294. <member name="F:NPOI.SS.UserModel.IconSet.GYR_4_ARROWS">
  41295. Green Up / Yellow NE / Yellow SE / Red Down arrows
  41296. </member>
  41297. <member name="F:NPOI.SS.UserModel.IconSet.GREY_4_ARROWS">
  41298. Grey Up / NE / SE / Down arrows
  41299. </member>
  41300. <member name="F:NPOI.SS.UserModel.IconSet.RB_4_TRAFFIC_LIGHTS">
  41301. Red / Light Red / Grey / Black traffic lights
  41302. </member>
  41303. <member name="F:NPOI.SS.UserModel.IconSet.GYRB_4_TRAFFIC_LIGHTS">
  41304. Green / Yellow / Red / Black traffic lights
  41305. </member>
  41306. <member name="F:NPOI.SS.UserModel.IconSet.id">
  41307. Numeric ID of the icon set
  41308. </member>
  41309. <member name="F:NPOI.SS.UserModel.IconSet.num">
  41310. How many icons in the set
  41311. </member>
  41312. <member name="F:NPOI.SS.UserModel.IconSet.name">
  41313. Name (system) of the set
  41314. </member>
  41315. <member name="T:NPOI.SS.UserModel.IgnoredErrorType">
  41316. Types of ignored workbook and worksheet error.
  41317. TODO Implement these for HSSF too, using FeatFormulaErr2,
  41318. see bugzilla bug #46136 for details
  41319. </member>
  41320. <member name="F:NPOI.SS.UserModel.IgnoredErrorType.CalculatedColumn">
  41321. ????. Probably XSSF-only.
  41322. </member>
  41323. <member name="F:NPOI.SS.UserModel.IgnoredErrorType.EmptyCellReference">
  41324. Whether to check for references to empty cells.
  41325. HSSF + XSSF.
  41326. </member>
  41327. <member name="F:NPOI.SS.UserModel.IgnoredErrorType.EvaluationError">
  41328. Whether to check for calculation/Evaluation errors.
  41329. HSSF + XSSF.
  41330. </member>
  41331. <member name="F:NPOI.SS.UserModel.IgnoredErrorType.Formula">
  41332. Whether to check formulas in the range of the shared feature
  41333. that are inconsistent with formulas in neighbouring cells.
  41334. HSSF + XSSF.
  41335. </member>
  41336. <member name="F:NPOI.SS.UserModel.IgnoredErrorType.FormulaRange">
  41337. Whether to check formulas in the range of the shared feature
  41338. with references to less than the entirety of a range Containing
  41339. continuous data.
  41340. HSSF + XSSF.
  41341. </member>
  41342. <member name="F:NPOI.SS.UserModel.IgnoredErrorType.ListDataValidation">
  41343. ????. Is this XSSF-specific the same as performDataValidation
  41344. in HSSF?
  41345. </member>
  41346. <member name="F:NPOI.SS.UserModel.IgnoredErrorType.NumberStoredAsText">
  41347. Whether to check the format of string values and warn
  41348. if they look to actually be numeric values.
  41349. HSSF + XSSF.
  41350. </member>
  41351. <member name="F:NPOI.SS.UserModel.IgnoredErrorType.TwoDigitTextYear">
  41352. ????. Is this XSSF-specific the same as CheckDateTimeFormats
  41353. in HSSF?
  41354. </member>
  41355. <member name="F:NPOI.SS.UserModel.IgnoredErrorType.UnlockedFormula">
  41356. Whether to check for unprotected formulas.
  41357. HSSF + XSSF.
  41358. </member>
  41359. <member name="T:NPOI.SS.UserModel.IndexedColors">
  41360. A deprecated indexing scheme for colours that is still required for some records, and for backwards
  41361. compatibility with OLE2 formats.
  41362. <p>
  41363. Each element corresponds to a color index (zero-based). When using the default indexed color palette,
  41364. the values are not written out, but instead are implied. When the color palette has been modified from default,
  41365. then the entire color palette is used.
  41366. </p>
  41367. @author Yegor Kozlov
  41368. </member>
  41369. <member name="M:NPOI.SS.UserModel.IndexedColors.FromInt(System.Int32)">
  41370. @param index the index of the color
  41371. @return the corresponding IndexedColors enum
  41372. @throws IllegalArgumentException if index is not a valid IndexedColors
  41373. @since 3.15-beta2
  41374. </member>
  41375. <member name="P:NPOI.SS.UserModel.IndexedColors.Index">
  41376. Returns index of this color
  41377. @return index of this color
  41378. </member>
  41379. <member name="T:NPOI.SS.UserModel.IName">
  41380. Represents a defined name for a range of cells.
  41381. A name is a meaningful shorthand that makes it easier to understand the purpose of a
  41382. cell reference, constant or a formula.
  41383. </member>
  41384. <member name="P:NPOI.SS.UserModel.IName.SheetName">
  41385. Get the sheets name which this named range is referenced to
  41386. @return sheet name, which this named range refered to
  41387. </member>
  41388. <member name="P:NPOI.SS.UserModel.IName.NameName">
  41389. Gets the name of the named range
  41390. @return named range name
  41391. </member>
  41392. <member name="P:NPOI.SS.UserModel.IName.RefersToFormula">
  41393. Returns the formula that the name is defined to refer to.
  41394. @return the reference for this name, <code>null</code> if it has not been set yet. Never empty string
  41395. @see #SetRefersToFormula(String)
  41396. </member>
  41397. <member name="P:NPOI.SS.UserModel.IName.IsFunctionName">
  41398. Checks if this name is a function name
  41399. @return true if this name is a function name
  41400. </member>
  41401. <member name="P:NPOI.SS.UserModel.IName.IsDeleted">
  41402. Checks if this name points to a cell that no longer exists
  41403. @return <c>true</c> if the name refers to a deleted cell, <c>false</c> otherwise
  41404. </member>
  41405. <member name="P:NPOI.SS.UserModel.IName.SheetIndex">
  41406. Returns the sheet index this name applies to.
  41407. @return the sheet index this name applies to, -1 if this name applies to the entire workbook
  41408. </member>
  41409. <member name="P:NPOI.SS.UserModel.IName.Comment">
  41410. Returns the comment the user provided when the name was Created.
  41411. @return the user comment for this named range
  41412. </member>
  41413. <member name="M:NPOI.SS.UserModel.IName.SetFunction(System.Boolean)">
  41414. Indicates that the defined name refers to a user-defined function.
  41415. This attribute is used when there is an add-in or other code project associated with the file.
  41416. @param value <c>true</c> indicates the name refers to a function.
  41417. </member>
  41418. <member name="T:NPOI.SS.UserModel.PageOrder">
  41419. Specifies printed page order.
  41420. @author Gisella Bronzetti
  41421. </member>
  41422. <member name="F:NPOI.SS.UserModel.PageOrder.DOWN_THEN_OVER">
  41423. Order pages vertically first, then move horizontally.
  41424. </member>
  41425. <member name="F:NPOI.SS.UserModel.PageOrder.OVER_THEN_DOWN">
  41426. Order pages horizontally first, then move vertically
  41427. </member>
  41428. <member name="T:NPOI.SS.UserModel.PaperSize">
  41429. The enumeration value indicating the possible paper size for a sheet
  41430. @author Daniele Montagni
  41431. </member>
  41432. <member name="F:NPOI.SS.UserModel.PaperSize.PRINTER_DEFAULT_PAPERSIZE">
  41433. <summary>
  41434. Allow accessing the Initial value.
  41435. </summary>
  41436. </member>
  41437. <member name="F:NPOI.SS.UserModel.PaperSize.A4_TRANSVERSE_PAPERSIZE">
  41438. <summary>
  41439. A4 Transverse - 210x297 mm
  41440. </summary>
  41441. </member>
  41442. <member name="F:NPOI.SS.UserModel.PaperSize.A4_PLUS_PAPERSIZE">
  41443. <summary>
  41444. A4 Plus - 210x330 mm
  41445. </summary>
  41446. </member>
  41447. <member name="F:NPOI.SS.UserModel.PaperSize.LETTER_ROTATED_PAPERSIZE">
  41448. <summary>
  41449. US Letter Rotated 11 x 8 1/2 in
  41450. </summary>
  41451. </member>
  41452. <member name="F:NPOI.SS.UserModel.PaperSize.A4_ROTATED_PAPERSIZE">
  41453. <summary>
  41454. A4 Rotated - 297x210 mm */
  41455. </summary>
  41456. </member>
  41457. <member name="T:NPOI.SS.UserModel.IPatternFormatting">
  41458. @author Yegor Kozlov
  41459. </member>
  41460. <member name="F:NPOI.SS.UserModel.PictureType.Unknown">
  41461. <summary>
  41462. Allow accessing the Initial value.
  41463. </summary>
  41464. </member>
  41465. <member name="F:NPOI.SS.UserModel.PictureType.EMF">
  41466. Extended windows meta file
  41467. </member>
  41468. <member name="F:NPOI.SS.UserModel.PictureType.WMF">
  41469. Windows Meta File
  41470. </member>
  41471. <member name="F:NPOI.SS.UserModel.PictureType.PICT">
  41472. Mac PICT format
  41473. </member>
  41474. <member name="F:NPOI.SS.UserModel.PictureType.JPEG">
  41475. JPEG format
  41476. </member>
  41477. <member name="F:NPOI.SS.UserModel.PictureType.PNG">
  41478. PNG format
  41479. </member>
  41480. <member name="F:NPOI.SS.UserModel.PictureType.DIB">
  41481. Device independent bitmap
  41482. </member>
  41483. <member name="F:NPOI.SS.UserModel.PictureType.GIF">
  41484. GIF image format
  41485. </member>
  41486. <member name="F:NPOI.SS.UserModel.PictureType.TIFF">
  41487. Tag Image File (.tiff)
  41488. </member>
  41489. <member name="F:NPOI.SS.UserModel.PictureType.EPS">
  41490. Encapsulated Postscript (.eps)
  41491. </member>
  41492. <member name="F:NPOI.SS.UserModel.PictureType.BMP">
  41493. Windows Bitmap (.bmp)
  41494. </member>
  41495. <member name="F:NPOI.SS.UserModel.PictureType.WPG">
  41496. WordPerfect graphics (.wpg)
  41497. </member>
  41498. <member name="T:NPOI.SS.UserModel.IPicture">
  41499. Repersents a picture in a SpreadsheetML document
  41500. @author Yegor Kozlov
  41501. </member>
  41502. <member name="M:NPOI.SS.UserModel.IPicture.Resize">
  41503. Reset the image to the dimension of the embedded image
  41504. @see #resize(double, double)
  41505. </member>
  41506. <member name="M:NPOI.SS.UserModel.IPicture.Resize(System.Double)">
  41507. Resize the image proportionally.
  41508. </member>
  41509. <member name="M:NPOI.SS.UserModel.IPicture.Resize(System.Double,System.Double)">
  41510. Resize the image.
  41511. <p>
  41512. Please note, that this method works correctly only for workbooks
  41513. with the default font size (Arial 10pt for .xls and Calibri 11pt for .xlsx).
  41514. If the default font is changed the resized image can be streched vertically or horizontally.
  41515. </p>
  41516. <p>
  41517. <code>resize(1.0,1.0)</code> keeps the original size,<br/>
  41518. <code>resize(0.5,0.5)</code> resize to 50% of the original,<br/>
  41519. <code>resize(2.0,2.0)</code> resizes to 200% of the original.<br/>
  41520. <code>resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE})</code> resizes to the dimension of the embedded image.
  41521. </p>
  41522. @param scaleX the amount by which the image width is multiplied relative to the original width.
  41523. @param scaleY the amount by which the image height is multiplied relative to the original height.
  41524. </member>
  41525. <member name="M:NPOI.SS.UserModel.IPicture.GetPreferredSize">
  41526. Calculate the preferred size for this picture.
  41527. @return XSSFClientAnchor with the preferred size for this image
  41528. </member>
  41529. <member name="M:NPOI.SS.UserModel.IPicture.GetPreferredSize(System.Double,System.Double)">
  41530. Calculate the preferred size for this picture.
  41531. @param scaleX the amount by which image width is multiplied relative to the original width.
  41532. @param scaleY the amount by which image height is multiplied relative to the original height.
  41533. @return ClientAnchor with the preferred size for this image
  41534. </member>
  41535. <member name="M:NPOI.SS.UserModel.IPicture.GetImageDimension">
  41536. Return the dimension of the embedded image in pixel
  41537. @return image dimension in pixels
  41538. </member>
  41539. <member name="P:NPOI.SS.UserModel.IPicture.PictureData">
  41540. Return picture data for this picture
  41541. @return picture data for this picture
  41542. </member>
  41543. <member name="P:NPOI.SS.UserModel.IPicture.ClientAnchor">
  41544. @return the anchor that is used by this picture
  41545. </member>
  41546. <member name="P:NPOI.SS.UserModel.IPictureData.Data">
  41547. Gets the picture data.
  41548. @return the picture data.
  41549. </member>
  41550. <member name="M:NPOI.SS.UserModel.IPictureData.SuggestFileExtension">
  41551. Suggests a file extension for this image.
  41552. @return the file extension.
  41553. </member>
  41554. <member name="P:NPOI.SS.UserModel.IPictureData.MimeType">
  41555. Returns the mime type for the image
  41556. </member>
  41557. <member name="P:NPOI.SS.UserModel.IPictureData.PictureType">
  41558. @return the POI internal image type, 0 if unknown image type
  41559. @see Workbook#PICTURE_TYPE_DIB
  41560. @see Workbook#PICTURE_TYPE_EMF
  41561. @see Workbook#PICTURE_TYPE_JPEG
  41562. @see Workbook#PICTURE_TYPE_PICT
  41563. @see Workbook#PICTURE_TYPE_PNG
  41564. @see Workbook#PICTURE_TYPE_WMF
  41565. </member>
  41566. <member name="P:NPOI.SS.UserModel.IPivotTableStyleInfo.IsShowColumnHeaders">
  41567. <summary>
  41568. return true if column headers should be visible
  41569. </summary>
  41570. </member>
  41571. <member name="P:NPOI.SS.UserModel.IPivotTableStyleInfo.IsShowRowHeaders">
  41572. <summary>
  41573. return true if row headers should be visible
  41574. </summary>
  41575. </member>
  41576. <member name="T:NPOI.SS.UserModel.PrintCellComments">
  41577. These enumerations specify how cell comments shall be displayed for paper printing purposes.
  41578. @author Gisella Bronzetti
  41579. </member>
  41580. <member name="F:NPOI.SS.UserModel.PrintCellComments.NONE">
  41581. Do not print cell comments.
  41582. </member>
  41583. <member name="F:NPOI.SS.UserModel.PrintCellComments.AS_DISPLAYED">
  41584. Print cell comments as displayed.
  41585. </member>
  41586. <member name="F:NPOI.SS.UserModel.PrintCellComments.AT_END">
  41587. Print cell comments at end of document.
  41588. </member>
  41589. <member name="T:NPOI.SS.UserModel.PrintOrientation">
  41590. The enumeration value indicating the print orientation for a sheet.
  41591. @author Gisella Bronzetti
  41592. </member>
  41593. <member name="F:NPOI.SS.UserModel.PrintOrientation.DEFAULT">
  41594. orientation not specified
  41595. </member>
  41596. <member name="F:NPOI.SS.UserModel.PrintOrientation.PORTRAIT">
  41597. portrait orientation
  41598. </member>
  41599. <member name="F:NPOI.SS.UserModel.PrintOrientation.LANDSCAPE">
  41600. landscape orientations
  41601. </member>
  41602. <member name="T:NPOI.SS.UserModel.DisplayCellErrorType">
  41603. <summary>
  41604. Used by HSSFPrintSetup.CellError property
  41605. </summary>
  41606. </member>
  41607. <member name="P:NPOI.SS.UserModel.IPrintSetup.PaperSize">
  41608. Returns the paper size.
  41609. @return paper size
  41610. </member>
  41611. <member name="P:NPOI.SS.UserModel.IPrintSetup.Scale">
  41612. Returns the scale.
  41613. @return scale
  41614. </member>
  41615. <member name="P:NPOI.SS.UserModel.IPrintSetup.PageStart">
  41616. Returns the page start.
  41617. @return page start
  41618. </member>
  41619. <member name="P:NPOI.SS.UserModel.IPrintSetup.FitWidth">
  41620. Returns the number of pages wide to fit sheet in.
  41621. @return number of pages wide to fit sheet in
  41622. </member>
  41623. <member name="P:NPOI.SS.UserModel.IPrintSetup.FitHeight">
  41624. Returns the number of pages high to fit the sheet in.
  41625. @return number of pages high to fit the sheet in
  41626. </member>
  41627. <member name="P:NPOI.SS.UserModel.IPrintSetup.LeftToRight">
  41628. Returns the left to right print order.
  41629. @return left to right print order
  41630. </member>
  41631. <member name="P:NPOI.SS.UserModel.IPrintSetup.Landscape">
  41632. Returns the landscape mode.
  41633. @return landscape mode
  41634. </member>
  41635. <member name="P:NPOI.SS.UserModel.IPrintSetup.ValidSettings">
  41636. Returns the valid Settings.
  41637. @return valid Settings
  41638. </member>
  41639. <member name="P:NPOI.SS.UserModel.IPrintSetup.NoColor">
  41640. Returns the black and white Setting.
  41641. @return black and white Setting
  41642. </member>
  41643. <member name="P:NPOI.SS.UserModel.IPrintSetup.Draft">
  41644. Returns the draft mode.
  41645. @return draft mode
  41646. </member>
  41647. <member name="P:NPOI.SS.UserModel.IPrintSetup.Notes">
  41648. Returns the print notes.
  41649. @return print notes
  41650. </member>
  41651. <member name="P:NPOI.SS.UserModel.IPrintSetup.NoOrientation">
  41652. Returns the no orientation.
  41653. @return no orientation
  41654. </member>
  41655. <member name="P:NPOI.SS.UserModel.IPrintSetup.UsePage">
  41656. Returns the use page numbers.
  41657. @return use page numbers
  41658. </member>
  41659. <member name="P:NPOI.SS.UserModel.IPrintSetup.HResolution">
  41660. Returns the horizontal resolution.
  41661. @return horizontal resolution
  41662. </member>
  41663. <member name="P:NPOI.SS.UserModel.IPrintSetup.VResolution">
  41664. Returns the vertical resolution.
  41665. @return vertical resolution
  41666. </member>
  41667. <member name="P:NPOI.SS.UserModel.IPrintSetup.HeaderMargin">
  41668. Returns the header margin.
  41669. @return header margin
  41670. </member>
  41671. <member name="P:NPOI.SS.UserModel.IPrintSetup.FooterMargin">
  41672. Returns the footer margin.
  41673. @return footer margin
  41674. </member>
  41675. <member name="P:NPOI.SS.UserModel.IPrintSetup.Copies">
  41676. Returns the number of copies.
  41677. @return number of copies
  41678. </member>
  41679. <member name="T:NPOI.SS.UserModel.IRichTextString">
  41680. Rich text unicode string. These strings can have fonts
  41681. applied to arbitary parts of the string.
  41682. @author Glen Stampoultzis (glens at apache.org)
  41683. @author Jason Height (jheight at apache.org)
  41684. </member>
  41685. <member name="M:NPOI.SS.UserModel.IRichTextString.ApplyFont(System.Int32,System.Int32,System.Int16)">
  41686. Applies a font to the specified characters of a string.
  41687. @param startIndex The start index to apply the font to (inclusive)
  41688. @param endIndex The end index to apply the font to (exclusive)
  41689. @param fontIndex The font to use.
  41690. </member>
  41691. <member name="M:NPOI.SS.UserModel.IRichTextString.ApplyFont(System.Int32,System.Int32,NPOI.SS.UserModel.IFont)">
  41692. Applies a font to the specified characters of a string.
  41693. @param startIndex The start index to apply the font to (inclusive)
  41694. @param endIndex The end index to apply to font to (exclusive)
  41695. @param font The index of the font to use.
  41696. </member>
  41697. <member name="M:NPOI.SS.UserModel.IRichTextString.ApplyFont(NPOI.SS.UserModel.IFont)">
  41698. Sets the font of the entire string.
  41699. @param font The font to use.
  41700. </member>
  41701. <member name="M:NPOI.SS.UserModel.IRichTextString.ClearFormatting">
  41702. Removes any formatting that may have been applied to the string.
  41703. </member>
  41704. <member name="P:NPOI.SS.UserModel.IRichTextString.String">
  41705. Returns the plain string representation.
  41706. </member>
  41707. <member name="P:NPOI.SS.UserModel.IRichTextString.Length">
  41708. @return the number of characters in the font.
  41709. </member>
  41710. <member name="P:NPOI.SS.UserModel.IRichTextString.NumFormattingRuns">
  41711. @return The number of formatting Runs used.
  41712. </member>
  41713. <member name="M:NPOI.SS.UserModel.IRichTextString.GetIndexOfFormattingRun(System.Int32)">
  41714. The index within the string to which the specified formatting run applies.
  41715. @param index the index of the formatting run
  41716. @return the index within the string.
  41717. </member>
  41718. <member name="M:NPOI.SS.UserModel.IRichTextString.ApplyFont(System.Int16)">
  41719. Applies the specified font to the entire string.
  41720. @param fontIndex the font to apply.
  41721. </member>
  41722. <member name="T:NPOI.SS.UserModel.MissingCellPolicy">
  41723. Used to specify the different possible policies
  41724. if for the case of null and blank cells
  41725. </member>
  41726. <member name="T:NPOI.SS.UserModel.IRow">
  41727. <summary>
  41728. High level representation of a row of a spreadsheet.
  41729. </summary>
  41730. </member>
  41731. <member name="M:NPOI.SS.UserModel.IRow.CreateCell(System.Int32)">
  41732. <summary>
  41733. Use this to create new cells within the row and return it.
  41734. The cell that is returned is a <see cref="T:NPOI.SS.UserModel.ICell"/>/<see cref="F:NPOI.SS.UserModel.CellType.Blank"/>.
  41735. The type can be changed either through calling <c>SetCellValue</c> or <c>SetCellType</c>.
  41736. </summary>
  41737. <param name="column">the column number this cell represents</param>
  41738. <returns>Cell a high level representation of the created cell.</returns>
  41739. <throws>
  41740. ArgumentException if columnIndex &lt; 0 or greater than the maximum number of supported columns
  41741. (255 for *.xls, 1048576 for *.xlsx)
  41742. </throws>
  41743. </member>
  41744. <member name="M:NPOI.SS.UserModel.IRow.CreateCell(System.Int32,NPOI.SS.UserModel.CellType)">
  41745. <summary>
  41746. Use this to create new cells within the row and return it.
  41747. The cell that is returned is a <see cref="T:NPOI.SS.UserModel.ICell"/>/<see cref="F:NPOI.SS.UserModel.CellType.Blank"/>. The type can be changed
  41748. either through calling <code>SetCellValue</code> or <code>SetCellType</code>.
  41749. </summary>
  41750. <param name="column">the column number this cell represents</param>
  41751. <param name="type"></param>
  41752. <returns>Cell a high level representation of the created cell.</returns>
  41753. <throws>ArgumentException if columnIndex &lt; 0 or greater than the maximum number of supported columns
  41754. (255 for *.xls, 1048576 for *.xlsx)
  41755. </throws>
  41756. </member>
  41757. <member name="M:NPOI.SS.UserModel.IRow.RemoveCell(NPOI.SS.UserModel.ICell)">
  41758. <summary>
  41759. Remove the Cell from this row.
  41760. </summary>
  41761. <param name="cell">the cell to remove</param>
  41762. </member>
  41763. <member name="P:NPOI.SS.UserModel.IRow.RowNum">
  41764. <summary>
  41765. Get row number this row represents
  41766. </summary>
  41767. <returns>the row number (0 based)</returns>
  41768. </member>
  41769. <member name="M:NPOI.SS.UserModel.IRow.GetCell(System.Int32)">
  41770. <summary>
  41771. Get the cell representing a given column (logical cell) 0-based. If you
  41772. ask for a cell that is not defined....you get a null.
  41773. </summary>
  41774. <param name="cellnum">0 based column number</param>
  41775. <returns>Cell representing that column or null if undefined.</returns>
  41776. <see cref="M:NPOI.SS.UserModel.IRow.GetCell(System.Int32,NPOI.SS.UserModel.MissingCellPolicy)"/>
  41777. </member>
  41778. <member name="M:NPOI.SS.UserModel.IRow.GetCell(System.Int32,NPOI.SS.UserModel.MissingCellPolicy)">
  41779. <summary>
  41780. Returns the cell at the given (0 based) index, with the specified {@link NPOI.SS.usermodel.Row.MissingCellPolicy}
  41781. </summary>
  41782. <returns>the cell at the given (0 based) index</returns>
  41783. <throws>ArgumentException if cellnum &lt; 0 or the specified MissingCellPolicy is invalid</throws>
  41784. <see cref="F:NPOI.SS.UserModel.MissingCellPolicy.RETURN_NULL_AND_BLANK"/>
  41785. <see cref="F:NPOI.SS.UserModel.MissingCellPolicy.RETURN_BLANK_AS_NULL"/>
  41786. <see cref="F:NPOI.SS.UserModel.MissingCellPolicy.CREATE_NULL_AS_BLANK"/>
  41787. </member>
  41788. <member name="P:NPOI.SS.UserModel.IRow.FirstCellNum">
  41789. <summary>
  41790. Get the number of the first cell Contained in this row.
  41791. </summary>
  41792. <returns>
  41793. short representing the first logical cell in the row,
  41794. or -1 if the row does not contain any cells.
  41795. </returns>
  41796. </member>
  41797. <member name="P:NPOI.SS.UserModel.IRow.LastCellNum">
  41798. <summary>
  41799. Gets the index of the last cell Contained in this row <b>PLUS ONE</b>. The result also
  41800. happens to be the 1-based column number of the last cell. This value can be used as a
  41801. standard upper bound when iterating over cells:
  41802. <pre>
  41803. short minColIx = row.GetFirstCellNum();
  41804. short maxColIx = row.GetLastCellNum();
  41805. for(short colIx=minColIx; colIx&lt;maxColIx; colIx++) {
  41806. Cell cell = row.GetCell(colIx);
  41807. if(cell == null) {
  41808. continue;
  41809. }
  41810. //... do something with cell
  41811. }
  41812. </pre>
  41813. </summary>
  41814. <returns>
  41815. short representing the last logical cell in the row <b>PLUS ONE</b>,
  41816. or -1 if the row does not contain any cells.
  41817. </returns>
  41818. </member>
  41819. <member name="P:NPOI.SS.UserModel.IRow.PhysicalNumberOfCells">
  41820. <summary>
  41821. Gets the number of defined cells (NOT number of cells in the actual row!).
  41822. That is to say if only columns 0,4,5 have values then there would be 3.
  41823. </summary>
  41824. <returns>int representing the number of defined cells in the row.</returns>
  41825. </member>
  41826. <member name="P:NPOI.SS.UserModel.IRow.ZeroHeight">
  41827. <summary>
  41828. Get whether or not to display this row with 0 height
  41829. </summary>
  41830. <returns>zHeight height is zero or not.</returns>
  41831. </member>
  41832. <member name="P:NPOI.SS.UserModel.IRow.Height">
  41833. <summary>
  41834. Get the row's height measured in twips (1/20th of a point).
  41835. If the height is not set, the default worksheet value is returned,
  41836. <see cref="P:NPOI.SS.UserModel.ISheet.DefaultRowHeightInPoints"/>
  41837. </summary>
  41838. <returns>row height measured in twips (1/20th of a point)</returns>
  41839. </member>
  41840. <member name="P:NPOI.SS.UserModel.IRow.HeightInPoints">
  41841. <summary>
  41842. Returns row height measured in point size.
  41843. If the height is not set, the default worksheet value is returned,
  41844. <see cref="P:NPOI.SS.UserModel.ISheet.DefaultRowHeightInPoints"/>
  41845. </summary>
  41846. <returns>row height measured in point size
  41847. <see cref="P:NPOI.SS.UserModel.ISheet.DefaultRowHeightInPoints"/>
  41848. </returns>
  41849. </member>
  41850. <member name="P:NPOI.SS.UserModel.IRow.IsFormatted">
  41851. <summary>
  41852. Is this row formatted? Most aren't, but some rows
  41853. do have whole-row styles. For those that do, you
  41854. can get the formatting from <see cref="P:NPOI.SS.UserModel.IRow.RowStyle"/>
  41855. </summary>
  41856. </member>
  41857. <member name="P:NPOI.SS.UserModel.IRow.Sheet">
  41858. <summary>
  41859. Returns the Sheet this row belongs to
  41860. </summary>
  41861. <returns>the Sheet that owns this row</returns>
  41862. </member>
  41863. <member name="P:NPOI.SS.UserModel.IRow.RowStyle">
  41864. <summary>
  41865. Returns the whole-row cell styles. Most rows won't
  41866. have one of these, so will return null. Call IsFormmated to check first
  41867. </summary>
  41868. <value>The row style.</value>
  41869. </member>
  41870. <member name="M:NPOI.SS.UserModel.IRow.MoveCell(NPOI.SS.UserModel.ICell,System.Int32)">
  41871. <summary>
  41872. Moves the supplied cell to a new column, which
  41873. must not already have a cell there!
  41874. </summary>
  41875. <param name="cell">The cell to move</param>
  41876. <param name="newColumn">The new column number (0 based)</param>
  41877. </member>
  41878. <member name="M:NPOI.SS.UserModel.IRow.CopyRowTo(System.Int32)">
  41879. <summary>
  41880. Copy the current row to the target row
  41881. </summary>
  41882. <param name="targetIndex">row index of the target row</param>
  41883. <returns>the new copied row object</returns>
  41884. </member>
  41885. <member name="M:NPOI.SS.UserModel.IRow.CopyCell(System.Int32,System.Int32)">
  41886. <summary>
  41887. Copy the source cell to the target cell. If the target cell exists, the new copied cell will be inserted before the existing one
  41888. </summary>
  41889. <param name="sourceIndex">index of the source cell</param>
  41890. <param name="targetIndex">index of the target cell</param>
  41891. <returns>the new copied cell object</returns>
  41892. </member>
  41893. <member name="P:NPOI.SS.UserModel.IRow.Cells">
  41894. <summary>
  41895. Get cells in the row
  41896. </summary>
  41897. </member>
  41898. <member name="P:NPOI.SS.UserModel.IRow.OutlineLevel">
  41899. <summary>
  41900. Returns the rows outline level. Increased as you
  41901. put it into more groups (outlines), reduced as
  41902. you take it out of them.
  41903. </summary>
  41904. </member>
  41905. <member name="T:NPOI.SS.UserModel.ShapeTypes">
  41906. All known types of automatic shapes in DrawingML
  41907. @author Yegor Kozlov
  41908. </member>
  41909. <member name="F:NPOI.SS.UserModel.ShapeTypes.None">
  41910. <summary>
  41911. Allow accessing the Initial value.
  41912. </summary>
  41913. </member>
  41914. <member name="T:NPOI.SS.UserModel.MarginType">
  41915. <summary>
  41916. Indicate the position of the margin. One of left, right, top and bottom.
  41917. </summary>
  41918. </member>
  41919. <member name="F:NPOI.SS.UserModel.MarginType.LeftMargin">
  41920. <summary>
  41921. referes to the left margin
  41922. </summary>
  41923. </member>
  41924. <member name="F:NPOI.SS.UserModel.MarginType.RightMargin">
  41925. <summary>
  41926. referes to the right margin
  41927. </summary>
  41928. </member>
  41929. <member name="F:NPOI.SS.UserModel.MarginType.TopMargin">
  41930. <summary>
  41931. referes to the top margin
  41932. </summary>
  41933. </member>
  41934. <member name="F:NPOI.SS.UserModel.MarginType.BottomMargin">
  41935. <summary>
  41936. referes to the bottom margin
  41937. </summary>
  41938. </member>
  41939. <member name="T:NPOI.SS.UserModel.PanePosition">
  41940. <summary>
  41941. Define the position of the pane. One of lower/right, upper/right, lower/left and upper/left.
  41942. </summary>
  41943. </member>
  41944. <member name="F:NPOI.SS.UserModel.PanePosition.LowerRight">
  41945. <summary>
  41946. referes to the lower/right corner
  41947. </summary>
  41948. </member>
  41949. <member name="F:NPOI.SS.UserModel.PanePosition.UpperRight">
  41950. <summary>
  41951. referes to the upper/right corner
  41952. </summary>
  41953. </member>
  41954. <member name="F:NPOI.SS.UserModel.PanePosition.LowerLeft">
  41955. <summary>
  41956. referes to the lower/left corner
  41957. </summary>
  41958. </member>
  41959. <member name="F:NPOI.SS.UserModel.PanePosition.UpperLeft">
  41960. <summary>
  41961. referes to the upper/left corner
  41962. </summary>
  41963. </member>
  41964. <member name="T:NPOI.SS.UserModel.ISheet">
  41965. <summary>
  41966. High level representation of a Excel worksheet.
  41967. </summary>
  41968. <remarks>
  41969. Sheets are the central structures within a workbook, and are where a user does most of his spreadsheet work.
  41970. The most common type of sheet is the worksheet, which is represented as a grid of cells. Worksheet cells can
  41971. contain text, numbers, dates, and formulas. Cells can also be formatted.
  41972. </remarks>
  41973. </member>
  41974. <member name="M:NPOI.SS.UserModel.ISheet.CreateRow(System.Int32)">
  41975. <summary>
  41976. Create a new row within the sheet and return the high level representation
  41977. </summary>
  41978. <param name="rownum">The row number.</param>
  41979. <returns>high level Row object representing a row in the sheet</returns>
  41980. <see>RemoveRow(Row)</see>
  41981. </member>
  41982. <member name="M:NPOI.SS.UserModel.ISheet.RemoveRow(NPOI.SS.UserModel.IRow)">
  41983. <summary>
  41984. Remove a row from this sheet. All cells Contained in the row are Removed as well
  41985. </summary>
  41986. <param name="row">a row to Remove.</param>
  41987. </member>
  41988. <member name="M:NPOI.SS.UserModel.ISheet.GetRow(System.Int32)">
  41989. <summary>
  41990. Returns the logical row (not physical) 0-based. If you ask for a row that is not
  41991. defined you get a null. This is to say row 4 represents the fifth row on a sheet.
  41992. </summary>
  41993. <param name="rownum">row to get (0-based).</param>
  41994. <returns>the rownumber or null if its not defined on the sheet</returns>
  41995. </member>
  41996. <member name="P:NPOI.SS.UserModel.ISheet.PhysicalNumberOfRows">
  41997. <summary>
  41998. Returns the number of physically defined rows (NOT the number of rows in the sheet)
  41999. </summary>
  42000. <value>the number of physically defined rows in this sheet.</value>
  42001. </member>
  42002. <member name="P:NPOI.SS.UserModel.ISheet.FirstRowNum">
  42003. <summary>
  42004. Gets the first row on the sheet
  42005. </summary>
  42006. <value>the number of the first logical row on the sheet (0-based).</value>
  42007. </member>
  42008. <member name="P:NPOI.SS.UserModel.ISheet.LastRowNum">
  42009. <summary>
  42010. Gets the last row on the sheet
  42011. </summary>
  42012. <value>last row contained n this sheet (0-based)</value>
  42013. </member>
  42014. <member name="P:NPOI.SS.UserModel.ISheet.ForceFormulaRecalculation">
  42015. <summary>
  42016. whether force formula recalculation.
  42017. </summary>
  42018. </member>
  42019. <member name="M:NPOI.SS.UserModel.ISheet.SetColumnHidden(System.Int32,System.Boolean)">
  42020. <summary>
  42021. Get the visibility state for a given column
  42022. </summary>
  42023. <param name="columnIndex">the column to get (0-based)</param>
  42024. <param name="hidden">the visiblity state of the column</param>
  42025. </member>
  42026. <member name="M:NPOI.SS.UserModel.ISheet.IsColumnHidden(System.Int32)">
  42027. <summary>
  42028. Get the hidden state for a given column
  42029. </summary>
  42030. <param name="columnIndex">the column to set (0-based)</param>
  42031. <returns>hidden - <c>false</c> if the column is visible</returns>
  42032. </member>
  42033. <member name="M:NPOI.SS.UserModel.ISheet.CopyRow(System.Int32,System.Int32)">
  42034. <summary>
  42035. Copy the source row to the target row. If the target row exists, the new copied row will be inserted before the existing one
  42036. </summary>
  42037. <param name="sourceIndex">source index</param>
  42038. <param name="targetIndex">target index</param>
  42039. <returns>the new copied row object</returns>
  42040. </member>
  42041. <member name="M:NPOI.SS.UserModel.ISheet.CopyComment(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.ICell)">
  42042. <summary>
  42043. Copies comment from one cell to another
  42044. </summary>
  42045. <param name="sourceCell">Cell with a comment to copy</param>
  42046. <param name="targetCell">Cell to paste the comment to</param>
  42047. <returns>Copied comment</returns>
  42048. </member>
  42049. <member name="M:NPOI.SS.UserModel.ISheet.SetColumnWidth(System.Int32,System.Int32)">
  42050. <summary>
  42051. Set the width (in units of 1/256th of a character width)
  42052. </summary>
  42053. <param name="columnIndex">the column to set (0-based)</param>
  42054. <param name="width">the width in units of 1/256th of a character width</param>
  42055. <remarks>
  42056. The maximum column width for an individual cell is 255 characters.
  42057. This value represents the number of characters that can be displayed
  42058. in a cell that is formatted with the standard font.
  42059. </remarks>
  42060. </member>
  42061. <member name="M:NPOI.SS.UserModel.ISheet.GetColumnWidth(System.Int32)">
  42062. <summary>
  42063. get the width (in units of 1/256th of a character width )
  42064. </summary>
  42065. <param name="columnIndex">the column to get (0-based)</param>
  42066. <returns>the width in units of 1/256th of a character width</returns>
  42067. </member>
  42068. <member name="M:NPOI.SS.UserModel.ISheet.GetColumnWidthInPixels(System.Int32)">
  42069. <summary>
  42070. get the width in pixel
  42071. </summary>
  42072. <param name="columnIndex"></param>
  42073. <returns></returns>
  42074. <remarks>
  42075. Please note, that this method works correctly only for workbooks
  42076. with the default font size (Arial 10pt for .xls and Calibri 11pt for .xlsx).
  42077. If the default font is changed the column width can be streched
  42078. </remarks>
  42079. </member>
  42080. <member name="P:NPOI.SS.UserModel.ISheet.DefaultColumnWidth">
  42081. <summary>
  42082. Get the default column width for the sheet (if the columns do not define their own width)
  42083. in characters
  42084. </summary>
  42085. <value>default column width measured in characters.</value>
  42086. </member>
  42087. <member name="P:NPOI.SS.UserModel.ISheet.DefaultRowHeight">
  42088. <summary>
  42089. Get the default row height for the sheet (if the rows do not define their own height) in
  42090. twips (1/20 of a point)
  42091. </summary>
  42092. <value>default row height measured in twips (1/20 of a point)</value>
  42093. </member>
  42094. <member name="P:NPOI.SS.UserModel.ISheet.DefaultRowHeightInPoints">
  42095. <summary>
  42096. Get the default row height for the sheet (if the rows do not define their own height) in
  42097. points.
  42098. </summary>
  42099. <value>The default row height in points.</value>
  42100. </member>
  42101. <member name="M:NPOI.SS.UserModel.ISheet.GetColumnStyle(System.Int32)">
  42102. <summary>
  42103. Returns the CellStyle that applies to the given
  42104. (0 based) column, or null if no style has been
  42105. set for that column
  42106. </summary>
  42107. <param name="column">The column.</param>
  42108. </member>
  42109. <member name="M:NPOI.SS.UserModel.ISheet.AddMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  42110. <summary>
  42111. Adds a merged region of cells (hence those cells form one)
  42112. </summary>
  42113. <param name="region">(rowfrom/colfrom-rowto/colto) to merge.</param>
  42114. <returns>index of this region</returns>
  42115. </member>
  42116. <member name="M:NPOI.SS.UserModel.ISheet.AddMergedRegionUnsafe(NPOI.SS.Util.CellRangeAddress)">
  42117. <summary>
  42118. Adds a merged region of cells (hence those cells form one).
  42119. Skips validation. It is possible to create overlapping merged regions
  42120. or create a merged region that intersects a multi-cell array formula
  42121. with this formula, which may result in a corrupt workbook.
  42122. To check for merged regions overlapping array formulas or other merged regions
  42123. after addMergedRegionUnsafe has been called, call {@link #validateMergedRegions()}, which runs in O(n^2) time.
  42124. </summary>
  42125. <param name="region">region to merge</param>
  42126. <returns>index of this region</returns>
  42127. <exception cref="T:System.ArgumentException">if region contains fewer than 2 cells</exception>
  42128. </member>
  42129. <member name="M:NPOI.SS.UserModel.ISheet.ValidateMergedRegions">
  42130. <summary>
  42131. Verify that merged regions do not intersect multi-cell array formulas and
  42132. no merged regions intersect another merged region in this sheet.
  42133. </summary>
  42134. <exception cref="!:NPOI.Util.InvalidOperationException">if region intersects with a multi-cell array formula</exception>
  42135. <exception cref="!:NPOI.Util.InvalidOperationException">if at least one region intersects with another merged region in this sheet</exception>
  42136. </member>
  42137. <member name="P:NPOI.SS.UserModel.ISheet.HorizontallyCenter">
  42138. <summary>
  42139. Determine whether printed output for this sheet will be horizontally centered.
  42140. </summary>
  42141. </member>
  42142. <member name="P:NPOI.SS.UserModel.ISheet.VerticallyCenter">
  42143. <summary>
  42144. Determine whether printed output for this sheet will be vertically centered.
  42145. </summary>
  42146. </member>
  42147. <member name="M:NPOI.SS.UserModel.ISheet.RemoveMergedRegion(System.Int32)">
  42148. <summary>
  42149. Removes a merged region of cells (hence letting them free)
  42150. </summary>
  42151. <param name="index">index of the region to unmerge</param>
  42152. </member>
  42153. <member name="M:NPOI.SS.UserModel.ISheet.RemoveMergedRegions(System.Collections.Generic.IList{System.Int32})">
  42154. <summary>
  42155. Removes a number of merged regions of cells (hence letting them free)
  42156. </summary>
  42157. <param name="indices">A set of the regions to unmerge</param>
  42158. </member>
  42159. <member name="P:NPOI.SS.UserModel.ISheet.NumMergedRegions">
  42160. <summary>
  42161. Returns the number of merged regions
  42162. </summary>
  42163. </member>
  42164. <member name="M:NPOI.SS.UserModel.ISheet.GetMergedRegion(System.Int32)">
  42165. <summary>
  42166. Returns the merged region at the specified index
  42167. </summary>
  42168. <param name="index">The index.</param>
  42169. </member>
  42170. <member name="P:NPOI.SS.UserModel.ISheet.MergedRegions">
  42171. <summary>
  42172. Returns the list of merged regions.
  42173. </summary>
  42174. </member>
  42175. <member name="M:NPOI.SS.UserModel.ISheet.GetRowEnumerator">
  42176. <summary>
  42177. Gets the row enumerator.
  42178. </summary>
  42179. <returns>
  42180. an iterator of the PHYSICAL rows. Meaning the 3rd element may not
  42181. be the third row if say for instance the second row is undefined.
  42182. Call <see cref="P:NPOI.SS.UserModel.IRow.RowNum"/> on each row
  42183. if you care which one it is.
  42184. </returns>
  42185. </member>
  42186. <member name="M:NPOI.SS.UserModel.ISheet.GetEnumerator">
  42187. <summary>
  42188. Get the row enumerator
  42189. </summary>
  42190. <returns></returns>
  42191. </member>
  42192. <member name="P:NPOI.SS.UserModel.ISheet.DisplayZeros">
  42193. <summary>
  42194. Gets the flag indicating whether the window should show 0 (zero) in cells Containing zero value.
  42195. When false, cells with zero value appear blank instead of showing the number zero.
  42196. </summary>
  42197. <value>whether all zero values on the worksheet are displayed.</value>
  42198. </member>
  42199. <member name="P:NPOI.SS.UserModel.ISheet.Autobreaks">
  42200. <summary>
  42201. Gets or sets a value indicating whether the sheet displays Automatic Page Breaks.
  42202. </summary>
  42203. </member>
  42204. <member name="P:NPOI.SS.UserModel.ISheet.DisplayGuts">
  42205. <summary>
  42206. Get whether to display the guts or not,
  42207. </summary>
  42208. <value>default value is true</value>
  42209. </member>
  42210. <member name="P:NPOI.SS.UserModel.ISheet.FitToPage">
  42211. <summary>
  42212. Flag indicating whether the Fit to Page print option is enabled.
  42213. </summary>
  42214. </member>
  42215. <member name="P:NPOI.SS.UserModel.ISheet.RowSumsBelow">
  42216. <summary>
  42217. Flag indicating whether summary rows appear below detail in an outline, when applying an outline.
  42218. When true a summary row is inserted below the detailed data being summarized and a
  42219. new outline level is established on that row.
  42220. When false a summary row is inserted above the detailed data being summarized and a new outline level
  42221. is established on that row.
  42222. </summary>
  42223. <returns><c>true</c> if row summaries appear below detail in the outline</returns>
  42224. </member>
  42225. <member name="P:NPOI.SS.UserModel.ISheet.RowSumsRight">
  42226. <summary>
  42227. Flag indicating whether summary columns appear to the right of detail in an outline, when applying an outline.
  42228. When true a summary column is inserted to the right of the detailed data being summarized
  42229. and a new outline level is established on that column.
  42230. When false a summary column is inserted to the left of the detailed data being
  42231. summarized and a new outline level is established on that column.
  42232. </summary>
  42233. <returns><c>true</c> if col summaries appear right of the detail in the outline</returns>
  42234. </member>
  42235. <member name="P:NPOI.SS.UserModel.ISheet.IsPrintGridlines">
  42236. <summary>
  42237. Gets the flag indicating whether this sheet displays the lines
  42238. between rows and columns to make editing and reading easier.
  42239. </summary>
  42240. <returns><c>true</c> if this sheet displays gridlines.</returns>
  42241. </member>
  42242. <member name="P:NPOI.SS.UserModel.ISheet.IsPrintRowAndColumnHeadings">
  42243. <summary>
  42244. Get or set the flag indicating whether this sheet prints the
  42245. row and column headings when printing.
  42246. return true if this sheet prints row and column headings.
  42247. </summary>
  42248. </member>
  42249. <member name="P:NPOI.SS.UserModel.ISheet.PrintSetup">
  42250. <summary>
  42251. Gets the print Setup object.
  42252. </summary>
  42253. <returns>The user model for the print Setup object.</returns>
  42254. </member>
  42255. <member name="P:NPOI.SS.UserModel.ISheet.Header">
  42256. <summary>
  42257. Gets the user model for the default document header.
  42258. <p/>
  42259. Note that XSSF offers more kinds of document headers than HSSF does
  42260. </summary>
  42261. <returns>the document header. Never <code>null</code></returns>
  42262. </member>
  42263. <member name="P:NPOI.SS.UserModel.ISheet.Footer">
  42264. <summary>
  42265. Gets the user model for the default document footer.
  42266. <p/>
  42267. Note that XSSF offers more kinds of document footers than HSSF does.
  42268. </summary>
  42269. <returns>the document footer. Never <code>null</code></returns>
  42270. </member>
  42271. <member name="M:NPOI.SS.UserModel.ISheet.GetMargin(NPOI.SS.UserModel.MarginType)">
  42272. <summary>
  42273. Gets the size of the margin in inches.
  42274. </summary>
  42275. <param name="margin">which margin to get</param>
  42276. <returns>the size of the margin</returns>
  42277. </member>
  42278. <member name="M:NPOI.SS.UserModel.ISheet.SetMargin(NPOI.SS.UserModel.MarginType,System.Double)">
  42279. <summary>
  42280. Sets the size of the margin in inches.
  42281. </summary>
  42282. <param name="margin">which margin to get</param>
  42283. <param name="size">the size of the margin</param>
  42284. </member>
  42285. <member name="P:NPOI.SS.UserModel.ISheet.Protect">
  42286. <summary>
  42287. Answer whether protection is enabled or disabled
  42288. </summary>
  42289. <returns>true => protection enabled; false => protection disabled</returns>
  42290. </member>
  42291. <member name="M:NPOI.SS.UserModel.ISheet.ProtectSheet(System.String)">
  42292. <summary>
  42293. Sets the protection enabled as well as the password
  42294. </summary>
  42295. <param name="password">to set for protection. Pass <code>null</code> to remove protection</param>
  42296. </member>
  42297. <member name="P:NPOI.SS.UserModel.ISheet.ScenarioProtect">
  42298. <summary>
  42299. Answer whether scenario protection is enabled or disabled
  42300. </summary>
  42301. <returns>true => protection enabled; false => protection disabled</returns>
  42302. </member>
  42303. <member name="P:NPOI.SS.UserModel.ISheet.TabColorIndex">
  42304. <summary>
  42305. Gets or sets the tab color of the _sheet
  42306. </summary>
  42307. </member>
  42308. <member name="P:NPOI.SS.UserModel.ISheet.DrawingPatriarch">
  42309. <summary>
  42310. Returns the top-level drawing patriach, if there is one.
  42311. This will hold any graphics or charts for the _sheet.
  42312. WARNING - calling this will trigger a parsing of the
  42313. associated escher records. Any that aren't supported
  42314. (such as charts and complex drawing types) will almost
  42315. certainly be lost or corrupted when written out. Only
  42316. use this with simple drawings, otherwise call
  42317. HSSFSheet#CreateDrawingPatriarch() and
  42318. start from scratch!
  42319. </summary>
  42320. <value>The drawing patriarch.</value>
  42321. </member>
  42322. <member name="M:NPOI.SS.UserModel.ISheet.SetZoom(System.Int32,System.Int32)">
  42323. <summary>
  42324. Sets the zoom magnication for the sheet. The zoom is expressed as a
  42325. fraction. For example to express a zoom of 75% use 3 for the numerator
  42326. and 4 for the denominator.
  42327. </summary>
  42328. <param name="numerator">The numerator for the zoom magnification.</param>
  42329. <param name="denominator">denominator for the zoom magnification.</param>
  42330. </member>
  42331. <!-- Badly formed XML comment ignored for member "M:NPOI.SS.UserModel.ISheet.SetZoom(System.Int32)" -->
  42332. <member name="P:NPOI.SS.UserModel.ISheet.TopRow">
  42333. <summary>
  42334. The top row in the visible view when the sheet is
  42335. first viewed after opening it in a viewer
  42336. </summary>
  42337. <value>the rownum (0 based) of the top row.</value>
  42338. </member>
  42339. <member name="P:NPOI.SS.UserModel.ISheet.LeftCol">
  42340. <summary>
  42341. The left col in the visible view when the sheet is
  42342. first viewed after opening it in a viewer
  42343. </summary>
  42344. <value>the rownum (0 based) of the top row</value>
  42345. </member>
  42346. <member name="M:NPOI.SS.UserModel.ISheet.ShowInPane(System.Int32,System.Int32)">
  42347. <summary>
  42348. Sets desktop window pane display area, when the file is first opened in a viewer.
  42349. </summary>
  42350. <param name="toprow">the top row to show in desktop window pane</param>
  42351. <param name="leftcol">the left column to show in desktop window pane</param>
  42352. </member>
  42353. <member name="M:NPOI.SS.UserModel.ISheet.ShiftRows(System.Int32,System.Int32,System.Int32)">
  42354. <summary>
  42355. Shifts rows between startRow and endRow n number of rows.
  42356. If you use a negative number, it will shift rows up.
  42357. Code ensures that rows don't wrap around.
  42358. Calls shiftRows(startRow, endRow, n, false, false);
  42359. Additionally shifts merged regions that are completely defined in these
  42360. rows (ie. merged 2 cells on a row to be shifted).
  42361. </summary>
  42362. <param name="startRow">the row to start shifting</param>
  42363. <param name="endRow">the row to end shifting</param>
  42364. <param name="n">the number of rows to shift</param>
  42365. </member>
  42366. <member name="M:NPOI.SS.UserModel.ISheet.ShiftRows(System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean)">
  42367. <summary>
  42368. Shifts rows between startRow and endRow n number of rows.
  42369. If you use a negative number, it will shift rows up.
  42370. Code ensures that rows don't wrap around
  42371. Additionally shifts merged regions that are completely defined in these
  42372. rows (ie. merged 2 cells on a row to be shifted).
  42373. </summary>
  42374. <param name="startRow">the row to start shifting</param>
  42375. <param name="endRow">the row to end shifting</param>
  42376. <param name="n">the number of rows to shift</param>
  42377. <param name="copyRowHeight">whether to copy the row height during the shift</param>
  42378. <param name="resetOriginalRowHeight">whether to set the original row's height to the default</param>
  42379. </member>
  42380. <member name="M:NPOI.SS.UserModel.ISheet.CreateFreezePane(System.Int32,System.Int32,System.Int32,System.Int32)">
  42381. <summary>
  42382. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  42383. </summary>
  42384. <param name="colSplit">Horizonatal position of split</param>
  42385. <param name="rowSplit">Vertical position of split</param>
  42386. <param name="leftmostColumn">Top row visible in bottom pane</param>
  42387. <param name="topRow">Left column visible in right pane</param>
  42388. </member>
  42389. <member name="M:NPOI.SS.UserModel.ISheet.CreateFreezePane(System.Int32,System.Int32)">
  42390. <summary>
  42391. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  42392. </summary>
  42393. <param name="colSplit">Horizonatal position of split.</param>
  42394. <param name="rowSplit">Vertical position of split.</param>
  42395. </member>
  42396. <member name="M:NPOI.SS.UserModel.ISheet.CreateSplitPane(System.Int32,System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.PanePosition)">
  42397. <summary>
  42398. Creates a split pane. Any existing freezepane or split pane is overwritten.
  42399. </summary>
  42400. <param name="xSplitPos">Horizonatal position of split (in 1/20th of a point)</param>
  42401. <param name="ySplitPos">Vertical position of split (in 1/20th of a point)</param>
  42402. <param name="leftmostColumn">Left column visible in right pane</param>
  42403. <param name="topRow">Top row visible in bottom pane</param>
  42404. <param name="activePane">Active pane. One of: PANE_LOWER_RIGHT, PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT</param>
  42405. @see #PANE_LOWER_LEFT
  42406. @see #PANE_LOWER_RIGHT
  42407. @see #PANE_UPPER_LEFT
  42408. @see #PANE_UPPER_RIGHT
  42409. </member>
  42410. <member name="P:NPOI.SS.UserModel.ISheet.PaneInformation">
  42411. <summary>
  42412. Returns the information regarding the currently configured pane (split or freeze)
  42413. </summary>
  42414. <value>if no pane configured returns <c>null</c> else return the pane information.</value>
  42415. </member>
  42416. <member name="P:NPOI.SS.UserModel.ISheet.DisplayGridlines">
  42417. <summary>
  42418. Returns if gridlines are displayed
  42419. </summary>
  42420. </member>
  42421. <member name="P:NPOI.SS.UserModel.ISheet.DisplayFormulas">
  42422. <summary>
  42423. Returns if formulas are displayed
  42424. </summary>
  42425. </member>
  42426. <member name="P:NPOI.SS.UserModel.ISheet.DisplayRowColHeadings">
  42427. <summary>
  42428. Returns if RowColHeadings are displayed.
  42429. </summary>
  42430. </member>
  42431. <member name="P:NPOI.SS.UserModel.ISheet.IsActive">
  42432. <summary>
  42433. Returns if RowColHeadings are displayed.
  42434. </summary>
  42435. </member>
  42436. <member name="M:NPOI.SS.UserModel.ISheet.IsRowBroken(System.Int32)">
  42437. <summary>
  42438. Determines if there is a page break at the indicated row
  42439. </summary>
  42440. <param name="row">The row.</param>
  42441. </member>
  42442. <member name="M:NPOI.SS.UserModel.ISheet.RemoveRowBreak(System.Int32)">
  42443. <summary>
  42444. Removes the page break at the indicated row
  42445. </summary>
  42446. <param name="row">The row index.</param>
  42447. </member>
  42448. <member name="P:NPOI.SS.UserModel.ISheet.RowBreaks">
  42449. <summary>
  42450. Retrieves all the horizontal page breaks
  42451. </summary>
  42452. <value>all the horizontal page breaks, or null if there are no row page breaks</value>
  42453. </member>
  42454. <member name="P:NPOI.SS.UserModel.ISheet.ColumnBreaks">
  42455. <summary>
  42456. Retrieves all the vertical page breaks
  42457. </summary>
  42458. <value>all the vertical page breaks, or null if there are no column page breaks.</value>
  42459. </member>
  42460. <member name="M:NPOI.SS.UserModel.ISheet.SetActiveCellRange(System.Int32,System.Int32,System.Int32,System.Int32)">
  42461. <summary>
  42462. Sets the active cell range.
  42463. </summary>
  42464. <param name="firstRow">The firstrow.</param>
  42465. <param name="lastRow">The lastrow.</param>
  42466. <param name="firstColumn">The firstcolumn.</param>
  42467. <param name="lastColumn">The lastcolumn.</param>
  42468. </member>
  42469. <member name="M:NPOI.SS.UserModel.ISheet.SetActiveCellRange(System.Collections.Generic.List{NPOI.SS.Util.CellRangeAddress8Bit},System.Int32,System.Int32,System.Int32)">
  42470. <summary>
  42471. Sets the active cell range.
  42472. </summary>
  42473. <param name="cellranges">The cellranges.</param>
  42474. <param name="activeRange">The index of the active range.</param>
  42475. <param name="activeRow">The active row in the active range</param>
  42476. <param name="activeColumn">The active column in the active range</param>
  42477. </member>
  42478. <member name="M:NPOI.SS.UserModel.ISheet.SetColumnBreak(System.Int32)">
  42479. <summary>
  42480. Sets a page break at the indicated column
  42481. </summary>
  42482. <param name="column">The column.</param>
  42483. </member>
  42484. <member name="M:NPOI.SS.UserModel.ISheet.SetRowBreak(System.Int32)">
  42485. <summary>
  42486. Sets the row break.
  42487. </summary>
  42488. <param name="row">The row.</param>
  42489. </member>
  42490. <member name="M:NPOI.SS.UserModel.ISheet.IsColumnBroken(System.Int32)">
  42491. <summary>
  42492. Determines if there is a page break at the indicated column
  42493. </summary>
  42494. <param name="column">The column index.</param>
  42495. </member>
  42496. <member name="M:NPOI.SS.UserModel.ISheet.RemoveColumnBreak(System.Int32)">
  42497. <summary>
  42498. Removes a page break at the indicated column
  42499. </summary>
  42500. <param name="column">The column.</param>
  42501. </member>
  42502. <member name="M:NPOI.SS.UserModel.ISheet.SetColumnGroupCollapsed(System.Int32,System.Boolean)">
  42503. <summary>
  42504. Expands or collapses a column group.
  42505. </summary>
  42506. <param name="columnNumber">One of the columns in the group.</param>
  42507. <param name="collapsed">if set to <c>true</c>collapse group.<c>false</c>expand group.</param>
  42508. </member>
  42509. <member name="M:NPOI.SS.UserModel.ISheet.GroupColumn(System.Int32,System.Int32)">
  42510. <summary>
  42511. Create an outline for the provided column range.
  42512. </summary>
  42513. <param name="fromColumn">beginning of the column range.</param>
  42514. <param name="toColumn">end of the column range.</param>
  42515. </member>
  42516. <member name="M:NPOI.SS.UserModel.ISheet.UngroupColumn(System.Int32,System.Int32)">
  42517. <summary>
  42518. Ungroup a range of columns that were previously groupped
  42519. </summary>
  42520. <param name="fromColumn">start column (0-based).</param>
  42521. <param name="toColumn">end column (0-based).</param>
  42522. </member>
  42523. <member name="M:NPOI.SS.UserModel.ISheet.GroupRow(System.Int32,System.Int32)">
  42524. <summary>
  42525. Tie a range of rows toGether so that they can be collapsed or expanded
  42526. </summary>
  42527. <param name="fromRow">start row (0-based)</param>
  42528. <param name="toRow">end row (0-based)</param>
  42529. </member>
  42530. <member name="M:NPOI.SS.UserModel.ISheet.UngroupRow(System.Int32,System.Int32)">
  42531. <summary>
  42532. Ungroup a range of rows that were previously groupped
  42533. </summary>
  42534. <param name="fromRow">start row (0-based)</param>
  42535. <param name="toRow">end row (0-based)</param>
  42536. </member>
  42537. <member name="M:NPOI.SS.UserModel.ISheet.SetRowGroupCollapsed(System.Int32,System.Boolean)">
  42538. <summary>
  42539. Set view state of a groupped range of rows
  42540. </summary>
  42541. <param name="row">start row of a groupped range of rows (0-based).</param>
  42542. <param name="collapse">whether to expand/collapse the detail rows.</param>
  42543. </member>
  42544. <member name="M:NPOI.SS.UserModel.ISheet.SetDefaultColumnStyle(System.Int32,NPOI.SS.UserModel.ICellStyle)">
  42545. <summary>
  42546. Sets the default column style for a given column. POI will only apply this style to new cells Added to the sheet.
  42547. </summary>
  42548. <param name="column">the column index</param>
  42549. <param name="style">the style to set</param>
  42550. </member>
  42551. <member name="M:NPOI.SS.UserModel.ISheet.AutoSizeColumn(System.Int32)">
  42552. <summary>
  42553. Adjusts the column width to fit the contents.
  42554. </summary>
  42555. <param name="column">the column index</param>
  42556. <remarks>
  42557. This process can be relatively slow on large sheets, so this should
  42558. normally only be called once per column, at the end of your
  42559. processing.
  42560. </remarks>
  42561. </member>
  42562. <member name="M:NPOI.SS.UserModel.ISheet.AutoSizeColumn(System.Int32,System.Boolean)">
  42563. <summary>
  42564. Adjusts the column width to fit the contents.
  42565. </summary>
  42566. <param name="column">the column index.</param>
  42567. <param name="useMergedCells">whether to use the contents of merged cells when
  42568. calculating the width of the column. Default is to ignore merged cells.</param>
  42569. <remarks>
  42570. This process can be relatively slow on large sheets, so this should
  42571. normally only be called once per column, at the end of your
  42572. processing.
  42573. </remarks>
  42574. </member>
  42575. <member name="M:NPOI.SS.UserModel.ISheet.AutoSizeRow(System.Int32)">
  42576. <summary>
  42577. Adjusts the row height to fit the contents.
  42578. </summary>
  42579. <param name="row">the row index</param>
  42580. <remarks>
  42581. This process can be relatively slow on large sheets, so this should
  42582. normally only be called once per row, at the end of your
  42583. processing.
  42584. </remarks>
  42585. </member>
  42586. <member name="M:NPOI.SS.UserModel.ISheet.AutoSizeRow(System.Int32,System.Boolean)">
  42587. <summary>
  42588. Adjusts the row height to fit the contents.
  42589. </summary>
  42590. <param name="row">the row index.</param>
  42591. <param name="useMergedCells">whether to use the contents of merged cells when
  42592. calculating the height of the row. Default is to ignore merged cells.</param>
  42593. <remarks>
  42594. This process can be relatively slow on large sheets, so this should
  42595. normally only be called once per row, at the end of your
  42596. processing.
  42597. </remarks>
  42598. </member>
  42599. <member name="M:NPOI.SS.UserModel.ISheet.GetCellComment(System.Int32,System.Int32)">
  42600. <summary>
  42601. Returns cell comment for the specified row and column
  42602. </summary>
  42603. <param name="row">The row.</param>
  42604. <param name="column">The column.</param>
  42605. </member>
  42606. <member name="M:NPOI.SS.UserModel.ISheet.GetCellComment(NPOI.SS.Util.CellAddress)">
  42607. <summary>
  42608. Returns cell comment for the specified location
  42609. </summary>
  42610. <param name="ref1">cell location</param>
  42611. <returns>return cell comment or null if not found</returns>
  42612. </member>
  42613. <member name="M:NPOI.SS.UserModel.ISheet.GetCellComments">
  42614. <summary>
  42615. Returns all cell comments on this sheet.
  42616. </summary>
  42617. <returns>return A Dictionary of each Comment in the sheet, keyed on the cell address where the comment is located.</returns>
  42618. </member>
  42619. <member name="M:NPOI.SS.UserModel.ISheet.CreateDrawingPatriarch">
  42620. <summary>
  42621. Creates the top-level drawing patriarch.
  42622. </summary>
  42623. </member>
  42624. <member name="P:NPOI.SS.UserModel.ISheet.Workbook">
  42625. <summary>
  42626. Gets the parent workbook.
  42627. </summary>
  42628. </member>
  42629. <member name="P:NPOI.SS.UserModel.ISheet.SheetName">
  42630. <summary>
  42631. Gets the name of the sheet.
  42632. </summary>
  42633. </member>
  42634. <member name="P:NPOI.SS.UserModel.ISheet.IsSelected">
  42635. <summary>
  42636. Gets or sets a value indicating whether this sheet is currently selected.
  42637. </summary>
  42638. </member>
  42639. <member name="M:NPOI.SS.UserModel.ISheet.SetActive(System.Boolean)">
  42640. <summary>
  42641. Sets whether sheet is selected.
  42642. </summary>
  42643. <param name="value">Whether to select the sheet or deselect the sheet.</param>
  42644. </member>
  42645. <member name="M:NPOI.SS.UserModel.ISheet.SetArrayFormula(System.String,NPOI.SS.Util.CellRangeAddress)">
  42646. <summary>
  42647. Sets array formula to specified region for result.
  42648. </summary>
  42649. <param name="formula">text representation of the formula</param>
  42650. <param name="range">Region of array formula for result</param>
  42651. <returns>the <see cref="T:NPOI.SS.UserModel.ICellRange`1"/> of cells affected by this change</returns>
  42652. </member>
  42653. <member name="M:NPOI.SS.UserModel.ISheet.RemoveArrayFormula(NPOI.SS.UserModel.ICell)">
  42654. <summary>
  42655. Remove a Array Formula from this sheet. All cells contained in the Array Formula range are removed as well
  42656. </summary>
  42657. <param name="cell">any cell within Array Formula range</param>
  42658. <returns>the <see cref="T:NPOI.SS.UserModel.ICellRange`1"/> of cells affected by this change</returns>
  42659. </member>
  42660. <member name="M:NPOI.SS.UserModel.ISheet.IsMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  42661. <summary>
  42662. Checks if the provided region is part of the merged regions.
  42663. </summary>
  42664. <param name="mergedRegion">Region searched in the merged regions</param>
  42665. <returns><c>true</c>, when the region is contained in at least one of the merged regions</returns>
  42666. </member>
  42667. <member name="M:NPOI.SS.UserModel.ISheet.GetDataValidationHelper">
  42668. <summary>
  42669. Create an instance of a DataValidationHelper.
  42670. </summary>
  42671. <returns>Instance of a DataValidationHelper</returns>
  42672. </member>
  42673. <member name="M:NPOI.SS.UserModel.ISheet.GetDataValidations">
  42674. <summary>
  42675. Returns the list of DataValidation in the sheet.
  42676. </summary>
  42677. <returns>list of DataValidation in the sheet</returns>
  42678. </member>
  42679. <member name="M:NPOI.SS.UserModel.ISheet.AddValidationData(NPOI.SS.UserModel.IDataValidation)">
  42680. <summary>
  42681. Creates a data validation object
  42682. </summary>
  42683. <param name="dataValidation">The data validation object settings</param>
  42684. </member>
  42685. <member name="M:NPOI.SS.UserModel.ISheet.SetAutoFilter(NPOI.SS.Util.CellRangeAddress)">
  42686. <summary>
  42687. Enable filtering for a range of cells
  42688. </summary>
  42689. <param name="range">the range of cells to filter</param>
  42690. </member>
  42691. <member name="P:NPOI.SS.UserModel.ISheet.SheetConditionalFormatting">
  42692. <summary>
  42693. The 'Conditional Formatting' facet for this <c>Sheet</c>
  42694. </summary>
  42695. <returns>conditional formatting rule for this sheet</returns>
  42696. </member>
  42697. <member name="P:NPOI.SS.UserModel.ISheet.IsRightToLeft">
  42698. <summary>
  42699. Whether the text is displayed in right-to-left mode in the window
  42700. </summary>
  42701. </member>
  42702. <member name="P:NPOI.SS.UserModel.ISheet.RepeatingRows">
  42703. <summary>
  42704. Get or set the repeating rows used when printing the sheet, as found in File->PageSetup->Sheet.
  42705. <p/>
  42706. Repeating rows cover a range of contiguous rows, e.g.:
  42707. <pre>
  42708. Sheet1!$1:$1
  42709. Sheet2!$5:$8
  42710. </pre>
  42711. The {@link CellRangeAddress} returned contains a column part which spans
  42712. all columns, and a row part which specifies the contiguous range of
  42713. repeating rows.
  42714. <p/>
  42715. If the Sheet does not have any repeating rows defined, null is returned.
  42716. </summary>
  42717. </member>
  42718. <member name="P:NPOI.SS.UserModel.ISheet.RepeatingColumns">
  42719. <summary>
  42720. Gets or set the repeating columns used when printing the sheet, as found in File->PageSetup->Sheet.
  42721. <p/>
  42722. Repeating columns cover a range of contiguous columns, e.g.:
  42723. <pre>
  42724. Sheet1!$A:$A
  42725. Sheet2!$C:$F
  42726. </pre>
  42727. The {@link CellRangeAddress} returned contains a row part which spans all
  42728. rows, and a column part which specifies the contiguous range of
  42729. repeating columns.
  42730. <p/>
  42731. If the Sheet does not have any repeating columns defined, null is
  42732. returned.
  42733. </summary>
  42734. </member>
  42735. <member name="M:NPOI.SS.UserModel.ISheet.CopySheet(System.String)">
  42736. <summary>
  42737. Copy sheet with a new name
  42738. </summary>
  42739. <param name="Name">new sheet name</param>
  42740. <returns>cloned sheet</returns>
  42741. </member>
  42742. <member name="M:NPOI.SS.UserModel.ISheet.CopySheet(System.String,System.Boolean)">
  42743. <summary>
  42744. Copy sheet with a new name
  42745. </summary>
  42746. <param name="Name">new sheet name</param>
  42747. <param name="copyStyle">whether to copy styles</param>
  42748. <returns>cloned sheet</returns>
  42749. </member>
  42750. <member name="M:NPOI.SS.UserModel.ISheet.GetColumnOutlineLevel(System.Int32)">
  42751. <summary>
  42752. Returns the column outline level. Increased as you
  42753. put it into more groups (outlines), reduced as
  42754. you take it out of them.
  42755. </summary>
  42756. <param name="columnIndex"></param>
  42757. <returns></returns>
  42758. </member>
  42759. <member name="M:NPOI.SS.UserModel.ISheet.GetHyperlink(System.Int32,System.Int32)">
  42760. <summary>
  42761. Get a Hyperlink in this sheet anchored at row, column
  42762. </summary>
  42763. <param name="row"></param>
  42764. <param name="column"></param>
  42765. <returns>return hyperlink if there is a hyperlink anchored at row, column; otherwise returns null</returns>
  42766. </member>
  42767. <member name="M:NPOI.SS.UserModel.ISheet.GetHyperlink(NPOI.SS.Util.CellAddress)">
  42768. <summary>
  42769. Get a Hyperlink in this sheet located in a cell specified by {code addr}
  42770. </summary>
  42771. <param name="addr">The address of the cell containing the hyperlink</param>
  42772. <returns>return hyperlink if there is a hyperlink anchored at {@code addr}; otherwise returns {@code null}</returns>
  42773. </member>
  42774. <member name="M:NPOI.SS.UserModel.ISheet.GetHyperlinkList">
  42775. <summary>
  42776. Get a list of Hyperlinks in this sheet
  42777. </summary>
  42778. <returns>return Hyperlinks for the sheet</returns>
  42779. </member>
  42780. <member name="P:NPOI.SS.UserModel.ISheet.ActiveCell">
  42781. <summary>
  42782. get or set location of the active cell, e.g. <code>A1</code>.
  42783. </summary>
  42784. </member>
  42785. <member name="T:NPOI.SS.UserModel.ISheetConditionalFormatting">
  42786. The 'Conditional Formatting' facet of <c>Sheet</c>
  42787. @author Dmitriy Kumshayev
  42788. @author Yegor Kozlov
  42789. @since 3.8
  42790. </member>
  42791. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule)">
  42792. <summary>
  42793. Add a new Conditional Formatting to the sheet.
  42794. </summary>
  42795. <param name="regions">list of rectangular regions to apply conditional formatting rules</param>
  42796. <param name="rule">the rule to apply</param>
  42797. <returns>index of the newly Created Conditional Formatting object</returns>
  42798. </member>
  42799. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule,NPOI.SS.UserModel.IConditionalFormattingRule)">
  42800. <summary>
  42801. Add a new Conditional Formatting consisting of two rules.
  42802. </summary>
  42803. <param name="regions"> list of rectangular regions to apply conditional formatting rules</param>
  42804. <param name="rule1">the first rule</param>
  42805. <param name="rule2">the second rule</param>
  42806. <returns>index of the newly Created Conditional Formatting object</returns>
  42807. </member>
  42808. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule[])">
  42809. <summary>
  42810. Add a new Conditional Formatting Set to the sheet.
  42811. </summary>
  42812. <param name="regions">list of rectangular regions to apply conditional formatting rules</param>
  42813. <param name="cfRules">Set of up to three conditional formatting rules</param>
  42814. <returns>index of the newly Created Conditional Formatting object</returns>
  42815. </member>
  42816. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.UserModel.IConditionalFormatting)">
  42817. <summary>
  42818. Adds a copy of a ConditionalFormatting object to the sheet
  42819. </summary>
  42820. <param name="cf">the Conditional Formatting to clone</param>
  42821. <returns>index of the new Conditional Formatting object</returns>
  42822. <remarks>
  42823. This method could be used to copy ConditionalFormatting object
  42824. from one sheet to another. For example:
  42825. ConditionalFormatting cf = sheet.GetConditionalFormattingAt(index);
  42826. newSheet.AddConditionalFormatting(cf);
  42827. </remarks>
  42828. </member>
  42829. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.ComparisonOperator,System.String,System.String)">
  42830. A factory method allowing to create a conditional formatting rule
  42831. with a cell comparison operator
  42832. <p>
  42833. The Created conditional formatting rule Compares a cell value
  42834. to a formula calculated result, using the specified operator.
  42835. The type of the Created condition is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS}
  42836. </p>
  42837. @param comparisonOperation - MUST be a constant value from
  42838. <c>{@link ComparisonOperator}</c>: <p>
  42839. <ul>
  42840. <li>BETWEEN</li>
  42841. <li>NOT_BETWEEN</li>
  42842. <li>EQUAL</li>
  42843. <li>NOT_EQUAL</li>
  42844. <li>GT</li>
  42845. <li>LT</li>
  42846. <li>GE</li>
  42847. <li>LE</li>
  42848. </ul>
  42849. </p>
  42850. @param formula1 - formula for the valued, Compared with the cell
  42851. @param formula2 - second formula (only used with
  42852. {@link ComparisonOperator#BETWEEN}) and {@link ComparisonOperator#NOT_BETWEEN} operations)
  42853. </member>
  42854. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.ComparisonOperator,System.String)">
  42855. <summary>
  42856. Create a conditional formatting rule that Compares a cell value to a formula calculated result, using an operator
  42857. </summary>
  42858. <param name="comparisonOperation">MUST be a constant value from ComparisonOperator except BETWEEN and NOT_BETWEEN</param>
  42859. <param name="formula">the formula to determine if the conditional formatting is applied</param>
  42860. <returns>a conditional formatting rule</returns>
  42861. </member>
  42862. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.CreateConditionalFormattingRule(System.String)">
  42863. <summary>
  42864. Create a conditional formatting rule based on a Boolean formula.
  42865. When the formula result is true, the cell is highlighted.
  42866. </summary>
  42867. <param name="formula">the formula to Evaluate. MUST be a Boolean function.</param>
  42868. <returns>conditional formatting rule</returns>
  42869. </member>
  42870. <!-- Badly formed XML comment ignored for member "M:NPOI.SS.UserModel.ISheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.ExtendedColor)" -->
  42871. <!-- Badly formed XML comment ignored for member "M:NPOI.SS.UserModel.ISheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.IconSet)" -->
  42872. <!-- Badly formed XML comment ignored for member "M:NPOI.SS.UserModel.ISheetConditionalFormatting.CreateConditionalFormattingColorScaleRule" -->
  42873. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.GetConditionalFormattingAt(System.Int32)">
  42874. <summary>
  42875. Gets Conditional Formatting object at a particular index
  42876. </summary>
  42877. <param name="index">0-based index of the Conditional Formatting object to fetch</param>
  42878. <returns>Conditional Formatting object or null if not found</returns>
  42879. <exception cref="T:System.ArgumentException">throws ArgumentException if the index is outside of the allowable range (0 ... numberOfFormats-1)</exception>
  42880. </member>
  42881. <member name="P:NPOI.SS.UserModel.ISheetConditionalFormatting.NumConditionalFormattings">
  42882. <summary>
  42883. get the number of conditional formats in this sheet
  42884. </summary>
  42885. </member>
  42886. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.RemoveConditionalFormatting(System.Int32)">
  42887. <summary>
  42888. Removes a Conditional Formatting object by index
  42889. </summary>
  42890. <param name="index">0-based index of the Conditional Formatting object to remove</param>
  42891. <exception cref="T:System.ArgumentException">throws ArgumentException if the index is outside of the allowable range (0 ... numberOfFormats-1)</exception>
  42892. </member>
  42893. <member name="F:NPOI.SS.UserModel.Table.IsStructuredReference">
  42894. Regular expression matching a Structured Reference (Table syntax) for XSSF table expressions.
  42895. Public for unit tests
  42896. @see <a href="https://support.office.com/en-us/article/Using-structured-references-with-Excel-tables-F5ED2452-2337-4F71-BED3-C8AE6D2B276E">
  42897. Excel Structured Reference Syntax
  42898. </a>
  42899. </member>
  42900. <member name="T:NPOI.SS.UserModel.ITable">
  42901. XSSF Only!
  42902. High level abstraction of table in a workbook.
  42903. </member>
  42904. <member name="P:NPOI.SS.UserModel.ITable.StartColIndex">
  42905. Get the top-left column index relative to the sheet
  42906. @return table start column index on sheet
  42907. </member>
  42908. <member name="P:NPOI.SS.UserModel.ITable.StartRowIndex">
  42909. Get the top-left row index on the sheet
  42910. @return table start row index on sheet
  42911. </member>
  42912. <member name="P:NPOI.SS.UserModel.ITable.EndColIndex">
  42913. Get the bottom-right column index on the sheet
  42914. @return table end column index on sheet
  42915. </member>
  42916. <member name="P:NPOI.SS.UserModel.ITable.EndRowIndex">
  42917. Get the bottom-right row index
  42918. @return table end row index on sheet
  42919. </member>
  42920. <member name="P:NPOI.SS.UserModel.ITable.Name">
  42921. Get the name of the table.
  42922. @return table name
  42923. </member>
  42924. <member name="M:NPOI.SS.UserModel.ITable.FindColumnIndex(System.String)">
  42925. Returns the index of a given named column in the table (names are case insensitive in XSSF).
  42926. Note this list is lazily loaded and cached for performance.
  42927. Changes to the underlying table structure are not reflected in later calls
  42928. unless <code>XSSFTable.UpdateHeaders()</code> is called to reset the cache.
  42929. @param columnHeader the column header name to Get the table column index of
  42930. @return column index corresponding to <code>columnHeader</code>
  42931. </member>
  42932. <member name="P:NPOI.SS.UserModel.ITable.SheetName">
  42933. Returns the sheet name that the table belongs to.
  42934. </member>
  42935. <member name="P:NPOI.SS.UserModel.ITable.IsHasTotalsRow">
  42936. Returns true iff the table has a 'Totals' row
  42937. </member>
  42938. <member name="P:NPOI.SS.UserModel.ITableStyleInfo.IsShowRowStripes">
  42939. <summary>
  42940. return true if alternating row styles should be applied
  42941. </summary>
  42942. </member>
  42943. <member name="P:NPOI.SS.UserModel.ITableStyleInfo.IsShowFirstColumn">
  42944. <summary>
  42945. return true if the distinct first column style should be applied
  42946. </summary>
  42947. </member>
  42948. <member name="P:NPOI.SS.UserModel.ITableStyleInfo.IsShowLastColumn">
  42949. <summary>
  42950. return true if the distinct last column style should be applied
  42951. </summary>
  42952. </member>
  42953. <member name="P:NPOI.SS.UserModel.ITableStyleInfo.Name">
  42954. <summary>
  42955. return the name of the style (may reference a built-in style)
  42956. </summary>
  42957. </member>
  42958. <member name="P:NPOI.SS.UserModel.ITableStyleInfo.Style">
  42959. <summary>
  42960. style definition
  42961. </summary>
  42962. </member>
  42963. <member name="P:NPOI.SS.UserModel.ITextbox.String">
  42964. @return the rich text string for this textbox.
  42965. </member>
  42966. <member name="P:NPOI.SS.UserModel.ITextbox.MarginLeft">
  42967. @return Returns the left margin within the textbox.
  42968. </member>
  42969. <member name="P:NPOI.SS.UserModel.ITextbox.MarginRight">
  42970. @return returns the right margin within the textbox.
  42971. </member>
  42972. <member name="P:NPOI.SS.UserModel.ITextbox.MarginTop">
  42973. @return returns the top margin within the textbox.
  42974. </member>
  42975. <member name="P:NPOI.SS.UserModel.ITextbox.MarginBottom">
  42976. s the bottom margin within the textbox.
  42977. </member>
  42978. <member name="T:NPOI.SS.UserModel.VerticalAlignment">
  42979. This enumeration value indicates the type of vertical alignment for a cell, i.e.,
  42980. whether it is aligned top, bottom, vertically centered, justified or distributed.
  42981. </member>
  42982. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Top">
  42983. The vertical alignment is aligned-to-top.
  42984. </member>
  42985. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Center">
  42986. The vertical alignment is centered across the height of the cell.
  42987. </member>
  42988. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Bottom">
  42989. The vertical alignment is aligned-to-bottom.
  42990. </member>
  42991. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Justify">
  42992. <p>
  42993. When text direction is horizontal: the vertical alignment of lines of text is distributed vertically,
  42994. where each line of text inside the cell is evenly distributed across the height of the cell,
  42995. with flush top and bottom margins.
  42996. </p>
  42997. <p>
  42998. When text direction is vertical: similar behavior as horizontal justification.
  42999. The alignment is justified (flush top and bottom in this case). For each line of text, each
  43000. line of the wrapped text in a cell is aligned to the top and bottom (except the last line).
  43001. If no single line of text wraps in the cell, then the text is not justified.
  43002. </p>
  43003. </member>
  43004. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Distributed">
  43005. <p>
  43006. When text direction is horizontal: the vertical alignment of lines of text is distributed vertically,
  43007. where each line of text inside the cell is evenly distributed across the height of the cell,
  43008. with flush top
  43009. </p>
  43010. <p>
  43011. When text direction is vertical: behaves exactly as distributed horizontal alignment.
  43012. The first words in a line of text (appearing at the top of the cell) are flush
  43013. with the top edge of the cell, and the last words of a line of text are flush with the bottom edge of the cell,
  43014. and the line of text is distributed evenly from top to bottom.
  43015. </p>
  43016. </member>
  43017. <member name="F:NPOI.SS.UserModel.SheetState.Visible">
  43018. <summary>
  43019. Indicates the sheet is visible.
  43020. </summary>
  43021. </member>
  43022. <member name="F:NPOI.SS.UserModel.SheetState.Hidden">
  43023. <summary>
  43024. Indicates the book window is hidden, but can be shown by the user via the user interface.
  43025. </summary>
  43026. </member>
  43027. <member name="F:NPOI.SS.UserModel.SheetState.VeryHidden">
  43028. <summary>
  43029. Indicates the sheet is hidden and cannot be shown in the user interface (UI).
  43030. </summary>
  43031. <remarks>
  43032. In Excel this state is only available programmatically in VBA:
  43033. ThisWorkbook.Sheets("MySheetName").Visible = xlSheetVeryHidden
  43034. </remarks>
  43035. </member>
  43036. <member name="T:NPOI.SS.UserModel.IWorkbook">
  43037. <summary>
  43038. High level interface of a Excel workbook. This is the first object most users
  43039. will construct whether they are reading or writing a workbook. It is also the
  43040. top level object for creating new sheets/etc.
  43041. This interface is shared between the implementation specific to xls and xlsx.
  43042. This way it is possible to access Excel workbooks stored in both formats.
  43043. </summary>
  43044. </member>
  43045. <member name="P:NPOI.SS.UserModel.IWorkbook.ActiveSheetIndex">
  43046. <summary>
  43047. get the active sheet. The active sheet is is the sheet
  43048. which is currently displayed when the workbook is viewed in Excel.
  43049. </summary>
  43050. </member>
  43051. <member name="P:NPOI.SS.UserModel.IWorkbook.FirstVisibleTab">
  43052. <summary>
  43053. Gets the first tab that is displayed in the list of tabs in excel.
  43054. </summary>
  43055. </member>
  43056. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSheetOrder(System.String,System.Int32)">
  43057. <summary>
  43058. Sets the order of appearance for a given sheet.
  43059. </summary>
  43060. <param name="sheetname">the name of the sheet to reorder</param>
  43061. <param name="pos">the position that we want to insert the sheet into (0 based)</param>
  43062. </member>
  43063. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSelectedTab(System.Int32)">
  43064. <summary>
  43065. Sets the tab whose data is actually seen when the sheet is opened.
  43066. This may be different from the "selected sheet" since excel seems to
  43067. allow you to show the data of one sheet when another is seen "selected"
  43068. in the tabs (at the bottom).
  43069. </summary>
  43070. <param name="index">the index of the sheet to select (0 based)</param>
  43071. </member>
  43072. <member name="M:NPOI.SS.UserModel.IWorkbook.SetActiveSheet(System.Int32)">
  43073. <summary>
  43074. set the active sheet. The active sheet is is the sheet
  43075. which is currently displayed when the workbook is viewed in Excel.
  43076. </summary>
  43077. <param name="sheetIndex">index of the active sheet (0-based)</param>
  43078. </member>
  43079. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheetName(System.Int32)">
  43080. <summary>
  43081. Set the sheet name
  43082. </summary>
  43083. <param name="sheet">sheet number (0 based)</param>
  43084. <returns>Sheet name</returns>
  43085. </member>
  43086. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSheetName(System.Int32,System.String)">
  43087. <summary>
  43088. Set the sheet name.
  43089. </summary>
  43090. <param name="sheet">sheet number (0 based)</param>
  43091. <param name="name">sheet name</param>
  43092. </member>
  43093. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheetIndex(System.String)">
  43094. <summary>
  43095. Returns the index of the sheet by its name
  43096. </summary>
  43097. <param name="name">the sheet name</param>
  43098. <returns>index of the sheet (0 based)</returns>
  43099. </member>
  43100. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheetIndex(NPOI.SS.UserModel.ISheet)">
  43101. <summary>
  43102. Returns the index of the given sheet
  43103. </summary>
  43104. <param name="sheet">the sheet to look up</param>
  43105. <returns>index of the sheet (0 based)</returns>
  43106. </member>
  43107. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateSheet">
  43108. <summary>
  43109. Sreate an Sheet for this Workbook, Adds it to the sheets and returns
  43110. the high level representation. Use this to create new sheets.
  43111. </summary>
  43112. <returns></returns>
  43113. </member>
  43114. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateSheet(System.String)">
  43115. <summary>
  43116. Create an Sheet for this Workbook, Adds it to the sheets and returns
  43117. the high level representation. Use this to create new sheets.
  43118. </summary>
  43119. <param name="sheetname">sheetname to set for the sheet.</param>
  43120. <returns>Sheet representing the new sheet.</returns>
  43121. </member>
  43122. <member name="M:NPOI.SS.UserModel.IWorkbook.CloneSheet(System.Int32)">
  43123. <summary>
  43124. Create an Sheet from an existing sheet in the Workbook.
  43125. </summary>
  43126. <param name="sheetNum"></param>
  43127. <returns></returns>
  43128. </member>
  43129. <member name="P:NPOI.SS.UserModel.IWorkbook.NumberOfSheets">
  43130. <summary>
  43131. Get the number of spreadsheets in the workbook
  43132. </summary>
  43133. </member>
  43134. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheetAt(System.Int32)">
  43135. <summary>
  43136. Get the Sheet object at the given index.
  43137. </summary>
  43138. <param name="index">index of the sheet number (0-based physical &amp; logical)</param>
  43139. <returns>Sheet at the provided index</returns>
  43140. </member>
  43141. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheet(System.String)">
  43142. <summary>
  43143. Get sheet with the given name
  43144. </summary>
  43145. <param name="name">name of the sheet</param>
  43146. <returns>Sheet with the name provided or null if it does not exist</returns>
  43147. </member>
  43148. <member name="M:NPOI.SS.UserModel.IWorkbook.RemoveSheetAt(System.Int32)">
  43149. <summary>
  43150. Removes sheet at the given index
  43151. </summary>
  43152. <param name="index"></param>
  43153. </member>
  43154. <member name="M:NPOI.SS.UserModel.IWorkbook.GetEnumerator">
  43155. <summary>
  43156. Enumerate sheets
  43157. </summary>
  43158. <returns></returns>
  43159. </member>
  43160. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateFont">
  43161. <summary>
  43162. Create a new Font and add it to the workbook's font table
  43163. </summary>
  43164. <returns></returns>
  43165. </member>
  43166. <member name="M:NPOI.SS.UserModel.IWorkbook.FindFont(System.Int16,System.Int16,System.Int16,System.String,System.Boolean,System.Boolean,NPOI.SS.UserModel.FontSuperScript,NPOI.SS.UserModel.FontUnderlineType)">
  43167. <summary>
  43168. Finds a font that matches the one with the supplied attributes
  43169. </summary>
  43170. <param name="boldWeight"></param>
  43171. <param name="color"></param>
  43172. <param name="fontHeight"></param>
  43173. <param name="name"></param>
  43174. <param name="italic"></param>
  43175. <param name="strikeout"></param>
  43176. <param name="typeOffset"></param>
  43177. <param name="underline"></param>
  43178. <returns>the font with the matched attributes or null</returns>
  43179. </member>
  43180. <member name="M:NPOI.SS.UserModel.IWorkbook.FindFont(System.Boolean,System.Int16,System.Int16,System.String,System.Boolean,System.Boolean,NPOI.SS.UserModel.FontSuperScript,NPOI.SS.UserModel.FontUnderlineType)">
  43181. <summary>
  43182. Finds a font that matches the one with the supplied attributes
  43183. </summary>
  43184. <param name="bold"></param>
  43185. <param name="color"></param>
  43186. <param name="fontHeight"></param>
  43187. <param name="name"></param>
  43188. <param name="italic"></param>
  43189. <param name="strikeout"></param>
  43190. <param name="typeOffset"></param>
  43191. <param name="underline"></param>
  43192. <returns>the font with the matched attributes or null</returns>
  43193. </member>
  43194. <member name="P:NPOI.SS.UserModel.IWorkbook.NumberOfFonts">
  43195. <summary>
  43196. Get the number of fonts in the font table
  43197. </summary>
  43198. </member>
  43199. <member name="M:NPOI.SS.UserModel.IWorkbook.GetFontAt(System.Int16)">
  43200. <summary>
  43201. Get the font at the given index number
  43202. </summary>
  43203. <param name="idx">index number (0-based)</param>
  43204. <returns>font at the index</returns>
  43205. </member>
  43206. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateCellStyle">
  43207. <summary>
  43208. Create a new Cell style and add it to the workbook's style table
  43209. </summary>
  43210. <returns>the new Cell Style object</returns>
  43211. </member>
  43212. <member name="P:NPOI.SS.UserModel.IWorkbook.NumCellStyles">
  43213. <summary>
  43214. Get the number of styles the workbook Contains
  43215. </summary>
  43216. </member>
  43217. <member name="M:NPOI.SS.UserModel.IWorkbook.GetCellStyleAt(System.Int32)">
  43218. <summary>
  43219. Get the cell style object at the given index
  43220. </summary>
  43221. <param name="idx">index within the set of styles (0-based)</param>
  43222. <returns>CellStyle object at the index</returns>
  43223. </member>
  43224. <member name="M:NPOI.SS.UserModel.IWorkbook.Write(System.IO.Stream,System.Boolean)">
  43225. <summary>
  43226. Write out this workbook to an OutPutstream.
  43227. </summary>
  43228. <param name="stream">the stream you wish to write to</param>
  43229. <param name="leaveOpen">leave stream open or not</param>
  43230. </member>
  43231. <member name="P:NPOI.SS.UserModel.IWorkbook.NumberOfNames">
  43232. <summary>
  43233. the total number of defined names in this workbook
  43234. </summary>
  43235. </member>
  43236. <member name="M:NPOI.SS.UserModel.IWorkbook.GetName(System.String)">
  43237. <summary>
  43238. the defined name with the specified name.
  43239. </summary>
  43240. <param name="name">the name of the defined name</param>
  43241. <returns>the defined name with the specified name. null if not found</returns>
  43242. </member>
  43243. <member name="M:NPOI.SS.UserModel.IWorkbook.GetNames(System.String)">
  43244. <summary>
  43245. Returns all defined names with the given name.
  43246. </summary>
  43247. <param name="name">the name of the defined name</param>
  43248. <returns>a list of the defined names with the specified name. An empty list is returned if none is found.</returns>
  43249. </member>
  43250. <member name="M:NPOI.SS.UserModel.IWorkbook.GetAllNames">
  43251. <summary>
  43252. Returns all defined names.
  43253. </summary>
  43254. <returns>a list of the defined names. An empty list is returned if none is found.</returns>
  43255. </member>
  43256. <member name="M:NPOI.SS.UserModel.IWorkbook.GetNameAt(System.Int32)">
  43257. <summary>
  43258. the defined name at the specified index
  43259. </summary>
  43260. <param name="nameIndex">position of the named range (0-based)</param>
  43261. <returns></returns>
  43262. </member>
  43263. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateName">
  43264. <summary>
  43265. Creates a new (unInitialised) defined name in this workbook
  43266. </summary>
  43267. <returns>new defined name object</returns>
  43268. </member>
  43269. <member name="M:NPOI.SS.UserModel.IWorkbook.GetNameIndex(System.String)">
  43270. <summary>
  43271. Gets the defined name index by name
  43272. </summary>
  43273. <param name="name">the name of the defined name</param>
  43274. <returns>zero based index of the defined name.</returns>
  43275. </member>
  43276. <member name="M:NPOI.SS.UserModel.IWorkbook.RemoveName(System.Int32)">
  43277. <summary>
  43278. Remove the defined name at the specified index
  43279. </summary>
  43280. <param name="index">named range index (0 based)</param>
  43281. </member>
  43282. <member name="M:NPOI.SS.UserModel.IWorkbook.RemoveName(System.String)">
  43283. <summary>
  43284. Remove a defined name by name
  43285. </summary>
  43286. <param name="name">the name of the defined name</param>
  43287. </member>
  43288. <member name="M:NPOI.SS.UserModel.IWorkbook.RemoveName(NPOI.SS.UserModel.IName)">
  43289. <summary>
  43290. Remove a defined name
  43291. </summary>
  43292. <param name="name">the name of the defined name</param>
  43293. </member>
  43294. <member name="M:NPOI.SS.UserModel.IWorkbook.LinkExternalWorkbook(System.String,NPOI.SS.UserModel.IWorkbook)">
  43295. <summary>
  43296. Adds the linking required to allow formulas referencing the specified
  43297. external workbook to be added to this one. In order for formulas
  43298. such as "[MyOtherWorkbook]Sheet3!$A$5" to be added to the file,
  43299. some linking information must first be recorded. Once a given external
  43300. workbook has been linked, then formulas using it can added. Each workbook
  43301. needs linking only once. <br/>
  43302. This linking only applies for writing formulas.
  43303. To link things for evaluation, see {@link FormulaEvaluator#setupReferencedWorkbooks(java.util.Map)}
  43304. </summary>
  43305. <param name="name">The name the workbook will be referenced as in formulas</param>
  43306. <param name="workbook">The open workbook to fetch the link required information from</param>
  43307. <returns></returns>
  43308. </member>
  43309. <member name="M:NPOI.SS.UserModel.IWorkbook.SetPrintArea(System.Int32,System.String)">
  43310. <summary>
  43311. Sets the printarea for the sheet provided
  43312. </summary>
  43313. <param name="sheetIndex">Zero-based sheet index</param>
  43314. <param name="reference">Valid name Reference for the Print Area</param>
  43315. </member>
  43316. <member name="M:NPOI.SS.UserModel.IWorkbook.SetPrintArea(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  43317. <summary>
  43318. Sets the printarea for the sheet provided
  43319. </summary>
  43320. <param name="sheetIndex">Zero-based sheet index (0 = First Sheet)</param>
  43321. <param name="startColumn">Column to begin printarea</param>
  43322. <param name="endColumn">Column to end the printarea</param>
  43323. <param name="startRow">Row to begin the printarea</param>
  43324. <param name="endRow">Row to end the printarea</param>
  43325. </member>
  43326. <member name="M:NPOI.SS.UserModel.IWorkbook.GetPrintArea(System.Int32)">
  43327. <summary>
  43328. Retrieves the reference for the printarea of the specified sheet,
  43329. the sheet name is Appended to the reference even if it was not specified.
  43330. </summary>
  43331. <param name="sheetIndex">Zero-based sheet index</param>
  43332. <returns>Null if no print area has been defined</returns>
  43333. </member>
  43334. <member name="M:NPOI.SS.UserModel.IWorkbook.RemovePrintArea(System.Int32)">
  43335. <summary>
  43336. Delete the printarea for the sheet specified
  43337. </summary>
  43338. <param name="sheetIndex">Zero-based sheet index (0 = First Sheet)</param>
  43339. </member>
  43340. <member name="P:NPOI.SS.UserModel.IWorkbook.MissingCellPolicy">
  43341. <summary>
  43342. Retrieves the current policy on what to do when getting missing or blank cells from a row.
  43343. </summary>
  43344. </member>
  43345. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateDataFormat">
  43346. <summary>
  43347. Returns the instance of DataFormat for this workbook.
  43348. </summary>
  43349. <returns>the DataFormat object</returns>
  43350. </member>
  43351. <member name="M:NPOI.SS.UserModel.IWorkbook.AddPicture(System.Byte[],NPOI.SS.UserModel.PictureType)">
  43352. <summary>
  43353. Adds a picture to the workbook.
  43354. </summary>
  43355. <param name="pictureData">The bytes of the picture</param>
  43356. <param name="format">The format of the picture.</param>
  43357. <returns>the index to this picture (1 based).</returns>
  43358. </member>
  43359. <member name="M:NPOI.SS.UserModel.IWorkbook.GetAllPictures">
  43360. <summary>
  43361. Gets all pictures from the Workbook.
  43362. </summary>
  43363. <returns>the list of pictures (a list of link PictureData objects.)</returns>
  43364. </member>
  43365. <member name="M:NPOI.SS.UserModel.IWorkbook.GetCreationHelper">
  43366. <summary>
  43367. Return an object that handles instantiating concrete classes of
  43368. the various instances one needs for HSSF and XSSF.
  43369. </summary>
  43370. <returns></returns>
  43371. </member>
  43372. <member name="P:NPOI.SS.UserModel.IWorkbook.IsHidden">
  43373. <summary>
  43374. if this workbook is not visible in the GUI
  43375. </summary>
  43376. </member>
  43377. <member name="M:NPOI.SS.UserModel.IWorkbook.IsSheetHidden(System.Int32)">
  43378. <summary>
  43379. Check whether a sheet is hidden.
  43380. </summary>
  43381. <param name="sheetIx">number of sheet</param>
  43382. <returns>true if sheet is hidden</returns>
  43383. </member>
  43384. <member name="M:NPOI.SS.UserModel.IWorkbook.IsSheetVeryHidden(System.Int32)">
  43385. Check whether a sheet is very hidden.
  43386. <p>
  43387. This is different from the normal hidden status
  43388. ({@link #isSheetHidden(int)})
  43389. </p>
  43390. @param sheetIx sheet index to check
  43391. @return <code>true</code> if sheet is very hidden
  43392. </member>
  43393. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSheetHidden(System.Int32,NPOI.SS.UserModel.SheetState)">
  43394. Hide or unhide a sheet
  43395. @param sheetIx the sheet index (0-based)
  43396. @param hidden True to mark the sheet as hidden, false otherwise
  43397. </member>
  43398. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSheetHidden(System.Int32,System.Int32)">
  43399. Hide or unhide a sheet.
  43400. <pre>
  43401. 0 = not hidden
  43402. 1 = hidden
  43403. 2 = very hidden.
  43404. </pre>
  43405. @param sheetIx The sheet number
  43406. @param hidden 0 for not hidden, 1 for hidden, 2 for very hidden
  43407. </member>
  43408. <member name="M:NPOI.SS.UserModel.IWorkbook.AddToolPack(NPOI.SS.Formula.UDF.UDFFinder)">
  43409. <summary>
  43410. Register a new toolpack in this workbook.
  43411. </summary>
  43412. <param name="toopack">the toolpack to register</param>
  43413. </member>
  43414. <member name="M:NPOI.SS.UserModel.IWorkbook.IsDate1904">
  43415. <summary>
  43416. Gets a bool value that indicates whether the date systems used in the workbook starts in 1904.
  43417. The default value is false, meaning that the workbook uses the 1900 date system,
  43418. where 1/1/1900 is the first day in the system.
  43419. </summary>
  43420. <returns>True if the date systems used in the workbook starts in 1904</returns>
  43421. </member>
  43422. <member name="P:NPOI.SS.UserModel.IWorkbook.SpreadsheetVersion">
  43423. <summary>
  43424. Returns the spreadsheet version (EXCLE97) of this workbook
  43425. </summary>
  43426. </member>
  43427. <member name="F:NPOI.SS.Util.AreaReference.SHEET_NAME_DELIMITER">
  43428. The Char (!) that Separates sheet names from cell references
  43429. </member>
  43430. <member name="F:NPOI.SS.Util.AreaReference.CELL_DELIMITER">
  43431. The Char (:) that Separates the two cell references in a multi-cell area reference
  43432. </member>
  43433. <member name="F:NPOI.SS.Util.AreaReference.SPECIAL_NAME_DELIMITER">
  43434. The Char (') used to quote sheet names when they contain special Chars
  43435. </member>
  43436. <member name="M:NPOI.SS.Util.AreaReference.#ctor(System.String,NPOI.SS.SpreadsheetVersion)">
  43437. Create an area ref from a string representation. Sheet names containing special Chars should be
  43438. delimited and escaped as per normal syntax rules for formulas.<br/>
  43439. The area reference must be contiguous (i.e. represent a single rectangle, not a Union of rectangles)
  43440. </member>
  43441. <member name="M:NPOI.SS.Util.AreaReference.#ctor(NPOI.SS.Util.CellReference,NPOI.SS.Util.CellReference)">
  43442. Creates an area ref from a pair of Cell References.
  43443. </member>
  43444. <member name="M:NPOI.SS.Util.AreaReference.IsContiguous(System.String)">
  43445. is the reference for a contiguous (i.e.
  43446. Unbroken) area, or is it made up of
  43447. several different parts?
  43448. (If it Is, you will need to call
  43449. ....
  43450. </member>
  43451. <member name="M:NPOI.SS.Util.AreaReference.IsWholeColumnReference(NPOI.SS.SpreadsheetVersion,NPOI.SS.Util.CellReference,NPOI.SS.Util.CellReference)">
  43452. is the reference for a whole-column reference,
  43453. such as C:C or D:G ?
  43454. </member>
  43455. <member name="M:NPOI.SS.Util.AreaReference.GenerateContiguous(System.String)">
  43456. Takes a non-contiguous area reference, and
  43457. returns an array of contiguous area references.
  43458. </member>
  43459. <member name="P:NPOI.SS.Util.AreaReference.IsSingleCell">
  43460. @return <c>false</c> if this area reference involves more than one cell
  43461. </member>
  43462. <member name="P:NPOI.SS.Util.AreaReference.FirstCell">
  43463. @return the first cell reference which defines this area. Usually this cell is in the upper
  43464. left corner of the area (but this is not a requirement).
  43465. </member>
  43466. <member name="P:NPOI.SS.Util.AreaReference.LastCell">
  43467. Note - if this area reference refers to a single cell, the return value of this method will
  43468. be identical to that of <c>GetFirstCell()</c>
  43469. @return the second cell reference which defines this area. For multi-cell areas, this is
  43470. cell diagonally opposite the 'first cell'. Usually this cell is in the lower right corner
  43471. of the area (but this is not a requirement).
  43472. </member>
  43473. <member name="M:NPOI.SS.Util.AreaReference.GetAllReferencedCells">
  43474. Returns a reference to every cell covered by this area
  43475. </member>
  43476. <member name="M:NPOI.SS.Util.AreaReference.FormatAsString">
  43477. Example return values:
  43478. <table border="0" cellpAdding="1" cellspacing="0" summary="Example return values">
  43479. <tr><th align='left'>Result</th><th align='left'>Comment</th></tr>
  43480. <tr><td>A1:A1</td><td>Single cell area reference without sheet</td></tr>
  43481. <tr><td>A1:$C$1</td><td>Multi-cell area reference without sheet</td></tr>
  43482. <tr><td>Sheet1!A$1:B4</td><td>Standard sheet name</td></tr>
  43483. <tr><td>'O''Brien''s Sales'!B5:C6' </td><td>Sheet name with special Chars</td></tr>
  43484. </table>
  43485. @return the text representation of this area reference as it would appear in a formula.
  43486. </member>
  43487. <member name="M:NPOI.SS.Util.AreaReference.SeparateAreaRefs(System.String)">
  43488. Separates Area refs in two parts and returns them as Separate elements in a String array,
  43489. each qualified with the sheet name (if present)
  43490. @return array with one or two elements. never <c>null</c>
  43491. </member>
  43492. <member name="T:NPOI.SS.Util.CellAddress">
  43493. <p>This class is a Container for POI usermodel row=0 column=0 cell references.
  43494. It is barely a Container for these two coordinates. The implementation
  43495. of the Comparable interface sorts by "natural" order top left to bottom right.</p>
  43496. <p>Use <tt>CellAddress</tt> when you want to refer to the location of a cell in a sheet
  43497. when the concept of relative/absolute does not apply (such as the anchor location
  43498. of a cell comment). Use {@link CellReference} when the concept of
  43499. relative/absolute does apply (such as a cell reference in a formula).
  43500. <tt>CellAddress</tt>es do not have a concept of "sheet", while <tt>CellReference</tt>s do.</p>
  43501. </member>
  43502. <member name="F:NPOI.SS.Util.CellAddress.A1">
  43503. A constant for references to the first cell in a sheet.
  43504. </member>
  43505. <member name="M:NPOI.SS.Util.CellAddress.#ctor(System.Int32,System.Int32)">
  43506. Create a new CellAddress object.
  43507. @param row Row index (first row is 0)
  43508. @param column Column index (first column is 0)
  43509. </member>
  43510. <member name="M:NPOI.SS.Util.CellAddress.#ctor(System.String)">
  43511. Create a new CellAddress object.
  43512. @param Address a cell Address in A1 format. Address may not contain sheet name or dollar signs.
  43513. (that is, Address is not a cell reference. Use {@link #CellAddress(CellReference)} instead if
  43514. starting with a cell reference.)
  43515. </member>
  43516. <member name="M:NPOI.SS.Util.CellAddress.#ctor(NPOI.SS.Util.CellReference)">
  43517. Create a new CellAddress object.
  43518. @param reference a reference to a cell
  43519. </member>
  43520. <member name="M:NPOI.SS.Util.CellAddress.#ctor(NPOI.SS.UserModel.ICell)">
  43521. Create a new CellAddress object.
  43522. @param cell the Cell to Get the location of
  43523. </member>
  43524. <member name="P:NPOI.SS.Util.CellAddress.Row">
  43525. Get the cell Address row
  43526. @return row
  43527. </member>
  43528. <member name="P:NPOI.SS.Util.CellAddress.Column">
  43529. Get the cell Address column
  43530. @return column
  43531. </member>
  43532. <member name="M:NPOI.SS.Util.CellAddress.CompareTo(NPOI.SS.Util.CellAddress)">
  43533. Compare this CellAddress using the "natural" row-major, column-minor ordering.
  43534. That is, top-left to bottom-right ordering.
  43535. @param other
  43536. @return <ul>
  43537. <li>-1 if this CellAddress is before (above/left) of other</li>
  43538. <li>0 if Addresses are the same</li>
  43539. <li>1 if this CellAddress is After (below/right) of other</li>
  43540. </ul>
  43541. </member>
  43542. <member name="M:NPOI.SS.Util.CellAddress.FormatAsString">
  43543. Same as {@link #ToString()}
  43544. @return A1-style cell Address string representation
  43545. </member>
  43546. <member name="M:NPOI.SS.Util.CellRangeAddress.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
  43547. Creates new cell range. Indexes are zero-based.
  43548. @param firstRow Index of first row
  43549. @param lastRow Index of last row (inclusive), must be equal to or larger than {@code firstRow}
  43550. @param firstCol Index of first column
  43551. @param lastCol Index of last column (inclusive), must be equal to or larger than {@code firstCol}
  43552. </member>
  43553. <member name="M:NPOI.SS.Util.CellRangeAddress.FormatAsString(System.String,System.Boolean)">
  43554. @return the text format of this range using specified sheet name.
  43555. </member>
  43556. <member name="M:NPOI.SS.Util.CellRangeAddress.ValueOf(System.String)">
  43557. <summary>
  43558. Creates a CellRangeAddress from a cell range reference string.
  43559. </summary>
  43560. <param name="reference">
  43561. usually a standard area ref (e.g. "B1:D8"). May be a single
  43562. cell ref (e.g. "B5") in which case the result is a 1 x 1 cell
  43563. range. May also be a whole row range (e.g. "3:5"), or a whole
  43564. column range (e.g. "C:F")
  43565. </param>
  43566. <returns>a CellRangeAddress object</returns>
  43567. </member>
  43568. <member name="T:NPOI.SS.Util.CellRangeAddressBase">
  43569. See OOO documentation: excelfileformat.pdf sec 2.5.14 - 'Cell Range Address'<p/>
  43570. Common subclass of 8-bit and 16-bit versions
  43571. @author Josh Micich
  43572. </member>
  43573. <member name="M:NPOI.SS.Util.CellRangeAddressBase.Validate(NPOI.SS.SpreadsheetVersion)">
  43574. Validate the range limits against the supplied version of Excel
  43575. @param ssVersion the version of Excel to validate against
  43576. @throws IllegalArgumentException if the range limits are outside of the allowed range
  43577. </member>
  43578. <member name="M:NPOI.SS.Util.CellRangeAddressBase.ValidateRow(System.Int32,NPOI.SS.SpreadsheetVersion)">
  43579. Runs a bounds check for row numbers
  43580. @param row
  43581. </member>
  43582. <member name="M:NPOI.SS.Util.CellRangeAddressBase.ValidateColumn(System.Int32,NPOI.SS.SpreadsheetVersion)">
  43583. Runs a bounds check for column numbers
  43584. @param column
  43585. </member>
  43586. <member name="M:NPOI.SS.Util.CellRangeAddressBase.ContainsRow(System.Int32)">
  43587. Check if the row is in the specified cell range
  43588. @param rowInd the row to check
  43589. @return true if the range contains the row [rowInd]
  43590. </member>
  43591. <member name="M:NPOI.SS.Util.CellRangeAddressBase.ContainsColumn(System.Int32)">
  43592. Check if the column is in the specified cell range
  43593. @param colInd the column to check
  43594. @return true if the range contains the column [colInd]
  43595. </member>
  43596. <member name="M:NPOI.SS.Util.CellRangeAddressBase.Intersects(NPOI.SS.Util.CellRangeAddressBase)">
  43597. <summary>
  43598. Determines whether or not this CellRangeAddress and the specified CellRangeAddress intersect.
  43599. </summary>
  43600. <param name="other">a candidate cell range address to check for intersection with this range</param>
  43601. <returns>returns true if this range and other range have at least 1 cell in common</returns>
  43602. </member>
  43603. <member name="P:NPOI.SS.Util.CellRangeAddressBase.FirstColumn">
  43604. @return column number for the upper left hand corner
  43605. </member>
  43606. <member name="P:NPOI.SS.Util.CellRangeAddressBase.FirstRow">
  43607. @return row number for the upper left hand corner
  43608. </member>
  43609. <member name="P:NPOI.SS.Util.CellRangeAddressBase.LastColumn">
  43610. @return column number for the lower right hand corner
  43611. </member>
  43612. <member name="P:NPOI.SS.Util.CellRangeAddressBase.LastRow">
  43613. @return row number for the lower right hand corner
  43614. </member>
  43615. <member name="P:NPOI.SS.Util.CellRangeAddressBase.NumberOfCells">
  43616. @return the size of the range (number of cells in the area).
  43617. </member>
  43618. <member name="F:NPOI.SS.Util.CellRangeAddressList._list">
  43619. List of <c>CellRangeAddress</c>es. Each structure represents a cell range
  43620. </member>
  43621. <member name="M:NPOI.SS.Util.CellRangeAddressList.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
  43622. Convenience constructor for creating a <c>CellRangeAddressList</c> with a single
  43623. <c>CellRangeAddress</c>. Other <c>CellRangeAddress</c>es may be Added later.
  43624. </member>
  43625. <member name="M:NPOI.SS.Util.CellRangeAddressList.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  43626. @param in the RecordInputstream to read the record from
  43627. </member>
  43628. <member name="M:NPOI.SS.Util.CellRangeAddressList.CountRanges">
  43629. Get the number of following ADDR structures. The number of this
  43630. structures is automatically set when reading an Excel file and/or
  43631. increased when you manually Add a new ADDR structure . This is the reason
  43632. there isn't a set method for this field .
  43633. @return number of ADDR structures
  43634. </member>
  43635. <member name="M:NPOI.SS.Util.CellRangeAddressList.AddCellRangeAddress(System.Int32,System.Int32,System.Int32,System.Int32)">
  43636. Add a cell range structure.
  43637. @param firstRow - the upper left hand corner's row
  43638. @param firstCol - the upper left hand corner's col
  43639. @param lastRow - the lower right hand corner's row
  43640. @param lastCol - the lower right hand corner's col
  43641. @return the index of this ADDR structure
  43642. </member>
  43643. <member name="M:NPOI.SS.Util.CellRangeAddressList.GetCellRangeAddress(System.Int32)">
  43644. @return <c>CellRangeAddress</c> at the given index
  43645. </member>
  43646. <member name="M:NPOI.SS.Util.CellRangeAddressList.GetEncodedSize(System.Int32)">
  43647. @return the total size of for the specified number of ranges,
  43648. including the initial 2 byte range count
  43649. </member>
  43650. <member name="T:NPOI.SS.Util.CellRangeUtil">
  43651. Utility class that builds on {@link CellRangeAddress}
  43652. Portions of this class may be moved to {@link CellRangeAddressBase}
  43653. </member>
  43654. <member name="F:NPOI.SS.Util.CellRangeUtil.INSIDE">
  43655. first range is within the second range
  43656. </member>
  43657. <member name="F:NPOI.SS.Util.CellRangeUtil.ENCLOSES">
  43658. first range encloses or is equal to the second
  43659. </member>
  43660. <member name="M:NPOI.SS.Util.CellRangeUtil.Intersect(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  43661. Get the type of intersection between two cell ranges
  43662. @param crB - the specified range
  43663. @return code which reflects how the specified range is related to this range.<br/>
  43664. Possible return codes are:
  43665. NO_INTERSECTION - the specified range is outside of this range;<br/>
  43666. OVERLAP - both ranges partially overlap;<br/>
  43667. INSIDE - the specified range is inside of this one<br/>
  43668. ENCLOSES - the specified range encloses (possibly exactly the same as) this range<br/>
  43669. </member>
  43670. <member name="M:NPOI.SS.Util.CellRangeUtil.MergeCellRanges(NPOI.SS.Util.CellRangeAddress[])">
  43671. Do all possible cell merges between cells of the list so that:
  43672. if a cell range is completely inside of another cell range, it s removed from the list
  43673. if two cells have a shared border, merge them into one bigger cell range
  43674. @param cellRangeList
  43675. @return updated List of cell ranges
  43676. </member>
  43677. <member name="M:NPOI.SS.Util.CellRangeUtil.MergeRanges(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  43678. @return the new range(s) to replace the supplied ones. <c>null</c> if no merge is possible
  43679. </member>
  43680. <member name="M:NPOI.SS.Util.CellRangeUtil.ToArray(System.Collections.ArrayList)">
  43681. **
  43682. </member>
  43683. <member name="M:NPOI.SS.Util.CellRangeUtil.Contains(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  43684. Check if the specified range is located inside of this cell range.
  43685. @param crB
  43686. @return true if this cell range Contains the argument range inside if it's area
  43687. </member>
  43688. <member name="M:NPOI.SS.Util.CellRangeUtil.HasExactSharedBorder(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  43689. Check if the specified cell range has a shared border with the current range.
  43690. @return <c>true</c> if the ranges have a complete shared border (i.e.
  43691. the two ranges toher make a simple rectangular region.
  43692. </member>
  43693. <member name="M:NPOI.SS.Util.CellRangeUtil.CreateEnclosingCellRange(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  43694. Create an enclosing CellRange for the two cell ranges.
  43695. @return enclosing CellRange
  43696. </member>
  43697. <member name="M:NPOI.SS.Util.CellRangeUtil.lt(System.Int32,System.Int32)">
  43698. @return true if a &lt; b
  43699. </member>
  43700. <member name="M:NPOI.SS.Util.CellRangeUtil.le(System.Int32,System.Int32)">
  43701. @return true if a &lt;= b
  43702. </member>
  43703. <member name="M:NPOI.SS.Util.CellRangeUtil.gt(System.Int32,System.Int32)">
  43704. @return true if a > b
  43705. </member>
  43706. <member name="M:NPOI.SS.Util.CellRangeUtil.ge(System.Int32,System.Int32)">
  43707. @return true if a >= b
  43708. </member>
  43709. <member name="F:NPOI.SS.Util.NameType.None">
  43710. <summary>
  43711. Allow accessing the Initial value.
  43712. </summary>
  43713. </member>
  43714. <member name="T:NPOI.SS.Util.CellReference">
  43715. <p>Common conversion functions between Excel style A1, C27 style
  43716. cell references, and POI usermodel style row=0, column=0
  43717. style references. Handles sheet-based and sheet-free references
  43718. as well, eg "Sheet1!A1" and "$B$72"</p>
  43719. <p>Use <tt>CellReference</tt> when the concept of
  43720. relative/absolute does apply (such as a cell reference in a formula).
  43721. Use {@link CellAddress} when you want to refer to the location of a cell in a sheet
  43722. when the concept of relative/absolute does not apply (such as the anchor location
  43723. of a cell comment).
  43724. <tt>CellReference</tt>s have a concept of "sheet", while <tt>CellAddress</tt>es do not.</p>
  43725. </member>
  43726. <member name="F:NPOI.SS.Util.CellReference.ABSOLUTE_REFERENCE_MARKER">
  43727. The character ($) that signifies a row or column value is absolute instead of relative
  43728. </member>
  43729. <member name="F:NPOI.SS.Util.CellReference.SHEET_NAME_DELIMITER">
  43730. The character (!) that Separates sheet names from cell references
  43731. </member>
  43732. <member name="F:NPOI.SS.Util.CellReference.SPECIAL_NAME_DELIMITER">
  43733. The character (') used to quote sheet names when they contain special characters
  43734. </member>
  43735. <member name="F:NPOI.SS.Util.CellReference.CELL_REF_PATTERN">
  43736. Matches a run of one or more letters followed by a run of one or more digits.
  43737. Both the letter and number groups are optional.
  43738. The run of letters is group 1 and the run of digits is group 2.
  43739. Each group may optionally be prefixed with a single '$'.
  43740. </member>
  43741. <member name="F:NPOI.SS.Util.CellReference.STRICTLY_CELL_REF_PATTERN">
  43742. Matches references only where row and column are included.
  43743. Matches a run of one or more letters followed by a run of one or more digits.
  43744. If a reference does not match this pattern, it might match COLUMN_REF_PATTERN or ROW_REF_PATTERN
  43745. References may optionally include a single '$' before each group, but these are excluded from the Matcher.group(int).
  43746. </member>
  43747. <member name="F:NPOI.SS.Util.CellReference.COLUMN_REF_PATTERN">
  43748. Matches a run of one or more letters. The run of letters is group 1.
  43749. References may optionally include a single '$' before the group, but these are excluded from the Matcher.group(int).
  43750. </member>
  43751. <member name="F:NPOI.SS.Util.CellReference.ROW_REF_PATTERN">
  43752. Matches a run of one or more letters. The run of numbers is group 1.
  43753. References may optionally include a single '$' before the group, but these are excluded from the Matcher.group(int).
  43754. </member>
  43755. <member name="F:NPOI.SS.Util.CellReference.NAMED_RANGE_NAME_PATTERN">
  43756. Named range names must start with a letter or underscore. Subsequent characters may include
  43757. digits or dot. (They can even end in dot).
  43758. </member>
  43759. <member name="M:NPOI.SS.Util.CellReference.#ctor(System.String)">
  43760. Create an cell ref from a string representation. Sheet names containing special characters should be
  43761. delimited and escaped as per normal syntax rules for formulas.
  43762. </member>
  43763. <member name="P:NPOI.SS.Util.CellReference.SheetName">
  43764. @return possibly <c>null</c> if this is a 2D reference. Special characters are not
  43765. escaped or delimited
  43766. </member>
  43767. <member name="M:NPOI.SS.Util.CellReference.ConvertColStringToIndex(System.String)">
  43768. takes in a column reference portion of a CellRef and converts it from
  43769. ALPHA-26 number format to 0-based base 10.
  43770. 'A' -> 0
  43771. 'Z' -> 25
  43772. 'AA' -> 26
  43773. 'IV' -> 255
  43774. @return zero based column index
  43775. </member>
  43776. <member name="M:NPOI.SS.Util.CellReference.ConvertNumToColString(System.Int32)">
  43777. Takes in a 0-based base-10 column and returns a ALPHA-26
  43778. representation.
  43779. eg column #3 -> D
  43780. </member>
  43781. <member name="M:NPOI.SS.Util.CellReference.SeparateRefParts(System.String)">
  43782. Separates the row from the columns and returns an array of three Strings. The first element
  43783. is the sheet name. Only the first element may be null. The second element in is the column
  43784. name still in ALPHA-26 number format. The third element is the row.
  43785. </member>
  43786. <member name="M:NPOI.SS.Util.CellReference.FormatAsString">
  43787. Example return values:
  43788. <table border="0" cellpAdding="1" cellspacing="0" summary="Example return values">
  43789. <tr><th align='left'>Result</th><th align='left'>Comment</th></tr>
  43790. <tr><td>A1</td><td>Cell reference without sheet</td></tr>
  43791. <tr><td>Sheet1!A1</td><td>Standard sheet name</td></tr>
  43792. <tr><td>'O''Brien''s Sales'!A1'</td><td>Sheet name with special characters</td></tr>
  43793. </table>
  43794. @return the text representation of this cell reference as it would appear in a formula.
  43795. </member>
  43796. <member name="P:NPOI.SS.Util.CellReference.CellRefParts">
  43797. Returns the three parts of the cell reference, the
  43798. Sheet name (or null if none supplied), the 1 based
  43799. row number, and the A based column letter.
  43800. This will not include any markers for absolute
  43801. references, so use {@link #formatAsString()}
  43802. to properly turn references into strings.
  43803. </member>
  43804. <member name="M:NPOI.SS.Util.CellReference.AppendCellReference(System.Text.StringBuilder)">
  43805. Appends cell reference with '$' markers for absolute values as required.
  43806. Sheet name is not included.
  43807. </member>
  43808. <member name="M:NPOI.SS.Util.CellReference.CellReferenceIsWithinRange(System.String,System.String,NPOI.SS.SpreadsheetVersion)">
  43809. Used to decide whether a name of the form "[A-Z]*[0-9]*" that appears in a formula can be
  43810. interpreted as a cell reference. Names of that form can be also used for sheets and/or
  43811. named ranges, and in those circumstances, the question of whether the potential cell
  43812. reference is valid (in range) becomes important.
  43813. <p/>
  43814. Note - that the maximum sheet size varies across Excel versions:
  43815. <p/>
  43816. <blockquote><table border="0" cellpadding="1" cellspacing="0"
  43817. summary="Notable cases.">
  43818. <tr><th>Version </th><th>File Format </th>
  43819. <th>Last Column </th><th>Last Row</th></tr>
  43820. <tr><td>97-2003</td><td>BIFF8</td><td>"IV" (2^8)</td><td>65536 (2^14)</td></tr>
  43821. <tr><td>2007</td><td>BIFF12</td><td>"XFD" (2^14)</td><td>1048576 (2^20)</td></tr>
  43822. </table></blockquote>
  43823. POI currently targets BIFF8 (Excel 97-2003), so the following behaviour can be observed for
  43824. this method:
  43825. <blockquote><table border="0" cellpadding="1" cellspacing="0"
  43826. summary="Notable cases.">
  43827. <tr><th>Input </th>
  43828. <th>Result </th></tr>
  43829. <tr><td>"A", "1"</td><td>true</td></tr>
  43830. <tr><td>"a", "111"</td><td>true</td></tr>
  43831. <tr><td>"A", "65536"</td><td>true</td></tr>
  43832. <tr><td>"A", "65537"</td><td>false</td></tr>
  43833. <tr><td>"iv", "1"</td><td>true</td></tr>
  43834. <tr><td>"IW", "1"</td><td>false</td></tr>
  43835. <tr><td>"AAA", "1"</td><td>false</td></tr>
  43836. <tr><td>"a", "111"</td><td>true</td></tr>
  43837. <tr><td>"Sheet", "1"</td><td>false</td></tr>
  43838. </table></blockquote>
  43839. @param colStr a string of only letter characters
  43840. @param rowStr a string of only digit characters
  43841. @return <c>true</c> if the row and col parameters are within range of a BIFF8 spreadsheet.
  43842. </member>
  43843. <member name="M:NPOI.SS.Util.CellReference.IsColumnWithnRange(System.String,NPOI.SS.SpreadsheetVersion)">
  43844. @deprecated 3.15 beta 2. Use {@link #isColumnWithinRange}.
  43845. </member>
  43846. <member name="T:NPOI.SS.Util.CellUtil">
  43847. Various utility functions that make working with a cells and rows easier. The various methods
  43848. that deal with style's allow you to create your CellStyles as you need them. When you apply a
  43849. style change to a cell, the code will attempt to see if a style already exists that meets your
  43850. needs. If not, then it will create a new style. This is to prevent creating too many styles.
  43851. there is an upper limit in Excel on the number of styles that can be supported.
  43852. @author Eric Pugh epugh@upstate.com
  43853. @author (secondary) Avinash Kewalramani akewalramani@accelrys.com
  43854. </member>
  43855. <member name="M:NPOI.SS.Util.CellUtil.GetRow(System.Int32,NPOI.SS.UserModel.ISheet)">
  43856. Get a row from the spreadsheet, and create it if it doesn't exist.
  43857. @param rowIndex The 0 based row number
  43858. @param sheet The sheet that the row is part of.
  43859. @return The row indicated by the rowCounter
  43860. </member>
  43861. <member name="M:NPOI.SS.Util.CellUtil.GetCell(NPOI.SS.UserModel.IRow,System.Int32)">
  43862. Get a specific cell from a row. If the cell doesn't exist, then create it.
  43863. @param row The row that the cell is part of
  43864. @param columnIndex The column index that the cell is in.
  43865. @return The cell indicated by the column.
  43866. </member>
  43867. <member name="M:NPOI.SS.Util.CellUtil.CreateCell(NPOI.SS.UserModel.IRow,System.Int32,System.String,NPOI.SS.UserModel.ICellStyle)">
  43868. Creates a cell, gives it a value, and applies a style if provided
  43869. @param row the row to create the cell in
  43870. @param column the column index to create the cell in
  43871. @param value The value of the cell
  43872. @param style If the style is not null, then set
  43873. @return A new Cell
  43874. </member>
  43875. <member name="M:NPOI.SS.Util.CellUtil.CreateCell(NPOI.SS.UserModel.IRow,System.Int32,System.String)">
  43876. Create a cell, and give it a value.
  43877. @param row the row to create the cell in
  43878. @param column the column index to create the cell in
  43879. @param value The value of the cell
  43880. @return A new Cell.
  43881. </member>
  43882. <member name="M:NPOI.SS.Util.CellUtil.SetAlignment(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.IWorkbook,System.Int16)">
  43883. Take a cell, and align it.
  43884. @param cell the cell to set the alignment for
  43885. @param workbook The workbook that is being worked with.
  43886. @param align the column alignment to use.
  43887. @see CellStyle for alignment options
  43888. </member>
  43889. <member name="M:NPOI.SS.Util.CellUtil.SetAlignment(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.HorizontalAlignment)">
  43890. Take a cell, and align it.
  43891. This is superior to cell.getCellStyle().setAlignment(align) because
  43892. this method will not modify the CellStyle object that may be referenced
  43893. by multiple cells. Instead, this method will search for existing CellStyles
  43894. that match the desired CellStyle, creating a new CellStyle with the desired
  43895. style if no match exists.
  43896. @param cell the cell to set the alignment for
  43897. @param align the horizontal alignment to use.
  43898. @see HorizontalAlignment for alignment options
  43899. @since POI 3.15 beta 3
  43900. </member>
  43901. <member name="M:NPOI.SS.Util.CellUtil.SetVerticalAlignment(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.VerticalAlignment)">
  43902. Take a cell, and vertically align it.
  43903. This is superior to cell.getCellStyle().setVerticalAlignment(align) because
  43904. this method will not modify the CellStyle object that may be referenced
  43905. by multiple cells. Instead, this method will search for existing CellStyles
  43906. that match the desired CellStyle, creating a new CellStyle with the desired
  43907. style if no match exists.
  43908. @param cell the cell to set the alignment for
  43909. @param align the vertical alignment to use.
  43910. @see VerticalAlignment for alignment options
  43911. @since POI 3.15 beta 3
  43912. </member>
  43913. <member name="M:NPOI.SS.Util.CellUtil.SetFont(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.IWorkbook,NPOI.SS.UserModel.IFont)">
  43914. Take a cell, and apply a font to it
  43915. @param cell the cell to set the alignment for
  43916. @param workbook The workbook that is being worked with.
  43917. @param font The Font that you want to set...
  43918. </member>
  43919. <member name="M:NPOI.SS.Util.CellUtil.SetFont(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.IFont)">
  43920. Take a cell, and apply a font to it
  43921. @param cell the cell to set the alignment for
  43922. @param font The Font that you want to set.
  43923. @throws IllegalArgumentException if <tt>font</tt> and <tt>cell</tt> do not belong to the same workbook
  43924. </member>
  43925. <member name="M:NPOI.SS.Util.CellUtil.SetCellStyleProperties(NPOI.SS.UserModel.ICell,System.Collections.Generic.Dictionary{System.String,System.Object},System.Boolean)">
  43926. <p>This method attempts to find an existing CellStyle that matches the <code>cell</code>'s
  43927. current style plus styles properties in <code>properties</code>. A new style is created if the
  43928. workbook does not contain a matching style.</p>
  43929. <p>Modifies the cell style of <code>cell</code> without affecting other cells that use the
  43930. same style.</p>
  43931. <p>This is necessary because Excel has an upper limit on the number of styles that it supports.</p>
  43932. <p>This function is more efficient than multiple calls to
  43933. {@link #setCellStyleProperty(org.apache.poi.ss.usermodel.Cell, org.apache.poi.ss.usermodel.Workbook, String, Object)}
  43934. if adding multiple cell styles.</p>
  43935. <p>For performance reasons, if this is the only cell in a workbook that uses a cell style,
  43936. this method does NOT remove the old style from the workbook.
  43937. <!-- NOT IMPLEMENTED: Unused styles should be
  43938. pruned from the workbook with [@link #removeUnusedCellStyles(Workbook)] or
  43939. [@link #removeStyleFromWorkbookIfUnused(CellStyle, Workbook)]. -->
  43940. </p>
  43941. @param cell The cell to change the style of
  43942. @param properties The properties to be added to a cell style, as {propertyName: propertyValue}.
  43943. @since POI 3.14 beta 2
  43944. </member>
  43945. <member name="M:NPOI.SS.Util.CellUtil.SetCellStyleProperty(NPOI.SS.UserModel.ICell,System.String,System.Object)">
  43946. <p>This method attempts to find an existing CellStyle that matches the <code>cell</code>'s
  43947. current style plus a single style property <code>propertyName</code> with value
  43948. <code>propertyValue</code>.
  43949. A new style is created if the workbook does not contain a matching style.</p>
  43950. <p>Modifies the cell style of <code>cell</code> without affecting other cells that use the
  43951. same style.</p>
  43952. <p>If setting more than one cell style property on a cell, use
  43953. {@link #setCellStyleProperties(org.apache.poi.ss.usermodel.Cell, Map)},
  43954. which is faster and does not add unnecessary intermediate CellStyles to the workbook.</p>
  43955. @param cell The cell that is to be changed.
  43956. @param propertyName The name of the property that is to be changed.
  43957. @param propertyValue The value of the property that is to be changed.
  43958. </member>
  43959. <member name="M:NPOI.SS.Util.CellUtil.SetCellStyleProperty(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.IWorkbook,System.String,System.Object)">
  43960. <p>This method attempts to find an existing CellStyle that matches the <code>cell</code>'s
  43961. current style plus a single style property <code>propertyName</code> with value
  43962. <code>propertyValue</code>.
  43963. A new style is created if the workbook does not contain a matching style.</p>
  43964. <p>Modifies the cell style of <code>cell</code> without affecting other cells that use the
  43965. same style.</p>
  43966. <p>If setting more than one cell style property on a cell, use
  43967. {@link #setCellStyleProperties(Cell, Map)},
  43968. which is faster and does not add unnecessary intermediate CellStyles to the workbook.</p>
  43969. @param workbook The workbook that is being worked with.
  43970. @param propertyName The name of the property that is to be changed.
  43971. @param propertyValue The value of the property that is to be changed.
  43972. @param cell The cell that needs it's style changes
  43973. </member>
  43974. <member name="M:NPOI.SS.Util.CellUtil.PutAll(System.Collections.Generic.Dictionary{System.String,System.Object},System.Collections.Generic.Dictionary{System.String,System.Object})">
  43975. Copies the entries in src to dest, using the preferential data type
  43976. so that maps can be compared for equality
  43977. @param src the property map to copy from (read-only)
  43978. @param dest the property map to copy into
  43979. @since POI 3.15 beta 3
  43980. </member>
  43981. <member name="M:NPOI.SS.Util.CellUtil.GetFormatProperties(NPOI.SS.UserModel.ICellStyle)">
  43982. Returns a map containing the format properties of the given cell style.
  43983. The returned map is not tied to <code>style</code>, so subsequent changes
  43984. to <code>style</code> will not modify the map, and changes to the returned
  43985. map will not modify the cell style. The returned map is mutable.
  43986. @param style cell style
  43987. @return map of format properties (String -> Object)
  43988. @see #setFormatProperties(org.apache.poi.ss.usermodel.CellStyle, org.apache.poi.ss.usermodel.Workbook, java.util.Map)
  43989. </member>
  43990. <member name="M:NPOI.SS.Util.CellUtil.SetFormatProperties(NPOI.SS.UserModel.ICellStyle,NPOI.SS.UserModel.IWorkbook,System.Collections.Generic.Dictionary{System.String,System.Object})">
  43991. Sets the format properties of the given style based on the given map.
  43992. @param style cell style
  43993. @param workbook parent workbook
  43994. @param properties map of format properties (String -> Object)
  43995. @see #getFormatProperties(CellStyle)
  43996. </member>
  43997. <member name="M:NPOI.SS.Util.CellUtil.GetShort(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">
  43998. Utility method that returns the named short value form the given map.
  43999. @param properties map of named properties (String -> Object)
  44000. @param name property name
  44001. @return zero if the property does not exist, or is not a {@link Short}.
  44002. </member>
  44003. <member name="M:NPOI.SS.Util.CellUtil.GetInt(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">
  44004. Utility method that returns the named int value from the given map.
  44005. @param properties map of named properties (String -> Object)
  44006. @param name property name
  44007. @return zero if the property does not exist, or is not a {@link Integer}
  44008. otherwise the property value
  44009. </member>
  44010. <member name="M:NPOI.SS.Util.CellUtil.GetBorderStyle(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">
  44011. Utility method that returns the named BorderStyle value form the given map.
  44012. @param properties map of named properties (String -> Object)
  44013. @param name property name
  44014. @return Border style if set, otherwise {@link BorderStyle#NONE}
  44015. </member>
  44016. <member name="M:NPOI.SS.Util.CellUtil.GetFillPattern(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">
  44017. Utility method that returns the named FillPattern value from the given map.
  44018. @param properties map of named properties (String -> Object)
  44019. @param name property name
  44020. @return FillPattern style if set, otherwise {@link FillPattern#NO_FILL}
  44021. @since POI 3.15 beta 3
  44022. </member>
  44023. <member name="M:NPOI.SS.Util.CellUtil.GetHorizontalAlignment(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">
  44024. Utility method that returns the named HorizontalAlignment value from the given map.
  44025. @param properties map of named properties (String -> Object)
  44026. @param name property name
  44027. @return HorizontalAlignment style if set, otherwise {@link HorizontalAlignment#GENERAL}
  44028. @since POI 3.15 beta 3
  44029. </member>
  44030. <member name="M:NPOI.SS.Util.CellUtil.GetVerticalAlignment(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">
  44031. Utility method that returns the named VerticalAlignment value from the given map.
  44032. @param properties map of named properties (String -> Object)
  44033. @param name property name
  44034. @return VerticalAlignment style if set, otherwise {@link VerticalAlignment#BOTTOM}
  44035. @since POI 3.15 beta 3
  44036. </member>
  44037. <member name="M:NPOI.SS.Util.CellUtil.GetBoolean(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">
  44038. Utility method that returns the named boolean value form the given map.
  44039. @param properties map of properties (String -> Object)
  44040. @param name property name
  44041. @return false if the property does not exist, or is not a {@link Boolean}.
  44042. </member>
  44043. <member name="M:NPOI.SS.Util.CellUtil.Put(System.Collections.Generic.Dictionary{System.String,System.Object},System.String,System.Object)">
  44044. Utility method that puts the given value to the given map.
  44045. @param properties map of properties (String -> Object)
  44046. @param name property name
  44047. @param value property value
  44048. </member>
  44049. <member name="M:NPOI.SS.Util.CellUtil.PutShort(System.Collections.Generic.Dictionary{System.String,System.Object},System.String,System.Int16)">
  44050. Utility method that puts the named short value to the given map.
  44051. @param properties map of properties (String -> Object)
  44052. @param name property name
  44053. @param value property value
  44054. </member>
  44055. <member name="M:NPOI.SS.Util.CellUtil.PutEnum(System.Collections.Generic.Dictionary{System.String,System.Object},System.String,System.Enum)">
  44056. Utility method that puts the named short value to the given map.
  44057. @param properties map of properties (String -> Object)
  44058. @param name property name
  44059. @param value property value
  44060. </member>
  44061. <member name="M:NPOI.SS.Util.CellUtil.PutBoolean(System.Collections.Generic.Dictionary{System.String,System.Object},System.String,System.Boolean)">
  44062. Utility method that puts the named boolean value to the given map.
  44063. @param properties map of properties (String -> Object)
  44064. @param name property name
  44065. @param value property value
  44066. </member>
  44067. <member name="M:NPOI.SS.Util.CellUtil.TranslateUnicodeValues(NPOI.SS.UserModel.ICell)">
  44068. Looks for text in the cell that should be unicode, like an alpha and provides the
  44069. unicode version of it.
  44070. @param cell The cell to check for unicode values
  44071. @return translated to unicode
  44072. </member>
  44073. <member name="T:NPOI.SS.Util.CellWalk.ICellHandler">
  44074. Represents callback for CellWalk traverse method.
  44075. @author Roman Kashitsyn
  44076. </member>
  44077. <member name="M:NPOI.SS.Util.CellWalk.ICellHandler.OnCell(NPOI.SS.UserModel.ICell,NPOI.SS.Util.CellWalk.ICellWalkContext)">
  44078. @param cell current cell
  44079. @param ctx information about invokation context
  44080. </member>
  44081. <member name="T:NPOI.SS.Util.CellWalk.CellWalk">
  44082. Traverse cell range.
  44083. @author Roman Kashitsyn
  44084. </member>
  44085. <member name="M:NPOI.SS.Util.CellWalk.CellWalk.IsTraverseEmptyCells">
  44086. Should we call handler on empty (blank) cells. Default is
  44087. false.
  44088. @return true if handler should be called on empty (blank)
  44089. cells, false otherwise.
  44090. </member>
  44091. <member name="M:NPOI.SS.Util.CellWalk.CellWalk.SetTraverseEmptyCells(System.Boolean)">
  44092. Sets the traverseEmptyCells property.
  44093. @param traverseEmptyCells new property value
  44094. </member>
  44095. <member name="M:NPOI.SS.Util.CellWalk.CellWalk.Traverse(NPOI.SS.Util.CellWalk.ICellHandler)">
  44096. Traverse cell range from top left to bottom right cell.
  44097. @param handler handler to call on each appropriate cell
  44098. </member>
  44099. <member name="T:NPOI.SS.Util.CellWalk.CellWalk.SimpleCellWalkContext">
  44100. Inner class to hold walk context.
  44101. @author Roman Kashitsyn
  44102. </member>
  44103. <member name="T:NPOI.SS.Util.CellWalk.ICellWalkContext">
  44104. @author Roman Kashitsyn
  44105. </member>
  44106. <member name="P:NPOI.SS.Util.CellWalk.ICellWalkContext.OrdinalNumber">
  44107. Returns ordinal number of cell in range. Numeration starts
  44108. from top left cell and ends at bottom right cell. Here is a
  44109. brief example (number in cell is it's ordinal number):
  44110. <table border="1">
  44111. <tbody>
  44112. <tr><td>1</td><td>2</td></tr>
  44113. <tr><td>3</td><td>4</td></tr>
  44114. </tbody>
  44115. </table>
  44116. @return ordinal number of current cell
  44117. </member>
  44118. <member name="P:NPOI.SS.Util.CellWalk.ICellWalkContext.RowNumber">
  44119. Returns number of current row.
  44120. @return number of current row
  44121. </member>
  44122. <member name="P:NPOI.SS.Util.CellWalk.ICellWalkContext.ColumnNumber">
  44123. Returns number of current column.
  44124. @return number of current column
  44125. </member>
  44126. <member name="T:NPOI.SS.Util.DataMarker">
  44127. <summary>
  44128. Represents data marker used in charts.
  44129. @author Roman Kashitsyn
  44130. </summary>
  44131. </member>
  44132. <member name="M:NPOI.SS.Util.DataMarker.#ctor(NPOI.SS.UserModel.ISheet,NPOI.SS.Util.CellRangeAddress)">
  44133. <summary>
  44134. constructor
  44135. </summary>
  44136. <param name="sheet">the sheet where data located.</param>
  44137. <param name="range">the range within that sheet.</param>
  44138. </member>
  44139. <member name="P:NPOI.SS.Util.DataMarker.Sheet">
  44140. <summary>
  44141. get or set the sheet marker points to.
  44142. </summary>
  44143. </member>
  44144. <member name="P:NPOI.SS.Util.DataMarker.Range">
  44145. <summary>
  44146. get or set range of the marker.
  44147. </summary>
  44148. </member>
  44149. <member name="M:NPOI.SS.Util.DataMarker.FormatAsString">
  44150. <summary>
  44151. Formats data marker using canonical format, for example
  44152. 'SheetName!$A$1:$A$5'.
  44153. </summary>
  44154. <returns>formatted data marker</returns>
  44155. </member>
  44156. <member name="T:NPOI.SS.Util.DateFormatConverter">
  44157. <summary>
  44158. Convert DateFormat patterns into Excel custom number formats.
  44159. For example, to format a date in excel using the "dd MMMM, yyyy" pattern and Japanese
  44160. locale, use the following code:
  44161. </summary>
  44162. <example>
  44163. returns "[$-0411]dd MMMM, yyyy;@" where the [$-0411] prefix tells Excel to use the Japanese locale
  44164. String excelFormatPattern = DateFormatConverter.convert(Locale.JAPANESE, "dd MMMM, yyyy");
  44165. CellStyle cellStyle = workbook.createCellStyle();
  44166. DataFormat poiFormat = workbook.createDataFormat();
  44167. cellStyle.setDataFormat(poiFormat.getFormat(excelFormatPattern));
  44168. cell.setCellValue(new Date());
  44169. cell.setCellStyle(cellStyle); // formats date as '2012\u5e743\u670817\u65e5'
  44170. </example>
  44171. </member>
  44172. <member name="F:NPOI.SS.Util.ExpandedDouble._significand">
  44173. Always 64 bits long (MSB, bit-63 is '1')
  44174. </member>
  44175. <member name="M:NPOI.SS.Util.ExpandedDouble.NormaliseBaseTen">
  44176. Convert to an equivalent {@link NormalisedDecimal} representation having 15 decimal digits of precision in the
  44177. non-fractional bits of the significand.
  44178. </member>
  44179. <member name="M:NPOI.SS.Util.ExpandedDouble.GetBinaryExponent">
  44180. @return the number of non-fractional bits after the MSB of the significand
  44181. </member>
  44182. <member name="T:NPOI.SS.Util.FormatBase">
  44183. <summary>
  44184. A substitute class for Format class in Java
  44185. </summary>
  44186. </member>
  44187. <member name="T:NPOI.SS.Util.SSNFormat">
  44188. Format class for Excel's SSN Format. This class mimics Excel's built-in
  44189. SSN Formatting.
  44190. @author James May
  44191. </member>
  44192. <member name="M:NPOI.SS.Util.SSNFormat.Format(System.Object,System.Globalization.CultureInfo)">
  44193. Format a number as an SSN
  44194. </member>
  44195. <member name="T:NPOI.SS.Util.ZipPlusFourFormat">
  44196. Format class for Excel Zip + 4 Format. This class mimics Excel's
  44197. built-in Formatting for Zip + 4.
  44198. @author James May
  44199. </member>
  44200. <member name="M:NPOI.SS.Util.ZipPlusFourFormat.Format(System.Object,System.Globalization.CultureInfo)">
  44201. Format a number as Zip + 4
  44202. </member>
  44203. <member name="T:NPOI.SS.Util.PhoneFormat">
  44204. Format class for Excel phone number Format. This class mimics Excel's
  44205. built-in phone number Formatting.
  44206. @author James May
  44207. </member>
  44208. <member name="M:NPOI.SS.Util.PhoneFormat.Format(System.Object,System.Globalization.CultureInfo)">
  44209. Format a number as a phone number
  44210. </member>
  44211. <member name="T:NPOI.SS.Util.ConstantStringFormat">
  44212. Format class that does nothing and always returns a constant string.
  44213. This format is used to simulate Excel's handling of a format string
  44214. of all # when the value is 0. Excel will output "", Java will output "0".
  44215. @see DataFormatter#createFormat(double, int, String)
  44216. </member>
  44217. <member name="F:NPOI.SS.Util.IEEEDouble.BIASED_EXPONENT_SPECIAL_VALUE">
  44218. The value the exponent field Gets for all <i>NaN</i> and <i>InfInity</i> values
  44219. </member>
  44220. <member name="M:NPOI.SS.Util.IEEEDouble.GetBiasedExponent(System.Int64)">
  44221. @param rawBits the 64 bit binary representation of the double value
  44222. @return the top 12 bits (sign and biased exponent value)
  44223. </member>
  44224. <member name="T:NPOI.SS.Util.ImageUtils">
  44225. @author Yegor Kozlov
  44226. </member>
  44227. <member name="M:NPOI.SS.Util.ImageUtils.GetImageDimension(System.IO.Stream,NPOI.SS.UserModel.PictureType)">
  44228. Return the dimension of this image
  44229. @param is the stream Containing the image data
  44230. @param type type of the picture: {@link NPOI.SS.UserModel.Workbook#PICTURE_TYPE_JPEG},
  44231. {@link NPOI.SS.UserModel.Workbook#PICTURE_TYPE_PNG} or {@link NPOI.SS.UserModel.Workbook#PICTURE_TYPE_DIB}
  44232. @return image dimension in pixels
  44233. </member>
  44234. <member name="M:NPOI.SS.Util.ImageUtils.GetResolution(SixLabors.ImageSharp.Image)">
  44235. The metadata of PNG and JPEG can contain the width of a pixel in millimeters.
  44236. Return the the "effective" dpi calculated as <code>25.4/HorizontalPixelSize</code>
  44237. and <code>25.4/VerticalPixelSize</code>. Where 25.4 is the number of mm in inch.
  44238. @return array of two elements: <code>{horisontalPdi, verticalDpi}</code>.
  44239. {96, 96} is the default.
  44240. </member>
  44241. <member name="M:NPOI.SS.Util.ImageUtils.SetPreferredSize(NPOI.SS.UserModel.IPicture,System.Double,System.Double)">
  44242. Calculate and Set the preferred size (anchor) for this picture.
  44243. @param scaleX the amount by which image width is multiplied relative to the original width.
  44244. @param scaleY the amount by which image height is multiplied relative to the original height.
  44245. @return the new Dimensions of the scaled picture in EMUs
  44246. </member>
  44247. <member name="M:NPOI.SS.Util.ImageUtils.GetDimensionFromAnchor(NPOI.SS.UserModel.IPicture)">
  44248. Calculates the dimensions in EMUs for the anchor of the given picture
  44249. @param picture the picture Containing the anchor
  44250. @return the dimensions in EMUs
  44251. </member>
  44252. <member name="F:NPOI.SS.Util.MutableFPNumber.BI_MIN_BASE">
  44253. The minimum value in 'Base-10 normalised form'.<br/>
  44254. When {@link #_binaryExponent} == 46 this is the the minimum {@link #_frac} value
  44255. (10<sup>14</sup>-0.05) * 2^17
  44256. <br/>
  44257. Values between (10<sup>14</sup>-0.05) and 10<sup>14</sup> will be represented as '1'
  44258. followed by 14 zeros.
  44259. Values less than (10<sup>14</sup>-0.05) will get Shifted by one more power of 10
  44260. This frac value rounds to '1' followed by fourteen zeros with an incremented decimal exponent
  44261. </member>
  44262. <member name="F:NPOI.SS.Util.MutableFPNumber.BI_MAX_BASE">
  44263. For 'Base-10 normalised form'<br/>
  44264. The maximum {@link #_frac} value when {@link #_binaryExponent} == 49
  44265. (10^15-0.5) * 2^14
  44266. </member>
  44267. <member name="F:NPOI.SS.Util.MutableFPNumber.C_64">
  44268. Width of a long
  44269. </member>
  44270. <member name="F:NPOI.SS.Util.MutableFPNumber.MIN_PRECISION">
  44271. Minimum precision after discarding whole 32-bit words from the significand
  44272. </member>
  44273. <member name="M:NPOI.SS.Util.MutableFPNumber.Rounder.Round(NPOI.Util.BigInteger,System.Int32)">
  44274. @param nBits number of bits to shift right
  44275. </member>
  44276. <member name="T:NPOI.SS.Util.MutableFPNumber.TenPower">
  44277. Holds values for quick multiplication and division by 10
  44278. </member>
  44279. <member name="F:NPOI.SS.Util.NormalisedDecimal.EXPONENT_OFFSET">
  44280. Number of powers of ten Contained in the significand
  44281. </member>
  44282. <member name="F:NPOI.SS.Util.NormalisedDecimal.C_2_POW_19">
  44283. 2<sup>19</sup>
  44284. </member>
  44285. <member name="F:NPOI.SS.Util.NormalisedDecimal.FRAC_HALF">
  44286. the value of {@link #_fractionalPart} that represents 0.5
  44287. </member>
  44288. <member name="F:NPOI.SS.Util.NormalisedDecimal.MAX_REP_WHOLE_PART">
  44289. 10<sup>15</sup>
  44290. </member>
  44291. <member name="M:NPOI.SS.Util.NormalisedDecimal.RoundUnits">
  44292. Rounds at the digit with value 10<sup>decimalExponent</sup>
  44293. </member>
  44294. <member name="F:NPOI.SS.Util.NormalisedDecimal._relativeDecimalExponent">
  44295. The decimal exponent increased by one less than the digit count of {@link #_wholePart}
  44296. </member>
  44297. <member name="F:NPOI.SS.Util.NormalisedDecimal._wholePart">
  44298. The whole part of the significand (typically 15 digits).
  44299. 47-50 bits long (MSB may be anywhere from bit 46 to 49)
  44300. LSB is units bit.
  44301. </member>
  44302. <member name="F:NPOI.SS.Util.NormalisedDecimal._fractionalPart">
  44303. The fractional part of the significand.
  44304. 24 bits (only top 14-17 bits significant): a value between 0x000000 and 0xFFFF80
  44305. </member>
  44306. <member name="M:NPOI.SS.Util.NormalisedDecimal.NormaliseBaseTwo">
  44307. Convert to an equivalent {@link ExpandedDouble} representation (binary frac and exponent).
  44308. The resulting transformed object is easily Converted to a 64 bit IEEE double:
  44309. <ul>
  44310. <li>bits 2-53 of the {@link #GetSignificand()} become the 52 bit 'fraction'.</li>
  44311. <li>{@link #GetBinaryExponent()} is biased by 1023 to give the 'exponent'.</li>
  44312. </ul>
  44313. The sign bit must be obtained from somewhere else.
  44314. @return a new {@link NormalisedDecimal} normalised to base 2 representation.
  44315. </member>
  44316. <member name="M:NPOI.SS.Util.NormalisedDecimal.ComposeFrac">
  44317. @return the significand as a fixed point number (with 24 fraction bits and 47-50 whole bits)
  44318. </member>
  44319. <member name="M:NPOI.SS.Util.NormalisedDecimal.GetSignificantDecimalDigitsLastDigitRounded">
  44320. Rounds the first whole digit position (considers only units digit, not frational part).
  44321. Caller should check total digit count of result to see whether the rounding operation caused
  44322. a carry out of the most significant digit
  44323. </member>
  44324. <member name="M:NPOI.SS.Util.NormalisedDecimal.GetDecimalExponent">
  44325. @return the number of powers of 10 which have been extracted from the significand and binary exponent.
  44326. </member>
  44327. <member name="M:NPOI.SS.Util.NormalisedDecimal.CompareNormalised(NPOI.SS.Util.NormalisedDecimal)">
  44328. assumes both this and other are normalised
  44329. </member>
  44330. <member name="M:NPOI.SS.Util.NumberComparer.Compare(System.Double,System.Double)">
  44331. This class attempts to reproduce Excel's behaviour for comparing numbers. Results are
  44332. mostly the same as those from {@link Double#compare(double, double)} but with some
  44333. rounding. For numbers that are very close, this code converts to a format having 15
  44334. decimal digits of precision and a decimal exponent, before completing the comparison.
  44335. <p/>
  44336. In Excel formula evaluation, expressions like "(0.06-0.01)=0.05" evaluate to "TRUE" even
  44337. though the equivalent java expression is <c>false</c>. In examples like this,
  44338. Excel achieves the effect by having additional logic for comparison operations.
  44339. <p/>
  44340. <p/>
  44341. Note - Excel also gives special treatment to expressions like "0.06-0.01-0.05" which
  44342. evaluates to "0" (in java, rounding anomalies give a result of 6.9E-18). The special
  44343. behaviour here is for different reasons to the example above: If the last operator in a
  44344. cell formula is '+' or '-' and the result is less than 2<sup>50</sup> times smaller than
  44345. first operand, the result is rounded to zero.
  44346. Needless to say, the two rules are not consistent and it is relatively easy to find
  44347. examples that satisfy<br/>
  44348. "A=B" is "TRUE" but "A-B" is not "0"<br/>
  44349. and<br/>
  44350. "A=B" is "FALSE" but "A-B" is "0"<br/>
  44351. <br/>
  44352. This rule (for rounding the result of a final addition or subtraction), has not been
  44353. implemented in POI (as of Jul-2009).
  44354. @return <code>negative, 0, or positive</code> according to the standard Excel comparison
  44355. of values <c>a</c> and <c>b</c>.
  44356. </member>
  44357. <member name="M:NPOI.SS.Util.NumberComparer.CompareSubnormalNumbers(System.Int64,System.Int64,System.Boolean)">
  44358. If both numbers are subnormal, Excel seems to use standard comparison rules
  44359. </member>
  44360. <member name="M:NPOI.SS.Util.NumberComparer.CompareAcrossSubnormalThreshold(System.Int64,System.Int64,System.Boolean)">
  44361. Usually any normal number is greater (in magnitude) than any subnormal number.
  44362. However there are some anomalous cases around the threshold where Excel produces screwy results
  44363. @param isNegative both values are either negative or positive. This parameter affects the sign of the comparison result
  44364. @return usually <code>isNegative ? -1 : +1</code>
  44365. </member>
  44366. <member name="M:NPOI.SS.Util.NumberComparer.ToHex(System.Double)">
  44367. for formatting double values in error messages
  44368. </member>
  44369. <member name="M:NPOI.SS.Util.NumberToTextConverter.ToText(System.Double)">
  44370. Converts the supplied <c>value</c> to the text representation that Excel would give if
  44371. the value were to appear in an unformatted cell, or as a literal number in a formula.<br/>
  44372. Note - the results from this method differ slightly from those of <c>Double.ToString()</c>
  44373. In some special cases Excel behaves quite differently. This function attempts to reproduce
  44374. those results.
  44375. </member>
  44376. <member name="T:NPOI.SS.Util.PaneInformation">
  44377. Holds information regarding a split plane or freeze plane for a sheet.
  44378. </member>
  44379. <member name="F:NPOI.SS.Util.PaneInformation.PANE_LOWER_RIGHT">
  44380. Constant for active pane being the lower right
  44381. </member>
  44382. <member name="F:NPOI.SS.Util.PaneInformation.PANE_UPPER_RIGHT">
  44383. Constant for active pane being the upper right
  44384. </member>
  44385. <member name="F:NPOI.SS.Util.PaneInformation.PANE_LOWER_LEFT">
  44386. Constant for active pane being the lower left
  44387. </member>
  44388. <member name="F:NPOI.SS.Util.PaneInformation.PANE_UPPER_LEFT">
  44389. Constant for active pane being the upper left
  44390. </member>
  44391. <member name="P:NPOI.SS.Util.PaneInformation.VerticalSplitPosition">
  44392. Returns the vertical position of the split.
  44393. @return 0 if there is no vertical spilt,
  44394. or for a freeze pane the number of columns in the TOP pane,
  44395. or for a split plane the position of the split in 1/20th of a point.
  44396. </member>
  44397. <member name="P:NPOI.SS.Util.PaneInformation.HorizontalSplitPosition">
  44398. Returns the horizontal position of the split.
  44399. @return 0 if there is no horizontal spilt,
  44400. or for a freeze pane the number of rows in the LEFT pane,
  44401. or for a split plane the position of the split in 1/20th of a point.
  44402. </member>
  44403. <member name="P:NPOI.SS.Util.PaneInformation.HorizontalSplitTopRow">
  44404. For a horizontal split returns the top row in the BOTTOM pane.
  44405. @return 0 if there is no horizontal split, or the top row of the bottom pane.
  44406. </member>
  44407. <member name="P:NPOI.SS.Util.PaneInformation.VerticalSplitLeftColumn">
  44408. For a vertical split returns the left column in the RIGHT pane.
  44409. @return 0 if there is no vertical split, or the left column in the RIGHT pane.
  44410. </member>
  44411. <member name="P:NPOI.SS.Util.PaneInformation.ActivePane">
  44412. Returns the active pane
  44413. @see #PANE_LOWER_RIGHT
  44414. @see #PANE_UPPER_RIGHT
  44415. @see #PANE_LOWER_LEFT
  44416. @see #PANE_UPPER_LEFT
  44417. @return the active pane.
  44418. </member>
  44419. <member name="M:NPOI.SS.Util.PaneInformation.IsFreezePane">
  44420. Returns true if this is a Freeze pane, false if it is a split pane.
  44421. </member>
  44422. <member name="T:NPOI.SS.Util.RegionUtil">
  44423. Various utility functions that make working with a region of cells easier.
  44424. @author Eric Pugh epugh@upstate.com
  44425. @author (secondary) Avinash Kewalramani akewalramani@accelrys.com
  44426. </member>
  44427. <member name="T:NPOI.SS.Util.RegionUtil.CellPropertySetter">
  44428. For setting the same property on many cells to the same value
  44429. </member>
  44430. <member name="M:NPOI.SS.Util.RegionUtil.SetBorderLeft(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet)">
  44431. <summary>
  44432. Sets the left border for a region of cells by manipulating the cell style of the individual cells on the left
  44433. </summary>
  44434. <param name="border">The new border</param>
  44435. <param name="region">The region that should have the border</param>
  44436. <param name="sheet">The sheet that the region is on.</param>
  44437. </member>
  44438. <member name="M:NPOI.SS.Util.RegionUtil.SetLeftBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet)">
  44439. <summary>
  44440. Sets the left border color for a region of cells by manipulating the cell style of the individual cells on the left
  44441. </summary>
  44442. <param name="color">The color of the border</param>
  44443. <param name="region">The region that should have the border</param>
  44444. <param name="sheet">The sheet that the region is on.</param>
  44445. </member>
  44446. <member name="M:NPOI.SS.Util.RegionUtil.SetBorderRight(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet)">
  44447. <summary>
  44448. Sets the right border for a region of cells by manipulating the cell style of the individual cells on the right
  44449. </summary>
  44450. <param name="border">The new border</param>
  44451. <param name="region">The region that should have the border</param>
  44452. <param name="sheet">The sheet that the region is on.</param>
  44453. </member>
  44454. <member name="M:NPOI.SS.Util.RegionUtil.SetRightBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet)">
  44455. <summary>
  44456. Sets the right border color for a region of cells by manipulating the cell style of the individual cells on the right
  44457. </summary>
  44458. <param name="color">The color of the border</param>
  44459. <param name="region">The region that should have the border</param>
  44460. <param name="sheet">The sheet that the region is on.</param>
  44461. </member>
  44462. <member name="M:NPOI.SS.Util.RegionUtil.SetBorderBottom(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet)">
  44463. <summary>
  44464. Sets the bottom border for a region of cells by manipulating the cell style of the individual cells on the bottom
  44465. </summary>
  44466. <param name="border">The new border</param>
  44467. <param name="region">The region that should have the border</param>
  44468. <param name="sheet">The sheet that the region is on</param>
  44469. </member>
  44470. <member name="M:NPOI.SS.Util.RegionUtil.SetBottomBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet)">
  44471. <summary>
  44472. Sets the bottom border color for a region of cells by manipulating the cell style of the individual cells on the bottom
  44473. </summary>
  44474. <param name="color">The color of the border</param>
  44475. <param name="region">The region that should have the border</param>
  44476. <param name="sheet">The sheet that the region is on.</param>
  44477. </member>
  44478. <member name="M:NPOI.SS.Util.RegionUtil.SetBorderTop(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet)">
  44479. <summary>
  44480. Sets the top border for a region of cells by manipulating the cell style of the individual cells on the top
  44481. </summary>
  44482. <param name="border">The new border</param>
  44483. <param name="region">The region that should have the border</param>
  44484. <param name="sheet">The sheet that the region is on.</param>
  44485. </member>
  44486. <member name="M:NPOI.SS.Util.RegionUtil.SetTopBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet)">
  44487. <summary>
  44488. Sets the top border color for a region of cells by manipulating the cell style of the individual cells on the top
  44489. </summary>
  44490. <param name="color">The color of the border</param>
  44491. <param name="region">The region that should have the border</param>
  44492. <param name="sheet">The sheet that the region is on.</param>
  44493. </member>
  44494. <member name="T:NPOI.SS.Util.SheetBuilder">
  44495. Class {@code SheetBuilder} provides an easy way of building workbook sheets
  44496. from 2D array of Objects. It can be used in test cases to improve code
  44497. readability or in Swing applications with tables.
  44498. @author Roman Kashitsyn
  44499. </member>
  44500. <member name="M:NPOI.SS.Util.SheetBuilder.GetCreateEmptyCells">
  44501. Returns {@code true} if null array elements should be treated as empty
  44502. cells.
  44503. @return {@code true} if null objects should be treated as empty cells
  44504. and {@code false} otherwise
  44505. </member>
  44506. <member name="M:NPOI.SS.Util.SheetBuilder.SetCreateEmptyCells(System.Boolean)">
  44507. Specifies if null array elements should be treated as empty cells.
  44508. @param shouldCreateEmptyCells {@code true} if null array elements should be
  44509. treated as empty cells
  44510. @return {@code this}
  44511. </member>
  44512. <member name="M:NPOI.SS.Util.SheetBuilder.SetSheetName(System.String)">
  44513. Specifies name of the sheet to build. If not specified, default name (provided by
  44514. workbook) will be used instead.
  44515. @param sheetName sheet name to use
  44516. @return {@code this}
  44517. </member>
  44518. <member name="M:NPOI.SS.Util.SheetBuilder.Build">
  44519. Builds sheet from parent workbook and 2D array with cell
  44520. values. Creates rows anyway (even if row contains only null
  44521. cells), creates cells if either corresponding array value is not
  44522. null or createEmptyCells property is true.
  44523. The conversion is performed in the following way:
  44524. <p/>
  44525. <ul>
  44526. <li>Numbers become numeric cells.</li>
  44527. <li><code>java.util.Date</code> or <code>java.util.Calendar</code>
  44528. instances become date cells.</li>
  44529. <li>String with leading '=' char become formulas (leading '='
  44530. will be truncated).</li>
  44531. <li>Other objects become strings via <code>Object.toString()</code>
  44532. method call.</li>
  44533. </ul>
  44534. @return newly created sheet
  44535. </member>
  44536. <member name="M:NPOI.SS.Util.SheetBuilder.SetCellValue(NPOI.SS.UserModel.ICell,System.Object)">
  44537. Sets the cell value using object type information.
  44538. @param cell cell to change
  44539. @param value value to set
  44540. </member>
  44541. <member name="T:NPOI.SS.Util.SheetReferences">
  44542. Holds a collection of Sheet names and their associated
  44543. reference numbers.
  44544. @author Andrew C. Oliver (acoliver at apache dot org)
  44545. </member>
  44546. <member name="T:NPOI.SS.Util.SheetUtil">
  44547. Helper methods for when working with Usermodel sheets
  44548. @author Yegor Kozlov
  44549. </member>
  44550. <member name="F:NPOI.SS.Util.SheetUtil.dummyEvaluator">
  44551. Dummy formula Evaluator that does nothing.
  44552. YK: The only reason of having this class is that
  44553. {@link NPOI.SS.UserModel.DataFormatter#formatCellValue(NPOI.SS.UserModel.Cell)}
  44554. returns formula string for formula cells. Dummy Evaluator Makes it to format the cached formula result.
  44555. See Bugzilla #50021
  44556. </member>
  44557. <member name="M:NPOI.SS.Util.SheetUtil.GetCellWidth(NPOI.SS.UserModel.ICell,System.Int32,NPOI.SS.UserModel.DataFormatter,System.Boolean)">
  44558. Compute width of a single cell
  44559. @param cell the cell whose width is to be calculated
  44560. @param defaultCharWidth the width of a single character
  44561. @param formatter formatter used to prepare the text to be measured
  44562. @param useMergedCells whether to use merged cells
  44563. @return the width in pixels or -1 if cell is empty
  44564. </member>
  44565. <member name="M:NPOI.SS.Util.SheetUtil.GetColumnWidth(NPOI.SS.UserModel.ISheet,System.Int32,System.Boolean)">
  44566. Compute width of a column and return the result
  44567. @param sheet the sheet to calculate
  44568. @param column 0-based index of the column
  44569. @param useMergedCells whether to use merged cells
  44570. @return the width in pixels or -1 if all cells are empty
  44571. </member>
  44572. <member name="M:NPOI.SS.Util.SheetUtil.GetColumnWidth(NPOI.SS.UserModel.ISheet,System.Int32,System.Boolean,System.Int32,System.Int32,System.Int32)">
  44573. Compute width of a column based on a subset of the rows and return the result
  44574. @param sheet the sheet to calculate
  44575. @param column 0-based index of the column
  44576. @param useMergedCells whether to use merged cells
  44577. @param firstRow 0-based index of the first row to consider (inclusive)
  44578. @param lastRow 0-based index of the last row to consider (inclusive)
  44579. @param maxRows limit the scope to maxRows rows to speed up the function, or leave 0 (optional)
  44580. @return the width in pixels or -1 if cell is empty
  44581. </member>
  44582. <member name="M:NPOI.SS.Util.SheetUtil.GetDefaultCharWidth(NPOI.SS.UserModel.IWorkbook)">
  44583. Get default character width
  44584. @param wb the workbook to get the default character width from
  44585. @return default character width
  44586. </member>
  44587. <member name="M:NPOI.SS.Util.SheetUtil.GetColumnWidthForRow(NPOI.SS.UserModel.IRow,System.Int32,System.Int32,NPOI.SS.UserModel.DataFormatter,System.Boolean)">
  44588. Compute width of a single cell in a row
  44589. Convenience method for {@link getCellWidth}
  44590. @param row the row that contains the cell of interest
  44591. @param column the column number of the cell whose width is to be calculated
  44592. @param defaultCharWidth the width of a single character
  44593. @param formatter formatter used to prepare the text to be measured
  44594. @param useMergedCells whether to use merged cells
  44595. @return the width in pixels or -1 if cell is empty
  44596. </member>
  44597. <member name="M:NPOI.SS.Util.SheetUtil.CanComputeColumnWidth(NPOI.SS.UserModel.IFont)">
  44598. Check if the Fonts are installed correctly so that Java can compute the size of
  44599. columns.
  44600. If a Cell uses a Font which is not available on the operating system then Java may
  44601. fail to return useful Font metrics and thus lead to an auto-computed size of 0.
  44602. This method allows to check if computing the sizes for a given Font will succeed or not.
  44603. @param font The Font that is used in the Cell
  44604. @return true if computing the size for this Font will succeed, false otherwise
  44605. </member>
  44606. <member name="M:NPOI.SS.Util.SheetUtil.IFont2Font(NPOI.SS.UserModel.IFont)">
  44607. <summary>
  44608. Convert HSSFFont to Font.
  44609. </summary>
  44610. <param name="font1">The font.</param>
  44611. <returns></returns>
  44612. <exception cref="T:SixLabors.Fonts.FontException">Will throw this if no font are
  44613. found by SixLabors in the current environment.</exception>
  44614. </member>
  44615. <member name="M:NPOI.SS.Util.SheetUtil.ContainsCell(NPOI.SS.Util.CellRangeAddress,System.Int32,System.Int32)">
  44616. <summary>
  44617. Check if the cell is in the specified cell range
  44618. </summary>
  44619. <param name="cr">the cell range to check in</param>
  44620. <param name="rowIx">the row to check</param>
  44621. <param name="colIx">the column to check</param>
  44622. <returns>return true if the range contains the cell [rowIx, colIx]</returns>
  44623. </member>
  44624. <member name="M:NPOI.SS.Util.SheetUtil.GetUniqueSheetName(NPOI.SS.UserModel.IWorkbook,System.String)">
  44625. Generate a valid sheet name based on the existing one. Used when cloning sheets.
  44626. @param srcName the original sheet name to
  44627. @return clone sheet name
  44628. </member>
  44629. <member name="M:NPOI.SS.Util.SheetUtil.GetCellWithMerges(NPOI.SS.UserModel.ISheet,System.Int32,System.Int32)">
  44630. Return the cell, taking account of merged regions. Allows you to find the
  44631. cell who's contents are Shown in a given position in the sheet.
  44632. <p>If the cell at the given co-ordinates is a merged cell, this will
  44633. return the primary (top-left) most cell of the merged region.</p>
  44634. <p>If the cell at the given co-ordinates is not in a merged region,
  44635. then will return the cell itself.</p>
  44636. <p>If there is no cell defined at the given co-ordinates, will return
  44637. null.</p>
  44638. </member>
  44639. <member name="T:NPOI.SS.Util.SSCellRange`1">
  44640. For POI internal use only
  44641. @author Josh Micich
  44642. </member>
  44643. <member name="T:NPOI.SS.Util.WorkbookUtil">
  44644. Helper methods for when working with Usermodel Workbooks
  44645. </member>
  44646. <member name="M:NPOI.SS.Util.WorkbookUtil.CreateSafeSheetName(System.String)">
  44647. Creates a valid sheet name, which is conform to the rules.
  44648. In any case, the result safely can be used for
  44649. {@link org.apache.poi.ss.usermodel.Workbook#setSheetName(int, String)}.
  44650. <br/>
  44651. Rules:
  44652. <ul>
  44653. <li>never null</li>
  44654. <li>minimum length is 1</li>
  44655. <li>maximum length is 31</li>
  44656. <li>doesn't contain special chars: 0x0000, 0x0003, / \ ? * ] [ </li>
  44657. <li>Sheet names must not begin or end with ' (apostrophe)</li>
  44658. </ul>
  44659. Invalid characters are replaced by one space character ' '.
  44660. @param nameProposal can be any string, will be truncated if necessary,
  44661. allowed to be null
  44662. @return a valid string, "empty" if to short, "null" if null
  44663. </member>
  44664. <member name="M:NPOI.SS.Util.WorkbookUtil.CreateSafeSheetName(System.String,System.Char)">
  44665. Creates a valid sheet name, which is conform to the rules.
  44666. In any case, the result safely can be used for
  44667. {@link org.apache.poi.ss.usermodel.Workbook#setSheetName(int, String)}.
  44668. <br />
  44669. Rules:
  44670. <ul>
  44671. <li>never null</li>
  44672. <li>minimum length is 1</li>
  44673. <li>maximum length is 31</li>
  44674. <li>doesn't contain special chars: : 0x0000, 0x0003, / \ ? * ] [ </li>
  44675. <li>Sheet names must not begin or end with ' (apostrophe)</li>
  44676. </ul>
  44677. @param nameProposal can be any string, will be truncated if necessary,
  44678. allowed to be null
  44679. @param replaceChar the char to replace invalid characters.
  44680. @return a valid string, "empty" if to short, "null" if null
  44681. </member>
  44682. <member name="M:NPOI.SS.Util.WorkbookUtil.ValidateSheetName(System.String)">
  44683. Validates sheet name.
  44684. <p>
  44685. The character count <c>MUST</c> be greater than or equal to 1 and less than or equal to 31.
  44686. The string MUST NOT contain the any of the following characters:
  44687. <ul>
  44688. <li> 0x0000 </li>
  44689. <li> 0x0003 </li>
  44690. <li> colon (:) </li>
  44691. <li> backslash (\) </li>
  44692. <li> asterisk (*) </li>
  44693. <li> question mark (?) </li>
  44694. <li> forward slash (/) </li>
  44695. <li> opening square bracket ([) </li>
  44696. <li> closing square bracket (]) </li>
  44697. </ul>
  44698. The string MUST NOT begin or end with the single quote (') character.
  44699. </p>
  44700. @param sheetName the name to validate
  44701. </member>
  44702. <member name="T:NPOI.UnsupportedFileFormatException">
  44703. Base class of all the exceptions that POI throws in the event
  44704. that it's given a file that isn't supported
  44705. </member>
  44706. <member name="T:NPOI.WP.UserModel.ICharacterRun">
  44707. This class represents a run of text that share common properties.
  44708. </member>
  44709. <member name="P:NPOI.WP.UserModel.ICharacterRun.FontName">
  44710. <summary>
  44711. Gets the fonts which shall be used to display the text contents of
  44712. this run. Specifies a font which shall be used to format all "normal"
  44713. characters in the run
  44714. </summary>
  44715. </member>
  44716. <member name="P:NPOI.WP.UserModel.ICharacterRun.Text">
  44717. @return The text of the Run, including any tabs/spaces/etc
  44718. </member>
  44719. <member name="T:NPOI.WP.UserModel.IParagraph">
  44720. This class represents a paragraph, made up of one or more
  44721. Runs of text.
  44722. </member>
  44723. </members>
  44724. </doc>